libavutil/lzo.h
04d7f601
 /*
  * LZO 1x decompression
  * copyright (c) 2006 Reimar Doeffinger
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
04d7f601
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
04d7f601
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
04d7f601
  * 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
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
04d7f601
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
98790382
 #ifndef AVUTIL_LZO_H
 #define AVUTIL_LZO_H
517840c6
 
82ed0b76
 #include <stdint.h>
 
679f5c25
 /** \defgroup errflags Error flags returned by av_lzo1x_decode
   * \{ */
 //! end of the input buffer reached before decoding finished
0b178e56
 #define AV_LZO_INPUT_DEPLETED 1
679f5c25
 //! decoded data did not fit into output buffer
0b178e56
 #define AV_LZO_OUTPUT_FULL 2
679f5c25
 //! a reference to previously decoded data was wrong
0b178e56
 #define AV_LZO_INVALID_BACKPTR 4
679f5c25
 //! a non-specific error in the compressed bitstream
0b178e56
 #define AV_LZO_ERROR 8
679f5c25
 /** \} */
517840c6
 
0b178e56
 #define AV_LZO_INPUT_PADDING 8
 #define AV_LZO_OUTPUT_PADDING 12
f53a2931
 
a545f067
 /**
  * \brief Decodes LZO 1x compressed data.
  * \param out output buffer
  * \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
679f5c25
  * \return 0 on success, otherwise a combination of the error flags above
a545f067
  *
  * Make sure all buffers are appropriately padded, in must provide
  * AV_LZO_INPUT_PADDING, out must provide AV_LZO_OUTPUT_PADDING additional bytes.
  */
0b178e56
 int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen);
517840c6
 
a545f067
 /**
  * \brief deliberately overlapping memcpy implementation
  * \param dst destination buffer; must be padded with 12 additional bytes
  * \param back how many bytes back we start (the initial size of the overlapping window)
  * \param cnt number of bytes to copy, must be >= 0
  *
  * cnt > back is valid, this will copy the bytes we just copied,
  * thus creating a repeating pattern with a period length of back.
  */
6ba10f33
 void av_memcpy_backptr(uint8_t *dst, int back, int cnt);
 
98790382
 #endif /* AVUTIL_LZO_H */