libavcodec/faxcompr.c
8d48db31
 /*
  * CCITT Fax Group 3 and 4 decompression
  * Copyright (c) 2008 Konstantin Shishkov
  *
  * 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
f6f95d4e
  * CCITT Fax Group 3 and 4 decompression
8d48db31
  * @author Konstantin Shishkov
  */
 #include "avcodec.h"
9106a698
 #include "get_bits.h"
b2755007
 #include "put_bits.h"
8d48db31
 #include "faxcompr.h"
 
 #define CCITT_SYMS 104
 
 static const uint16_t ccitt_syms[CCITT_SYMS] = {
     0,    1,    2,    3,    4,    5,    6,    7,    8,    9,   10,   11,   12,
    13,   14,   15,   16,   17,   18,   19,   20,   21,   22,   23,   24,   25,
    26,   27,   28,   29,   30,   31,   32,   33,   34,   35,   36,   37,   38,
    39,   40,   41,   42,   43,   44,   45,   46,   47,   48,   49,   50,   51,
    52,   53,   54,   55,   56,   57,   58,   59,   60,   61,   62,   63,   64,
   128,  192,  256,  320,  384,  448,  512,  576,  640,  704,  768,  832,  896,
   960, 1024, 1088, 1152, 1216, 1280, 1344, 1408, 1472, 1536, 1600, 1664, 1728,
  1792, 1856, 1920, 1984, 2048, 2112, 2176, 2240, 2304, 2368, 2432, 2496, 2560
 };
 
 static const uint8_t ccitt_codes_bits[2][CCITT_SYMS] =
 {
   {
     0x35, 0x07, 0x07, 0x08, 0x0B, 0x0C, 0x0E, 0x0F, 0x13, 0x14, 0x07, 0x08, 0x08,
     0x03, 0x34, 0x35, 0x2A, 0x2B, 0x27, 0x0C, 0x08, 0x17, 0x03, 0x04, 0x28, 0x2B,
     0x13, 0x24, 0x18, 0x02, 0x03, 0x1A, 0x1B, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
     0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x04, 0x05, 0x0A, 0x0B, 0x52, 0x53, 0x54,
     0x55, 0x24, 0x25, 0x58, 0x59, 0x5A, 0x5B, 0x4A, 0x4B, 0x32, 0x33, 0x34, 0x1B,
     0x12, 0x17, 0x37, 0x36, 0x37, 0x64, 0x65, 0x68, 0x67, 0xCC, 0xCD, 0xD2, 0xD3,
     0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA, 0xDB, 0x98, 0x99, 0x9A, 0x18, 0x9B,
     0x08, 0x0C, 0x0D, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x1C, 0x1D, 0x1E, 0x1F
   },
   {
     0x37, 0x02, 0x03, 0x02, 0x03, 0x03, 0x02, 0x03, 0x05, 0x04, 0x04, 0x05, 0x07,
     0x04, 0x07, 0x18, 0x17, 0x18, 0x08, 0x67, 0x68, 0x6C, 0x37, 0x28, 0x17, 0x18,
     0xCA, 0xCB, 0xCC, 0xCD, 0x68, 0x69, 0x6A, 0x6B, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6,
     0xD7, 0x6C, 0x6D, 0xDA, 0xDB, 0x54, 0x55, 0x56, 0x57, 0x64, 0x65, 0x52, 0x53,
     0x24, 0x37, 0x38, 0x27, 0x28, 0x58, 0x59, 0x2B, 0x2C, 0x5A, 0x66, 0x67, 0x0F,
     0xC8, 0xC9, 0x5B, 0x33, 0x34, 0x35, 0x6C, 0x6D, 0x4A, 0x4B, 0x4C, 0x4D, 0x72,
     0x73, 0x74, 0x75, 0x76, 0x77, 0x52, 0x53, 0x54, 0x55, 0x5A, 0x5B, 0x64, 0x65,
     0x08, 0x0C, 0x0D, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x1C, 0x1D, 0x1E, 0x1F
   }
 };
 
 static const uint8_t ccitt_codes_lens[2][CCITT_SYMS] =
 {
   {
      8,  6,  4,  4,  4,  4,  4,  4,  5,  5,  5,  5,  6,  6,  6,  6,  6,  6,  7,  7,
      7,  7,  7,  7,  7,  7,  7,  7,  7,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,
      8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,  8,
      8,  8,  8,  8,  5,  5,  6,  7,  8,  8,  8,  8,  8,  8,  9,  9,  9,  9,  9,  9,
      9,  9,  9,  9,  9,  9,  9,  9,  9,  6,  9, 11, 11, 11, 12, 12, 12, 12, 12, 12,
     12, 12, 12, 12
   },
   {
     10,  3,  2,  2,  3,  4,  4,  5,  6,  6,  7,  7,  7,  8,  8,  9, 10, 10, 10, 11,
     11, 11, 11, 11, 11, 11, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12,
     12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12,
     12, 12, 12, 12, 10, 12, 12, 12, 12, 12, 12, 13, 13, 13, 13, 13, 13, 13, 13, 13,
     13, 13, 13, 13, 13, 13, 13, 13, 13, 13, 13, 11, 11, 11, 12, 12, 12, 12, 12, 12,
     12, 12, 12, 12
   }
 };
 
 static const uint8_t ccitt_group3_2d_bits[11] = {
     1, 1, 2, 2, 2, 1, 3, 3, 3, 1, 1
 };
 
 static const uint8_t ccitt_group3_2d_lens[11] = {
     4, 3, 7, 6, 3, 1, 3, 6, 7, 7, 9
 };
 
 static VLC ccitt_vlc[2], ccitt_group3_2d_vlc;
 
dc8a7c93
 av_cold void ff_ccitt_unpack_init(void)
8d48db31
 {
     static VLC_TYPE code_table1[528][2];
     static VLC_TYPE code_table2[648][2];
     int i;
     static int initialized = 0;
 
f32aefcf
     if (initialized)
8d48db31
         return;
     ccitt_vlc[0].table = code_table1;
     ccitt_vlc[0].table_allocated = 528;
     ccitt_vlc[1].table = code_table2;
     ccitt_vlc[1].table_allocated = 648;
f32aefcf
     for (i = 0; i < 2; i++) {
e96b4a53
         ff_init_vlc_sparse(&ccitt_vlc[i], 9, CCITT_SYMS,
                            ccitt_codes_lens[i], 1, 1,
                            ccitt_codes_bits[i], 1, 1,
                            ccitt_syms, 2, 2,
                            INIT_VLC_USE_NEW_STATIC);
8d48db31
     }
     INIT_VLC_STATIC(&ccitt_group3_2d_vlc, 9, 11,
                     ccitt_group3_2d_lens, 1, 1,
                     ccitt_group3_2d_bits, 1, 1, 512);
     initialized = 1;
 }
 
b2e95e01
 static int decode_uncompressed(AVCodecContext *avctx, GetBitContext *gb,
                                unsigned int *pix_left, int **runs,
                                const int *runend, int *mode)
 {
     int eob = 0;
     int newmode;
     int saved_run = 0;
 
     do {
         int cwi, k;
         int cw = 0;
         int codes[2];
         do {
             cwi = show_bits(gb, 11);
             if (!cwi) {
                 av_log(avctx, AV_LOG_ERROR, "Invalid uncompressed codeword\n");
                 return AVERROR_INVALIDDATA;
             }
             cwi = 10 - av_log2(cwi);
             skip_bits(gb, cwi + 1);
             if (cwi > 5) {
                 newmode = get_bits1(gb);
                 eob = 1;
                 cwi -= 6;
             }
             cw += cwi;
         } while(cwi == 5);
 
         codes[0] = cw;
         codes[1] = !eob;
 
         for (k = 0; k < 2; k++) {
             if (codes[k]) {
01278405
                 if (*mode == !k) {
b2e95e01
                     *(*runs)++ = saved_run;
                     if (*runs >= runend) {
                         av_log(avctx, AV_LOG_ERROR, "uncompressed run overrun\n");
                         return AVERROR_INVALIDDATA;
                     }
                     if (*pix_left <= saved_run) {
                         av_log(avctx, AV_LOG_ERROR, "uncompressed run went out of bounds\n");
                         return AVERROR_INVALIDDATA;
                     }
                     *pix_left -= saved_run;
                     saved_run = 0;
                     *mode = !*mode;
                 }
                 saved_run += codes[k];
             }
         }
     } while (!eob);
     *(*runs)++ = saved_run;
     if (*runs >= runend) {
         av_log(avctx, AV_LOG_ERROR, "uncompressed run overrun\n");
         return AVERROR_INVALIDDATA;
     }
     if (*pix_left <= saved_run) {
         if (*pix_left == saved_run)
             return 1;
         av_log(avctx, AV_LOG_ERROR, "uncompressed run went out of boundsE\n");
         return AVERROR_INVALIDDATA;
     }
     *pix_left -= saved_run;
     saved_run = 0;
     *mode = !*mode;
     if (newmode != *mode) { //FIXME CHECK
         *(*runs)++ = 0;
d4a731b8
         if (*runs >= runend) {
             av_log(avctx, AV_LOG_ERROR, "uncompressed run overrun\n");
             return AVERROR_INVALIDDATA;
         }
b2e95e01
         *mode = newmode;
     }
     return 0;
 }
8d48db31
 
 static int decode_group3_1d_line(AVCodecContext *avctx, GetBitContext *gb,
f32aefcf
                                  unsigned int pix_left, int *runs,
                                  const int *runend)
8d48db31
 {
f32aefcf
     int mode         = 0;
     unsigned int run = 0;
8d48db31
     unsigned int t;
f32aefcf
     for (;;) {
         t    = get_vlc2(gb, ccitt_vlc[mode].table, 9, 2);
8d48db31
         run += t;
f32aefcf
         if (t < 64) {
8d48db31
             *runs++ = run;
f32aefcf
             if (runs >= runend) {
1d798507
                 av_log(avctx, AV_LOG_ERROR, "Run overrun\n");
a3b2b83f
                 return AVERROR_INVALIDDATA;
1d798507
             }
f32aefcf
             if (pix_left <= run) {
                 if (pix_left == run)
8d48db31
                     break;
                 av_log(avctx, AV_LOG_ERROR, "Run went out of bounds\n");
a3b2b83f
                 return AVERROR_INVALIDDATA;
8d48db31
             }
11c5999e
             pix_left -= run;
f32aefcf
             run       = 0;
             mode      = !mode;
         } else if ((int)t == -1) {
a4f9bb22
             if (show_bits(gb, 12) == 15) {
b2e95e01
                 int ret;
a4f9bb22
                 skip_bits(gb, 12);
b2e95e01
                 ret = decode_uncompressed(avctx, gb, &pix_left, &runs, runend, &mode);
                 if (ret < 0) {
                     return ret;
                 } else if (ret)
                     break;
a4f9bb22
             } else {
                 av_log(avctx, AV_LOG_ERROR, "Incorrect code\n");
                 return AVERROR_INVALIDDATA;
             }
8d48db31
         }
     }
     *runs++ = 0;
     return 0;
 }
 
 static int decode_group3_2d_line(AVCodecContext *avctx, GetBitContext *gb,
f32aefcf
                                  unsigned int width, int *runs,
                                  const int *runend, const int *ref)
8d48db31
 {
f32aefcf
     int mode          = 0, saved_run = 0, t;
     int run_off       = *ref++;
     unsigned int offs = 0, run = 0;
8d48db31
 
f32aefcf
     while (offs < width) {
8d48db31
         int cmode = get_vlc2(gb, ccitt_group3_2d_vlc.table, 9, 1);
f32aefcf
         if (cmode == -1) {
8d48db31
             av_log(avctx, AV_LOG_ERROR, "Incorrect mode VLC\n");
a3b2b83f
             return AVERROR_INVALIDDATA;
8d48db31
         }
f32aefcf
         if (!cmode) { //pass mode
a5a9bcc8
             if (run_off < width)
6f9ae391
                 run_off += *ref++;
f32aefcf
             run      = run_off - offs;
             offs     = run_off;
a5a9bcc8
             if (run_off < width)
6f9ae391
                 run_off += *ref++;
f32aefcf
             if (offs > width) {
8d48db31
                 av_log(avctx, AV_LOG_ERROR, "Run went out of bounds\n");
a3b2b83f
                 return AVERROR_INVALIDDATA;
8d48db31
             }
             saved_run += run;
f32aefcf
         } else if (cmode == 1) { //horizontal mode
8d48db31
             int k;
f32aefcf
             for (k = 0; k < 2; k++) {
8d48db31
                 run = 0;
f32aefcf
                 for (;;) {
8d48db31
                     t = get_vlc2(gb, ccitt_vlc[mode].table, 9, 2);
f32aefcf
                     if (t == -1) {
8d48db31
                         av_log(avctx, AV_LOG_ERROR, "Incorrect code\n");
a3b2b83f
                         return AVERROR_INVALIDDATA;
8d48db31
                     }
                     run += t;
f32aefcf
                     if (t < 64)
8d48db31
                         break;
                 }
                 *runs++ = run + saved_run;
f32aefcf
                 if (runs >= runend) {
1d798507
                     av_log(avctx, AV_LOG_ERROR, "Run overrun\n");
a3b2b83f
                     return AVERROR_INVALIDDATA;
1d798507
                 }
8d48db31
                 saved_run = 0;
f32aefcf
                 offs     += run;
                 if (offs > width || run > width) {
8d48db31
                     av_log(avctx, AV_LOG_ERROR, "Run went out of bounds\n");
a3b2b83f
                     return AVERROR_INVALIDDATA;
8d48db31
                 }
                 mode = !mode;
             }
f32aefcf
         } else if (cmode == 9 || cmode == 10) {
bd2d4cc4
             int xxx = get_bits(gb, 3);
38025e68
             if (cmode == 9 && xxx == 7) {
b2e95e01
                 int ret;
                 int pix_left = width - offs;
38025e68
 
                 if (saved_run) {
                     av_log(avctx, AV_LOG_ERROR, "saved run %d on entering uncompressed mode\n", saved_run);
                     return AVERROR_INVALIDDATA;
                 }
b2e95e01
                 ret = decode_uncompressed(avctx, gb, &pix_left, &runs, runend, &mode);
                 offs = width - pix_left;
                 if (ret < 0) {
                     return ret;
                 } else if (ret)
                     break;
38025e68
             } else {
                 avpriv_report_missing_feature(avctx, "Special mode %d xxx=%d support", cmode, xxx);
                 return AVERROR_PATCHWELCOME;
             }
f32aefcf
         } else { //vertical mode
             run      = run_off - offs + (cmode - 5);
a56f82ea
             run_off -= *--ref;
f32aefcf
             offs    += run;
             if (offs > width || run > width) {
8d48db31
                 av_log(avctx, AV_LOG_ERROR, "Run went out of bounds\n");
a3b2b83f
                 return AVERROR_INVALIDDATA;
8d48db31
             }
             *runs++ = run + saved_run;
f32aefcf
             if (runs >= runend) {
1d798507
                 av_log(avctx, AV_LOG_ERROR, "Run overrun\n");
a3b2b83f
                 return AVERROR_INVALIDDATA;
1d798507
             }
8d48db31
             saved_run = 0;
f32aefcf
             mode      = !mode;
8d48db31
         }
6f5c00eb
         //sync line pointers
a5a9bcc8
         while (offs < width && run_off <= offs) {
6f5c00eb
             run_off += *ref++;
             run_off += *ref++;
         }
8d48db31
     }
     *runs++ = saved_run;
98b7a50a
     if (saved_run) {
a5a9bcc8
         if (runs >= runend) {
98b7a50a
             av_log(avctx, AV_LOG_ERROR, "Run overrun\n");
             return -1;
         }
         *runs++ = 0;
     }
8d48db31
     return 0;
 }
 
 static void put_line(uint8_t *dst, int size, int width, const int *runs)
 {
     PutBitContext pb;
bc0f7a9c
     int run, mode = ~0, pix_left = width, run_idx = 0;
8d48db31
 
50833c9f
     init_put_bits(&pb, dst, size);
f32aefcf
     while (pix_left > 0) {
         run       = runs[run_idx++];
         mode      = ~mode;
8d48db31
         pix_left -= run;
f32aefcf
         for (; run > 16; run -= 16)
bc0f7a9c
             put_sbits(&pb, 16, mode);
f32aefcf
         if (run)
679f3fa9
             put_sbits(&pb, run, mode);
8d48db31
     }
a5568f46
     flush_put_bits(&pb);
8d48db31
 }
 
 static int find_group3_syncmarker(GetBitContext *gb, int srcsize)
 {
eb12536a
     unsigned int state = -1;
     srcsize -= get_bits_count(gb);
f32aefcf
     while (srcsize-- > 0) {
         state += state + get_bits1(gb);
         if ((state & 0xFFF) == 1)
eb12536a
             return 0;
8d48db31
     }
eb12536a
     return -1;
8d48db31
 }
 
f32aefcf
 int ff_ccitt_unpack(AVCodecContext *avctx, const uint8_t *src, int srcsize,
d2cdf201
                     uint8_t *dst, int height, int stride,
                     enum TiffCompr compr, int opts)
8d48db31
 {
     int j;
     GetBitContext gb;
99a33529
     int *runs, *ref = NULL, *runend;
8d48db31
     int ret;
f32aefcf
     int runsize = avctx->width + 2;
3a1ca240
     int has_eol;
8d48db31
 
713e62e9
     runs = av_malloc_array(runsize, sizeof(runs[0]));
     ref  = av_malloc_array(runsize, sizeof(ref[0]));
f32aefcf
     if (!runs || !ref) {
a3b2b83f
         ret = AVERROR(ENOMEM);
99a33529
         goto fail;
     }
8d48db31
     ref[0] = avctx->width;
     ref[1] = 0;
     ref[2] = 0;
134e8c73
     if ((ret = init_get_bits8(&gb, src, srcsize)) < 0)
424ed1a8
         goto fail;
438b86fe
     has_eol = show_bits(&gb, 12) == 1 || show_bits(&gb, 16) == 1;
 
f32aefcf
     for (j = 0; j < height; j++) {
6fe68c7b
         runend = runs + runsize;
f32aefcf
         if (compr == TIFF_G4) {
             ret = decode_group3_2d_line(avctx, &gb, avctx->width, runs, runend,
                                         ref);
a3b2b83f
             if (ret < 0)
99a33529
                 goto fail;
f32aefcf
         } else {
8da5d3dc
             int g3d1 = (compr == TIFF_G3) && !(opts & 1);
f32aefcf
             if (compr != TIFF_CCITT_RLE &&
a5a9bcc8
                 has_eol &&
f32aefcf
                 find_group3_syncmarker(&gb, srcsize * 8) < 0)
8d48db31
                 break;
f32aefcf
             if (compr == TIFF_CCITT_RLE || g3d1 || get_bits1(&gb))
                 ret = decode_group3_1d_line(avctx, &gb, avctx->width, runs,
                                             runend);
8d48db31
             else
f32aefcf
                 ret = decode_group3_2d_line(avctx, &gb, avctx->width, runs,
                                             runend, ref);
             if (compr == TIFF_CCITT_RLE)
badce93d
                 align_get_bits(&gb);
8d48db31
         }
a3b2b83f
         if (avctx->err_recognition & AV_EF_EXPLODE && ret < 0)
             goto fail;
 
f32aefcf
         if (ret < 0) {
8d48db31
             put_line(dst, stride, avctx->width, ref);
f32aefcf
         } else {
8d48db31
             put_line(dst, stride, avctx->width, runs);
f32aefcf
             FFSWAP(int *, runs, ref);
8d48db31
         }
         dst += stride;
     }
a3b2b83f
     ret = 0;
99a33529
 fail:
8d48db31
     av_free(runs);
     av_free(ref);
a3b2b83f
     return ret;
8d48db31
 }