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 module ffmpeg.libavutil.error; 25 26 extern (C): 27 import ffmpeg; @nogc nothrow: 28 29 /** 30 * @addtogroup lavu_error 31 * 32 * @{ 33 */ 34 35 /* error handling */ 36 extern (D) auto AVERROR(T)(auto ref T e) 37 { 38 return -e; 39 } ///< Returns a negative error code from a POSIX error code, to return from library functions. 40 extern (D) auto AVUNERROR(T)(auto ref T e) 41 { 42 return -e; 43 } ///< Returns a POSIX error code from a library function error return value. 44 45 /* Some platforms have E* and errno already negated. */ 46 47 extern (D) auto FFERRTAG(T0, T1, T2, T3)(auto ref T0 a, auto ref T1 b, auto ref T2 c, auto ref T3 d) 48 { 49 return -cast(int) MKTAG(a, b, c, d); 50 } 51 52 enum AVERROR_BSF_NOT_FOUND = FFERRTAG(0xF8, 'B', 'S', 'F'); ///< Bitstream filter not found 53 enum AVERROR_BUG = FFERRTAG('B', 'U', 'G', '!'); ///< Internal bug, also see AVERROR_BUG2 54 enum AVERROR_BUFFER_TOO_SMALL = FFERRTAG('B', 'U', 'F', 'S'); ///< Buffer too small 55 enum AVERROR_DECODER_NOT_FOUND = FFERRTAG(0xF8, 'D', 'E', 'C'); ///< Decoder not found 56 enum AVERROR_DEMUXER_NOT_FOUND = FFERRTAG(0xF8, 'D', 'E', 'M'); ///< Demuxer not found 57 enum AVERROR_ENCODER_NOT_FOUND = FFERRTAG(0xF8, 'E', 'N', 'C'); ///< Encoder not found 58 enum AVERROR_EOF = FFERRTAG('E', 'O', 'F', ' '); ///< End of file 59 enum AVERROR_EXIT = FFERRTAG('E', 'X', 'I', 'T'); ///< Immediate exit was requested; the called function should not be restarted 60 enum AVERROR_EXTERNAL = FFERRTAG('E', 'X', 'T', ' '); ///< Generic error in an external library 61 enum AVERROR_FILTER_NOT_FOUND = FFERRTAG(0xF8, 'F', 'I', 'L'); ///< Filter not found 62 enum AVERROR_INVALIDDATA = FFERRTAG('I', 'N', 'D', 'A'); ///< Invalid data found when processing input 63 enum AVERROR_MUXER_NOT_FOUND = FFERRTAG(0xF8, 'M', 'U', 'X'); ///< Muxer not found 64 enum AVERROR_OPTION_NOT_FOUND = FFERRTAG(0xF8, 'O', 'P', 'T'); ///< Option not found 65 enum AVERROR_PATCHWELCOME = FFERRTAG('P', 'A', 'W', 'E'); ///< Not yet implemented in FFmpeg, patches welcome 66 enum AVERROR_PROTOCOL_NOT_FOUND = FFERRTAG(0xF8, 'P', 'R', 'O'); ///< Protocol not found 67 68 enum AVERROR_STREAM_NOT_FOUND = FFERRTAG(0xF8, 'S', 'T', 'R'); ///< Stream not found 69 /** 70 * This is semantically identical to AVERROR_BUG 71 * it has been introduced in Libav after our AVERROR_BUG and with a modified value. 72 */ 73 enum AVERROR_BUG2 = FFERRTAG('B', 'U', 'G', ' '); 74 enum AVERROR_UNKNOWN = FFERRTAG('U', 'N', 'K', 'N'); ///< Unknown error, typically from an external library 75 enum AVERROR_EXPERIMENTAL = -0x2bb2afa8; ///< Requested feature is flagged experimental. Set strict_std_compliance if you really want to use it. 76 enum AVERROR_INPUT_CHANGED = -0x636e6701; ///< Input changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_OUTPUT_CHANGED) 77 enum AVERROR_OUTPUT_CHANGED = -0x636e6702; ///< Output changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_INPUT_CHANGED) 78 /* HTTP & RTSP errors */ 79 enum AVERROR_HTTP_BAD_REQUEST = FFERRTAG(0xF8, '4', '0', '0'); 80 enum AVERROR_HTTP_UNAUTHORIZED = FFERRTAG(0xF8, '4', '0', '1'); 81 enum AVERROR_HTTP_FORBIDDEN = FFERRTAG(0xF8, '4', '0', '3'); 82 enum AVERROR_HTTP_NOT_FOUND = FFERRTAG(0xF8, '4', '0', '4'); 83 enum AVERROR_HTTP_OTHER_4XX = FFERRTAG(0xF8, '4', 'X', 'X'); 84 enum AVERROR_HTTP_SERVER_ERROR = FFERRTAG(0xF8, '5', 'X', 'X'); 85 86 enum 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 char* av_make_error_string (char* errbuf, size_t errbuf_size, int errnum); 113 114 /** 115 * Convenience macro, the return value should be used only directly in 116 * function arguments but never stand-alone. 117 */ 118 119 /** 120 * @} 121 */ 122 123 /* AVUTIL_ERROR_H */