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

Multimedia module of the StormByte suite. More...

Namespaces

namespace  FFmpeg
 Private RAII wrappers over libav*.
namespace  Pipeline
 Demux / decode / filter / encode / mux types.
namespace  Backend
 Private backends.
namespace  Detail
 Private multimedia implementation helpers.
namespace  Property
 Media property value types.
namespace  Tables
 Private codec and container identity table declarations.

Classes

class  Attachment
 Container attachment (cover, fonts). More...
class  Codec
 Immutable codec identity owned by Registry. More...
class  Container
 Immutable container identity owned by StormByte::Multimedia::Registry. More...
class  DecoderInfo
 Read-only description of one decoder implementation of a codec. More...
struct  PreviewVideo
 Owned, tightly packed RGBA8 preview image, not an HDR mastering surface. More...
struct  PreviewHDRVideo
 Owned RGBA16LE image retaining its HDR transfer and color primaries. More...
struct  PreviewAudio
 Losslessly owned decoded PCM, at its actual rate and channel order. More...
struct  SubtitleRegion
 One decoded subtitle rectangle. More...
struct  PreviewSubtitle
 Timed decoded subtitle, retaining text, bitmap and styling information. More...
struct  AudioPresentation
 Device clock feedback in media seconds for the requested epoch. More...
class  Display
 Consumer-owned combined video, audio and subtitle presentation sink. More...
class  HDRDisplay
 Optional HDR presentation extension for a Display implementation. More...
struct  EncoderOption
 Description of one FFmpeg option of an encoder implementation. More...
class  EncoderInfo
 Read-only description of one encoder implementation of a codec. More...
class  Exception
 Base exception for the Multimedia module. More...
class  CodecNotFoundException
 Thrown when Registry::FindCodec does not resolve a key. More...
class  ContainerNotFoundException
 Thrown when Registry::FindContainer does not resolve a key. More...
class  FileOpenException
 Thrown when File::Open fails (path or buffer). More...
class  FilePathOpenException
 Thrown when File::Open fails on a filesystem path. More...
class  FileBufferOpenException
 Thrown when File::Open fails on a Consumer. More...
class  TranscodeException
 Thrown when Transcode::Open or a configuration call fails. More...
class  Features
 Bitmask of Feature flags. More...
class  File
 Read-only consultation snapshot of a media source. More...
class  Registry
 Process-wide catalog of codecs and containers. More...
struct  PreviewBuffering
 Per-player buffering policy, fixed for the engine's lifetime. More...
struct  PreviewDiagnostics
 Thread-safe diagnostics, cumulative since Open (including seeks). More...
struct  PreviewTrack
 Selectable input stream, excluding attached pictures and attachments. More...
class  SimplePlayer
 Real-time asynchronous file preview, not a professional media player. More...
class  Stream
 Public media stream snapshot. More...
class  Access
 Bitmask of Operation flags for a codec. More...
class  CodecRef
 Trivial borrowed codec handle; never owns or deletes the codec. More...
class  ContainerRef
 Trivial borrowed container handle; never owns or deletes the container. More...

Typedefs

using Attachments = StormByte::Safe::Vector<Attachment>
 Ordered attachments with creator-owned Safe storage.
using Streams = StormByte::Safe::Vector<Stream>
 Ordered stream snapshots with creator-owned Safe storage.
using ExpectedCodec = StormByte::Expected<CodecRef, CodecNotFoundException>
 Result of FindCodec.
using ExpectedContainer = StormByte::Expected<ContainerRef, ContainerNotFoundException>
 Result of FindContainer.
using ExpectedFile = StormByte::Expected<File, FileOpenException>
 Result of OpenFile.
using ExpectedTranscoder = StormByte::Expected<Safe::Unique<Pipeline::Transcoder>, TranscodeException>
 Result of Transcoder::Open.
using CodecRefs = Safe::Vector<CodecRef>
 Safe-owned list of borrowed codecs, not codec ownership.
using ContainerRefs = Safe::Vector<ContainerRef>
 Safe-owned list of borrowed containers, not container ownership.

Enumerations

enum class  SubtitleKind { Unknown , Text , Bitmap }
 Semantic subtitle representation, not its on-disk encoding. More...
enum class  DecodeAcceleration { Auto , Software }
 Selects whether video decoders may use an available FFmpeg hardware backend. More...
enum class  PreviewColorMode { SDR , HDR }
 Selects SDR presentation or HDR signal preservation for preview. More...
enum class  AudioSample {
  Unsigned8 , Signed16 , Signed32 , Signed64 ,
  Float32 , Float64
}
 Decoded native-endian PCM representation, without conversion. More...
enum class  AudioLayout { Unspecified , Speakers , Custom , Ambisonic }
 Interpretation of ordered decoded channel identities. More...
enum class  SubtitleContent { Text , Ass , Bitmap }
 FFmpeg decoded subtitle representation. More...
enum class  EncoderSetting : unsigned char {
  CRF , BitRate , MaxBitRate , Preset ,
  Tune , Params
}
 Rate and style settings an encoder implementation may accept. More...
enum class  EncoderOptionType : unsigned char {
  Integer , Float , Boolean , String ,
  Other
}
 Value type of an FFmpeg encoder option. More...
enum class  Feature : std::uint32_t {
  None = 0 , MultiThreaded = 1u << 0 , RealTime = 1u << 1 , LowDelay = 1u << 2 ,
  ZeroCopy = 1u << 3 , HardwareAcceleration = 1u << 4 , HighQuality = 1u << 5 , PsychoVisual = 1u << 6 ,
  AdaptiveQuantization = 1u << 7 , Lookahead = 1u << 8 , TwoPass = 1u << 9 , Lossless = 1u << 10 ,
  ProfileBased = 1u << 11 , ContentTuning = 1u << 12 , TenBit = 1u << 13 , TwelveBit = 1u << 14 ,
  HDR10 = 1u << 15 , HDR10Plus = 1u << 16 , WideGamut = 1u << 17 , SurroundSound = 1u << 18 ,
  SideData = 1u << 19 , BFrames = 1u << 20 , IntraOnly = 1u << 21 , Interlaced = 1u << 22 ,
  Slices = 1u << 23 , Streamable = 1u << 24 , Encodeable = 1u << 25 , DOVI = 1u << 26
}
 Handcrafted capability of one decoder or encoder implementation. More...
enum class  PreviewDecodeBackend { Unknown , Software , Hardware }
 Actual output of the video decoder, not the requested policy. More...
enum class  PlaybackState {
  Closed , Stopped , Playing , Paused ,
  Ended , Error
}
 Observable preview lifecycle. More...
enum class  Type {
  Audio , Video , Subtitle , Attachment ,
  Unknown
}
 Kind of media stream or codec. More...
enum class  Operation : std::uint8_t { None = 0 , Read = 1 << 0 , Write = 1 << 1 , Attach = 1 << 2 }
 Read / write capability flags for a codec. More...

Functions

constexpr const char * ToString (Feature feature) noexcept
 Converts a Feature to a stable token.
constexpr const char * ToString (Type type) noexcept
 Converts a Type to a string literal.

Detailed Description

Multimedia module of the StormByte suite.

Portable multimedia services.

Multimedia classes and helpers.

Audio and video processing types.

Multimedia processing types.

Multimedia processing and metadata.

Public Multimedia module.

Portable multimedia preview contracts.

Public media types and implementation descriptions.

Public media types: codecs, containers, registry and stream kinds.

Public media types: codecs, registry and stream kinds.

Typedef Documentation

◆ Attachments

Ordered attachments with creator-owned Safe storage.

◆ CodecRefs

Safe-owned list of borrowed codecs, not codec ownership.

Note
Each nonempty handle requires its codec and provider to remain alive. Safe owner callbacks retain allocation and destruction in the owning module.

◆ ContainerRefs

Safe-owned list of borrowed containers, not container ownership.

Note
Each nonempty handle requires its container and provider to remain alive. Safe owner callbacks retain allocation and destruction in the owning module.

◆ ExpectedCodec

Result of FindCodec.

Note
Borrows a registry identity; compatible ABI and provider lifetime are required. This alias does not acquire codec ownership.

◆ ExpectedContainer

Result of FindContainer.

Note
Borrows a registry identity; compatible ABI and provider lifetime are required. This alias does not acquire container ownership.

◆ ExpectedFile

◆ ExpectedTranscoder

◆ Streams

Ordered stream snapshots with creator-owned Safe storage.

Enumeration Type Documentation

◆ AudioLayout

Interpretation of ordered decoded channel identities.

Enumerator
Unspecified 

Count only; speaker mapping is unknown.

Speakers 

Known native speaker order.

Custom 

Explicit decoder channel order; identities may be unknown.

Ambisonic 

Ambisonic components, not ordinary speakers.

◆ AudioSample

Decoded native-endian PCM representation, without conversion.

Enumerator
Unsigned8 

Unsigned 8-bit.

Signed16 

Signed 16-bit.

Signed32 

Signed 32-bit.

Signed64 

Signed 64-bit.

Float32 

IEEE 32-bit float.

Float64 

IEEE 64-bit float.

◆ DecodeAcceleration

Selects whether video decoders may use an available FFmpeg hardware backend.

Note
MPEG-4 Part 2 always uses software decoding, including in Auto mode.
Enumerator
Auto 

Try a compatible hardware device, then fall back to software.

Software 

Do not initialize a hardware device.

◆ EncoderOptionType

enum class StormByte::Multimedia::EncoderOptionType : unsigned char
strong

Value type of an FFmpeg encoder option.

Enumerator
Integer 

Integer value.

Float 

Floating point value.

Boolean 

Boolean value.

String 

Free text.

Other 

Any other FFmpeg type (dictionary, rational, size, ...).

◆ EncoderSetting

enum class StormByte::Multimedia::EncoderSetting : unsigned char
strong

Rate and style settings an encoder implementation may accept.

Each value maps to a StormByte::Multimedia::Pipeline::Encoder setter (and the matching Transcoder::Track setter). Using an unsupported setting makes the encoder fail instead of being ignored.

Enumerator
CRF 

Constant quality (CRF, CQ, QP, global_quality or audio qscale).

BitRate 

Target bitrate.

MaxBitRate 

VBV / maximum bitrate.

Preset 

Speed / efficiency preset.

Tune 

Content tuning.

Params 

Packed vendor parameters (x265-params, ...).

When present, FineTune keys go into that blob; otherwise each FineTune key is an FFmpeg option.

◆ Feature

enum class StormByte::Multimedia::Feature : std::uint32_t
strong

Handcrafted capability of one decoder or encoder implementation.

Preference is not a Feature; it lives on the table row. Bits must be disjoint: Has() is a real bitmask test. HDR10 / HDR10Plus / SideData mean the implementation surfaces that metadata on Pipeline::Frame (decode) or writes it (encode). DOVI means the bundled FFmpeg implementation emits parsed AV_FRAME_DATA_DOVI_METADATA (decode), or has a native Dolby Vision configure/generate path consuming that metadata (encode). Raw RPU forwarding, container configuration and hardware acceleration alone do not qualify. This is not a profile, rendering, transform-validity or Dolby certification guarantee, nor automatic pipeline negotiation.

Note
DOVI requires supported input/profile, codec options and dependencies. Metadata retention does not prove semantic validity after pixel changes.
Enumerator
None 

No flags.

MultiThreaded 

Frame or slice threading.

RealTime 

Suitable for real-time use.

LowDelay 

Low latency.

ZeroCopy 

Zero-copy paths.

HardwareAcceleration 

Hardware decode or encode.

HighQuality 

High quality presets.

PsychoVisual 

Psycho-visual tuning.

AdaptiveQuantization 

Adaptive quantization.

Lookahead 

Lookahead analysis.

TwoPass 

Two-pass encoding.

Lossless 

Lossless mode.

ProfileBased 

Profile selection.

ContentTuning 

Content-type tuning.

TenBit 

10-bit.

TwelveBit 

12-bit.

HDR10 

Static HDR10 metadata on the frame.

HDR10Plus 

Dynamic HDR10+ side data on the frame.

WideGamut 

Wide color gamut.

SurroundSound 

Surround layouts.

SideData 

Propagates packet or frame side data.

BFrames 

B-frames.

IntraOnly 

Intra-only.

Interlaced 

Interlaced.

Slices 

Slice coding.

Streamable 

Streamable output.

Encodeable 

Can encode (legacy; Write is Codec::HasAccess).

DOVI 

Parsed Dolby Vision metadata decoding or native RPU encoding.

◆ Operation

enum class StormByte::Multimedia::Operation : std::uint8_t
strong

Read / write capability flags for a codec.

Enumerator
None 

No access.

Read 

Decode / demux is available.

Write 

At least one encoder / muxer exists.

Attach 

Container can hold real attachments (covers, fonts).

◆ PlaybackState

Observable preview lifecycle.

Enumerator
Closed 

No input.

Stopped 

Open input, rewound.

Playing 

Asynchronous playback.

Paused 

Frozen presentation, including paused seek previews.

Ended 

Decode and presentation drained.

Error 

Explicit failure; Error() provides details.

◆ PreviewColorMode

Selects SDR presentation or HDR signal preservation for preview.

Enumerator
SDR 

Tone-map PQ/HLG to BT.709 and deliver RGBA8 through Display.

HDR 

Deliver PQ/HLG as full-range RGBA16LE through HDRDisplay.

◆ PreviewDecodeBackend

Actual output of the video decoder, not the requested policy.

Enumerator
Unknown 
Software 
Hardware 

◆ SubtitleContent

FFmpeg decoded subtitle representation.

Enumerator
Text 

UTF-8 plain text.

Ass 

ASS event with the decoder's style header.

Bitmap 

RGBA8 pixels at the supplied canvas coordinates.

◆ SubtitleKind

Semantic subtitle representation, not its on-disk encoding.

Enumerator
Unknown 

Subtitle without a reliable representation classification.

Text 

Text-based cues, including binary-packed text formats.

Bitmap 

Image-based cues.

◆ Type

enum class StormByte::Multimedia::Type
strong

Kind of media stream or codec.

Enumerator
Audio 

Audio stream or codec.

Video 

Video stream or codec.

Subtitle 

Subtitle stream or codec.

Attachment 

Attachment / ancillary data.

Unknown 

Unclassified type.

Function Documentation

◆ ToString() [1/2]

const char * StormByte::Multimedia::ToString ( Feature feature)
constexprnoexcept

Converts a Feature to a stable token.

Parameters
featureFeature value.
Returns
Literal. Unknown bits return "UnknownFeature".

◆ ToString() [2/2]

const char * StormByte::Multimedia::ToString ( Type type)
constexprnoexcept

Converts a Type to a string literal.

Parameters
typeValue to convert.
Returns
Null-terminated name, or "Invalid".