Mercurial > libavutil.hg
annotate error.h @ 961:64a8e85b50be libavutil
Improve GET_UTF{8,16} documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:48 +0000 |
parents | e34e8d654ded |
children | 399b530e8fb2 |
rev | line source |
---|---|
877
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
1 /* |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
2 * This file is part of FFmpeg. |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
3 * |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
4 * FFmpeg is free software; you can redistribute it and/or |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
5 * modify it under the terms of the GNU Lesser General Public |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
6 * License as published by the Free Software Foundation; either |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
7 * version 2.1 of the License, or (at your option) any later version. |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
8 * |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
9 * FFmpeg is distributed in the hope that it will be useful, |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
12 * Lesser General Public License for more details. |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
13 * |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
14 * You should have received a copy of the GNU Lesser General Public |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
15 * License along with FFmpeg; if not, write to the Free Software |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
17 */ |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
18 |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
19 /** |
899
0795a743bda1
Remove explicit filename from Doxygen @file commands.
diego
parents:
892
diff
changeset
|
20 * @file |
877
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
21 * error code definitions |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
22 */ |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
23 |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
24 #ifndef AVUTIL_ERROR_H |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
25 #define AVUTIL_ERROR_H |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
26 |
885 | 27 #include <errno.h> |
28 #include "avutil.h" | |
29 | |
877
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
30 /* error handling */ |
886 | 31 #if EDOM > 0 |
891
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
32 #define AVERROR(e) (-(e)) ///< Returns a negative error code from a POSIX error code, to return from library functions. |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
33 #define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value. |
877
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
34 #else |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
35 /* Some platforms have E* and errno already negated. */ |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
36 #define AVERROR(e) (e) |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
37 #define AVUNERROR(e) (e) |
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
38 #endif |
879
042e0e6f0735
Make iff.c:decode_init return the value returned by
stefano
parents:
878
diff
changeset
|
39 |
042e0e6f0735
Make iff.c:decode_init return the value returned by
stefano
parents:
878
diff
changeset
|
40 #if LIBAVUTIL_VERSION_MAJOR < 51 |
891
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
41 #define AVERROR_INVALIDDATA AVERROR(EINVAL) ///< Invalid data found when processing input |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
42 #define AVERROR_IO AVERROR(EIO) ///< I/O error |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
43 #define AVERROR_NOENT AVERROR(ENOENT) ///< No such file or directory |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
44 #define AVERROR_NOFMT AVERROR(EILSEQ) ///< Unknown format |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
45 #define AVERROR_NOMEM AVERROR(ENOMEM) ///< Not enough memory |
911
71ebc8b18666
Drop AVERROR_NOTSUPP at the next major bump, use AVERROR(ENOSYS)
stefano
parents:
899
diff
changeset
|
46 #define AVERROR_NOTSUPP AVERROR(ENOSYS) ///< Operation not supported |
891
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
47 #define AVERROR_NUMEXPECTED AVERROR(EDOM) ///< Number syntax expected in filename |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
48 #define AVERROR_UNKNOWN AVERROR(EINVAL) ///< Unknown error |
879
042e0e6f0735
Make iff.c:decode_init return the value returned by
stefano
parents:
878
diff
changeset
|
49 #endif |
042e0e6f0735
Make iff.c:decode_init return the value returned by
stefano
parents:
878
diff
changeset
|
50 |
891
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
51 #define AVERROR_EOF AVERROR(EPIPE) ///< End of file |
882 | 52 |
891
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
53 #define AVERROR_PATCHWELCOME (-MKTAG('P','A','W','E')) ///< Not yet implemented in FFmpeg, patches welcome |
877
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
54 |
884
bac1abbd0702
Change the definition of AVERROR_NUMEXPECTED at the next libavutil
stefano
parents:
883
diff
changeset
|
55 #if LIBAVUTIL_VERSION_MAJOR > 50 |
891
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
56 #define AVERROR_INVALIDDATA (-MKTAG('I','N','D','A')) ///< Invalid data found when processing input |
5ab17eb3a54c
Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
stefano
parents:
890
diff
changeset
|
57 #define AVERROR_NUMEXPECTED (-MKTAG('N','U','E','X')) ///< Number syntax expected in filename |
884
bac1abbd0702
Change the definition of AVERROR_NUMEXPECTED at the next libavutil
stefano
parents:
883
diff
changeset
|
58 #endif |
bac1abbd0702
Change the definition of AVERROR_NUMEXPECTED at the next libavutil
stefano
parents:
883
diff
changeset
|
59 |
892 | 60 /** |
957 | 61 * Put a description of the AVERROR code errnum in errbuf. |
892 | 62 * In case of failure the global variable errno is set to indicate the |
915
a1a27468a9c5
Make av_strerror() print an error message mentioning the error code
stefano
parents:
911
diff
changeset
|
63 * error. Even in case of failure av_strerror() will print a generic |
a1a27468a9c5
Make av_strerror() print an error message mentioning the error code
stefano
parents:
911
diff
changeset
|
64 * error message indicating the errnum provided to errbuf. |
892 | 65 * |
66 * @param errbuf_size the size in bytes of errbuf | |
916
2860cc0b5562
Make av_strerror() return -1 even in the case when av_strerror_r() is
stefano
parents:
915
diff
changeset
|
67 * @return 0 on success, a negative value if a description for errnum |
2860cc0b5562
Make av_strerror() return -1 even in the case when av_strerror_r() is
stefano
parents:
915
diff
changeset
|
68 * cannot be found |
892 | 69 */ |
70 int av_strerror(int errnum, char *errbuf, size_t errbuf_size); | |
71 | |
877
51fd7ea406a1
Move error code definitions from libavcodec/avcodec.h to
stefano
parents:
diff
changeset
|
72 #endif /* AVUTIL_ERROR_H */ |