xref: /aosp_15_r20/external/libgav1/src/gav1/status_code.h (revision 095378508e87ed692bf8dfeb34008b65b3735891)
1*09537850SAkhilesh Sanikop /*
2*09537850SAkhilesh Sanikop  * Copyright 2019 The libgav1 Authors
3*09537850SAkhilesh Sanikop  *
4*09537850SAkhilesh Sanikop  * Licensed under the Apache License, Version 2.0 (the "License");
5*09537850SAkhilesh Sanikop  * you may not use this file except in compliance with the License.
6*09537850SAkhilesh Sanikop  * You may obtain a copy of the License at
7*09537850SAkhilesh Sanikop  *
8*09537850SAkhilesh Sanikop  *      http://www.apache.org/licenses/LICENSE-2.0
9*09537850SAkhilesh Sanikop  *
10*09537850SAkhilesh Sanikop  * Unless required by applicable law or agreed to in writing, software
11*09537850SAkhilesh Sanikop  * distributed under the License is distributed on an "AS IS" BASIS,
12*09537850SAkhilesh Sanikop  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*09537850SAkhilesh Sanikop  * See the License for the specific language governing permissions and
14*09537850SAkhilesh Sanikop  * limitations under the License.
15*09537850SAkhilesh Sanikop  */
16*09537850SAkhilesh Sanikop 
17*09537850SAkhilesh Sanikop #ifndef LIBGAV1_SRC_GAV1_STATUS_CODE_H_
18*09537850SAkhilesh Sanikop #define LIBGAV1_SRC_GAV1_STATUS_CODE_H_
19*09537850SAkhilesh Sanikop 
20*09537850SAkhilesh Sanikop #include "gav1/symbol_visibility.h"
21*09537850SAkhilesh Sanikop 
22*09537850SAkhilesh Sanikop // All the declarations in this file are part of the public ABI. This file may
23*09537850SAkhilesh Sanikop // be included by both C and C++ files.
24*09537850SAkhilesh Sanikop 
25*09537850SAkhilesh Sanikop // The Libgav1StatusCode enum type: A libgav1 function may return
26*09537850SAkhilesh Sanikop // Libgav1StatusCode to indicate success or the reason for failure.
27*09537850SAkhilesh Sanikop typedef enum {
28*09537850SAkhilesh Sanikop   // Success.
29*09537850SAkhilesh Sanikop   kLibgav1StatusOk = 0,
30*09537850SAkhilesh Sanikop 
31*09537850SAkhilesh Sanikop   // An unknown error. Used as the default error status if error detail is not
32*09537850SAkhilesh Sanikop   // available.
33*09537850SAkhilesh Sanikop   kLibgav1StatusUnknownError = -1,
34*09537850SAkhilesh Sanikop 
35*09537850SAkhilesh Sanikop   // An invalid function argument.
36*09537850SAkhilesh Sanikop   kLibgav1StatusInvalidArgument = -2,
37*09537850SAkhilesh Sanikop 
38*09537850SAkhilesh Sanikop   // Memory allocation failure.
39*09537850SAkhilesh Sanikop   kLibgav1StatusOutOfMemory = -3,
40*09537850SAkhilesh Sanikop 
41*09537850SAkhilesh Sanikop   // Ran out of a resource (other than memory).
42*09537850SAkhilesh Sanikop   kLibgav1StatusResourceExhausted = -4,
43*09537850SAkhilesh Sanikop 
44*09537850SAkhilesh Sanikop   // The object is not initialized.
45*09537850SAkhilesh Sanikop   kLibgav1StatusNotInitialized = -5,
46*09537850SAkhilesh Sanikop 
47*09537850SAkhilesh Sanikop   // An operation that can only be performed once has already been performed.
48*09537850SAkhilesh Sanikop   kLibgav1StatusAlready = -6,
49*09537850SAkhilesh Sanikop 
50*09537850SAkhilesh Sanikop   // Not implemented, or not supported.
51*09537850SAkhilesh Sanikop   kLibgav1StatusUnimplemented = -7,
52*09537850SAkhilesh Sanikop 
53*09537850SAkhilesh Sanikop   // An internal error in libgav1. Usually this indicates a programming error.
54*09537850SAkhilesh Sanikop   kLibgav1StatusInternalError = -8,
55*09537850SAkhilesh Sanikop 
56*09537850SAkhilesh Sanikop   // The bitstream is not encoded correctly or violates a bitstream conformance
57*09537850SAkhilesh Sanikop   // requirement.
58*09537850SAkhilesh Sanikop   kLibgav1StatusBitstreamError = -9,
59*09537850SAkhilesh Sanikop 
60*09537850SAkhilesh Sanikop   // The operation is not allowed at the moment. This is not a fatal error. Try
61*09537850SAkhilesh Sanikop   // again later.
62*09537850SAkhilesh Sanikop   kLibgav1StatusTryAgain = -10,
63*09537850SAkhilesh Sanikop 
64*09537850SAkhilesh Sanikop   // Used only by DequeueFrame(). There are no enqueued frames, so there is
65*09537850SAkhilesh Sanikop   // nothing to dequeue. This is not a fatal error. Try enqueuing a frame before
66*09537850SAkhilesh Sanikop   // trying to dequeue again.
67*09537850SAkhilesh Sanikop   kLibgav1StatusNothingToDequeue = -11,
68*09537850SAkhilesh Sanikop 
69*09537850SAkhilesh Sanikop   // An extra enumerator to prevent people from writing code that fails to
70*09537850SAkhilesh Sanikop   // compile when a new status code is added.
71*09537850SAkhilesh Sanikop   //
72*09537850SAkhilesh Sanikop   // Do not reference this enumerator. In particular, if you write code that
73*09537850SAkhilesh Sanikop   // switches on Libgav1StatusCode, add a default: case instead of a case that
74*09537850SAkhilesh Sanikop   // mentions this enumerator.
75*09537850SAkhilesh Sanikop   //
76*09537850SAkhilesh Sanikop   // Do not depend on the value (currently -1000) listed here. It may change in
77*09537850SAkhilesh Sanikop   // the future.
78*09537850SAkhilesh Sanikop   kLibgav1StatusReservedForFutureExpansionUseDefaultInSwitchInstead_ = -1000
79*09537850SAkhilesh Sanikop } Libgav1StatusCode;
80*09537850SAkhilesh Sanikop 
81*09537850SAkhilesh Sanikop #if defined(__cplusplus)
82*09537850SAkhilesh Sanikop extern "C" {
83*09537850SAkhilesh Sanikop #endif
84*09537850SAkhilesh Sanikop 
85*09537850SAkhilesh Sanikop // Returns a human readable error string in en-US for the status code |status|.
86*09537850SAkhilesh Sanikop // Always returns a valid (non-NULL) string.
87*09537850SAkhilesh Sanikop LIBGAV1_PUBLIC const char* Libgav1GetErrorString(Libgav1StatusCode status);
88*09537850SAkhilesh Sanikop 
89*09537850SAkhilesh Sanikop #if defined(__cplusplus)
90*09537850SAkhilesh Sanikop }  // extern "C"
91*09537850SAkhilesh Sanikop 
92*09537850SAkhilesh Sanikop namespace libgav1 {
93*09537850SAkhilesh Sanikop 
94*09537850SAkhilesh Sanikop // Declare type aliases for C++.
95*09537850SAkhilesh Sanikop using StatusCode = Libgav1StatusCode;
96*09537850SAkhilesh Sanikop constexpr StatusCode kStatusOk = kLibgav1StatusOk;
97*09537850SAkhilesh Sanikop constexpr StatusCode kStatusUnknownError = kLibgav1StatusUnknownError;
98*09537850SAkhilesh Sanikop constexpr StatusCode kStatusInvalidArgument = kLibgav1StatusInvalidArgument;
99*09537850SAkhilesh Sanikop constexpr StatusCode kStatusOutOfMemory = kLibgav1StatusOutOfMemory;
100*09537850SAkhilesh Sanikop constexpr StatusCode kStatusResourceExhausted = kLibgav1StatusResourceExhausted;
101*09537850SAkhilesh Sanikop constexpr StatusCode kStatusNotInitialized = kLibgav1StatusNotInitialized;
102*09537850SAkhilesh Sanikop constexpr StatusCode kStatusAlready = kLibgav1StatusAlready;
103*09537850SAkhilesh Sanikop constexpr StatusCode kStatusUnimplemented = kLibgav1StatusUnimplemented;
104*09537850SAkhilesh Sanikop constexpr StatusCode kStatusInternalError = kLibgav1StatusInternalError;
105*09537850SAkhilesh Sanikop constexpr StatusCode kStatusBitstreamError = kLibgav1StatusBitstreamError;
106*09537850SAkhilesh Sanikop constexpr StatusCode kStatusTryAgain = kLibgav1StatusTryAgain;
107*09537850SAkhilesh Sanikop constexpr StatusCode kStatusNothingToDequeue = kLibgav1StatusNothingToDequeue;
108*09537850SAkhilesh Sanikop 
109*09537850SAkhilesh Sanikop // Returns a human readable error string in en-US for the status code |status|.
110*09537850SAkhilesh Sanikop // Always returns a valid (non-NULL) string.
GetErrorString(StatusCode status)111*09537850SAkhilesh Sanikop inline const char* GetErrorString(StatusCode status) {
112*09537850SAkhilesh Sanikop   return Libgav1GetErrorString(status);
113*09537850SAkhilesh Sanikop }
114*09537850SAkhilesh Sanikop 
115*09537850SAkhilesh Sanikop }  // namespace libgav1
116*09537850SAkhilesh Sanikop #endif  // defined(__cplusplus)
117*09537850SAkhilesh Sanikop 
118*09537850SAkhilesh Sanikop #endif  // LIBGAV1_SRC_GAV1_STATUS_CODE_H_
119