Terminal sink node that sends video frames over RTP. More...

#include <rtpvideosinknode.h>

Inheritance diagram for RtpVideoSinkNode:

[legend]

Collaboration diagram for RtpVideoSinkNode:

[legend]

Public Member Functions
	RtpVideoSinkNode (ObjectBase *parent=nullptr)
	Constructs an RtpVideoSinkNode.

	~RtpVideoSinkNode () override
	Destructor.

void	setFrameRate (const FrameRate &fps)
	Sets the video frame rate for pacing.

const FrameRate &	frameRate () const
	Returns the configured frame rate.

void	setPayloadType (uint8_t pt)
	Sets the RTP payload type number.

uint8_t	payloadType () const
	Returns the RTP payload type.

void	setClockRate (uint32_t hz)
	Sets the RTP timestamp clock rate.

uint32_t	clockRate () const
	Returns the RTP clock rate.

void	setDumpPath (const String &path)
	Sets a file path to dump the first frame's raw data.

const String &	dumpPath () const
	Returns the dump path.

void	setDscp (uint8_t dscp)
	Sets the DSCP value for QoS marking.

uint8_t	dscp () const
	Returns the DSCP value.

Error	configure () override
	Validates configuration and creates the RTP session.

Error	start () override
	Starts the RTP session and optionally joins a multicast group.

void	stop () override
	Stops the RTP session.

void	process () override
	Sends a video frame over RTP with real-time pacing.

void	starvation () override
	Records a video underrun event.

Map< String, Variant >	extendedStats () const override
	Returns video sink statistics.

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 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.

	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

Terminal sink node that sends video frames over RTP.

RtpVideoSinkNode is a terminal MediaNode with one Image input and no outputs. It paces video frame transmission at the configured frame rate and sends RTP packets via the provided RtpPayload handler and RtpSession.

The node acts as the real-time pacing authority in a pipeline — it sleeps between frames to maintain the target frame rate, preventing drift from processing time.

Example: RtpPayloadJpeg payload(1920, 1080);

RtpVideoSinkNode *sink = new RtpVideoSinkNode();

sink->setDestination(SocketAddress(Ipv4Address("239.0.0.1"), 5004));

sink->setFrameRate(FrameRate::FPS_30);

sink->setRtpPayload(&payload);

sink->configure();

sink->start();

Ipv4Address
IPv4 network address.
Definition ipv4address.h:51

RtpPayloadJpeg
RTP payload handler for RFC 2435 JPEG (Motion JPEG).
Definition rtppayload.h:264

RtpVideoSinkNode
Terminal sink node that sends video frames over RTP.
Definition rtpvideosinknode.h:50

RtpVideoSinkNode::configure
Error configure() override
Validates configuration and creates the RTP session.

RtpVideoSinkNode::setFrameRate
void setFrameRate(const FrameRate &fps)
Sets the video frame rate for pacing.
Definition rtpvideosinknode.h:86

RtpVideoSinkNode::start
Error start() override
Starts the RTP session and optionally joins a multicast group.

SocketAddress
Network address with port number.
Definition socketaddress.h:50

Constructor & Destructor Documentation

◆ RtpVideoSinkNode()

RtpVideoSinkNode::RtpVideoSinkNode ( ObjectBase * parent = nullptr )

Constructs an RtpVideoSinkNode.

Parameters

parent Optional parent object.

Member Function Documentation

◆ configure()

Error RtpVideoSinkNode::configure ( )

overridevirtual

Validates configuration and creates the RTP session.

Checks that an RTP payload handler, destination address, and frame rate are set. Computes the RTP timestamp increment and frame interval for pacing.

Returns: Error::Ok on success, or Error::Invalid.

Reimplemented from MediaNode.

◆ extendedStats()

Map< String, Variant > RtpVideoSinkNode::extendedStats ( ) const

overridevirtual

Returns video sink statistics.

Returns: A map containing packetsSent, bytesSent, and underrunCount.

Reimplemented from MediaNode.

◆ process()

void RtpVideoSinkNode::process ( )

overridevirtual

Sends a video frame over RTP with real-time pacing.

Dequeues a Frame from the input port, packs the image data into RTP packets via the payload handler, sleeps to maintain the target frame rate, and sends the packets.

Implements MediaNode.

◆ setClockRate()

void RtpVideoSinkNode::setClockRate ( uint32_t hz )

inline

Sets the RTP timestamp clock rate.

Parameters

hz	Clock rate in Hz (default: 90000).

◆ setDscp()

void RtpVideoSinkNode::setDscp ( uint8_t dscp )

inline

Sets the DSCP value for QoS marking.

Parameters

dscp	DSCP value (default: 34, AF41 for broadcast video).

◆ setDumpPath()

void RtpVideoSinkNode::setDumpPath ( const String & path )

inline

Sets a file path to dump the first frame's raw data.

When set, the first frame processed will be written to this path as-is (e.g. a complete JPEG file for MJPEG transport). Useful for diagnosing encoding or packing issues.

Parameters

path	Output file path, or empty to disable.

◆ setFrameRate()

void RtpVideoSinkNode::setFrameRate ( const FrameRate & fps )

inline

Sets the video frame rate for pacing.

Parameters

fps	The target frame rate.

◆ setPayloadType()

void RtpVideoSinkNode::setPayloadType ( uint8_t pt )

inline

Sets the RTP payload type number.

Parameters

pt	Payload type (default: 96).

◆ start()

Error RtpVideoSinkNode::start ( )

overridevirtual

Starts the RTP session and optionally joins a multicast group.

Returns: Error::Ok on success, or an error if the session cannot start.

Reimplemented from MediaNode.

◆ starvation()

void RtpVideoSinkNode::starvation ( )

overridevirtual

Records a video underrun event.

Reimplemented from MediaNode.

◆ stop()

void RtpVideoSinkNode::stop ( )

overridevirtual

Stops the RTP session.

Reimplemented from MediaNode.

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

include/promeki/proav/rtpvideosinknode.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RtpVideoSinkNode()

Member Function Documentation

◆ configure()

◆ extendedStats()

◆ process()

◆ setClockRate()

◆ setDscp()

◆ setDumpPath()

◆ setFrameRate()

◆ setPayloadType()

◆ start()

◆ starvation()

◆ stop()