uvgvpcc_enc::API Namespace Reference

API of the uvgVPCCenc library. More...

Classes
struct	v3c_chunk
	Bitstream writing miscellaneous. More...
struct	v3c_unit_stream

Functions
void	initializeEncoder ()
	Create the context of the uvgVPCCenc encoder. Parse the input parameters and verify if the given configuration is valid. Initialize static parameters and function pointers.
void	setParameter (const std::string &parameterName, const std::string &parameterValue)
	The only way to modify the exposed uvgVPCCenc parameters is by calling this function.
void	encodeFrame (std::shared_ptr< Frame > frame, v3c_unit_stream *output)
	Entry point of the uvgVPCCenc library. Take as input a frame. Create all the jobs for processing this frame. This function also handles the GOF processing.
void	emptyFrameQueue ()
	This function is called when all frames to be processed have been sent to the encoder. Wait for all remaining jobs to be executed.
void	stopEncoder ()
	Insure a proper end of the encoder execution.

Detailed Description

API of the uvgVPCCenc library.

Function Documentation

emptyFrameQueue()

void uvgvpcc_enc::API::emptyFrameQueue

(

)

This function is called when all frames to be processed have been sent to the encoder. Wait for all remaining jobs to be executed.

Here is the caller graph for this function:

encodeFrame()

void uvgvpcc_enc::API::encodeFrame	(	std::shared_ptr< Frame >	frame,
		v3c_unit_stream *	output
	)

Entry point of the uvgVPCCenc library. Take as input a frame. Create all the jobs for processing this frame. This function also handles the GOF processing.

Parameters

frame	uvgvpcc_enc::Frame
output	GOF bitstream

Here is the call graph for this function:

Here is the caller graph for this function:

initializeEncoder()

void uvgvpcc_enc::API::initializeEncoder

(

)

Create the context of the uvgVPCCenc encoder. Parse the input parameters and verify if the given configuration is valid. Initialize static parameters and function pointers.

Here is the call graph for this function:

Here is the caller graph for this function:

setParameter()

void uvgvpcc_enc::API::setParameter	(	const std::string &	parameterName,
		const std::string &	parameterValue
	)

The only way to modify the exposed uvgVPCCenc parameters is by calling this function.

Parameters

parameterName	Name of the parameter. All exposed parameters are listed in the object parameterMap defined in lib/utils/parameters.cpp
parameterValue	The value of the parameter written as a string.

Here is the call graph for this function:

Here is the caller graph for this function:

stopEncoder()

void uvgvpcc_enc::API::stopEncoder

(

)

Insure a proper end of the encoder execution.

Here is the caller graph for this function: