3 * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
4 * Copyright (C) 2015 Tom Butterworth <bangnoise@gmail.com>
6 * HapQA and HAPAlphaOnly added by Jokyo Images
8 * This file is part of FFmpeg.
10 * FFmpeg is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * FFmpeg is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with FFmpeg; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29 * Fourcc: Hap1, Hap5, HapY, HapA, HapM
31 * https://github.com/Vidvox/hap/blob/master/documentation/HapVideoDRAFT.md
36 #include "libavutil/imgutils.h"
39 #include "bytestream.h"
43 #include "texturedsp.h"
46 /* The first three bytes are the size of the section past the header, or zero
47 * if the length is stored in the next long word. The fourth byte in the first
48 * long word indicates the type of the current section. */
49 static int parse_section_header(GetByteContext *gbc, int *section_size,
50 enum HapSectionType *section_type)
52 if (bytestream2_get_bytes_left(gbc) < 4)
53 return AVERROR_INVALIDDATA;
55 *section_size = bytestream2_get_le24(gbc);
56 *section_type = bytestream2_get_byte(gbc);
58 if (*section_size == 0) {
59 if (bytestream2_get_bytes_left(gbc) < 4)
60 return AVERROR_INVALIDDATA;
62 *section_size = bytestream2_get_le32(gbc);
65 if (*section_size > bytestream2_get_bytes_left(gbc) || *section_size < 0)
66 return AVERROR_INVALIDDATA;
71 static int hap_parse_decode_instructions(HapContext *ctx, int size)
73 GetByteContext *gbc = &ctx->gbc;
75 enum HapSectionType section_type;
76 int is_first_table = 1, had_offsets = 0, had_compressors = 0, had_sizes = 0;
80 int stream_remaining = bytestream2_get_bytes_left(gbc);
81 ret = parse_section_header(gbc, §ion_size, §ion_type);
85 size -= stream_remaining - bytestream2_get_bytes_left(gbc);
87 switch (section_type) {
88 case HAP_ST_COMPRESSOR_TABLE:
89 ret = ff_hap_set_chunk_count(ctx, section_size, is_first_table);
92 for (i = 0; i < section_size; i++) {
93 ctx->chunks[i].compressor = bytestream2_get_byte(gbc) << 4;
98 case HAP_ST_SIZE_TABLE:
99 ret = ff_hap_set_chunk_count(ctx, section_size / 4, is_first_table);
102 for (i = 0; i < section_size / 4; i++) {
103 ctx->chunks[i].compressed_size = bytestream2_get_le32(gbc);
108 case HAP_ST_OFFSET_TABLE:
109 ret = ff_hap_set_chunk_count(ctx, section_size / 4, is_first_table);
112 for (i = 0; i < section_size / 4; i++) {
113 ctx->chunks[i].compressed_offset = bytestream2_get_le32(gbc);
121 size -= section_size;
124 if (!had_sizes || !had_compressors)
125 return AVERROR_INVALIDDATA;
127 /* The offsets table is optional. If not present than calculate offsets by
128 * summing the sizes of preceding chunks. */
130 size_t running_size = 0;
131 for (i = 0; i < ctx->chunk_count; i++) {
132 ctx->chunks[i].compressed_offset = running_size;
133 running_size += ctx->chunks[i].compressed_size;
140 static int hap_can_use_tex_in_place(HapContext *ctx)
143 size_t running_offset = 0;
144 for (i = 0; i < ctx->chunk_count; i++) {
145 if (ctx->chunks[i].compressed_offset != running_offset
146 || ctx->chunks[i].compressor != HAP_COMP_NONE)
148 running_offset += ctx->chunks[i].compressed_size;
153 static int hap_parse_frame_header(AVCodecContext *avctx)
155 HapContext *ctx = avctx->priv_data;
156 GetByteContext *gbc = &ctx->gbc;
158 enum HapSectionType section_type;
159 const char *compressorstr;
162 ret = parse_section_header(gbc, &ctx->texture_section_size, §ion_type);
166 if ((avctx->codec_tag == MKTAG('H','a','p','1') && (section_type & 0x0F) != HAP_FMT_RGBDXT1) ||
167 (avctx->codec_tag == MKTAG('H','a','p','5') && (section_type & 0x0F) != HAP_FMT_RGBADXT5) ||
168 (avctx->codec_tag == MKTAG('H','a','p','Y') && (section_type & 0x0F) != HAP_FMT_YCOCGDXT5) ||
169 (avctx->codec_tag == MKTAG('H','a','p','A') && (section_type & 0x0F) != HAP_FMT_RGTC1) ||
170 ((avctx->codec_tag == MKTAG('H','a','p','M') && (section_type & 0x0F) != HAP_FMT_RGTC1) &&
171 (section_type & 0x0F) != HAP_FMT_YCOCGDXT5)) {
172 av_log(avctx, AV_LOG_ERROR,
173 "Invalid texture format %#04x.\n", section_type & 0x0F);
174 return AVERROR_INVALIDDATA;
177 switch (section_type & 0xF0) {
179 case HAP_COMP_SNAPPY:
180 ret = ff_hap_set_chunk_count(ctx, 1, 1);
182 ctx->chunks[0].compressor = section_type & 0xF0;
183 ctx->chunks[0].compressed_offset = 0;
184 ctx->chunks[0].compressed_size = ctx->texture_section_size;
186 if (ctx->chunks[0].compressor == HAP_COMP_NONE) {
187 compressorstr = "none";
189 compressorstr = "snappy";
192 case HAP_COMP_COMPLEX:
193 ret = parse_section_header(gbc, §ion_size, §ion_type);
194 if (ret == 0 && section_type != HAP_ST_DECODE_INSTRUCTIONS)
195 ret = AVERROR_INVALIDDATA;
197 ret = hap_parse_decode_instructions(ctx, section_size);
198 compressorstr = "complex";
201 ret = AVERROR_INVALIDDATA;
208 /* Check the frame is valid and read the uncompressed chunk sizes */
210 for (i = 0; i < ctx->chunk_count; i++) {
211 HapChunk *chunk = &ctx->chunks[i];
213 /* Check the compressed buffer is valid */
214 if (chunk->compressed_offset + chunk->compressed_size > bytestream2_get_bytes_left(gbc))
215 return AVERROR_INVALIDDATA;
217 /* Chunks are unpacked sequentially, ctx->tex_size is the uncompressed
219 chunk->uncompressed_offset = ctx->tex_size;
221 /* Fill out uncompressed size */
222 if (chunk->compressor == HAP_COMP_SNAPPY) {
223 GetByteContext gbc_tmp;
224 int64_t uncompressed_size;
225 bytestream2_init(&gbc_tmp, gbc->buffer + chunk->compressed_offset,
226 chunk->compressed_size);
227 uncompressed_size = ff_snappy_peek_uncompressed_length(&gbc_tmp);
228 if (uncompressed_size < 0) {
229 return uncompressed_size;
231 chunk->uncompressed_size = uncompressed_size;
232 } else if (chunk->compressor == HAP_COMP_NONE) {
233 chunk->uncompressed_size = chunk->compressed_size;
235 return AVERROR_INVALIDDATA;
237 ctx->tex_size += chunk->uncompressed_size;
240 av_log(avctx, AV_LOG_DEBUG, "%s compressor\n", compressorstr);
245 static int decompress_chunks_thread(AVCodecContext *avctx, void *arg,
246 int chunk_nb, int thread_nb)
248 HapContext *ctx = avctx->priv_data;
250 HapChunk *chunk = &ctx->chunks[chunk_nb];
252 uint8_t *dst = ctx->tex_buf + chunk->uncompressed_offset;
254 bytestream2_init(&gbc, ctx->gbc.buffer + chunk->compressed_offset, chunk->compressed_size);
256 if (chunk->compressor == HAP_COMP_SNAPPY) {
258 int64_t uncompressed_size = ctx->tex_size;
260 /* Uncompress the frame */
261 ret = ff_snappy_uncompress(&gbc, dst, &uncompressed_size);
263 av_log(avctx, AV_LOG_ERROR, "Snappy uncompress error\n");
266 } else if (chunk->compressor == HAP_COMP_NONE) {
267 bytestream2_get_buffer(&gbc, dst, chunk->compressed_size);
273 static int decompress_texture_thread_internal(AVCodecContext *avctx, void *arg,
274 int slice, int thread_nb, int texture_num)
276 HapContext *ctx = avctx->priv_data;
277 AVFrame *frame = arg;
278 const uint8_t *d = ctx->tex_data;
279 int w_block = avctx->coded_width / TEXTURE_BLOCK_W;
280 int h_block = avctx->coded_height / TEXTURE_BLOCK_H;
282 int start_slice, end_slice;
283 int base_blocks_per_slice = h_block / ctx->slice_count;
284 int remainder_blocks = h_block % ctx->slice_count;
286 /* When the frame height (in blocks) doesn't divide evenly between the
287 * number of slices, spread the remaining blocks evenly between the first
289 start_slice = slice * base_blocks_per_slice;
290 /* Add any extra blocks (one per slice) that have been added before this slice */
291 start_slice += FFMIN(slice, remainder_blocks);
293 end_slice = start_slice + base_blocks_per_slice;
294 /* Add an extra block if there are still remainder blocks to be accounted for */
295 if (slice < remainder_blocks)
298 for (y = start_slice; y < end_slice; y++) {
299 uint8_t *p = frame->data[0] + y * frame->linesize[0] * TEXTURE_BLOCK_H;
300 int off = y * w_block;
301 for (x = 0; x < w_block; x++) {
302 if (texture_num == 0) {
303 ctx->tex_fun(p + x * 4 * ctx->uncompress_pix_size, frame->linesize[0],
304 d + (off + x) * ctx->tex_rat);
306 ctx->tex_fun2(p + x * 4 * ctx->uncompress_pix_size, frame->linesize[0],
307 d + (off + x) * ctx->tex_rat2);
315 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
316 int slice, int thread_nb)
318 return decompress_texture_thread_internal(avctx, arg, slice, thread_nb, 0);
321 static int decompress_texture2_thread(AVCodecContext *avctx, void *arg,
322 int slice, int thread_nb)
324 return decompress_texture_thread_internal(avctx, arg, slice, thread_nb, 1);
327 static int hap_decode(AVCodecContext *avctx, void *data,
328 int *got_frame, AVPacket *avpkt)
330 HapContext *ctx = avctx->priv_data;
335 enum HapSectionType section_type;
336 int start_texture_section = 0;
337 int tex_rat[2] = {0, 0};
339 bytestream2_init(&ctx->gbc, avpkt->data, avpkt->size);
341 tex_rat[0] = ctx->tex_rat;
343 /* check for multi texture header */
344 if (ctx->texture_count == 2) {
345 ret = parse_section_header(&ctx->gbc, §ion_size, §ion_type);
348 if ((section_type & 0x0F) != 0x0D) {
349 av_log(avctx, AV_LOG_ERROR, "Invalid section type in 2 textures mode %#04x.\n", section_type);
350 return AVERROR_INVALIDDATA;
352 start_texture_section = 4;
353 tex_rat[1] = ctx->tex_rat2;
356 /* Get the output frame ready to receive data */
358 ret = ff_thread_get_buffer(avctx, &tframe, 0);
362 for (t = 0; t < ctx->texture_count; t++) {
363 bytestream2_seek(&ctx->gbc, start_texture_section, SEEK_SET);
365 /* Check for section header */
366 ret = hap_parse_frame_header(avctx);
370 start_texture_section += ctx->texture_section_size + 4;
372 if (avctx->codec->update_thread_context)
373 ff_thread_finish_setup(avctx);
375 /* Unpack the DXT texture */
376 if (hap_can_use_tex_in_place(ctx)) {
377 /* Only DXTC texture compression in a contiguous block */
378 ctx->tex_data = ctx->gbc.buffer;
379 tex_size = FFMIN(ctx->texture_section_size, bytestream2_get_bytes_left(&ctx->gbc));
381 /* Perform the second-stage decompression */
382 ret = av_reallocp(&ctx->tex_buf, ctx->tex_size);
386 avctx->execute2(avctx, decompress_chunks_thread, NULL,
387 ctx->chunk_results, ctx->chunk_count);
389 for (i = 0; i < ctx->chunk_count; i++) {
390 if (ctx->chunk_results[i] < 0)
391 return ctx->chunk_results[i];
394 ctx->tex_data = ctx->tex_buf;
395 tex_size = ctx->tex_size;
398 if (tex_size < (avctx->coded_width / TEXTURE_BLOCK_W)
399 *(avctx->coded_height / TEXTURE_BLOCK_H)
401 av_log(avctx, AV_LOG_ERROR, "Insufficient data\n");
402 return AVERROR_INVALIDDATA;
405 /* Use the decompress function on the texture, one block per thread */
407 avctx->execute2(avctx, decompress_texture_thread, tframe.f, NULL, ctx->slice_count);
410 avctx->execute2(avctx, decompress_texture2_thread, tframe.f, NULL, ctx->slice_count);
414 /* Frame is ready to be output */
415 tframe.f->pict_type = AV_PICTURE_TYPE_I;
416 tframe.f->key_frame = 1;
422 static av_cold int hap_init(AVCodecContext *avctx)
424 HapContext *ctx = avctx->priv_data;
425 const char *texture_name;
426 int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
429 av_log(avctx, AV_LOG_ERROR, "Invalid video size %dx%d.\n",
430 avctx->width, avctx->height);
434 /* Since codec is based on 4x4 blocks, size is aligned to 4 */
435 avctx->coded_width = FFALIGN(avctx->width, TEXTURE_BLOCK_W);
436 avctx->coded_height = FFALIGN(avctx->height, TEXTURE_BLOCK_H);
438 ff_texturedsp_init(&ctx->dxtc);
440 ctx->texture_count = 1;
441 ctx->uncompress_pix_size = 4;
443 switch (avctx->codec_tag) {
444 case MKTAG('H','a','p','1'):
445 texture_name = "DXT1";
447 ctx->tex_fun = ctx->dxtc.dxt1_block;
448 avctx->pix_fmt = AV_PIX_FMT_RGB0;
450 case MKTAG('H','a','p','5'):
451 texture_name = "DXT5";
453 ctx->tex_fun = ctx->dxtc.dxt5_block;
454 avctx->pix_fmt = AV_PIX_FMT_RGBA;
456 case MKTAG('H','a','p','Y'):
457 texture_name = "DXT5-YCoCg-scaled";
459 ctx->tex_fun = ctx->dxtc.dxt5ys_block;
460 avctx->pix_fmt = AV_PIX_FMT_RGB0;
462 case MKTAG('H','a','p','A'):
463 texture_name = "RGTC1";
465 ctx->tex_fun = ctx->dxtc.rgtc1u_gray_block;
466 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
467 ctx->uncompress_pix_size = 1;
469 case MKTAG('H','a','p','M'):
470 texture_name = "DXT5-YCoCg-scaled / RGTC1";
473 ctx->tex_fun = ctx->dxtc.dxt5ys_block;
474 ctx->tex_fun2 = ctx->dxtc.rgtc1u_alpha_block;
475 avctx->pix_fmt = AV_PIX_FMT_RGBA;
476 ctx->texture_count = 2;
479 return AVERROR_DECODER_NOT_FOUND;
482 av_log(avctx, AV_LOG_DEBUG, "%s texture\n", texture_name);
484 ctx->slice_count = av_clip(avctx->thread_count, 1,
485 avctx->coded_height / TEXTURE_BLOCK_H);
490 static av_cold int hap_close(AVCodecContext *avctx)
492 HapContext *ctx = avctx->priv_data;
494 ff_hap_free_context(ctx);
499 AVCodec ff_hap_decoder = {
501 .long_name = NULL_IF_CONFIG_SMALL("Vidvox Hap"),
502 .type = AVMEDIA_TYPE_VIDEO,
503 .id = AV_CODEC_ID_HAP,
505 .decode = hap_decode,
507 .priv_data_size = sizeof(HapContext),
508 .capabilities = AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_SLICE_THREADS |
510 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
511 FF_CODEC_CAP_INIT_CLEANUP,