LZO optimization: check input buffer bounds less frequently if padded
[ffmpeg.git] / libavcodec / lzo.c
1 /*
2  * LZO 1x decompression
3  * Copyright (c) 2006 Reimar Doeffinger
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #include "common.h"
22 //! avoid e.g. MPlayers fast_memcpy, it slows things down here
23 #undef memcpy
24 #include <string.h>
25 #include "lzo.h"
26
27 //! define if we may write up to 12 bytes beyond the output buffer
28 #define OUTBUF_PADDED 1
29 //! define if we may read up to 8 bytes beyond the input buffer
30 #define INBUF_PADDED 1
31 typedef struct LZOContext {
32     uint8_t *in, *in_end;
33     uint8_t *out_start, *out, *out_end;
34     int error;
35 } LZOContext;
36
37 /**
38  * \brief read one byte from input buffer, avoiding overrun
39  * \return byte read
40  */
41 static inline int get_byte(LZOContext *c) {
42     if (c->in < c->in_end)
43         return *c->in++;
44     c->error |= LZO_INPUT_DEPLETED;
45     return 1;
46 }
47
48 #ifdef INBUF_PADDED
49 #define GETB(c) (*(c).in++)
50 #else
51 #define GETB(c) get_byte(&(c))
52 #endif
53
54 /**
55  * \brief decode a length value in the coding used by lzo
56  * \param x previous byte value
57  * \param mask bits used from x
58  * \return decoded length value
59  */
60 static inline int get_len(LZOContext *c, int x, int mask) {
61     int cnt = x & mask;
62     if (!cnt) {
63         while (!(x = get_byte(c))) cnt += 255;
64         cnt += mask + x;
65     }
66     return cnt;
67 }
68
69 /**
70  * \brief copy bytes from input to output buffer with checking
71  * \param cnt number of bytes to copy, must be > 0
72  */
73 static inline void copy(LZOContext *c, int cnt) {
74     register uint8_t *src = c->in;
75     register uint8_t *dst = c->out;
76     if (src + cnt > c->in_end || src + cnt < src) {
77         cnt = c->in_end - src;
78         c->error |= LZO_INPUT_DEPLETED;
79     }
80     if (dst + cnt > c->out_end || dst + cnt < dst) {
81         cnt = c->out_end - dst;
82         c->error |= LZO_OUTPUT_FULL;
83     }
84 #if defined(INBUF_PADDED) && defined(OUTBUF_PADDED)
85     dst[0] = src[0];
86     dst[1] = src[1];
87     dst[2] = src[2];
88     dst[3] = src[3];
89     src += 4;
90     dst += 4;
91     cnt -= 4;
92     if (cnt > 0)
93 #endif
94         memcpy(dst, src, cnt);
95     c->in = src + cnt;
96     c->out = dst + cnt;
97 }
98
99 /**
100  * \brief copy previously decoded bytes to current position
101  * \param back how many bytes back we start
102  * \param cnt number of bytes to copy, must be > 0
103  *
104  * cnt > back is valid, this will copy the bytes we just copied,
105  * thus creating a repeating pattern with a period length of back.
106  */
107 static inline void copy_backptr(LZOContext *c, int back, int cnt) {
108     register uint8_t *src = &c->out[-back];
109     register uint8_t *dst = c->out;
110     if (src < c->out_start || src > dst) {
111         c->error |= LZO_INVALID_BACKPTR;
112         return;
113     }
114     if (dst + cnt > c->out_end || dst +  cnt < dst) {
115         cnt = c->out_end - dst;
116         c->error |= LZO_OUTPUT_FULL;
117     }
118     if (back == 1) {
119         memset(dst, *src, cnt);
120         dst += cnt;
121     } else {
122 #ifdef OUTBUF_PADDED
123         dst[0] = src[0];
124         dst[1] = src[1];
125         dst[2] = src[2];
126         dst[3] = src[3];
127         src += 4;
128         dst += 4;
129         cnt -= 4;
130         if (cnt > 0) {
131             dst[0] = src[0];
132             dst[1] = src[1];
133             dst[2] = src[2];
134             dst[3] = src[3];
135             dst[4] = src[4];
136             dst[5] = src[5];
137             dst[6] = src[6];
138             dst[7] = src[7];
139             src += 8;
140             dst += 8;
141             cnt -= 8;
142         }
143 #endif
144         if (cnt > 0) {
145             int blocklen = back;
146             while (cnt > blocklen) {
147                 memcpy(dst, src, blocklen);
148                 dst += blocklen;
149                 cnt -= blocklen;
150                 blocklen <<= 1;
151             }
152             memcpy(dst, src, cnt);
153         }
154         dst += cnt;
155     }
156     c->out = dst;
157 }
158
159 /**
160  * \brief decode LZO 1x compressed data
161  * \param out output buffer
162  * \param outlen size of output buffer, number of bytes left are returned here
163  * \param in input buffer
164  * \param inlen size of input buffer, number of bytes left are returned here
165  * \return 0 on success, otherwise error flags, see lzo.h
166  *
167  * make sure all buffers are appropriately padded, in must provide
168  * LZO_INPUT_PADDING, out must provide LZO_OUTPUT_PADDING additional bytes
169  */
170 int lzo1x_decode(void *out, int *outlen, void *in, int *inlen) {
171     enum {COPY, BACKPTR} state = COPY;
172     int x;
173     LZOContext c;
174     c.in = in;
175     c.in_end = (uint8_t *)in + *inlen;
176     c.out = c.out_start = out;
177     c.out_end = (uint8_t *)out + * outlen;
178     c.error = 0;
179     x = GETB(c);
180     if (x > 17) {
181         copy(&c, x - 17);
182         x = GETB(c);
183         if (x < 16) c.error |= LZO_ERROR;
184     }
185     while (!c.error) {
186         int cnt, back;
187         if (x >> 4) {
188             if (x >> 6) {
189                 cnt = (x >> 5) - 1;
190                 back = (GETB(c) << 3) + ((x >> 2) & 7) + 1;
191             } else if (x >> 5) {
192                 cnt = get_len(&c, x, 31);
193                 x = GETB(c);
194                 back = (GETB(c) << 6) + (x >> 2) + 1;
195             } else {
196                 cnt = get_len(&c, x, 7);
197                 back = (1 << 14) + ((x & 8) << 11);
198                 x = GETB(c);
199                 back += (GETB(c) << 6) + (x >> 2);
200                 if (back == (1 << 14)) {
201                     if (cnt != 1)
202                         c.error |= LZO_ERROR;
203                     break;
204                 }
205             }
206         } else
207         switch (state) {
208             case COPY:
209                 cnt = get_len(&c, x, 15);
210                 copy(&c, cnt + 3);
211                 x = GETB(c);
212                 if (x >> 4)
213                     continue;
214                 cnt = 1;
215                 back = (1 << 11) + (GETB(c) << 2) + (x >> 2) + 1;
216                 break;
217             case BACKPTR:
218                 cnt = 0;
219                 back = (GETB(c) << 2) + (x >> 2) + 1;
220                 break;
221         }
222         copy_backptr(&c, back, cnt + 2);
223         cnt = x & 3;
224         state = cnt ? BACKPTR : COPY;
225         if (cnt)
226             copy(&c, cnt);
227         x = GETB(c);
228         if (c.in > c.in_end)
229             c.error |= LZO_INPUT_DEPLETED;
230     }
231     *inlen = c.in_end - c.in;
232     if (c.in > c.in_end)
233         *inlen = 0;
234     *outlen = c.out_end - c.out;
235     return c.error;
236 }
237
238 #ifdef TEST
239 #include <stdio.h>
240 #include <lzo/lzo1x.h>
241 #include "log.h"
242 #define MAXSZ (10*1024*1024)
243 int main(int argc, char *argv[]) {
244     FILE *in = fopen(argv[1], "rb");
245     uint8_t *orig = av_malloc(MAXSZ + 16);
246     uint8_t *comp = av_malloc(2*MAXSZ + 16);
247     uint8_t *decomp = av_malloc(MAXSZ + 16);
248     size_t s = fread(orig, 1, MAXSZ, in);
249     lzo_uint clen = 0;
250     long tmp[LZO1X_MEM_COMPRESS];
251     int inlen, outlen;
252     int i;
253     av_log_level = AV_LOG_DEBUG;
254     lzo1x_999_compress(orig, s, comp, &clen, tmp);
255     for (i = 0; i < 300; i++) {
256 START_TIMER
257         inlen = clen; outlen = MAXSZ;
258         if (lzo1x_decode(decomp, &outlen, comp, &inlen))
259             av_log(NULL, AV_LOG_ERROR, "decompression error\n");
260 STOP_TIMER("lzod")
261     }
262     if (memcmp(orig, decomp, s))
263         av_log(NULL, AV_LOG_ERROR, "decompression incorrect\n");
264     else
265         av_log(NULL, AV_LOG_ERROR, "decompression ok\n");
266     return 0;
267 }
268 #endif