git.sesse.net Git - ffmpeg/blob - libavcodec/lagarith.c

   1 /*
   2  * Lagarith lossless decoder
   3  * Copyright (c) 2009 Nathan Caldwell <saintdev (at) gmail.com>
   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 /**
  23  * @file
  24  * Lagarith lossless decoder
  25  * @author Nathan Caldwell
  26  */
  27
  28 #include "avcodec.h"
  29 #include "get_bits.h"
  30 #include "mathops.h"
  31 #include "dsputil.h"
  32 #include "lagarithrac.h"
  33
  34 enum LagarithFrameType {
  35     FRAME_RAW           = 1,    /**< uncompressed */
  36     FRAME_U_RGB24       = 2,    /**< unaligned RGB24 */
  37     FRAME_ARITH_YUY2    = 3,    /**< arithmetic coded YUY2 */
  38     FRAME_ARITH_RGB24   = 4,    /**< arithmetic coded RGB24 */
  39     FRAME_SOLID_GRAY    = 5,    /**< solid grayscale color frame */
  40     FRAME_SOLID_COLOR   = 6,    /**< solid non-grayscale color frame */
  41     FRAME_OLD_ARITH_RGB = 7,    /**< obsolete arithmetic coded RGB (no longer encoded by upstream since version 1.1.0) */
  42     FRAME_ARITH_RGBA    = 8,    /**< arithmetic coded RGBA */
  43     FRAME_SOLID_RGBA    = 9,    /**< solid RGBA color frame */
  44     FRAME_ARITH_YV12    = 10,   /**< arithmetic coded YV12 */
  45     FRAME_REDUCED_RES   = 11,   /**< reduced resolution YV12 frame */
  46 };
  47
  48 typedef struct LagarithContext {
  49     AVCodecContext *avctx;
  50     AVFrame picture;
  51     DSPContext dsp;
  52     int zeros;                  /**< number of consecutive zero bytes encountered */
  53     int zeros_rem;              /**< number of zero bytes remaining to output */
  54     uint8_t *rgb_planes;
  55     int rgb_stride;
  56 } LagarithContext;
  57
  58 /**
  59  * Compute the 52bit mantissa of 1/(double)denom.
  60  * This crazy format uses floats in an entropy coder and we have to match x86
  61  * rounding exactly, thus ordinary floats aren't portable enough.
  62  * @param denom denominator
  63  * @return 52bit mantissa
  64  * @see softfloat_mul
  65  */
  66 static uint64_t softfloat_reciprocal(uint32_t denom)
  67 {
  68     int shift = av_log2(denom - 1) + 1;
  69     uint64_t ret = (1ULL << 52) / denom;
  70     uint64_t err = (1ULL << 52) - ret * denom;
  71     ret <<= shift;
  72     err <<= shift;
  73     err +=  denom / 2;
  74     return ret + err / denom;
  75 }
  76
  77 /**
  78  * (uint32_t)(x*f), where f has the given mantissa, and exponent 0
  79  * Used in combination with softfloat_reciprocal computes x/(double)denom.
  80  * @param x 32bit integer factor
  81  * @param mantissa mantissa of f with exponent 0
  82  * @return 32bit integer value (x*f)
  83  * @see softfloat_reciprocal
  84  */
  85 static uint32_t softfloat_mul(uint32_t x, uint64_t mantissa)
  86 {
  87     uint64_t l = x * (mantissa & 0xffffffff);
  88     uint64_t h = x * (mantissa >> 32);
  89     h += l >> 32;
  90     l &= 0xffffffff;
  91     l += 1 << av_log2(h >> 21);
  92     h += l >> 32;
  93     return h >> 20;
  94 }
  95
  96 static uint8_t lag_calc_zero_run(int8_t x)
  97 {
  98     return (x << 1) ^ (x >> 7);
  99 }
 100
 101 static int lag_decode_prob(GetBitContext *gb, uint32_t *value)
 102 {
 103     static const uint8_t series[] = { 1, 2, 3, 5, 8, 13, 21 };
 104     int i;
 105     int bit     = 0;
 106     int bits    = 0;
 107     int prevbit = 0;
 108     unsigned val;
 109
 110     for (i = 0; i < 7; i++) {
 111         if (prevbit && bit)
 112             break;
 113         prevbit = bit;
 114         bit = get_bits1(gb);
 115         if (bit && !prevbit)
 116             bits += series[i];
 117     }
 118     bits--;
 119     if (bits < 0 || bits > 31) {
 120         *value = 0;
 121         return -1;
 122     } else if (bits == 0) {
 123         *value = 0;
 124         return 0;
 125     }
 126
 127     val  = get_bits_long(gb, bits);
 128     val |= 1 << bits;
 129
 130     *value = val - 1;
 131
 132     return 0;
 133 }
 134
 135 static int lag_read_prob_header(lag_rac *rac, GetBitContext *gb)
 136 {
 137     int i, j, scale_factor;
 138     unsigned prob, cumulative_target;
 139     unsigned cumul_prob = 0;
 140     unsigned scaled_cumul_prob = 0;
 141
 142     rac->prob[0] = 0;
 143     rac->prob[257] = UINT_MAX;
 144     /* Read probabilities from bitstream */
 145     for (i = 1; i < 257; i++) {
 146         if (lag_decode_prob(gb, &rac->prob[i]) < 0) {
 147             av_log(rac->avctx, AV_LOG_ERROR, "Invalid probability encountered.\n");
 148             return -1;
 149         }
 150         if ((uint64_t)cumul_prob + rac->prob[i] > UINT_MAX) {
 151             av_log(rac->avctx, AV_LOG_ERROR, "Integer overflow encountered in cumulative probability calculation.\n");
 152             return -1;
 153         }
 154         cumul_prob += rac->prob[i];
 155         if (!rac->prob[i]) {
 156             if (lag_decode_prob(gb, &prob)) {
 157                 av_log(rac->avctx, AV_LOG_ERROR, "Invalid probability run encountered.\n");
 158                 return -1;
 159             }
 160             if (prob > 257 - i)
 161                 prob = 257 - i;
 162             for (j = 0; j < prob; j++)
 163                 rac->prob[++i] = 0;
 164         }
 165     }
 166
 167     if (!cumul_prob) {
 168         av_log(rac->avctx, AV_LOG_ERROR, "All probabilities are 0!\n");
 169         return -1;
 170     }
 171
 172     /* Scale probabilities so cumulative probability is an even power of 2. */
 173     scale_factor = av_log2(cumul_prob);
 174
 175     if (cumul_prob & (cumul_prob - 1)) {
 176         uint64_t mul = softfloat_reciprocal(cumul_prob);
 177         for (i = 1; i < 257; i++) {
 178             rac->prob[i] = softfloat_mul(rac->prob[i], mul);
 179             scaled_cumul_prob += rac->prob[i];
 180         }
 181
 182         scale_factor++;
 183         cumulative_target = 1 << scale_factor;
 184
 185         if (scaled_cumul_prob > cumulative_target) {
 186             av_log(rac->avctx, AV_LOG_ERROR,
 187                    "Scaled probabilities are larger than target!\n");
 188             return -1;
 189         }
 190
 191         scaled_cumul_prob = cumulative_target - scaled_cumul_prob;
 192
 193         for (i = 1; scaled_cumul_prob; i = (i & 0x7f) + 1) {
 194             if (rac->prob[i]) {
 195                 rac->prob[i]++;
 196                 scaled_cumul_prob--;
 197             }
 198             /* Comment from reference source:
 199              * if (b & 0x80 == 0) {     // order of operations is 'wrong'; it has been left this way
 200              *                          // since the compression change is negligable and fixing it
 201              *                          // breaks backwards compatibilty
 202              *      b =- (signed int)b;
 203              *      b &= 0xFF;
 204              * } else {
 205              *      b++;
 206              *      b &= 0x7f;
 207              * }
 208              */
 209         }
 210     }
 211
 212     rac->scale = scale_factor;
 213
 214     /* Fill probability array with cumulative probability for each symbol. */
 215     for (i = 1; i < 257; i++)
 216         rac->prob[i] += rac->prob[i - 1];
 217
 218     return 0;
 219 }
 220
 221 static void add_lag_median_prediction(uint8_t *dst, uint8_t *src1,
 222                                       uint8_t *diff, int w, int *left,
 223                                       int *left_top)
 224 {
 225     /* This is almost identical to add_hfyu_median_prediction in dsputil.h.
 226      * However the &0xFF on the gradient predictor yealds incorrect output
 227      * for lagarith.
 228      */
 229     int i;
 230     uint8_t l, lt;
 231
 232     l  = *left;
 233     lt = *left_top;
 234
 235     for (i = 0; i < w; i++) {
 236         l = mid_pred(l, src1[i], l + src1[i] - lt) + diff[i];
 237         lt = src1[i];
 238         dst[i] = l;
 239     }
 240
 241     *left     = l;
 242     *left_top = lt;
 243 }
 244
 245 static void lag_pred_line(LagarithContext *l, uint8_t *buf,
 246                           int width, int stride, int line)
 247 {
 248     int L, TL;
 249
 250     if (!line) {
 251         /* Left prediction only for first line */
 252         L = l->dsp.add_hfyu_left_prediction(buf + 1, buf + 1,
 253                                             width - 1, buf[0]);
 254         return;
 255     }
 256     /* Left pixel is actually prev_row[width] */
 257     L = buf[width - stride - 1];
 258     if (line == 1) {
 259         /* Second line, left predict first pixel, the rest of the line is median predicted
 260          * NOTE: In the case of RGB this pixel is top predicted */
 261         TL = l->avctx->pix_fmt == PIX_FMT_YUV420P ? buf[-stride] : L;
 262     } else {
 263         /* Top left is 2 rows back, last pixel */
 264         TL = buf[width - (2 * stride) - 1];
 265     }
 266
 267     add_lag_median_prediction(buf, buf - stride, buf,
 268                               width, &L, &TL);
 269 }
 270
 271 static int lag_decode_line(LagarithContext *l, lag_rac *rac,
 272                            uint8_t *dst, int width, int stride,
 273                            int esc_count)
 274 {
 275     int i = 0;
 276     int ret = 0;
 277
 278     if (!esc_count)
 279         esc_count = -1;
 280
 281     /* Output any zeros remaining from the previous run */
 282 handle_zeros:
 283     if (l->zeros_rem) {
 284         int count = FFMIN(l->zeros_rem, width - i);
 285         memset(dst + i, 0, count);
 286         i += count;
 287         l->zeros_rem -= count;
 288     }
 289
 290     while (i < width) {
 291         dst[i] = lag_get_rac(rac);
 292         ret++;
 293
 294         if (dst[i])
 295             l->zeros = 0;
 296         else
 297             l->zeros++;
 298
 299         i++;
 300         if (l->zeros == esc_count) {
 301             int index = lag_get_rac(rac);
 302             ret++;
 303
 304             l->zeros = 0;
 305
 306             l->zeros_rem = lag_calc_zero_run(index);
 307             goto handle_zeros;
 308         }
 309     }
 310     return ret;
 311 }
 312
 313 static int lag_decode_zero_run_line(LagarithContext *l, uint8_t *dst,
 314                                     const uint8_t *src, int width,
 315                                     int esc_count)
 316 {
 317     int i = 0;
 318     int count;
 319     uint8_t zero_run = 0;
 320     const uint8_t *start = src;
 321     uint8_t mask1 = -(esc_count < 2);
 322     uint8_t mask2 = -(esc_count < 3);
 323     uint8_t *end = dst + (width - 2);
 324
 325 output_zeros:
 326     if (l->zeros_rem) {
 327         count = FFMIN(l->zeros_rem, width - i);
 328         memset(dst, 0, count);
 329         l->zeros_rem -= count;
 330         dst += count;
 331     }
 332
 333     while (dst < end) {
 334         i = 0;
 335         while (!zero_run && dst + i < end) {
 336             i++;
 337             zero_run =
 338                 !(src[i] | (src[i + 1] & mask1) | (src[i + 2] & mask2));
 339         }
 340         if (zero_run) {
 341             zero_run = 0;
 342             i += esc_count;
 343             memcpy(dst, src, i);
 344             dst += i;
 345             l->zeros_rem = lag_calc_zero_run(src[i]);
 346
 347             src += i + 1;
 348             goto output_zeros;
 349         } else {
 350             memcpy(dst, src, i);
 351             src += i;
 352         }
 353     }
 354     return start - src;
 355 }
 356
 357
 358
 359 static int lag_decode_arith_plane(LagarithContext *l, uint8_t *dst,
 360                                   int width, int height, int stride,
 361                                   const uint8_t *src, int src_size)
 362 {
 363     int i = 0;
 364     int read = 0;
 365     uint32_t length;
 366     uint32_t offset = 1;
 367     int esc_count = src[0];
 368     GetBitContext gb;
 369     lag_rac rac;
 370
 371     rac.avctx = l->avctx;
 372     l->zeros = 0;
 373
 374     if (esc_count < 4) {
 375         length = width * height;
 376         if (esc_count && AV_RL32(src + 1) < length) {
 377             length = AV_RL32(src + 1);
 378             offset += 4;
 379         }
 380
 381         init_get_bits(&gb, src + offset, src_size * 8);
 382
 383         if (lag_read_prob_header(&rac, &gb) < 0)
 384             return -1;
 385
 386         ff_lag_rac_init(&rac, &gb, length - stride);
 387
 388         for (i = 0; i < height; i++)
 389             read += lag_decode_line(l, &rac, dst + (i * stride), width,
 390                                     stride, esc_count);
 391
 392         if (read > length)
 393             av_log(l->avctx, AV_LOG_WARNING,
 394                    "Output more bytes than length (%d of %d)\n", read,
 395                    length);
 396     } else if (esc_count < 8) {
 397         esc_count -= 4;
 398         if (esc_count > 0) {
 399             /* Zero run coding only, no range coding. */
 400             for (i = 0; i < height; i++)
 401                 src += lag_decode_zero_run_line(l, dst + (i * stride), src,
 402                                                 width, esc_count);
 403         } else {
 404             /* Plane is stored uncompressed */
 405             for (i = 0; i < height; i++) {
 406                 memcpy(dst + (i * stride), src, width);
 407                 src += width;
 408             }
 409         }
 410     } else if (esc_count == 0xff) {
 411         /* Plane is a solid run of given value */
 412         for (i = 0; i < height; i++)
 413             memset(dst + i * stride, src[1], width);
 414         /* Do not apply prediction.
 415            Note: memset to 0 above, setting first value to src[1]
 416            and applying prediction gives the same result. */
 417         return 0;
 418     } else {
 419         av_log(l->avctx, AV_LOG_ERROR,
 420                "Invalid zero run escape code! (%#x)\n", esc_count);
 421         return -1;
 422     }
 423
 424     for (i = 0; i < height; i++) {
 425         lag_pred_line(l, dst, width, stride, i);
 426         dst += stride;
 427     }
 428
 429     return 0;
 430 }
 431
 432 /**
 433  * Decode a frame.
 434  * @param avctx codec context
 435  * @param data output AVFrame
 436  * @param data_size size of output data or 0 if no picture is returned
 437  * @param avpkt input packet
 438  * @return number of consumed bytes on success or negative if decode fails
 439  */
 440 static int lag_decode_frame(AVCodecContext *avctx,
 441                             void *data, int *data_size, AVPacket *avpkt)
 442 {
 443     const uint8_t *buf = avpkt->data;
 444     int buf_size = avpkt->size;
 445     LagarithContext *l = avctx->priv_data;
 446     AVFrame *const p = &l->picture;
 447     uint8_t frametype = 0;
 448     uint32_t offset_gu = 0, offset_bv = 0, offset_ry = 9;
 449     int offs[4];
 450     uint8_t *srcs[4], *dst;
 451     int i, j, planes = 3;
 452
 453     AVFrame *picture = data;
 454
 455     if (p->data[0])
 456         avctx->release_buffer(avctx, p);
 457
 458     p->reference = 0;
 459     p->key_frame = 1;
 460
 461     frametype = buf[0];
 462
 463     offset_gu = AV_RL32(buf + 1);
 464     offset_bv = AV_RL32(buf + 5);
 465
 466     switch (frametype) {
 467     case FRAME_SOLID_RGBA:
 468         avctx->pix_fmt = PIX_FMT_RGB32;
 469
 470         if (avctx->get_buffer(avctx, p) < 0) {
 471             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 472             return -1;
 473         }
 474
 475         dst = p->data[0];
 476         for (j = 0; j < avctx->height; j++) {
 477             for (i = 0; i < avctx->width; i++)
 478                 AV_WN32(dst + i * 4, offset_gu);
 479             dst += p->linesize[0];
 480         }
 481         break;
 482     case FRAME_ARITH_RGBA:
 483         avctx->pix_fmt = PIX_FMT_RGB32;
 484         planes = 4;
 485         offset_ry += 4;
 486         offs[3] = AV_RL32(buf + 9);
 487     case FRAME_ARITH_RGB24:
 488         if (frametype == FRAME_ARITH_RGB24)
 489             avctx->pix_fmt = PIX_FMT_RGB24;
 490
 491         if (avctx->get_buffer(avctx, p) < 0) {
 492             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 493             return -1;
 494         }
 495
 496         offs[0] = offset_bv;
 497         offs[1] = offset_gu;
 498         offs[2] = offset_ry;
 499
 500         if (!l->rgb_planes) {
 501             l->rgb_stride = FFALIGN(avctx->width, 16);
 502             l->rgb_planes = av_malloc(l->rgb_stride * avctx->height * planes + 16);
 503             if (!l->rgb_planes) {
 504                 av_log(avctx, AV_LOG_ERROR, "cannot allocate temporary buffer\n");
 505                 return AVERROR(ENOMEM);
 506             }
 507         }
 508         for (i = 0; i < planes; i++)
 509             srcs[i] = l->rgb_planes + (i + 1) * l->rgb_stride * avctx->height - l->rgb_stride;
 510         for (i = 0; i < planes; i++)
 511             lag_decode_arith_plane(l, srcs[i],
 512                                    avctx->width, avctx->height,
 513                                    -l->rgb_stride, buf + offs[i],
 514                                    buf_size);
 515         dst = p->data[0];
 516         for (i = 0; i < planes; i++)
 517             srcs[i] = l->rgb_planes + i * l->rgb_stride * avctx->height;
 518         for (j = 0; j < avctx->height; j++) {
 519             for (i = 0; i < avctx->width; i++) {
 520                 uint8_t r, g, b, a;
 521                 r = srcs[0][i];
 522                 g = srcs[1][i];
 523                 b = srcs[2][i];
 524                 r += g;
 525                 b += g;
 526                 if (frametype == FRAME_ARITH_RGBA) {
 527                     a = srcs[3][i];
 528                     AV_WN32(dst + i * 4, MKBETAG(a, r, g, b));
 529                 } else {
 530                     dst[i * 3 + 0] = r;
 531                     dst[i * 3 + 1] = g;
 532                     dst[i * 3 + 2] = b;
 533                 }
 534             }
 535             dst += p->linesize[0];
 536             for (i = 0; i < planes; i++)
 537                 srcs[i] += l->rgb_stride;
 538         }
 539         break;
 540     case FRAME_ARITH_YV12:
 541         avctx->pix_fmt = PIX_FMT_YUV420P;
 542
 543         if (avctx->get_buffer(avctx, p) < 0) {
 544             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 545             return -1;
 546         }
 547
 548         lag_decode_arith_plane(l, p->data[0], avctx->width, avctx->height,
 549                                p->linesize[0], buf + offset_ry,
 550                                buf_size);
 551         lag_decode_arith_plane(l, p->data[2], avctx->width / 2,
 552                                avctx->height / 2, p->linesize[2],
 553                                buf + offset_gu, buf_size);
 554         lag_decode_arith_plane(l, p->data[1], avctx->width / 2,
 555                                avctx->height / 2, p->linesize[1],
 556                                buf + offset_bv, buf_size);
 557         break;
 558     default:
 559         av_log(avctx, AV_LOG_ERROR,
 560                "Unsupported Lagarith frame type: %#x\n", frametype);
 561         return -1;
 562     }
 563
 564     *picture = *p;
 565     *data_size = sizeof(AVFrame);
 566
 567     return buf_size;
 568 }
 569
 570 static av_cold int lag_decode_init(AVCodecContext *avctx)
 571 {
 572     LagarithContext *l = avctx->priv_data;
 573     l->avctx = avctx;
 574
 575     ff_dsputil_init(&l->dsp, avctx);
 576
 577     return 0;
 578 }
 579
 580 static av_cold int lag_decode_end(AVCodecContext *avctx)
 581 {
 582     LagarithContext *l = avctx->priv_data;
 583
 584     if (l->picture.data[0])
 585         avctx->release_buffer(avctx, &l->picture);
 586     av_freep(&l->rgb_planes);
 587
 588     return 0;
 589 }
 590
 591 AVCodec ff_lagarith_decoder = {
 592     .name           = "lagarith",
 593     .type           = AVMEDIA_TYPE_VIDEO,
 594     .id             = CODEC_ID_LAGARITH,
 595     .priv_data_size = sizeof(LagarithContext),
 596     .init           = lag_decode_init,
 597     .close          = lag_decode_end,
 598     .decode         = lag_decode_frame,
 599     .capabilities   = CODEC_CAP_DR1,
 600     .long_name = NULL_IF_CONFIG_SMALL("Lagarith lossless"),
 601 };