README

   1 CONTENT
   2
   3 1. GENERAL DESCRIPTION OF THE MEDIA VISION PACKAGE
   4 2. USAGE OF PORTING LAYER FOR CHANGING MEDIA VISION ENGINE MODULES
   5 3. OPEN PORT REQUIRED PACKAGES
   6 4. TEST SUITE
   7
   8
   9
  10
  11 1. GENERAL DESCRIPTION OF THE MEDIA VISION PACKAGE
  12
  13 Media Vision package includes following modules: Common, Media Vision Barcode,
  14 Media Vision Face and Media Vision Image. Common module provides two handles
  15 (mv_source_h and mv_engine_config_h) and related functionality. It used by
  16 barcode detector and generator submodules. mv_source_h is used for wrapping raw
  17 image data buffers. mv_engine_config_h is optional. It can be used for fine
  18 tuning of internal libraries which are used by API. mv_engine_config_h handle
  19 usually can be used by barcode detector and/or generator modules (these modules
  20 provide mv_barcode_detector and mv_barcode_generator internal libraries) in the
  21 case when Native API doesn't cover all features supported by internal libraries.
  22 Using NULL instead of real mv_engine_h handle as functions parameter has to be
  23 taken into account. In most cases API user prefer to ignore detailed
  24 configuration of the modules.
  25
  26 Barcode detector submodule API provides tools to analyze the image buffers using
  27 mv_barcode_detect() function. This analysis strives to detect barcodes at the
  28 image, determine the type and extract the message. Results can be processed
  29 using mv_barcode_detected_cb callback.
  30
  31 Barcode generator submodule API provides tools to generate image buffer (or
  32 image file) with barcode. Barcodes generation can be configured by type,
  33 message, size, encoding mode, ECC (error correction level), version (three last
  34 setting are allowed only for QR Codes). One of two functions can be used:
  35 mv_barcode_generate_source() to generate the mv_source_h handle and
  36 mv_barcode_generate_image() to generate the file with barcode image.
  37
  38 Media Vision Face module aggregates functionality for detecting, recognition and
  39 tracking the faces on images. More detailed description can be found in doxygen
  40 documentation.
  41
  42 Media Vision Image module aggregates functionality for recognition and
  43 tracking the Flat Image objects. More detailed description can be found in
  44 doxygen documentation.
  45
  46
  47 2. USAGE OF PORTING LAYER FOR CHANGING MEDIA VISION ENGINE MODULES
  48
  49 Deprecated
  50
  51
  52 3. OPEN PORT REQUIRED PACKAGES
  53
  54 Building default barcode detector and generator libraries requires following
  55 dependencies:
  56
  57 Barcode detector: zbar
  58 Barcode generator: zint
  59 Media Vision Face: opencv_core, opencv_objdetect, opencv_contrib
  60 Media Vision Image: opencv_core, opencv_highgui, opencv_imgproc,
  61                     opencv_objdetect, opencv_features2d, opencv_nonfree,
  62                     opencv_calib3d
  63
  64 You can remove BuildRequires sections for these libraries from
  65 packaging/capi-media-vision.spec file if corresponding module/modules is/are
  66 disabled with options mentioned in 2.a.
  67
  68
  69
  70 3. TEST SUITE
  71
  72 capi-media-vision package includes test suites which allow to check API
  73 functionality. The test suite applications provide console interface that allows
  74 to select options for barcode generation and detection, face detection,
  75 recognition and tracking, image recognition and tracking. Source codes of the
  76 testsuites are located in corresponding subdirectories of the test directory in
  77 the capi-media-vision project root:
  78 test/testsuites/barcode
  79 test/testsuites/face
  80 test/testsuites/image