error.h 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. #define AVERROR_BSF_NOT_FOUND (-MKTAG(0xF8,'B','S','F')) ///< Bitstream filter not found
  36. #define AVERROR_DECODER_NOT_FOUND (-MKTAG(0xF8,'D','E','C')) ///< Decoder not found
  37. #define AVERROR_DEMUXER_NOT_FOUND (-MKTAG(0xF8,'D','E','M')) ///< Demuxer not found
  38. #define AVERROR_ENCODER_NOT_FOUND (-MKTAG(0xF8,'E','N','C')) ///< Encoder not found
  39. #define AVERROR_EOF (-MKTAG( 'E','O','F',' ')) ///< End of file
  40. #define AVERROR_EXIT (-MKTAG( 'E','X','I','T')) ///< Immediate exit was requested; the called function should not be restarted
  41. #define AVERROR_FILTER_NOT_FOUND (-MKTAG(0xF8,'F','I','L')) ///< Filter not found
  42. #define AVERROR_INVALIDDATA (-MKTAG( 'I','N','D','A')) ///< Invalid data found when processing input
  43. #define AVERROR_MUXER_NOT_FOUND (-MKTAG(0xF8,'M','U','X')) ///< Muxer not found
  44. #define AVERROR_OPTION_NOT_FOUND (-MKTAG(0xF8,'O','P','T')) ///< Option not found
  45. #define AVERROR_PATCHWELCOME (-MKTAG( 'P','A','W','E')) ///< Not yet implemented in FFmpeg, patches welcome
  46. #define AVERROR_PROTOCOL_NOT_FOUND (-MKTAG(0xF8,'P','R','O')) ///< Protocol not found
  47. #define AVERROR_STREAM_NOT_FOUND (-MKTAG(0xF8,'S','T','R')) ///< Stream not found
  48. /**
  49. * Put a description of the AVERROR code errnum in errbuf.
  50. * In case of failure the global variable errno is set to indicate the
  51. * error. Even in case of failure av_strerror() will print a generic
  52. * error message indicating the errnum provided to errbuf.
  53. *
  54. * @param errnum error code to describe
  55. * @param errbuf buffer to which description is written
  56. * @param errbuf_size the size in bytes of errbuf
  57. * @return 0 on success, a negative value if a description for errnum
  58. * cannot be found
  59. */
  60. int av_strerror(int errnum, char *errbuf, size_t errbuf_size);
  61. #endif /* AVUTIL_ERROR_H */