StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::PreviewAudio Struct Reference

Losslessly owned decoded PCM, at its actual rate and channel order. More...

#include <StormByte/multimedia/display.hxx>

Collaboration diagram for StormByte::Multimedia::PreviewAudio:

Public Member Functions

 PreviewAudio ()=default
 Construct an empty block.
 PreviewAudio (const PreviewAudio &other)=default
 Copy samples.
 PreviewAudio (PreviewAudio &&other) noexcept=default
 Move samples.
 ~PreviewAudio () noexcept=default
 Release samples.
PreviewAudio & operator= (const PreviewAudio &other)=default
 Copy samples.
PreviewAudio & operator= (PreviewAudio &&other) noexcept=default
 Move samples.

Public Attributes

Safe::Vector< Safe::Binary > m_planes
 Exact owned sample planes.
Safe::Vector< Safe::String > m_channels
 Identities in decoded sample order; size is channel count.
AudioSample m_format = AudioSample::Unsigned8
 Actual decoded sample representation.
AudioLayout m_layout = AudioLayout::Unspecified
 Channel identity interpretation.
bool m_planar = false
 Separate channel planes rather than packed samples.
std::uint32_t m_rate = 0
 Actual decoded samples per second per channel.
std::uint32_t m_frames = 0
 Samples per channel.
std::uint64_t m_epoch = 0
 Delivery generation.
double m_position = 0
 First sample presentation time in media seconds.

Detailed Description

Losslessly owned decoded PCM, at its actual rate and channel order.

Planar blocks contain one plane per channel; packed blocks contain one interleaved plane. Planes contain only sample bytes, never decoder padding. Channel identities use canonical speaker abbreviations (FL, FR, FC, LFE, BL, BR, SL, SR, etc.), AMBI followed by the ACN component number, or NONE (unspecified), UNK (unknown) or USR identifiers. BL/BR and SL/SR are distinct. Unspecified, unknown and ambisonic channels must never be guessed by a device adapter. The Display owns conversion, reordering and device negotiation.

Constructor & Destructor Documentation

◆ PreviewAudio() [1/3]

StormByte::Multimedia::PreviewAudio::PreviewAudio ( )
default

Construct an empty block.

◆ PreviewAudio() [2/3]

StormByte::Multimedia::PreviewAudio::PreviewAudio ( const PreviewAudio & other)
default

Copy samples.

Parameters
otherSource.

◆ PreviewAudio() [3/3]

StormByte::Multimedia::PreviewAudio::PreviewAudio ( PreviewAudio && other)
defaultnoexcept

Move samples.

Parameters
otherSource.

◆ ~PreviewAudio()

StormByte::Multimedia::PreviewAudio::~PreviewAudio ( )
defaultnoexcept

Release samples.

Member Function Documentation

◆ operator=() [1/2]

PreviewAudio & StormByte::Multimedia::PreviewAudio::operator= ( const PreviewAudio & other)
default

Copy samples.

Parameters
otherSource.
Returns
This block.

◆ operator=() [2/2]

PreviewAudio & StormByte::Multimedia::PreviewAudio::operator= ( PreviewAudio && other)
defaultnoexcept

Move samples.

Parameters
otherSource.
Returns
This block.

Member Data Documentation

◆ m_channels

Safe::Vector<Safe::String> StormByte::Multimedia::PreviewAudio::m_channels

Identities in decoded sample order; size is channel count.

◆ m_epoch

std::uint64_t StormByte::Multimedia::PreviewAudio::m_epoch = 0

Delivery generation.

◆ m_format

AudioSample StormByte::Multimedia::PreviewAudio::m_format = AudioSample::Unsigned8

Actual decoded sample representation.

◆ m_frames

std::uint32_t StormByte::Multimedia::PreviewAudio::m_frames = 0

Samples per channel.

◆ m_layout

AudioLayout StormByte::Multimedia::PreviewAudio::m_layout = AudioLayout::Unspecified

Channel identity interpretation.

◆ m_planar

bool StormByte::Multimedia::PreviewAudio::m_planar = false

Separate channel planes rather than packed samples.

◆ m_planes

Safe::Vector<Safe::Binary> StormByte::Multimedia::PreviewAudio::m_planes

Exact owned sample planes.

◆ m_position

double StormByte::Multimedia::PreviewAudio::m_position = 0

First sample presentation time in media seconds.

◆ m_rate

std::uint32_t StormByte::Multimedia::PreviewAudio::m_rate = 0

Actual decoded samples per second per channel.


The documentation for this struct was generated from the following file: