The maximum rank that NNStreamer supports with Tizen APIs.

Since :

5.5

The maximum number of other/tensor instances that other/tensors may have.

Since :

5.5

The virtual name to set the audio source of camcorder in Tizen.

If an application needs to access the recorder device to construct the pipeline, set the virtual name as an audio source element. Note that you have to add 'http://tizen.org/privilege/recorder' into the manifest of your application.

Since :

5.5

The virtual name to set the video source of camcorder in Tizen.

If an application needs to access the camera device to construct the pipeline, set the virtual name as a video source element. Note that you have to add 'http://tizen.org/privilege/camera' into the manifest of your application.

Since :

5.5

A handle of a "custom-easy filter" of an NNStreamer pipeline.

Since :

6.0

Callback to execute the custom-easy filter in NNStreamer pipelines.

Since :

6.0

Remarks:

The in can be used only in the callback. To use outside, make a copy.

The out can be used only in the callback. To use outside, make a copy.

Parameters:

[out]	in	The handle of the tensor input (a single frame. tensor/tensors).
[out]	out	The handle of the tensor output to be filled (a single frame. tensor/tensors).
[out]	user_data	User application's private data.

Returns:

0 on success. 1 to ignore the input data. Otherwise a negative error value.

A handle of a common element (i.e. All GstElement except AppSrc, AppSink, TensorSink, Selector and Valve) of an NNStreamer pipeline.

Since :

6.0

A handle of an NNStreamer pipeline.

Since :

5.5

Callback for sink element of NNStreamer pipelines (pipeline's output).

If an application wants to accept data outputs of an NNStreamer stream, use this callback to get data from the stream. Note that the buffer may be deallocated after the return and this is synchronously called. Thus, if you need the data afterwards, copy the data to another buffer and return fast. Do not spend too much time in the callback. It is recommended to use very small tensors at sinks.

Since :

5.5

Remarks:

The data can be used only in the callback. To use outside, make a copy.

The info can be used only in the callback. To use outside, make a copy.

Parameters:

[out]	data	The handle of the tensor output (a single frame. tensor/tensors). Number of tensors is determined by ml_tensors_info_get_count() with the handle 'info'. Note that the maximum number of tensors is 16 (ML_TENSOR_SIZE_LIMIT).
[out]	info	The handle of tensors information (cardinality, dimension, and type of given tensor/tensors).
[out]	user_data	User application's private data.

A handle of a "sink node" of an NNStreamer pipeline.

Since :

5.5

A handle of a "src node" of an NNStreamer pipeline.

Since :

5.5

Callback for the change of pipeline state.

If an application wants to get the change of pipeline state, use this callback. This callback can be registered when constructing the pipeline using ml_pipeline_construct(). Do not spend too much time in the callback.

Since :

5.5

Parameters:

[out]	state	The new state of the pipeline.
[out]	user_data	User application's private data.

A handle of a "switch" of an NNStreamer pipeline.

Since :

5.5

A handle of a "valve node" of an NNStreamer pipeline.

Since :

5.5

The dimensions of a tensor that NNStreamer supports.

Since :

5.5

Possible data element types of tensor in NNStreamer.

Since :

5.5

A handle of input or output frames. ml_tensors_info_h is the handle for tensors metadata.

Since :

5.5

A handle of a tensors metadata instance.

Since :

5.5

Possible data element types of tensor in NNStreamer.

Since :

5.5

Enumerator:

ML_TENSOR_TYPE_INT32	Integer 32bit
ML_TENSOR_TYPE_UINT32	Unsigned integer 32bit
ML_TENSOR_TYPE_INT16	Integer 16bit
ML_TENSOR_TYPE_UINT16	Unsigned integer 16bit
ML_TENSOR_TYPE_INT8	Integer 8bit
ML_TENSOR_TYPE_UINT8	Unsigned integer 8bit
ML_TENSOR_TYPE_FLOAT64	Float 64bit
ML_TENSOR_TYPE_FLOAT32	Float 32bit
ML_TENSOR_TYPE_INT64	Integer 64bit
ML_TENSOR_TYPE_UINT64	Unsigned integer 64bit
ML_TENSOR_TYPE_UNKNOWN	Unknown type

Types of hardware resources to be used for NNFWs. Note that if the affinity (nnn) is not supported by the driver or hardware, it is ignored.

Since :

5.5

Enumerator:

ML_NNFW_HW_ANY	Hardware resource is not specified.
ML_NNFW_HW_AUTO	Try to schedule and optimize if possible.
ML_NNFW_HW_CPU	0x1000: any CPU. 0x1nnn: CPU # nnn-1.
ML_NNFW_HW_CPU_SIMD	0x1100: SIMD in CPU. (Since 6.0)
ML_NNFW_HW_CPU_NEON	0x1100: NEON (alias for SIMD) in CPU. (Since 6.0)
ML_NNFW_HW_GPU	0x2000: any GPU. 0x2nnn: GPU # nnn-1.
ML_NNFW_HW_NPU	0x3000: any NPU. 0x3nnn: NPU # nnn-1.
ML_NNFW_HW_NPU_MOVIDIUS	0x3001: Intel Movidius Stick. (Since 6.0)
ML_NNFW_HW_NPU_EDGE_TPU	0x3002: Google Coral Edge TPU (USB). (Since 6.0)
ML_NNFW_HW_NPU_VIVANTE	0x3003: VeriSilicon's Vivante. (Since 6.0)
ML_NNFW_HW_NPU_SR	0x13000: any SR (Samsung Research) made NPU. (Since 6.0)

Types of NNFWs.

To check if a nnfw-type is supported in a system, an application may call the API, ml_check_nnfw_availability().

Since :

5.5

Enumerator:

ML_NNFW_TYPE_ANY	NNHW is not specified (Try to determine the NNFW with file extension).
ML_NNFW_TYPE_CUSTOM_FILTER	Custom filter (Independent shared object).
ML_NNFW_TYPE_TENSORFLOW_LITE	Tensorflow-lite (.tflite).
ML_NNFW_TYPE_TENSORFLOW	Tensorflow (.pb).
ML_NNFW_TYPE_NNFW	Neural Network Inference framework, which is developed by SR (Samsung Research).
ML_NNFW_TYPE_MVNC	Intel Movidius Neural Compute SDK (libmvnc). (Since 6.0)
ML_NNFW_TYPE_OPENVINO	Intel OpenVINO. (Since 6.0)
ML_NNFW_TYPE_VIVANTE	VeriSilicon's Vivante. (Since 6.0)
ML_NNFW_TYPE_EDGE_TPU	Google Coral Edge TPU (USB). (Since 6.0)
ML_NNFW_TYPE_ARMNN	Arm Neural Network framework (support for caffe and tensorflow-lite). (Since 6.0)
ML_NNFW_TYPE_SNPE	Qualcomm SNPE (Snapdgragon Neural Processing Engine (.dlc). (Since 6.0)
ML_NNFW_TYPE_SNAP	SNAP (Samsung Neural Acceleration Platform), only for Android. (Since 6.0)

Enumeration for buffer deallocation policies.

Since :

5.5

Enumerator:

ML_PIPELINE_BUF_POLICY_AUTO_FREE	Default. Application should not deallocate this buffer. NNStreamer will deallocate when the buffer is no more needed.
ML_PIPELINE_BUF_POLICY_DO_NOT_FREE	This buffer is not to be freed by NNStreamer (i.e., it's a static object). However, be careful: NNStreamer might be accessing this object after the return of the API call.
ML_PIPELINE_BUF_POLICY_MAX	Max size of ml_pipeline_buf_policy_e structure.
ML_PIPELINE_BUF_SRC_EVENT_EOS	Trigger End-Of-Stream event for the corresponding appsrc and ignore the given input value. The corresponding appsrc will no longer accept new data after this.

Enumeration for pipeline state.

The pipeline state is described on Pipeline State Diagram. Refer to https://gstreamer.freedesktop.org/documentation/plugin-development/basics/states.html.

Since :

5.5

Enumerator:

ML_PIPELINE_STATE_UNKNOWN	Unknown state. Maybe not constructed?
ML_PIPELINE_STATE_NULL	GST-State "Null"
ML_PIPELINE_STATE_READY	GST-State "Ready"
ML_PIPELINE_STATE_PAUSED	GST-State "Paused"
ML_PIPELINE_STATE_PLAYING	GST-State "Playing"

Enumeration for switch types.

This designates different GStreamer filters, "GstInputSelector"/"GstOutputSelector".

Since :

5.5

Enumerator:

ML_PIPELINE_SWITCH_OUTPUT_SELECTOR	GstOutputSelector
ML_PIPELINE_SWITCH_INPUT_SELECTOR	GstInputSelector

Checks the availability of the given execution environments.

If the function returns an error, available may not be changed.

Since :

5.5

Parameters:

[in]	nnfw	Check if the nnfw is available in the system. Set ML_NNFW_TYPE_ANY to skip checking nnfw.
[in]	hw	Check if the hardware is available in the system. Set ML_NNFW_HW_ANY to skip checking hardware.
[out]	available	true if it's available, false if it's not available.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful and the environments are available.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Constructs the pipeline (GStreamer + NNStreamer).

Use this function to create gst_parse_launch compatible NNStreamer pipelines.

Since :

5.5

Remarks:

If the function succeeds, pipe handle must be released using ml_pipeline_destroy().

http://tizen.org/privilege/mediastorage is needed if pipeline_description is relevant to media storage.

http://tizen.org/privilege/externalstorage is needed if pipeline_description is relevant to external storage.

http://tizen.org/privilege/camera is needed if pipeline_description accesses the camera device.

http://tizen.org/privilege/recorder is needed if pipeline_description accesses the recorder device.

Parameters:

[in]	pipeline_description	The pipeline description compatible with GStreamer gst_parse_launch(). Refer to GStreamer manual or NNStreamer (https://github.com/nnstreamer/nnstreamer) documentation for examples and the grammar.
[in]	cb	The function to be called when the pipeline state is changed. You may set NULL if it's not required.
[in]	user_data	Private data for the callback. This value is passed to the callback when it's invoked.
[out]	pipe	The NNStreamer pipeline handler from the given description.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_PERMISSION_DENIED	The application does not have the required privilege to access to the media storage, external storage, microphone, or camera.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid. (Pipeline is not negotiated yet.)
ML_ERROR_STREAMS_PIPE	Pipeline construction is failed because of wrong parameter or initialization failure.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory to construct the pipeline.

Precondition:

The pipeline state should be ML_PIPELINE_STATE_UNKNOWN or ML_PIPELINE_STATE_NULL.

Postcondition:

The pipeline state will be ML_PIPELINE_STATE_PAUSED in the same thread.

Registers a custom filter.

NNStreamer provides an interface for processing the tensors with 'custom-easy' framework which can execute without independent shared object. Using this function, the application can easily register and execute the processing code. If a custom filter with same name exists, this will be failed and return the error code ML_ERROR_INVALID_PARAMETER.

Since :

6.0

Remarks:

If the function succeeds, custom handle must be released using ml_pipeline_custom_easy_filter_unregister().

Parameters:

[in]	name	The name of custom filter.
[in]	in	The handle of input tensors information.
[in]	out	The handle of output tensors information.
[in]	cb	The function to be called when the pipeline runs.
[in]	user_data	Private data for the callback. This value is passed to the callback when it's invoked.
[out]	custom	The custom filter handler.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	The parameter is invalid, or duplicated name exists.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory to register the custom filter.

Here is an example of the usage:

 // Define invoke callback.
 static int custom_filter_invoke_cb (const ml_tensors_data_h in, ml_tensors_data_h out, void *user_data)
 {
   // Get input tensors using data handle 'in', and fill output tensors using data handle 'out'.
 }

 // The pipeline description (input data with dimension 2:1:1:1 and type int8 will be passed to custom filter 'my-custom-filter', which converts data type to float32 and processes tensors.)
 const char pipeline[] = "appsrc ! other/tensor,dimension=(string)2:1:1:1,type=(string)int8,framerate=(fraction)0/1 ! tensor_filter framework=custom-easy model=my-custom-filter ! tensor_sink";
 int status;
 ml_pipeline_h pipe;
 ml_custom_easy_filter_h custom;
 ml_tensors_info_h in_info, out_info;
 ml_tensor_dimension dim = { 2, 1, 1, 1 };

 // Set input and output tensors information.
 ml_tensors_info_create (&in_info);
 ml_tensors_info_set_count (in_info, 1);
 ml_tensors_info_set_tensor_type (in_info, 0, ML_TENSOR_TYPE_INT8);
 ml_tensors_info_set_tensor_dimension (in_info, 0, dim);

 ml_tensors_info_create (&out_info);
 ml_tensors_info_set_count (out_info, 1);
 ml_tensors_info_set_tensor_type (out_info, 0, ML_TENSOR_TYPE_FLOAT32);
 ml_tensors_info_set_tensor_dimension (out_info, 0, dim);

 // Register custom filter with name 'my-custom-filter' ('custom-easy' framework).
 status = ml_pipeline_custom_easy_filter_register ("my-custom-filter", in_info, out_info, custom_filter_invoke_cb, NULL, &custom);
 if (status != ML_ERROR_NONE) {
   // Handle error case.
   goto error;
 }

 // Construct the pipeline.
 status = ml_pipeline_construct (pipeline, NULL, NULL, &pipe);
 if (status != ML_ERROR_NONE) {
   // Handle error case.
   goto error;
 }

 // Start the pipeline and execute the tensor.
 ml_pipeline_start (pipe);

 error:
 // Destroy the pipeline and unregister custom filter.
 ml_pipeline_stop (pipe);
 ml_pipeline_destroy (handle);
 ml_pipeline_custom_easy_filter_unregister (custom);

Unregisters the custom filter.

Use this function to release and unregister the custom filter.

Since :

6.0

Parameters:

[in]

custom

The custom filter to be unregistered.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	The parameter is invalid.

Destroys the pipeline.

Use this function to destroy the pipeline constructed with ml_pipeline_construct().

Since :

5.5

Parameters:

[in]

pipe

The pipeline to be destroyed.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	The parameter is invalid. (Pipeline is not negotiated yet.)
ML_ERROR_STREAMS_PIPE	Failed to access the pipeline state.

Precondition:

The pipeline state should be ML_PIPELINE_STATE_PLAYING or ML_PIPELINE_STATE_PAUSED.

Postcondition:

The pipeline state will be ML_PIPELINE_STATE_NULL.

Gets an element handle in NNStreamer pipelines to control its properties.

Since :

6.0

Remarks:

If the function succeeds, elem_h handle must be released using ml_pipeline_element_release_handle().

Parameters:

[in]	pipe	The pipeline to be managed.
[in]	element_name	The name of element to control.
[out]	elem_h	The element handle.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Here is an example of the usage:

 ml_pipeline_h handle = nullptr;
 ml_pipeline_element_h demux_h = nullptr;
 gchar *pipeline;
 gchar *ret_tensorpick;
 int status;

 pipeline = g_strdup("videotestsrc ! video/x-raw,format=RGB,width=640,height=480 ! videorate max-rate=1 ! " \
    "tensor_converter ! tensor_mux ! tensor_demux name=demux ! tensor_sink");

 // Construct a pipeline
 status = ml_pipeline_construct (pipeline, NULL, NULL, &handle);
 if (status != ML_ERROR_NONE) {
  // handle error case
  goto error;
 }

 // Get the handle of target element
 status = ml_pipeline_element_get_handle (handle, "demux", &demux_h);
 if (status != ML_ERROR_NONE) {
  // handle error case
  goto error;
 }

 // Set the string value of given element's property
 status = ml_pipeline_element_set_property_string (demux_h, "tensorpick", "1,2");
 if (status != ML_ERROR_NONE) {
  // handle error case
  goto error;
 }

 // Get the string value of given element's property
 status = ml_pipeline_element_get_property_string (demux_h, "tensorpick", &ret_tensorpick);
 if (status != ML_ERROR_NONE) {
  // handle error case
  goto error;
 }
 // check the property value of given element
 if (!g_str_equal (ret_tensorpick, "1,2")) {
  // handle error case
  goto error;
 }

 error:
  ml_pipeline_element_release_handle (demux_h);
  ml_pipeline_destroy (handle);
 g_free(pipeline);

Gets the boolean value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The boolean value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the floating point value of element's property in NNStreamer pipelines.

Since :

6.0

Remarks:

This function supports all types of floating point values such as Double and Float.

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The floating point value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the enumeration value of element's property in NNStreamer pipelines.

Since :

6.0

Remarks:

Enumeration value is get as an unsigned integer value and developers can get this information using gst-inspect tool.

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The unsigned integer value of given property, which is corresponding to Enumeration value.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the integer value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The integer value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the integer 64bit value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The integer 64bit value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the string value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The string value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the unsigned integer value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The unsigned integer value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Gets the unsigned integer 64bit value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[out]	value	The unsigned integer 64bit value of given property.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the third parameter is NULL.

Releases the given element handle.

Since :

6.0

Parameters:

[in]

elem_h

The handle to be released.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Sets the boolean value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The boolean value to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not boolean.

Sets the floating point value of element's property in NNStreamer pipelines.

Since :

6.0

Remarks:

This function supports all types of floating point values such as Double and Float.

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The floating point integer value to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not floating point number.

Sets the enumeration value of element's property in NNStreamer pipelines.

Since :

6.0

Remarks:

Enumeration value is set as an unsigned integer value and developers can get this information using gst-inspect tool.

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The unsigned integer value to be set, which is corresponding to Enumeration value.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not unsigned integer.

Sets the integer value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The integer value to be set.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not integer.

Sets the integer 64bit value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The integer value to be set.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not integer.

Sets the string value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The string value to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not string.

Sets the unsigned integer value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The unsigned integer value to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not unsigned integer.

Sets the unsigned integer 64bit value of element's property in NNStreamer pipelines.

Since :

6.0

Parameters:

[in]	elem_h	The target element handle.
[in]	property_name	The name of the property.
[in]	value	The unsigned integer 64bit value to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given property name does not exist or the type is not unsigned integer.

Gets the state of pipeline.

Gets the state of the pipeline handle returned by ml_pipeline_construct().

Since :

5.5

Parameters:

[in]	pipe	The pipeline handle.
[out]	state	The pipeline state.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid. (Pipeline is not negotiated yet.)
ML_ERROR_STREAMS_PIPE	Failed to get state from the pipeline.

Registers a callback for sink node of NNStreamer pipelines.

Since :

5.5

Remarks:

If the function succeeds, sink_handle handle must be unregistered using ml_pipeline_sink_unregister().

Parameters:

[in]	pipe	The pipeline to be attached with a sink node.
[in]	sink_name	The name of sink node, described with ml_pipeline_construct().
[in]	cb	The function to be called by the sink node.
[in]	user_data	Private data for the callback. This value is passed to the callback when it's invoked.
[out]	sink_handle	The sink handle.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid. (Not negotiated, sink_name is not found, or sink_name has an invalid type.)
ML_ERROR_STREAMS_PIPE	Failed to connect a signal to sink element.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Precondition:

The pipeline state should be ML_PIPELINE_STATE_PAUSED.

Unregisters a callback for sink node of NNStreamer pipelines.

Since :

5.5

Parameters:

[in]

sink_handle

The sink handle to be unregistered.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Precondition:

The pipeline state should be ML_PIPELINE_STATE_PAUSED.

Gets a handle to operate as a src node of NNStreamer pipelines.

Since :

5.5

Remarks:

If the function succeeds, src_handle handle must be released using ml_pipeline_src_release_handle().

Parameters:

[in]	pipe	The pipeline to be attached with a src node.
[in]	src_name	The name of src node, described with ml_pipeline_construct().
[out]	src_handle	The src handle.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_STREAMS_PIPE	Failed to get src element.
ML_ERROR_TRY_AGAIN	The pipeline is not ready yet.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Gets a handle for the tensors information of given src node.

If the media type is not other/tensor or other/tensors, info handle may not be correct. If want to use other media types, you MUST set the correct properties.

Since :

5.5

Remarks:

If the function succeeds, info handle must be released using ml_tensors_info_destroy().

Parameters:

[in]	src_handle	The source handle returned by ml_pipeline_src_get_handle().
[out]	info	The handle of tensors information.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_STREAMS_PIPE	The pipeline has inconsistent pad caps. (Pipeline is not negotiated yet.)
ML_ERROR_TRY_AGAIN	The pipeline is not ready yet.

Adds an input data frame.

Since :

5.5

Parameters:

[in]	src_handle	The source handle returned by ml_pipeline_src_get_handle().
[in]	data	The handle of input tensors, in the format of tensors info given by ml_pipeline_src_get_tensors_info(). This function takes ownership of the data if policy is ML_PIPELINE_BUF_POLICY_AUTO_FREE.
[in]	policy	The policy of buffer deallocation. The policy value may include buffer deallocation mechanisms or event triggers for appsrc elements. If event triggers are provided, these functions will not give input data to the appsrc element, but will trigger the given event only.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_STREAMS_PIPE	The pipeline has inconsistent pad caps. (Pipeline is not negotiated yet.)
ML_ERROR_TRY_AGAIN	The pipeline is not ready yet.

Releases the given src handle.

Since :

5.5

Parameters:

[in]

src_handle

The src handle to be released.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Starts the pipeline, asynchronously.

The pipeline handle returned by ml_pipeline_construct() is started. Note that this is asynchronous function. State might be "pending". If you need to get the changed state, add a callback while constructing a pipeline with ml_pipeline_construct().

Since :

5.5

Parameters:

[in]

pipe

The pipeline handle.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid. (Pipeline is not negotiated yet.)
ML_ERROR_STREAMS_PIPE	Failed to start the pipeline.

Precondition:

The pipeline state should be ML_PIPELINE_STATE_PAUSED.

Postcondition:

The pipeline state will be ML_PIPELINE_STATE_PLAYING.

Stops the pipeline, asynchronously.

The pipeline handle returned by ml_pipeline_construct() is stopped. Note that this is asynchronous function. State might be "pending". If you need to get the changed state, add a callback while constructing a pipeline with ml_pipeline_construct().

Since :

5.5

Parameters:

[in]

pipe

The pipeline to be stopped.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid. (Pipeline is not negotiated yet.)
ML_ERROR_STREAMS_PIPE	Failed to stop the pipeline.

Precondition:

The pipeline state should be ML_PIPELINE_STATE_PLAYING.

Postcondition:

The pipeline state will be ML_PIPELINE_STATE_PAUSED.

Gets a handle to operate a "GstInputSelector"/"GstOutputSelector" node of NNStreamer pipelines.

Refer to https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-input-selector.html for input selectors. Refer to https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-output-selector.html for output selectors.

Since :

5.5

Remarks:

If the function succeeds, switch_handle handle must be released using ml_pipeline_switch_release_handle().

Parameters:

[in]	pipe	The pipeline to be managed.
[in]	switch_name	The name of switch (InputSelector/OutputSelector).
[out]	switch_type	The type of the switch. If NULL, it is ignored.
[out]	switch_handle	The switch handle.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Gets the pad names of a switch.

Since :

5.5

Remarks:

If the function succeeds, list and its contents should be released using g_free(). Refer the below sample code.

Parameters:

[in]	switch_handle	The switch handle returned by ml_pipeline_switch_get_handle().
[out]	list	NULL terminated array of char*. The caller must free each string (char*) in the list and free the list itself.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_STREAMS_PIPE	The element is not both input and output switch (Internal data inconsistency).
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Here is an example of the usage:

 int status;
 gchar *pipeline;
 ml_pipeline_h handle;
 ml_pipeline_switch_e switch_type;
 ml_pipeline_switch_h switch_handle;
 gchar **node_list = NULL;

 // pipeline description
 pipeline = g_strdup ("videotestsrc is-live=true ! videoconvert ! tensor_converter ! output-selector name=outs "
     "outs.src_0 ! tensor_sink name=sink0 async=false "
     "outs.src_1 ! tensor_sink name=sink1 async=false");

 status = ml_pipeline_construct (pipeline, NULL, NULL, &handle);
 if (status != ML_ERROR_NONE) {
   // handle error case
   goto error;
 }

 status = ml_pipeline_switch_get_handle (handle, "outs", &switch_type, &switch_handle);
 if (status != ML_ERROR_NONE) {
   // handle error case
   goto error;
 }

 status = ml_pipeline_switch_get_pad_list (switch_handle, &node_list);
 if (status != ML_ERROR_NONE) {
   // handle error case
   goto error;
 }

 if (node_list) {
   gchar *name = NULL;
   guint idx = 0;

   while ((name = node_list[idx++]) != NULL) {
     // node name is 'src_0' or 'src_1'

     // release name
     g_free (name);
   }
   // release list of switch pads
   g_free (node_list);
 }

 error:
 ml_pipeline_switch_release_handle (switch_handle);
 ml_pipeline_destroy (handle);
 g_free (pipeline);

Releases the given switch handle.

Since :

5.5

Parameters:

[in]

switch_handle

The handle to be released.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Controls the switch with the given handle to select input/output nodes(pads).

Since :

5.5

Parameters:

[in]	switch_handle	The switch handle returned by ml_pipeline_switch_get_handle().
[in]	pad_name	The name of the chosen pad to be activated. Use ml_pipeline_switch_get_pad_list() to list the available pad names.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets a handle to operate a "GstValve" node of NNStreamer pipelines.

Refer to https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-valve.html for more information.

Since :

5.5

Remarks:

If the function succeeds, valve_handle handle must be released using ml_pipeline_valve_release_handle().

Parameters:

[in]	pipe	The pipeline to be managed.
[in]	valve_name	The name of valve (Valve).
[out]	valve_handle	The valve handle.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Releases the given valve handle.

Since :

5.5

Parameters:

[in]

valve_handle

The handle to be released.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Controls the valve with the given handle.

Since :

5.5

Parameters:

[in]	valve_handle	The valve handle returned by ml_pipeline_valve_get_handle().
[in]	open	true to open(let the flow pass), false to close (drop & stop the flow).

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Creates a tensor data frame with the given tensors information.

Since :

5.5

Remarks:

Before 6.0, this function returned ML_ERROR_STREAMS_PIPE in case of an internal error. Since 6.0, ML_ERROR_OUT_OF_MEMORY is returned in such cases, so ML_ERROR_STREAMS_PIPE is not returned by this function anymore.

Parameters:

[in]	info	The handle of tensors information for the allocation.
[out]	data	The handle of tensors data. The caller is responsible for freeing the allocated data with ml_tensors_data_destroy().

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Frees the given tensors' data handle.

Since :

5.5

Parameters:

[in]

data

The handle of tensors data.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets a tensor data of given handle.

This returns the pointer of memory block in the handle. Do not deallocate the returned tensor data.

Since :

5.5

Parameters:

[in]	data	The handle of tensors data.
[in]	index	The index of the tensor.
[out]	raw_data	Raw tensor data in the handle.
[out]	data_size	Byte size of tensor data.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Copies a tensor data to given handle.

Since :

5.5

Parameters:

[in]	data	The handle of tensors data.
[in]	index	The index of the tensor.
[in]	raw_data	Raw tensor data to be copied.
[in]	data_size	Byte size of raw data.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Copies the tensors information.

Since :

5.5

Parameters:

[out]	dest	A destination handle of tensors information.
[in]	src	The tensors information to be copied.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Creates a tensors information handle with default value.

Since :

5.5

Parameters:

[out]

info

The handle of tensors information.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.
ML_ERROR_OUT_OF_MEMORY	Failed to allocate required memory.

Frees the given handle of a tensors information.

Since :

5.5

Parameters:

[in]

info

The handle of tensors information.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets the number of tensors with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[out]	count	The number of tensors.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets the tensor dimension with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor.
[out]	dimension	The tensor dimension.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets the tensor name with given handle of tensors information.

Since :

5.5

Remarks:

Before 6.0 this function returned the internal pointer so application developers do not need to free. Since 6.0 the name string is internally copied and returned. So if the function succeeds, name should be released using g_free().

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor.
[out]	name	The tensor name.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets the size of tensors data in the given tensors information handle in bytes.

If an application needs to get the total byte size of tensors, set the index '-1'. Note that the maximum number of tensors is 16 (ML_TENSOR_SIZE_LIMIT).

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor.
[out]	data_size	The byte size of tensor data.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Gets the tensor type with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor.
[out]	type	The tensor type.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Sets the number of tensors with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	count	The number of tensors.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Sets the tensor dimension with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor to be updated.
[in]	dimension	The tensor dimension to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Sets the tensor name with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor to be updated.
[in]	name	The tensor name to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Sets the tensor type with given handle of tensors information.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information.
[in]	index	The index of the tensor to be updated.
[in]	type	The tensor type to be set.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.

Validates the given tensors information.

If the function returns an error, valid may not be changed.

Since :

5.5

Parameters:

[in]	info	The handle of tensors information to be validated.
[out]	valid	true if it's valid, false if it's invalid.

Returns:

0 on success. Otherwise a negative error value.

Return values:

ML_ERROR_NONE	Successful.
ML_ERROR_NOT_SUPPORTED	Not supported.
ML_ERROR_INVALID_PARAMETER	Given parameter is invalid.