Merge commit 'ae5a8dca675ee544178225256893e679b750cb63'
[ffmpeg.git] / libavcodec / hapdec.c
1 /*
2  * Vidvox Hap decoder
3  * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
4  * Copyright (C) 2015 Tom Butterworth <bangnoise@gmail.com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Hap decoder
26  *
27  * Fourcc: Hap1, Hap5, HapY
28  *
29  * https://github.com/Vidvox/hap/blob/master/documentation/HapVideoDRAFT.md
30  */
31
32 #include <stdint.h>
33
34 #include "libavutil/imgutils.h"
35
36 #include "avcodec.h"
37 #include "bytestream.h"
38 #include "hap.h"
39 #include "internal.h"
40 #include "snappy.h"
41 #include "texturedsp.h"
42 #include "thread.h"
43 #include "memory.h"
44
45 /* The first three bytes are the size of the section past the header, or zero
46  * if the length is stored in the next long word. The fourth byte in the first
47  * long word indicates the type of the current section. */
48 static int parse_section_header(GetByteContext *gbc, int *section_size,
49                                 enum HapSectionType *section_type)
50 {
51     if (bytestream2_get_bytes_left(gbc) < 4)
52         return AVERROR_INVALIDDATA;
53
54     *section_size = bytestream2_get_le24(gbc);
55     *section_type = bytestream2_get_byte(gbc);
56
57     if (*section_size == 0) {
58         if (bytestream2_get_bytes_left(gbc) < 4)
59             return AVERROR_INVALIDDATA;
60
61         *section_size = bytestream2_get_le32(gbc);
62     }
63
64     if (*section_size > bytestream2_get_bytes_left(gbc))
65         return AVERROR_INVALIDDATA;
66     else
67         return 0;
68 }
69
70 static int hap_parse_decode_instructions(HapContext *ctx, int size)
71 {
72     GetByteContext *gbc = &ctx->gbc;
73     int section_size;
74     enum HapSectionType section_type;
75     int is_first_table = 1, had_offsets = 0, had_compressors = 0, had_sizes = 0;
76     int i, ret;
77
78     while (size > 0) {
79         int stream_remaining = bytestream2_get_bytes_left(gbc);
80         ret = parse_section_header(gbc, &section_size, &section_type);
81         if (ret != 0)
82             return ret;
83
84         size -= stream_remaining - bytestream2_get_bytes_left(gbc);
85
86         switch (section_type) {
87             case HAP_ST_COMPRESSOR_TABLE:
88                 ret = ff_hap_set_chunk_count(ctx, section_size, is_first_table);
89                 if (ret != 0)
90                     return ret;
91                 for (i = 0; i < section_size; i++) {
92                     ctx->chunks[i].compressor = bytestream2_get_byte(gbc) << 4;
93                 }
94                 had_compressors = 1;
95                 is_first_table = 0;
96                 break;
97             case HAP_ST_SIZE_TABLE:
98                 ret = ff_hap_set_chunk_count(ctx, section_size / 4, is_first_table);
99                 if (ret != 0)
100                     return ret;
101                 for (i = 0; i < section_size / 4; i++) {
102                     ctx->chunks[i].compressed_size = bytestream2_get_le32(gbc);
103                 }
104                 had_sizes = 1;
105                 is_first_table = 0;
106                 break;
107             case HAP_ST_OFFSET_TABLE:
108                 ret = ff_hap_set_chunk_count(ctx, section_size / 4, is_first_table);
109                 if (ret != 0)
110                     return ret;
111                 for (i = 0; i < section_size / 4; i++) {
112                     ctx->chunks[i].compressed_offset = bytestream2_get_le32(gbc);
113                 }
114                 had_offsets = 1;
115                 is_first_table = 0;
116                 break;
117             default:
118                 break;
119         }
120         size -= section_size;
121     }
122
123     if (!had_sizes || !had_compressors)
124         return AVERROR_INVALIDDATA;
125
126     /* The offsets table is optional. If not present than calculate offsets by
127      * summing the sizes of preceding chunks. */
128     if (!had_offsets) {
129         size_t running_size = 0;
130         for (i = 0; i < ctx->chunk_count; i++) {
131             ctx->chunks[i].compressed_offset = running_size;
132             running_size += ctx->chunks[i].compressed_size;
133         }
134     }
135
136     return 0;
137 }
138
139 static int hap_can_use_tex_in_place(HapContext *ctx)
140 {
141     int i;
142     size_t running_offset = 0;
143     for (i = 0; i < ctx->chunk_count; i++) {
144         if (ctx->chunks[i].compressed_offset != running_offset
145             || ctx->chunks[i].compressor != HAP_COMP_NONE)
146             return 0;
147         running_offset += ctx->chunks[i].compressed_size;
148     }
149     return 1;
150 }
151
152 static int hap_parse_frame_header(AVCodecContext *avctx)
153 {
154     HapContext *ctx = avctx->priv_data;
155     GetByteContext *gbc = &ctx->gbc;
156     int section_size;
157     enum HapSectionType section_type;
158     const char *compressorstr;
159     int i, ret;
160
161     ret = parse_section_header(gbc, &section_size, &section_type);
162     if (ret != 0)
163         return ret;
164
165     if ((avctx->codec_tag == MKTAG('H','a','p','1') && (section_type & 0x0F) != HAP_FMT_RGBDXT1)
166         || (avctx->codec_tag == MKTAG('H','a','p','5') && (section_type & 0x0F) != HAP_FMT_RGBADXT5)
167         || (avctx->codec_tag == MKTAG('H','a','p','Y') && (section_type & 0x0F) != HAP_FMT_YCOCGDXT5)) {
168         av_log(avctx, AV_LOG_ERROR, "Invalid texture format %#04x.\n", section_type & 0x0F);
169         return AVERROR_INVALIDDATA;
170     }
171
172     switch (section_type & 0xF0) {
173         case HAP_COMP_NONE:
174         case HAP_COMP_SNAPPY:
175             ret = ff_hap_set_chunk_count(ctx, 1, 1);
176             if (ret == 0) {
177                 ctx->chunks[0].compressor = section_type & 0xF0;
178                 ctx->chunks[0].compressed_offset = 0;
179                 ctx->chunks[0].compressed_size = section_size;
180             }
181             if (ctx->chunks[0].compressor == HAP_COMP_NONE) {
182                 compressorstr = "none";
183             } else {
184                 compressorstr = "snappy";
185             }
186             break;
187         case HAP_COMP_COMPLEX:
188             ret = parse_section_header(gbc, &section_size, &section_type);
189             if (ret == 0 && section_type != HAP_ST_DECODE_INSTRUCTIONS)
190                 ret = AVERROR_INVALIDDATA;
191             if (ret == 0)
192                 ret = hap_parse_decode_instructions(ctx, section_size);
193             compressorstr = "complex";
194             break;
195         default:
196             ret = AVERROR_INVALIDDATA;
197             break;
198     }
199
200     if (ret != 0)
201         return ret;
202
203     /* Check the frame is valid and read the uncompressed chunk sizes */
204     ctx->tex_size = 0;
205     for (i = 0; i < ctx->chunk_count; i++) {
206         HapChunk *chunk = &ctx->chunks[i];
207
208         /* Check the compressed buffer is valid */
209         if (chunk->compressed_offset + chunk->compressed_size > bytestream2_get_bytes_left(gbc))
210             return AVERROR_INVALIDDATA;
211
212         /* Chunks are unpacked sequentially, ctx->tex_size is the uncompressed
213          * size thus far */
214         chunk->uncompressed_offset = ctx->tex_size;
215
216         /* Fill out uncompressed size */
217         if (chunk->compressor == HAP_COMP_SNAPPY) {
218             GetByteContext gbc_tmp;
219             int64_t uncompressed_size;
220             bytestream2_init(&gbc_tmp, gbc->buffer + chunk->compressed_offset,
221                              chunk->compressed_size);
222             uncompressed_size = ff_snappy_peek_uncompressed_length(&gbc_tmp);
223             if (uncompressed_size < 0) {
224                 return uncompressed_size;
225             }
226             chunk->uncompressed_size = uncompressed_size;
227         } else if (chunk->compressor == HAP_COMP_NONE) {
228             chunk->uncompressed_size = chunk->compressed_size;
229         } else {
230             return AVERROR_INVALIDDATA;
231         }
232         ctx->tex_size += chunk->uncompressed_size;
233     }
234
235     av_log(avctx, AV_LOG_DEBUG, "%s compressor\n", compressorstr);
236
237     return ret;
238 }
239
240 static int decompress_chunks_thread(AVCodecContext *avctx, void *arg,
241                                     int chunk_nb, int thread_nb)
242 {
243     HapContext *ctx = avctx->priv_data;
244
245     HapChunk *chunk = &ctx->chunks[chunk_nb];
246     GetByteContext gbc;
247     uint8_t *dst = ctx->tex_buf + chunk->uncompressed_offset;
248
249     bytestream2_init(&gbc, ctx->gbc.buffer + chunk->compressed_offset, chunk->compressed_size);
250
251     if (chunk->compressor == HAP_COMP_SNAPPY) {
252         int ret;
253         int64_t uncompressed_size = ctx->tex_size;
254         /* Uncompress the frame */
255         ret = ff_snappy_uncompress(&gbc, dst, &uncompressed_size);
256         if (ret < 0) {
257              av_log(avctx, AV_LOG_ERROR, "Snappy uncompress error\n");
258              return ret;
259         }
260     } else if (chunk->compressor == HAP_COMP_NONE) {
261         bytestream2_get_buffer(&gbc, dst, chunk->compressed_size);
262     }
263
264     return 0;
265 }
266
267 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
268                                      int slice, int thread_nb)
269 {
270     HapContext *ctx = avctx->priv_data;
271     AVFrame *frame = arg;
272     const uint8_t *d = ctx->tex_data;
273     int w_block = avctx->coded_width / TEXTURE_BLOCK_W;
274     int h_block = avctx->coded_height / TEXTURE_BLOCK_H;
275     int x, y;
276     int start_slice, end_slice;
277     int base_blocks_per_slice = h_block / ctx->slice_count;
278     int remainder_blocks = h_block % ctx->slice_count;
279
280     /* When the frame height (in blocks) doesn't divide evenly between the
281      * number of slices, spread the remaining blocks evenly between the first
282      * operations */
283     start_slice = slice * base_blocks_per_slice;
284     /* Add any extra blocks (one per slice) that have been added before this slice */
285     start_slice += FFMIN(slice, remainder_blocks);
286
287     end_slice = start_slice + base_blocks_per_slice;
288     /* Add an extra block if there are still remainder blocks to be accounted for */
289     if (slice < remainder_blocks)
290         end_slice++;
291
292     for (y = start_slice; y < end_slice; y++) {
293         uint8_t *p = frame->data[0] + y * frame->linesize[0] * TEXTURE_BLOCK_H;
294         int off  = y * w_block;
295         for (x = 0; x < w_block; x++) {
296             ctx->tex_fun(p + x * 16, frame->linesize[0],
297                          d + (off + x) * ctx->tex_rat);
298         }
299     }
300
301     return 0;
302 }
303
304 static int hap_decode(AVCodecContext *avctx, void *data,
305                       int *got_frame, AVPacket *avpkt)
306 {
307     HapContext *ctx = avctx->priv_data;
308     ThreadFrame tframe;
309     int ret, i;
310
311     bytestream2_init(&ctx->gbc, avpkt->data, avpkt->size);
312
313     /* Check for section header */
314     ret = hap_parse_frame_header(avctx);
315     if (ret < 0)
316         return ret;
317
318     /* Get the output frame ready to receive data */
319     tframe.f = data;
320     ret = ff_thread_get_buffer(avctx, &tframe, 0);
321     if (ret < 0)
322         return ret;
323     if (avctx->codec->update_thread_context)
324         ff_thread_finish_setup(avctx);
325
326     /* Unpack the DXT texture */
327     if (hap_can_use_tex_in_place(ctx)) {
328         /* Only DXTC texture compression in a contiguous block */
329         ctx->tex_data = ctx->gbc.buffer;
330     } else {
331         /* Perform the second-stage decompression */
332         ret = av_reallocp(&ctx->tex_buf, ctx->tex_size);
333         if (ret < 0)
334             return ret;
335
336         avctx->execute2(avctx, decompress_chunks_thread, NULL,
337                         ctx->chunk_results, ctx->chunk_count);
338
339         for (i = 0; i < ctx->chunk_count; i++) {
340             if (ctx->chunk_results[i] < 0)
341                 return ctx->chunk_results[i];
342         }
343
344         ctx->tex_data = ctx->tex_buf;
345     }
346
347     /* Use the decompress function on the texture, one block per thread */
348     avctx->execute2(avctx, decompress_texture_thread, tframe.f, NULL, ctx->slice_count);
349
350     /* Frame is ready to be output */
351     tframe.f->pict_type = AV_PICTURE_TYPE_I;
352     tframe.f->key_frame = 1;
353     *got_frame = 1;
354
355     return avpkt->size;
356 }
357
358 static av_cold int hap_init(AVCodecContext *avctx)
359 {
360     HapContext *ctx = avctx->priv_data;
361     const char *texture_name;
362     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
363
364     if (ret < 0) {
365         av_log(avctx, AV_LOG_ERROR, "Invalid video size %dx%d.\n",
366                avctx->width, avctx->height);
367         return ret;
368     }
369
370     /* Since codec is based on 4x4 blocks, size is aligned to 4 */
371     avctx->coded_width  = FFALIGN(avctx->width,  TEXTURE_BLOCK_W);
372     avctx->coded_height = FFALIGN(avctx->height, TEXTURE_BLOCK_H);
373
374     /* Technically only one mode has alpha, but 32 bits are easier to handle */
375     avctx->pix_fmt = AV_PIX_FMT_RGBA;
376
377     ff_texturedsp_init(&ctx->dxtc);
378
379     switch (avctx->codec_tag) {
380     case MKTAG('H','a','p','1'):
381         texture_name = "DXT1";
382         ctx->tex_rat = 8;
383         ctx->tex_fun = ctx->dxtc.dxt1_block;
384         break;
385     case MKTAG('H','a','p','5'):
386         texture_name = "DXT5";
387         ctx->tex_rat = 16;
388         ctx->tex_fun = ctx->dxtc.dxt5_block;
389         break;
390     case MKTAG('H','a','p','Y'):
391         texture_name = "DXT5-YCoCg-scaled";
392         ctx->tex_rat = 16;
393         ctx->tex_fun = ctx->dxtc.dxt5ys_block;
394         break;
395     default:
396         return AVERROR_DECODER_NOT_FOUND;
397     }
398
399     av_log(avctx, AV_LOG_DEBUG, "%s texture\n", texture_name);
400
401     ctx->slice_count = av_clip(avctx->thread_count, 1,
402                                avctx->coded_height / TEXTURE_BLOCK_H);
403
404     return 0;
405 }
406
407 static av_cold int hap_close(AVCodecContext *avctx)
408 {
409     HapContext *ctx = avctx->priv_data;
410
411     ff_hap_free_context(ctx);
412
413     return 0;
414 }
415
416 AVCodec ff_hap_decoder = {
417     .name           = "hap",
418     .long_name      = NULL_IF_CONFIG_SMALL("Vidvox Hap decoder"),
419     .type           = AVMEDIA_TYPE_VIDEO,
420     .id             = AV_CODEC_ID_HAP,
421     .init           = hap_init,
422     .decode         = hap_decode,
423     .close          = hap_close,
424     .priv_data_size = sizeof(HapContext),
425     .capabilities   = CODEC_CAP_FRAME_THREADS | CODEC_CAP_SLICE_THREADS |
426                       CODEC_CAP_DR1,
427     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
428                       FF_CODEC_CAP_INIT_CLEANUP,
429 };