Detailed Description

Defines sensor serializer.

Defines sensor serializer base types.

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

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

Typedefs
typedef struct dwSensorSerializerNewObject *	dwSensorSerializerNewHandle_t
	Handle representing a sensor serializer. More...

typedef enum dwSerializerStatTimeDifference	dwSerializerStatTimeDifference
	Defines the various delta used in statistics. More...

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

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

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

typedef struct dwSerializerParams	dwSerializerParams
	Holds the parameters for sensor serializer creation. 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	dwSensorSerializerNew_initialize (dwSensorSerializerNewHandle_t const serializer, dwCodecHeaderHandle_t const codecHeader, dwSerializerParams const const serializerConfig, dwContextHandle_t const context)
	Create and initialize a sensor serializer based on the driveworks context parameter, CodecHeader parameter and dwSerializerParams parameter. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_release (dwSensorSerializerNewHandle_t const serializer)
	Release the sensor serializer. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_serializeData (uint8_t const *const data, size_t const size, dwTime_t const timestamp, dwSensorSerializerNewHandle_t const serializer)
	Serialize the data synchronously. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_serializeDataAsync (uint8_t const *const data, size_t const size, dwTime_t const timestamp, dwSensorSerializerNewHandle_t const serializer)
	Serialize the data asynchronously. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_serializeCameraFrame (dwCameraFrameHandle_t const frame, dwSensorSerializerNewHandle_t const serializer)
	Serialize the camera frame synchronously. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_serializeCameraFrameAsync (dwCameraFrameHandle_t const frame, dwSensorSerializerNewHandle_t const serializer)
	Serialize the camera frame asynchronously. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_start (dwSensorSerializerNewHandle_t const serializer)
	Create and launch a worker thread to do serialization task. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_stop (dwSensorSerializerNewHandle_t const serializer)
	Stop the internal worker thread. More...

DW_API_PUBLIC dwStatus	dwSensorSerializerNew_appendAllocationAttributes (dwImageProperties *const imgProps, dwSensorSerializerNewHandle_t const serializer)
	The internal encoder's allocation attributes are appended to the image properties `imgProps` of the allocated images. 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_release (dwSensorSerializerHandle_t const serializer)
	Releases a sensor serializer. 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_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_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_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...

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_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_getStats (dwSerializerStats *const outStats, dwSensorSerializerHandle_t const serializer)
	Gets serializer statistics (if available). More...

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

Typedef Documentation

◆ dwSensorSerializerHandle_t

typedef struct dwSensorSerializerObject* dwSensorSerializerHandle_t

Handle representing a sensor serializer.

Definition at line 86 of file SensorSerializerTypes.h.

◆ dwSensorSerializerNewHandle_t

typedef struct dwSensorSerializerNewObject* dwSensorSerializerNewHandle_t

Handle representing a sensor serializer.

Definition at line 50 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 83 of file SensorSerializerTypes.h.

◆ dwSerializerParams

typedef struct dwSerializerParams dwSerializerParams

Holds the parameters for sensor serializer creation.

◆ dwSerializerStats

typedef struct dwSerializerStats dwSerializerStats

Holds the available statistics for a serializer.

◆ dwSerializerStatTimeDifference

typedef enum dwSerializerStatTimeDifference dwSerializerStatTimeDifference

Defines the various delta used in statistics.

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 37 of file SensorSerializerTypes.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.

API Group

Init: Yes
Runtime: No
De-Init: No

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: No
De-Init: No

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: No
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ 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

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ dwSensorSerializerNew_appendAllocationAttributes()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_appendAllocationAttributes	(	dwImageProperties *const	imgProps,
		dwSensorSerializerNewHandle_t const	serializer
	)

The internal encoder's allocation attributes are appended to the image properties imgProps of the allocated images.

These images can be set as the image pool for camera frames. By doing so, the camera frames fed to the serializer can be properly encoded by the internal encoder, utilizing the allocated images with the appropriate attributes.

Parameters

[in,out]	imgProps	Image properties to have allocation attributes appended from the serializer(internal encoder).
[in]	serializer	Sensor serializer handle.

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 - The appending operation is successful.

Note: The given imgProps should be compatible with the serializer(internal encoder).; 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 the space is limited.; Must be called after dwSensorSerializer_initialize and only for serializing video data.

API Group

Init: Yes
Runtime: No
De-Init: No

◆ dwSensorSerializerNew_initialize()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_initialize	(	dwSensorSerializerNewHandle_t *const	serializer,
		dwCodecHeaderHandle_t const	codecHeader,
		dwSerializerParams const *const	serializerConfig,
		dwContextHandle_t const	context
	)

Create and initialize a sensor serializer based on the driveworks context parameter, CodecHeader parameter and dwSerializerParams parameter.

Set the serializer working in sync-mode or async-mode.
Create an output stream based on the file path where serialized data will be written to.
Check the media type
- video type. Check the codec type, only support h26x and raw format video data. Different codec types need create different internal muxer objects to serialize the video data. The output stream is bound to the muxer object. The serializer creates an internal encoder object to encode the video data.
- non-video type. Create a muxer object to serialize the data packet, the output stream is bound to the muxer object. If the serializer works in async-mode, it creates internal buffer pool and queue to cache the data packet to be serialized asynchronously.

Parameters

[out]	serializer	A pointer to the created sensor serializer handle.
[in]	codecHeader	CodecHeader handle. It determines the media type and codec type of the Serializer.
[in]	serializerConfig	A Parameter to Configure the Serializer, such as work mode, file path to save the serialized data. Refer to comments of dwSerializerParams to see more details.
[in]	context	The DW context

Returns: DW_INVALID_HANDLE Only for video data, failed to allocate CPU wait context from context.; DW_INVALID_ARGUMENT If any input parameter is NULL or has invalid configuration.; DW_SUCCESS Initialize successfully, the Serializer is correctly configured.

API Group

Init: Yes
Runtime: No
De-Init: No

◆ dwSensorSerializerNew_release()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_release ( dwSensorSerializerNewHandle_t const serializer )

Release the sensor serializer.

Stop the worker thread if the serializer works in async-mode. All packets cached in the serializer will be processed. The output stream is flushed and closed. Destroy the underlying Sensor Serializer object.

Parameters

[in] serializer sensor serializer handle.

Returns: DW_INVALID_ARGUMENT If serializer handle is NULL.; DW_SUCCESS Release successfully. All packets that are successfully serialized are persisted to the storage. Allocated memory in the serializer object is returned to the allocator.

API Group

Init: Yes
Runtime: No
De-Init: Yes

◆ dwSensorSerializerNew_serializeCameraFrame()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeCameraFrame	(	dwCameraFrameHandle_t const	frame,
		dwSensorSerializerNewHandle_t const	serializer
	)

Serialize the camera frame synchronously.

Once this API returns successfully, the camera frame is serialized into an output stream. After serialization, the serialized data is flushed to storage, guaranteeing that it is written and saved.

Parameters

[in]	frame	The camera frame data to be serialized.
[in]	serializer	Sensor serializer handle.

Returns: DW_NOT_AVAILABLE serialization is not available at this moment.; DW_INVALID_ARGUMENT if the input frame or serializer is NULL.; DW_INTERNAL_ERROR some internal error(eg: internal timestamp queue is empty).; DW_SUCCESS the camera frame is successfully serialized into the output stream.

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ dwSensorSerializerNew_serializeCameraFrameAsync()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeCameraFrameAsync	(	dwCameraFrameHandle_t const	frame,
		dwSensorSerializerNewHandle_t const	serializer
	)

Serialize the camera frame asynchronously.

Once this API returns successfully, the camera frame packet is added to an internal buffer or queue. An internal worker thread periodically serializes the packets from this buffer or queue. Finally, the serialized data is flushed into storage, ensuring it is written and saved. No additional action or option is required for this particular camera frame packet.

Parameters

[in]	frame	The camera frame data to be serialized.
[in]	serializer	Sensor serializer handle.

Returns: DW_CALL_NOT_ALLOWED if calling this function in sync mode or the media type of serializer is not DW_MEDIA_TYPE_VIDEO or dwSensorSerializer_start have not been called before calling this function.; DW_NOT_AVAILABLE serialization is not available at this moment.; DW_INVALID_ARGUMENT if the input frame or serializer is NULL.; DW_SUCCESS the camera frame is successfully placed into the internal buffer or queue, there is no guarantee that it will be written into the file finally.

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ dwSensorSerializerNew_serializeData()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeData	(	uint8_t const *const	data,
		size_t const	size,
		dwTime_t const	timestamp,
		dwSensorSerializerNewHandle_t const	serializer
	)

Serialize the data synchronously.

Once this API returns successfully, the data is serialized into an output stream. After serialization, the serialized data is flushed to storage, guaranteeing that it is written and saved.

Parameters

[in]	data	First byte of the data packet to be serialized.
[in]	size	Total count of bytes of the data packet to be serialized.
[in]	timestamp	The timestamp of the data packet to be serialized, will be recorded into the serialized data.
[in]	serializer	Sensor serializer handle.

Returns: DW_NOT_AVAILABLE Serialization is not available at this moment.; DW_CALL_NOT_ALLOWED If calling this function in async mode or the media type of serializer is DW_MEDIA_TYPE_VIDEO.; DW_INVALID_ARGUMENT If the input parameters 'data'/'serializer' is NULL or size is zero.; DW_SUCCESS The data packet is successfully serialized into the output stream.

Note: Other return value will depend on the internal implementations of the serialization.

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ dwSensorSerializerNew_serializeDataAsync()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_serializeDataAsync	(	uint8_t const *const	data,
		size_t const	size,
		dwTime_t const	timestamp,
		dwSensorSerializerNewHandle_t const	serializer
	)

Serialize the data asynchronously.

Once this API returns successfully, the data packet is added to an internal buffer or queue. An internal worker thread periodically serializes the packets from this buffer or queue. Finally, the serialized data is flushed into storage, ensuring it is written and saved. No additional action or option is required for this particular data packet.

Parameters

[in]	data	First byte of the data packet to be serialized.
[in]	size	Total count of bytes of the data packet to be serialized.
[in]	timestamp	The timestamp of the data packet to be serialized, will be recorded into the serialized data.
[in]	serializer	Sensor serializer handle.

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_CALL_NOT_ALLOWED if calling this function in sync mode or the media type of serializer is DW_MEDIA_TYPE_VIDEO or dwSensorSerializer_start have not been called before calling this function.; DW_INVALID_ARGUMENT if the input parameters 'data'/'serializer' is NULL or size is zero.; DW_SUCCESS the data packet is successfully placed into the internal buffer or queue, there is no guarantee that it will be written into the file finally.

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ dwSensorSerializerNew_start()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_start ( dwSensorSerializerNewHandle_t const serializer )

Create and launch a worker thread to do serialization task.

This action is applicable only when the Serializer is operating in async-mode.

Parameters

[in] serializer Sensor serializer handle.

Returns: DW_CALL_NOT_ALLOWED if calling this function in sync-mode or dwSensorSerializer_start has been called before.; DW_SUCCESS dedicated worker thread is created and launched successfully.

Note: To ensure that no data is missed, it is recommended to call this API before feeding any data packet to the Serializer.

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

◆ dwSensorSerializerNew_stop()

DW_API_PUBLIC dwStatus dwSensorSerializerNew_stop ( dwSensorSerializerNewHandle_t const serializer )

Stop the internal worker thread.

all packets cached in the serializer are processed before the dedicated thread is halted. This action is applicable only when the Serializer is operating in async-mode.

Parameters

[in] serializer Sensor serializer handle.

Returns: DW_CALL_NOT_ALLOWED dwSensorSerializer_start have not been called before.; DW_SUCCESS All packets that are cached in the serializer are successfully serialized. However, an additional flush or sync operation is required to ensure that these serialized packets are flushed and written into the storage.

Note: To ensure that no data is missed, avoid feeding any data packet to the Serializer after invoking this API.

API Group

Init: Yes
Runtime: Yes
De-Init: Yes

NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release

Detailed Description

Data Structures

Typedefs

Enumerations

Functions

Typedef Documentation

◆ dwSensorSerializerHandle_t

◆ dwSensorSerializerNewHandle_t

◆ dwSensorSerializerOnDataFunc_t

◆ dwSerializerParams

◆ dwSerializerStats

◆ dwSerializerStatTimeDifference

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()

◆ dwSensorSerializerNew_appendAllocationAttributes()

◆ dwSensorSerializerNew_initialize()

◆ dwSensorSerializerNew_release()

◆ dwSensorSerializerNew_serializeCameraFrame()

◆ dwSensorSerializerNew_serializeCameraFrameAsync()

◆ dwSensorSerializerNew_serializeData()

◆ dwSensorSerializerNew_serializeDataAsync()

◆ dwSensorSerializerNew_start()

◆ dwSensorSerializerNew_stop()