4 * This file is part of FFmpeg.
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.
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.
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
23 #include "libavutil/imgutils.h"
24 #include "libavutil/intreadwrite.h"
35 /* HQX has four modes - 422, 444, 422alpha and 444alpha - all 12-bit */
43 #define HQX_HEADER_SIZE 59
45 /* macroblock selects a group of 4 possible quants and
46 * a block can use any of those four quantisers
47 * one column is powers of 2, the other one is powers of 2 * 3,
48 * then there is the special one, powers of 2 * 5 */
49 static const int hqx_quants[16][4] = {
50 { 0x1, 0x2, 0x4, 0x8 }, { 0x1, 0x3, 0x6, 0xC },
51 { 0x2, 0x4, 0x8, 0x10 }, { 0x3, 0x6, 0xC, 0x18 },
52 { 0x4, 0x8, 0x10, 0x20 }, { 0x6, 0xC, 0x18, 0x30 },
53 { 0x8, 0x10, 0x20, 0x40 },
54 { 0xA, 0x14, 0x28, 0x50 },
55 { 0xC, 0x18, 0x30, 0x60 },
56 { 0x10, 0x20, 0x40, 0x80 }, { 0x18, 0x30, 0x60, 0xC0 },
57 { 0x20, 0x40, 0x80, 0x100 }, { 0x30, 0x60, 0xC0, 0x180 },
58 { 0x40, 0x80, 0x100, 0x200 }, { 0x60, 0xC0, 0x180, 0x300 },
59 { 0x80, 0x100, 0x200, 0x400 }
62 static const uint8_t hqx_quant_luma[64] = {
63 16, 16, 16, 19, 19, 19, 42, 44,
64 16, 16, 19, 19, 19, 38, 43, 45,
65 16, 19, 19, 19, 40, 41, 45, 48,
66 19, 19, 19, 40, 41, 42, 46, 49,
67 19, 19, 40, 41, 42, 43, 48, 101,
68 19, 38, 41, 42, 43, 44, 98, 104,
69 42, 43, 45, 46, 48, 98, 109, 116,
70 44, 45, 48, 49, 101, 104, 116, 123,
73 static const uint8_t hqx_quant_chroma[64] = {
74 16, 16, 19, 25, 26, 26, 42, 44,
75 16, 19, 25, 25, 26, 38, 43, 91,
76 19, 25, 26, 27, 40, 41, 91, 96,
77 25, 25, 27, 40, 41, 84, 93, 197,
78 26, 26, 40, 41, 84, 86, 191, 203,
79 26, 38, 41, 84, 86, 177, 197, 209,
80 42, 43, 91, 93, 191, 197, 219, 232,
81 44, 91, 96, 197, 203, 209, 232, 246,
84 static inline void put_blocks(HQXContext *ctx, int plane,
85 int x, int y, int ilace,
86 int16_t *block0, int16_t *block1,
89 int fields = ilace ? 2 : 1;
90 int lsize = ctx->pic->linesize[plane];
91 uint8_t *p = ctx->pic->data[plane] + x * 2;
93 ctx->hqxdsp.idct_put((uint16_t *)(p + y * lsize),
94 lsize * fields, block0, quant);
95 ctx->hqxdsp.idct_put((uint16_t *)(p + (y + (ilace ? 1 : 8)) * lsize),
96 lsize * fields, block1, quant);
99 static inline void hqx_get_ac(GetBitContext *gb, const HQXAC *ac,
104 val = show_bits(gb, ac->lut_bits);
105 if (ac->lut[val].bits == -1) {
106 GetBitContext gb2 = *gb;
107 skip_bits(&gb2, ac->lut_bits);
108 val = ac->lut[val].lev + show_bits(&gb2, ac->extra_bits);
110 *run = ac->lut[val].run;
111 *lev = ac->lut[val].lev;
112 skip_bits(gb, ac->lut[val].bits);
115 static int decode_block(GetBitContext *gb, VLC *vlc,
116 const int *quants, int dcb,
117 int16_t block[64], int *last_dc)
121 int run, lev, pos = 1;
123 memset(block, 0, 64 * sizeof(*block));
124 dc = get_vlc2(gb, vlc->table, HQX_DC_VLC_BITS, 2);
126 return AVERROR_INVALIDDATA;
129 block[0] = sign_extend(*last_dc << (12 - dcb), 12);
131 q = quants[get_bits(gb, 2)];
133 ac_idx = HQX_AC_Q128;
146 hqx_get_ac(gb, &ff_hqx_ac[ac_idx], &run, &lev);
150 block[ff_zigzag_direct[pos++]] = lev * q;
156 static int hqx_decode_422(HQXContext *ctx, int slice_no, int x, int y)
158 HQXSlice *slice = &ctx->slice[slice_no];
159 GetBitContext *gb = &slice->gb;
166 flag = get_bits1(gb);
170 quants = hqx_quants[get_bits(gb, 4)];
172 for (i = 0; i < 8; i++) {
173 int vlc_index = ctx->dcb - 9;
174 if (i == 0 || i == 4 || i == 6)
176 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
177 ctx->dcb, slice->block[i], &last_dc);
182 put_blocks(ctx, 0, x, y, flag, slice->block[0], slice->block[2], hqx_quant_luma);
183 put_blocks(ctx, 0, x + 8, y, flag, slice->block[1], slice->block[3], hqx_quant_luma);
184 put_blocks(ctx, 2, x >> 1, y, flag, slice->block[4], slice->block[5], hqx_quant_chroma);
185 put_blocks(ctx, 1, x >> 1, y, flag, slice->block[6], slice->block[7], hqx_quant_chroma);
190 static int hqx_decode_422a(HQXContext *ctx, int slice_no, int x, int y)
192 HQXSlice *slice = &ctx->slice[slice_no];
193 GetBitContext *gb = &slice->gb;
200 cbp = get_vlc2(gb, ctx->cbp_vlc.table, ctx->cbp_vlc.bits, 1);
202 for (i = 0; i < 12; i++)
203 memset(slice->block[i], 0, sizeof(**slice->block) * 64);
204 for (i = 0; i < 12; i++)
205 slice->block[i][0] = -0x800;
208 flag = get_bits1(gb);
210 quants = hqx_quants[get_bits(gb, 4)];
212 cbp |= cbp << 4; // alpha CBP
213 if (cbp & 0x3) // chroma CBP - top
215 if (cbp & 0xC) // chroma CBP - bottom
217 for (i = 0; i < 12; i++) {
218 if (i == 0 || i == 4 || i == 8 || i == 10)
220 if (cbp & (1 << i)) {
221 int vlc_index = ctx->dcb - 9;
222 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
223 ctx->dcb, slice->block[i], &last_dc);
230 put_blocks(ctx, 3, x, y, flag, slice->block[ 0], slice->block[ 2], hqx_quant_luma);
231 put_blocks(ctx, 3, x + 8, y, flag, slice->block[ 1], slice->block[ 3], hqx_quant_luma);
232 put_blocks(ctx, 0, x, y, flag, slice->block[ 4], slice->block[ 6], hqx_quant_luma);
233 put_blocks(ctx, 0, x + 8, y, flag, slice->block[ 5], slice->block[ 7], hqx_quant_luma);
234 put_blocks(ctx, 2, x >> 1, y, flag, slice->block[ 8], slice->block[ 9], hqx_quant_chroma);
235 put_blocks(ctx, 1, x >> 1, y, flag, slice->block[10], slice->block[11], hqx_quant_chroma);
240 static int hqx_decode_444(HQXContext *ctx, int slice_no, int x, int y)
242 HQXSlice *slice = &ctx->slice[slice_no];
243 GetBitContext *gb = &slice->gb;
250 flag = get_bits1(gb);
254 quants = hqx_quants[get_bits(gb, 4)];
256 for (i = 0; i < 12; i++) {
257 int vlc_index = ctx->dcb - 9;
258 if (i == 0 || i == 4 || i == 8)
260 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
261 ctx->dcb, slice->block[i], &last_dc);
266 put_blocks(ctx, 0, x, y, flag, slice->block[0], slice->block[ 2], hqx_quant_luma);
267 put_blocks(ctx, 0, x + 8, y, flag, slice->block[1], slice->block[ 3], hqx_quant_luma);
268 put_blocks(ctx, 2, x, y, flag, slice->block[4], slice->block[ 6], hqx_quant_chroma);
269 put_blocks(ctx, 2, x + 8, y, flag, slice->block[5], slice->block[ 7], hqx_quant_chroma);
270 put_blocks(ctx, 1, x, y, flag, slice->block[8], slice->block[10], hqx_quant_chroma);
271 put_blocks(ctx, 1, x + 8, y, flag, slice->block[9], slice->block[11], hqx_quant_chroma);
276 static int hqx_decode_444a(HQXContext *ctx, int slice_no, int x, int y)
278 HQXSlice *slice = &ctx->slice[slice_no];
279 GetBitContext *gb = &slice->gb;
286 cbp = get_vlc2(gb, ctx->cbp_vlc.table, ctx->cbp_vlc.bits, 1);
288 for (i = 0; i < 16; i++)
289 memset(slice->block[i], 0, sizeof(**slice->block) * 64);
290 for (i = 0; i < 16; i++)
291 slice->block[i][0] = -0x800;
294 flag = get_bits1(gb);
296 quants = hqx_quants[get_bits(gb, 4)];
298 cbp |= cbp << 4; // alpha CBP
299 cbp |= cbp << 8; // chroma CBP
300 for (i = 0; i < 16; i++) {
301 if (i == 0 || i == 4 || i == 8 || i == 12)
303 if (cbp & (1 << i)) {
304 int vlc_index = ctx->dcb - 9;
305 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
306 ctx->dcb, slice->block[i], &last_dc);
313 put_blocks(ctx, 3, x, y, flag, slice->block[ 0], slice->block[ 2], hqx_quant_luma);
314 put_blocks(ctx, 3, x + 8, y, flag, slice->block[ 1], slice->block[ 3], hqx_quant_luma);
315 put_blocks(ctx, 0, x, y, flag, slice->block[ 4], slice->block[ 6], hqx_quant_luma);
316 put_blocks(ctx, 0, x + 8, y, flag, slice->block[ 5], slice->block[ 7], hqx_quant_luma);
317 put_blocks(ctx, 2, x, y, flag, slice->block[ 8], slice->block[10], hqx_quant_chroma);
318 put_blocks(ctx, 2, x + 8, y, flag, slice->block[ 9], slice->block[11], hqx_quant_chroma);
319 put_blocks(ctx, 1, x, y, flag, slice->block[12], slice->block[14], hqx_quant_chroma);
320 put_blocks(ctx, 1, x + 8, y, flag, slice->block[13], slice->block[15], hqx_quant_chroma);
325 static const int shuffle_16[16] = {
326 0, 5, 11, 14, 2, 7, 9, 13, 1, 4, 10, 15, 3, 6, 8, 12
329 static int decode_slice(HQXContext *ctx, int slice_no)
331 int mb_w = (ctx->width + 15) >> 4;
332 int mb_h = (ctx->height + 15) >> 4;
333 int grp_w = (mb_w + 4) / 5;
334 int grp_h = (mb_h + 4) / 5;
335 int grp_h_edge = grp_w * (mb_w / grp_w);
336 int grp_v_edge = grp_h * (mb_h / grp_h);
337 int grp_v_rest = mb_w - grp_h_edge;
338 int grp_h_rest = mb_h - grp_v_edge;
339 int num_mbs = mb_w * mb_h;
340 int num_tiles = (num_mbs + 479) / 480;
341 int std_tile_blocks = num_mbs / (16 * num_tiles);
342 int g_tile = slice_no * num_tiles;
343 int blk_addr, loc_addr, mb_x, mb_y, pos, loc_row, i;
344 int tile_blocks, tile_limit, tile_no;
346 for (tile_no = 0; tile_no < num_tiles; tile_no++, g_tile++) {
347 tile_blocks = std_tile_blocks;
349 if (g_tile < num_mbs - std_tile_blocks * 16 * num_tiles) {
350 tile_limit = num_mbs / (16 * num_tiles);
353 for (i = 0; i < tile_blocks; i++) {
355 blk_addr = g_tile + 16 * num_tiles * i;
357 blk_addr = tile_no + 16 * num_tiles * i +
358 num_tiles * shuffle_16[(i + slice_no) & 0xF];
359 loc_row = grp_h * (blk_addr / (grp_h * mb_w));
360 loc_addr = blk_addr % (grp_h * mb_w);
361 if (loc_row >= grp_v_edge) {
362 mb_x = grp_w * (loc_addr / (grp_h_rest * grp_w));
363 pos = loc_addr % (grp_h_rest * grp_w);
365 mb_x = grp_w * (loc_addr / (grp_h * grp_w));
366 pos = loc_addr % (grp_h * grp_w);
368 if (mb_x >= grp_h_edge) {
369 mb_x += pos % grp_v_rest;
370 mb_y = loc_row + (pos / grp_v_rest);
373 mb_y = loc_row + (pos / grp_w);
375 ctx->decode_func(ctx, slice_no, mb_x * 16, mb_y * 16);
382 static int decode_slice_thread(AVCodecContext *avctx, void *arg,
383 int slice_no, int threadnr)
385 HQXContext *ctx = avctx->priv_data;
386 uint32_t *slice_off = ctx->slice_off;
389 if (slice_off[slice_no] < HQX_HEADER_SIZE ||
390 slice_off[slice_no] >= slice_off[slice_no + 1] ||
391 slice_off[slice_no + 1] > ctx->data_size) {
392 av_log(avctx, AV_LOG_ERROR, "Invalid slice size %d.\n", ctx->data_size);
393 return AVERROR_INVALIDDATA;
396 ret = init_get_bits8(&ctx->slice[slice_no].gb,
397 ctx->src + slice_off[slice_no],
398 slice_off[slice_no + 1] - slice_off[slice_no]);
402 return decode_slice(ctx, slice_no);
405 static int hqx_decode_frame(AVCodecContext *avctx, void *data,
406 int *got_picture_ptr, AVPacket *avpkt)
408 HQXContext *ctx = avctx->priv_data;
409 ThreadFrame frame = { .f = data };
410 uint8_t *src = avpkt->data;
415 if (avpkt->size < 4 + 4) {
416 av_log(avctx, AV_LOG_ERROR, "Frame is too small %d.\n", avpkt->size);
417 return AVERROR_INVALIDDATA;
420 info_tag = AV_RL32(src);
421 if (info_tag == MKTAG('I', 'N', 'F', 'O')) {
422 uint32_t info_offset = AV_RL32(src + 4);
423 if (info_offset > INT_MAX || info_offset + 8 > avpkt->size) {
424 av_log(avctx, AV_LOG_ERROR,
425 "Invalid INFO header offset: 0x%08"PRIX32" is too large.\n",
427 return AVERROR_INVALIDDATA;
429 ff_canopus_parse_info_tag(avctx, src + 8, info_offset);
435 data_start = src - avpkt->data;
436 ctx->data_size = avpkt->size - data_start;
440 if (ctx->data_size < HQX_HEADER_SIZE) {
441 av_log(avctx, AV_LOG_ERROR, "Frame too small.\n");
442 return AVERROR_INVALIDDATA;
445 if (src[0] != 'H' || src[1] != 'Q') {
446 av_log(avctx, AV_LOG_ERROR, "Not an HQX frame.\n");
447 return AVERROR_INVALIDDATA;
449 ctx->interlaced = !(src[2] & 0x80);
450 ctx->format = src[2] & 7;
451 ctx->dcb = (src[3] & 3) + 8;
452 ctx->width = AV_RB16(src + 4);
453 ctx->height = AV_RB16(src + 6);
454 for (i = 0; i < 17; i++)
455 ctx->slice_off[i] = AV_RB24(src + 8 + i * 3);
458 av_log(avctx, AV_LOG_ERROR, "Invalid DC precision %d.\n", ctx->dcb);
459 return AVERROR_INVALIDDATA;
461 ret = av_image_check_size(ctx->width, ctx->height, 0, avctx);
463 av_log(avctx, AV_LOG_ERROR, "Invalid stored dimensions %dx%d.\n",
464 ctx->width, ctx->height);
465 return AVERROR_INVALIDDATA;
468 avctx->coded_width = FFALIGN(ctx->width, 16);
469 avctx->coded_height = FFALIGN(ctx->height, 16);
470 avctx->width = ctx->width;
471 avctx->height = ctx->height;
472 avctx->bits_per_raw_sample = 10;
474 switch (ctx->format) {
476 avctx->pix_fmt = AV_PIX_FMT_YUV422P16;
477 ctx->decode_func = hqx_decode_422;
480 avctx->pix_fmt = AV_PIX_FMT_YUV444P16;
481 ctx->decode_func = hqx_decode_444;
484 avctx->pix_fmt = AV_PIX_FMT_YUVA422P16;
485 ctx->decode_func = hqx_decode_422a;
488 avctx->pix_fmt = AV_PIX_FMT_YUVA444P16;
489 ctx->decode_func = hqx_decode_444a;
492 av_log(avctx, AV_LOG_ERROR, "Invalid format: %d.\n", ctx->format);
493 return AVERROR_INVALIDDATA;
496 ret = ff_thread_get_buffer(avctx, &frame, 0);
500 avctx->execute2(avctx, decode_slice_thread, NULL, NULL, 16);
502 ctx->pic->key_frame = 1;
503 ctx->pic->pict_type = AV_PICTURE_TYPE_I;
505 *got_picture_ptr = 1;
510 static av_cold int hqx_decode_close(AVCodecContext *avctx)
513 HQXContext *ctx = avctx->priv_data;
515 if (avctx->internal->is_copy)
518 ff_free_vlc(&ctx->cbp_vlc);
519 for (i = 0; i < 3; i++) {
520 ff_free_vlc(&ctx->dc_vlc[i]);
526 static av_cold int hqx_decode_init(AVCodecContext *avctx)
528 HQXContext *ctx = avctx->priv_data;
530 ff_hqxdsp_init(&ctx->hqxdsp);
532 return ff_hqx_init_vlcs(ctx);
535 AVCodec ff_hqx_decoder = {
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 = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_SLICE_THREADS |
545 AV_CODEC_CAP_FRAME_THREADS,
546 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
547 FF_CODEC_CAP_INIT_CLEANUP,