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 "canopus.h" 28#include "codec_internal.h" 29#include "get_bits.h" 30#include "thread.h" 31 32#include "hqx.h" 33#include "hqxdsp.h" 34 35/* HQX has four modes - 422, 444, 422alpha and 444alpha - all 12-bit */ 36enum HQXFormat { 37 HQX_422 = 0, 38 HQX_444, 39 HQX_422A, 40 HQX_444A, 41}; 42 43#define HQX_HEADER_SIZE 59 44 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 */ 49static 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 } 60}; 61 62static 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, 71}; 72 73static 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, 82}; 83 84static inline void put_blocks(HQXContext *ctx, int plane, 85 int x, int y, int ilace, 86 int16_t *block0, int16_t *block1, 87 const uint8_t *quant) 88{ 89 int fields = ilace ? 2 : 1; 90 int lsize = ctx->pic->linesize[plane]; 91 uint8_t *p = ctx->pic->data[plane] + x * 2; 92 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); 97} 98 99static inline void hqx_get_ac(GetBitContext *gb, const HQXAC *ac, 100 int *run, int *lev) 101{ 102 int val; 103 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); 109 } 110 *run = ac->lut[val].run; 111 *lev = ac->lut[val].lev; 112 skip_bits(gb, ac->lut[val].bits); 113} 114 115static int decode_block(GetBitContext *gb, VLC *vlc, 116 const int *quants, int dcb, 117 int16_t block[64], int *last_dc) 118{ 119 int q, dc; 120 int ac_idx; 121 int run, lev, pos = 1; 122 123 memset(block, 0, 64 * sizeof(*block)); 124 dc = get_vlc2(gb, vlc->table, HQX_DC_VLC_BITS, 2); 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 154static 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 188static 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, HQX_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 238static 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 274static 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, HQX_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 323static const int shuffle_16[16] = { 324 0, 5, 11, 14, 2, 7, 9, 13, 1, 4, 10, 15, 3, 6, 8, 12 325}; 326 327static 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 380static 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 403static int hqx_decode_frame(AVCodecContext *avctx, AVFrame *frame, 404 int *got_picture_ptr, AVPacket *avpkt) 405{ 406 HQXContext *ctx = avctx->priv_data; 407 const uint8_t *src = avpkt->data; 408 uint32_t info_tag; 409 int data_start; 410 int i, ret; 411 412 if (avpkt->size < 4 + 4) { 413 av_log(avctx, AV_LOG_ERROR, "Frame is too small %d.\n", avpkt->size); 414 return AVERROR_INVALIDDATA; 415 } 416 417 info_tag = AV_RL32(src); 418 if (info_tag == MKTAG('I', 'N', 'F', 'O')) { 419 uint32_t info_offset = AV_RL32(src + 4); 420 if (info_offset > INT_MAX || 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 ff_canopus_parse_info_tag(avctx, src + 8, info_offset); 427 428 info_offset += 8; 429 src += info_offset; 430 } 431 432 data_start = src - avpkt->data; 433 ctx->data_size = avpkt->size - data_start; 434 ctx->src = src; 435 ctx->pic = frame; 436 437 if (ctx->data_size < HQX_HEADER_SIZE) { 438 av_log(avctx, AV_LOG_ERROR, "Frame too small.\n"); 439 return AVERROR_INVALIDDATA; 440 } 441 442 if (src[0] != 'H' || src[1] != 'Q') { 443 av_log(avctx, AV_LOG_ERROR, "Not an HQX frame.\n"); 444 return AVERROR_INVALIDDATA; 445 } 446 ctx->interlaced = !(src[2] & 0x80); 447 ctx->format = src[2] & 7; 448 ctx->dcb = (src[3] & 3) + 8; 449 ctx->width = AV_RB16(src + 4); 450 ctx->height = AV_RB16(src + 6); 451 for (i = 0; i < 17; i++) 452 ctx->slice_off[i] = AV_RB24(src + 8 + i * 3); 453 454 if (ctx->dcb == 8) { 455 av_log(avctx, AV_LOG_ERROR, "Invalid DC precision %d.\n", ctx->dcb); 456 return AVERROR_INVALIDDATA; 457 } 458 ret = av_image_check_size(ctx->width, ctx->height, 0, avctx); 459 if (ret < 0) { 460 av_log(avctx, AV_LOG_ERROR, "Invalid stored dimensions %dx%d.\n", 461 ctx->width, ctx->height); 462 return AVERROR_INVALIDDATA; 463 } 464 465 avctx->coded_width = FFALIGN(ctx->width, 16); 466 avctx->coded_height = FFALIGN(ctx->height, 16); 467 avctx->width = ctx->width; 468 avctx->height = ctx->height; 469 avctx->bits_per_raw_sample = 10; 470 471 //The minimum size is 2bit per macroblock 472 // hqx_decode_422 & hqx_decode_444 have a unconditionally stored 4bits hqx_quants index 473 // hqx_decode_422a & hqx_decode_444a use cbp_vlc which has a minimum length of 2 bits for its VLCs 474 // The code rejects slices overlapping in their input data 475 if (avctx->coded_width / 16 * (avctx->coded_height / 16) * 476 (100 - avctx->discard_damaged_percentage) / 100 > 4LL * avpkt->size) 477 return AVERROR_INVALIDDATA; 478 479 switch (ctx->format) { 480 case HQX_422: 481 avctx->pix_fmt = AV_PIX_FMT_YUV422P16; 482 ctx->decode_func = hqx_decode_422; 483 break; 484 case HQX_444: 485 avctx->pix_fmt = AV_PIX_FMT_YUV444P16; 486 ctx->decode_func = hqx_decode_444; 487 break; 488 case HQX_422A: 489 avctx->pix_fmt = AV_PIX_FMT_YUVA422P16; 490 ctx->decode_func = hqx_decode_422a; 491 break; 492 case HQX_444A: 493 avctx->pix_fmt = AV_PIX_FMT_YUVA444P16; 494 ctx->decode_func = hqx_decode_444a; 495 break; 496 default: 497 av_log(avctx, AV_LOG_ERROR, "Invalid format: %d.\n", ctx->format); 498 return AVERROR_INVALIDDATA; 499 } 500 501 ret = ff_thread_get_buffer(avctx, frame, 0); 502 if (ret < 0) 503 return ret; 504 505 avctx->execute2(avctx, decode_slice_thread, NULL, NULL, 16); 506 507 ctx->pic->key_frame = 1; 508 ctx->pic->pict_type = AV_PICTURE_TYPE_I; 509 510 *got_picture_ptr = 1; 511 512 return avpkt->size; 513} 514 515static av_cold int hqx_decode_close(AVCodecContext *avctx) 516{ 517 int i; 518 HQXContext *ctx = avctx->priv_data; 519 520 ff_free_vlc(&ctx->cbp_vlc); 521 for (i = 0; i < 3; i++) { 522 ff_free_vlc(&ctx->dc_vlc[i]); 523 } 524 525 return 0; 526} 527 528static av_cold int hqx_decode_init(AVCodecContext *avctx) 529{ 530 HQXContext *ctx = avctx->priv_data; 531 532 ff_hqxdsp_init(&ctx->hqxdsp); 533 534 return ff_hqx_init_vlcs(ctx); 535} 536 537const FFCodec ff_hqx_decoder = { 538 .p.name = "hqx", 539 .p.long_name = NULL_IF_CONFIG_SMALL("Canopus HQX"), 540 .p.type = AVMEDIA_TYPE_VIDEO, 541 .p.id = AV_CODEC_ID_HQX, 542 .priv_data_size = sizeof(HQXContext), 543 .init = hqx_decode_init, 544 FF_CODEC_DECODE_CB(hqx_decode_frame), 545 .close = hqx_decode_close, 546 .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_SLICE_THREADS | 547 AV_CODEC_CAP_FRAME_THREADS, 548 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE | 549 FF_CODEC_CAP_INIT_CLEANUP, 550}; 551