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 static int hap_parse_decode_instructions(HapContext *ctx, int size)
48 GetByteContext *gbc = &ctx->gbc;
50 enum HapSectionType section_type;
51 int is_first_table = 1, had_offsets = 0, had_compressors = 0, had_sizes = 0;
55 int stream_remaining = bytestream2_get_bytes_left(gbc);
56 ret = ff_hap_parse_section_header(gbc, §ion_size, §ion_type);
60 size -= stream_remaining - bytestream2_get_bytes_left(gbc);
62 switch (section_type) {
63 case HAP_ST_COMPRESSOR_TABLE:
64 ret = ff_hap_set_chunk_count(ctx, section_size, is_first_table);
67 for (i = 0; i < section_size; i++) {
68 ctx->chunks[i].compressor = bytestream2_get_byte(gbc) << 4;
73 case HAP_ST_SIZE_TABLE:
74 ret = ff_hap_set_chunk_count(ctx, section_size / 4, is_first_table);
77 for (i = 0; i < section_size / 4; i++) {
78 ctx->chunks[i].compressed_size = bytestream2_get_le32(gbc);
83 case HAP_ST_OFFSET_TABLE:
84 ret = ff_hap_set_chunk_count(ctx, section_size / 4, is_first_table);
87 for (i = 0; i < section_size / 4; i++) {
88 ctx->chunks[i].compressed_offset = bytestream2_get_le32(gbc);
99 if (!had_sizes || !had_compressors)
100 return AVERROR_INVALIDDATA;
102 /* The offsets table is optional. If not present than calculate offsets by
103 * summing the sizes of preceding chunks. */
105 size_t running_size = 0;
106 for (i = 0; i < ctx->chunk_count; i++) {
107 ctx->chunks[i].compressed_offset = running_size;
108 running_size += ctx->chunks[i].compressed_size;
115 static int hap_can_use_tex_in_place(HapContext *ctx)
118 size_t running_offset = 0;
119 for (i = 0; i < ctx->chunk_count; i++) {
120 if (ctx->chunks[i].compressed_offset != running_offset
121 || ctx->chunks[i].compressor != HAP_COMP_NONE)
123 running_offset += ctx->chunks[i].compressed_size;
128 static int hap_parse_frame_header(AVCodecContext *avctx)
130 HapContext *ctx = avctx->priv_data;
131 GetByteContext *gbc = &ctx->gbc;
133 enum HapSectionType section_type;
134 const char *compressorstr;
137 ret = ff_hap_parse_section_header(gbc, &ctx->texture_section_size, §ion_type);
141 if ((avctx->codec_tag == MKTAG('H','a','p','1') && (section_type & 0x0F) != HAP_FMT_RGBDXT1) ||
142 (avctx->codec_tag == MKTAG('H','a','p','5') && (section_type & 0x0F) != HAP_FMT_RGBADXT5) ||
143 (avctx->codec_tag == MKTAG('H','a','p','Y') && (section_type & 0x0F) != HAP_FMT_YCOCGDXT5) ||
144 (avctx->codec_tag == MKTAG('H','a','p','A') && (section_type & 0x0F) != HAP_FMT_RGTC1) ||
145 ((avctx->codec_tag == MKTAG('H','a','p','M') && (section_type & 0x0F) != HAP_FMT_RGTC1) &&
146 (section_type & 0x0F) != HAP_FMT_YCOCGDXT5)) {
147 av_log(avctx, AV_LOG_ERROR,
148 "Invalid texture format %#04x.\n", section_type & 0x0F);
149 return AVERROR_INVALIDDATA;
152 switch (section_type & 0xF0) {
154 case HAP_COMP_SNAPPY:
155 ret = ff_hap_set_chunk_count(ctx, 1, 1);
157 ctx->chunks[0].compressor = section_type & 0xF0;
158 ctx->chunks[0].compressed_offset = 0;
159 ctx->chunks[0].compressed_size = ctx->texture_section_size;
161 if (ctx->chunks[0].compressor == HAP_COMP_NONE) {
162 compressorstr = "none";
164 compressorstr = "snappy";
167 case HAP_COMP_COMPLEX:
168 ret = ff_hap_parse_section_header(gbc, §ion_size, §ion_type);
169 if (ret == 0 && section_type != HAP_ST_DECODE_INSTRUCTIONS)
170 ret = AVERROR_INVALIDDATA;
172 ret = hap_parse_decode_instructions(ctx, section_size);
173 compressorstr = "complex";
176 ret = AVERROR_INVALIDDATA;
183 /* Check the frame is valid and read the uncompressed chunk sizes */
185 for (i = 0; i < ctx->chunk_count; i++) {
186 HapChunk *chunk = &ctx->chunks[i];
188 /* Check the compressed buffer is valid */
189 if (chunk->compressed_offset + chunk->compressed_size > bytestream2_get_bytes_left(gbc))
190 return AVERROR_INVALIDDATA;
192 /* Chunks are unpacked sequentially, ctx->tex_size is the uncompressed
194 chunk->uncompressed_offset = ctx->tex_size;
196 /* Fill out uncompressed size */
197 if (chunk->compressor == HAP_COMP_SNAPPY) {
198 GetByteContext gbc_tmp;
199 int64_t uncompressed_size;
200 bytestream2_init(&gbc_tmp, gbc->buffer + chunk->compressed_offset,
201 chunk->compressed_size);
202 uncompressed_size = ff_snappy_peek_uncompressed_length(&gbc_tmp);
203 if (uncompressed_size < 0) {
204 return uncompressed_size;
206 chunk->uncompressed_size = uncompressed_size;
207 } else if (chunk->compressor == HAP_COMP_NONE) {
208 chunk->uncompressed_size = chunk->compressed_size;
210 return AVERROR_INVALIDDATA;
212 ctx->tex_size += chunk->uncompressed_size;
215 av_log(avctx, AV_LOG_DEBUG, "%s compressor\n", compressorstr);
220 static int decompress_chunks_thread(AVCodecContext *avctx, void *arg,
221 int chunk_nb, int thread_nb)
223 HapContext *ctx = avctx->priv_data;
225 HapChunk *chunk = &ctx->chunks[chunk_nb];
227 uint8_t *dst = ctx->tex_buf + chunk->uncompressed_offset;
229 bytestream2_init(&gbc, ctx->gbc.buffer + chunk->compressed_offset, chunk->compressed_size);
231 if (chunk->compressor == HAP_COMP_SNAPPY) {
233 int64_t uncompressed_size = ctx->tex_size;
235 /* Uncompress the frame */
236 ret = ff_snappy_uncompress(&gbc, dst, &uncompressed_size);
238 av_log(avctx, AV_LOG_ERROR, "Snappy uncompress error\n");
241 } else if (chunk->compressor == HAP_COMP_NONE) {
242 bytestream2_get_buffer(&gbc, dst, chunk->compressed_size);
248 static int decompress_texture_thread_internal(AVCodecContext *avctx, void *arg,
249 int slice, int thread_nb, int texture_num)
251 HapContext *ctx = avctx->priv_data;
252 AVFrame *frame = arg;
253 const uint8_t *d = ctx->tex_data;
254 int w_block = avctx->coded_width / TEXTURE_BLOCK_W;
255 int h_block = avctx->coded_height / TEXTURE_BLOCK_H;
257 int start_slice, end_slice;
258 int base_blocks_per_slice = h_block / ctx->slice_count;
259 int remainder_blocks = h_block % ctx->slice_count;
261 /* When the frame height (in blocks) doesn't divide evenly between the
262 * number of slices, spread the remaining blocks evenly between the first
264 start_slice = slice * base_blocks_per_slice;
265 /* Add any extra blocks (one per slice) that have been added before this slice */
266 start_slice += FFMIN(slice, remainder_blocks);
268 end_slice = start_slice + base_blocks_per_slice;
269 /* Add an extra block if there are still remainder blocks to be accounted for */
270 if (slice < remainder_blocks)
273 for (y = start_slice; y < end_slice; y++) {
274 uint8_t *p = frame->data[0] + y * frame->linesize[0] * TEXTURE_BLOCK_H;
275 int off = y * w_block;
276 for (x = 0; x < w_block; x++) {
277 if (texture_num == 0) {
278 ctx->tex_fun(p + x * 4 * ctx->uncompress_pix_size, frame->linesize[0],
279 d + (off + x) * ctx->tex_rat);
281 ctx->tex_fun2(p + x * 4 * ctx->uncompress_pix_size, frame->linesize[0],
282 d + (off + x) * ctx->tex_rat2);
290 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
291 int slice, int thread_nb)
293 return decompress_texture_thread_internal(avctx, arg, slice, thread_nb, 0);
296 static int decompress_texture2_thread(AVCodecContext *avctx, void *arg,
297 int slice, int thread_nb)
299 return decompress_texture_thread_internal(avctx, arg, slice, thread_nb, 1);
302 static int hap_decode(AVCodecContext *avctx, void *data,
303 int *got_frame, AVPacket *avpkt)
305 HapContext *ctx = avctx->priv_data;
309 enum HapSectionType section_type;
310 int start_texture_section = 0;
311 int tex_rat[2] = {0, 0};
313 bytestream2_init(&ctx->gbc, avpkt->data, avpkt->size);
315 tex_rat[0] = ctx->tex_rat;
317 /* check for multi texture header */
318 if (ctx->texture_count == 2) {
319 ret = ff_hap_parse_section_header(&ctx->gbc, §ion_size, §ion_type);
322 if ((section_type & 0x0F) != 0x0D) {
323 av_log(avctx, AV_LOG_ERROR, "Invalid section type in 2 textures mode %#04x.\n", section_type);
324 return AVERROR_INVALIDDATA;
326 start_texture_section = 4;
327 tex_rat[1] = ctx->tex_rat2;
330 /* Get the output frame ready to receive data */
332 ret = ff_thread_get_buffer(avctx, &tframe, 0);
336 for (t = 0; t < ctx->texture_count; t++) {
337 bytestream2_seek(&ctx->gbc, start_texture_section, SEEK_SET);
339 /* Check for section header */
340 ret = hap_parse_frame_header(avctx);
344 if (ctx->tex_size != (avctx->coded_width / TEXTURE_BLOCK_W)
345 *(avctx->coded_height / TEXTURE_BLOCK_H)
347 av_log(avctx, AV_LOG_ERROR, "uncompressed size mismatches\n");
348 return AVERROR_INVALIDDATA;
351 start_texture_section += ctx->texture_section_size + 4;
353 if (avctx->codec->update_thread_context)
354 ff_thread_finish_setup(avctx);
356 /* Unpack the DXT texture */
357 if (hap_can_use_tex_in_place(ctx)) {
359 /* Only DXTC texture compression in a contiguous block */
360 ctx->tex_data = ctx->gbc.buffer;
361 tex_size = FFMIN(ctx->texture_section_size, bytestream2_get_bytes_left(&ctx->gbc));
362 if (tex_size < (avctx->coded_width / TEXTURE_BLOCK_W)
363 *(avctx->coded_height / TEXTURE_BLOCK_H)
365 av_log(avctx, AV_LOG_ERROR, "Insufficient data\n");
366 return AVERROR_INVALIDDATA;
369 /* Perform the second-stage decompression */
370 ret = av_reallocp(&ctx->tex_buf, ctx->tex_size);
374 avctx->execute2(avctx, decompress_chunks_thread, NULL,
375 ctx->chunk_results, ctx->chunk_count);
377 for (i = 0; i < ctx->chunk_count; i++) {
378 if (ctx->chunk_results[i] < 0)
379 return ctx->chunk_results[i];
382 ctx->tex_data = ctx->tex_buf;
385 /* Use the decompress function on the texture, one block per thread */
387 avctx->execute2(avctx, decompress_texture_thread, tframe.f, NULL, ctx->slice_count);
390 avctx->execute2(avctx, decompress_texture2_thread, tframe.f, NULL, ctx->slice_count);
394 /* Frame is ready to be output */
395 tframe.f->pict_type = AV_PICTURE_TYPE_I;
396 tframe.f->key_frame = 1;
402 static av_cold int hap_init(AVCodecContext *avctx)
404 HapContext *ctx = avctx->priv_data;
405 const char *texture_name;
406 int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
409 av_log(avctx, AV_LOG_ERROR, "Invalid video size %dx%d.\n",
410 avctx->width, avctx->height);
414 /* Since codec is based on 4x4 blocks, size is aligned to 4 */
415 avctx->coded_width = FFALIGN(avctx->width, TEXTURE_BLOCK_W);
416 avctx->coded_height = FFALIGN(avctx->height, TEXTURE_BLOCK_H);
418 ff_texturedsp_init(&ctx->dxtc);
420 ctx->texture_count = 1;
421 ctx->uncompress_pix_size = 4;
423 switch (avctx->codec_tag) {
424 case MKTAG('H','a','p','1'):
425 texture_name = "DXT1";
427 ctx->tex_fun = ctx->dxtc.dxt1_block;
428 avctx->pix_fmt = AV_PIX_FMT_RGB0;
430 case MKTAG('H','a','p','5'):
431 texture_name = "DXT5";
433 ctx->tex_fun = ctx->dxtc.dxt5_block;
434 avctx->pix_fmt = AV_PIX_FMT_RGBA;
436 case MKTAG('H','a','p','Y'):
437 texture_name = "DXT5-YCoCg-scaled";
439 ctx->tex_fun = ctx->dxtc.dxt5ys_block;
440 avctx->pix_fmt = AV_PIX_FMT_RGB0;
442 case MKTAG('H','a','p','A'):
443 texture_name = "RGTC1";
445 ctx->tex_fun = ctx->dxtc.rgtc1u_gray_block;
446 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
447 ctx->uncompress_pix_size = 1;
449 case MKTAG('H','a','p','M'):
450 texture_name = "DXT5-YCoCg-scaled / RGTC1";
453 ctx->tex_fun = ctx->dxtc.dxt5ys_block;
454 ctx->tex_fun2 = ctx->dxtc.rgtc1u_alpha_block;
455 avctx->pix_fmt = AV_PIX_FMT_RGBA;
456 ctx->texture_count = 2;
459 return AVERROR_DECODER_NOT_FOUND;
462 av_log(avctx, AV_LOG_DEBUG, "%s texture\n", texture_name);
464 ctx->slice_count = av_clip(avctx->thread_count, 1,
465 avctx->coded_height / TEXTURE_BLOCK_H);
470 static av_cold int hap_close(AVCodecContext *avctx)
472 HapContext *ctx = avctx->priv_data;
474 ff_hap_free_context(ctx);
479 AVCodec ff_hap_decoder = {
481 .long_name = NULL_IF_CONFIG_SMALL("Vidvox Hap"),
482 .type = AVMEDIA_TYPE_VIDEO,
483 .id = AV_CODEC_ID_HAP,
485 .decode = hap_decode,
487 .priv_data_size = sizeof(HapContext),
488 .capabilities = AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_SLICE_THREADS |
490 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
491 FF_CODEC_CAP_INIT_CLEANUP,
492 .codec_tags = (const uint32_t []){
493 MKTAG('H','a','p','1'),
494 MKTAG('H','a','p','5'),
495 MKTAG('H','a','p','Y'),
496 MKTAG('H','a','p','A'),
497 MKTAG('H','a','p','M'),