Detailed Description

Defines sensor serializer.

Data Structures
struct	dwSerializerParams
	Holds the parameters for sensor serializer creation. More...

struct	dwSerializerStats
	Holds the available statistics for a serializer. More...

Typedefs
typedef struct dwSensorSerializerObject *	dwSensorSerializerHandle_t
	Handle representing a sensor serializer. More...

typedef void(*	dwSensorSerializerOnDataFunc_t) (const uint8_t data, size_t size, void userData)
	Callback type for getting data from sensor serializer. More...

Enumerations
enum	dwSerializerStatTimeDifference { DW_SERIALIZER_STAT_DISK_WRITE_TIME = 0 , DW_SERIALIZER_STAT_ENCODE_TIME = 1 , DW_SERIALIZER_STAT_STAGE1_TIME = 2 , DW_SERIALIZER_STAT_STAGE2_TIME = 3 , DW_SERIALIZER_STAT_STAGE3_TIME = 4 , DW_SERIALIZER_STAT_COUNT = 5 }
	Defines the various delta used in statistics. More...

Functions
DW_API_PUBLIC dwStatus	dwSensorSerializer_appendAllocationAttributes (dwImageProperties *const imgProps, dwSensorSerializerHandle_t const serializer)
	Append the allocation attribute such that images allocated by the application and given to the serializer This API is used to append the underlying driver's allocation attributes to the image properties. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_attachTo (dwSensorSerializerHandle_t const serializer, dwSensorSerializerHandle_t const masterSerializer)
	Starts and stops serialization of a sensor with a master serializer. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_detachFrom (dwSensorSerializerHandle_t const serializer, dwSensorSerializerHandle_t const masterSerializer)
	This method detaches the serializer previously attached with dwSensorSerializer_attachTo(). More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_getStats (dwSerializerStats *const outStats, dwSensorSerializerHandle_t const serializer)
	Gets serializer statistics (if available). More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_initialize (dwSensorSerializerHandle_t const serializer, dwSerializerParams const const params, dwSensorHandle_t const sensor)
	Initializes a sensor serializer with the parameters provided. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_isAttached (bool *const isAttached, dwSensorSerializerHandle_t const serializer)
	Query method to check whether the serializer is attached to another. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_release (dwSensorSerializerHandle_t const serializer)
	Releases a sensor serializer. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_serializeCameraFrame (dwCameraFrameHandle_t const frame, dwSensorSerializerHandle_t const serializer)
	Pushes a camera frame to the serializer.This method must only be used if 'dwSensorSerializer_start' is not called. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_serializeCameraFrameAsync (dwCameraFrameHandle_t const frame, dwSensorSerializerHandle_t const serializer)
	Pushes a camera frame to the serializer. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_serializeData (uint8_t const *const data, size_t const size, dwSensorSerializerHandle_t const serializer)
	Pushes data to the serializer. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_serializeDataAsync (uint8_t const *const data, size_t const size, dwSensorSerializerHandle_t const serializer)
	Pushes data to the serializer. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_start (dwSensorSerializerHandle_t const serializer)
	Starts serialization of sensor. More...

DW_API_PUBLIC dwStatus	dwSensorSerializer_stop (dwSensorSerializerHandle_t const serializer)
	Starts serialization of sensor. More...

Data Structure Documentation

◆ dwSerializerParams

struct dwSerializerParams

Data Fields

dwSensorSerializerOnDataFunc_t onData Callback executed by the serializer on new data available.

const char8_t *

parameters

Array for additional parameters provided to sensor serializer creation.

The parameters argument is an array in the form of key-value pairs separated by commas, i.e., key1=value1,key2=value2,key3=value3.

Supported 'keys' are:

'type' - Required. Specifies data-sink settings.
- If the value of 'type' is 'disk', the serializer streams data to the file specified in the 'file' key. For an example, see dwSensorSerializer_initialize().
- If the value of 'type' is 'user', the serializer uses the provided callback to stream data. When new data is available, the serializer calls the function provided in onData and puts the data in the buffer provided by userData.
'file' - See description for 'type'.
'file-buffer-size' - Size of output buffer to use for file operations.
'format' - Required. Specifies the video format. Supported values are 'h264' and 'raw'.
'bitrate' - Required if 'format' is 'h264'; optional if it is 'raw'.
'async-record' - Optional. Interpreted as uint16_t. Specify whether the serializer works in 'sync' mode (with a value of zero) or 'async' mode (with a non-zero value). The default mode is 'sync'.
'framerate' - Optional. Interpreted as uint32_t. Specify frame proccessing rate. Default value is zero.
'quality' - Optional. String value. If non-empty, encoder qualitywill be set to max value.
'gop-length' - Optional. String value. If non-empty, set group of pictures's length to 16, default length is 1.
'image-type' - Optional. Interpreted as uint32_t. Specify image output type, see 'dwCameraOutputType', default output type is 'DW_CAMERA_OUTPUT_NATIVE_PROCESSED'.

For a code snippet, see dwSensorSerializer_initialize().

void * userData User data to be passed to the callback.

◆ dwSerializerStats

struct dwSerializerStats

Data Fields
dwTime_t	currentDeltaUs[DW_SERIALIZER_STAT_COUNT]	Array of current latencies of all the time deltas between various stages of serialization as per the dwSerializerStatTimeDifference [us].
dwTime_t	maxDeltaUs[DW_SERIALIZER_STAT_COUNT]	Array of max latencies of all the time deltas between various stages of serialization as per the dwSerializerStatTimeDifference [us].
float64_t	meanDelta[DW_SERIALIZER_STAT_COUNT]	Array of Mean of all the time deltas between various stages of serialization as per the dwSerializerStatTimeDifference.
dwTime_t	minDeltaUs[DW_SERIALIZER_STAT_COUNT]	Array of min latencies of all the time deltas between various stages of serialization as per the dwSerializerStatTimeDifference [us].
float64_t	standardDeviationDelta[DW_SERIALIZER_STAT_COUNT]	Array of Variance of all the time deltas between various stages of serialization as per the dwSerializerStatTimeDifference.

Typedef Documentation

◆ dwSensorSerializerHandle_t

typedef struct dwSensorSerializerObject* dwSensorSerializerHandle_t

Handle representing a sensor serializer.

Definition at line 112 of file SensorSerializer.h.

◆ dwSensorSerializerOnDataFunc_t

typedef void(* dwSensorSerializerOnDataFunc_t) (const uint8_t *data, size_t size, void *userData)

Callback type for getting data from sensor serializer.

Parameters

[in]	data	A pointer to the byte array of serialized data.
[in]	size	A pointer to the size of the byte array.
[in]	userData	User Data

Definition at line 109 of file SensorSerializer.h.

Enumeration Type Documentation

◆ dwSerializerStatTimeDifference

enum dwSerializerStatTimeDifference

Defines the various delta used in statistics.

Enumerator
DW_SERIALIZER_STAT_DISK_WRITE_TIME	Stat to hold the disk write time delta.
DW_SERIALIZER_STAT_ENCODE_TIME	Stat to hold the encode time delta.
DW_SERIALIZER_STAT_STAGE1_TIME	Stat to hold the stage1 time delta.
DW_SERIALIZER_STAT_STAGE2_TIME	Stat to hold the stage2 time delta.
DW_SERIALIZER_STAT_STAGE3_TIME	Stat to hold the stage3 time delta.
DW_SERIALIZER_STAT_COUNT	Count which the type value is less than.

Definition at line 63 of file SensorSerializer.h.

Function Documentation

◆ dwSensorSerializer_appendAllocationAttributes()

DW_API_PUBLIC dwStatus dwSensorSerializer_appendAllocationAttributes	(	dwImageProperties *const	imgProps,
		dwSensorSerializerHandle_t const	serializer
	)

Append the allocation attribute such that images allocated by the application and given to the serializer This API is used to append the underlying driver's allocation attributes to the image properties.

Parameters

[in,out]	imgProps	Image properties
[in]	serializer	Handle to the serializer

Note: The given imgProps should be compatible with serialzier; The imgProps are read and used to generate the allocation attributes needed by the driver. The allocation attributes are stored back into imgProps.meta.allocAttrs. Applications do not need to free or alter the imgProps.meta.allocAttrs in any way. The imgProps.meta.allocAttrs are only used by DriveWorks as needed when the given imgProps are used to allocate dwImages. If the application alters the imgProps after calling this API, the imgProps.meta.allocAttrs may no longer be applicable to the imgProps and calls related to allocating images will fail.; if imgProps.meta.allocAttrs does not have allocated Memory, this would be allocated by DW and will be owned by DW context until context is destroyed and should be used wisely as it the space is limited.; Must be called after dwSensorSerializer_initialize().

Returns: DW_NVMEDIA_ERROR - if underlying driver had an NvMedia error.
DW_INVALID_HANDLE - if given handle is not valid.
DW_NOT_IMPLEMENTED - if the method for this image type is not implemented by given camera.
DW_SUCCESS - if call is successful.

◆ dwSensorSerializer_attachTo()

DW_API_PUBLIC dwStatus dwSensorSerializer_attachTo	(	dwSensorSerializerHandle_t const	serializer,
		dwSensorSerializerHandle_t const	masterSerializer
	)

Starts and stops serialization of a sensor with a master serializer.

This method attaches the serializer to the same thread of the master serializer. The slave serializer handle is still used to call dwSensorSerializer_serializeDataAsync().

Note: To ensure you don't miss any data, activate serialization before calling dwSensorSerializer_startSensor().

Parameters

[in]	serializer	Specifies the sensor serializer handle.
[in]	masterSerializer	Specifies the sensor serializer handle that is the main thread.

Returns: DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_detachFrom()

DW_API_PUBLIC dwStatus dwSensorSerializer_detachFrom	(	dwSensorSerializerHandle_t const	serializer,
		dwSensorSerializerHandle_t const	masterSerializer
	)

This method detaches the serializer previously attached with dwSensorSerializer_attachTo().

Due to the asyncronous nature of this call, the serializer may still be attached to the serializing thread immediately following this call. dwSensorSerializer_isAttached() must be polled for status.

Note: To ensure you don't miss any data, activate serialization before calling dwSensorSerializer_startSensor().

Parameters

[in]	serializer	Specifies the sensor serializer handle.
[in]	masterSerializer	Specifies the sensor serializer handle that takes ownership of the serializer.

Returns: DW_NOT_AVAILABLE - serializer is not attached to another serializer.
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_getStats()

DW_API_PUBLIC dwStatus dwSensorSerializer_getStats	(	dwSerializerStats *const	outStats,
		dwSensorSerializerHandle_t const	serializer
	)

Gets serializer statistics (if available).

Parameters

[out]	outStats	A pointer to a structure containing the statistics.
[in]	serializer	Handle to the serializer

Returns: DW_INVALID_HANDLE - if provided serializer handle is invalid.
DW_NOT_SUPPORTED - if serializer does not implement this functionality
DW_SUCCESS - if call is successful.

◆ dwSensorSerializer_initialize()

DW_API_PUBLIC dwStatus dwSensorSerializer_initialize	(	dwSensorSerializerHandle_t *const	serializer,
		dwSerializerParams const *const	params,
		dwSensorHandle_t const	sensor
	)

Initializes a sensor serializer with the parameters provided.

Parameters

[out]	serializer	A pointer to the sensor serializer handle.
[in]	params	A pointer to the sensor serializer parameters.
[in]	sensor	Specifies the sensor used to create the serializer. This is necessary because each sensor has its own unique serializer. For example, camera provides a serializer that can encode the data, while GPS serializes RAW data.

Note: Creating serializer from virtual sensors will perform a copy of the data

Returns: DW_INVALID_HANDLE - if provided inputs are invalid
DW_INVALID_ARGUMENT
DW_SUCCESS

◆ dwSensorSerializer_isAttached()

DW_API_PUBLIC dwStatus dwSensorSerializer_isAttached	(	bool *const	isAttached,
		dwSensorSerializerHandle_t const	serializer
	)

Query method to check whether the serializer is attached to another.

See also: dwSensorSerializer_attachTo()

Parameters

[out]	isAttached	Specifies whether the sensor serializer handle is attached to another.
[in]	serializer	The sensor serializer handle.

Returns: DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_release()

DW_API_PUBLIC dwStatus dwSensorSerializer_release ( dwSensorSerializerHandle_t const serializer )

Releases a sensor serializer.

If the serializer has been attached to a master serializer via dwSensorSerializer_attachTo(), this method fails with DW_NOT_AVAILABLE. If this happens, dwSensorSerializer_detachFrom() must be called, and then this method succeeds. If the serializer is a master serializer that has other serializers attached, it releases as normal and the slave serializers are no longer be attached.

Parameters

[in] serializer The sensor serializer handle.

Returns: DW_INVALID_HANDLE - if provided inputs are invalid.
DW_INVALID_ARGUMENT
DW_NOT_AVAILABLE - if provided serializer is attached to another. DW_SUCCESS

◆ dwSensorSerializer_serializeCameraFrame()

DW_API_PUBLIC dwStatus dwSensorSerializer_serializeCameraFrame	(	dwCameraFrameHandle_t const	frame,
		dwSensorSerializerHandle_t const	serializer
	)

Pushes a camera frame to the serializer.This method must only be used if 'dwSensorSerializer_start' is not called.

This pushes the serialized image directly to the sink.

Parameters

[in]	frame	Handle to the camera frame.
[in]	serializer	Specifies the sensor serializer handle.

Returns: DW_NOT_AVAILABLE - serialization is not available at this moment,
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_serializeCameraFrameAsync()

DW_API_PUBLIC dwStatus dwSensorSerializer_serializeCameraFrameAsync	(	dwCameraFrameHandle_t const	frame,
		dwSensorSerializerHandle_t const	serializer
	)

Pushes a camera frame to the serializer.

This method is thread-safe.

Parameters

[in]	frame	Handle to the camera frame.
[in]	serializer	Specifies the sensor serializer handle.

Returns: DW_NOT_AVAILABLE - serialization is not available at this moment,
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_serializeData()

DW_API_PUBLIC dwStatus dwSensorSerializer_serializeData	(	uint8_t const *const	data,
		size_t const	size,
		dwSensorSerializerHandle_t const	serializer
	)

Pushes data to the serializer.

This method is thread-safe and thus can be used on the capture thread (or any other thread).

Parameters

[in]	data	A pointer to the byte array of data.
[in]	size	Specifies the size of the byte array.
[in]	serializer	Specifies the handle to the sensor serializer.

Returns: DW_NOT_AVAILABLE - serialization is not available at this moment.
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_serializeDataAsync()

DW_API_PUBLIC dwStatus dwSensorSerializer_serializeDataAsync	(	uint8_t const *const	data,
		size_t const	size,
		dwSensorSerializerHandle_t const	serializer
	)

Pushes data to the serializer.

This method is thread-safe and thus can be used on the capture thread (or any other thread). Use this method in conjunction with 'dwSensorSerializer_start'/'dwSensorSerializer_stop'.

Parameters

[in]	data	A pointer to the byte array of data.
[in]	size	Specifies the size of the byte array.
[in]	serializer	Specifies the handle to the sensor serializer.

Returns: DW_NOT_AVAILABLE - serialization is not available at this moment.
DW_BUFFER_FULL - serializer buffer is full, data was not pushed to serializer.
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_start()

DW_API_PUBLIC dwStatus dwSensorSerializer_start ( dwSensorSerializerHandle_t const serializer )

Starts serialization of sensor.

This method creates a new thread and begins the serialization loop.

Note: To ensure you don't miss any data, activate serialization before calling dwSensorSerializer_startSensor().

Parameters

[in] serializer Specifies the sensor serializer handle.

Returns: DW_NOT_AVAILABLE - serialization is not available at this moment.
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

◆ dwSensorSerializer_stop()

DW_API_PUBLIC dwStatus dwSensorSerializer_stop ( dwSensorSerializerHandle_t const serializer )

Starts serialization of sensor.

This method stops the thread and the serialization loop.

Parameters

[in] serializer Specifies the sensor serializer handle.

Returns: DW_NOT_AVAILABLE - serialization is not available at this moment.
DW_INVALID_HANDLE - if given handle is not valid.
DW_SUCCESS

Detailed Description

Data Structures

Typedefs

Enumerations

Functions

Data Structure Documentation

◆ dwSerializerParams

◆ dwSerializerStats

Typedef Documentation

◆ dwSensorSerializerHandle_t

◆ dwSensorSerializerOnDataFunc_t

Enumeration Type Documentation

◆ dwSerializerStatTimeDifference

Function Documentation

◆ dwSensorSerializer_appendAllocationAttributes()

◆ dwSensorSerializer_attachTo()

◆ dwSensorSerializer_detachFrom()

◆ dwSensorSerializer_getStats()

◆ dwSensorSerializer_initialize()

◆ dwSensorSerializer_isAttached()

◆ dwSensorSerializer_release()

◆ dwSensorSerializer_serializeCameraFrame()

◆ dwSensorSerializer_serializeCameraFrameAsync()

◆ dwSensorSerializer_serializeData()

◆ dwSensorSerializer_serializeDataAsync()

◆ dwSensorSerializer_start()

◆ dwSensorSerializer_stop()