a4880cd3e7afa6fa2871e05cb9e81c63a870ba0e
[ffmpeg.git] / libavcodec / hapdec.c
1 /*
2  * Vidvox Hap decoder
3  * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Hap decoder
25  *
26  * Fourcc: Hap1, Hap5, HapY
27  *
28  * https://github.com/Vidvox/hap/blob/master/documentation/HapVideoDRAFT.md
29  */
30
31 #include <stdint.h>
32
33 #include "libavutil/imgutils.h"
34
35 #include "avcodec.h"
36 #include "bytestream.h"
37 #include "hap.h"
38 #include "internal.h"
39 #include "snappy.h"
40 #include "texturedsp.h"
41 #include "thread.h"
42
43 /* The first three bytes are the size of the section past the header, or zero
44  * if the length is stored in the next long word. The fourth byte in the first
45  * long word indicates the type of the current section. */
46 static int parse_section_header(AVCodecContext *avctx)
47 {
48     HapContext *ctx = avctx->priv_data;
49     GetByteContext *gbc = &ctx->gbc;
50     int length;
51
52     if (bytestream2_get_bytes_left(gbc) < 4)
53         return AVERROR_INVALIDDATA;
54
55     length = bytestream2_get_le24(gbc);
56
57     ctx->section_type = bytestream2_get_byte(gbc);
58
59     if (length == 0) {
60         if (bytestream2_get_bytes_left(gbc) < 4)
61             return AVERROR_INVALIDDATA;
62         length = bytestream2_get_le32(gbc);
63     }
64
65     if (length > bytestream2_get_bytes_left(gbc) || length == 0)
66         return AVERROR_INVALIDDATA;
67
68     return length;
69 }
70
71 /* Prepare the texture to be decompressed */
72 static int setup_texture(AVCodecContext *avctx, size_t length)
73 {
74     HapContext *ctx = avctx->priv_data;
75     GetByteContext *gbc = &ctx->gbc;
76     int64_t snappy_size;
77     const char *texture_name;
78     const char *compressorstr;
79     int ret;
80
81     switch (ctx->section_type & 0x0F) {
82     case HAP_FMT_RGBDXT1:
83         ctx->tex_rat = 8;
84         ctx->tex_fun = ctx->dxtc.dxt1_block;
85         texture_name = "DXT1";
86         break;
87     case HAP_FMT_RGBADXT5:
88         ctx->tex_rat = 16;
89         ctx->tex_fun = ctx->dxtc.dxt5_block;
90         texture_name = "DXT5";
91         break;
92     case HAP_FMT_YCOCGDXT5:
93         ctx->tex_rat = 16;
94         ctx->tex_fun = ctx->dxtc.dxt5ys_block;
95         texture_name = "DXT5-YCoCg-scaled";
96         break;
97     default:
98         av_log(avctx, AV_LOG_ERROR,
99                "Invalid format mode %02X.\n", ctx->section_type);
100         return AVERROR_INVALIDDATA;
101     }
102
103     switch (ctx->section_type & 0xF0) {
104     case HAP_COMP_NONE:
105         /* Only DXTC texture compression */
106         ctx->tex_data = gbc->buffer;
107         ctx->tex_size = length;
108         compressorstr = "none";
109         break;
110     case HAP_COMP_SNAPPY:
111         /* Uncompress the frame */
112         ret = ff_snappy_uncompress(gbc, &ctx->snappied, &snappy_size);
113         if (ret < 0) {
114              av_log(avctx, AV_LOG_ERROR, "Snappy uncompress error\n");
115              return ret;
116         }
117
118         ctx->tex_data = ctx->snappied;
119         ctx->tex_size = snappy_size;
120         compressorstr = "snappy";
121         break;
122     case HAP_COMP_COMPLEX:
123         compressorstr = "complex";
124         avpriv_request_sample(avctx, "Complex Hap compressor");
125         return AVERROR_PATCHWELCOME;
126         break;
127     default:
128         av_log(avctx, AV_LOG_ERROR,
129                "Invalid compressor mode %02X.\n", ctx->section_type);
130         return AVERROR_INVALIDDATA;
131     }
132
133     av_log(avctx, AV_LOG_DEBUG, "%s texture with %s compressor\n",
134            texture_name, compressorstr);
135
136     return 0;
137 }
138
139 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
140                                      int slice, int thread_nb)
141 {
142     HapContext *ctx = avctx->priv_data;
143     AVFrame *frame = arg;
144     const uint8_t *d = ctx->tex_data;
145     int w_block = avctx->coded_width / TEXTURE_BLOCK_W;
146     int h_block = avctx->coded_height / TEXTURE_BLOCK_H;
147     int x, y;
148     int start_slice, end_slice;
149     int base_blocks_per_slice = h_block / ctx->slice_count;
150     int remainder_blocks = h_block % ctx->slice_count;
151
152     /* When the frame height (in blocks) doesn't divide evenly between the
153      * number of slices, spread the remaining blocks evenly between the first
154      * operations */
155     start_slice = slice * base_blocks_per_slice;
156     /* Add any extra blocks (one per slice) that have been added before this slice */
157     start_slice += FFMIN(slice, remainder_blocks);
158
159     end_slice = start_slice + base_blocks_per_slice;
160     /* Add an extra block if there are still remainder blocks to be accounted for */
161     if (slice < remainder_blocks)
162         end_slice++;
163
164     for (y = start_slice; y < end_slice; y++) {
165         uint8_t *p = frame->data[0] + y * frame->linesize[0] * TEXTURE_BLOCK_H;
166         int off  = y * w_block;
167         for (x = 0; x < w_block; x++) {
168             ctx->tex_fun(p + x * 16, frame->linesize[0],
169                          d + (off + x) * ctx->tex_rat);
170         }
171     }
172
173     return 0;
174 }
175
176 static int hap_decode(AVCodecContext *avctx, void *data,
177                       int *got_frame, AVPacket *avpkt)
178 {
179     HapContext *ctx = avctx->priv_data;
180     ThreadFrame tframe;
181     int ret, length;
182
183     bytestream2_init(&ctx->gbc, avpkt->data, avpkt->size);
184
185     /* Check for section header */
186     length = parse_section_header(avctx);
187     if (length < 0) {
188         av_log(avctx, AV_LOG_ERROR, "Frame is too small.\n");
189         return length;
190     }
191
192     /* Prepare the texture buffer and decompress function */
193     ret = setup_texture(avctx, length);
194     if (ret < 0)
195         return ret;
196
197     /* Get the output frame ready to receive data */
198     tframe.f = data;
199     ret = ff_thread_get_buffer(avctx, &tframe, 0);
200     if (ret < 0)
201         return ret;
202     ff_thread_finish_setup(avctx);
203
204     /* Use the decompress function on the texture, one block per thread */
205     avctx->execute2(avctx, decompress_texture_thread, tframe.f, NULL, ctx->slice_count);
206
207     /* Frame is ready to be output */
208     tframe.f->pict_type = AV_PICTURE_TYPE_I;
209     tframe.f->key_frame = 1;
210     *got_frame = 1;
211
212     return avpkt->size;
213 }
214
215 static av_cold int hap_init(AVCodecContext *avctx)
216 {
217     HapContext *ctx = avctx->priv_data;
218     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
219
220     if (ret < 0) {
221         av_log(avctx, AV_LOG_ERROR, "Invalid video size %dx%d.\n",
222                avctx->width, avctx->height);
223         return ret;
224     }
225
226     /* Since codec is based on 4x4 blocks, size is aligned to 4 */
227     avctx->coded_width  = FFALIGN(avctx->width,  TEXTURE_BLOCK_W);
228     avctx->coded_height = FFALIGN(avctx->height, TEXTURE_BLOCK_H);
229
230     /* Technically only one mode has alpha, but 32 bits are easier to handle */
231     avctx->pix_fmt = AV_PIX_FMT_RGBA;
232
233     ff_texturedsp_init(&ctx->dxtc);
234
235     ctx->slice_count = av_clip(avctx->thread_count, 1,
236                                avctx->coded_height / TEXTURE_BLOCK_H);
237
238     return 0;
239 }
240
241 static av_cold int hap_close(AVCodecContext *avctx)
242 {
243     HapContext *ctx = avctx->priv_data;
244
245     av_freep(&ctx->snappied);
246
247     return 0;
248 }
249
250 AVCodec ff_hap_decoder = {
251     .name           = "hap",
252     .long_name      = NULL_IF_CONFIG_SMALL("Vidvox Hap decoder"),
253     .type           = AVMEDIA_TYPE_VIDEO,
254     .id             = AV_CODEC_ID_HAP,
255     .init           = hap_init,
256     .decode         = hap_decode,
257     .close          = hap_close,
258     .priv_data_size = sizeof(HapContext),
259     .capabilities   = CODEC_CAP_FRAME_THREADS | CODEC_CAP_SLICE_THREADS |
260                       CODEC_CAP_DR1,
261     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
262                       FF_CODEC_CAP_INIT_CLEANUP,
263 };