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);
127 block[0] = sign_extend(*last_dc << (12 - dcb), 12);
129 q = quants[get_bits(gb, 2)];
131 ac_idx = HQX_AC_Q128;
144 hqx_get_ac(gb, &ff_hqx_ac[ac_idx], &run, &lev);
148 block[ff_zigzag_direct[pos++]] = lev * q;
154 static int hqx_decode_422(HQXContext *ctx, int slice_no, int x, int y)
156 HQXSlice *slice = &ctx->slice[slice_no];
157 GetBitContext *gb = &slice->gb;
164 flag = get_bits1(gb);
168 quants = hqx_quants[get_bits(gb, 4)];
170 for (i = 0; i < 8; i++) {
171 int vlc_index = ctx->dcb - 9;
172 if (i == 0 || i == 4 || i == 6)
174 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
175 ctx->dcb, slice->block[i], &last_dc);
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);
188 static int hqx_decode_422a(HQXContext *ctx, int slice_no, int x, int y)
190 HQXSlice *slice = &ctx->slice[slice_no];
191 GetBitContext *gb = &slice->gb;
198 cbp = get_vlc2(gb, ctx->cbp_vlc.table, HQX_CBP_VLC_BITS, 1);
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;
206 flag = get_bits1(gb);
208 quants = hqx_quants[get_bits(gb, 4)];
210 cbp |= cbp << 4; // alpha CBP
211 if (cbp & 0x3) // chroma CBP - top
213 if (cbp & 0xC) // chroma CBP - bottom
215 for (i = 0; i < 12; i++) {
216 if (i == 0 || i == 4 || i == 8 || i == 10)
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);
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);
238 static int hqx_decode_444(HQXContext *ctx, int slice_no, int x, int y)
240 HQXSlice *slice = &ctx->slice[slice_no];
241 GetBitContext *gb = &slice->gb;
248 flag = get_bits1(gb);
252 quants = hqx_quants[get_bits(gb, 4)];
254 for (i = 0; i < 12; i++) {
255 int vlc_index = ctx->dcb - 9;
256 if (i == 0 || i == 4 || i == 8)
258 ret = decode_block(gb, &ctx->dc_vlc[vlc_index], quants,
259 ctx->dcb, slice->block[i], &last_dc);
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);
274 static int hqx_decode_444a(HQXContext *ctx, int slice_no, int x, int y)
276 HQXSlice *slice = &ctx->slice[slice_no];
277 GetBitContext *gb = &slice->gb;
284 cbp = get_vlc2(gb, ctx->cbp_vlc.table, HQX_CBP_VLC_BITS, 1);
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;
292 flag = get_bits1(gb);
294 quants = hqx_quants[get_bits(gb, 4)];
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)
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);
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);
323 static const int shuffle_16[16] = {
324 0, 5, 11, 14, 2, 7, 9, 13, 1, 4, 10, 15, 3, 6, 8, 12
327 static int decode_slice(HQXContext *ctx, int slice_no)
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;
344 for (tile_no = 0; tile_no < num_tiles; tile_no++, g_tile++) {
345 tile_blocks = std_tile_blocks;
347 if (g_tile < num_mbs - std_tile_blocks * 16 * num_tiles) {
348 tile_limit = num_mbs / (16 * num_tiles);
351 for (i = 0; i < tile_blocks; i++) {
353 blk_addr = g_tile + 16 * num_tiles * i;
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);
363 mb_x = grp_w * (loc_addr / (grp_h * grp_w));
364 pos = loc_addr % (grp_h * grp_w);
366 if (mb_x >= grp_h_edge) {
367 mb_x += pos % grp_v_rest;
368 mb_y = loc_row + (pos / grp_v_rest);
371 mb_y = loc_row + (pos / grp_w);
373 ctx->decode_func(ctx, slice_no, mb_x * 16, mb_y * 16);
380 static int decode_slice_thread(AVCodecContext *avctx, void *arg,
381 int slice_no, int threadnr)
383 HQXContext *ctx = avctx->priv_data;
384 uint32_t *slice_off = ctx->slice_off;
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;
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]);
400 return decode_slice(ctx, slice_no);
403 static int hqx_decode_frame(AVCodecContext *avctx, void *data,
404 int *got_picture_ptr, AVPacket *avpkt)
406 HQXContext *ctx = avctx->priv_data;
407 ThreadFrame frame = { .f = data };
408 uint8_t *src = avpkt->data;
413 if (avpkt->size < 4 + 4) {
414 av_log(avctx, AV_LOG_ERROR, "Frame is too small %d.\n", avpkt->size);
415 return AVERROR_INVALIDDATA;
418 info_tag = AV_RL32(src);
419 if (info_tag == MKTAG('I', 'N', 'F', 'O')) {
420 uint32_t info_offset = AV_RL32(src + 4);
421 if (info_offset > INT_MAX || info_offset + 8 > avpkt->size) {
422 av_log(avctx, AV_LOG_ERROR,
423 "Invalid INFO header offset: 0x%08"PRIX32" is too large.\n",
425 return AVERROR_INVALIDDATA;
427 ff_canopus_parse_info_tag(avctx, src + 8, info_offset);
433 data_start = src - avpkt->data;
434 ctx->data_size = avpkt->size - data_start;
438 if (ctx->data_size < HQX_HEADER_SIZE) {
439 av_log(avctx, AV_LOG_ERROR, "Frame too small.\n");
440 return AVERROR_INVALIDDATA;
443 if (src[0] != 'H' || src[1] != 'Q') {
444 av_log(avctx, AV_LOG_ERROR, "Not an HQX frame.\n");
445 return AVERROR_INVALIDDATA;
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);
456 av_log(avctx, AV_LOG_ERROR, "Invalid DC precision %d.\n", ctx->dcb);
457 return AVERROR_INVALIDDATA;
459 ret = av_image_check_size(ctx->width, ctx->height, 0, avctx);
461 av_log(avctx, AV_LOG_ERROR, "Invalid stored dimensions %dx%d.\n",
462 ctx->width, ctx->height);
463 return AVERROR_INVALIDDATA;
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;
472 //The minimum size is 2bit per macroblock
473 // hqx_decode_422 & hqx_decode_444 have a unconditionally stored 4bits hqx_quants index
474 // hqx_decode_422a & hqx_decode_444a use cbp_vlc which has a minimum length of 2 bits for its VLCs
475 // The code rejects slices overlapping in their input data
476 if (avctx->coded_width / 16 * (avctx->coded_height / 16) *
477 (100 - avctx->discard_damaged_percentage) / 100 > 4LL * avpkt->size)
478 return AVERROR_INVALIDDATA;
480 switch (ctx->format) {
482 avctx->pix_fmt = AV_PIX_FMT_YUV422P16;
483 ctx->decode_func = hqx_decode_422;
486 avctx->pix_fmt = AV_PIX_FMT_YUV444P16;
487 ctx->decode_func = hqx_decode_444;
490 avctx->pix_fmt = AV_PIX_FMT_YUVA422P16;
491 ctx->decode_func = hqx_decode_422a;
494 avctx->pix_fmt = AV_PIX_FMT_YUVA444P16;
495 ctx->decode_func = hqx_decode_444a;
498 av_log(avctx, AV_LOG_ERROR, "Invalid format: %d.\n", ctx->format);
499 return AVERROR_INVALIDDATA;
502 ret = ff_thread_get_buffer(avctx, &frame, 0);
506 avctx->execute2(avctx, decode_slice_thread, NULL, NULL, 16);
508 ctx->pic->key_frame = 1;
509 ctx->pic->pict_type = AV_PICTURE_TYPE_I;
511 *got_picture_ptr = 1;
516 static av_cold int hqx_decode_close(AVCodecContext *avctx)
519 HQXContext *ctx = avctx->priv_data;
521 ff_free_vlc(&ctx->cbp_vlc);
522 for (i = 0; i < 3; i++) {
523 ff_free_vlc(&ctx->dc_vlc[i]);
529 static av_cold int hqx_decode_init(AVCodecContext *avctx)
531 HQXContext *ctx = avctx->priv_data;
533 ff_hqxdsp_init(&ctx->hqxdsp);
535 return ff_hqx_init_vlcs(ctx);
538 AVCodec ff_hqx_decoder = {
540 .long_name = NULL_IF_CONFIG_SMALL("Canopus HQX"),
541 .type = AVMEDIA_TYPE_VIDEO,
542 .id = AV_CODEC_ID_HQX,
543 .priv_data_size = sizeof(HQXContext),
544 .init = hqx_decode_init,
545 .decode = hqx_decode_frame,
546 .close = hqx_decode_close,
547 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_SLICE_THREADS |
548 AV_CODEC_CAP_FRAME_THREADS,
549 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
550 FF_CODEC_CAP_INIT_CLEANUP,