diff options
| author | Reimar Döffinger <Reimar.Doeffinger@gmx.de> | 2009-02-02 20:42:06 +0000 |
|---|---|---|
| committer | Reimar Döffinger <Reimar.Doeffinger@gmx.de> | 2009-02-02 20:42:06 +0000 |
| commit | 679f5c2542081a90810b76d2d072222be91056c3 (patch) | |
| tree | 020ce2d32947c0ee96329be4dfbd0ec63e173ff4 /libavutil/lzo.h | |
| parent | a545f067f3ef940a24556bffb2a19edfc9b824f9 (diff) | |
| download | ffmpeg-679f5c2542081a90810b76d2d072222be91056c3.tar.gz | |
Documentation for LZO error return value flags
Originally committed as revision 16950 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavutil/lzo.h')
| -rw-r--r-- | libavutil/lzo.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/libavutil/lzo.h b/libavutil/lzo.h index 5431c1b5cf..6788054bff 100644 --- a/libavutil/lzo.h +++ b/libavutil/lzo.h @@ -24,10 +24,17 @@ #include <stdint.h> +/** \defgroup errflags Error flags returned by av_lzo1x_decode + * \{ */ +//! end of the input buffer reached before decoding finished #define AV_LZO_INPUT_DEPLETED 1 +//! decoded data did not fit into output buffer #define AV_LZO_OUTPUT_FULL 2 +//! a reference to previously decoded data was wrong #define AV_LZO_INVALID_BACKPTR 4 +//! a non-specific error in the compressed bitstream #define AV_LZO_ERROR 8 +/** \} */ #define AV_LZO_INPUT_PADDING 8 #define AV_LZO_OUTPUT_PADDING 12 @@ -38,7 +45,7 @@ * \param outlen size of output buffer, number of bytes left are returned here * \param in input buffer * \param inlen size of input buffer, number of bytes left are returned here - * \return 0 on success, otherwise error flags, see lzo.h + * \return 0 on success, otherwise a combination of the error flags above * * Make sure all buffers are appropriately padded, in must provide * AV_LZO_INPUT_PADDING, out must provide AV_LZO_OUTPUT_PADDING additional bytes. |