move doxy from .c to .h
[ffmpeg.git] / libavcodec / rle.h
1 /*
2  * RLE encoder
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  *
20  */
21
22 #ifndef RLE_H
23 #define RLE_H
24
25 /**
26  * RLE compress the row, with maximum size of out_size. Value before repeated bytes is (count ^ xor) + add.
27  * @param outbuf Output buffer
28  * @param out_size Maximum output size
29  * @param ptr Input buffer
30  * @param bpp Bytes per pixel
31  * @param w Image width
32  * @return Size of output in bytes, or -1 if larger than out_size
33  */
34 int ff_rle_encode(uint8_t *outbuf, int out_size, const uint8_t *inbuf, int bpp, int w, int8_t add, uint8_t xor);
35
36 #endif /* RLE_H */