Support decoding unaligned rgb24 lagarith.
[ffmpeg.git] / 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     } else {
255         /* Left pixel is actually prev_row[width] */
256         L = buf[width - stride - 1];
257
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
272 static int lag_decode_line(LagarithContext *l, lag_rac *rac,
273                            uint8_t *dst, int width, int stride,
274                            int esc_count)
275 {
276     int i = 0;
277     int ret = 0;
278
279     if (!esc_count)
280         esc_count = -1;
281
282     /* Output any zeros remaining from the previous run */
283 handle_zeros:
284     if (l->zeros_rem) {
285         int count = FFMIN(l->zeros_rem, width - i);
286         memset(dst + i, 0, count);
287         i += count;
288         l->zeros_rem -= count;
289     }
290
291     while (i < width) {
292         dst[i] = lag_get_rac(rac);
293         ret++;
294
295         if (dst[i])
296             l->zeros = 0;
297         else
298             l->zeros++;
299
300         i++;
301         if (l->zeros == esc_count) {
302             int index = lag_get_rac(rac);
303             ret++;
304
305             l->zeros = 0;
306
307             l->zeros_rem = lag_calc_zero_run(index);
308             goto handle_zeros;
309         }
310     }
311     return ret;
312 }
313
314 static int lag_decode_zero_run_line(LagarithContext *l, uint8_t *dst,
315                                     const uint8_t *src, const uint8_t *src_end,
316                                     int width, int esc_count)
317 {
318     int i = 0;
319     int count;
320     uint8_t zero_run = 0;
321     const uint8_t *src_start = src;
322     uint8_t mask1 = -(esc_count < 2);
323     uint8_t mask2 = -(esc_count < 3);
324     uint8_t *end = dst + (width - 2);
325
326 output_zeros:
327     if (l->zeros_rem) {
328         count = FFMIN(l->zeros_rem, width - i);
329         if(end - dst < count) {
330             av_log(l->avctx, AV_LOG_ERROR, "too many zeros remaining\n");
331             return AVERROR_INVALIDDATA;
332         }
333         memset(dst, 0, count);
334         l->zeros_rem -= count;
335         dst += count;
336     }
337
338     while (dst < end) {
339         i = 0;
340         while (!zero_run && dst + i < end) {
341             i++;
342             if (i+2 >= src_end - src)
343                 return AVERROR_INVALIDDATA;
344             zero_run =
345                 !(src[i] | (src[i + 1] & mask1) | (src[i + 2] & mask2));
346         }
347         if (zero_run) {
348             zero_run = 0;
349             i += esc_count;
350             memcpy(dst, src, i);
351             dst += i;
352             l->zeros_rem = lag_calc_zero_run(src[i]);
353
354             src += i + 1;
355             goto output_zeros;
356         } else {
357             memcpy(dst, src, i);
358             src += i;
359             dst += i;
360         }
361     }
362     return  src - src_start;
363 }
364
365
366
367 static int lag_decode_arith_plane(LagarithContext *l, uint8_t *dst,
368                                   int width, int height, int stride,
369                                   const uint8_t *src, int src_size)
370 {
371     int i = 0;
372     int read = 0;
373     uint32_t length;
374     uint32_t offset = 1;
375     int esc_count;
376     GetBitContext gb;
377     lag_rac rac;
378     const uint8_t *src_end = src + src_size;
379
380     rac.avctx = l->avctx;
381     l->zeros = 0;
382
383     if(src_size < 2)
384         return AVERROR_INVALIDDATA;
385
386     esc_count = src[0];
387     if (esc_count < 4) {
388         length = width * height;
389         if(src_size < 5)
390             return AVERROR_INVALIDDATA;
391         if (esc_count && AV_RL32(src + 1) < length) {
392             length = AV_RL32(src + 1);
393             offset += 4;
394         }
395
396         init_get_bits(&gb, src + offset, src_size * 8);
397
398         if (lag_read_prob_header(&rac, &gb) < 0)
399             return -1;
400
401         ff_lag_rac_init(&rac, &gb, length - stride);
402
403         for (i = 0; i < height; i++)
404             read += lag_decode_line(l, &rac, dst + (i * stride), width,
405                                     stride, esc_count);
406
407         if (read > length)
408             av_log(l->avctx, AV_LOG_WARNING,
409                    "Output more bytes than length (%d of %d)\n", read,
410                    length);
411     } else if (esc_count < 8) {
412         esc_count -= 4;
413         if (esc_count > 0) {
414             /* Zero run coding only, no range coding. */
415             for (i = 0; i < height; i++) {
416                 int res = lag_decode_zero_run_line(l, dst + (i * stride), src,
417                                                    src_end, width, esc_count);
418                 if (res < 0)
419                     return res;
420                 src += res;
421             }
422         } else {
423             if (src_size < width * height)
424                 return AVERROR_INVALIDDATA; // buffer not big enough
425             /* Plane is stored uncompressed */
426             for (i = 0; i < height; i++) {
427                 memcpy(dst + (i * stride), src, width);
428                 src += width;
429             }
430         }
431     } else if (esc_count == 0xff) {
432         /* Plane is a solid run of given value */
433         for (i = 0; i < height; i++)
434             memset(dst + i * stride, src[1], width);
435         /* Do not apply prediction.
436            Note: memset to 0 above, setting first value to src[1]
437            and applying prediction gives the same result. */
438         return 0;
439     } else {
440         av_log(l->avctx, AV_LOG_ERROR,
441                "Invalid zero run escape code! (%#x)\n", esc_count);
442         return -1;
443     }
444
445     for (i = 0; i < height; i++) {
446         lag_pred_line(l, dst, width, stride, i);
447         dst += stride;
448     }
449
450     return 0;
451 }
452
453 /**
454  * Decode a frame.
455  * @param avctx codec context
456  * @param data output AVFrame
457  * @param data_size size of output data or 0 if no picture is returned
458  * @param avpkt input packet
459  * @return number of consumed bytes on success or negative if decode fails
460  */
461 static int lag_decode_frame(AVCodecContext *avctx,
462                             void *data, int *data_size, AVPacket *avpkt)
463 {
464     const uint8_t *buf = avpkt->data;
465     unsigned int buf_size = avpkt->size;
466     LagarithContext *l = avctx->priv_data;
467     AVFrame *const p = &l->picture;
468     uint8_t frametype = 0;
469     uint32_t offset_gu = 0, offset_bv = 0, offset_ry = 9;
470     int offs[4];
471     uint8_t *srcs[4], *dst;
472     int i, j, planes = 3;
473
474     AVFrame *picture = data;
475
476     if (p->data[0])
477         avctx->release_buffer(avctx, p);
478
479     p->reference = 0;
480     p->key_frame = 1;
481
482     frametype = buf[0];
483
484     offset_gu = AV_RL32(buf + 1);
485     offset_bv = AV_RL32(buf + 5);
486
487     switch (frametype) {
488     case FRAME_SOLID_RGBA:
489         avctx->pix_fmt = PIX_FMT_RGB32;
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         dst = p->data[0];
497         for (j = 0; j < avctx->height; j++) {
498             for (i = 0; i < avctx->width; i++)
499                 AV_WN32(dst + i * 4, offset_gu);
500             dst += p->linesize[0];
501         }
502         break;
503     case FRAME_ARITH_RGBA:
504         avctx->pix_fmt = PIX_FMT_RGB32;
505         planes = 4;
506         offset_ry += 4;
507         offs[3] = AV_RL32(buf + 9);
508     case FRAME_ARITH_RGB24:
509     case FRAME_U_RGB24:
510         if (frametype == FRAME_ARITH_RGB24 || frametype == FRAME_U_RGB24)
511             avctx->pix_fmt = PIX_FMT_RGB24;
512
513         if (avctx->get_buffer(avctx, p) < 0) {
514             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
515             return -1;
516         }
517
518         offs[0] = offset_bv;
519         offs[1] = offset_gu;
520         offs[2] = offset_ry;
521
522         if (!l->rgb_planes) {
523             l->rgb_stride = FFALIGN(avctx->width, 16);
524             l->rgb_planes = av_malloc(l->rgb_stride * avctx->height * planes + 16);
525             if (!l->rgb_planes) {
526                 av_log(avctx, AV_LOG_ERROR, "cannot allocate temporary buffer\n");
527                 return AVERROR(ENOMEM);
528             }
529         }
530         for (i = 0; i < planes; i++)
531             srcs[i] = l->rgb_planes + (i + 1) * l->rgb_stride * avctx->height - l->rgb_stride;
532         for (i = 0; i < planes; i++)
533             if (buf_size <= offs[i]) {
534                 av_log(avctx, AV_LOG_ERROR,
535                         "Invalid frame offsets\n");
536                 return AVERROR_INVALIDDATA;
537             }
538
539         for (i = 0; i < planes; i++)
540             lag_decode_arith_plane(l, srcs[i],
541                                    avctx->width, avctx->height,
542                                    -l->rgb_stride, buf + offs[i],
543                                    buf_size - offs[i]);
544         dst = p->data[0];
545         for (i = 0; i < planes; i++)
546             srcs[i] = l->rgb_planes + i * l->rgb_stride * avctx->height;
547         for (j = 0; j < avctx->height; j++) {
548             for (i = 0; i < avctx->width; i++) {
549                 uint8_t r, g, b, a;
550                 r = srcs[0][i];
551                 g = srcs[1][i];
552                 b = srcs[2][i];
553                 r += g;
554                 b += g;
555                 if (frametype == FRAME_ARITH_RGBA) {
556                     a = srcs[3][i];
557                     AV_WN32(dst + i * 4, MKBETAG(a, r, g, b));
558                 } else {
559                     dst[i * 3 + 0] = r;
560                     dst[i * 3 + 1] = g;
561                     dst[i * 3 + 2] = b;
562                 }
563             }
564             dst += p->linesize[0];
565             for (i = 0; i < planes; i++)
566                 srcs[i] += l->rgb_stride;
567         }
568         break;
569     case FRAME_ARITH_YV12:
570         avctx->pix_fmt = PIX_FMT_YUV420P;
571
572         if (avctx->get_buffer(avctx, p) < 0) {
573             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
574             return -1;
575         }
576         if (buf_size <= offset_ry || buf_size <= offset_gu || buf_size <= offset_bv) {
577             return AVERROR_INVALIDDATA;
578         }
579
580         if (offset_ry >= buf_size ||
581             offset_gu >= buf_size ||
582             offset_bv >= buf_size) {
583             av_log(avctx, AV_LOG_ERROR,
584                    "Invalid frame offsets\n");
585             return AVERROR_INVALIDDATA;
586         }
587
588         lag_decode_arith_plane(l, p->data[0], avctx->width, avctx->height,
589                                p->linesize[0], buf + offset_ry,
590                                buf_size - offset_ry);
591         lag_decode_arith_plane(l, p->data[2], avctx->width / 2,
592                                avctx->height / 2, p->linesize[2],
593                                buf + offset_gu, buf_size - offset_gu);
594         lag_decode_arith_plane(l, p->data[1], avctx->width / 2,
595                                avctx->height / 2, p->linesize[1],
596                                buf + offset_bv, buf_size - offset_bv);
597         break;
598     default:
599         av_log(avctx, AV_LOG_ERROR,
600                "Unsupported Lagarith frame type: %#x\n", frametype);
601         return -1;
602     }
603
604     *picture = *p;
605     *data_size = sizeof(AVFrame);
606
607     return buf_size;
608 }
609
610 static av_cold int lag_decode_init(AVCodecContext *avctx)
611 {
612     LagarithContext *l = avctx->priv_data;
613     l->avctx = avctx;
614
615     ff_dsputil_init(&l->dsp, avctx);
616
617     return 0;
618 }
619
620 static av_cold int lag_decode_end(AVCodecContext *avctx)
621 {
622     LagarithContext *l = avctx->priv_data;
623
624     if (l->picture.data[0])
625         avctx->release_buffer(avctx, &l->picture);
626     av_freep(&l->rgb_planes);
627
628     return 0;
629 }
630
631 AVCodec ff_lagarith_decoder = {
632     .name           = "lagarith",
633     .type           = AVMEDIA_TYPE_VIDEO,
634     .id             = CODEC_ID_LAGARITH,
635     .priv_data_size = sizeof(LagarithContext),
636     .init           = lag_decode_init,
637     .close          = lag_decode_end,
638     .decode         = lag_decode_frame,
639     .capabilities   = CODEC_CAP_DR1,
640     .long_name      = NULL_IF_CONFIG_SMALL("Lagarith lossless"),
641 };