FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
lzo.c
Go to the documentation of this file.
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;
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++;
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);
86  }
87  if (cnt > c->out_end - dst) {
88  cnt = FFMAX(c->out_end - dst, 0);
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 /**
104  * @brief Copies previously decoded bytes to current position.
105  * @param back how many bytes back we start, must be > 0
106  * @param cnt number of bytes to copy, must be >= 0
107  *
108  * cnt > back is valid, this will copy the bytes we just copied,
109  * thus creating a repeating pattern with a period length of back.
110  */
111 static inline void copy_backptr(LZOContext *c, int back, int cnt)
112 {
113  register const uint8_t *src = &c->out[-back];
114  register uint8_t *dst = c->out;
115  if (src < c->out_start || src > dst) {
117  return;
118  }
119  if (cnt > c->out_end - dst) {
120  cnt = FFMAX(c->out_end - dst, 0);
122  }
123  av_memcpy_backptr(dst, back, cnt);
124  c->out = dst + cnt;
125 }
126 
127 int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen)
128 {
129  int state = 0;
130  int x;
131  LZOContext c;
132  if (*outlen <= 0 || *inlen <= 0) {
133  int res = 0;
134  if (*outlen <= 0)
135  res |= AV_LZO_OUTPUT_FULL;
136  if (*inlen <= 0)
137  res |= AV_LZO_INPUT_DEPLETED;
138  return res;
139  }
140  c.in = in;
141  c.in_end = (const uint8_t *)in + *inlen;
142  c.out = c.out_start = out;
143  c.out_end = (uint8_t *)out + *outlen;
144  c.error = 0;
145  x = GETB(c);
146  if (x > 17) {
147  copy(&c, x - 17);
148  x = GETB(c);
149  if (x < 16)
150  c.error |= AV_LZO_ERROR;
151  }
152  if (c.in > c.in_end)
154  while (!c.error) {
155  int cnt, back;
156  if (x > 15) {
157  if (x > 63) {
158  cnt = (x >> 5) - 1;
159  back = (GETB(c) << 3) + ((x >> 2) & 7) + 1;
160  } else if (x > 31) {
161  cnt = get_len(&c, x, 31);
162  x = GETB(c);
163  back = (GETB(c) << 6) + (x >> 2) + 1;
164  } else {
165  cnt = get_len(&c, x, 7);
166  back = (1 << 14) + ((x & 8) << 11);
167  x = GETB(c);
168  back += (GETB(c) << 6) + (x >> 2);
169  if (back == (1 << 14)) {
170  if (cnt != 1)
171  c.error |= AV_LZO_ERROR;
172  break;
173  }
174  }
175  } else if (!state) {
176  cnt = get_len(&c, x, 15);
177  copy(&c, cnt + 3);
178  x = GETB(c);
179  if (x > 15)
180  continue;
181  cnt = 1;
182  back = (1 << 11) + (GETB(c) << 2) + (x >> 2) + 1;
183  } else {
184  cnt = 0;
185  back = (GETB(c) << 2) + (x >> 2) + 1;
186  }
187  copy_backptr(&c, back, cnt + 2);
188  state =
189  cnt = x & 3;
190  copy(&c, cnt);
191  x = GETB(c);
192  }
193  *inlen = c.in_end - c.in;
194  if (c.in > c.in_end)
195  *inlen = 0;
196  *outlen = c.out_end - c.out;
197  return c.error;
198 }
199 
200 #ifdef TEST
201 #include <stdio.h>
202 #include <lzo/lzo1x.h>
203 #include "log.h"
204 #define MAXSZ (10*1024*1024)
205 
206 /* Define one of these to 1 if you wish to benchmark liblzo
207  * instead of our native implementation. */
208 #define BENCHMARK_LIBLZO_SAFE 0
209 #define BENCHMARK_LIBLZO_UNSAFE 0
210 
211 int main(int argc, char *argv[]) {
212  FILE *in = fopen(argv[1], "rb");
213  uint8_t *orig = av_malloc(MAXSZ + 16);
214  uint8_t *comp = av_malloc(2*MAXSZ + 16);
215  uint8_t *decomp = av_malloc(MAXSZ + 16);
216  size_t s = fread(orig, 1, MAXSZ, in);
217  lzo_uint clen = 0;
218  long tmp[LZO1X_MEM_COMPRESS];
219  int inlen, outlen;
220  int i;
222  lzo1x_999_compress(orig, s, comp, &clen, tmp);
223  for (i = 0; i < 300; i++) {
225  inlen = clen; outlen = MAXSZ;
226 #if BENCHMARK_LIBLZO_SAFE
227  if (lzo1x_decompress_safe(comp, inlen, decomp, &outlen, NULL))
228 #elif BENCHMARK_LIBLZO_UNSAFE
229  if (lzo1x_decompress(comp, inlen, decomp, &outlen, NULL))
230 #else
231  if (av_lzo1x_decode(decomp, &outlen, comp, &inlen))
232 #endif
233  av_log(NULL, AV_LOG_ERROR, "decompression error\n");
234 STOP_TIMER("lzod")
235  }
236  if (memcmp(orig, decomp, s))
237  av_log(NULL, AV_LOG_ERROR, "decompression incorrect\n");
238  else
239  av_log(NULL, AV_LOG_ERROR, "decompression OK\n");
240  return 0;
241 }
242 #endif