Tizen Native API  7.0
Media Vision Common

Common functions and enumerations used in Media Vision Face, Media Vision Image, Media Vision Surveillance and Media Vision BarCode submodules.

Required Header

#include <mv_common.h>

Overview

Media Vision Common provides a set of functions that are used in Media Vision API to correctly prepare and use included modules. mv_source_h is the handler that has to be created to keep information on image or video frame data as row buffer. It can be created based on the media data stored in memory or using the media_packet_h handler. mv_source_h supported by the set of getters which allow to retrieve such image parameters as its size or colorspace (see mv_colorspace_e enumeration). The handler is usually used as parameter for functions performing computer vision tasks on the image data.
mv_engine_config_h is the handler which provides dictionary functionality. It means that it is possible to set (key, value) pairs to the mv_engine_config_h handlers and use them to transfer these values to the engine part underlying Media Vision API. Information on which attributes can be set is provided together with particular engines.

Related Features

This API is related with the following features:

  • http://tizen.org/feature/vision.barcode_detection
  • http://tizen.org/feature/vision.barcode_generation
  • http://tizen.org/feature/vision.face_recognition
  • http://tizen.org/feature/vision.image_recognition
  • http://tizen.org/feature/vision.inference
  • http://tizen.org/feature/vision.training
  • http://tizen.org/feature/vision.inference.face_recognition
  • http://tizen.org/feature/vision.training.face_recognition
  • http://tizen.org/feature/vision.inference.image
  • http://tizen.org/feature/vision.inference.face

It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.

Functions

int mv_create_source (mv_source_h *source)
 Creates a source handle.
int mv_destroy_source (mv_source_h source)
 Destroys the source handle and releases all its resources.
int mv_source_fill_by_media_packet (mv_source_h source, media_packet_h media_packet)
 Fills the media source based on the media packet.
int mv_source_fill_by_buffer (mv_source_h source, unsigned char *data_buffer, unsigned int buffer_size, unsigned int image_width, unsigned int image_height, mv_colorspace_e image_colorspace)
 Fills the media source based on the buffer and metadata.
int mv_source_clear (mv_source_h source)
 Clears the buffer of the media source.
int mv_source_get_buffer (mv_source_h source, unsigned char **data_buffer, unsigned int *buffer_size)
 Gets buffer of the media source.
int mv_source_get_height (mv_source_h source, unsigned int *image_height)
 Gets height of the media source.
int mv_source_get_width (mv_source_h source, unsigned int *image_width)
 Gets width of the media source.
int mv_source_get_colorspace (mv_source_h source, mv_colorspace_e *image_colorspace)
 Gets colorspace of the media source.
int mv_create_engine_config (mv_engine_config_h *engine_cfg)
 Creates the handle to the configuration of engine.
int mv_destroy_engine_config (mv_engine_config_h engine_cfg)
 Destroys the engine configuration handle and releases all its resources.
int mv_engine_config_set_double_attribute (mv_engine_config_h engine_cfg, const char *name, double value)
 Sets the double attribute to the configuration.
int mv_engine_config_set_int_attribute (mv_engine_config_h engine_cfg, const char *name, int value)
 Sets the integer attribute to the configuration.
int mv_engine_config_set_bool_attribute (mv_engine_config_h engine_cfg, const char *name, bool value)
 Sets the boolean attribute to the configuration.
int mv_engine_config_set_string_attribute (mv_engine_config_h engine_cfg, const char *name, const char *value)
 Sets the string attribute to the configuration.
int mv_engine_config_set_array_string_attribute (mv_engine_config_h engine_cfg, const char *name, const char **values, unsigned int size)
 Sets the array of string attribute to the configuration.
int mv_engine_config_get_double_attribute (mv_engine_config_h engine_cfg, const char *name, double *value)
 Gets the double attribute from the configuration dictionary.
int mv_engine_config_get_int_attribute (mv_engine_config_h engine_cfg, const char *name, int *value)
 Gets the integer attribute from the configuration dictionary.
int mv_engine_config_get_bool_attribute (mv_engine_config_h engine_cfg, const char *name, bool *value)
 Gets the boolean attribute from the configuration dictionary.
int mv_engine_config_get_string_attribute (mv_engine_config_h engine_cfg, const char *name, char **value)
 Gets the string attribute from the configuration dictionary.
int mv_engine_config_get_array_string_attribute (mv_engine_config_h engine_cfg, const char *name, char ***values, int *size)
 Gets the array of string attribute from the configuration dictionary.
int mv_engine_config_foreach_supported_attribute (mv_supported_attribute_cb callback, void *user_data)
 Traverses the list of supported attribute names and types.

Typedefs

typedef void * mv_engine_config_h
 The handle to the Media Vision API engine algorithms configuration.
typedef void * mv_source_h
 The handle to the source.
typedef bool(* mv_supported_attribute_cb )(mv_config_attribute_type_e attribute_type, const char *attribute_name, void *user_data)
 Called to get information (type and name) once for each supported attribute.

Typedef Documentation

typedef void* mv_engine_config_h

The handle to the Media Vision API engine algorithms configuration.

Configuration is a dictionary consists of key and value pairs to collect engine-specific settings and allow Media Vision module to access them internally. Engine configuration provides developer by the possibility to make computer vision algorithms work better in particular conditions of API usage. To create engine configuration handle mv_create_engine_config() function has to be used. When configuration is not needed any more, it is required to destroy it and release resources by mv_destroy_engine_config() function.

Since :
2.4
See also:
mv_create_engine_config()
mv_destroy_engine_config()
typedef void* mv_source_h

The handle to the source.

Since :
2.4
typedef bool(* mv_supported_attribute_cb)(mv_config_attribute_type_e attribute_type, const char *attribute_name, void *user_data)

Called to get information (type and name) once for each supported attribute.

Since :
2.4
Parameters:
[in]attribute_typeThe supported attribute type
[in]attribute_nameThe supported attribute name
[in]user_dataThe user data passed from the mv_engine_config_foreach_supported_attribute() function
Returns:
true to continue with the next iteration of the loop,
otherwise false to break out of the loop
Precondition:
mv_engine_config_foreach_supported_attribute() will invoke this callback
See also:
mv_engine_config_foreach_supported_attribute()

Enumeration Type Documentation

Enumeration for Media Vision colorspace.

Since :
2.4
Enumerator:
MEDIA_VISION_COLORSPACE_INVALID 

The colorspace type is invalid

MEDIA_VISION_COLORSPACE_Y800 

The colorspace type is Y800

MEDIA_VISION_COLORSPACE_I420 

The colorspace type is I420

MEDIA_VISION_COLORSPACE_NV12 

The colorspace type is NV12

MEDIA_VISION_COLORSPACE_YV12 

The colorspace type is YV12

MEDIA_VISION_COLORSPACE_NV21 

The colorspace type is NV21

MEDIA_VISION_COLORSPACE_YUYV 

The colorspace type is YUYV

MEDIA_VISION_COLORSPACE_UYVY 

The colorspace type is UYVY

MEDIA_VISION_COLORSPACE_422P 

The colorspace type is 422P

MEDIA_VISION_COLORSPACE_RGB565 

The colorspace type is RGB565

MEDIA_VISION_COLORSPACE_RGB888 

The colorspace type is RGB888

MEDIA_VISION_COLORSPACE_RGBA 

The colorspace type is RGBA

Enumeration for Media Vision mv_engine_config_h handle attribute type.

Since :
2.4
Enumerator:
MV_ENGINE_CONFIG_ATTR_TYPE_DOUBLE 

Double attribute type

MV_ENGINE_CONFIG_ATTR_TYPE_INTEGER 

Integer attribute type

MV_ENGINE_CONFIG_ATTR_TYPE_BOOLEAN 

Boolean attribute type

MV_ENGINE_CONFIG_ATTR_TYPE_STRING 

String attribute type

MV_ENGINE_CONFIG_ATTR_TYPE_ARRAY_STRING 

Array of string attribute type (Since 5.5)

enum mv_error_e

Enumeration for Media Vision error.

Since :
2.4
Enumerator:
MEDIA_VISION_ERROR_NONE 

Successful

MEDIA_VISION_ERROR_NOT_SUPPORTED 

Not supported

MEDIA_VISION_ERROR_MSG_TOO_LONG 

Message too long

MEDIA_VISION_ERROR_NO_DATA 

No data

MEDIA_VISION_ERROR_KEY_NOT_AVAILABLE 

Key not available

MEDIA_VISION_ERROR_OUT_OF_MEMORY 

Out of memory

MEDIA_VISION_ERROR_INVALID_PARAMETER 

Invalid parameter

MEDIA_VISION_ERROR_INVALID_OPERATION 

Invalid operation

MEDIA_VISION_ERROR_PERMISSION_DENIED 

Not permitted

MEDIA_VISION_ERROR_NOT_SUPPORTED_FORMAT 

Not supported format

MEDIA_VISION_ERROR_INTERNAL 

Internal error

MEDIA_VISION_ERROR_INVALID_DATA 

Invalid data

MEDIA_VISION_ERROR_INVALID_PATH 

Invalid path (Since 3.0)

MEDIA_VISION_ERROR_NOT_SUPPORTED_ENGINE 

Not supported engine (Since 5.5.)


Function Documentation

Creates the handle to the configuration of engine.

Since :
2.4
Remarks:
Available engine configuration attributes can be get by using mv_engine_config_foreach_supported_attribute(). The attributes can be changed by mv_engine_config_h related setters. Default values are used if the attributes are not changed.
Parameters:
[out]engine_cfgThe handle to the engine to be created
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_OUT_OF_MEMORYOut of memory
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_h
mv_destroy_engine_config()
mv_engine_config_set_double_attribute()
mv_engine_config_set_int_attribute()
mv_engine_config_set_bool_attribute()
mv_engine_config_set_string_attribute()
mv_engine_config_get_double_attribute()
mv_engine_config_get_int_attribute()
mv_engine_config_get_bool_attribute()
mv_engine_config_get_string_attribute()
int mv_create_source ( mv_source_h source)

Creates a source handle.

Since :
2.4
Remarks:
You must release source by using mv_destroy_source().
Parameters:
[out]sourceA new handle to the source
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_OUT_OF_MEMORYOut of memory
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_destroy_source()

Destroys the engine configuration handle and releases all its resources.

Since :
2.4
Parameters:
[in]engine_cfgThe handle to the engine configuration to be destroyed
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_h
mv_create_engine_config()
int mv_destroy_source ( mv_source_h  source)

Destroys the source handle and releases all its resources.

Since :
2.4
Parameters:
[in]sourceThe handle to the source to be destroyed
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_create_source()

Traverses the list of supported attribute names and types.

Using this function names of supported attributes can be obtained. Names of the attributes can be used with mv_engine_config_h related getters and setters to get/set appropriate attribute values.

Since :
2.4
Remarks:
If callback is called zero times after mv_engine_config_foreach_supported_attribute() call, then engine configuration is not supported and setting of attributes will cause no effect. In this case for all Media Vision functions which require mv_engine_config_h handle as in parameter this parameter can be set NULL.
If callback is called at least once, then attribute names and types obtained in the mv_supported_attribute_cb() callback can be changed after mv_engine_config_h handle creation (with mv_create_engine_config() function) by corresponding setters. Although, if attributes aren't changed by setters, then default values will be used.
Changing of attribute values will affect internal functionality provided by concrete library underlying Media Vision API.
Parameters:
[in]callbackThe iteration callback function
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_NO_DATACan't determine list of supported attributes
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_set_double_attribute()
mv_engine_config_set_int_attribute()
mv_engine_config_set_bool_attribute()
mv_engine_config_set_string_attribute()
mv_engine_config_get_double_attribute()
mv_engine_config_get_int_attribute()
mv_engine_config_get_bool_attribute()
mv_engine_config_get_string_attribute()
int mv_engine_config_get_array_string_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
char ***  values,
int *  size 
)

Gets the array of string attribute from the configuration dictionary.

Since :
5.5
Remarks:
Each element in the values array should be released using free(), then the array itself should be released using free().
Parameters:
[in]engine_cfgEngine configuration from which values should be obtained.
[in]nameString key of the attribute which will be used for getting the values from the configuration dictionary
[out]valuesThe attribute to be filled with the array of string value from dictionary
[out]sizeThe number of elements in values
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
See also:
mv_engine_config_set_array_string_attribute()
int mv_engine_config_get_bool_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
bool *  value 
)

Gets the boolean attribute from the configuration dictionary.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration from which value has to be gotten
[in]nameString key of the attribute will be used for getting the value from the configuration dictionary
[out]valueThe attribute to be filled with boolean value from dictionary
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_set_bool_attribute()
mv_engine_config_get_double_attribute()
mv_engine_config_get_int_attribute()
mv_engine_config_get_string_attribute()
int mv_engine_config_get_double_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
double *  value 
)

Gets the double attribute from the configuration dictionary.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration from which value has to be gotten
[in]nameString key of the attribute will be used for getting the value from the configuration dictionary
[out]valueThe attribute to be filled with double value from dictionary
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_set_double_attribute()
mv_engine_config_get_int_attribute()
mv_engine_config_get_bool_attribute()
mv_engine_config_get_string_attribute()
int mv_engine_config_get_int_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
int *  value 
)

Gets the integer attribute from the configuration dictionary.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration from which value has to be gotten
[in]nameString key of the attribute will be used for getting the value from the configuration dictionary
[out]valueThe attribute to be filled with integer value from dictionary
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_set_int_attribute()
mv_engine_config_get_double_attribute()
mv_engine_config_get_bool_attribute()
mv_engine_config_get_string_attribute()
mv_barcode_detect_attr_target_e
mv_barcode_generate_attr_text_e
int mv_engine_config_get_string_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
char **  value 
)

Gets the string attribute from the configuration dictionary.

Since :
2.4
Remarks:
Function allocates memory required for output value, so it has to be removed by the user himself.
Parameters:
[in]engine_cfgEngine configuration from which value has to be gotten
[in]nameString key of the attribute will be used for getting the value from the configuration dictionary
[out]valueThe attribute to be filled with string value from dictionary
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_set_string_attribute()
mv_engine_config_get_double_attribute()
mv_engine_config_get_int_attribute()
mv_engine_config_get_bool_attribute()
int mv_engine_config_set_array_string_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
const char **  values,
unsigned int  size 
)

Sets the array of string attribute to the configuration.

Since :
5.5
Parameters:
[in]engine_cfgEngine configuration for which values have to be set
[in]nameString key of the attribute will be used for storing the values into configuration dictionary
[in]valuesThe string values of the attribute
[in]sizeThe number of string values
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
See also:
mv_engine_config_get_array_string_attribute()
int mv_engine_config_set_bool_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
bool  value 
)

Sets the boolean attribute to the configuration.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration for which value has to be set
[in]nameString key of the attribute will be used for storing the value into configuration dictionary
[in]valueThe boolean value of the attribute
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_get_bool_attribute()
mv_engine_config_set_double_attribute()
mv_engine_config_set_int_attribute()
mv_engine_config_set_string_attribute()
int mv_engine_config_set_double_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
double  value 
)

Sets the double attribute to the configuration.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration for which value has to be set
[in]nameString key of the attribute will be used for storing the value into configuration dictionary
[in]valueThe double value of the attribute
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_get_double_attribute()
mv_engine_config_set_int_attribute()
mv_engine_config_set_bool_attribute()
mv_engine_config_set_string_attribute()
int mv_engine_config_set_int_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
int  value 
)

Sets the integer attribute to the configuration.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration for which value has to be set
[in]nameString key of the attribute will be used for storing the value into configuration dictionary
[in]valueThe integer value of the attribute
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_get_int_attribute()
mv_engine_config_set_double_attribute()
mv_engine_config_set_bool_attribute()
mv_engine_config_set_string_attribute()
mv_barcode_detect_attr_target_e
mv_barcode_generate_attr_text_e
int mv_engine_config_set_string_attribute ( mv_engine_config_h  engine_cfg,
const char *  name,
const char *  value 
)

Sets the string attribute to the configuration.

Since :
2.4
Parameters:
[in]engine_cfgEngine configuration for which value has to be set
[in]nameString key of the attribute will be used for storing the value into configuration dictionary
[in]valueThe string value of the attribute
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_KEY_NOT_AVAILABLEAttribute key isn't available
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_engine_config_get_string_attribute()
mv_engine_config_set_double_attribute()
mv_engine_config_set_int_attribute()
mv_engine_config_set_bool_attribute()
int mv_source_clear ( mv_source_h  source)

Clears the buffer of the media source.

Since :
2.4
Parameters:
[in,out]sourceThe handle to the source
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_source_fill_by_buffer()
int mv_source_fill_by_buffer ( mv_source_h  source,
unsigned char *  data_buffer,
unsigned int  buffer_size,
unsigned int  image_width,
unsigned int  image_height,
mv_colorspace_e  image_colorspace 
)

Fills the media source based on the buffer and metadata.

Since :
2.4
Parameters:
[in,out]sourceThe handle to the source
[in]data_bufferThe buffer of image data
[in]buffer_sizeThe buffer size
[in]image_widthThe width of image data
[in]image_heightThe height of image data
[in]image_colorspaceThe image colorspace
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_OUT_OF_MEMORYOut of memory
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
Precondition:
Create a source handle by calling mv_create_source()
See also:
mv_source_clear()
int mv_source_fill_by_media_packet ( mv_source_h  source,
media_packet_h  media_packet 
)

Fills the media source based on the media packet.

Since :
2.4
Parameters:
[in,out]sourceThe handle to the source
[in]media_packetThe handle to the media packet from which will be filled the source
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_INVALID_OPERATIONInvalid operation
MEDIA_VISION_ERROR_NOT_SUPPORTED_FORMATNot supported format
MEDIA_VISION_ERROR_OUT_OF_MEMORYOut of memory
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
Precondition:
Create a source handle by calling mv_create_source()
See also:
mv_create_source()
mv_destroy_source()
int mv_source_get_buffer ( mv_source_h  source,
unsigned char **  data_buffer,
unsigned int *  buffer_size 
)

Gets buffer of the media source.

Since :
2.4
Remarks:
Note that the retrieved buffer will be destroyed when mv_destroy_source() or mv_source_clear() function is called for the source.
Parameters:
[in]sourceThe handle to the source
[out]data_bufferThe buffer of the source
[out]buffer_sizeThe size of buffer
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_source_get_width()
mv_source_get_height()
mv_source_get_colorspace()
int mv_source_get_colorspace ( mv_source_h  source,
mv_colorspace_e image_colorspace 
)

Gets colorspace of the media source.

Since :
2.4
Parameters:
[in]sourceThe handle to the source
[out]image_colorspaceThe colorspace of an image in the source
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_source_get_width()
mv_source_get_height()
mv_source_get_buffer()
int mv_source_get_height ( mv_source_h  source,
unsigned int *  image_height 
)

Gets height of the media source.

Since :
2.4
Parameters:
[in]sourceThe handle to the source
[out]image_heightThe height of an image in the source
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_source_get_width()
mv_source_get_colorspace()
mv_source_get_buffer()
int mv_source_get_width ( mv_source_h  source,
unsigned int *  image_width 
)

Gets width of the media source.

Since :
2.4
Parameters:
[in]sourceThe handle to the source
[out]image_widthThe width of an image in the source
Returns:
0 on success, otherwise a negative error value
Return values:
MEDIA_VISION_ERROR_NONESuccessful
MEDIA_VISION_ERROR_INVALID_PARAMETERInvalid parameter
MEDIA_VISION_ERROR_NOT_SUPPORTEDNot supported
See also:
mv_source_get_height()
mv_source_get_colorspace()
mv_source_get_buffer()