eval: clear Parser instances before using
[ffmpeg.git] / libavutil / error.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; 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 "avutil.h"
29
30 /* error handling */
31 #if EDOM > 0
32 #define AVERROR(e) (-(e))   ///< Returns a negative error code from a POSIX error code, to return from library functions.
33 #define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value.
34 #else
35 /* Some platforms have E* and errno already negated. */
36 #define AVERROR(e) (e)
37 #define AVUNERROR(e) (e)
38 #endif
39
40 #define AVERROR_BSF_NOT_FOUND      (-MKTAG(0xF8,'B','S','F')) ///< Bitstream filter not found
41 #define AVERROR_DECODER_NOT_FOUND  (-MKTAG(0xF8,'D','E','C')) ///< Decoder not found
42 #define AVERROR_DEMUXER_NOT_FOUND  (-MKTAG(0xF8,'D','E','M')) ///< Demuxer not found
43 #define AVERROR_ENCODER_NOT_FOUND  (-MKTAG(0xF8,'E','N','C')) ///< Encoder not found
44 #define AVERROR_EOF                (-MKTAG( 'E','O','F',' ')) ///< End of file
45 #define AVERROR_EXIT               (-MKTAG( 'E','X','I','T')) ///< Immediate exit was requested; the called function should not be restarted
46 #define AVERROR_FILTER_NOT_FOUND   (-MKTAG(0xF8,'F','I','L')) ///< Filter not found
47 #define AVERROR_INVALIDDATA        (-MKTAG( 'I','N','D','A')) ///< Invalid data found when processing input
48 #define AVERROR_MUXER_NOT_FOUND    (-MKTAG(0xF8,'M','U','X')) ///< Muxer not found
49 #define AVERROR_OPTION_NOT_FOUND   (-MKTAG(0xF8,'O','P','T')) ///< Option not found
50 #define AVERROR_PATCHWELCOME       (-MKTAG( 'P','A','W','E')) ///< Not yet implemented in Libav, patches welcome
51 #define AVERROR_PROTOCOL_NOT_FOUND (-MKTAG(0xF8,'P','R','O')) ///< Protocol not found
52 #define AVERROR_STREAM_NOT_FOUND   (-MKTAG(0xF8,'S','T','R')) ///< Stream not found
53
54 /**
55  * Put a description of the AVERROR code errnum in errbuf.
56  * In case of failure the global variable errno is set to indicate the
57  * error. Even in case of failure av_strerror() will print a generic
58  * error message indicating the errnum provided to errbuf.
59  *
60  * @param errnum      error code to describe
61  * @param errbuf      buffer to which description is written
62  * @param errbuf_size the size in bytes of errbuf
63  * @return 0 on success, a negative value if a description for errnum
64  * cannot be found
65  */
66 int av_strerror(int errnum, char *errbuf, size_t errbuf_size);
67
68 #endif /* AVUTIL_ERROR_H */