error.h 3.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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 "avutil.h"
  26. /* error handling */
  27. #if EDOM > 0
  28. #define AVERROR(e) (-(e)) ///< Returns a negative error code from a POSIX error code, to return from library functions.
  29. #define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value.
  30. #else
  31. /* Some platforms have E* and errno already negated. */
  32. #define AVERROR(e) (e)
  33. #define AVUNERROR(e) (e)
  34. #endif
  35. #if LIBAVUTIL_VERSION_MAJOR < 51
  36. #define AVERROR_INVALIDDATA AVERROR(EINVAL) ///< Invalid data found when processing input
  37. #define AVERROR_IO AVERROR(EIO) ///< I/O error
  38. #define AVERROR_NOENT AVERROR(ENOENT) ///< No such file or directory
  39. #define AVERROR_NOFMT AVERROR(EILSEQ) ///< Unknown format
  40. #define AVERROR_NOMEM AVERROR(ENOMEM) ///< Not enough memory
  41. #define AVERROR_NOTSUPP AVERROR(ENOSYS) ///< Operation not supported
  42. #define AVERROR_NUMEXPECTED AVERROR(EDOM) ///< Number syntax expected in filename
  43. #define AVERROR_UNKNOWN AVERROR(EINVAL) ///< Unknown error
  44. #endif
  45. #define AVERROR_EOF AVERROR(EPIPE) ///< End of file
  46. #define AVERROR_PATCHWELCOME (-MKTAG('P','A','W','E')) ///< Not yet implemented in Libav, patches welcome
  47. #if LIBAVUTIL_VERSION_MAJOR > 50
  48. #define AVERROR_INVALIDDATA (-MKTAG('I','N','D','A')) ///< Invalid data found when processing input
  49. #define AVERROR_NUMEXPECTED (-MKTAG('N','U','E','X')) ///< Number syntax expected in filename
  50. #endif
  51. #define AVERROR_DEMUXER_NOT_FOUND (-MKTAG(0xF8,'D','E','M')) ///< Demuxer not found
  52. #define AVERROR_MUXER_NOT_FOUND (-MKTAG(0xF8,'M','U','X')) ///< Muxer not found
  53. #define AVERROR_BSF_NOT_FOUND (-MKTAG(0xF8,'B','S','F')) ///< Bitstream filter not found
  54. #define AVERROR_DECODER_NOT_FOUND (-MKTAG(0xF8,'D','E','C')) ///< Decoder not found
  55. #define AVERROR_DEMUXER_NOT_FOUND (-MKTAG(0xF8,'D','E','M')) ///< Demuxer not found
  56. #define AVERROR_ENCODER_NOT_FOUND (-MKTAG(0xF8,'E','N','C')) ///< Encoder not found
  57. #define AVERROR_EXIT (-MKTAG( 'E','X','I','T')) ///< Immediate exit was requested; the called function should not be restarted
  58. #define AVERROR_FILTER_NOT_FOUND (-MKTAG(0xF8,'F','I','L')) ///< Filter not found
  59. #define AVERROR_MUXER_NOT_FOUND (-MKTAG(0xF8,'M','U','X')) ///< Muxer not found
  60. #define AVERROR_OPTION_NOT_FOUND (-MKTAG(0xF8,'O','P','T')) ///< Option not found
  61. #define AVERROR_PROTOCOL_NOT_FOUND (-MKTAG(0xF8,'P','R','O')) ///< Protocol not found
  62. #define AVERROR_STREAM_NOT_FOUND (-MKTAG(0xF8,'S','T','R')) ///< Stream not found
  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. #endif /* AVUTIL_ERROR_H */