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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
/*
* Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __TIZEN_MEDIAVISION_DOC_H__
#define __TIZEN_MEDIAVISION_DOC_H__
/**
* @ingroup CAPI_MEDIA_FRAMEWORK
* @defgroup CAPI_MEDIA_VISION_MODULE Media Vision
* @brief Media Vision library providing following functionality:\n
* * Face detection, recognition, and tracking;\n
* * Barcode detection and generation;\n
* * Flat Image detection, recognition and tracking;\n
* * Flat Image features extraction.
*
* @defgroup CAPI_MEDIA_VISION_COMMON_MODULE Media Vision Common
* @ingroup CAPI_MEDIA_VISION_MODULE
* @brief Common functions and enumerations used in
* @ref CAPI_MEDIA_VISION_FACE_MODULE,
* @ref CAPI_MEDIA_VISION_IMAGE_MODULE and
* @ref CAPI_MEDIA_VISION_BARCODE_MODULE submodules.
* @section CAPI_MEDIA_VISION_COMMON_MODULE_HEADER Required Header
* \#include <mv_common.h>
*
* @section CAPI_MEDIA_VISION_COMMON_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_COMMON_MODULE provides a set of functions that
* are used in Media Vision API to correctly prepare and use included modules.
* @ref 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 @ref media_packet_h handler.
* @ref mv_source_h supported by the set of getters which allow to retrieve
* such image parameters as its size or colorspace (see @ref mv_colorspace_e
* enumeration). The handler is usually used as parameter for functions
* performing computer vision tasks on the image data.\n
* @ref mv_engine_config_h is the handler which provides dictionary
* functionality. It means that it is possible to set (key, value) pairs to
* the @ref 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.
*
* @section CAPI_MEDIA_VISION_COMMON_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/vision.barcode_detection\n
* - http://tizen.org/feature/vision.barcode_generation\n
* - http://tizen.org/feature/vision.face_recognition\n
* - http://tizen.org/feature/vision.image_recognition\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* You can check if a device supports the related features for this API by using
* @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
* your application.\n
* 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.\n
* More details on featuring your application can be found from
* <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm">
* <b>Feature Element</b>.
* </a>
*
* @defgroup CAPI_MEDIA_VISION_FACE_MODULE Media Vision Face
* @ingroup CAPI_MEDIA_VISION_MODULE
* @brief Face detection, recognition, and tracking.
* @section CAPI_MEDIA_VISION_FACE_MODULE_HEADER Required Header
* \#include <mv_face.h>
*
* @section CAPI_MEDIA_VISION_FACE_MODULE_OVERVIEW Overview
*
* @section CAPI_MEDIA_VISION_FACE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/vision.face_recognition\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* You can check if a device supports the related features for this API by using
* @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
* your application.\n
* 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.\n
* More details on featuring your application can be found from
* <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm">
* <b>Feature Element</b>.
* </a>
*
* @ref CAPI_MEDIA_VISION_FACE_MODULE contains @ref mv_face_detect() function
* to detect faces on @ref mv_source_h, and @ref mv_face_detected_cb callback
* to process detected faces. Also it contains @ref mv_face_recognize() function
* which performs face recognition on @ref mv_source_h for recognition model
* @ref mv_face_recognition_model_h handle. Results of the recognition will be
* passed to the @ref mv_face_recognized_cb. Results of the recognition consist
* of unique face label and confidence of the recognition model that face was
* recognized correctly. Unique face label is the integer identifier should be
* introduced to the model before starting recognition, when learning examples
* are added (see @ref mv_face_recognition_model_add() function
* documentation for details about unique face labels).\n
* Recognition model should be created with
* @ref mv_face_recognition_model_create() and destroyed with
* @ref mv_face_recognition_model_destroy(). Model can be cloned with
* @ref mv_face_recognition_model_clone(), saved to the file with
* @ref mv_face_recognition_model_save(), loaded with
* @ref mv_face_recognition_model_load(). Model learning can be provided with
* @ref mv_face_recognition_model_add(), and
* @ref mv_face_recognition_model_learn() functions. These two methods has to be
* called in the direct order: first, labeled face examples should be added to
* the model using @ref mv_face_recognition_model_add(). It is
* expected that images of the same face will be added specifying the same face
* label. When examples were added, model has to be learned based on the collected
* set of labeled face images. @ref mv_face_recognition_model_learn() function
* will perform learning. If it is required to get the list of unique face
* labels learned by the model, @ref mv_face_recognition_model_query_labels()
* function can be used.\n
* Module contains function
* @ref mv_face_track() which performs tracking on @ref mv_source_h for
* @ref mv_face_tracking_model_h and @ref mv_face_on_tracked_cb which process
* tracked face. Tracking model should be created with
* @ref mv_face_tracking_model_create() and destroyed with
* @ref mv_face_tracking_model_destroy(). Tracking model should be prepared
* with @ref mv_face_tracking_model_prepare() before each session of tracking.
* Model can be cloned with @ref mv_face_tracking_model_clone(), saved to the
* file with @ref mv_face_tracking_model_save(), loaded with
* @ref mv_face_tracking_model_load().\n
* Module provides function for detecting eye-blink status -
* @ref mv_face_eye_condition_recognize(), which provides detection on
* @ref mv_source_h and face location - @ref mv_rectangle_s. Callback
* @ref mv_face_eye_condition_recognized_cb handles result.\n
* Also module contains @ref mv_face_facial_expression_recognize() function which
* detects face expression on @ref mv_source_h, face location is determined by
* @ref mv_rectangle_s. Result is handled with
* @ref mv_face_facial_expression_recognized_cb.
*
* @defgroup CAPI_MEDIA_VISION_IMAGE_MODULE Media Vision Image
* @ingroup CAPI_MEDIA_VISION_MODULE
* @brief Flat Image recognition and tracking;\n
* Flat image features extraction.
* @section CCAPI_MEDIA_VISION_IMAGE_MODULE_HEADER Required Header
* \#include <mv_image.h>
*
* @section CAPI_MEDIA_VISION_IMAGE_MODULE_OVERVIEW Overview
*
* @section CAPI_MEDIA_VISION_IMAGE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/vision.image_recognition\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* You can check if a device supports the related features for this API by using
* @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
* your application.\n
* 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.\n
* More details on featuring your application can be found from
* <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm">
* <b>Feature Element</b>.
* </a>
*
* @ref CAPI_MEDIA_VISION_IMAGE_MODULE contains @ref mv_image_recognize()
* function to recognize images on @ref mv_source_h, and @ref
* mv_image_recognized_cb callback to process recognition result. Module
* also contains @ref mv_image_track() which performs tracking of image on
* sequence of @ref mv_source_h handles (by using method for each @ref
* mv_source_h) and callback @ref mv_image_tracked_cb to process tracking result.
* In order to perform general functionality, module contains @ref
* mv_image_object_h and @ref mv_image_tracking_model_h handles.
* Image object should be created with @ref mv_image_object_create() and
* destroyed with @ref mv_image_object_destroy(). @ref mv_image_object_h can be
* constructed by calling @ref mv_image_object_fill() using image wrapped with
* @ref mv_source_h. Object can be cloned with @ref mv_image_object_clone(),
* saved to the file with @ref mv_image_object_save() and loaded from file with
* @ref mv_image_object_load(). Image object can be evaluated with
* @ref mv_image_object_get_recognition_rate().
* Tracking model should be created with @ref mv_image_tracking_model_create()
* and destroyed with @ref mv_image_tracking_model_destroy(). Tracking model
* should be based on image object which will be tracked. Use
* @ref mv_image_tracking_model_set_target() to assign @ref mv_image_object_h
* to the corresponding @ref mv_image_tracking_model_h. It can be cloned with
* @ref mv_image_tracking_model_clone(), saved to the file with @ref
* mv_image_tracking_model_save() and loaded from file with @ref
* mv_image_tracking_model_load().
*
* @defgroup CAPI_MEDIA_VISION_BARCODE_MODULE Media Vision BarCode
* @ingroup CAPI_MEDIA_VISION_MODULE
* @brief Barcode module consists of barcode detection and barcode generation
* submodules.
* @section CAPI_MEDIA_VISION_BARCODE_MODULE_HEADER Required Header
* \#include <mv_barcode.h>
*
* @section CAPI_MEDIA_VISION_BARCODE_MODULE_OVERVIEW Overview
*
* @section CAPI_MEDIA_VISION_BARCODE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - http://tizen.org/feature/vision.barcode_detection\n
* - http://tizen.org/feature/vision.barcode_generation\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* You can check if a device supports the related features for this API by using
* @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
* your application.\n
* 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.\n
* More details on featuring your application can be found from
* <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm">
* <b>Feature Element</b>.
* </a>
*
* @ref CAPI_MEDIA_VISION_BARCODE_MODULE contains two submodules:\n
* * Detection submodule,
* * Generation submodule.\n
*
* Detection submodule can be used for detecting barcodes on image sources,
* reading encoded messages, getting barcode types.\n
* This module contains
* @ref mv_barcode_detect() function and @ref mv_barcode_detected_cb
* callback. @ref mv_barcode_detect() function can be called for the image
* determined by @ref mv_source_h handler to detect barcodes. If barcodes
* were detected, then @ref mv_barcode_detected_cb callback is called.
* Each detected barcode type, message and location can be processed by
* this callback. @ref mv_barcode_detect() supports ROI (rectangular region of
* interest) specification to allow barcode detection only for the region on
* the image.
*
* Generation submodule can be used for generating the barcodes and QR codes.
* Different encoding types (see @ref mv_barcode_qr_mode_e), error correction
* codes (see @ref mv_barcode_qr_ecc_e) and code versions are supported for
* QRCodes.\n This submodule contains @ref mv_barcode_generate_source() function
* to generate handler to the buffer with row image of barcode, and
* @ref mv_barcode_generate_image() function to generate image file with
* barcode. Both functions support the set of parameters which allow API user to
* configure output barcode. QR codes as well as Barcodes are supported
* (see @ref mv_barcode_type_e enumeration for full list of supported barcodes).
* For QR codes it is possible to specify error correction code and encoding
* mode (see @ref mv_barcode_qr_mode_e). Generation to file supports several
* formats (see @ref mv_barcode_image_format_e).
*/
#endif /* __TIZEN_MEDIAVISION_DOC_H__ */
|
