Resource in which input media from source outside the flowgraph is introduced. More...

#include <MprToOutputDevice.h>

Inheritance diagram for MprToOutputDevice:

Collaboration diagram for MprToOutputDevice:

Public Member Functions
Creators
	MprToOutputDevice (const UtlString &rName, MpOutputDeviceManager *deviceManager, MpOutputDeviceHandle deviceId)
	Default constructor. More...

virtual	~MprToOutputDevice ()
	Destructor. More...

Accessors
OsMsgQ *	getCopyQ ()
	Get pointer to the copy queue. More...

Public Member Functions inherited from MpAudioResource
	MpAudioResource (const UtlString &rName, int minInputs, int maxInputs, int minOutputs, int maxOutputs)
	Constructor. More...

virtual	~MpAudioResource ()
	Destructor. More...

virtual UtlBoolean	processFrame (void)
	Wrapper around doProcessFrame(). More...

Public Member Functions inherited from MpResource
	MpResource (const UtlString &rName, int minInputs, int maxInputs, int minOutputs, int maxOutputs)
	Constructor. More...

virtual	~MpResource ()
	Destructor. More...

virtual UtlBoolean	disable ()
	Disable this resource. More...

virtual UtlBoolean	enable ()
	Enable this resource. More...

virtual void	reset ()
	This method is invoked for resources that care about stream discontinuities. More...

UtlBoolean	handleMessages (OsMsgQ &msgQ)
	Handles a queue full of incoming messages for this media processing object. More...

void	setVisitState (int newState)
	Sets the visit state for this resource. More...

OsStatus	sendNotification (MpResNotificationMsg::RNMsgType msgType)
	Send a notification with the given message type if notifications are enabled. More...

OsStatus	sendNotification (MpResNotificationMsg &msg)
	Send the given notification message if notifications are enabled. More...

virtual void	setConnectionId (MpConnectionID connectionId)
	Set the ID of a connection this resource belongs to. More...

virtual void	setStreamId (int streamId)
	Set the ID of a stream inside of the connection this resource belongs to. More...

virtual int	getStreamId (void)
	Get the ID of a stream within the connection this resource belongs to. More...

virtual OsStatus	pushBuffer (int inputPort, MpBufPtr &inputBuffer)
	Receive buffer asynchronously from resource at given input port. More...

virtual void	reassignSSRC (void)
	Broadcast announcement that we are changing our SSRC. More...

MpFlowGraphBase *	getFlowGraph () const
	Returns parent flowgraph. More...

void	getInputInfo (int inPortIdx, MpResource *&rpUpstreamResource, int &rUpstreamPortIdx)
	Returns information about the upstream end of a connection. More...

const UtlString &	getName () const
	Returns the name associated with this resource. More...

void	getOutputInfo (int outPortIdx, MpResource *&rpDownstreamResource, int &rDownstreamPortIdx)
	Returns information about the downstream end of a connection. More...

int	getVisitState ()
	Returns the current visit state for this resource. More...

int	maxInputs () const
	Returns the maximum number of inputs supported by this resource. More...

int	maxOutputs () const
	Returns the maximum number of outputs supported by this resource. More...

int	minInputs () const
	Returns the minimum number of inputs required by this resource. More...

int	minOutputs () const
	Returns the minimum number of outputs required by this resource. More...

int	numInputs () const
	Returns the number of resource inputs that are currently connected. More...

int	numOutputs () const
	Returns the number of resource outputs that are currently connected. More...

virtual MpConnectionID	getConnectionId (void) const
	Get the ID of a connection this resource belongs to. More...

int	reserveFirstUnconnectedInput ()
	Find the first unconnected input port and reserve it. More...

int	reserveFirstUnconnectedOutput ()
	Find the first unconnected output port and reserve it. More...

UtlContainableType	getContainableType () const
	Get the ContainableType for a UtlContainable derived class. More...

virtual OsStatus	getCurrentLatency (int &latency, int input=0, int output=0) const
	Get current input to output latency (in samples) More...

UtlBoolean	isEnabled () const
	Returns TRUE is this resource is currently enabled, FALSE otherwise. More...

UtlBoolean	isInputConnected (int portIdx)
	Returns TRUE if portIdx is valid and the indicated input is connected, FALSE otherwise. More...

UtlBoolean	isInputUnconnected (int portIdx)
	Returns TRUE if portIdx is valid and the indicated input is not connected, FALSE otherwise. More...

UtlBoolean	isOutputConnected (int portIdx)
	Returns TRUE if portIdx is valid and the indicated output is connected, FALSE otherwise. More...

UtlBoolean	isOutputUnconnected (int portIdx)
	Returns TRUE if portIdx is valid and the indicated output is not connected, FALSE otherwise. More...

UtlBoolean	areNotificationsEnabled () const
	Returns TRUE if notification sending is enabled on this resource. More...

virtual UtlBoolean	isAsynchInput (int inputIndex)
	Takes asynchronous input (pushBuffer). More...

Protected Member Functions
UtlBoolean	handleSetOutputDeviceId (const MpIntResourceMsg &message)

Protected Member Functions inherited from MpResource
virtual UtlBoolean	handleMessage (MpFlowGraphMsg &fgMsg)
	Handles an incoming flowgraph message for this media processing object. More...

virtual UtlBoolean	handleDisable ()
	perform the disable operation on the resource More...

void	setInputBuffer (int inPortIdx, const MpBufPtr &pBuf)
	If there already is a buffer stored for this input port, delete it. Then store `pBuf` for the indicated input port. More...

OsStatus	postMessage (MpFlowGraphMsg &rMsg)
	Post a message from this resource. More...

OsStatus	postMessage (MpResourceMsg &rMsg)
	Post a message for this resource. More...

UtlBoolean	pushBufferDownsream (int outPortIdx, const MpBufPtr &pBuf)
	Makes `pBuf` available to resource connected to the `outPortIdx` output port of this resource. More...

virtual OsStatus	setFlowGraph (MpFlowGraphBase *pFlowGraph)
	Associates this resource with the indicated flow graph. More...

virtual OsStatus	setNotificationsEnabled (UtlBoolean enable)
	Sets whether or not this resource should send notifications. More...

virtual UtlBoolean	connectInput (MpResource &rFrom, int fromPortIdx, int toPortIdx)
	Connects the `toPortIdx` input port on this resource to the `fromPortIdx` output port of the `rFrom` resource. More...

virtual UtlBoolean	connectOutput (MpResource &rTo, int toPortIdx, int fromPortIdx)
	Connects the `fromPortIdx` output port on this resource to the `toPortIdx` input port of the `rTo` resource. More...

virtual UtlBoolean	disconnectInput (int inPortIdx)
	Removes the connection to the `inPortIdx` input port of this resource. More...

virtual UtlBoolean	disconnectOutput (int outPortIdx)
	Removes the connection to the `outPortIdx` output port of this resource. More...

void	setName (const UtlString &rName)
	Sets the name that is associated with this resource. More...

Private Types
enum	AddlResMsgTypes { MPRM_ENABLE_COPY_QUEUE = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START, MPRM_DISABLE_COPY_QUEUE, MPRM_SET_OUTPUT_DEVICE_ID }

Private Member Functions
virtual UtlBoolean	doProcessFrame (MpBufPtr inBufs[], MpBufPtr outBufs[], int inBufsSize, int outBufsSize, UtlBoolean isEnabled, int samplesPerFrame, int samplesPerSecond)
	This method does the real work for the media processing resource and must be defined in each class derived from this one. More...

virtual UtlBoolean	handleMessage (MpResourceMsg &rMsg)
	Handles an incoming flowgraph message for this media processing object. More...

virtual UtlBoolean	handleEnable ()
	perform the enable operation on the resource More...

	MprToOutputDevice (const MprToOutputDevice &rMprToOutputDevice)
	Copy constructor (not implemented for this class) More...

MprToOutputDevice &	operator= (const MprToOutputDevice &rhs)
	Assignment operator (not implemented for this class) More...

Private Attributes
MpOutputDeviceManager *	mpOutputDeviceManager

UtlBoolean	mFrameTimeInitialized

MpFrameTime	mFrameTime

MpFrameTime	mMixerBufferPosition

MpFrameTime	mLastPushedTime

MpOutputDeviceHandle	mDeviceId

MpResamplerBase *	mpResampler

OsMsgQ	mCopyQ

OsMsgPool	mCopyQPool
	Pool for messages to be sent to mCopyQ. More...

UtlBoolean	mIsCopyQEnabled
	Should we copy data to mCopyQ or not? More...

Manipulators
OsStatus	enableCopyQ (UtlBoolean enable)
	Send message to enable/disable copy queue. More...

static OsStatus	setDeviceId (const UtlString &resourceName, OsMsgQ &flowgraphMessageQueue, MpOutputDeviceHandle deviceId)
	Send a message to the named MprToOutputDevice in the given flowgraph, to set the output device. More...

static OsStatus	enableCopyQ (const UtlString &namedResource, OsMsgQ &fgQ, UtlBoolean enable)
	Send message to enable/disable copy queue. More...

Additional Inherited Members
Public Types inherited from MpResource
enum	VisitState { NOT_VISITED, IN_PROGRESS, FINISHED }
	Graph traversal states that are used when running a topological sort to order resources within a flow graph. More...

enum	{ ASSOCIATED_LATENCY =-1, INF_LATENCY =-1 }

Static Public Member Functions inherited from MpResource
static OsStatus	disable (const UtlString &namedResource, OsMsgQ &fgQ)
	Post a message to disable the resource named. More...

static OsStatus	enable (const UtlString &namedResource, OsMsgQ &fgQ)
	Post a message to enable the resource named. More...

static OsStatus	setNotificationsEnabled (UtlBoolean enable, const UtlString &namedResource, OsMsgQ &fgQ)
	Post a message to enable or disable resource notifications on the named resource. More...

static void	resourceInfo (MpResource *pResource, int index)
	Displays information on the console about the specified resource. More...

Static Public Attributes inherited from MpResource
static const UtlContainableType	TYPE = "MpResource"
	Class name, used for run-time checks. More...

Protected Attributes inherited from MpResource
MpFlowGraphBase *	mpFlowGraph
	flow graph this resource belongs to More...

MpConnectionID	mConnectionId
	The ID of connection this resource belongs to. More...

int	mStreamId

UtlBoolean	mIsEnabled
	TRUE if resource is enabled, FALSE otherwise. More...

OsRWMutex	mRWMutex
	reader/writer lock for synchronization More...

MpBufPtr *	mpInBufs
	input buffers for this resource More...

MpBufPtr *	mpOutBufs
	output buffers for this resource More...

Conn *	mpInConns
	input connections for this resource More...

Conn *	mpOutConns
	output connections for this resource More...

int	mMaxInputs
	maximum number of inputs More...

int	mMaxOutputs
	maximum number of outputs More...

int	mMinInputs
	number of required inputs More...

int	mMinOutputs
	number of required outputs More...

int	mNumActualInputs
	actual number of connected inputs More...

int	mNumActualOutputs
	actual number of connected outputs More...

int	mVisitState
	(used by flow graph topological sort alg.) More...

UtlBoolean	mNotificationsEnabled
	Whether we should send notifications or not. More...

OsBSem	mLock
	used mainly to make safe changes to ports More...

Static Protected Attributes inherited from MpResource
static const OsTime	sOperationQueueTimeout = OsTime::OS_INFINITY
	The timeout for message operations for all resources when posting to the flowgraph queue. More...

Detailed Description

Resource in which input media from source outside the flowgraph is introduced.

The MprToOutputDevice get frames of media from its MpOutputDeviceManager. The MpOutputDeviceManager provides some simple buffering of frames from each device for a small window of time. It is the MprToOutputDevice responsibility to decide how current to keep (e.g. delay to prevent starvation) with the frames in the MpOutputDeviceManager for the specific device to which is sent output.

The MprToOutputDevice also maintains so called "copy queue" - a queue to which a copies of buffers are sent. Only copies of buffers accepted by the device are sent to the copy queue. This queue is usually used by echo canceler.

Member Enumeration Documentation

enum AddlResMsgTypes

private

Enumerator
MPRM_ENABLE_COPY_QUEUE
MPRM_DISABLE_COPY_QUEUE
MPRM_SET_OUTPUT_DEVICE_ID

Constructor & Destructor Documentation

MprToOutputDevice	(	const UtlString &	rName,
		MpOutputDeviceManager *	deviceManager,
		MpOutputDeviceHandle	deviceId
	)

Default constructor.

~MprToOutputDevice ( )

virtual

Destructor.

MprToOutputDevice ( const MprToOutputDevice & rMprToOutputDevice )

private

Copy constructor (not implemented for this class)

Member Function Documentation

OsStatus setDeviceId	(	const UtlString &	resourceName,
		OsMsgQ &	flowgraphMessageQueue,
		MpOutputDeviceHandle	deviceId
	)

static

Send a message to the named MprToOutputDevice in the given flowgraph, to set the output device.

Parameters

[in]	resourceName	- the name of the resource to send a message to.
[in]	flowgraphMessageQueue	- the queue of the flowgraph containing the resource which the message is to be received by.
	deviceId	- output device ID for the MpOutputDeviceManager on which this resource is to send its output.

OsStatus enableCopyQ	(	const UtlString &	namedResource,
		OsMsgQ &	fgQ,
		UtlBoolean	enable
	)

static

Send message to enable/disable copy queue.

Parameters

[in]	namedResource	- the name of the resource to send a message to.
[in]	fgQ	- the queue of the flowgraph containing the resource which the message is to be received by.
[in]	enable	- TRUE to enable copy queue, FALSE to disable it.

Returns: the result of attempting to queue the message to this resource.

OsStatus enableCopyQ ( UtlBoolean enable )

Send message to enable/disable copy queue.

Parameters

[in] enable - TRUE to enable copy queue, FALSE to disable it.

Returns: the result of attempting to queue the message to this resource.

OsMsgQ * getCopyQ ( )

inline

Get pointer to the copy queue.

UtlBoolean handleSetOutputDeviceId ( const MpIntResourceMsg & message )

protected

UtlBoolean doProcessFrame	(	MpBufPtr	inBufs[],
		MpBufPtr	outBufs[],
		int	inBufsSize,
		int	outBufsSize,
		UtlBoolean	isEnabled,
		int	samplesPerFrame,
		int	samplesPerSecond
	)

privatevirtual

This method does the real work for the media processing resource and must be defined in each class derived from this one.

Parameters

inBufs	(in) array of pointers to input buffers for the resource
outBufs	(out) array of pointers to output buffers produce by the resource
inBufsSize	(in) size of the inBufs array
outBufsSize	(in) size of the outBufs array
isEnabled	(in) indicates whether this resource has been enabled
samplesPerFrame	(in) samples to produce per frame processing interval
samplesPerSecond	(in) samples to produce per second

Returns: TRUE if successful, FALSE otherwise.

Implements MpAudioResource.

UtlBoolean handleMessage ( MpResourceMsg & rMsg )

privatevirtual

Handles an incoming flowgraph message for this media processing object.

Returns: TRUE if the message was handled, otherwise FALSE.

Reimplemented from MpResource.

UtlBoolean handleEnable ( void )

privatevirtual

perform the enable operation on the resource

Reimplemented from MpResource.

MprToOutputDevice& operator= ( const MprToOutputDevice & rhs )

private

Assignment operator (not implemented for this class)

Member Data Documentation

MpOutputDeviceManager* mpOutputDeviceManager

private

UtlBoolean mFrameTimeInitialized

private

MpFrameTime mFrameTime

private

MpFrameTime mMixerBufferPosition

private

MpFrameTime mLastPushedTime

private

MpOutputDeviceHandle mDeviceId

private

MpResamplerBase* mpResampler

private

OsMsgQ mCopyQ

private

Queue for the copy of data sent to output device. It is usually used by acoustic echo canceler.

OsMsgPool mCopyQPool

private

Pool for messages to be sent to mCopyQ.

UtlBoolean mIsCopyQEnabled

private

Should we copy data to mCopyQ or not?

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Manipulators

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation