47fc767a0640ed0e4618e50d37bbb459070c27bb
[ffmpeg.git] / libavutil / 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
22 #include <string.h>
23
24 #include "avutil.h"
25 #include "common.h"
26 #include "intreadwrite.h"
27 #include "lzo.h"
28
29 /// Define if we may write up to 12 bytes beyond the output buffer.
30 #define OUTBUF_PADDED 1
31 /// Define if we may read up to 8 bytes beyond the input buffer.
32 #define INBUF_PADDED 1
33
34 typedef struct LZOContext {
35     const uint8_t *in, *in_end;
36     uint8_t *out_start, *out, *out_end;
37     int error;
38 } LZOContext;
39
40 /**
41  * @brief Reads one byte from the input buffer, avoiding an overrun.
42  * @return byte read
43  */
44 static inline int get_byte(LZOContext *c)
45 {
46     if (c->in < c->in_end)
47         return *c->in++;
48     c->error |= AV_LZO_INPUT_DEPLETED;
49     return 1;
50 }
51
52 #ifdef INBUF_PADDED
53 #define GETB(c) (*(c).in++)
54 #else
55 #define GETB(c) get_byte(&(c))
56 #endif
57
58 /**
59  * @brief Decodes a length value in the coding used by lzo.
60  * @param x previous byte value
61  * @param mask bits used from x
62  * @return decoded length value
63  */
64 static inline int get_len(LZOContext *c, int x, int mask)
65 {
66     int cnt = x & mask;
67     if (!cnt) {
68         while (!(x = get_byte(c)))
69             cnt += 255;
70         cnt += mask + x;
71     }
72     return cnt;
73 }
74
75 /**
76  * @brief Copies bytes from input to output buffer with checking.
77  * @param cnt number of bytes to copy, must be >= 0
78  */
79 static inline void copy(LZOContext *c, int cnt)
80 {
81     register const uint8_t *src = c->in;
82     register uint8_t *dst       = c->out;
83     if (cnt > c->in_end - src) {
84         cnt       = FFMAX(c->in_end - src, 0);
85         c->error |= AV_LZO_INPUT_DEPLETED;
86     }
87     if (cnt > c->out_end - dst) {
88         cnt       = FFMAX(c->out_end - dst, 0);
89         c->error |= AV_LZO_OUTPUT_FULL;
90     }
91 #if defined(INBUF_PADDED) && defined(OUTBUF_PADDED)
92     AV_COPY32U(dst, src);
93     src += 4;
94     dst += 4;
95     cnt -= 4;
96     if (cnt > 0)
97 #endif
98     memcpy(dst, src, cnt);
99     c->in  = src + cnt;
100     c->out = dst + cnt;
101 }
102
103 static inline void memcpy_backptr(uint8_t *dst, int back, int cnt);
104
105 /**
106  * @brief Copies previously decoded bytes to current position.
107  * @param back how many bytes back we start, must be > 0
108  * @param cnt number of bytes to copy, must be >= 0
109  *
110  * cnt > back is valid, this will copy the bytes we just copied,
111  * thus creating a repeating pattern with a period length of back.
112  */
113 static inline void copy_backptr(LZOContext *c, int back, int cnt)
114 {
115     register const uint8_t *src = &c->out[-back];
116     register uint8_t *dst       = c->out;
117     if (src < c->out_start || src > dst) {
118         c->error |= AV_LZO_INVALID_BACKPTR;
119         return;
120     }
121     if (cnt > c->out_end - dst) {
122         cnt       = FFMAX(c->out_end - dst, 0);
123         c->error |= AV_LZO_OUTPUT_FULL;
124     }
125     memcpy_backptr(dst, back, cnt);
126     c->out = dst + cnt;
127 }
128
129 static inline void memcpy_backptr(uint8_t *dst, int back, int cnt)
130 {
131     const uint8_t *src = &dst[-back];
132     if (back <= 1) {
133         memset(dst, *src, cnt);
134     } else {
135         if (cnt >= 4) {
136             AV_COPY16U(dst,     src);
137             AV_COPY16U(dst + 2, src + 2);
138             src += 4;
139             dst += 4;
140             cnt -= 4;
141         }
142         if (cnt >= 8) {
143             AV_COPY16U(dst,     src);
144             AV_COPY16U(dst + 2, src + 2);
145             AV_COPY16U(dst + 4, src + 4);
146             AV_COPY16U(dst + 6, src + 6);
147             src += 8;
148             dst += 8;
149             cnt -= 8;
150         }
151         if (cnt > 0) {
152             int blocklen = back;
153             while (cnt > blocklen) {
154                 memcpy(dst, src, blocklen);
155                 dst       += blocklen;
156                 cnt       -= blocklen;
157                 blocklen <<= 1;
158             }
159             memcpy(dst, src, cnt);
160         }
161     }
162 }
163
164 void av_memcpy_backptr(uint8_t *dst, int back, int cnt)
165 {
166     memcpy_backptr(dst, back, cnt);
167 }
168
169 int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen)
170 {
171     int state = 0;
172     int x;
173     LZOContext c;
174     if (*outlen <= 0 || *inlen <= 0) {
175         int res = 0;
176         if (*outlen <= 0)
177             res |= AV_LZO_OUTPUT_FULL;
178         if (*inlen <= 0)
179             res |= AV_LZO_INPUT_DEPLETED;
180         return res;
181     }
182     c.in      = in;
183     c.in_end  = (const uint8_t *)in + *inlen;
184     c.out     = c.out_start = out;
185     c.out_end = (uint8_t *)out + *outlen;
186     c.error   = 0;
187     x         = GETB(c);
188     if (x > 17) {
189         copy(&c, x - 17);
190         x = GETB(c);
191         if (x < 16)
192             c.error |= AV_LZO_ERROR;
193     }
194     if (c.in > c.in_end)
195         c.error |= AV_LZO_INPUT_DEPLETED;
196     while (!c.error) {
197         int cnt, back;
198         if (x > 15) {
199             if (x > 63) {
200                 cnt  = (x >> 5) - 1;
201                 back = (GETB(c) << 3) + ((x >> 2) & 7) + 1;
202             } else if (x > 31) {
203                 cnt  = get_len(&c, x, 31);
204                 x    = GETB(c);
205                 back = (GETB(c) << 6) + (x >> 2) + 1;
206             } else {
207                 cnt   = get_len(&c, x, 7);
208                 back  = (1 << 14) + ((x & 8) << 11);
209                 x     = GETB(c);
210                 back += (GETB(c) << 6) + (x >> 2);
211                 if (back == (1 << 14)) {
212                     if (cnt != 1)
213                         c.error |= AV_LZO_ERROR;
214                     break;
215                 }
216             }
217         } else if (!state) {
218             cnt = get_len(&c, x, 15);
219             copy(&c, cnt + 3);
220             x = GETB(c);
221             if (x > 15)
222                 continue;
223             cnt  = 1;
224             back = (1 << 11) + (GETB(c) << 2) + (x >> 2) + 1;
225         } else {
226             cnt  = 0;
227             back = (GETB(c) << 2) + (x >> 2) + 1;
228         }
229         copy_backptr(&c, back, cnt + 2);
230         state =
231         cnt   = x & 3;
232         copy(&c, cnt);
233         x = GETB(c);
234     }
235     *inlen = c.in_end - c.in;
236     if (c.in > c.in_end)
237         *inlen = 0;
238     *outlen = c.out_end - c.out;
239     return c.error;
240 }
241
242 #ifdef TEST
243 #include <stdio.h>
244 #include <lzo/lzo1x.h>
245 #include "log.h"
246 #define MAXSZ (10*1024*1024)
247
248 /* Define one of these to 1 if you wish to benchmark liblzo
249  * instead of our native implementation. */
250 #define BENCHMARK_LIBLZO_SAFE   0
251 #define BENCHMARK_LIBLZO_UNSAFE 0
252
253 int main(int argc, char *argv[]) {
254     FILE *in = fopen(argv[1], "rb");
255     uint8_t *orig = av_malloc(MAXSZ + 16);
256     uint8_t *comp = av_malloc(2*MAXSZ + 16);
257     uint8_t *decomp = av_malloc(MAXSZ + 16);
258     size_t s = fread(orig, 1, MAXSZ, in);
259     lzo_uint clen = 0;
260     long tmp[LZO1X_MEM_COMPRESS];
261     int inlen, outlen;
262     int i;
263     av_log_set_level(AV_LOG_DEBUG);
264     lzo1x_999_compress(orig, s, comp, &clen, tmp);
265     for (i = 0; i < 300; i++) {
266 START_TIMER
267         inlen = clen; outlen = MAXSZ;
268 #if BENCHMARK_LIBLZO_SAFE
269         if (lzo1x_decompress_safe(comp, inlen, decomp, &outlen, NULL))
270 #elif BENCHMARK_LIBLZO_UNSAFE
271         if (lzo1x_decompress(comp, inlen, decomp, &outlen, NULL))
272 #else
273         if (av_lzo1x_decode(decomp, &outlen, comp, &inlen))
274 #endif
275             av_log(NULL, AV_LOG_ERROR, "decompression error\n");
276 STOP_TIMER("lzod")
277     }
278     if (memcmp(orig, decomp, s))
279         av_log(NULL, AV_LOG_ERROR, "decompression incorrect\n");
280     else
281         av_log(NULL, AV_LOG_ERROR, "decompression OK\n");
282     return 0;
283 }
284 #endif