avcodec/hapdec: log reason for failure when texture type doesn't match stream
[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 FFmpeg.
6  *
7  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 *compressorstr;
78     int ret;
79
80     if ((avctx->codec_tag == MKTAG('H','a','p','1') && (ctx->section_type & 0x0F) != HAP_FMT_RGBDXT1)
81         || (avctx->codec_tag == MKTAG('H','a','p','5') && (ctx->section_type & 0x0F) != HAP_FMT_RGBADXT5)
82         || (avctx->codec_tag == MKTAG('H','a','p','Y') && (ctx->section_type & 0x0F) != HAP_FMT_YCOCGDXT5)) {
83         av_log(avctx, AV_LOG_ERROR, "Invalid texture format %#04x.\n", ctx->section_type & 0x0F);
84         return AVERROR_INVALIDDATA;
85     }
86
87     switch (ctx->section_type & 0xF0) {
88     case HAP_COMP_NONE:
89         /* Only DXTC texture compression */
90         ctx->tex_data = gbc->buffer;
91         ctx->tex_size = length;
92         compressorstr = "none";
93         break;
94     case HAP_COMP_SNAPPY:
95         snappy_size = ff_snappy_peek_uncompressed_length(gbc);
96         ret = av_reallocp(&ctx->snappied, snappy_size);
97         if (ret < 0) {
98             return ret;
99         }
100         /* Uncompress the frame */
101         ret = ff_snappy_uncompress(gbc, ctx->snappied, &snappy_size);
102         if (ret < 0) {
103              av_log(avctx, AV_LOG_ERROR, "Snappy uncompress error\n");
104              return ret;
105         }
106
107         ctx->tex_data = ctx->snappied;
108         ctx->tex_size = snappy_size;
109         compressorstr = "snappy";
110         break;
111     case HAP_COMP_COMPLEX:
112         compressorstr = "complex";
113         avpriv_request_sample(avctx, "Complex Hap compressor");
114         return AVERROR_PATCHWELCOME;
115         break;
116     default:
117         av_log(avctx, AV_LOG_ERROR,
118                "Invalid compressor mode %02X.\n", ctx->section_type);
119         return AVERROR_INVALIDDATA;
120     }
121
122     av_log(avctx, AV_LOG_DEBUG, "%s compressor\n", compressorstr);
123
124     return 0;
125 }
126
127 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
128                                      int block_nb, int thread_nb)
129 {
130     HapContext *ctx = avctx->priv_data;
131     AVFrame *frame = arg;
132     int x = (TEXTURE_BLOCK_W * block_nb) % avctx->coded_width;
133     int y = TEXTURE_BLOCK_H * (TEXTURE_BLOCK_W * block_nb / avctx->coded_width);
134     uint8_t *p = frame->data[0] + x * 4 + y * frame->linesize[0];
135     const uint8_t *d = ctx->tex_data + block_nb * ctx->tex_rat;
136
137     ctx->tex_fun(p, frame->linesize[0], d);
138     return 0;
139 }
140
141 static int hap_decode(AVCodecContext *avctx, void *data,
142                       int *got_frame, AVPacket *avpkt)
143 {
144     HapContext *ctx = avctx->priv_data;
145     ThreadFrame tframe;
146     int ret, length;
147     int blocks = avctx->coded_width * avctx->coded_height / (TEXTURE_BLOCK_W * TEXTURE_BLOCK_H);
148
149     bytestream2_init(&ctx->gbc, avpkt->data, avpkt->size);
150
151     /* Check for section header */
152     length = parse_section_header(avctx);
153     if (length < 0) {
154         av_log(avctx, AV_LOG_ERROR, "Frame is too small.\n");
155         return length;
156     }
157
158     /* Prepare the texture buffer and decompress function */
159     ret = setup_texture(avctx, length);
160     if (ret < 0)
161         return ret;
162
163     /* Get the output frame ready to receive data */
164     tframe.f = data;
165     ret = ff_thread_get_buffer(avctx, &tframe, 0);
166     if (ret < 0)
167         return ret;
168     if (avctx->codec->update_thread_context)
169         ff_thread_finish_setup(avctx);
170
171     /* Use the decompress function on the texture, one block per thread */
172     avctx->execute2(avctx, decompress_texture_thread, tframe.f, NULL, blocks);
173
174     /* Frame is ready to be output */
175     tframe.f->pict_type = AV_PICTURE_TYPE_I;
176     tframe.f->key_frame = 1;
177     *got_frame = 1;
178
179     return avpkt->size;
180 }
181
182 static av_cold int hap_init(AVCodecContext *avctx)
183 {
184     HapContext *ctx = avctx->priv_data;
185     const char *texture_name;
186     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
187
188     if (ret < 0) {
189         av_log(avctx, AV_LOG_ERROR, "Invalid video size %dx%d.\n",
190                avctx->width, avctx->height);
191         return ret;
192     }
193
194     /* Since codec is based on 4x4 blocks, size is aligned to 4 */
195     avctx->coded_width  = FFALIGN(avctx->width,  TEXTURE_BLOCK_W);
196     avctx->coded_height = FFALIGN(avctx->height, TEXTURE_BLOCK_H);
197
198     /* Technically only one mode has alpha, but 32 bits are easier to handle */
199     avctx->pix_fmt = AV_PIX_FMT_RGBA;
200
201     ff_texturedsp_init(&ctx->dxtc);
202
203     switch (avctx->codec_tag) {
204     case MKTAG('H','a','p','1'):
205         texture_name = "DXT1";
206         ctx->tex_rat = 8;
207         ctx->tex_fun = ctx->dxtc.dxt1_block;
208         break;
209     case MKTAG('H','a','p','5'):
210         texture_name = "DXT5";
211         ctx->tex_rat = 16;
212         ctx->tex_fun = ctx->dxtc.dxt5_block;
213         break;
214     case MKTAG('H','a','p','Y'):
215         texture_name = "DXT5-YCoCg-scaled";
216         ctx->tex_rat = 16;
217         ctx->tex_fun = ctx->dxtc.dxt5ys_block;
218         break;
219     default:
220         return AVERROR_DECODER_NOT_FOUND;
221     }
222
223     av_log(avctx, AV_LOG_DEBUG, "%s texture\n", texture_name);
224
225     return 0;
226 }
227
228 static av_cold int hap_close(AVCodecContext *avctx)
229 {
230     HapContext *ctx = avctx->priv_data;
231
232     av_freep(&ctx->snappied);
233
234     return 0;
235 }
236
237 AVCodec ff_hap_decoder = {
238     .name           = "hap",
239     .long_name      = NULL_IF_CONFIG_SMALL("Vidvox Hap decoder"),
240     .type           = AVMEDIA_TYPE_VIDEO,
241     .id             = AV_CODEC_ID_HAP,
242     .init           = hap_init,
243     .decode         = hap_decode,
244     .close          = hap_close,
245     .priv_data_size = sizeof(HapContext),
246     .capabilities   = CODEC_CAP_FRAME_THREADS | CODEC_CAP_SLICE_THREADS |
247                       CODEC_CAP_DR1,
248     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
249                       FF_CODEC_CAP_INIT_CLEANUP,
250 };