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