FFmpeg
nuv.c
Go to the documentation of this file.
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 "idctdsp.h"
33 #include "internal.h"
34 #include "rtjpeg.h"
35 
36 typedef struct NuvContext {
39  int quality;
40  int width, height;
41  unsigned int decomp_size;
42  unsigned char *decomp_buf;
43  uint32_t lq[64], cq[64];
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  uint8_t *src_data[4];
79  int src_linesize[4];
80  av_image_fill_arrays(src_data, src_linesize, src,
81  f->format, width, height, 1);
82  av_image_copy(f->data, f->linesize, (const uint8_t **)src_data, src_linesize,
83  f->format, width, height);
84 }
85 
86 /**
87  * @brief extract quantization tables from codec data into our context
88  */
89 static int get_quant(AVCodecContext *avctx, NuvContext *c, const uint8_t *buf,
90  int size)
91 {
92  int i;
93  if (size < 2 * 64 * 4) {
94  av_log(avctx, AV_LOG_ERROR, "insufficient rtjpeg quant data\n");
95  return AVERROR_INVALIDDATA;
96  }
97  for (i = 0; i < 64; i++, buf += 4)
98  c->lq[i] = AV_RL32(buf);
99  for (i = 0; i < 64; i++, buf += 4)
100  c->cq[i] = AV_RL32(buf);
101  return 0;
102 }
103 
104 /**
105  * @brief set quantization tables from a quality value
106  */
108 {
109  int i;
110  quality = FFMAX(quality, 1);
111  for (i = 0; i < 64; i++) {
112  c->lq[i] = (fallback_lquant[i] << 7) / quality;
113  c->cq[i] = (fallback_cquant[i] << 7) / quality;
114  }
115 }
116 
117 static int codec_reinit(AVCodecContext *avctx, int width, int height,
118  int quality)
119 {
120  NuvContext *c = avctx->priv_data;
121  int ret;
122 
123  width = FFALIGN(width, 2);
124  height = FFALIGN(height, 2);
125  if (quality >= 0)
126  get_quant_quality(c, quality);
127  if (width != c->width || height != c->height) {
128  // also reserve space for a possible additional header
129  int buf_size = height * width * 3 / 2
132  if (buf_size > INT_MAX/8)
133  return -1;
134  if ((ret = av_image_check_size(height, width, 0, avctx)) < 0)
135  return ret;
136  avctx->width = c->width = width;
137  avctx->height = c->height = height;
139  buf_size);
140  if (!c->decomp_buf) {
141  av_log(avctx, AV_LOG_ERROR,
142  "Can't allocate decompression buffer.\n");
143  return AVERROR(ENOMEM);
144  }
145  ff_rtjpeg_decode_init(&c->rtj, c->width, c->height, c->lq, c->cq);
146  av_frame_unref(c->pic);
147  return 1;
148  } else if (quality != c->quality)
149  ff_rtjpeg_decode_init(&c->rtj, c->width, c->height, c->lq, c->cq);
150 
151  return 0;
152 }
153 
154 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
155  AVPacket *avpkt)
156 {
157  const uint8_t *buf = avpkt->data;
158  int buf_size = avpkt->size;
159  NuvContext *c = avctx->priv_data;
160  AVFrame *picture = data;
161  int orig_size = buf_size;
162  int keyframe, ret;
163  int size_change = 0;
164  int minsize = 0;
165  int flags = 0;
166  int result, init_frame = !avctx->frame_number;
167  enum {
168  NUV_UNCOMPRESSED = '0',
169  NUV_RTJPEG = '1',
170  NUV_RTJPEG_IN_LZO = '2',
171  NUV_LZO = '3',
172  NUV_BLACK = 'N',
173  NUV_COPY_LAST = 'L'
174  } comptype;
175 
176  if (buf_size < 12) {
177  av_log(avctx, AV_LOG_ERROR, "coded frame too small\n");
178  return AVERROR_INVALIDDATA;
179  }
180 
181  // codec data (rtjpeg quant tables)
182  if (buf[0] == 'D' && buf[1] == 'R') {
183  int ret;
184  // Skip the rest of the frame header.
185  buf = &buf[12];
186  buf_size -= 12;
187  ret = get_quant(avctx, c, buf, buf_size);
188  if (ret < 0)
189  return ret;
190  ff_rtjpeg_decode_init(&c->rtj, c->width, c->height, c->lq, c->cq);
191  return orig_size;
192  }
193 
194  if (buf_size < 12 || buf[0] != 'V') {
195  av_log(avctx, AV_LOG_ERROR, "not a nuv video frame\n");
196  return AVERROR_INVALIDDATA;
197  }
198  comptype = buf[1];
199  switch (comptype) {
200  case NUV_RTJPEG_IN_LZO:
201  case NUV_RTJPEG:
202  keyframe = !buf[2];
203  if (c->width < 16 || c->height < 16) {
204  return AVERROR_INVALIDDATA;
205  }
206  break;
207  case NUV_COPY_LAST:
209  keyframe = 0;
210  break;
211  default:
212  keyframe = 1;
213  break;
214  }
215  switch (comptype) {
216  case NUV_UNCOMPRESSED:
217  minsize = c->width * c->height * 3 / 2;
218  break;
219  case NUV_RTJPEG:
220  minsize = c->width/16 * (c->height/16) * 6;
221  break;
222  }
223  if (buf_size < minsize / 4)
224  return AVERROR_INVALIDDATA;
225 retry:
226  // Skip the rest of the frame header.
227  buf = &buf[12];
228  buf_size -= 12;
229  if (comptype == NUV_RTJPEG_IN_LZO || comptype == NUV_LZO) {
231  int inlen = buf_size;
232  if (av_lzo1x_decode(c->decomp_buf, &outlen, buf, &inlen)) {
233  av_log(avctx, AV_LOG_ERROR, "error during lzo decompression\n");
234  return AVERROR_INVALIDDATA;
235  }
236  buf = c->decomp_buf;
238  memset(c->decomp_buf + buf_size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
239  }
240  if (c->codec_frameheader) {
241  int w, h, q;
242  if (buf_size < RTJPEG_HEADER_SIZE) {
243  av_log(avctx, AV_LOG_ERROR, "Too small NUV video frame\n");
244  return AVERROR_INVALIDDATA;
245  }
246  // There seem to exist two variants of this header: one starts with 'V'
247  // and 5 bytes unknown, the other matches current MythTV and is 4 bytes size,
248  // 1 byte header size (== 12), 1 byte version (== 0)
249  if (buf[0] != 'V' && AV_RL16(&buf[4]) != 0x000c) {
250  av_log(avctx, AV_LOG_ERROR, "Unknown secondary frame header (wrong codec_tag?)\n");
251  return AVERROR_INVALIDDATA;
252  }
253  w = AV_RL16(&buf[6]);
254  h = AV_RL16(&buf[8]);
255  q = buf[10];
256  if ((result = codec_reinit(avctx, w, h, q)) < 0)
257  return result;
258  if (result) {
259  buf = avpkt->data;
260  buf_size = avpkt->size;
261  size_change = 1;
262  goto retry;
263  }
264  buf = &buf[RTJPEG_HEADER_SIZE];
265  buf_size -= RTJPEG_HEADER_SIZE;
266  }
267 
268  if (size_change || keyframe) {
269  av_frame_unref(c->pic);
270  init_frame = 1;
271  }
272 
273  if ((result = ff_reget_buffer(avctx, c->pic, flags)) < 0)
274  return result;
275  if (init_frame) {
276  memset(c->pic->data[0], 0, avctx->height * c->pic->linesize[0]);
277  memset(c->pic->data[1], 0x80, avctx->height * c->pic->linesize[1] / 2);
278  memset(c->pic->data[2], 0x80, avctx->height * c->pic->linesize[2] / 2);
279  }
280 
282  c->pic->key_frame = keyframe;
283  // decompress/copy/whatever data
284  switch (comptype) {
285  case NUV_LZO:
286  case NUV_UNCOMPRESSED: {
287  int height = c->height;
288  if (buf_size < c->width * height * 3 / 2) {
289  av_log(avctx, AV_LOG_ERROR, "uncompressed frame too short\n");
290  height = buf_size / c->width / 3 * 2;
291  }
292  if(height > 0)
293  copy_frame(c->pic, buf, c->width, height);
294  break;
295  }
296  case NUV_RTJPEG_IN_LZO:
297  case NUV_RTJPEG:
298  ret = ff_rtjpeg_decode_frame_yuv420(&c->rtj, c->pic, buf, buf_size);
299  if (ret < 0)
300  return ret;
301  break;
302  case NUV_BLACK:
303  memset(c->pic->data[0], 0, c->width * c->height);
304  memset(c->pic->data[1], 128, c->width * c->height / 4);
305  memset(c->pic->data[2], 128, c->width * c->height / 4);
306  break;
307  case NUV_COPY_LAST:
308  /* nothing more to do here */
309  break;
310  default:
311  av_log(avctx, AV_LOG_ERROR, "unknown compression\n");
312  return AVERROR_INVALIDDATA;
313  }
314 
315  if ((result = av_frame_ref(picture, c->pic)) < 0)
316  return result;
317 
318  *got_frame = 1;
319  return orig_size;
320 }
321 
323 {
324  NuvContext *c = avctx->priv_data;
325  int ret;
326 
327  c->pic = av_frame_alloc();
328  if (!c->pic)
329  return AVERROR(ENOMEM);
330 
331  avctx->pix_fmt = AV_PIX_FMT_YUV420P;
332  c->decomp_buf = NULL;
333  c->quality = -1;
334  c->width = 0;
335  c->height = 0;
336 
337  c->codec_frameheader = avctx->codec_tag == MKTAG('R', 'J', 'P', 'G');
338 
339  if (avctx->extradata_size)
340  get_quant(avctx, c, avctx->extradata, avctx->extradata_size);
341 
342  ff_rtjpeg_init(&c->rtj, avctx);
343 
344  if ((ret = codec_reinit(avctx, avctx->width, avctx->height, -1)) < 0)
345  return ret;
346 
347  return 0;
348 }
349 
351 {
352  NuvContext *c = avctx->priv_data;
353 
354  av_freep(&c->decomp_buf);
355  av_frame_free(&c->pic);
356 
357  return 0;
358 }
359 
361  .name = "nuv",
362  .long_name = NULL_IF_CONFIG_SMALL("NuppelVideo/RTJPEG"),
363  .type = AVMEDIA_TYPE_VIDEO,
364  .id = AV_CODEC_ID_NUV,
365  .priv_data_size = sizeof(NuvContext),
366  .init = decode_init,
367  .close = decode_end,
368  .decode = decode_frame,
369  .capabilities = AV_CODEC_CAP_DR1,
370  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
371 };
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
#define NULL
Definition: coverity.c:32
static av_cold int decode_end(AVCodecContext *avctx)
Definition: nuv.c:350
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int width
Definition: nuv.c:40
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
int height
Definition: nuv.c:40
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
misc image utilities
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1481
int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4], const uint8_t *src, enum AVPixelFormat pix_fmt, int width, int height, int align)
Setup the data pointers and linesizes based on the specified image parameters and the provided array...
Definition: imgutils.c:411
static int get_quant(AVCodecContext *avctx, NuvContext *c, const uint8_t *buf, int size)
extract quantization tables from codec data into our context
Definition: nuv.c:89
int codec_frameheader
Definition: nuv.c:38
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1778
static void get_quant_quality(NuvContext *c, int quality)
set quantization tables from a quality value
Definition: nuv.c:107
static const uint8_t fallback_lquant[]
Definition: nuv.c:47
#define src
Definition: vp8dsp.c:254
AVCodec.
Definition: avcodec.h:3492
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
int quality
Definition: nuv.c:39
Definition: nuv.c:36
uint8_t
#define av_cold
Definition: attributes.h:82
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:189
int ff_rtjpeg_decode_frame_yuv420(RTJpegContext *c, AVFrame *f, const uint8_t *buf, int buf_size)
decode one rtjpeg YUV420 frame
Definition: rtjpeg.c:106
void ff_rtjpeg_init(RTJpegContext *c, AVCodecContext *avctx)
Definition: rtjpeg.c:170
#define f(width, name)
Definition: cbs_vp9.c:255
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:443
#define AV_LZO_OUTPUT_PADDING
Definition: lzo.h:47
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1669
uint8_t * data
Definition: avcodec.h:1480
#define FF_REGET_BUFFER_FLAG_READONLY
the returned buffer does not need to be writable
Definition: internal.h:323
ptrdiff_t size
Definition: opengl_enc.c:100
#define FFALIGN(x, a)
Definition: macros.h:48
#define av_log(a,...)
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Identical in function to ff_get_buffer(), except it reuses the existing buffer if available...
Definition: decode.c:2015
const char * name
Name of the codec implementation.
Definition: avcodec.h:3499
#define FFMAX(a, b)
Definition: common.h:94
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], const uint8_t *src_data[4], const int src_linesizes[4], enum AVPixelFormat pix_fmt, int width, int height)
Copy image in src_data to dst_data.
Definition: imgutils.c:387
static av_cold int decode_init(AVCodecContext *avctx)
Definition: nuv.c:322
AVCodec ff_nuv_decoder
Definition: nuv.c:360
void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size)
Allocate a buffer, reusing the given one if large enough.
Definition: mem.c:500
unsigned char * decomp_buf
Definition: nuv.c:42
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:282
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:378
int width
picture width / height.
Definition: avcodec.h:1741
uint8_t w
Definition: llviddspenc.c:38
void ff_rtjpeg_decode_init(RTJpegContext *c, int width, int height, const uint32_t *lquant, const uint32_t *cquant)
initialize an RTJpegContext, may be called multiple times
Definition: rtjpeg.c:158
int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen)
Decodes LZO 1x compressed data.
Definition: lzo.c:134
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:368
Libavcodec external API header.
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:326
main external API structure.
Definition: avcodec.h:1568
static void copy_frame(AVFrame *f, const uint8_t *src, int width, int height)
copy frame data from buffer to AVFrame, handling stride.
Definition: nuv.c:76
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> (&#39;D&#39;<<24) + (&#39;C&#39;<<16) + (&#39;B&#39;<<8) + &#39;A&#39;).
Definition: avcodec.h:1593
void * buf
Definition: avisynth_c.h:766
int extradata_size
Definition: avcodec.h:1670
byte swapping routines
unsigned int decomp_size
Definition: nuv.c:41
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:553
#define flags(name, subs,...)
Definition: cbs_av1.c:561
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:309
static const uint8_t fallback_cquant[]
Definition: nuv.c:58
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
common internal api header.
common internal and external API header
AVFrame * pic
Definition: nuv.c:37
#define AV_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:793
void * priv_data
Definition: avcodec.h:1595
static int codec_reinit(AVCodecContext *avctx, int width, int height, int quality)
Definition: nuv.c:117
uint32_t lq[64]
Definition: nuv.c:43
#define RTJPEG_HEADER_SIZE
Definition: rtjpeg.h:31
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:373
and forward the result(frame or status change) to the corresponding input.If nothing is possible
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:2259
#define av_freep(p)
static void init_frame(FlacEncodeContext *s, int nb_samples)
Definition: flacenc.c:470
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: nuv.c:154
RTJpegContext rtj
Definition: nuv.c:44
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
#define MKTAG(a, b, c, d)
Definition: common.h:366
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1457
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:984
uint32_t cq[64]
Definition: nuv.c:43
Predicted.
Definition: avutil.h:275