/**
* @brief Define MV_BARCODE_DETECT_ATTR_TARGET to set target attribute of the engine configuration
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*
* @see mv_barcode_detect_attr_target_e
*/
/**
* @brief Enumeration to target attribute
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
MV_BARCODE_DETECT_ATTR_TARGET_ALL, /**< 1D and 2D */
* @details If no barcode is detected then the method will be called, barcodes
* and states will be equal to NULL, and @a number_of_barcodes - 0.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The handle to the media source
* @param [in] engine_cfg The handle to the configuration of the engine
* @param [in] barcode_locations The quadrangle locations of detected barcodes
/**
* @brief Detects barcode(s) on source and reads message from it.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The media source handle
* @param [in] engine_cfg The handle to the configuration of the engine
* @param [in] roi Region of interest - rectangular area on the
* @brief Define MV_BARCODE_GENERATE_ATTR_TEXT to set text attribute
* of the engine configuration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks This attribute is only available for 1D barcode generation
*
* @see mv_barcode_generate_attr_text_e
/**
* @brief Enumeration to text attribute.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
MV_BARCODE_GENERATE_ATTR_TEXT_INVISIBLE, /**< Invisible */
* message length. Also for QR codes the version may be selected as minimum
* required to generate QR code with the input message length.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks If the text attribute of engine configuration is set to
* #MV_BARCODE_GENERATE_ATTR_TEXT_VISIBLE,
* #MEDIA_VISION_ERROR_INVALID_OPERATION will be returned
* message length. Also for QR codes the version may be selected as minimum
* required to generate QR code with the input message length.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks If the text attribute of engine configuration is set to
* #MV_BARCODE_GENERATE_ATTR_TEXT_VISIBLE,
* #MEDIA_VISION_ERROR_INVALID_OPERATION will be returned
* @brief Enumeration for supported barcode types.
* @details QR codes (versions 1 to 40) and set of 1D barcodes are supported
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks #MV_BARCODE_UNDEFINED is deprecated. Use #MV_BARCODE_UNKNOWN instead
*/
typedef enum {
/**
* @brief Enumeration for supported QR code error correction level.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks This is unavailable for 1D barcodes
*/
typedef enum {
/**
* @brief Enumeration for supported QR code encoding mode.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks This is unavailable for 1D barcodes
*/
typedef enum {
/**
* @brief Enumeration for supported image formats for the barcode generating.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
MV_BARCODE_IMAGE_FORMAT_UNAVAILABLE = -1, /**< Unavailable image format */
/**
* @brief Point in 2D space.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef struct {
int x; /**< X-axis coordinate of the point in 2D space */
/**
* @brief Location of the object bounded by quadrangle defined by four 2D points.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef struct {
mv_point_s points[4]; /**< Four points that define object bounding
* @brief Location of the object bounded by rectangle defined by
* coordinates of top left corner, width and height.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef struct {
mv_point_s point; /**< Top left corner of rectangle coordinates */
/**
* @brief Enumeration for Media Vision error.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
MEDIA_VISION_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
* @brief Enumeration for Media Vision #mv_engine_config_h handle attribute
* type.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
MV_ENGINE_CONFIG_ATTR_TYPE_DOUBLE, /**< Double attribute type */
/**
* @brief Enumeration for Media Vision colorspace.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
MEDIA_VISION_COLORSPACE_INVALID, /**< The colorspace type is invalid */
* destroy it and release resources by mv_destroy_engine_config()
* function.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*
* @see mv_create_engine_config()
* @see mv_destroy_engine_config()
/**
* @brief The handle to the source.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
typedef void *mv_source_h;
/**
* @brief Creates a source handle.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks You must release @a source by using mv_destroy_source().
* @param [out] source A new handle to the source
* @return @c 0 on success, otherwise a negative error value
/**
* @brief Destroys the source handle and releases all its resources.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The handle to the source to be destroyed
* @return @c 0 on success, otherwise a negative error value
* @retval #MEDIA_VISION_ERROR_NONE Successful
/**
* @brief Fills the media source based on the media packet.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in,out] source The handle to the source
* @param [in] media_packet The handle to the media packet from which
* will be filled the source
/**
* @brief Fills the media source based on the buffer and metadata.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in,out] source The handle to the source
* @param [in] data_buffer The buffer of image data
* @param [in] buffer_size The buffer size
/**
* @brief Clears the buffer of the media source.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in,out] source The handle to the source
* @return @c 0 on success, otherwise a negative error value
* @retval #MEDIA_VISION_ERROR_NONE Successful
/**
* @brief Gets buffer of the media source.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks Note that the retrieved buffer will be destroyed when
* mv_destroy_source() or mv_source_clear() function
* is called for the @a source.
/**
* @brief Gets height of the media source.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The handle to the source
* @param [out] image_height The height of an image in the source
* @return @c 0 on success, otherwise a negative error value
/**
* @brief Gets width of the media source.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The handle to the source
* @param [out] image_width The width of an image in the source
* @return @c 0 on success, otherwise a negative error value
/**
* @brief Gets colorspace of the media source.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The handle to the source
* @param [out] image_colorspace The colorspace of an image in the source
* @return @c 0 on success, otherwise a negative error value
/**
* @brief Creates the handle to the configuration of engine.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 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
* @brief Destroys the engine configuration handle and releases all its
* resources.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg The handle to the engine configuration
* to be destroyed
* @return @c 0 on success, otherwise a negative error value
/**
* @brief Sets the double attribute to the configuration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration for which @a value has
* to be set
* @param [in] name String key of the attribute will be used for
/**
* @brief Sets the integer attribute to the configuration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration for which @a value has
* to be set
* @param [in] name String key of the attribute will be used for
/**
* @brief Sets the boolean attribute to the configuration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration for which @a value has
* to be set
* @param [in] name String key of the attribute will be used for
/**
* @brief Sets the string attribute to the configuration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration for which @a value has
* to be set
* @param [in] name String key of the attribute will be used for
/**
* @brief Gets the double attribute from the configuration dictionary.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration from which @a value
* has to be gotten
* @param [in] name String key of the attribute will be used for
/**
* @brief Gets the integer attribute from the configuration dictionary.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration from which @a value
* has to be gotten
* @param [in] name String key of the attribute will be used for
/**
* @brief Gets the boolean attribute from the configuration dictionary.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg Engine configuration from which @a value
* has to be gotten
* @param [in] name String key of the attribute will be used for
/**
* @brief Gets the string attribute from the configuration dictionary.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks Function allocates memory required for output @a value, so
* it has to be removed by the user himself.
* @param [in] engine_cfg Engine configuration from which @a value
* @brief Called to get information (type and name) once for each supported
* attribute.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] attribute_type The supported attribute type
* @param [in] attribute_name The supported attribute name
* @param [in] user_data The user data passed from the
* Names of the attributes can be used with #mv_engine_config_h
* related getters and setters to get/set appropriate attribute values.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks If @a callback is called zero times after
* mv_engine_config_foreach_supported_attribute() call, then
* engine configuration is not supported and setting of attributes will
/**
* @brief Barcode constructor.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks create copy of bar_obj
* @param [in] barObj zbar barcode handle
*
/**
* @brief Barcode destructor.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
~Barcode();
/**
* @brief Gets encoded message from barcode object.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Encoded message
*/
std::string getMessage(void) const;
/**
* @brief Gets the type of the barcode.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Enumeration value corresponding to the barcode type
*/
mv_barcode_type_e getType(void) const;
* @brief Calculates location of barcode handle from zbar.
* location polygon.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [out] location Quadrangle that contains barcode on image
* @return @c MEDIA_VISION_ERROR_NONE on success,
* otherwise a negative error value
/**
* @brief This function converts media vision image handle to zbar image handle.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] mvSource Media vision image handle
* @param [out] zbarSource Zbar image handle
* @return @c MEDIA_VISION_ERROR_NONE on success,
/**
* @brief Detects barcode(s) on source and reads message from it.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] source The media source handle
* @param [in] engine_cfg The handle to the configuration of the engine
* @param [in] roi Region of interest - rectangular area on the
* @brief This class implements barcode generation.
* @details 1D Barcodes and 2D QR codes are supported.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
class BarcodeGenerator
{
/**
* @brief This method generates Barcodes image according to options.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] imageFileName Image file name which will be generated
* @param [in] imageFormat Image file format which will be generated
* @param [in] imageWidth Image file width which will be generated
/**
* @brief This method generates Barcodes image buffer according to options.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [out] imageBuffer Image buffer with image to be generated
* @param [out] imageWidth Image buffer width which will be generated
* @param [out] imageHeight Image buffer height which will be generated
/**
* @brief The Barcode type enumeration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
enum BarcodeType {
BARCODE_QR = 58,
/**
* @brief The Barcode error correction level enumeration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks This is unavailable for 1D barcodes.
*/
enum BarcodeQRErrorCorrectionLevel {
/**
* @brief The Barcode encoding mode enumeration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @remarks This is unavailable for 1D barcodes.
*/
enum BarcodeQREncodingMode {
/**
* @brief The Barcode image format enumeration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
enum BarcodeImageFormat { BARCODE_IMAGE_JPG, BARCODE_IMAGE_PNG, BARCODE_IMAGE_BMP };
/**
* @brief The Barcode generation text option enumeration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
enum BarcodeGenTextOpt { BARCODE_GEN_TEXT_INVISIBLE, BARCODE_GEN_TEXT_VISIBLE };
/**
* @brief The Barcode error enumeration.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*/
enum BarcodeError {
BARCODE_ERROR_NONE = 0,
/**
* @brief Generates @ref mv_source_h with barcode image.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg The handle to the configuration of the engine
* @param [in] message The message to be encoded in the barcode
* @param [in] type Type of the barcode to be generated
/**
* @brief Generates image file with barcode.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] engine_cfg The handle to the configuration of the engine
* @param [in] message The message to be encoded in the barcode
* @param [in] image_width The width of the generated image
/**
* @brief Sets attribute with double value.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [in] value The double attribute value to be set
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Sets attribute with integer value.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [in] value The integer attribute value to be set
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Sets attribute with boolean value.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [in] value The boolean attribute value to be set
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Sets attribute with string value.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [in] value The string attribute value to be set
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Gets double attribute value by attribute name.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [out] value The double attribute value to be obtained
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Gets integer attribute value by attribute name.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [out] value The integer attribute value to be obtained
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Gets boolean attribute value by attribute name.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [out] value The boolean attribute value to be obtained
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Gets string attribute value by attribute name.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] key The string name of the attribute
* @param [out] value The string attribute value to be obtained
* @return @c MEDIA_VISION_ERROR_NONE on success,\n
/**
* @brief Destroys the MediaSource and releases all its resources.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*
* @see MediaSource::MediaSource()
*/
* @brief Clears the MediaSource.
* @details Releases all internal resources and set parameters to default values.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
*
* @see MediaSource::MediaSource()
* @see MediaSource::fill()
/**
* @brief Fills the MediaSource based on the buffer and metadata.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @param [in] buffer The buffer of image data
* @param [in] bufferSize The buffer size
* @param [in] width The image width
/**
* @brief Gets data buffer of the MediaSource.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Pointer to the data buffer.
*/
unsigned char *getBuffer(void) const;
/**
* @brief Gets buffer size of the MediaSource.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Size of data buffer.
*/
unsigned int getBufferSize(void) const;
/**
* @brief Gets image width of the MediaSource.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Width of image.
*/
unsigned int getWidth(void) const;
/**
* @brief Gets image height of the MediaSource.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Height of image.
*/
unsigned int getHeight(void) const;
/**
* @brief Gets image colorspace of the MediaSource.
*
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @since_tizen 2.4
* @return Colorspace of image.
*/
mv_colorspace_e getColorspace(void) const;