Module Class Reference

#include <Module.h>

Inherited by AbsControlModule, AffineTransform, ArchiveSpaceManager, AudioCaptureSrc, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CCNPPI, CalcHistogramCV, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, EglRenderer, ExternalSinkModule, ExternalSourceModule, FaceDetectorXform, FacialLandmarkCV, FileReaderModule, FileWriterModule, FramesMuxer, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, ImageViewerModule, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, KeyboardListener, MemTypeConversion, Merge, MotionVectorExtractor, Mp4ReaderSource, Mp4WriterSink, MultimediaQueueXform, NvArgusCamera, NvTransform, NvV4L2Camera, OverlayModule, OverlayNPPI, QRReader, RTSPClientSrc, RTSPPusher, ResizeNPPI, RotateCV, RotateNPPI, Split, StatSink, TestSignalGenerator, TextOverlayXForm, ThumbnailListGenerator, ValveModule, VirtualCameraSink, VirtualPTZ, and WebCamSource.

Collaboration diagram for Module:

Classes
class	FFBufferMaker
class	Profiler

Public Types
enum	Kind { SOURCE , TRANSFORM , SINK , CONTROL }
enum	ModuleState { Initialized , Running , EndOfStreamNormal , EndOfStreamSocketError }

Public Member Functions
	Module (Kind nature, string name, ModuleProps _props)
virtual	~Module ()
Kind	getNature ()
string	getName ()
string	getId ()
double	getPipelineFps ()
uint64_t	getTickCounter ()
string	addOutputPin (framemetadata_sp &metadata)
vector< string >	getAllOutputPinsByType (int type)
void	addOutputPin (framemetadata_sp &metadata, string &pinId)
bool	setNext (boost::shared_ptr< Module > next, vector< string > &pinIdArr, bool open=true)
virtual bool	setNext (boost::shared_ptr< Module > next, bool open=true, bool sieve=true)
bool	addFeedback (boost::shared_ptr< Module > next, vector< string > &pinIdArr, bool open=true)
bool	addFeedback (boost::shared_ptr< Module > next, bool open=true)
boost_deque< boost::shared_ptr< Module > >	getConnectedModules ()
bool	relay (boost::shared_ptr< Module > next, bool open, bool priority=false)
virtual bool	init ()
void	operator() ()
virtual bool	run ()
bool	play (float speed, bool direction=true)
bool	play (bool play)
bool	queueStep ()
virtual bool	step ()
virtual bool	stop ()
virtual bool	term ()
virtual bool	isFull ()
bool	isNextModuleQueFull ()
void	adaptQueue (boost::shared_ptr< FrameContainerQueueAdapter > queAdapter)
void	register_consumer (boost::function< void(Module *, unsigned short)>, bool bFatal=false)
boost::shared_ptr< PaceMaker >	getPacer ()
virtual void	flushQue ()
bool	getPlayDirection ()
virtual void	flushQueRecursive ()
virtual void	addControlModule (boost::shared_ptr< Module > cModule)
void	registerHealthCallback (APHealthCallback callback)
void	executeErrorCallback (const APErrorObject &error)
void	registerErrorCallback (APErrorCallback callback)
ModuleProps	getProps ()

Static Public Member Functions
static frame_sp	getFrameByType (frame_container &frames, int frameType)

Protected Member Functions
virtual boost_deque< frame_sp >	getFrames (frame_container &frames)
virtual bool	process (frame_container &frames)
virtual bool	processEOS (string &pinId)
virtual bool	processSOS (frame_sp &frame)
virtual bool	shouldTriggerSOS ()
virtual bool	produce ()
bool	stepNonSource (frame_container &frames)
bool	preProcessNonSource (frame_container &frames)
bool	preProcessControl (frame_container &frames)
bool	isRunning ()
void	setProps (ModuleProps &props)
void	fillProps (ModuleProps &props)
template<class T >
void	addPropsToQueue (T &props, bool priority=false)
virtual bool	handlePropsChange (frame_sp &frame)
virtual bool	handleCommand (Command::CommandType type, frame_sp &frame)
template<class T >
bool	handlePropsChange (frame_sp &frame, T &props)
template<class T >
bool	queuePriorityCommand (T &cmd)
template<class T >
bool	queueCommand (T &cmd, bool priority=false)
template<class T >
void	getCommand (T &cmd, frame_sp &frame)
bool	queuePlayPauseCommand (PlayPauseCommand ppCmd, bool priority=false)
frame_sp	makeCommandFrame (size_t size, framemetadata_sp &metadata)
frame_sp	makeFrame (size_t size, string &pinId)
frame_sp	makeFrame (size_t size)
frame_sp	makeFrame ()
frame_sp	makeFrame (frame_sp &bigFrame, size_t &newSize, string &pinId)
frame_sp	getEOSFrame ()
frame_sp	getEmptyFrame ()
void	setMetadata (std::string &pinId, framemetadata_sp &metadata)
virtual bool	send (frame_container &frames, bool forceBlockingPush=false)
virtual void	sendEOS ()
virtual void	sendEOS (frame_sp &frame)
virtual void	sendMp4ErrorFrame (frame_sp &frame)
virtual void	sendEoPFrame ()
void	ignore (int times)
void	stop_onStepfail ()
void	emit_event (unsigned short eventID)
void	emit_fatal (unsigned short eventID)
void	setModuleState (enum ModuleState es)
ModuleState	getModuleState ()
virtual bool	validateInputPins ()
virtual bool	validateOutputPins ()
virtual bool	validateInputOutputPins ()
size_t	getNumberOfOutputPins (bool implicit=true)
size_t	getNumberOfInputPins ()
framemetadata_sp	getFirstInputMetadata ()
framemetadata_sp	getFirstOutputMetadata ()
framemetadata_sp	getOutputMetadata (string outPinID)
metadata_by_pin &	getInputMetadata ()
framefactory_by_pin &	getOutputFrameFactory ()
framemetadata_sp	getInputMetadataByType (int type)
int	getNumberOfInputsByType (int type)
int	getNumberOfOutputsByType (int type)
framemetadata_sp	getOutputMetadataByType (int type)
bool	isMetadataEmpty (framemetadata_sp &metadata)
bool	isFrameEmpty (frame_sp &frame)
string	getInputPinIdByType (int type)
string	getOutputPinIdByType (int type)
bool	setNext (boost::shared_ptr< Module > next, bool open, bool isFeedback, bool sieve)
bool	setNext (boost::shared_ptr< Module > next, vector< string > &pinIdArr, bool open, bool isFeedback, bool sieve)
void	addInputPin (framemetadata_sp &metadata, string &pinId, bool isFeedback)
virtual void	addInputPin (framemetadata_sp &metadata, string &pinId)
boost::shared_ptr< FrameContainerQueue >	getQue ()
bool	getPlayState ()
Connections	getConnections ()
frame_container	try_pop ()
frame_container	pop ()
bool	processSourceQue ()
bool	handlePausePlay (bool play)
virtual bool	handlePausePlay (float speed=1, bool direction=true)
virtual void	notifyPlay (bool play)
FFBufferMaker	createFFBufferMaker ()

Protected Attributes
boost::function< void()>	onStepFail
boost::function< void(Module *, unsigned short)>	event_consumer
boost::function< void(Module *, unsigned short)>	fatal_event_consumer
enum ModuleState	module_state
boost::shared_ptr< Module >	controlModule = nullptr

Private Member Functions
void	setSieveDisabledFlag (bool sieve)
frame_sp	makeFrame (size_t size, framefactory_sp &framefactory)
bool	push (frame_container frameContainer)
bool	push_back (frame_container frameContainer)
bool	try_push (frame_container frameContainer)
bool	addEoPFrame (frame_container &frames)
bool	handleStop ()
template<class T >
void	serialize (T &props, frame_sp &frame)
template<class T >
void	deSerialize (T &props, frame_sp &frame)
bool	shouldForceStep ()
bool	shouldSkip ()
bool	isFeedbackEnabled (std::string &moduleId)

Private Attributes
bool	mPlay
bool	mDirection
float	mSpeed
uint32_t	mForceStepCount
int	mSkipIndex
Kind	myNature
string	myName
string	myId
boost::thread	myThread
boost::shared_ptr< FrameContainerQueue >	mQue
bool	mRunning
uint32_t	mStopCount
uint32_t	mForwardPins
bool	mIsSieveDisabledForAny = false
boost::shared_ptr< FrameFactory >	mpFrameFactory
boost::shared_ptr< FrameFactory >	mpCommandFactory
boost::shared_ptr< PaceMaker >	pacer
APErrorCallback	mErrorCallback
Connections	mConnections
map< string, boost::shared_ptr< Module > >	mModules
map< string, bool >	mRelay
std::map< std::string, bool >	mInputPinsDirection
metadata_by_pin	mInputPinIdMetadataMap
framefactory_by_pin	mOutputPinIdFrameFactoryMap
std::shared_ptr< FIndexStrategy >	mFIndexStrategy
boost::shared_ptr< Profiler >	mProfiler
boost::shared_ptr< ModuleProps >	mProps
boost::shared_ptr< QuePushStrategy >	mQuePushStrategy
framemetadata_sp	mCommandMetadata
framemetadata_sp	mPropsChangeMetadata
APHealthCallback	mHealthCallback

Friends
class	PipeLine

Member Enumeration Documentation

Kind

enum Module::Kind

Enumerator
SOURCE
TRANSFORM
SINK
CONTROL

ModuleState

enum Module::ModuleState

Enumerator
Initialized
Running
EndOfStreamNormal
EndOfStreamSocketError

Constructor & Destructor Documentation

Module()

Module::Module	(	Kind	nature,
		string	name,
		ModuleProps	_props )

Here is the call graph for this function:

~Module()

Module::~Module ( )

virtual

Member Function Documentation

adaptQueue()

void Module::adaptQueue

(

boost::shared_ptr< FrameContainerQueueAdapter >

queAdapter

)

Here is the caller graph for this function:

addControlModule()

void Module::addControlModule ( boost::shared_ptr< Module > cModule )

virtual

addEoPFrame()

bool Module::addEoPFrame ( frame_container & frames )

private

Here is the caller graph for this function:

addFeedback() [1/2]

bool Module::addFeedback	(	boost::shared_ptr< Module >	next,
		bool	open = true )

Here is the call graph for this function:

addFeedback() [2/2]

bool Module::addFeedback	(	boost::shared_ptr< Module >	next,
		vector< string > &	pinIdArr,
		bool	open = true )

Here is the call graph for this function:

addInputPin() [1/2]

void Module::addInputPin ( framemetadata_sp & metadata, string & pinId )

protectedvirtual

Reimplemented in AffineTransform, ArchiveSpaceManager, AudioToTextXForm, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, FaceDetectorXform, FacialLandmarkCV, FramesMuxer, GaussianBlur, H264Decoder, ImageResizeCV, ImageViewerModule, KeyboardListener, MemTypeConversion, Merge, Mp4WriterSink, MultimediaQueueXform, NvTransform, OverlayModule, OverlayNPPI, ResizeNPPI, RotateCV, RotateNPPI, Split, TextOverlayXForm, ValveModule, and VirtualPTZ.

Here is the call graph for this function:

addInputPin() [2/2]

void Module::addInputPin ( framemetadata_sp & metadata, string & pinId, bool isFeedback )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

addOutputPin() [1/2]

string Module::addOutputPin

(

framemetadata_sp &

metadata

)

Here is the call graph for this function:

Here is the caller graph for this function:

addOutputPin() [2/2]

void Module::addOutputPin	(	framemetadata_sp &	metadata,
		string &	pinId )

Here is the call graph for this function:

addPropsToQueue()

template<class T >

void Module::addPropsToQueue ( T & props, bool priority = false )

inlineprotected

Here is the call graph for this function:

Here is the caller graph for this function:

createFFBufferMaker()

FFBufferMaker Module::createFFBufferMaker ( )

protected

deSerialize()

template<class T >

void Module::deSerialize ( T & props, frame_sp & frame )

inlineprivate

Here is the caller graph for this function:

emit_event()

void Module::emit_event ( unsigned short eventID )

protected

emit_fatal()

void Module::emit_fatal ( unsigned short eventID )

protected

executeErrorCallback()

void Module::executeErrorCallback

(

const APErrorObject &

error

)

Here is the call graph for this function:

Here is the caller graph for this function:

fillProps()

void Module::fillProps ( ModuleProps & props )

protected

Here is the caller graph for this function:

flushQue()

void Module::flushQue ( )

virtual

Reimplemented in H264Decoder.

Here is the caller graph for this function:

flushQueRecursive()

void Module::flushQueRecursive ( )

virtual

Here is the call graph for this function:

getAllOutputPinsByType()

vector< string > Module::getAllOutputPinsByType

(

int

type

)

getCommand()

template<class T >

void Module::getCommand ( T & cmd, frame_sp & frame )

inlineprotected

Here is the call graph for this function:

Here is the caller graph for this function:

getConnectedModules()

boost::container::deque< boost::shared_ptr< Module > > Module::getConnectedModules

(

)

getConnections()

Connections Module::getConnections ( )

inlineprotected

getEmptyFrame()

frame_sp Module::getEmptyFrame ( )

protected

getEOSFrame()

frame_sp Module::getEOSFrame ( )

protected

getFirstInputMetadata()

framemetadata_sp Module::getFirstInputMetadata ( )

protected

Here is the caller graph for this function:

getFirstOutputMetadata()

framemetadata_sp Module::getFirstOutputMetadata ( )

protected

Here is the caller graph for this function:

getFrameByType()

frame_sp Module::getFrameByType ( frame_container & frames, int frameType )

static

Here is the caller graph for this function:

getFrames()

boost_deque< frame_sp > Module::getFrames ( frame_container & frames )

protectedvirtual

getId()

string Module::getId ( )

inline

getInputMetadata()

metadata_by_pin & Module::getInputMetadata ( )

inlineprotected

Here is the caller graph for this function:

getInputMetadataByType()

framemetadata_sp Module::getInputMetadataByType ( int type )

protected

Here is the caller graph for this function:

getInputPinIdByType()

string Module::getInputPinIdByType ( int type )

protected

Here is the caller graph for this function:

getModuleState()

ModuleState Module::getModuleState ( )

inlineprotected

getName()

string Module::getName ( )

inline

getNature()

Kind Module::getNature ( )

inline

getNumberOfInputPins()

size_t Module::getNumberOfInputPins ( )

inlineprotected

getNumberOfInputsByType()

int Module::getNumberOfInputsByType ( int type )

protected

Here is the caller graph for this function:

getNumberOfOutputPins()

size_t Module::getNumberOfOutputPins ( bool implicit = true )

inlineprotected

getNumberOfOutputsByType()

int Module::getNumberOfOutputsByType ( int type )

protected

getOutputFrameFactory()

framefactory_by_pin & Module::getOutputFrameFactory ( )

inlineprotected

Here is the caller graph for this function:

getOutputMetadata()

framemetadata_sp Module::getOutputMetadata ( string outPinID )

protected

Here is the caller graph for this function:

getOutputMetadataByType()

framemetadata_sp Module::getOutputMetadataByType ( int type )

protected

Here is the caller graph for this function:

getOutputPinIdByType()

string Module::getOutputPinIdByType ( int type )

protected

Here is the caller graph for this function:

getPacer()

boost::shared_ptr< PaceMaker > Module::getPacer ( )

inline

getPipelineFps()

double Module::getPipelineFps

(

)

getPlayDirection()

bool Module::getPlayDirection ( )

inline

Here is the caller graph for this function:

getPlayState()

bool Module::getPlayState ( )

inlineprotected

Here is the caller graph for this function:

getProps()

ModuleProps Module::getProps

(

)

getQue()

boost::shared_ptr< FrameContainerQueue > Module::getQue ( )

inlineprotected

Here is the caller graph for this function:

getTickCounter()

uint64_t Module::getTickCounter

(

)

handleCommand()

bool Module::handleCommand ( Command::CommandType type, frame_sp & frame )

protectedvirtual

Reimplemented in AbsControlModule, EglRenderer, FileReaderModule, GtkGlRenderer, H264Decoder, ImageViewerModule, Mp4ReaderSource, MultimediaQueueXform, RTSPClientSrc, and ValveModule.

Here is the call graph for this function:

Here is the caller graph for this function:

handlePausePlay() [1/2]

bool Module::handlePausePlay ( bool play )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

handlePausePlay() [2/2]

bool Module::handlePausePlay ( float speed = 1, bool direction = true )

protectedvirtual

Reimplemented in Mp4ReaderSource.

Here is the call graph for this function:

handlePropsChange() [1/2]

bool Module::handlePropsChange ( frame_sp & frame )

protectedvirtual

Reimplemented in AbsControlModule, AffineTransform, ArchiveSpaceManager, AudioCaptureSrc, AudioToTextXForm, BrightnessContrastControl, CalcHistogramCV, EffectsNPPI, FaceDetectorXform, FacialLandmarkCV, FileReaderModule, GaussianBlur, MotionVectorExtractor, Mp4ReaderSource, Mp4WriterSink, MultimediaQueueXform, OverlayNPPI, RTSPClientSrc, TestSignalGenerator, TextOverlayXForm, ThumbnailListGenerator, ValveModule, VirtualPTZ, and WebCamSource.

Here is the caller graph for this function:

handlePropsChange() [2/2]

template<class T >

bool Module::handlePropsChange ( frame_sp & frame, T & props )

inlineprotected

Here is the call graph for this function:

handleStop()

bool Module::handleStop ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

ignore()

void Module::ignore ( int times )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

init()

bool Module::init ( )

virtual

Reimplemented in AbsControlModule, AffineTransform, ArchiveSpaceManager, AudioCaptureSrc, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, EglRenderer, ExternalSourceModule, FaceDetectorXform, FacialLandmarkCV, FileReaderModule, FileWriterModule, FramesMuxer, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, ImageViewerModule, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, KeyboardListener, MemTypeConversion, Merge, MotionVectorExtractor, Mp4ReaderSource, Mp4WriterSink, MultimediaQueueXform, NvArgusCamera, NvTransform, NvV4L2Camera, OverlayModule, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPClientSrc, RTSPPusher, Split, StatSink, TestSignalGenerator, TextOverlayXForm, ThumbnailListGenerator, ValveModule, VirtualCameraSink, VirtualPTZ, and WebCamSource.

Here is the call graph for this function:

isFeedbackEnabled()

bool Module::isFeedbackEnabled ( std::string & moduleId )

private

isFrameEmpty()

bool Module::isFrameEmpty ( frame_sp & frame )

protected

Here is the caller graph for this function:

isFull()

bool Module::isFull ( )

virtual

isMetadataEmpty()

bool Module::isMetadataEmpty ( framemetadata_sp & metadata )

protected

isNextModuleQueFull()

bool Module::isNextModuleQueFull

(

)

Here is the caller graph for this function:

isRunning()

bool Module::isRunning ( )

inlineprotected

Here is the caller graph for this function:

makeCommandFrame()

frame_sp Module::makeCommandFrame ( size_t size, framemetadata_sp & metadata )

protected

Here is the caller graph for this function:

makeFrame() [1/5]

frame_sp Module::makeFrame ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

makeFrame() [2/5]

frame_sp Module::makeFrame ( frame_sp & bigFrame, size_t & newSize, string & pinId )

protected

makeFrame() [3/5]

frame_sp Module::makeFrame ( size_t size )

protected

Here is the call graph for this function:

makeFrame() [4/5]

frame_sp Module::makeFrame ( size_t size, framefactory_sp & framefactory )

private

makeFrame() [5/5]

frame_sp Module::makeFrame ( size_t size, string & pinId )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

notifyPlay()

virtual void Module::notifyPlay ( bool play )

inlineprotectedvirtual

Reimplemented in FileReaderModule, and RTSPClientSrc.

Here is the caller graph for this function:

operator()()

void Module::operator()

(

)

Here is the call graph for this function:

play() [1/2]

bool Module::play

(

bool

play

)

Here is the call graph for this function:

play() [2/2]

bool Module::play	(	float	speed,
		bool	direction = true )

Here is the call graph for this function:

Here is the caller graph for this function:

pop()

frame_container Module::pop ( )

protected

Here is the caller graph for this function:

preProcessControl()

bool Module::preProcessControl ( frame_container & frames )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

preProcessNonSource()

bool Module::preProcessNonSource ( frame_container & frames )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

process()

virtual bool Module::process ( frame_container & frames )

inlineprotectedvirtual

Reimplemented in AbsControlModule, AffineTransform, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, EglRenderer, FaceDetectorXform, FacialLandmarkCV, FileWriterModule, FramesMuxer, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, ImageViewerModule, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, KeyboardListener, MemTypeConversion, Merge, MotionVectorExtractor, Mp4WriterSink, MultimediaQueueXform, NvTransform, OverlayModule, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPPusher, Split, StatSink, TextOverlayXForm, ThumbnailListGenerator, ValveModule, VirtualCameraSink, and VirtualPTZ.

Here is the caller graph for this function:

processEOS()

virtual bool Module::processEOS ( string & pinId )

inlineprotectedvirtual

Reimplemented in AffineTransform, BMPConverter, CCNPPI, CudaMemCopy, DMAFDToHostCopy, EffectsNPPI, FacialLandmarkCV, GaussianBlur, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, MemTypeConversion, Mp4WriterSink, NvTransform, OverlayNPPI, ResizeNPPI, RotateCV, RotateNPPI, RTSPPusher, and VirtualCameraSink.

Here is the caller graph for this function:

processSOS()

virtual bool Module::processSOS ( frame_sp & frame )

inlineprotectedvirtual

Reimplemented in AffineTransform, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CudaMemCopy, DMAFDToHostCopy, EffectsNPPI, EglRenderer, FaceDetectorXform, FacialLandmarkCV, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, ImageViewerModule, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, MemTypeConversion, MotionVectorExtractor, Mp4WriterSink, NvTransform, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPPusher, TextOverlayXForm, ValveModule, VirtualCameraSink, and VirtualPTZ.

Here is the caller graph for this function:

processSourceQue()

bool Module::processSourceQue ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

produce()

virtual bool Module::produce ( )

inlineprotectedvirtual

Reimplemented in AudioCaptureSrc, FileReaderModule, Mp4ReaderSource, NvArgusCamera, NvV4L2Camera, RTSPClientSrc, TestSignalGenerator, and WebCamSource.

Here is the caller graph for this function:

push()

bool Module::push ( frame_container frameContainer )

private

Here is the caller graph for this function:

push_back()

bool Module::push_back ( frame_container frameContainer )

private

Here is the caller graph for this function:

queueCommand()

template<class T >

bool Module::queueCommand ( T & cmd, bool priority = false )

inlineprotected

Here is the call graph for this function:

Here is the caller graph for this function:

queuePlayPauseCommand()

bool Module::queuePlayPauseCommand ( PlayPauseCommand ppCmd, bool priority = false )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

queuePriorityCommand()

template<class T >

bool Module::queuePriorityCommand ( T & cmd )

inlineprotected

Here is the call graph for this function:

queueStep()

bool Module::queueStep

(

)

Here is the call graph for this function:

register_consumer()

void Module::register_consumer	(	boost::function< void(Module *, unsigned short)>	consumer,
		bool	bFatal = false )

registerErrorCallback()

void Module::registerErrorCallback

(

APErrorCallback

callback

)

registerHealthCallback()

void Module::registerHealthCallback

(

APHealthCallback

callback

)

relay()

bool Module::relay	(	boost::shared_ptr< Module >	next,
		bool	open,
		bool	priority = false )

Here is the call graph for this function:

run()

bool Module::run ( )

virtual

Here is the call graph for this function:

Here is the caller graph for this function:

send()

bool Module::send ( frame_container & frames, bool forceBlockingPush = false )

protectedvirtual

Reimplemented in ExternalSourceModule.

Here is the call graph for this function:

sendEoPFrame()

void Module::sendEoPFrame ( )

protectedvirtual

Here is the call graph for this function:

Here is the caller graph for this function:

sendEOS() [1/2]

void Module::sendEOS ( )

protectedvirtual

Reimplemented in AbsControlModule, ExternalSourceModule, and SimpleControlModule.

Here is the call graph for this function:

Here is the caller graph for this function:

sendEOS() [2/2]

void Module::sendEOS ( frame_sp & frame )

protectedvirtual

Reimplemented in AbsControlModule, and SimpleControlModule.

Here is the call graph for this function:

sendMp4ErrorFrame()

void Module::sendMp4ErrorFrame ( frame_sp & frame )

protectedvirtual

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

template<class T >

void Module::serialize ( T & props, frame_sp & frame )

inlineprivate

Here is the caller graph for this function:

setMetadata()

void Module::setMetadata ( std::string & pinId, framemetadata_sp & metadata )

protected

Here is the caller graph for this function:

setModuleState()

void Module::setModuleState ( enum ModuleState es )

inlineprotected

setNext() [1/4]

bool Module::setNext ( boost::shared_ptr< Module > next, bool open, bool isFeedback, bool sieve )

protected

Here is the call graph for this function:

setNext() [2/4]

bool Module::setNext ( boost::shared_ptr< Module > next, bool open = true, bool sieve = true )

virtual

Reimplemented in ValveModule.

Here is the call graph for this function:

setNext() [3/4]

bool Module::setNext ( boost::shared_ptr< Module > next, vector< string > & pinIdArr, bool open, bool isFeedback, bool sieve )

protected

Here is the call graph for this function:

setNext() [4/4]

bool Module::setNext	(	boost::shared_ptr< Module >	next,
		vector< string > &	pinIdArr,
		bool	open = true )

Here is the call graph for this function:

Here is the caller graph for this function:

setProps()

void Module::setProps ( ModuleProps & props )

protected

Here is the caller graph for this function:

setSieveDisabledFlag()

void Module::setSieveDisabledFlag ( bool sieve )

private

Here is the caller graph for this function:

shouldForceStep()

bool Module::shouldForceStep ( )

private

Here is the caller graph for this function:

shouldSkip()

bool Module::shouldSkip ( )

private

Here is the caller graph for this function:

shouldTriggerSOS()

bool Module::shouldTriggerSOS ( )

protectedvirtual

Reimplemented in AffineTransform, BMPConverter, CalcHistogramCV, CCNPPI, ColorConversion, CudaMemCopy, EffectsNPPI, EglRenderer, FaceDetectorXform, FacialLandmarkCV, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageViewerModule, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, MotionVectorExtractor, Mp4WriterSink, OverlayModule, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPPusher, and VirtualCameraSink.

Here is the caller graph for this function:

step()

bool Module::step ( )

virtual

Here is the call graph for this function:

Here is the caller graph for this function:

stepNonSource()

bool Module::stepNonSource ( frame_container & frames )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

stop()

bool Module::stop ( )

virtual

Reimplemented in ExternalSourceModule.

Here is the call graph for this function:

Here is the caller graph for this function:

stop_onStepfail()

void Module::stop_onStepfail ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

term()

bool Module::term ( )

virtual

Reimplemented in AbsControlModule, AffineTransform, ArchiveSpaceManager, AudioCaptureSrc, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, EglRenderer, FaceDetectorXform, FacialLandmarkCV, FileReaderModule, FileWriterModule, FramesMuxer, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, ImageViewerModule, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, KeyboardListener, MemTypeConversion, Merge, MotionVectorExtractor, Mp4ReaderSource, Mp4WriterSink, MultimediaQueueXform, NvArgusCamera, NvTransform, NvV4L2Camera, OverlayModule, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPClientSrc, RTSPPusher, Split, StatSink, TestSignalGenerator, TextOverlayXForm, ThumbnailListGenerator, ValveModule, VirtualCameraSink, VirtualPTZ, and WebCamSource.

try_pop()

frame_container Module::try_pop ( )

protected

Here is the caller graph for this function:

try_push()

bool Module::try_push ( frame_container frameContainer )

private

Here is the caller graph for this function:

validateInputOutputPins()

virtual bool Module::validateInputOutputPins ( )

inlineprotectedvirtual

Reimplemented in ArchiveSpaceManager, CalcHistogramCV, FramesMuxer, HistogramOverlay, Mp4WriterSink, MultimediaQueueXform, OverlayNPPI, and ValveModule.

Here is the call graph for this function:

Here is the caller graph for this function:

validateInputPins()

bool Module::validateInputPins ( )

protectedvirtual

Reimplemented in AffineTransform, ArchiveSpaceManager, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, EglRenderer, ExternalSinkModule, FaceDetectorXform, FacialLandmarkCV, FileWriterModule, FramesMuxer, GaussianBlur, GtkGlRenderer, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, ImageViewerModule, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, KeyboardListener, MemTypeConversion, Merge, MotionVectorExtractor, Mp4WriterSink, MultimediaQueueXform, NvTransform, OverlayModule, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPPusher, Split, StatSink, TextOverlayXForm, ThumbnailListGenerator, ValveModule, VirtualCameraSink, and VirtualPTZ.

Here is the call graph for this function:

Here is the caller graph for this function:

validateOutputPins()

bool Module::validateOutputPins ( )

protectedvirtual

Reimplemented in AffineTransform, ArchiveSpaceManager, AudioCaptureSrc, AudioToTextXForm, BMPConverter, BrightnessContrastControl, CalcHistogramCV, CCNPPI, ColorConversion, CuCtxSynchronize, CudaMemCopy, CudaStreamSynchronize, DMAFDToHostCopy, EffectsNPPI, ExternalSourceModule, FaceDetectorXform, FacialLandmarkCV, FileReaderModule, FramesMuxer, GaussianBlur, H264Decoder, H264EncoderNVCodec, H264EncoderV4L2, HistogramOverlay, ImageDecoderCV, ImageEncoderCV, ImageResizeCV, JPEGDecoderL4TM, JPEGDecoderNVJPEG, JPEGEncoderL4TM, JPEGEncoderNVJPEG, KeyboardListener, MemTypeConversion, Merge, MotionVectorExtractor, Mp4ReaderSource, MultimediaQueueXform, NvArgusCamera, NvTransform, NvV4L2Camera, OverlayModule, OverlayNPPI, QRReader, ResizeNPPI, RotateCV, RotateNPPI, RTSPClientSrc, Split, TestSignalGenerator, TextOverlayXForm, ValveModule, VirtualPTZ, and WebCamSource.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

PipeLine

friend class PipeLine

friend

Member Data Documentation

controlModule

boost::shared_ptr<Module> Module::controlModule = nullptr

protected

event_consumer

boost::function<void(Module *, unsigned short)> Module::event_consumer

protected

fatal_event_consumer

boost::function<void(Module *, unsigned short)> Module::fatal_event_consumer

protected

mCommandMetadata

framemetadata_sp Module::mCommandMetadata

private

mConnections

Connections Module::mConnections

private

mDirection

bool Module::mDirection

private

mErrorCallback

APErrorCallback Module::mErrorCallback

private

mFIndexStrategy

std::shared_ptr<FIndexStrategy> Module::mFIndexStrategy

private

mForceStepCount

uint32_t Module::mForceStepCount

private

mForwardPins

uint32_t Module::mForwardPins

private

mHealthCallback

APHealthCallback Module::mHealthCallback

private

mInputPinIdMetadataMap

metadata_by_pin Module::mInputPinIdMetadataMap

private

mInputPinsDirection

std::map<std::string, bool> Module::mInputPinsDirection

private

mIsSieveDisabledForAny

bool Module::mIsSieveDisabledForAny = false

private

mModules

map<string, boost::shared_ptr<Module> > Module::mModules

private

module_state

enum ModuleState Module::module_state

protected

mOutputPinIdFrameFactoryMap

framefactory_by_pin Module::mOutputPinIdFrameFactoryMap

private

mpCommandFactory

boost::shared_ptr<FrameFactory> Module::mpCommandFactory

private

mpFrameFactory

boost::shared_ptr<FrameFactory> Module::mpFrameFactory

private

mPlay

bool Module::mPlay

private

mProfiler

boost::shared_ptr<Profiler> Module::mProfiler

private

mProps

boost::shared_ptr<ModuleProps> Module::mProps

private

mPropsChangeMetadata

framemetadata_sp Module::mPropsChangeMetadata

private

mQue

boost::shared_ptr<FrameContainerQueue> Module::mQue

private

mQuePushStrategy

boost::shared_ptr<QuePushStrategy> Module::mQuePushStrategy

private

mRelay

map<string, bool> Module::mRelay

private

mRunning

bool Module::mRunning

private

mSkipIndex

int Module::mSkipIndex

private

mSpeed

float Module::mSpeed

private

mStopCount

uint32_t Module::mStopCount

private

myId

string Module::myId

private

myName

string Module::myName

private

myNature

Kind Module::myNature

private

myThread

boost::thread Module::myThread

private

onStepFail

boost::function<void()> Module::onStepFail

protected

pacer

boost::shared_ptr<PaceMaker> Module::pacer

private

---

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

• base/include/Module.h
• base/src/Module.cpp