snappy: Refactor so ff_snappy_uncompress() uses an existing buffer
[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         snappy_size = ff_snappy_peek_uncompressed_length(gbc);
112         ret = av_reallocp(&ctx->snappied, snappy_size);
113         if (ret < 0) {
114             return ret;
115         }
116         /* Uncompress the frame */
117         ret = ff_snappy_uncompress(gbc, ctx->snappied, &snappy_size);
118         if (ret < 0) {
119              av_log(avctx, AV_LOG_ERROR, "Snappy uncompress error\n");
120              return ret;
121         }
122
123         ctx->tex_data = ctx->snappied;
124         ctx->tex_size = snappy_size;
125         compressorstr = "snappy";
126         break;
127     case HAP_COMP_COMPLEX:
128         compressorstr = "complex";
129         avpriv_request_sample(avctx, "Complex Hap compressor");
130         return AVERROR_PATCHWELCOME;
131         break;
132     default:
133         av_log(avctx, AV_LOG_ERROR,
134                "Invalid compressor mode %02X.\n", ctx->section_type);
135         return AVERROR_INVALIDDATA;
136     }
137
138     av_log(avctx, AV_LOG_DEBUG, "%s texture with %s compressor\n",
139            texture_name, compressorstr);
140
141     return 0;
142 }
143
144 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
145                                      int slice, int thread_nb)
146 {
147     HapContext *ctx = avctx->priv_data;
148     AVFrame *frame = arg;
149     const uint8_t *d = ctx->tex_data;
150     int w_block = avctx->coded_width / TEXTURE_BLOCK_W;
151     int h_block = avctx->coded_height / TEXTURE_BLOCK_H;
152     int x, y;
153     int start_slice, end_slice;
154     int base_blocks_per_slice = h_block / ctx->slice_count;
155     int remainder_blocks = h_block % ctx->slice_count;
156
157     /* When the frame height (in blocks) doesn't divide evenly between the
158      * number of slices, spread the remaining blocks evenly between the first
159      * operations */
160     start_slice = slice * base_blocks_per_slice;
161     /* Add any extra blocks (one per slice) that have been added before this slice */
162     start_slice += FFMIN(slice, remainder_blocks);
163
164     end_slice = start_slice + base_blocks_per_slice;
165     /* Add an extra block if there are still remainder blocks to be accounted for */
166     if (slice < remainder_blocks)
167         end_slice++;
168
169     for (y = start_slice; y < end_slice; y++) {
170         uint8_t *p = frame->data[0] + y * frame->linesize[0] * TEXTURE_BLOCK_H;
171         int off  = y * w_block;
172         for (x = 0; x < w_block; x++) {
173             ctx->tex_fun(p + x * 16, frame->linesize[0],
174                          d + (off + x) * ctx->tex_rat);
175         }
176     }
177
178     return 0;
179 }
180
181 static int hap_decode(AVCodecContext *avctx, void *data,
182                       int *got_frame, AVPacket *avpkt)
183 {
184     HapContext *ctx = avctx->priv_data;
185     ThreadFrame tframe;
186     int ret, length;
187
188     bytestream2_init(&ctx->gbc, avpkt->data, avpkt->size);
189
190     /* Check for section header */
191     length = parse_section_header(avctx);
192     if (length < 0) {
193         av_log(avctx, AV_LOG_ERROR, "Frame is too small.\n");
194         return length;
195     }
196
197     /* Prepare the texture buffer and decompress function */
198     ret = setup_texture(avctx, length);
199     if (ret < 0)
200         return ret;
201
202     /* Get the output frame ready to receive data */
203     tframe.f = data;
204     ret = ff_thread_get_buffer(avctx, &tframe, 0);
205     if (ret < 0)
206         return ret;
207     ff_thread_finish_setup(avctx);
208
209     /* Use the decompress function on the texture, one block per thread */
210     avctx->execute2(avctx, decompress_texture_thread, tframe.f, NULL, ctx->slice_count);
211
212     /* Frame is ready to be output */
213     tframe.f->pict_type = AV_PICTURE_TYPE_I;
214     tframe.f->key_frame = 1;
215     *got_frame = 1;
216
217     return avpkt->size;
218 }
219
220 static av_cold int hap_init(AVCodecContext *avctx)
221 {
222     HapContext *ctx = avctx->priv_data;
223     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
224
225     if (ret < 0) {
226         av_log(avctx, AV_LOG_ERROR, "Invalid video size %dx%d.\n",
227                avctx->width, avctx->height);
228         return ret;
229     }
230
231     /* Since codec is based on 4x4 blocks, size is aligned to 4 */
232     avctx->coded_width  = FFALIGN(avctx->width,  TEXTURE_BLOCK_W);
233     avctx->coded_height = FFALIGN(avctx->height, TEXTURE_BLOCK_H);
234
235     /* Technically only one mode has alpha, but 32 bits are easier to handle */
236     avctx->pix_fmt = AV_PIX_FMT_RGBA;
237
238     ff_texturedsp_init(&ctx->dxtc);
239
240     ctx->slice_count = av_clip(avctx->thread_count, 1,
241                                avctx->coded_height / TEXTURE_BLOCK_H);
242
243     return 0;
244 }
245
246 static av_cold int hap_close(AVCodecContext *avctx)
247 {
248     HapContext *ctx = avctx->priv_data;
249
250     av_freep(&ctx->snappied);
251
252     return 0;
253 }
254
255 AVCodec ff_hap_decoder = {
256     .name           = "hap",
257     .long_name      = NULL_IF_CONFIG_SMALL("Vidvox Hap decoder"),
258     .type           = AVMEDIA_TYPE_VIDEO,
259     .id             = AV_CODEC_ID_HAP,
260     .init           = hap_init,
261     .decode         = hap_decode,
262     .close          = hap_close,
263     .priv_data_size = sizeof(HapContext),
264     .capabilities   = CODEC_CAP_FRAME_THREADS | CODEC_CAP_SLICE_THREADS |
265                       CODEC_CAP_DR1,
266     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
267                       FF_CODEC_CAP_INIT_CLEANUP,
268 };