summaryrefslogtreecommitdiffstats
path: root/dom/media/platforms/ffmpeg/ffmpeg60/include/libavutil/error.h
blob: 74af5b1534c48b9116862f8c59c9f674b92e1249 (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
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
/*
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * @file
 * error code definitions
 */

#ifndef AVUTIL_ERROR_H
#define AVUTIL_ERROR_H

#include <errno.h>
#include <stddef.h>

#include "macros.h"

/**
 * @addtogroup lavu_error
 *
 * @{
 */

/* error handling */
#if EDOM > 0
#  define AVERROR(e) \
    (-(e))  ///< Returns a negative error code from a POSIX error code, to
            ///< return from library functions.
#  define AVUNERROR(e) \
    (-(e))  ///< Returns a POSIX error code from a library function error return
            ///< value.
#else
/* Some platforms have E* and errno already negated. */
#  define AVERROR(e) (e)
#  define AVUNERROR(e) (e)
#endif

#define FFERRTAG(a, b, c, d) (-(int)MKTAG(a, b, c, d))

#define AVERROR_BSF_NOT_FOUND \
  FFERRTAG(0xF8, 'B', 'S', 'F')  ///< Bitstream filter not found
#define AVERROR_BUG \
  FFERRTAG('B', 'U', 'G', '!')  ///< Internal bug, also see AVERROR_BUG2
#define AVERROR_BUFFER_TOO_SMALL \
  FFERRTAG('B', 'U', 'F', 'S')  ///< Buffer too small
#define AVERROR_DECODER_NOT_FOUND \
  FFERRTAG(0xF8, 'D', 'E', 'C')  ///< Decoder not found
#define AVERROR_DEMUXER_NOT_FOUND \
  FFERRTAG(0xF8, 'D', 'E', 'M')  ///< Demuxer not found
#define AVERROR_ENCODER_NOT_FOUND \
  FFERRTAG(0xF8, 'E', 'N', 'C')                   ///< Encoder not found
#define AVERROR_EOF FFERRTAG('E', 'O', 'F', ' ')  ///< End of file
#define AVERROR_EXIT \
  FFERRTAG('E', 'X', 'I', 'T')  ///< Immediate exit was requested; the called
                                ///< function should not be restarted
#define AVERROR_EXTERNAL \
  FFERRTAG('E', 'X', 'T', ' ')  ///< Generic error in an external library
#define AVERROR_FILTER_NOT_FOUND \
  FFERRTAG(0xF8, 'F', 'I', 'L')  ///< Filter not found
#define AVERROR_INVALIDDATA \
  FFERRTAG('I', 'N', 'D', 'A')  ///< Invalid data found when processing input
#define AVERROR_MUXER_NOT_FOUND \
  FFERRTAG(0xF8, 'M', 'U', 'X')  ///< Muxer not found
#define AVERROR_OPTION_NOT_FOUND \
  FFERRTAG(0xF8, 'O', 'P', 'T')  ///< Option not found
#define AVERROR_PATCHWELCOME \
  FFERRTAG('P', 'A', 'W',    \
           'E')  ///< Not yet implemented in FFmpeg, patches welcome
#define AVERROR_PROTOCOL_NOT_FOUND \
  FFERRTAG(0xF8, 'P', 'R', 'O')  ///< Protocol not found

#define AVERROR_STREAM_NOT_FOUND \
  FFERRTAG(0xF8, 'S', 'T', 'R')  ///< Stream not found
/**
 * This is semantically identical to AVERROR_BUG
 * it has been introduced in Libav after our AVERROR_BUG and with a modified
 * value.
 */
#define AVERROR_BUG2 FFERRTAG('B', 'U', 'G', ' ')
#define AVERROR_UNKNOWN   \
  FFERRTAG('U', 'N', 'K', \
           'N')  ///< Unknown error, typically from an external library
#define AVERROR_EXPERIMENTAL \
  (-0x2bb2afa8)  ///< Requested feature is flagged experimental. Set
                 ///< strict_std_compliance if you really want to use it.
#define AVERROR_INPUT_CHANGED \
  (-0x636e6701)  ///< Input changed between calls. Reconfiguration is required.
                 ///< (can be OR-ed with AVERROR_OUTPUT_CHANGED)
#define AVERROR_OUTPUT_CHANGED \
  (-0x636e6702)  ///< Output changed between calls. Reconfiguration is required.
                 ///< (can be OR-ed with AVERROR_INPUT_CHANGED)
/* HTTP & RTSP errors */
#define AVERROR_HTTP_BAD_REQUEST FFERRTAG(0xF8, '4', '0', '0')
#define AVERROR_HTTP_UNAUTHORIZED FFERRTAG(0xF8, '4', '0', '1')
#define AVERROR_HTTP_FORBIDDEN FFERRTAG(0xF8, '4', '0', '3')
#define AVERROR_HTTP_NOT_FOUND FFERRTAG(0xF8, '4', '0', '4')
#define AVERROR_HTTP_OTHER_4XX FFERRTAG(0xF8, '4', 'X', 'X')
#define AVERROR_HTTP_SERVER_ERROR FFERRTAG(0xF8, '5', 'X', 'X')

#define AV_ERROR_MAX_STRING_SIZE 64

/**
 * Put a description of the AVERROR code errnum in errbuf.
 * In case of failure the global variable errno is set to indicate the
 * error. Even in case of failure av_strerror() will print a generic
 * error message indicating the errnum provided to errbuf.
 *
 * @param errnum      error code to describe
 * @param errbuf      buffer to which description is written
 * @param errbuf_size the size in bytes of errbuf
 * @return 0 on success, a negative value if a description for errnum
 * cannot be found
 */
int av_strerror(int errnum, char* errbuf, size_t errbuf_size);

/**
 * Fill the provided buffer with a string containing an error string
 * corresponding to the AVERROR code errnum.
 *
 * @param errbuf         a buffer
 * @param errbuf_size    size in bytes of errbuf
 * @param errnum         error code to describe
 * @return the buffer in input, filled with the error description
 * @see av_strerror()
 */
static inline char* av_make_error_string(char* errbuf, size_t errbuf_size,
                                         int errnum) {
  av_strerror(errnum, errbuf, errbuf_size);
  return errbuf;
}

/**
 * Convenience macro, the return value should be used only directly in
 * function arguments but never stand-alone.
 */
#define av_err2str(errnum)                                  \
  av_make_error_string((char[AV_ERROR_MAX_STRING_SIZE]){0}, \
                       AV_ERROR_MAX_STRING_SIZE, errnum)

/**
 * @}
 */

#endif /* AVUTIL_ERROR_H */