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 import core.stdc.errno; 26 import core.stdc.stddef; 27 import ffmpeg.libavutil.common; 28 29 @nogc nothrow extern(C): 30 31 /** 32 * @addtogroup lavu_error 33 * 34 * @{ 35 */ 36 37 38 /* error handling */ 39 static if (EDOM > 0) { 40 template AVERROR(int e) { ///< Returns a negative error code from a POSIX error code, to return from library functions. 41 const int AVERROR = (-(e)); 42 } 43 template AVUNERROR(int e) { ///< Returns a POSIX error code from a library function error return value. 44 const int AVUNERROR = (-(e)); 45 } 46 } else { 47 /* Some platforms have E* and errno already negated. */ 48 template AVERROR(int e) { 49 const int AVERROR = e; 50 } 51 template AVUNERROR(int e) { 52 const int AVUNERROR = e; 53 } 54 } 55 56 template FFERRTAG(int a, int b, int c, int d) { 57 const int FFERRTAG = -(MKTAG!(a, b, c, d)); 58 } 59 60 enum AVERROR_BSF_NOT_FOUND = FFERRTAG!(0xF8,'B','S','F'); ///< Bitstream filter not found 61 enum AVERROR_BUG = FFERRTAG!( 'B','U','G','!'); ///< Internal bug, also see AVERROR_BUG2 62 enum AVERROR_BUFFER_TOO_SMALL = FFERRTAG!( 'B','U','F','S'); ///< Buffer too small 63 enum AVERROR_DECODER_NOT_FOUND= FFERRTAG!(0xF8,'D','E','C'); ///< Decoder not found 64 enum AVERROR_DEMUXER_NOT_FOUND= FFERRTAG!(0xF8,'D','E','M'); ///< Demuxer not found 65 enum AVERROR_ENCODER_NOT_FOUND= FFERRTAG!(0xF8,'E','N','C'); ///< Encoder not found 66 enum AVERROR_EOF = FFERRTAG!( 'E','O','F',' '); ///< End of file 67 enum AVERROR_EXIT = FFERRTAG!( 'E','X','I','T'); ///< Immediate exit was requested; the called function should not be restarted 68 enum AVERROR_EXTERNAL = FFERRTAG!( 'E','X','T',' '); ///< Generic error in an external library 69 enum AVERROR_FILTER_NOT_FOUND = FFERRTAG!(0xF8,'F','I','L'); ///< Filter not found 70 enum AVERROR_INVALIDDATA = FFERRTAG!( 'I','N','D','A'); ///< Invalid data found when processing input 71 enum AVERROR_MUXER_NOT_FOUND = FFERRTAG!(0xF8,'M','U','X'); ///< Muxer not found 72 enum AVERROR_OPTION_NOT_FOUND = FFERRTAG!(0xF8,'O','P','T'); ///< Option not found 73 enum AVERROR_PATCHWELCOME = FFERRTAG!( 'P','A','W','E'); ///< Not yet implemented in FFmpeg, patches welcome 74 enum AVERROR_PROTOCOL_NOT_FOUND=FFERRTAG!(0xF8,'P','R','O'); ///< Protocol not found 75 76 enum AVERROR_STREAM_NOT_FOUND = FFERRTAG!(0xF8,'S','T','R'); ///< Stream not found 77 /** 78 * This is semantically identical to AVERROR_BUG 79 * it has been introduced in Libav after our AVERROR_BUG and with a modified value. 80 */ 81 enum AVERROR_BUG2 = FFERRTAG!( 'B','U','G',' '); 82 enum AVERROR_UNKNOWN = FFERRTAG!( 'U','N','K','N'); ///< Unknown error, typically from an external library 83 enum AVERROR_EXPERIMENTAL = (-0x2bb2afa8); ///< Requested feature is flagged experimental. Set strict_std_compliance if you really want to use it. 84 enum AVERROR_INPUT_CHANGED = (-0x636e6701); ///< Input changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_OUTPUT_CHANGED) 85 enum AVERROR_OUTPUT_CHANGED = (-0x636e6702); ///< Output changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_INPUT_CHANGED) 86 /* HTTP & RTSP errors */ 87 enum AVERROR_HTTP_BAD_REQUEST = FFERRTAG!( 0xF8,'4','0','0'); 88 enum AVERROR_HTTP_UNAUTHORIZED= FFERRTAG!( 0xF8,'4','0','1'); 89 enum AVERROR_HTTP_FORBIDDEN = FFERRTAG!( 0xF8,'4','0','3'); 90 enum AVERROR_HTTP_NOT_FOUND = FFERRTAG!( 0xF8,'4','0','4'); 91 enum AVERROR_HTTP_OTHER_4XX = FFERRTAG!( 0xF8,'4','X','X'); 92 enum AVERROR_HTTP_SERVER_ERROR= FFERRTAG!( 0xF8,'5','X','X'); 93 94 enum AV_ERROR_MAX_STRING_SIZE = 64; 95 96 /** 97 * Put a description of the AVERROR code errnum in errbuf. 98 * In case of failure the global variable errno is set to indicate the 99 * error. Even in case of failure av_strerror() will print a generic 100 * error message indicating the errnum provided to errbuf. 101 * 102 * @param errnum error code to describe 103 * @param errbuf buffer to which description is written 104 * @param errbuf_size the size in bytes of errbuf 105 * @return 0 on success, a negative value if a description for errnum 106 * cannot be found 107 */ 108 int av_strerror(int errnum, char *errbuf, size_t errbuf_size); 109 110 /** 111 * Fill the provided buffer with a string containing an error string 112 * corresponding to the AVERROR code errnum. 113 * 114 * @param errbuf a buffer 115 * @param errbuf_size size in bytes of errbuf 116 * @param errnum error code to describe 117 * @return the buffer in input, filled with the error description 118 * @see av_strerror() 119 */ 120 static char *av_make_error_string(char *errbuf, size_t errbuf_size, int errnum) 121 { 122 av_strerror(errnum, errbuf, errbuf_size); 123 return errbuf; 124 } 125 126 /** 127 * Convenience macro, the return value should be used only directly in 128 * function arguments but never stand-alone. 129 */ 130 template av_err2str(int errnum) { 131 auto buffer = new char[AV_ERROR_MAX_STRING_SIZE]; 132 const char* av_err2str = av_make_error_string(buffer, AV_ERROR_MAX_STRING_SIZE, errnum); 133 } 134 135 136 /** 137 * @} 138 */ 139 140 //#endif /* AVUTIL_ERROR_H */