1 /*
2  * Copyright (C) 2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 /**
17  * @addtogroup image
18  * @{
19  *
20  * @brief Provides APIs for access to the image interface.
21  *
22  * @Syscap SystemCapability.Multimedia.Image
23  * @since 10
24  * @version 2.0
25  */
26 
27 /**
28  * @file image_mdk_common.h
29  *
30  * @brief Declares the common enums and structs used by the image interface.
31  *
32  * @since 10
33  * @version 2.0
34  */
35 
36 #ifndef INTERFACES_KITS_NATIVE_INCLUDE_IMAGE_COMMON_H
37 #define INTERFACES_KITS_NATIVE_INCLUDE_IMAGE_COMMON_H
38 #include <stdint.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 #define IMAGE_RESULT_BASE 62980096
44 /**
45  * @brief Enumerates the return values that may be used by the interface.
46  *
47  * @since 10
48  * @version 2.0
49  */
50 typedef enum {
51     IMAGE_RESULT_SUCCESS = 0,                                      // Operation success
52     IMAGE_RESULT_BAD_PARAMETER = -1,                               // Invalid parameter
53     IMAGE_RESULT_IMAGE_RESULT_BASE = IMAGE_RESULT_BASE,            // Operation failed
54     IMAGE_RESULT_ERR_IPC = IMAGE_RESULT_BASE + 1,                  // ipc error
55     IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST = IMAGE_RESULT_BASE + 2,     // sharememory error
56     IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL = IMAGE_RESULT_BASE + 3, // sharememory data abnormal
57     IMAGE_RESULT_DECODE_ABNORMAL = IMAGE_RESULT_BASE + 4,          // image decode error
58     IMAGE_RESULT_DATA_ABNORMAL = IMAGE_RESULT_BASE + 5,            // image input data error
59     IMAGE_RESULT_MALLOC_ABNORMAL = IMAGE_RESULT_BASE + 6,          // image malloc error
60     IMAGE_RESULT_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 7,           // image type unsupported
61     IMAGE_RESULT_INIT_ABNORMAL = IMAGE_RESULT_BASE + 8,            // image init error
62     IMAGE_RESULT_GET_DATA_ABNORMAL = IMAGE_RESULT_BASE + 9,        // image get data error
63     IMAGE_RESULT_TOO_LARGE = IMAGE_RESULT_BASE + 10,               // image data too large
64     IMAGE_RESULT_TRANSFORM = IMAGE_RESULT_BASE + 11,               // image transform error
65     IMAGE_RESULT_COLOR_CONVERT = IMAGE_RESULT_BASE + 12,           // image color convert error
66     IMAGE_RESULT_CROP = IMAGE_RESULT_BASE + 13,                    // crop error
67     IMAGE_RESULT_SOURCE_DATA = IMAGE_RESULT_BASE + 14,             // image source data error
68     IMAGE_RESULT_SOURCE_DATA_INCOMPLETE = IMAGE_RESULT_BASE + 15,  // image source data incomplete
69     IMAGE_RESULT_MISMATCHED_FORMAT = IMAGE_RESULT_BASE + 16,       // image mismatched format
70     IMAGE_RESULT_UNKNOWN_FORMAT = IMAGE_RESULT_BASE + 17,          // image unknown format
71     IMAGE_RESULT_SOURCE_UNRESOLVED = IMAGE_RESULT_BASE + 18,       // image source unresolved
72     IMAGE_RESULT_INVALID_PARAMETER = IMAGE_RESULT_BASE + 19,       // image invalid parameter
73     IMAGE_RESULT_DECODE_FAILED = IMAGE_RESULT_BASE + 20,           // decode fail
74     IMAGE_RESULT_PLUGIN_REGISTER_FAILED = IMAGE_RESULT_BASE + 21,  // register plugin fail
75     IMAGE_RESULT_PLUGIN_CREATE_FAILED = IMAGE_RESULT_BASE + 22,    // create plugin fail
76     IMAGE_RESULT_ENCODE_FAILED = IMAGE_RESULT_BASE + 23,           // image encode fail
77     IMAGE_RESULT_ADD_PIXEL_MAP_FAILED = IMAGE_RESULT_BASE + 24,    // image add pixel map fail
78     IMAGE_RESULT_HW_DECODE_UNSUPPORT = IMAGE_RESULT_BASE + 25,     // image hardware decode unsupported
79     IMAGE_RESULT_DECODE_HEAD_ABNORMAL = IMAGE_RESULT_BASE + 26,    // image decode head error
80     IMAGE_RESULT_DECODE_EXIF_UNSUPPORT = IMAGE_RESULT_BASE + 27,   // image decode exif unsupport
81     IMAGE_RESULT_PROPERTY_NOT_EXIST = IMAGE_RESULT_BASE + 28,      // image property not exist
82 
83     IMAGE_RESULT_MEDIA_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 30,               // media type unsupported
84     IMAGE_RESULT_MEDIA_TOO_LARGE = IMAGE_RESULT_BASE + 31,                    // media data too large
85     IMAGE_RESULT_MEDIA_MALLOC_FAILED = IMAGE_RESULT_BASE + 32,                // media malloc memory failed
86     IMAGE_RESULT_MEDIA_END_OF_STREAM = IMAGE_RESULT_BASE + 33,                // media end of stream error
87     IMAGE_RESULT_MEDIA_IO_ABNORMAL = IMAGE_RESULT_BASE + 34,                  // media io error
88     IMAGE_RESULT_MEDIA_MALFORMED = IMAGE_RESULT_BASE + 35,                    // media malformed error
89     IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL = IMAGE_RESULT_BASE + 36,             // media buffer too small error
90     IMAGE_RESULT_MEDIA_OUT_OF_RANGE = IMAGE_RESULT_BASE + 37,                 // media out of range error
91     IMAGE_RESULT_MEDIA_STATUS_ABNORMAL = IMAGE_RESULT_BASE + 38,              // media status abnormal error
92     IMAGE_RESULT_MEDIA_VALUE_INVALID = IMAGE_RESULT_BASE + 39,                // media value invalid
93     IMAGE_RESULT_MEDIA_NULL_POINTER = IMAGE_RESULT_BASE + 40,                 // media error operation
94     IMAGE_RESULT_MEDIA_INVALID_OPERATION = IMAGE_RESULT_BASE + 41,            // media invalid operation
95     IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT = IMAGE_RESULT_BASE + 42,          // media init error
96     IMAGE_RESULT_MEDIA_EARLY_PREPARE = IMAGE_RESULT_BASE + 43,                // media early prepare
97     IMAGE_RESULT_MEDIA_SEEK_ERR = IMAGE_RESULT_BASE + 44,                     // media rewind error
98     IMAGE_RESULT_MEDIA_PERMISSION_DENIED = IMAGE_RESULT_BASE + 45,            // media permission denied
99     IMAGE_RESULT_MEDIA_DEAD_OBJECT = IMAGE_RESULT_BASE + 46,                  // media dead object
100     IMAGE_RESULT_MEDIA_TIMED_OUT = IMAGE_RESULT_BASE + 47,                    // media time out
101     IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED = IMAGE_RESULT_BASE + 48,      // media track subset support
102     IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED = IMAGE_RESULT_BASE + 49,          // media recorder adapter init failed
103     IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL = IMAGE_RESULT_BASE + 50,            // write parcel failed
104     IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL = IMAGE_RESULT_BASE + 51,             // read parcel failed
105     IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER = IMAGE_RESULT_BASE + 52,              // read parcel failed
106     IMAGE_RESULT_MEDIA_INVALID_PARAM = IMAGE_RESULT_BASE + 53,                // media function found invalid param
107     IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 54,      // media zcodec adapter not init
108     IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED = IMAGE_RESULT_BASE + 55,  // media create zcodec adapter failed
109     IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 56,       // media adapter inner not init
110     IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED = IMAGE_RESULT_BASE + 57,         // media adapter inner not init
111     IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST = IMAGE_RESULT_BASE + 58,             // media zcodec not exist
112     IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST = IMAGE_RESULT_BASE + 59,          // media jni class not found
113     IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST = IMAGE_RESULT_BASE + 60,         // media jni method not found
114     IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED = IMAGE_RESULT_BASE + 61,           // media jni obj new failed
115     IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR = IMAGE_RESULT_BASE + 62,             // media jni normal error
116     IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT = IMAGE_RESULT_BASE + 63,       // media distribute not support
117     IMAGE_RESULT_MEDIA_SOURCE_NOT_SET = IMAGE_RESULT_BASE + 64,               // media source not set
118     IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 65,        // media rtsp adapter not init
119     IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 66,       // media rtsp adapter not exist
120     IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT = IMAGE_RESULT_BASE + 67,       // media rtsp surface not support
121     IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT = IMAGE_RESULT_BASE + 68,        // media rtsp capture init error
122     IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID = IMAGE_RESULT_BASE + 69,      // media rtsp source url invalid
123     IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND = IMAGE_RESULT_BASE + 70,   // media rtsp can't find video track
124     IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX = IMAGE_RESULT_BASE + 71,    // rtsp camera num reach to max num
125     IMAGE_RESULT_MEDIA_SET_VOLUME = IMAGE_RESULT_BASE + 72,                   // media set volume error
126     IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW = IMAGE_RESULT_BASE + 73,              // media number operation overflow
127     IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED = IMAGE_RESULT_BASE + 74,       // media distribute player unsupporteded
128     IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 75,           // image dencode ICC fail
129     IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 76,            // image encode ICC fail
130 
131     IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 150,        // read pixelmap failed
132     IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 151,       // write pixelmap failed
133     IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY = IMAGE_RESULT_BASE + 152,   // pixelmap not allow modify
134     IMAGE_RESULT_MEDIA_CONFIG_FAILED = IMAGE_RESULT_BASE + 153,               // config error
135     IMAGE_RESULT_JNI_ENV_ABNORMAL = IMAGE_RESULT_BASE + 154,                  // Abnormal JNI environment
136     IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED = IMAGE_RESULT_BASE + 155,     // surface gralloc buffer failed
137     IMAGE_RESULT_CREATE_SURFACE_FAILED = IMAGE_RESULT_BASE + 156,             // create surface failed
138     IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED = IMAGE_RESULT_BASE + 157,      // Failed to obtain parameters for surface
139     IMAGE_RESULT_GET_SURFACE_FAILED = IMAGE_RESULT_BASE + 158,                // get sufrace failed
140     IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED = IMAGE_RESULT_BASE + 159,     // Acquire Buffer failed
141     IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED = IMAGE_RESULT_BASE + 160,     // request Buffer failed
142     IMAGE_RESULT_REGISTER_LISTENER_FAILED = IMAGE_RESULT_BASE + 161,          // Failed to register listener
143     IMAGE_RESULT_REGISTER_BUFFER_FAILED = IMAGE_RESULT_BASE + 162,            // Failed to register buffer
144     IMAGE_RESULT_FREAD_FAILED = IMAGE_RESULT_BASE + 163,                      // read file failed
145     IMAGE_RESULT_PEEK_FAILED = IMAGE_RESULT_BASE + 164,                       // peek file failed
146     IMAGE_RESULT_SEEK_FAILED = IMAGE_RESULT_BASE + 165,                       // seek file failed
147     IMAGE_RESULT_STREAM_SIZE_ERROR = IMAGE_RESULT_BASE + 166,                 // stream bad
148     IMAGE_RESULT_FILE_FD_ERROR = IMAGE_RESULT_BASE + 167,                     // file fd is bad
149     IMAGE_RESULT_FILE_DAMAGED = IMAGE_RESULT_BASE + 168,                      // file damaged
150     IMAGE_RESULT_CREATE_DECODER_FAILED = IMAGE_RESULT_BASE + 169,             // create decoder failed
151     IMAGE_RESULT_CREATE_ENCODER_FAILED = IMAGE_RESULT_BASE + 170,             // create encoder failed
152     IMAGE_RESULT_CHECK_FORMAT_ERROR = IMAGE_RESULT_BASE + 171,                // check format failed
153     IMAGE_RESULT_THIRDPART_SKIA_ERROR = IMAGE_RESULT_BASE + 172,              // skia error
154     IMAGE_RESULT_HW_DECODE_FAILED = IMAGE_RESULT_BASE + 173,                  // hard decode failed
155     IMAGE_RESULT_ALLOCATER_TYPE_ERROR = IMAGE_RESULT_BASE + 174,              // hard decode failed
156     IMAGE_RESULT_ALPHA_TYPE_ERROR = IMAGE_RESULT_BASE + 175,                  // hard decode failed
157     IMAGE_RESULT_INDEX_INVALID = IMAGE_RESULT_BASE + 176,                     // invalid index
158     IMAGE_RESULT_CREATE_FORMAT_CONVERT_FAILED = IMAGE_RESULT_BASE + 177,
159     IMAGE_RESULT_FORMAT_CONVERT_FAILED = IMAGE_RESULT_BASE + 178,
160 
161     IMAGE_RESULT_MEDIA_UNKNOWN = IMAGE_RESULT_BASE + 200,                     // media unknown error
162 } IRNdkErrCode;
163 
164 /**
165  * @brief Defines the image size.
166  *
167  * @since 10
168  * @version 2.0
169  */
170 struct OhosImageSize {
171     /** Image width, in pixels. */
172     int32_t width;
173     /** Image height, in pixels. */
174     int32_t height;
175 };
176 
177 #ifdef __cplusplus
178 };
179 #endif
180 /** @} */
181 
182 #endif // INTERFACES_KITS_NATIVE_INCLUDE_IMAGE_COMMON_H