FrameDemuxNode Class Reference

Splits a Frame into separate Image and Audio streams. More...

#include <framedemuxnode.h>

Inheritance diagram for FrameDemuxNode:

Collaboration diagram for FrameDemuxNode:

Public Member Functions
	FrameDemuxNode (ObjectBase *parent=nullptr)
	Constructs a FrameDemuxNode.
virtual	~FrameDemuxNode ()=default
	Destructor.
Error	configure () override
	Validates ports and allocates resources.
void	process () override
	Processes one cycle of data.
Public Member Functions inherited from MediaNode
	MediaNode (ObjectBase *parent=nullptr)
	Constructs a MediaNode.
virtual	~MediaNode ()
	Virtual destructor.
State	state () const
	Returns the current state.
const String &	name () const
	Returns the node name.
void	setName (const String &name)
	Sets the node name.
const MediaPort::PtrList &	inputPorts () const
	Returns the list of input ports.
const MediaPort::PtrList &	outputPorts () const
	Returns the list of output ports.
MediaPort::Ptr	inputPort (int index) const
	Returns the input port at the given index.
MediaPort::Ptr	outputPort (int index) const
	Returns the output port at the given index.
MediaPort::Ptr	inputPort (const String &name) const
	Returns the input port with the given name.
MediaPort::Ptr	outputPort (const String &name) const
	Returns the output port with the given name.
int	inputPortCount () const
	Returns the number of input ports.
int	outputPortCount () const
	Returns the number of output ports.
void	setThreadingPolicy (ThreadingPolicy policy)
	Sets the threading policy.
void	setThreadingPolicy (ThreadPool *pool)
	Sets a custom thread pool and switches policy to CustomPool.
ThreadingPolicy	threadingPolicy () const
	Returns the current threading policy.
ThreadPool *	customThreadPool () const
	Returns the custom thread pool, or nullptr if not using CustomPool.
void	setIdealQueueSize (int size)
	Sets the ideal input queue depth.
int	idealQueueSize () const
	Returns the ideal input queue size.
int	queuedFrameCount () const
	Returns the current input queue depth.
virtual Error	start ()
	Begins processing.
virtual void	stop ()
	Stops processing.
virtual void	starvation ()
	Called when the node's input queue is empty and data is needed.
virtual Map< String, Variant >	properties () const
	Returns all configurable properties as key-value pairs.
virtual Error	setProperty (const String &name, const Variant &value)
	Sets a property by name.
Variant	property (const String &name) const
	Gets a single property value by name.
NodeStats	stats () const
	Returns a snapshot of the node's performance statistics.
void	resetStats ()
	Resets all statistics counters to zero.
virtual Map< String, Variant >	extendedStats () const
	Returns additional node-specific statistics.
	PROMEKI_SIGNAL (stateChanged, State)
	Emitted when the node's state changes.
	PROMEKI_SIGNAL (errorOccurred, Error)
	Emitted when an error occurs.
	PROMEKI_SIGNAL (messageEmitted, NodeMessage)
	Emitted when the node produces a message.
Public Member Functions inherited from ObjectBase
	ObjectBase (ObjectBase *p=nullptr)
	Default ObjectBase constructor.
virtual	~ObjectBase ()
	Destructor. Emits aboutToDestroy, detaches from parent, and destroys children.
ObjectBase *	parent () const
	Returns the parent object, if one. nullptr if none.
void	setParent (ObjectBase *p)
	Sets the parent of this object. If the object already has a parent, it will be removed as a child from the old parent and added as a child to the new one.
const ObjectBaseList &	childList () const
	Returns a list of children of this object.
template<typename... Args>
int	registerSlot (Slot< Args... > *slot)
	Registers a slot with this object and assigns it an ID.
EventLoop *	eventLoop () const
	Returns the EventLoop this object is affiliated with.
void	moveToThread (EventLoop *loop)
	Changes the EventLoop affinity of this object.
int	startTimer (unsigned int intervalMs, bool singleShot=false)
	Starts a timer on this object's EventLoop.
void	stopTimer (int timerId)
	Stops a timer previously started with startTimer().
template<typename... Args>
PROMEKI_NAMESPACE_BEGIN void	connect (Signal< Args... > *signal, Slot< Args... > *slot)

Additional Inherited Members
Public Types inherited from MediaNode
enum	State { Idle , Configured , Running , ErrorState }
	Node lifecycle state. More...
enum	ThreadingPolicy { UseGraphPool , DedicatedThread , CustomPool }
	Threading policy for this node. More...
Public Types inherited from ObjectBase
using	SlotVariantFunc = std::function< void(const VariantList &)>
	Function type for invoking a slot with a list of Variants.
Static Public Member Functions inherited from MediaNode
static void	registerNodeType (const String &typeName, std::function< MediaNode *()> factory)
	Registers a node type for runtime creation.
static MediaNode *	createNode (const String &typeName)
	Creates a node by registered type name.
static List< String >	registeredNodeTypes ()
	Returns the list of all registered node type names.
Static Public Member Functions inherited from ObjectBase
static const MetaInfo &	metaInfo ()
	Returns the MetaInfo for the ObjectBase class.
template<typename... Args>
static void	connect (Signal< Args... > *signal, Slot< Args... > *slot)
	connects a signal and slot together. This function assumes both the signal and slot exist in a ObjectBase or derived object
Public Attributes inherited from ObjectBase
Signal< ObjectBase * >	aboutToDestroySignal = Signal< ObjectBase * >(this, aboutToDestroySignalName)
Static Public Attributes inherited from ObjectBase
static constexpr const char *	aboutToDestroySignalName = PROMEKI_STRINGIFY( aboutToDestroy ) "(" PROMEKI_STRINGIFY_ARGS( ObjectBase * ) ")"
static SignalMeta	aboutToDestroySignalMeta = SignalMeta(metaInfo(), aboutToDestroySignalName)
Protected Member Functions inherited from MediaNode
void	enqueueInput (Frame::Ptr frame)
	Enqueues a frame into this node's input queue.
void	recordProcessTiming (double duration)
	Records timing for a process() call.
void	recordStarvation ()
	Records a starvation event.
void	addInputPort (MediaPort::Ptr port)
	Adds an input port to this node.
void	addOutputPort (MediaPort::Ptr port)
	Adds an output port to this node.
void	setState (State state)
	Sets the node state and emits stateChanged.
Frame::Ptr	dequeueInput ()
	Dequeues a frame from this node's input queue.
void	deliverOutput (int portIndex, Frame::Ptr frame)
	Delivers a frame to all outgoing links on the given output port.
void	deliverOutput (Frame::Ptr frame)
	Delivers a frame to all outgoing links on all output ports.
void	emitMessage (Severity severity, const String &message, uint64_t frameNumber=0)
	Emits a message with the given severity and text.
void	emitWarning (const String &message)
	Emits a Warning-severity message.
void	emitError (const String &message)
	Emits an Error-severity message.
Protected Member Functions inherited from ObjectBase
ObjectBase *	signalSender ()
	Returns the ObjectBase that emitted the signal currently being handled.
virtual void	event (Event *e)
	Called by EventLoop to deliver events to this object.
virtual void	timerEvent (TimerEvent *e)
	Called when a timer fires for this object.

Detailed Description

Splits a Frame into separate Image and Audio streams.

Utility node with one Frame input port, one Image output port, and one Audio output port. Extracts the image and audio from each incoming Frame and delivers them to the respective output ports. Metadata from the Frame is propagated to both output streams.

If the input Frame has no audio, only the Image output is produced.

Example

FrameDemuxNode *demux = new FrameDemuxNode();
graph.connect(source, 0, demux, 0);       // Frame input
graph.connect(demux, 0, videoSink, 0);     // Image output
graph.connect(demux, 1, audioSink, 0);     // Audio output

Constructor & Destructor Documentation

FrameDemuxNode()

FrameDemuxNode::FrameDemuxNode

(

ObjectBase *

parent = nullptr

)

Constructs a FrameDemuxNode.

Parameters

parent

Optional parent object.

Member Function Documentation

configure()

Error FrameDemuxNode::configure ( )

overridevirtual

Validates ports and allocates resources.

Transitions the node from Idle to Configured on success.

Returns

Error::Ok on success, or an error code.

Reimplemented from MediaNode.

process()

void FrameDemuxNode::process ( )

overridevirtual

Processes one cycle of data.

Pure virtual — must be implemented by concrete node subclasses.

Implements MediaNode.

---

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

• include/promeki/proav/framedemuxnode.h