Merge commit 'ea031b75fb50c59196ccb654c9d143fb75365da9'
[ffmpeg.git] / libavcodec / hqx.c
1 /*
2  * Canopus HQX decoder
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include <inttypes.h>
22
23 #include "libavutil/imgutils.h"
24 #include "libavutil/intreadwrite.h"
25
26 #include "avcodec.h"
27 #include "get_bits.h"
28 #include "internal.h"
29
30 #include "hqx.h"
31 #include "hqxdsp.h"
32
33 /* HQX has four modes - 422, 444, 422alpha and 444alpha - all 12-bit */
34 enum HQXFormat {
35     HQX_422 = 0,
36     HQX_444,
37     HQX_422A,
38     HQX_444A,
39 };
40
41 #define HQX_HEADER_SIZE 59
42
43 typedef int (*mb_decode_func)(HQXContext *ctx, HQXSliceData * slice_data, AVFrame *pic,
44                               GetBitContext *gb, int x, int y);
45
46 /* macroblock selects a group of 4 possible quants and
47  * a block can use any of those four quantisers
48  * one column is powers of 2, the other one is powers of 2 * 3,
49  * then there is the special one, powers of 2 * 5 */
50 static const int hqx_quants[16][4] = {
51     {  0x1,   0x2,   0x4,   0x8 }, {  0x1,  0x3,   0x6,   0xC },
52     {  0x2,   0x4,   0x8,  0x10 }, {  0x3,  0x6,   0xC,  0x18 },
53     {  0x4,   0x8,  0x10,  0x20 }, {  0x6,  0xC,  0x18,  0x30 },
54     {  0x8,  0x10,  0x20,  0x40 },
55                       { 0xA, 0x14, 0x28, 0x50 },
56                                    {  0xC, 0x18,  0x30,  0x60 },
57     { 0x10,  0x20,  0x40,  0x80 }, { 0x18, 0x30,  0x60,  0xC0 },
58     { 0x20,  0x40,  0x80, 0x100 }, { 0x30, 0x60,  0xC0, 0x180 },
59     { 0x40,  0x80, 0x100, 0x200 }, { 0x60, 0xC0, 0x180, 0x300 },
60     { 0x80, 0x100, 0x200, 0x400 }
61 };
62
63 static const uint8_t hqx_quant_luma[64] = {
64     16,  16,  16,  19,  19,  19,  42,  44,
65     16,  16,  19,  19,  19,  38,  43,  45,
66     16,  19,  19,  19,  40,  41,  45,  48,
67     19,  19,  19,  40,  41,  42,  46,  49,
68     19,  19,  40,  41,  42,  43,  48, 101,
69     19,  38,  41,  42,  43,  44,  98, 104,
70     42,  43,  45,  46,  48,  98, 109, 116,
71     44,  45,  48,  49, 101, 104, 116, 123,
72 };
73
74 static const uint8_t hqx_quant_chroma[64] = {
75     16,  16,  19,  25,  26,  26,  42,  44,
76     16,  19,  25,  25,  26,  38,  43,  91,
77     19,  25,  26,  27,  40,  41,  91,  96,
78     25,  25,  27,  40,  41,  84,  93, 197,
79     26,  26,  40,  41,  84,  86, 191, 203,
80     26,  38,  41,  84,  86, 177, 197, 209,
81     42,  43,  91,  93, 191, 197, 219, 232,
82     44,  91,  96, 197, 203, 209, 232, 246,
83 };
84
85 static inline void put_blocks(HQXContext *ctx, AVFrame *pic, int plane,
86                               int x, int y, int ilace,
87                               int16_t *block0, int16_t *block1,
88                               const uint8_t *quant)
89 {
90     int fields = ilace ? 2 : 1;
91     int lsize = pic->linesize[plane];
92     uint8_t *p = pic->data[plane] + x * 2;
93
94     ctx->hqxdsp.idct_put((uint16_t *)(p + y * lsize),
95                          lsize * fields, block0, quant);
96     ctx->hqxdsp.idct_put((uint16_t *)(p + (y + (ilace ? 1 : 8)) * lsize),
97                          lsize * fields, block1, quant);
98 }
99
100 static inline void hqx_get_ac(GetBitContext *gb, const HQXAC *ac,
101                               int *run, int *lev)
102 {
103     int val;
104
105     val = show_bits(gb, ac->lut_bits);
106     if (ac->lut[val].bits == -1) {
107         GetBitContext gb2 = *gb;
108         skip_bits(&gb2, ac->lut_bits);
109         val = ac->lut[val].lev + show_bits(&gb2, ac->extra_bits);
110     }
111     *run = ac->lut[val].run;
112     *lev = ac->lut[val].lev;
113     skip_bits(gb, ac->lut[val].bits);
114 }
115
116 static int decode_block(GetBitContext *gb, VLC *vlc,
117                         const int *quants, int dcb,
118                         int16_t block[64], int *last_dc)
119 {
120     int q, dc;
121     int ac_idx;
122     int run, lev, pos = 1;
123
124     memset(block, 0, 64 * sizeof(*block));
125     dc = get_vlc2(gb, vlc->table, HQX_DC_VLC_BITS, 2);
126     if (dc < 0)
127         return AVERROR_INVALIDDATA;
128     *last_dc += dc;
129
130     block[0] = sign_extend(*last_dc << (12 - dcb), 12);
131
132     q = quants[get_bits(gb, 2)];
133     if (q >= 128)
134         ac_idx = HQX_AC_Q128;
135     else if (q >= 64)
136         ac_idx = HQX_AC_Q64;
137     else if (q >= 32)
138         ac_idx = HQX_AC_Q32;
139     else if (q >= 16)
140         ac_idx = HQX_AC_Q16;
141     else if (q >= 8)
142         ac_idx = HQX_AC_Q8;
143     else
144         ac_idx = HQX_AC_Q0;
145
146     do {
147         hqx_get_ac(gb, &ff_hqx_ac[ac_idx], &run, &lev);
148         pos += run;
149         if (pos >= 64)
150             break;
151         block[ff_zigzag_direct[pos++]] = lev * q;
152     } while (pos < 64);
153
154     return 0;
155 }
156
157 static int hqx_decode_422(HQXContext *ctx, HQXSliceData * slice_data, AVFrame *pic,
158                           GetBitContext *gb, int x, int y)
159 {
160     const int *quants;
161     int flag;
162     int last_dc;
163     int i, ret;
164
165     if (ctx->interlaced)
166         flag = get_bits1(gb);
167     else
168         flag = 0;
169
170     quants = hqx_quants[get_bits(gb, 4)];
171
172     for (i = 0; i < 8; i++) {
173         int vlc_index = ctx->dcb - 9;
174         if (i == 0 || i == 4 || i == 6)
175             last_dc = 0;
176         ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
177                            ctx->dcb, slice_data->block[i], &last_dc);
178         if (ret < 0)
179             return ret;
180     }
181
182     put_blocks(ctx, pic, 0, x     , y, flag, slice_data->block[0], slice_data->block[2], hqx_quant_luma);
183     put_blocks(ctx, pic, 0, x + 8 , y, flag, slice_data->block[1], slice_data->block[3], hqx_quant_luma);
184     put_blocks(ctx, pic, 2, x >> 1, y, flag, slice_data->block[4], slice_data->block[5], hqx_quant_chroma);
185     put_blocks(ctx, pic, 1, x >> 1, y, flag, slice_data->block[6], slice_data->block[7], hqx_quant_chroma);
186
187     return 0;
188 }
189
190 static int hqx_decode_422a(HQXContext *ctx, HQXSliceData * slice_data, AVFrame *pic,
191                            GetBitContext *gb, int x, int y)
192 {
193     const int *quants;
194     int flag = 0;
195     int last_dc;
196     int i, ret;
197     int cbp;
198
199     cbp = get_vlc2(gb, ctx->cbp_vlc.table, ctx->cbp_vlc.bits, 1);
200
201     for (i = 0; i < 12; i++)
202         memset(slice_data->block[i], 0, sizeof(**slice_data->block) * 64);
203     for (i = 0; i < 12; i++)
204         slice_data->block[i][0] = -0x800;
205     if (cbp) {
206         if (ctx->interlaced)
207             flag = get_bits1(gb);
208
209         quants = hqx_quants[get_bits(gb, 4)];
210
211         cbp |= cbp << 4; // alpha CBP
212         if (cbp & 0x3)   // chroma CBP - top
213             cbp |= 0x500;
214         if (cbp & 0xC)   // chroma CBP - bottom
215             cbp |= 0xA00;
216         for (i = 0; i < 12; i++) {
217             if (i == 0 || i == 4 || i == 8 || i == 10)
218                 last_dc = 0;
219             if (cbp & (1 << i)) {
220                 int vlc_index = ctx->dcb - 9;
221                 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
222                                    ctx->dcb, slice_data->block[i], &last_dc);
223                 if (ret < 0)
224                     return ret;
225             }
226         }
227     }
228
229     put_blocks(ctx, pic, 3, x,      y, flag, slice_data->block[ 0], slice_data->block[ 2], hqx_quant_luma);
230     put_blocks(ctx, pic, 3, x + 8,  y, flag, slice_data->block[ 1], slice_data->block[ 3], hqx_quant_luma);
231     put_blocks(ctx, pic, 0, x,      y, flag, slice_data->block[ 4], slice_data->block[ 6], hqx_quant_luma);
232     put_blocks(ctx, pic, 0, x + 8,  y, flag, slice_data->block[ 5], slice_data->block[ 7], hqx_quant_luma);
233     put_blocks(ctx, pic, 2, x >> 1, y, flag, slice_data->block[ 8], slice_data->block[ 9], hqx_quant_chroma);
234     put_blocks(ctx, pic, 1, x >> 1, y, flag, slice_data->block[10], slice_data->block[11], hqx_quant_chroma);
235
236     return 0;
237 }
238
239 static int hqx_decode_444(HQXContext *ctx, HQXSliceData * slice_data, AVFrame *pic,
240                           GetBitContext *gb, int x, int y)
241 {
242     const int *quants;
243     int flag;
244     int last_dc;
245     int i, ret;
246
247     if (ctx->interlaced)
248         flag = get_bits1(gb);
249     else
250         flag = 0;
251
252     quants = hqx_quants[get_bits(gb, 4)];
253
254     for (i = 0; i < 12; i++) {
255         int vlc_index = ctx->dcb - 9;
256         if (i == 0 || i == 4 || i == 8)
257             last_dc = 0;
258         ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
259                            ctx->dcb, slice_data->block[i], &last_dc);
260         if (ret < 0)
261             return ret;
262     }
263
264     put_blocks(ctx, pic, 0, x,     y, flag, slice_data->block[0], slice_data->block[ 2], hqx_quant_luma);
265     put_blocks(ctx, pic, 0, x + 8, y, flag, slice_data->block[1], slice_data->block[ 3], hqx_quant_luma);
266     put_blocks(ctx, pic, 2, x,     y, flag, slice_data->block[4], slice_data->block[ 6], hqx_quant_chroma);
267     put_blocks(ctx, pic, 2, x + 8, y, flag, slice_data->block[5], slice_data->block[ 7], hqx_quant_chroma);
268     put_blocks(ctx, pic, 1, x,     y, flag, slice_data->block[8], slice_data->block[10], hqx_quant_chroma);
269     put_blocks(ctx, pic, 1, x + 8, y, flag, slice_data->block[9], slice_data->block[11], hqx_quant_chroma);
270
271     return 0;
272 }
273
274 static int hqx_decode_444a(HQXContext *ctx, HQXSliceData * slice_data, AVFrame *pic,
275                            GetBitContext *gb, int x, int y)
276 {
277     const int *quants;
278     int flag = 0;
279     int last_dc;
280     int i, ret;
281     int cbp;
282
283     cbp = get_vlc2(gb, ctx->cbp_vlc.table, ctx->cbp_vlc.bits, 1);
284
285     for (i = 0; i < 16; i++)
286         memset(slice_data->block[i], 0, sizeof(**slice_data->block) * 64);
287     for (i = 0; i < 16; i++)
288         slice_data->block[i][0] = -0x800;
289     if (cbp) {
290         if (ctx->interlaced)
291             flag = get_bits1(gb);
292
293         quants = hqx_quants[get_bits(gb, 4)];
294
295         cbp |= cbp << 4; // alpha CBP
296         cbp |= cbp << 8; // chroma CBP
297         for (i = 0; i < 16; i++) {
298             if (i == 0 || i == 4 || i == 8 || i == 12)
299                 last_dc = 0;
300             if (cbp & (1 << i)) {
301                 int vlc_index = ctx->dcb - 9;
302                 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
303                                    ctx->dcb, slice_data->block[i], &last_dc);
304                 if (ret < 0)
305                     return ret;
306             }
307         }
308     }
309
310     put_blocks(ctx, pic, 3, x,     y, flag, slice_data->block[ 0], slice_data->block[ 2], hqx_quant_luma);
311     put_blocks(ctx, pic, 3, x + 8, y, flag, slice_data->block[ 1], slice_data->block[ 3], hqx_quant_luma);
312     put_blocks(ctx, pic, 0, x,     y, flag, slice_data->block[ 4], slice_data->block[ 6], hqx_quant_luma);
313     put_blocks(ctx, pic, 0, x + 8, y, flag, slice_data->block[ 5], slice_data->block[ 7], hqx_quant_luma);
314     put_blocks(ctx, pic, 2, x,     y, flag, slice_data->block[ 8], slice_data->block[10], hqx_quant_chroma);
315     put_blocks(ctx, pic, 2, x + 8, y, flag, slice_data->block[ 9], slice_data->block[11], hqx_quant_chroma);
316     put_blocks(ctx, pic, 1, x,     y, flag, slice_data->block[12], slice_data->block[14], hqx_quant_chroma);
317     put_blocks(ctx, pic, 1, x + 8, y, flag, slice_data->block[13], slice_data->block[15], hqx_quant_chroma);
318
319     return 0;
320 }
321
322 static const int shuffle_16[16] = {
323     0, 5, 11, 14, 2, 7, 9, 13, 1, 4, 10, 15, 3, 6, 8, 12
324 };
325
326 static int decode_slice(HQXContext *ctx, AVFrame *pic, GetBitContext *gb,
327                         int slice_no, mb_decode_func decode_func)
328 {
329     int mb_w = (ctx->width  + 15) >> 4;
330     int mb_h = (ctx->height + 15) >> 4;
331     int grp_w = (mb_w + 4) / 5;
332     int grp_h = (mb_h + 4) / 5;
333     int grp_h_edge = grp_w * (mb_w / grp_w);
334     int grp_v_edge = grp_h * (mb_h / grp_h);
335     int grp_v_rest = mb_w - grp_h_edge;
336     int grp_h_rest = mb_h - grp_v_edge;
337     int num_mbs = mb_w * mb_h;
338     int num_tiles = (num_mbs + 479) / 480;
339     int std_tile_blocks = num_mbs / (16 * num_tiles);
340     int g_tile = slice_no * num_tiles;
341     int blk_addr, loc_addr, mb_x, mb_y, pos, loc_row, i;
342     int tile_blocks, tile_limit, tile_no;
343
344     for (tile_no = 0; tile_no < num_tiles; tile_no++, g_tile++) {
345         tile_blocks = std_tile_blocks;
346         tile_limit = -1;
347         if (g_tile < num_mbs - std_tile_blocks * 16 * num_tiles) {
348             tile_limit = num_mbs / (16 * num_tiles);
349             tile_blocks++;
350         }
351         for (i = 0; i < tile_blocks; i++) {
352             if (i == tile_limit)
353                 blk_addr = g_tile + 16 * num_tiles * i;
354             else
355                 blk_addr = tile_no + 16 * num_tiles * i +
356                            num_tiles * shuffle_16[(i + slice_no) & 0xF];
357             loc_row  = grp_h * (blk_addr / (grp_h * mb_w));
358             loc_addr =          blk_addr % (grp_h * mb_w);
359             if (loc_row >= grp_v_edge) {
360                 mb_x = grp_w * (loc_addr / (grp_h_rest * grp_w));
361                 pos  =          loc_addr % (grp_h_rest * grp_w);
362             } else {
363                 mb_x = grp_w * (loc_addr / (grp_h * grp_w));
364                 pos  =          loc_addr % (grp_h * grp_w);
365             }
366             if (mb_x >= grp_h_edge) {
367                 mb_x +=            pos % grp_v_rest;
368                 mb_y  = loc_row + (pos / grp_v_rest);
369             } else {
370                 mb_x +=            pos % grp_w;
371                 mb_y  = loc_row + (pos / grp_w);
372             }
373             decode_func(ctx, &ctx->slice[slice_no], pic, gb, mb_x * 16, mb_y * 16);
374         }
375     }
376
377     return 0;
378 }
379
380 typedef struct {
381     AVFrame *pic;
382     uint8_t *src;
383     GetBitContext gb[17];
384     unsigned data_size;
385     mb_decode_func decode_func;
386     uint32_t slice_off[17];
387 } Data;
388
389 static int decode_slice_thread(AVCodecContext *avctx, void *arg, int slice, int threadnr)
390 {
391     Data * data = (Data*) arg;
392     uint32_t * slice_off = data->slice_off;
393     unsigned data_size = data->data_size;
394     HQXContext *ctx = avctx->priv_data;
395     int ret;
396
397     if (slice_off[slice] < HQX_HEADER_SIZE ||
398         slice_off[slice] >= slice_off[slice + 1] ||
399         slice_off[slice + 1] > data_size) {
400         av_log(avctx, AV_LOG_ERROR, "Invalid slice size.\n");
401         return AVERROR_INVALIDDATA;
402     }
403
404     ret = init_get_bits8(&data->gb[slice], data->src + slice_off[slice], slice_off[slice + 1] - slice_off[slice]);
405     if (ret < 0)
406         return ret;
407
408     ret = decode_slice(ctx, data->pic, &data->gb[slice], slice, data->decode_func);
409     if (ret < 0) {
410         av_log(avctx, AV_LOG_ERROR, "Error decoding slice %d.\n", slice);
411     }
412     return ret;
413 }
414
415 static int hqx_decode_frame(AVCodecContext *avctx, void *data,
416                             int *got_picture_ptr, AVPacket *avpkt)
417 {
418     HQXContext *ctx = avctx->priv_data;
419     AVFrame *pic = data;
420     uint8_t *src = avpkt->data;
421     uint32_t info_tag, info_offset;
422     int data_start;
423     int i, ret;
424     Data arg_data;
425     arg_data.decode_func = 0;
426
427     if (avpkt->size < 8)
428         return AVERROR_INVALIDDATA;
429
430     /* Skip the INFO header if present */
431     info_offset = 0;
432     info_tag    = AV_RL32(src);
433     if (info_tag == MKTAG('I', 'N', 'F', 'O')) {
434         info_offset = AV_RL32(src + 4);
435         if (info_offset > UINT32_MAX - 8 || info_offset + 8 > avpkt->size) {
436             av_log(avctx, AV_LOG_ERROR,
437                    "Invalid INFO header offset: 0x%08"PRIX32" is too large.\n",
438                    info_offset);
439             return AVERROR_INVALIDDATA;
440         }
441
442         info_offset += 8;
443         src         += info_offset;
444
445         av_log(avctx, AV_LOG_DEBUG, "Skipping INFO chunk.\n");
446     }
447
448     data_start = src - avpkt->data;
449     arg_data.src = src;
450     arg_data.pic = data;
451     arg_data.data_size = avpkt->size - data_start;
452
453     if (arg_data.data_size < HQX_HEADER_SIZE) {
454         av_log(avctx, AV_LOG_ERROR, "Frame too small.\n");
455         return AVERROR_INVALIDDATA;
456     }
457
458     if (src[0] != 'H' || src[1] != 'Q') {
459         av_log(avctx, AV_LOG_ERROR, "Not an HQX frame.\n");
460         return AVERROR_INVALIDDATA;
461     }
462     ctx->interlaced = !(src[2] & 0x80);
463     ctx->format     = src[2] & 7;
464     ctx->dcb        = (src[3] & 3) + 8;
465     ctx->width      = AV_RB16(src + 4);
466     ctx->height     = AV_RB16(src + 6);
467     for (i = 0; i < 17; i++)
468         arg_data.slice_off[i] = AV_RB24(src + 8 + i * 3);
469
470     if (ctx->dcb == 8) {
471         av_log(avctx, AV_LOG_ERROR, "Invalid DC precision %d.\n", ctx->dcb);
472         return AVERROR_INVALIDDATA;
473     }
474     ret = av_image_check_size(ctx->width, ctx->height, 0, avctx);
475     if (ret < 0) {
476         av_log(avctx, AV_LOG_ERROR, "Invalid stored dimensions %dx%d.\n",
477                ctx->width, ctx->height);
478         return AVERROR_INVALIDDATA;
479     }
480
481     avctx->coded_width         = FFALIGN(ctx->width,  16);
482     avctx->coded_height        = FFALIGN(ctx->height, 16);
483     avctx->width               = ctx->width;
484     avctx->height              = ctx->height;
485     avctx->bits_per_raw_sample = 10;
486
487     switch (ctx->format) {
488     case HQX_422:
489         avctx->pix_fmt = AV_PIX_FMT_YUV422P16;
490         arg_data.decode_func = hqx_decode_422;
491         break;
492     case HQX_444:
493         avctx->pix_fmt = AV_PIX_FMT_YUV444P16;
494         arg_data.decode_func = hqx_decode_444;
495         break;
496     case HQX_422A:
497         avctx->pix_fmt = AV_PIX_FMT_YUVA422P16;
498         arg_data.decode_func = hqx_decode_422a;
499         break;
500     case HQX_444A:
501         avctx->pix_fmt = AV_PIX_FMT_YUVA444P16;
502         arg_data.decode_func = hqx_decode_444a;
503         break;
504     default:
505         av_log(avctx, AV_LOG_ERROR, "Invalid format: %d.\n", ctx->format);
506         return AVERROR_INVALIDDATA;
507     }
508
509     ret = ff_get_buffer(avctx, pic, 0);
510     if (ret < 0)
511         return ret;
512
513
514     avctx->execute2(avctx, decode_slice_thread, &arg_data, NULL, 16);
515
516     pic->key_frame = 1;
517     pic->pict_type = AV_PICTURE_TYPE_I;
518
519     *got_picture_ptr = 1;
520
521     return avpkt->size;
522 }
523
524 static av_cold int hqx_decode_close(AVCodecContext *avctx)
525 {
526     int i;
527     HQXContext *ctx = avctx->priv_data;
528
529     ff_free_vlc(&ctx->cbp_vlc);
530     for (i = 0; i < 3; i++) {
531         ff_free_vlc(&ctx->dc_vlc[i]);
532     }
533
534     return 0;
535 }
536
537 static av_cold int hqx_decode_init(AVCodecContext *avctx)
538 {
539     HQXContext *ctx = avctx->priv_data;
540     int ret = ff_hqx_init_vlcs(ctx);
541     if (ret < 0)
542         hqx_decode_close(avctx);
543
544     ff_hqxdsp_init(&ctx->hqxdsp);
545
546     return ret;
547 }
548
549 AVCodec ff_hqx_decoder = {
550     .name           = "hqx",
551     .long_name      = NULL_IF_CONFIG_SMALL("Canopus HQX"),
552     .type           = AVMEDIA_TYPE_VIDEO,
553     .id             = AV_CODEC_ID_HQX,
554     .priv_data_size = sizeof(HQXContext),
555     .init           = hqx_decode_init,
556     .decode         = hqx_decode_frame,
557     .close          = hqx_decode_close,
558     .capabilities = CODEC_CAP_DR1 | CODEC_CAP_SLICE_THREADS,
559 };