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