error.h (3369B)
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 /** 31 * @addtogroup lavu_error 32 * 33 * @{ 34 */ 35 36 37 /* error handling */ 38 #if EDOM > 0 39 #define AVERROR(e) (-(e)) ///< Returns a negative error code from a POSIX error code, to return from library functions. 40 #define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value. 41 #else 42 /* Some platforms have E* and errno already negated. */ 43 #define AVERROR(e) (e) 44 #define AVUNERROR(e) (e) 45 #endif 46 47 #define AVERROR_BSF_NOT_FOUND (-MKTAG(0xF8,'B','S','F')) ///< Bitstream filter not found 48 #define AVERROR_DECODER_NOT_FOUND (-MKTAG(0xF8,'D','E','C')) ///< Decoder not found 49 #define AVERROR_DEMUXER_NOT_FOUND (-MKTAG(0xF8,'D','E','M')) ///< Demuxer not found 50 #define AVERROR_ENCODER_NOT_FOUND (-MKTAG(0xF8,'E','N','C')) ///< Encoder not found 51 #define AVERROR_EOF (-MKTAG( 'E','O','F',' ')) ///< End of file 52 #define AVERROR_EXIT (-MKTAG( 'E','X','I','T')) ///< Immediate exit was requested; the called function should not be restarted 53 #define AVERROR_FILTER_NOT_FOUND (-MKTAG(0xF8,'F','I','L')) ///< Filter not found 54 #define AVERROR_INVALIDDATA (-MKTAG( 'I','N','D','A')) ///< Invalid data found when processing input 55 #define AVERROR_MUXER_NOT_FOUND (-MKTAG(0xF8,'M','U','X')) ///< Muxer not found 56 #define AVERROR_OPTION_NOT_FOUND (-MKTAG(0xF8,'O','P','T')) ///< Option not found 57 #define AVERROR_PATCHWELCOME (-MKTAG( 'P','A','W','E')) ///< Not yet implemented in Libav, patches welcome 58 #define AVERROR_PROTOCOL_NOT_FOUND (-MKTAG(0xF8,'P','R','O')) ///< Protocol not found 59 #define AVERROR_STREAM_NOT_FOUND (-MKTAG(0xF8,'S','T','R')) ///< Stream not found 60 #define AVERROR_BUG (-MKTAG( 'B','U','G',' ')) ///< Bug detected, please report the issue 61 #define AVERROR_UNKNOWN (-MKTAG( 'U','N','K','N')) ///< Unknown error, typically from an external library 62 63 /** 64 * Put a description of the AVERROR code errnum in errbuf. 65 * In case of failure the global variable errno is set to indicate the 66 * error. Even in case of failure av_strerror() will print a generic 67 * error message indicating the errnum provided to errbuf. 68 * 69 * @param errnum error code to describe 70 * @param errbuf buffer to which description is written 71 * @param errbuf_size the size in bytes of errbuf 72 * @return 0 on success, a negative value if a description for errnum 73 * cannot be found 74 */ 75 int av_strerror(int errnum, char *errbuf, size_t errbuf_size); 76 77 /** 78 * @} 79 */ 80 81 #endif /* AVUTIL_ERROR_H */