summaryrefslogtreecommitdiff
path: root/README
blob: 2b5c2442fafb8cb4b0fa16fb35f0b6001a7926c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
CONTENT

1. GENERAL DESCRIPTION OF THE MEDIA VISION PACKAGE
2. USAGE OF PORTING LAYER FOR CHANGING MEDIA VISION ENGINE MODULES
3. OPEN PORT REQUIRED PACKAGES
4. TEST SUITE




1. GENERAL DESCRIPTION OF THE MEDIA VISION PACKAGE

Media Vision package includes following modules: Common, Media Vision Barcode,
Media Vision Face and Media Vision Image. Common module provides two handles
(mv_source_h and mv_engine_config_h) and related functionality. It used by
barcode detector and generator submodules. mv_source_h is used for wrapping raw
image data buffers. mv_engine_config_h is optional. It can be used for fine
tuning of internal libraries which are used by API. mv_engine_config_h handle
usually can be used by barcode detector and/or generator modules (these modules
provide mv_barcode_detector and mv_barcode_generator internal libraries) in the
case when Native API doesn't cover all features supported by internal libraries.
Using NULL instead of real mv_engine_h handle as functions parameter has to be
taken into account. In most cases API user prefer to ignore detailed
configuration of the modules.

Barcode detector submodule API provides tools to analyze the image buffers using
mv_barcode_detect() function. This analysis strives to detect barcodes at the
image, determine the type and extract the message. Results can be processed
using mv_barcode_detected_cb callback.

Barcode generator submodule API provides tools to generate image buffer (or
image file) with barcode. Barcodes generation can be configured by type,
message, size, encoding mode, ECC (error correction level), version (three last
setting are allowed only for QR Codes). One of two functions can be used:
mv_barcode_generate_source() to generate the mv_source_h handle and
mv_barcode_generate_image() to generate the file with barcode image.

Media Vision Face module aggregates functionality for detecting, recognition and
tracking the faces on images. More detailed description can be found in doxygen
documentation.

Media Vision Image module aggregates functionality for recognition and
tracking the Flat Image objects. More detailed description can be found in
doxygen documentation.


2. USAGE OF PORTING LAYER FOR CHANGING MEDIA VISION ENGINE MODULES

Deprecated


3. OPEN PORT REQUIRED PACKAGES

Building default barcode detector and generator libraries requires following
dependencies:

Barcode detector: zbar
Barcode generator: zint
Media Vision Face: opencv_core, opencv_objdetect, opencv_contrib
Media Vision Image: opencv_core, opencv_highgui, opencv_imgproc,
                    opencv_objdetect, opencv_features2d, opencv_nonfree,
                    opencv_calib3d

You can remove BuildRequires sections for these libraries from
packaging/capi-media-vision.spec file if corresponding module/modules is/are
disabled with options mentioned in 2.a.



3. TEST SUITE

capi-media-vision package includes test suites which allow to check API
functionality. The test suite applications provide console interface that allows
to select options for barcode generation and detection, face detection,
recognition and tracking, image recognition and tracking. Source codes of the
testsuites are located in corresponding subdirectories of the test directory in
the capi-media-vision project root:
test/testsuites/barcode
test/testsuites/face
test/testsuites/image