Merge commit 'ed9625eb62be1e1c44cecdd73ea0d80077a15d48'
[ffmpeg.git] / libavcodec / nuv.c
1 /*
2  * NuppelVideo decoder
3  * Copyright (c) 2006 Reimar Doeffinger
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 #include <stdio.h>
23 #include <stdlib.h>
24 #include <limits.h>
25
26 #include "libavutil/bswap.h"
27 #include "libavutil/common.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/lzo.h"
30 #include "libavutil/imgutils.h"
31 #include "avcodec.h"
32 #include "internal.h"
33 #include "rtjpeg.h"
34
35 typedef struct {
36     AVFrame *pic;
37     int codec_frameheader;
38     int quality;
39     int width, height;
40     unsigned int decomp_size;
41     unsigned char *decomp_buf;
42     uint32_t lq[64], cq[64];
43     RTJpegContext rtj;
44     DSPContext dsp;
45 } NuvContext;
46
47 static const uint8_t fallback_lquant[] = {
48     16,  11,  10,  16,  24,  40,  51,  61,
49     12,  12,  14,  19,  26,  58,  60,  55,
50     14,  13,  16,  24,  40,  57,  69,  56,
51     14,  17,  22,  29,  51,  87,  80,  62,
52     18,  22,  37,  56,  68, 109, 103,  77,
53     24,  35,  55,  64,  81, 104, 113,  92,
54     49,  64,  78,  87, 103, 121, 120, 101,
55     72,  92,  95,  98, 112, 100, 103,  99
56 };
57
58 static const uint8_t fallback_cquant[] = {
59     17, 18, 24, 47, 99, 99, 99, 99,
60     18, 21, 26, 66, 99, 99, 99, 99,
61     24, 26, 56, 99, 99, 99, 99, 99,
62     47, 66, 99, 99, 99, 99, 99, 99,
63     99, 99, 99, 99, 99, 99, 99, 99,
64     99, 99, 99, 99, 99, 99, 99, 99,
65     99, 99, 99, 99, 99, 99, 99, 99,
66     99, 99, 99, 99, 99, 99, 99, 99
67 };
68
69 /**
70  * @brief copy frame data from buffer to AVFrame, handling stride.
71  * @param f destination AVFrame
72  * @param src source buffer, does not use any line-stride
73  * @param width width of the video frame
74  * @param height height of the video frame
75  */
76 static void copy_frame(AVFrame *f, const uint8_t *src, int width, int height)
77 {
78     AVPicture pic;
79     avpicture_fill(&pic, src, AV_PIX_FMT_YUV420P, width, height);
80     av_picture_copy((AVPicture *)f, &pic, AV_PIX_FMT_YUV420P, width, height);
81 }
82
83 /**
84  * @brief extract quantization tables from codec data into our context
85  */
86 static int get_quant(AVCodecContext *avctx, NuvContext *c, const uint8_t *buf,
87                      int size)
88 {
89     int i;
90     if (size < 2 * 64 * 4) {
91         av_log(avctx, AV_LOG_ERROR, "insufficient rtjpeg quant data\n");
92         return AVERROR_INVALIDDATA;
93     }
94     for (i = 0; i < 64; i++, buf += 4)
95         c->lq[i] = AV_RL32(buf);
96     for (i = 0; i < 64; i++, buf += 4)
97         c->cq[i] = AV_RL32(buf);
98     return 0;
99 }
100
101 /**
102  * @brief set quantization tables from a quality value
103  */
104 static void get_quant_quality(NuvContext *c, int quality)
105 {
106     int i;
107     quality = FFMAX(quality, 1);
108     for (i = 0; i < 64; i++) {
109         c->lq[i] = (fallback_lquant[i] << 7) / quality;
110         c->cq[i] = (fallback_cquant[i] << 7) / quality;
111     }
112 }
113
114 static int codec_reinit(AVCodecContext *avctx, int width, int height,
115                         int quality)
116 {
117     NuvContext *c = avctx->priv_data;
118     int ret;
119
120     width  = FFALIGN(width,  2);
121     height = FFALIGN(height, 2);
122     if (quality >= 0)
123         get_quant_quality(c, quality);
124     if (width != c->width || height != c->height) {
125         // also reserve space for a possible additional header
126         int buf_size = height * width * 3 / 2
127                      + FFMAX(AV_LZO_OUTPUT_PADDING, FF_INPUT_BUFFER_PADDING_SIZE)
128                      + RTJPEG_HEADER_SIZE;
129         if (buf_size > INT_MAX/8)
130             return -1;
131         if ((ret = av_image_check_size(height, width, 0, avctx)) < 0)
132             return ret;
133         avctx->width  = c->width  = width;
134         avctx->height = c->height = height;
135         av_fast_malloc(&c->decomp_buf, &c->decomp_size,
136                        buf_size);
137         if (!c->decomp_buf) {
138             av_log(avctx, AV_LOG_ERROR,
139                    "Can't allocate decompression buffer.\n");
140             return AVERROR(ENOMEM);
141         }
142         ff_rtjpeg_decode_init(&c->rtj, &c->dsp, c->width, c->height,
143                               c->lq, c->cq);
144         av_frame_unref(c->pic);
145         return 1;
146     } else if (quality != c->quality)
147         ff_rtjpeg_decode_init(&c->rtj, &c->dsp, c->width, c->height,
148                               c->lq, c->cq);
149
150     return 0;
151 }
152
153 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
154                         AVPacket *avpkt)
155 {
156     const uint8_t *buf = avpkt->data;
157     int buf_size       = avpkt->size;
158     NuvContext *c      = avctx->priv_data;
159     AVFrame *picture   = data;
160     int orig_size      = buf_size;
161     int keyframe, ret;
162     int size_change = 0;
163     int result, init_frame = !avctx->frame_number;
164     enum {
165         NUV_UNCOMPRESSED  = '0',
166         NUV_RTJPEG        = '1',
167         NUV_RTJPEG_IN_LZO = '2',
168         NUV_LZO           = '3',
169         NUV_BLACK         = 'N',
170         NUV_COPY_LAST     = 'L'
171     } comptype;
172
173     if (buf_size < 12) {
174         av_log(avctx, AV_LOG_ERROR, "coded frame too small\n");
175         return AVERROR_INVALIDDATA;
176     }
177
178     // codec data (rtjpeg quant tables)
179     if (buf[0] == 'D' && buf[1] == 'R') {
180         int ret;
181         // skip rest of the frameheader.
182         buf       = &buf[12];
183         buf_size -= 12;
184         ret       = get_quant(avctx, c, buf, buf_size);
185         if (ret < 0)
186             return ret;
187         ff_rtjpeg_decode_init(&c->rtj, &c->dsp, c->width, c->height, c->lq,
188                               c->cq);
189         return orig_size;
190     }
191
192     if (buf_size < 12 || buf[0] != 'V') {
193         av_log(avctx, AV_LOG_ERROR, "not a nuv video frame\n");
194         return AVERROR_INVALIDDATA;
195     }
196     comptype = buf[1];
197     switch (comptype) {
198     case NUV_RTJPEG_IN_LZO:
199     case NUV_RTJPEG:
200         keyframe = !buf[2];
201         break;
202     case NUV_COPY_LAST:
203         keyframe = 0;
204         break;
205     default:
206         keyframe = 1;
207         break;
208     }
209 retry:
210     // skip rest of the frameheader.
211     buf       = &buf[12];
212     buf_size -= 12;
213     if (comptype == NUV_RTJPEG_IN_LZO || comptype == NUV_LZO) {
214         int outlen = c->decomp_size - FFMAX(FF_INPUT_BUFFER_PADDING_SIZE, AV_LZO_OUTPUT_PADDING);
215         int inlen  = buf_size;
216         if (av_lzo1x_decode(c->decomp_buf, &outlen, buf, &inlen)) {
217             av_log(avctx, AV_LOG_ERROR, "error during lzo decompression\n");
218             return AVERROR_INVALIDDATA;
219         }
220         buf      = c->decomp_buf;
221         buf_size = c->decomp_size - FFMAX(FF_INPUT_BUFFER_PADDING_SIZE, AV_LZO_OUTPUT_PADDING) - outlen;
222         memset(c->decomp_buf + buf_size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
223     }
224     if (c->codec_frameheader) {
225         int w, h, q;
226         if (buf_size < RTJPEG_HEADER_SIZE) {
227             av_log(avctx, AV_LOG_ERROR, "Too small NUV video frame\n");
228             return AVERROR_INVALIDDATA;
229         }
230         // There seem to exist two variants of this header: one starts with 'V'
231         // and 5 bytes unknown, the other matches current MythTV and is 4 bytes size,
232         // 1 byte header size (== 12), 1 byte version (== 0)
233         if (buf[0] != 'V' && AV_RL16(&buf[4]) != 0x000c) {
234             av_log(avctx, AV_LOG_ERROR, "Unknown secondary frame header (wrong codec_tag?)\n");
235             return AVERROR_INVALIDDATA;
236         }
237         w = AV_RL16(&buf[6]);
238         h = AV_RL16(&buf[8]);
239         q = buf[10];
240         if ((result = codec_reinit(avctx, w, h, q)) < 0)
241             return result;
242         if (result) {
243             buf = avpkt->data;
244             buf_size = avpkt->size;
245             size_change = 1;
246             goto retry;
247         }
248         buf       = &buf[RTJPEG_HEADER_SIZE];
249         buf_size -= RTJPEG_HEADER_SIZE;
250     }
251
252     if (size_change || keyframe) {
253         av_frame_unref(c->pic);
254         init_frame = 1;
255     }
256
257     if ((result = ff_reget_buffer(avctx, c->pic)) < 0)
258         return result;
259     if (init_frame) {
260         memset(c->pic->data[0], 0,    avctx->height * c->pic->linesize[0]);
261         memset(c->pic->data[1], 0x80, avctx->height * c->pic->linesize[1] / 2);
262         memset(c->pic->data[2], 0x80, avctx->height * c->pic->linesize[2] / 2);
263     }
264
265     c->pic->pict_type = keyframe ? AV_PICTURE_TYPE_I : AV_PICTURE_TYPE_P;
266     c->pic->key_frame = keyframe;
267     // decompress/copy/whatever data
268     switch (comptype) {
269     case NUV_LZO:
270     case NUV_UNCOMPRESSED: {
271         int height = c->height;
272         if (buf_size < c->width * height * 3 / 2) {
273             av_log(avctx, AV_LOG_ERROR, "uncompressed frame too short\n");
274             height = buf_size / c->width / 3 * 2;
275         }
276         if(height > 0)
277             copy_frame(c->pic, buf, c->width, height);
278         break;
279     }
280     case NUV_RTJPEG_IN_LZO:
281     case NUV_RTJPEG:
282         ret = ff_rtjpeg_decode_frame_yuv420(&c->rtj, c->pic, buf, buf_size);
283         if (ret < 0)
284             return ret;
285         break;
286     case NUV_BLACK:
287         memset(c->pic->data[0], 0, c->width * c->height);
288         memset(c->pic->data[1], 128, c->width * c->height / 4);
289         memset(c->pic->data[2], 128, c->width * c->height / 4);
290         break;
291     case NUV_COPY_LAST:
292         /* nothing more to do here */
293         break;
294     default:
295         av_log(avctx, AV_LOG_ERROR, "unknown compression\n");
296         return AVERROR_INVALIDDATA;
297     }
298
299     if ((result = av_frame_ref(picture, c->pic)) < 0)
300         return result;
301
302     *got_frame = 1;
303     return orig_size;
304 }
305
306 static av_cold int decode_init(AVCodecContext *avctx)
307 {
308     NuvContext *c  = avctx->priv_data;
309     int ret;
310
311     c->pic = av_frame_alloc();
312     if (!c->pic)
313         return AVERROR(ENOMEM);
314
315     avctx->pix_fmt = AV_PIX_FMT_YUV420P;
316     c->decomp_buf  = NULL;
317     c->quality     = -1;
318     c->width       = 0;
319     c->height      = 0;
320
321     c->codec_frameheader = avctx->codec_tag == MKTAG('R', 'J', 'P', 'G');
322
323     if (avctx->extradata_size)
324         get_quant(avctx, c, avctx->extradata, avctx->extradata_size);
325
326     ff_dsputil_init(&c->dsp, avctx);
327
328     if ((ret = codec_reinit(avctx, avctx->width, avctx->height, -1)) < 0)
329         return ret;
330
331     return 0;
332 }
333
334 static av_cold int decode_end(AVCodecContext *avctx)
335 {
336     NuvContext *c = avctx->priv_data;
337
338     av_freep(&c->decomp_buf);
339     av_frame_free(&c->pic);
340
341     return 0;
342 }
343
344 AVCodec ff_nuv_decoder = {
345     .name           = "nuv",
346     .long_name      = NULL_IF_CONFIG_SMALL("NuppelVideo/RTJPEG"),
347     .type           = AVMEDIA_TYPE_VIDEO,
348     .id             = AV_CODEC_ID_NUV,
349     .priv_data_size = sizeof(NuvContext),
350     .init           = decode_init,
351     .close          = decode_end,
352     .decode         = decode_frame,
353     .capabilities   = CODEC_CAP_DR1,
354 };