StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Pipeline::Remuxer Class Referencefinal

Forwards compressed packets of one origin track to the muxer. More...

#include <StormByte/multimedia/pipeline/remuxer.hxx>

Inheritance diagram for StormByte::Multimedia::Pipeline::Remuxer:
Collaboration diagram for StormByte::Multimedia::Pipeline::Remuxer:

Public Member Functions

int In () const noexcept
 Origin stream index.
StormByte::Size InputCeiling () const noexcept override
 Maximum number of queued input packets.
Lifecycle
 Remuxer (StormByte::Safe::Shared< StormByte::Logger::Log > log, int in)
 Remuxer for origin stream in.
 Remuxer (StormByte::Safe::Shared< StormByte::Logger::Log > log, int in, int out)
 Remuxes one origin into an explicit destination slot.
 Remuxer (const Remuxer &other)=delete
 Copy constructor.
 Remuxer (Remuxer &&other) noexcept=delete
 Move constructor.
 ~Remuxer () noexcept override
 Destroy the remuxer; Step::Join halts before backends die.
Remuxer & operator= (const Remuxer &other)=delete
 Copy assignment.
Remuxer & operator= (Remuxer &&other) noexcept=delete
 Move assignment.
Public Member Functions inherited from StormByte::Multimedia::Pipeline::Step
 Step (const Step &other)=delete
 Copy construction is disabled.
 Step (Step &&other) noexcept=delete
 Move construction is disabled.
virtual ~Step () noexcept
 Destructor.
Step & operator= (const Step &other)=delete
 Copy assignment is disabled.
Step & operator= (Step &&other) noexcept=delete
 Move assignment is disabled.
void Wake () noexcept
 Notifies all waiters of this step.
StormByte::Safe::Shared< class Plan > Plan () const noexcept
 Bound job intention, if any.
const Kinds & Receives () const noexcept
 Kinds this step consumes.
const Kinds & Produces () const noexcept
 Kinds this step emits.
State Status () const noexcept
 Current lifecycle value.
StormByte::Safe::Shared< const StageTelemetry > Telemetry () const
 Shared stage counters, retained independently of this Step.
StormByte::Buffer::QueueSnapshot QueueSnapshot (int track) const noexcept
 Reads effective queue limits and logical-byte accounting.
virtual bool Ready () const noexcept
 Whether this step can take work.
void Stop () noexcept
 Requests shutdown and notifies connected stages.
bool Failed () const noexcept
 Whether this step has failed.
StormByte::Safe::Optional< StormByte::Safe::String > Error () const
 Failure text.
void Fail (StormByte::Safe::String reason) noexcept
 Marks the stage as failed and notifies connected stages.
void Fail () noexcept
 Marks failure without storing a message or allocating.
STORMBYTE_FORCE_INLINE void Fail (const char *reason) noexcept
 Copies a null-terminated failure literal into Safe storage.
void Fail (std::string_view reason) noexcept
 Copies borrowed failure text before calling the DLL-safe overload.

Friends

class Backend::Pipeline::Detail::Worker::Remux
 Allow the remux worker to access pipeline internals.
class Route
 Allow routes to access remuxer internals.
Remuxer & operator>> (Demuxer &demuxer, Remuxer &remuxer)
 Connect the origin demuxer to this remuxer.
Remuxer & operator>> (Remuxer &remuxer, Muxer &muxer)
 Connect this remuxer to the destination muxer.

Additional Inherited Members

Protected Member Functions inherited from StormByte::Multimedia::Pipeline::Step
bool Connect (Step &downstream) noexcept
 Registers a borrowed downstream stage and shares any bound plan.
bool WaitPlan () noexcept
 Waits interruptibly for the shared plan to enter Running.
Backend::Pipeline::Pipe & pipe () noexcept
const Backend::Pipeline::Pipe & pipe () const noexcept
 Step (StormByte::Safe::Shared< StormByte::Logger::Log > log, enum Producer name, Kinds receives, Kinds produces)
 Constructs a stage in State::Created.
void Emit (Item::PointerType item) noexcept
 Sends item to connected consumers.
Item::PointerType CloneItem (const Item &item) const
 Creates a distinct item through Item::Clone.
virtual void Wait () noexcept
 Waits until input is available, the stage fails or stops, or WakeNow.
virtual bool WakeNow () const noexcept
 Extra reason to leave Wait.
virtual void AfterWait () noexcept
 Work on the waiting worker after Wait unblocks.
void Launch () noexcept
 Starts stage initialization and processing.
void Halt () noexcept
 Stops the stage and waits for execution to finish.
bool Stopping () const noexcept
 Worker must return (Stop, Halt or Fail).
void RecordWork (std::int64_t microseconds) noexcept
 Adds one Process duration to the step summary.
std::int64_t LastWork () const noexcept
 Duration of the last timed Process, or 0.
void DumpWork () noexcept
 Writes min/max Process time at Debug.
Backend::Pipeline::Host & Face () noexcept
void Mount (StormByte::Safe::Unique< Backend::Pipeline::Pumper > pumper, StormByte::Safe::Unique< Backend::Pipeline::Worker > worker)
Protected Attributes inherited from StormByte::Multimedia::Pipeline::Step
StormByte::Safe::Shared< StormByte::Logger::Log > m_log
 Scoped logger retained through Base-heap shared ownership.
enum Producer m_name
 UseLog leaf / default Label.
Kinds m_receives
 Receives.
Kinds m_produces
 Produces.

Detailed Description

Forwards compressed packets of one origin track to the muxer.

Packets retain their source lineage and are forwarded without re-encoding. Filters can analyze decoded destination pictures without changing the forwarded packets.

Logging identifies the origin codec or track index; the supplied logger controls throttling.

Constructor & Destructor Documentation

◆ Remuxer() [1/4]

StormByte::Multimedia::Pipeline::Remuxer::Remuxer ( StormByte::Safe::Shared< StormByte::Logger::Log > log,
int in )
explicit

Remuxer for origin stream in.

Parameters
logShared logger. Empty pointer means no log.
inOrigin stream index.

◆ Remuxer() [2/4]

StormByte::Multimedia::Pipeline::Remuxer::Remuxer ( StormByte::Safe::Shared< StormByte::Logger::Log > log,
int in,
int out )

Remuxes one origin into an explicit destination slot.

Parameters
logShared logger.
inOrigin stream index.
outMux output slot, independent of in.

◆ Remuxer() [3/4]

StormByte::Multimedia::Pipeline::Remuxer::Remuxer ( const Remuxer & other)
delete

Copy constructor.

Parameters
otherSource remuxer.

◆ Remuxer() [4/4]

StormByte::Multimedia::Pipeline::Remuxer::Remuxer ( Remuxer && other)
deletenoexcept

Move constructor.

Parameters
otherRemuxer to take.

◆ ~Remuxer()

StormByte::Multimedia::Pipeline::Remuxer::~Remuxer ( )
overridenoexcept

Destroy the remuxer; Step::Join halts before backends die.

Member Function Documentation

◆ In()

int StormByte::Multimedia::Pipeline::Remuxer::In ( ) const
inlinenoexcept

Origin stream index.

Returns
Index passed to the constructor.

◆ InputCeiling()

StormByte::Size StormByte::Multimedia::Pipeline::Remuxer::InputCeiling ( ) const
overridevirtualnoexcept

Maximum number of queued input packets.

Returns
Packet limit, or 0 if no input queue exists.

Reimplemented from StormByte::Multimedia::Pipeline::Step.

◆ operator=() [1/2]

Remuxer & StormByte::Multimedia::Pipeline::Remuxer::operator= ( const Remuxer & other)
delete

Copy assignment.

Parameters
otherSource remuxer.
Returns
*this.

◆ operator=() [2/2]

Remuxer & StormByte::Multimedia::Pipeline::Remuxer::operator= ( Remuxer && other)
deletenoexcept

Move assignment.

Parameters
otherRemuxer to take.
Returns
*this.

◆ Backend::Pipeline::Detail::Worker::Remux

friend class Backend::Pipeline::Detail::Worker::Remux
friend

Allow the remux worker to access pipeline internals.

◆ operator>> [1/2]

Remuxer & operator>> ( Demuxer & demuxer,
Remuxer & remuxer )
friend

Connect the origin demuxer to this remuxer.

Parameters
demuxerOrigin demuxer.
remuxerDestination remuxer.
Returns
Destination remuxer.
Parameters
demuxerOrigin demuxer.
remuxerDestination remuxer.
Returns
remuxer.

◆ operator>> [2/2]

Remuxer & operator>> ( Remuxer & remuxer,
Muxer & muxer )
friend

Connect this remuxer to the destination muxer.

Parameters
remuxerOrigin remuxer.
muxerDestination muxer.
Returns
Origin remuxer.

Allows remuxer connections to reserve output tracks.

Parameters
remuxerLive remuxer.
muxerDestination.
Returns
remuxer.
Registers a borrowed graph edge and binds the typed packet lane,
even without a Plan. Backend reservation and writer opening are
deferred until Setup observes a running Plan.

◆ Route

friend class Route
friend

Allow routes to access remuxer internals.


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