libavcodec/lzw.c
ffc5430b
 /*
  * LZW decoder
406792e7
  * Copyright (c) 2003 Fabrice Bellard
  * Copyright (c) 2006 Konstantin Shishkov
ffc5430b
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * 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
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
ffc5430b
  * @brief LZW decoding routines
  * @author Fabrice Bellard
ad4cd0c2
  * @author modified for use in TIFF by Konstantin Shishkov
ffc5430b
  */
 
 #include "avcodec.h"
 #include "lzw.h"
 
 #define LZW_MAXBITS                 12
 #define LZW_SIZTABLE                (1<<LZW_MAXBITS)
 
 static const uint16_t mask[17] =
 {
     0x0000, 0x0001, 0x0003, 0x0007,
     0x000F, 0x001F, 0x003F, 0x007F,
     0x00FF, 0x01FF, 0x03FF, 0x07FF,
     0x0FFF, 0x1FFF, 0x3FFF, 0x7FFF, 0xFFFF
 };
 
 struct LZWState {
7993df65
     const uint8_t *pbuf, *ebuf;
ffc5430b
     int bbits;
     unsigned int bbuf;
 
     int mode;                   ///< Decoder mode
     int cursize;                ///< The current code size
     int curmask;
     int codesize;
     int clear_code;
     int end_code;
     int newcodes;               ///< First available code
     int top_slot;               ///< Highest code for current size
62ef8925
     int extra_slot;
ffc5430b
     int slot;                   ///< Last read code
     int fc, oc;
     uint8_t *sp;
     uint8_t stack[LZW_SIZTABLE];
     uint8_t suffix[LZW_SIZTABLE];
     uint16_t prefix[LZW_SIZTABLE];
     int bs;                     ///< current buffer size for GIF
 };
 
 /* get one code from stream */
 static int lzw_get_code(struct LZWState * s)
 {
6aaf3abd
     int c;
ffc5430b
 
     if(s->mode == FF_LZW_GIF) {
         while (s->bbits < s->cursize) {
             if (!s->bs) {
6aaf3abd
                 s->bs = *s->pbuf++;
ffc5430b
             }
             s->bbuf |= (*s->pbuf++) << s->bbits;
             s->bbits += 8;
             s->bs--;
         }
f39c3c88
         c = s->bbuf;
93e91145
         s->bbuf >>= s->cursize;
ffc5430b
     } else { // TIFF
         while (s->bbits < s->cursize) {
             s->bbuf = (s->bbuf << 8) | (*s->pbuf++);
             s->bbits += 8;
         }
f39c3c88
         c = s->bbuf >> (s->bbits - s->cursize);
ffc5430b
     }
     s->bbits -= s->cursize;
f39c3c88
     return c & s->curmask;
ffc5430b
 }
 
7993df65
 const uint8_t* ff_lzw_cur_ptr(LZWState *p)
ffc5430b
 {
     return ((struct LZWState*)p)->pbuf;
 }
 
 void ff_lzw_decode_tail(LZWState *p)
 {
     struct LZWState *s = (struct LZWState *)p;
5f01beb5
 
     if(s->mode == FF_LZW_GIF) {
         while(s->pbuf < s->ebuf && s->bs>0){
             s->pbuf += s->bs;
             s->bs = *s->pbuf++;
         }
     }else
         s->pbuf= s->ebuf;
ffc5430b
 }
 
98a6fff9
 av_cold void ff_lzw_decode_open(LZWState **p)
ffc5430b
 {
     *p = av_mallocz(sizeof(struct LZWState));
 }
 
98a6fff9
 av_cold void ff_lzw_decode_close(LZWState **p)
ffc5430b
 {
     av_freep(p);
 }
 
 /**
  * Initialize LZW decoder
9a58234f
  * @param p LZW context
ffc5430b
  * @param csize initial code size in bits
  * @param buf input data
  * @param buf_size input data size
  * @param mode decoder working mode - either GIF or TIFF
  */
7993df65
 int ff_lzw_decode_init(LZWState *p, int csize, const uint8_t *buf, int buf_size, int mode)
ffc5430b
 {
     struct LZWState *s = (struct LZWState *)p;
 
b08edb22
     if(csize < 1 || csize >= LZW_MAXBITS)
ffc5430b
         return -1;
     /* read buffer */
     s->pbuf = buf;
     s->ebuf = s->pbuf + buf_size;
     s->bbuf = 0;
     s->bbits = 0;
     s->bs = 0;
 
     /* decoder */
     s->codesize = csize;
     s->cursize = s->codesize + 1;
     s->curmask = mask[s->cursize];
     s->top_slot = 1 << s->cursize;
     s->clear_code = 1 << s->codesize;
     s->end_code = s->clear_code + 1;
     s->slot = s->newcodes = s->clear_code + 2;
34a370cb
     s->oc = s->fc = -1;
ffc5430b
     s->sp = s->stack;
 
     s->mode = mode;
0abfd533
     s->extra_slot = s->mode == FF_LZW_TIFF;
ffc5430b
     return 0;
 }
 
 /**
  * Decode given number of bytes
  * NOTE: the algorithm here is inspired from the LZW GIF decoder
  *  written by Steven A. Bennett in 1987.
  *
9a58234f
  * @param p LZW context
ffc5430b
  * @param buf output buffer
  * @param len number of bytes to decode
  * @return number of bytes decoded
  */
 int ff_lzw_decode(LZWState *p, uint8_t *buf, int len){
     int l, c, code, oc, fc;
     uint8_t *sp;
     struct LZWState *s = (struct LZWState *)p;
 
     if (s->end_code < 0)
         return 0;
 
     l = len;
     sp = s->sp;
     oc = s->oc;
     fc = s->fc;
 
     for (;;) {
bf770961
         while (sp > s->stack) {
             *buf++ = *(--sp);
             if ((--l) == 0)
                 goto the_end;
         }
ffc5430b
         c = lzw_get_code(s);
         if (c == s->end_code) {
             break;
         } else if (c == s->clear_code) {
             s->cursize = s->codesize + 1;
             s->curmask = mask[s->cursize];
             s->slot = s->newcodes;
             s->top_slot = 1 << s->cursize;
34a370cb
             fc= oc= -1;
ffc5430b
         } else {
             code = c;
0cb7f8a2
             if (code == s->slot && fc>=0) {
ffc5430b
                 *sp++ = fc;
                 code = oc;
0cb7f8a2
             }else if(code >= s->slot)
                 break;
ffc5430b
             while (code >= s->newcodes) {
                 *sp++ = s->suffix[code];
                 code = s->prefix[code];
             }
             *sp++ = code;
34a370cb
             if (s->slot < s->top_slot && oc>=0) {
                 s->suffix[s->slot] = code;
ffc5430b
                 s->prefix[s->slot++] = oc;
             }
34a370cb
             fc = code;
             oc = c;
62ef8925
             if (s->slot >= s->top_slot - s->extra_slot) {
ffc5430b
                 if (s->cursize < LZW_MAXBITS) {
                     s->top_slot <<= 1;
                     s->curmask = mask[++s->cursize];
                 }
             }
         }
     }
0cb7f8a2
     s->end_code = -1;
ffc5430b
   the_end:
     s->sp = sp;
     s->oc = oc;
     s->fc = fc;
     return len - l;
 }