FFmpeg/libavutil/error.h

/*
 * This file is part of Libav.
 *
 * Libav is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * Libav is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Libav; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * @file
 * error code definitions
 */

#ifndef AVUTIL_ERROR_H
#define AVUTIL_ERROR_H

#include <errno.h>
#include <stddef.h>
#include "avutil.h"

/**
 * @addtogroup lavu_error
 *
 * @{
 */


/* error handling */
#if EDOM > 0
#define AVERROR(e) (-(e))   ///< Returns a negative error code from a POSIX error code, to return from library functions.
#define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value.
#else
/* Some platforms have E* and errno already negated. */
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif

#define AVERROR_BSF_NOT_FOUND      0xb9acbd08 ///< Bitstream filter not found
#define AVERROR_DECODER_NOT_FOUND  0xbcbabb08 ///< Decoder not found
#define AVERROR_DEMUXER_NOT_FOUND  0xb2babb08 ///< Demuxer not found
#define AVERROR_ENCODER_NOT_FOUND  0xbcb1ba08 ///< Encoder not found
#define AVERROR_EOF                0xdfb9b0bb ///< End of file
#define AVERROR_EXIT               0xabb6a7bb ///< Immediate exit was requested; the called function should not be restarted
#define AVERROR_FILTER_NOT_FOUND   0xb3b6b908 ///< Filter not found
#define AVERROR_INVALIDDATA        0xbebbb1b7 ///< Invalid data found when processing input
#define AVERROR_MUXER_NOT_FOUND    0xa7aab208 ///< Muxer not found
#define AVERROR_OPTION_NOT_FOUND   0xabafb008 ///< Option not found
#define AVERROR_PATCHWELCOME       0xbaa8beb0 ///< Not yet implemented in Libav, patches welcome
#define AVERROR_PROTOCOL_NOT_FOUND 0xb0adaf08 ///< Protocol not found
#define AVERROR_STREAM_NOT_FOUND   0xadabac08 ///< Stream not found
#define AVERROR_BUG                0xdfb8aabe ///< Bug detected, please report the issue
#define AVERROR_UNKNOWN            0xb1b4b1ab ///< Unknown error, typically from an external library

/**
 * Put a description of the AVERROR code errnum in errbuf.
 * In case of failure the global variable errno is set to indicate the
 * error. Even in case of failure av_strerror() will print a generic
 * error message indicating the errnum provided to errbuf.
 *
 * @param errnum      error code to describe
 * @param errbuf      buffer to which description is written
 * @param errbuf_size the size in bytes of errbuf
 * @return 0 on success, a negative value if a description for errnum
 * cannot be found
 */
int av_strerror(int errnum, char *errbuf, size_t errbuf_size);

/**
 * @}
 */

#endif /* AVUTIL_ERROR_H */