1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /**
18  * @addtogroup Media
19  * @{
20  */
21 
22 /**
23  * @file NdkMediaError.h
24  */
25 
26 /*
27  * This file defines an NDK API.
28  * Do not remove methods.
29  * Do not change method signatures.
30  * Do not change the value of constants.
31  * Do not change the size of any of the classes defined in here.
32  * Do not reference types that are not part of the NDK.
33  * Do not #include files that aren't part of the NDK.
34  */
35 
36 #ifndef _NDK_MEDIA_ERROR_H
37 #define _NDK_MEDIA_ERROR_H
38 
39 #include <sys/cdefs.h>
40 
41 __BEGIN_DECLS
42 
43 /**
44  * Media error message types returned from NDK media functions.
45  */
46 typedef enum {
47     /** The requested media operation completed successfully. */
48     AMEDIA_OK = 0,
49 
50     /**
51      * This indicates required resource was not able to be allocated.
52      */
53     AMEDIACODEC_ERROR_INSUFFICIENT_RESOURCE = 1100,
54 
55     /**
56      * This indicates the resource manager reclaimed the media resource used by the codec.
57      * With this error, the codec must be released, as it has moved to terminal state.
58      */
59     AMEDIACODEC_ERROR_RECLAIMED             = 1101,
60 
61     AMEDIA_ERROR_BASE                  = -10000,
62 
63     /** The called media function failed with an unknown error. */
64     AMEDIA_ERROR_UNKNOWN               = AMEDIA_ERROR_BASE,
65 
66     /** The input media data is corrupt or incomplete. */
67     AMEDIA_ERROR_MALFORMED             = AMEDIA_ERROR_BASE - 1,
68 
69     /** The required operation or media formats are not supported. */
70     AMEDIA_ERROR_UNSUPPORTED           = AMEDIA_ERROR_BASE - 2,
71 
72     /** An invalid (or already closed) object is used in the function call. */
73     AMEDIA_ERROR_INVALID_OBJECT        = AMEDIA_ERROR_BASE - 3,
74 
75     /** At least one of the invalid parameters is used. */
76     AMEDIA_ERROR_INVALID_PARAMETER     = AMEDIA_ERROR_BASE - 4,
77 
78     /** The media object is not in the right state for the required operation. */
79     AMEDIA_ERROR_INVALID_OPERATION     = AMEDIA_ERROR_BASE - 5,
80 
81     /** Media stream ends while processing the requested operation. */
82     AMEDIA_ERROR_END_OF_STREAM         = AMEDIA_ERROR_BASE - 6,
83 
84     /** An Error occurred when the Media object is carrying IO operation. */
85     AMEDIA_ERROR_IO                    = AMEDIA_ERROR_BASE - 7,
86 
87     /** The required operation would have to be blocked (on I/O or others),
88      *   but blocking is not enabled.
89      */
90     AMEDIA_ERROR_WOULD_BLOCK           = AMEDIA_ERROR_BASE - 8,
91 
92     AMEDIA_DRM_ERROR_BASE              = -20000,
93     AMEDIA_DRM_NOT_PROVISIONED         = AMEDIA_DRM_ERROR_BASE - 1,
94     AMEDIA_DRM_RESOURCE_BUSY           = AMEDIA_DRM_ERROR_BASE - 2,
95     AMEDIA_DRM_DEVICE_REVOKED          = AMEDIA_DRM_ERROR_BASE - 3,
96     AMEDIA_DRM_SHORT_BUFFER            = AMEDIA_DRM_ERROR_BASE - 4,
97     AMEDIA_DRM_SESSION_NOT_OPENED      = AMEDIA_DRM_ERROR_BASE - 5,
98     AMEDIA_DRM_TAMPER_DETECTED         = AMEDIA_DRM_ERROR_BASE - 6,
99     AMEDIA_DRM_VERIFY_FAILED           = AMEDIA_DRM_ERROR_BASE - 7,
100     AMEDIA_DRM_NEED_KEY                = AMEDIA_DRM_ERROR_BASE - 8,
101     AMEDIA_DRM_LICENSE_EXPIRED         = AMEDIA_DRM_ERROR_BASE - 9,
102 
103     AMEDIA_IMGREADER_ERROR_BASE          = -30000,
104 
105     /** There are no more image buffers to read/write image data. */
106     AMEDIA_IMGREADER_NO_BUFFER_AVAILABLE = AMEDIA_IMGREADER_ERROR_BASE - 1,
107 
108     /** The AImage object has used up the allowed maximum image buffers. */
109     AMEDIA_IMGREADER_MAX_IMAGES_ACQUIRED = AMEDIA_IMGREADER_ERROR_BASE - 2,
110 
111     /** The required image buffer could not be locked to read. */
112     AMEDIA_IMGREADER_CANNOT_LOCK_IMAGE   = AMEDIA_IMGREADER_ERROR_BASE - 3,
113 
114     /** The media data or buffer could not be unlocked. */
115     AMEDIA_IMGREADER_CANNOT_UNLOCK_IMAGE = AMEDIA_IMGREADER_ERROR_BASE - 4,
116 
117     /** The media/buffer needs to be locked to perform the required operation. */
118     AMEDIA_IMGREADER_IMAGE_NOT_LOCKED    = AMEDIA_IMGREADER_ERROR_BASE - 5,
119 
120 } media_status_t;
121 
122 __END_DECLS
123 
124 #endif // _NDK_MEDIA_ERROR_H
125 
126 /** @} */
127