hqx: Implement slice-threaded decoding
[ffmpeg.git] / libavcodec / hqx.c
1 /*
2  * Canopus HQX decoder
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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 /* macroblock selects a group of 4 possible quants and
44  * a block can use any of those four quantisers
45  * one column is powers of 2, the other one is powers of 2 * 3,
46  * then there is the special one, powers of 2 * 5 */
47 static const int hqx_quants[16][4] = {
48     {  0x1,   0x2,   0x4,   0x8 }, {  0x1,  0x3,   0x6,   0xC },
49     {  0x2,   0x4,   0x8,  0x10 }, {  0x3,  0x6,   0xC,  0x18 },
50     {  0x4,   0x8,  0x10,  0x20 }, {  0x6,  0xC,  0x18,  0x30 },
51     {  0x8,  0x10,  0x20,  0x40 },
52                       { 0xA, 0x14, 0x28, 0x50 },
53                                    {  0xC, 0x18,  0x30,  0x60 },
54     { 0x10,  0x20,  0x40,  0x80 }, { 0x18, 0x30,  0x60,  0xC0 },
55     { 0x20,  0x40,  0x80, 0x100 }, { 0x30, 0x60,  0xC0, 0x180 },
56     { 0x40,  0x80, 0x100, 0x200 }, { 0x60, 0xC0, 0x180, 0x300 },
57     { 0x80, 0x100, 0x200, 0x400 }
58 };
59
60 static const uint8_t hqx_quant_luma[64] = {
61     16,  16,  16,  19,  19,  19,  42,  44,
62     16,  16,  19,  19,  19,  38,  43,  45,
63     16,  19,  19,  19,  40,  41,  45,  48,
64     19,  19,  19,  40,  41,  42,  46,  49,
65     19,  19,  40,  41,  42,  43,  48, 101,
66     19,  38,  41,  42,  43,  44,  98, 104,
67     42,  43,  45,  46,  48,  98, 109, 116,
68     44,  45,  48,  49, 101, 104, 116, 123,
69 };
70
71 static const uint8_t hqx_quant_chroma[64] = {
72     16,  16,  19,  25,  26,  26,  42,  44,
73     16,  19,  25,  25,  26,  38,  43,  91,
74     19,  25,  26,  27,  40,  41,  91,  96,
75     25,  25,  27,  40,  41,  84,  93, 197,
76     26,  26,  40,  41,  84,  86, 191, 203,
77     26,  38,  41,  84,  86, 177, 197, 209,
78     42,  43,  91,  93, 191, 197, 219, 232,
79     44,  91,  96, 197, 203, 209, 232, 246,
80 };
81
82 static inline void put_blocks(HQXContext *ctx, int plane,
83                               int x, int y, int ilace,
84                               int16_t *block0, int16_t *block1,
85                               const uint8_t *quant)
86 {
87     int fields = ilace ? 2 : 1;
88     int lsize = ctx->pic->linesize[plane];
89     uint8_t *p = ctx->pic->data[plane] + x * 2;
90
91     ctx->hqxdsp.idct_put((uint16_t *)(p + y * lsize),
92                          lsize * fields, block0, quant);
93     ctx->hqxdsp.idct_put((uint16_t *)(p + (y + (ilace ? 1 : 8)) * lsize),
94                          lsize * fields, block1, quant);
95 }
96
97 static inline void hqx_get_ac(GetBitContext *gb, const HQXAC *ac,
98                               int *run, int *lev)
99 {
100     int val;
101
102     val = show_bits(gb, ac->lut_bits);
103     if (ac->lut[val].bits == -1) {
104         GetBitContext gb2 = *gb;
105         skip_bits(&gb2, ac->lut_bits);
106         val = ac->lut[val].lev + show_bits(&gb2, ac->extra_bits);
107     }
108     *run = ac->lut[val].run;
109     *lev = ac->lut[val].lev;
110     skip_bits(gb, ac->lut[val].bits);
111 }
112
113 static int decode_block(GetBitContext *gb, VLC *vlc,
114                         const int *quants, int dcb,
115                         int16_t block[64], int *last_dc)
116 {
117     int q, dc;
118     int ac_idx;
119     int run, lev, pos = 1;
120
121     memset(block, 0, 64 * sizeof(*block));
122     dc = get_vlc2(gb, vlc->table, HQX_DC_VLC_BITS, 2);
123     if (dc < 0)
124         return AVERROR_INVALIDDATA;
125     *last_dc += dc;
126
127     block[0] = sign_extend(*last_dc << (12 - dcb), 12);
128
129     q = quants[get_bits(gb, 2)];
130     if (q >= 128)
131         ac_idx = HQX_AC_Q128;
132     else if (q >= 64)
133         ac_idx = HQX_AC_Q64;
134     else if (q >= 32)
135         ac_idx = HQX_AC_Q32;
136     else if (q >= 16)
137         ac_idx = HQX_AC_Q16;
138     else if (q >= 8)
139         ac_idx = HQX_AC_Q8;
140     else
141         ac_idx = HQX_AC_Q0;
142
143     do {
144         hqx_get_ac(gb, &ff_hqx_ac[ac_idx], &run, &lev);
145         pos += run;
146         if (pos >= 64)
147             break;
148         block[ff_zigzag_direct[pos++]] = lev * q;
149     } while (pos < 64);
150
151     return 0;
152 }
153
154 static int hqx_decode_422(HQXContext *ctx, int slice_no, int x, int y)
155 {
156     HQXSlice *slice = &ctx->slice[slice_no];
157     GetBitContext *gb = &slice->gb;
158     const int *quants;
159     int flag;
160     int last_dc;
161     int i, ret;
162
163     if (ctx->interlaced)
164         flag = get_bits1(gb);
165     else
166         flag = 0;
167
168     quants = hqx_quants[get_bits(gb, 4)];
169
170     for (i = 0; i < 8; i++) {
171         int vlc_index = ctx->dcb - 9;
172         if (i == 0 || i == 4 || i == 6)
173             last_dc = 0;
174         ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
175                            ctx->dcb, slice->block[i], &last_dc);
176         if (ret < 0)
177             return ret;
178     }
179
180     put_blocks(ctx, 0, x,      y, flag, slice->block[0], slice->block[2], hqx_quant_luma);
181     put_blocks(ctx, 0, x + 8,  y, flag, slice->block[1], slice->block[3], hqx_quant_luma);
182     put_blocks(ctx, 2, x >> 1, y, flag, slice->block[4], slice->block[5], hqx_quant_chroma);
183     put_blocks(ctx, 1, x >> 1, y, flag, slice->block[6], slice->block[7], hqx_quant_chroma);
184
185     return 0;
186 }
187
188 static int hqx_decode_422a(HQXContext *ctx, int slice_no, int x, int y)
189 {
190     HQXSlice *slice = &ctx->slice[slice_no];
191     GetBitContext *gb = &slice->gb;
192     const int *quants;
193     int flag = 0;
194     int last_dc;
195     int i, ret;
196     int cbp;
197
198     cbp = get_vlc2(gb, ctx->cbp_vlc.table, ctx->cbp_vlc.bits, 1);
199
200     for (i = 0; i < 12; i++)
201         memset(slice->block[i], 0, sizeof(**slice->block) * 64);
202     for (i = 0; i < 12; i++)
203         slice->block[i][0] = -0x800;
204     if (cbp) {
205         if (ctx->interlaced)
206             flag = get_bits1(gb);
207
208         quants = hqx_quants[get_bits(gb, 4)];
209
210         cbp |= cbp << 4; // alpha CBP
211         if (cbp & 0x3)   // chroma CBP - top
212             cbp |= 0x500;
213         if (cbp & 0xC)   // chroma CBP - bottom
214             cbp |= 0xA00;
215         for (i = 0; i < 12; i++) {
216             if (i == 0 || i == 4 || i == 8 || i == 10)
217                 last_dc = 0;
218             if (cbp & (1 << i)) {
219                 int vlc_index = ctx->dcb - 9;
220                 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
221                                    ctx->dcb, slice->block[i], &last_dc);
222                 if (ret < 0)
223                     return ret;
224             }
225         }
226     }
227
228     put_blocks(ctx, 3, x,      y, flag, slice->block[ 0], slice->block[ 2], hqx_quant_luma);
229     put_blocks(ctx, 3, x + 8,  y, flag, slice->block[ 1], slice->block[ 3], hqx_quant_luma);
230     put_blocks(ctx, 0, x,      y, flag, slice->block[ 4], slice->block[ 6], hqx_quant_luma);
231     put_blocks(ctx, 0, x + 8,  y, flag, slice->block[ 5], slice->block[ 7], hqx_quant_luma);
232     put_blocks(ctx, 2, x >> 1, y, flag, slice->block[ 8], slice->block[ 9], hqx_quant_chroma);
233     put_blocks(ctx, 1, x >> 1, y, flag, slice->block[10], slice->block[11], hqx_quant_chroma);
234
235     return 0;
236 }
237
238 static int hqx_decode_444(HQXContext *ctx, int slice_no, int x, int y)
239 {
240     HQXSlice *slice = &ctx->slice[slice_no];
241     GetBitContext *gb = &slice->gb;
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->block[i], &last_dc);
260         if (ret < 0)
261             return ret;
262     }
263
264     put_blocks(ctx, 0, x,     y, flag, slice->block[0], slice->block[ 2], hqx_quant_luma);
265     put_blocks(ctx, 0, x + 8, y, flag, slice->block[1], slice->block[ 3], hqx_quant_luma);
266     put_blocks(ctx, 2, x,     y, flag, slice->block[4], slice->block[ 6], hqx_quant_chroma);
267     put_blocks(ctx, 2, x + 8, y, flag, slice->block[5], slice->block[ 7], hqx_quant_chroma);
268     put_blocks(ctx, 1, x,     y, flag, slice->block[8], slice->block[10], hqx_quant_chroma);
269     put_blocks(ctx, 1, x + 8, y, flag, slice->block[9], slice->block[11], hqx_quant_chroma);
270
271     return 0;
272 }
273
274 static int hqx_decode_444a(HQXContext *ctx, int slice_no, int x, int y)
275 {
276     HQXSlice *slice = &ctx->slice[slice_no];
277     GetBitContext *gb = &slice->gb;
278     const int *quants;
279     int flag = 0;
280     int last_dc;
281     int i, ret;
282     int cbp;
283
284     cbp = get_vlc2(gb, ctx->cbp_vlc.table, ctx->cbp_vlc.bits, 1);
285
286     for (i = 0; i < 16; i++)
287         memset(slice->block[i], 0, sizeof(**slice->block) * 64);
288     for (i = 0; i < 16; i++)
289         slice->block[i][0] = -0x800;
290     if (cbp) {
291         if (ctx->interlaced)
292             flag = get_bits1(gb);
293
294         quants = hqx_quants[get_bits(gb, 4)];
295
296         cbp |= cbp << 4; // alpha CBP
297         cbp |= cbp << 8; // chroma CBP
298         for (i = 0; i < 16; i++) {
299             if (i == 0 || i == 4 || i == 8 || i == 12)
300                 last_dc = 0;
301             if (cbp & (1 << i)) {
302                 int vlc_index = ctx->dcb - 9;
303                 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
304                                    ctx->dcb, slice->block[i], &last_dc);
305                 if (ret < 0)
306                     return ret;
307             }
308         }
309     }
310
311     put_blocks(ctx, 3, x,     y, flag, slice->block[ 0], slice->block[ 2], hqx_quant_luma);
312     put_blocks(ctx, 3, x + 8, y, flag, slice->block[ 1], slice->block[ 3], hqx_quant_luma);
313     put_blocks(ctx, 0, x,     y, flag, slice->block[ 4], slice->block[ 6], hqx_quant_luma);
314     put_blocks(ctx, 0, x + 8, y, flag, slice->block[ 5], slice->block[ 7], hqx_quant_luma);
315     put_blocks(ctx, 2, x,     y, flag, slice->block[ 8], slice->block[10], hqx_quant_chroma);
316     put_blocks(ctx, 2, x + 8, y, flag, slice->block[ 9], slice->block[11], hqx_quant_chroma);
317     put_blocks(ctx, 1, x,     y, flag, slice->block[12], slice->block[14], hqx_quant_chroma);
318     put_blocks(ctx, 1, x + 8, y, flag, slice->block[13], slice->block[15], hqx_quant_chroma);
319
320     return 0;
321 }
322
323 static const int shuffle_16[16] = {
324     0, 5, 11, 14, 2, 7, 9, 13, 1, 4, 10, 15, 3, 6, 8, 12
325 };
326
327 static int decode_slice(HQXContext *ctx, int slice_no)
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             ctx->decode_func(ctx, slice_no, mb_x * 16, mb_y * 16);
374         }
375     }
376
377     return 0;
378 }
379
380 static int decode_slice_thread(AVCodecContext *avctx, void *arg,
381                                int slice_no, int threadnr)
382 {
383     HQXContext *ctx = avctx->priv_data;
384     uint32_t *slice_off = ctx->slice_off;
385     int ret;
386
387     if (slice_off[slice_no] < HQX_HEADER_SIZE ||
388         slice_off[slice_no] >= slice_off[slice_no + 1] ||
389         slice_off[slice_no + 1] > ctx->data_size) {
390         av_log(avctx, AV_LOG_ERROR, "Invalid slice size %d.\n", ctx->data_size);
391         return AVERROR_INVALIDDATA;
392     }
393
394     ret = init_get_bits8(&ctx->slice[slice_no].gb,
395                          ctx->src + slice_off[slice_no],
396                          slice_off[slice_no + 1] - slice_off[slice_no]);
397     if (ret < 0)
398         return ret;
399
400     return decode_slice(ctx, slice_no);
401 }
402
403 static int hqx_decode_frame(AVCodecContext *avctx, void *data,
404                             int *got_picture_ptr, AVPacket *avpkt)
405 {
406     HQXContext *ctx = avctx->priv_data;
407     uint8_t *src = avpkt->data;
408     uint32_t info_tag, info_offset;
409     int data_start;
410     int i, ret;
411
412     if (avpkt->size < 8)
413         return AVERROR_INVALIDDATA;
414
415     /* Skip the INFO header if present */
416     info_offset = 0;
417     info_tag    = AV_RL32(src);
418     if (info_tag == MKTAG('I', 'N', 'F', 'O')) {
419         info_offset = AV_RL32(src + 4);
420         if (info_offset > UINT32_MAX - 8 || info_offset + 8 > avpkt->size) {
421             av_log(avctx, AV_LOG_ERROR,
422                    "Invalid INFO header offset: 0x%08"PRIX32" is too large.\n",
423                    info_offset);
424             return AVERROR_INVALIDDATA;
425         }
426
427         info_offset += 8;
428         src         += info_offset;
429
430         av_log(avctx, AV_LOG_DEBUG, "Skipping INFO chunk.\n");
431     }
432
433     data_start     = src - avpkt->data;
434     ctx->data_size = avpkt->size - data_start;
435     ctx->src       = src;
436     ctx->pic       = data;
437
438     if (ctx->data_size < HQX_HEADER_SIZE) {
439         av_log(avctx, AV_LOG_ERROR, "Frame too small.\n");
440         return AVERROR_INVALIDDATA;
441     }
442
443     if (src[0] != 'H' || src[1] != 'Q') {
444         av_log(avctx, AV_LOG_ERROR, "Not an HQX frame.\n");
445         return AVERROR_INVALIDDATA;
446     }
447     ctx->interlaced = !(src[2] & 0x80);
448     ctx->format     = src[2] & 7;
449     ctx->dcb        = (src[3] & 3) + 8;
450     ctx->width      = AV_RB16(src + 4);
451     ctx->height     = AV_RB16(src + 6);
452     for (i = 0; i < 17; i++)
453         ctx->slice_off[i] = AV_RB24(src + 8 + i * 3);
454
455     if (ctx->dcb == 8) {
456         av_log(avctx, AV_LOG_ERROR, "Invalid DC precision %d.\n", ctx->dcb);
457         return AVERROR_INVALIDDATA;
458     }
459     ret = av_image_check_size(ctx->width, ctx->height, 0, avctx);
460     if (ret < 0) {
461         av_log(avctx, AV_LOG_ERROR, "Invalid stored dimenstions %dx%d.\n",
462                ctx->width, ctx->height);
463         return AVERROR_INVALIDDATA;
464     }
465
466     avctx->coded_width         = FFALIGN(ctx->width,  16);
467     avctx->coded_height        = FFALIGN(ctx->height, 16);
468     avctx->width               = ctx->width;
469     avctx->height              = ctx->height;
470     avctx->bits_per_raw_sample = 10;
471
472     switch (ctx->format) {
473     case HQX_422:
474         avctx->pix_fmt = AV_PIX_FMT_YUV422P16;
475         ctx->decode_func = hqx_decode_422;
476         break;
477     case HQX_444:
478         avctx->pix_fmt = AV_PIX_FMT_YUV444P16;
479         ctx->decode_func = hqx_decode_444;
480         break;
481     case HQX_422A:
482         avctx->pix_fmt = AV_PIX_FMT_YUVA422P16;
483         ctx->decode_func = hqx_decode_422a;
484         break;
485     case HQX_444A:
486         avctx->pix_fmt = AV_PIX_FMT_YUVA444P16;
487         ctx->decode_func = hqx_decode_444a;
488         break;
489     default:
490         av_log(avctx, AV_LOG_ERROR, "Invalid format: %d.\n", ctx->format);
491         return AVERROR_INVALIDDATA;
492     }
493
494     ret = ff_get_buffer(avctx, ctx->pic, 0);
495     if (ret < 0) {
496         av_log(avctx, AV_LOG_ERROR, "Could not allocate buffer.\n");
497         return ret;
498     }
499
500     avctx->execute2(avctx, decode_slice_thread, NULL, NULL, 16);
501
502     ctx->pic->key_frame = 1;
503     ctx->pic->pict_type = AV_PICTURE_TYPE_I;
504
505     *got_picture_ptr = 1;
506
507     return avpkt->size;
508 }
509
510 static av_cold int hqx_decode_close(AVCodecContext *avctx)
511 {
512     int i;
513     HQXContext *ctx = avctx->priv_data;
514
515     ff_free_vlc(&ctx->cbp_vlc);
516     for (i = 0; i < 3; i++) {
517         ff_free_vlc(&ctx->dc_vlc[i]);
518     }
519
520     return 0;
521 }
522
523 static av_cold int hqx_decode_init(AVCodecContext *avctx)
524 {
525     HQXContext *ctx = avctx->priv_data;
526     int ret = ff_hqx_init_vlcs(ctx);
527     if (ret < 0)
528         hqx_decode_close(avctx);
529
530     ff_hqxdsp_init(&ctx->hqxdsp);
531
532     return ret;
533 }
534
535 AVCodec ff_hqx_decoder = {
536     .name           = "hqx",
537     .long_name      = NULL_IF_CONFIG_SMALL("Canopus HQX"),
538     .type           = AVMEDIA_TYPE_VIDEO,
539     .id             = AV_CODEC_ID_HQX,
540     .priv_data_size = sizeof(HQXContext),
541     .init           = hqx_decode_init,
542     .decode         = hqx_decode_frame,
543     .close          = hqx_decode_close,
544     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_SLICE_THREADS,
545 };