Line	Branch	Exec	Source
1			/*
2			* This file is part of FFmpeg.
3			*
4			* FFmpeg is free software; you can redistribute it and/or
5			* modify it under the terms of the GNU Lesser General Public
6			* License as published by the Free Software Foundation; either
7			* version 2.1 of the License, or (at your option) any later version.
8			*
9			* FFmpeg is distributed in the hope that it will be useful,
10			* but WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12			* Lesser General Public License for more details.
13			*
14			* You should have received a copy of the GNU Lesser General Public
15			* License along with FFmpeg; if not, write to the Free Software
16			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17			*/
18
19			/**
20			* @file
21			* error code definitions
22			*/
23
24			#ifndef AVUTIL_ERROR_H
25			#define AVUTIL_ERROR_H
26
27			#include <errno.h>
28			#include <stddef.h>
29
30			#include "macros.h"
31
32			/**
33			* @addtogroup lavu_error
34			*
35			* @{
36			*/
37
38
39			/* error handling */
40			#if EDOM > 0
41			#define AVERROR(e) (-(e)) ///< Returns a negative error code from a POSIX error code, to return from library functions.
42			#define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value.
43			#else
44			/* Some platforms have E* and errno already negated. */
45			#define AVERROR(e) (e)
46			#define AVUNERROR(e) (e)
47			#endif
48
49			#define FFERRTAG(a, b, c, d) (-(int)MKTAG(a, b, c, d))
50
51			#define AVERROR_BSF_NOT_FOUND FFERRTAG(0xF8,'B','S','F') ///< Bitstream filter not found
52			#define AVERROR_BUG FFERRTAG( 'B','U','G','!') ///< Internal bug, also see AVERROR_BUG2
53			#define AVERROR_BUFFER_TOO_SMALL FFERRTAG( 'B','U','F','S') ///< Buffer too small
54			#define AVERROR_DECODER_NOT_FOUND FFERRTAG(0xF8,'D','E','C') ///< Decoder not found
55			#define AVERROR_DEMUXER_NOT_FOUND FFERRTAG(0xF8,'D','E','M') ///< Demuxer not found
56			#define AVERROR_ENCODER_NOT_FOUND FFERRTAG(0xF8,'E','N','C') ///< Encoder not found
57			#define AVERROR_EOF FFERRTAG( 'E','O','F',' ') ///< End of file
58			#define AVERROR_EXIT FFERRTAG( 'E','X','I','T') ///< Immediate exit was requested; the called function should not be restarted
59			#define AVERROR_EXTERNAL FFERRTAG( 'E','X','T',' ') ///< Generic error in an external library
60			#define AVERROR_FILTER_NOT_FOUND FFERRTAG(0xF8,'F','I','L') ///< Filter not found
61			#define AVERROR_INVALIDDATA FFERRTAG( 'I','N','D','A') ///< Invalid data found when processing input
62			#define AVERROR_MUXER_NOT_FOUND FFERRTAG(0xF8,'M','U','X') ///< Muxer not found
63			#define AVERROR_OPTION_NOT_FOUND FFERRTAG(0xF8,'O','P','T') ///< Option not found
64			#define AVERROR_PATCHWELCOME FFERRTAG( 'P','A','W','E') ///< Not yet implemented in FFmpeg, patches welcome
65			#define AVERROR_PROTOCOL_NOT_FOUND FFERRTAG(0xF8,'P','R','O') ///< Protocol not found
66
67			#define AVERROR_STREAM_NOT_FOUND FFERRTAG(0xF8,'S','T','R') ///< Stream not found
68			/**
69			* This is semantically identical to AVERROR_BUG
70			* it has been introduced in Libav after our AVERROR_BUG and with a modified value.
71			*/
72			#define AVERROR_BUG2 FFERRTAG( 'B','U','G',' ')
73			#define AVERROR_UNKNOWN FFERRTAG( 'U','N','K','N') ///< Unknown error, typically from an external library
74			#define AVERROR_EXPERIMENTAL (-0x2bb2afa8) ///< Requested feature is flagged experimental. Set strict_std_compliance if you really want to use it.
75			#define AVERROR_INPUT_CHANGED (-0x636e6701) ///< Input changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_OUTPUT_CHANGED)
76			#define AVERROR_OUTPUT_CHANGED (-0x636e6702) ///< Output changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_INPUT_CHANGED)
77			/* HTTP & RTSP errors */
78			#define AVERROR_HTTP_BAD_REQUEST FFERRTAG(0xF8,'4','0','0')
79			#define AVERROR_HTTP_UNAUTHORIZED FFERRTAG(0xF8,'4','0','1')
80			#define AVERROR_HTTP_FORBIDDEN FFERRTAG(0xF8,'4','0','3')
81			#define AVERROR_HTTP_NOT_FOUND FFERRTAG(0xF8,'4','0','4')
82			#define AVERROR_HTTP_TOO_MANY_REQUESTS FFERRTAG(0xF8,'4','2','9')
83			#define AVERROR_HTTP_OTHER_4XX FFERRTAG(0xF8,'4','X','X')
84			#define AVERROR_HTTP_SERVER_ERROR FFERRTAG(0xF8,'5','X','X')
85
86			#define AV_ERROR_MAX_STRING_SIZE 64
87
88			/**
89			* Put a description of the AVERROR code errnum in errbuf.
90			* In case of failure the global variable errno is set to indicate the
91			* error. Even in case of failure av_strerror() will print a generic
92			* error message indicating the errnum provided to errbuf.
93			*
94			* @param errnum error code to describe
95			* @param errbuf buffer to which description is written
96			* @param errbuf_size the size in bytes of errbuf
97			* @return 0 on success, a negative value if a description for errnum
98			* cannot be found
99			*/
100			int av_strerror(int errnum, char *errbuf, size_t errbuf_size);
101
102			/**
103			* Fill the provided buffer with a string containing an error string
104			* corresponding to the AVERROR code errnum.
105			*
106			* @param errbuf a buffer
107			* @param errbuf_size size in bytes of errbuf
108			* @param errnum error code to describe
109			* @return the buffer in input, filled with the error description
110			* @see av_strerror()
111			*/
112		610	static inline char *av_make_error_string(char *errbuf, size_t errbuf_size, int errnum)
113			{
114		610	av_strerror(errnum, errbuf, errbuf_size);
115		610	return errbuf;
116			}
117
118			/**
119			* Convenience macro, the return value should be used only directly in
120			* function arguments but never stand-alone.
121			*/
122			#define av_err2str(errnum) \
123			av_make_error_string((char[AV_ERROR_MAX_STRING_SIZE]){0}, AV_ERROR_MAX_STRING_SIZE, errnum)
124
125			/**
126			* @}
127			*/
128
129			#endif /* AVUTIL_ERROR_H */
130