error.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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. * @file
  20. * error code definitions
  21. */
  22. #ifndef AVUTIL_ERROR_H
  23. #define AVUTIL_ERROR_H
  24. #include <errno.h>
  25. #include <stddef.h>
  26. /**
  27. * @addtogroup lavu_error
  28. *
  29. * @{
  30. */
  31. /* error handling */
  32. #if EDOM > 0
  33. #define AVERROR(e) (-(e)) ///< Returns a negative error code from a POSIX error code, to return from library functions.
  34. #define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value.
  35. #else
  36. /* Some platforms have E* and errno already negated. */
  37. #define AVERROR(e) (e)
  38. #define AVUNERROR(e) (e)
  39. #endif
  40. #define FFERRTAG(a, b, c, d) (-(int)MKTAG(a, b, c, d))
  41. #define AVERROR_BSF_NOT_FOUND FFERRTAG(0xF8,'B','S','F') ///< Bitstream filter not found
  42. #define AVERROR_BUG FFERRTAG( 'B','U','G','!') ///< Internal bug, also see AVERROR_BUG2
  43. #define AVERROR_BUFFER_TOO_SMALL FFERRTAG( 'B','U','F','S') ///< Buffer too small
  44. #define AVERROR_DECODER_NOT_FOUND FFERRTAG(0xF8,'D','E','C') ///< Decoder not found
  45. #define AVERROR_DEMUXER_NOT_FOUND FFERRTAG(0xF8,'D','E','M') ///< Demuxer not found
  46. #define AVERROR_ENCODER_NOT_FOUND FFERRTAG(0xF8,'E','N','C') ///< Encoder not found
  47. #define AVERROR_EOF FFERRTAG( 'E','O','F',' ') ///< End of file
  48. #define AVERROR_EXIT FFERRTAG( 'E','X','I','T') ///< Immediate exit was requested; the called function should not be restarted
  49. #define AVERROR_EXTERNAL FFERRTAG( 'E','X','T',' ') ///< Generic error in an external library
  50. #define AVERROR_FILTER_NOT_FOUND FFERRTAG(0xF8,'F','I','L') ///< Filter not found
  51. #define AVERROR_INVALIDDATA FFERRTAG( 'I','N','D','A') ///< Invalid data found when processing input
  52. #define AVERROR_MUXER_NOT_FOUND FFERRTAG(0xF8,'M','U','X') ///< Muxer not found
  53. #define AVERROR_OPTION_NOT_FOUND FFERRTAG(0xF8,'O','P','T') ///< Option not found
  54. #define AVERROR_PATCHWELCOME FFERRTAG( 'P','A','W','E') ///< Not yet implemented in FFmpeg, patches welcome
  55. #define AVERROR_PROTOCOL_NOT_FOUND FFERRTAG(0xF8,'P','R','O') ///< Protocol not found
  56. #define AVERROR_STREAM_NOT_FOUND FFERRTAG(0xF8,'S','T','R') ///< Stream not found
  57. /**
  58. * This is semantically identical to AVERROR_BUG
  59. * it has been introduced in Libav after our AVERROR_BUG and with a modified value.
  60. */
  61. #define AVERROR_BUG2 FFERRTAG( 'B','U','G',' ')
  62. #define AVERROR_UNKNOWN FFERRTAG( 'U','N','K','N') ///< Unknown error, typically from an external library
  63. #define AV_ERROR_MAX_STRING_SIZE 64
  64. /**
  65. * Put a description of the AVERROR code errnum in errbuf.
  66. * In case of failure the global variable errno is set to indicate the
  67. * error. Even in case of failure av_strerror() will print a generic
  68. * error message indicating the errnum provided to errbuf.
  69. *
  70. * @param errnum error code to describe
  71. * @param errbuf buffer to which description is written
  72. * @param errbuf_size the size in bytes of errbuf
  73. * @return 0 on success, a negative value if a description for errnum
  74. * cannot be found
  75. */
  76. int av_strerror(int errnum, char *errbuf, size_t errbuf_size);
  77. /**
  78. * Fill the provided buffer with a string containing an error string
  79. * corresponding to the AVERROR code errnum.
  80. *
  81. * @param errbuf a buffer
  82. * @param errbuf_size size in bytes of errbuf
  83. * @param errnum error code to describe
  84. * @return the buffer in input, filled with the error description
  85. * @see av_strerror()
  86. */
  87. static inline char *av_make_error_string(char *errbuf, size_t errbuf_size, int errnum)
  88. {
  89. av_strerror(errnum, errbuf, errbuf_size);
  90. return errbuf;
  91. }
  92. /**
  93. * Convenience macro, the return value should be used only directly in
  94. * function arguments but never stand-alone.
  95. */
  96. #define av_err2str(errnum) \
  97. av_make_error_string((char[AV_ERROR_MAX_STRING_SIZE]){0}, AV_ERROR_MAX_STRING_SIZE, errnum)
  98. /**
  99. * @}
  100. */
  101. #endif /* AVUTIL_ERROR_H */