FFmpeg
cdxl.c
Go to the documentation of this file.
1 /*
2  * CDXL video decoder
3  * Copyright (c) 2011-2012 Paul B Mahol
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  * Commodore CDXL video decoder
25  * @author Paul B Mahol
26  */
27 
28 #define UNCHECKED_BITSTREAM_READER 1
29 
30 #include "libavutil/intreadwrite.h"
31 #include "avcodec.h"
32 #include "bytestream.h"
33 #include "codec_internal.h"
34 #include "decode.h"
35 #include "get_bits.h"
36 
37 #define BIT_PLANAR 0x00
38 #define CHUNKY 0x20
39 #define BYTE_PLANAR 0x40
40 #define BIT_LINE 0x80
41 #define BYTE_LINE 0xC0
42 
43 typedef struct CDXLVideoContext {
45  int bpp;
46  int type;
47  int format;
49  const uint8_t *palette;
51  const uint8_t *video;
53  uint8_t *new_video;
56 
58 {
59  CDXLVideoContext *c = avctx->priv_data;
60 
61  c->new_video_size = 0;
62  c->avctx = avctx;
63 
64  return 0;
65 }
66 
67 static void import_palette(CDXLVideoContext *c, uint32_t *new_palette)
68 {
69  if (c->type == 1) {
70  for (int i = 0; i < c->palette_size / 2; i++) {
71  unsigned rgb = AV_RB16(&c->palette[i * 2]);
72  unsigned r = ((rgb >> 8) & 0xF) * 0x11;
73  unsigned g = ((rgb >> 4) & 0xF) * 0x11;
74  unsigned b = (rgb & 0xF) * 0x11;
75  AV_WN32(&new_palette[i], (0xFFU << 24) | (r << 16) | (g << 8) | b);
76  }
77  } else {
78  for (int i = 0; i < c->palette_size / 3; i++) {
79  unsigned rgb = AV_RB24(&c->palette[i * 3]);
80  AV_WN32(&new_palette[i], (0xFFU << 24) | rgb);
81  }
82  }
83 }
84 
85 static void bitplanar2chunky(CDXLVideoContext *c, int linesize, uint8_t *out)
86 {
87  GetBitContext gb;
88  int x, y, plane;
89 
90  if (init_get_bits8(&gb, c->video, c->video_size) < 0)
91  return;
92  for (plane = 0; plane < c->bpp; plane++) {
93  for (y = 0; y < c->avctx->height; y++) {
94  for (x = 0; x < c->avctx->width; x++)
95  out[linesize * y + x] |= get_bits1(&gb) << plane;
96  skip_bits(&gb, c->padded_bits);
97  }
98  }
99 }
100 
101 static void bitline2chunky(CDXLVideoContext *c, int linesize, uint8_t *out)
102 {
103  GetBitContext gb;
104  int x, y, plane;
105 
106  if (init_get_bits8(&gb, c->video, c->video_size) < 0)
107  return;
108  for (y = 0; y < c->avctx->height; y++) {
109  for (plane = 0; plane < c->bpp; plane++) {
110  for (x = 0; x < c->avctx->width; x++)
111  out[linesize * y + x] |= get_bits1(&gb) << plane;
112  skip_bits(&gb, c->padded_bits);
113  }
114  }
115 }
116 
117 static void chunky2chunky(CDXLVideoContext *c, int linesize, uint8_t *out)
118 {
119  GetByteContext gb;
120  int y;
121 
122  bytestream2_init(&gb, c->video, c->video_size);
123  for (y = 0; y < c->avctx->height; y++) {
124  bytestream2_get_buffer(&gb, out + linesize * y, c->avctx->width * 3);
125  }
126 }
127 
128 static void import_format(CDXLVideoContext *c, int linesize, uint8_t *out)
129 {
130  memset(out, 0, linesize * c->avctx->height);
131 
132  switch (c->format) {
133  case BIT_PLANAR:
134  bitplanar2chunky(c, linesize, out);
135  break;
136  case BIT_LINE:
137  bitline2chunky(c, linesize, out);
138  break;
139  case CHUNKY:
140  chunky2chunky(c, linesize, out);
141  break;
142  }
143 }
144 
146 {
147  uint32_t *new_palette = (uint32_t *)frame->data[1];
148 
149  memset(frame->data[1], 0, AVPALETTE_SIZE);
150  import_palette(c, new_palette);
151  import_format(c, frame->linesize[0], frame->data[0]);
152 }
153 
155 {
156  import_format(c, frame->linesize[0], frame->data[0]);
157 }
158 
160 {
161  AVCodecContext *avctx = c->avctx;
162  uint32_t new_palette[16], r, g, b;
163  uint8_t *ptr, *out, index, op;
164  int x, y;
165 
166  ptr = c->new_video;
167  out = frame->data[0];
168 
169  import_palette(c, new_palette);
170  import_format(c, avctx->width, c->new_video);
171 
172  for (y = 0; y < avctx->height; y++) {
173  r = new_palette[0] & 0xFF0000;
174  g = new_palette[0] & 0xFF00;
175  b = new_palette[0] & 0xFF;
176  for (x = 0; x < avctx->width; x++) {
177  index = *ptr++;
178  op = index >> 4;
179  index &= 15;
180  switch (op) {
181  case 0:
182  r = new_palette[index] & 0xFF0000;
183  g = new_palette[index] & 0xFF00;
184  b = new_palette[index] & 0xFF;
185  break;
186  case 1:
187  b = index * 0x11;
188  break;
189  case 2:
190  r = index * 0x11 << 16;
191  break;
192  case 3:
193  g = index * 0x11 << 8;
194  break;
195  }
196  AV_WL24(out + x * 3, r | g | b);
197  }
198  out += frame->linesize[0];
199  }
200 }
201 
203 {
204  AVCodecContext *avctx = c->avctx;
205  uint32_t new_palette[64], r, g, b;
206  uint8_t *ptr, *out, index, op;
207  int x, y;
208 
209  ptr = c->new_video;
210  out = frame->data[0];
211 
212  import_palette(c, new_palette);
213  import_format(c, avctx->width, c->new_video);
214 
215  for (y = 0; y < avctx->height; y++) {
216  r = new_palette[0] & 0xFF0000;
217  g = new_palette[0] & 0xFF00;
218  b = new_palette[0] & 0xFF;
219  for (x = 0; x < avctx->width; x++) {
220  index = *ptr++;
221  op = index >> 6;
222  index &= 63;
223  switch (op) {
224  case 0:
225  r = new_palette[index] & 0xFF0000;
226  g = new_palette[index] & 0xFF00;
227  b = new_palette[index] & 0xFF;
228  break;
229  case 1:
230  b = (index << 2) | (b & 3);
231  break;
232  case 2:
233  r = (index << 18) | (r & (3 << 16));
234  break;
235  case 3:
236  g = (index << 10) | (g & (3 << 8));
237  break;
238  }
239  AV_WL24(out + x * 3, r | g | b);
240  }
241  out += frame->linesize[0];
242  }
243 }
244 
246  int *got_frame, AVPacket *pkt)
247 {
248  CDXLVideoContext *c = avctx->priv_data;
249  int ret, w, h, encoding, aligned_width, buf_size = pkt->size;
250  const uint8_t *buf = pkt->data;
251 
252  if (buf_size < 32)
253  return AVERROR_INVALIDDATA;
254  c->type = buf[0];
255  encoding = buf[1] & 7;
256  c->format = buf[1] & 0xE0;
257  w = AV_RB16(&buf[14]);
258  h = AV_RB16(&buf[16]);
259  c->bpp = buf[19];
260  c->palette_size = AV_RB16(&buf[20]);
261  c->palette = buf + 32;
262  c->video = c->palette + c->palette_size;
263  c->video_size = buf_size - c->palette_size - 32;
264 
265  if (c->type > 1)
266  return AVERROR_INVALIDDATA;
267  if (c->type == 1 && c->palette_size > 512)
268  return AVERROR_INVALIDDATA;
269  if (c->type == 0 && c->palette_size > 768)
270  return AVERROR_INVALIDDATA;
271  if (buf_size < c->palette_size + 32)
272  return AVERROR_INVALIDDATA;
273  if (c->bpp < 1)
274  return AVERROR_INVALIDDATA;
275  if (c->format != BIT_PLANAR && c->format != BIT_LINE && c->format != CHUNKY) {
276  avpriv_request_sample(avctx, "Pixel format 0x%0x", c->format);
277  return AVERROR_PATCHWELCOME;
278  }
279 
280  if ((ret = ff_set_dimensions(avctx, w, h)) < 0)
281  return ret;
282 
283  if (c->format == CHUNKY)
284  aligned_width = avctx->width;
285  else
286  aligned_width = FFALIGN(c->avctx->width, 16);
287  c->padded_bits = aligned_width - c->avctx->width;
288  if (c->video_size < aligned_width * avctx->height * (int64_t)c->bpp / 8)
289  return AVERROR_INVALIDDATA;
290  if (!encoding && c->palette_size && c->bpp <= 8 && c->format != CHUNKY) {
291  avctx->pix_fmt = AV_PIX_FMT_PAL8;
292  } else if (encoding == 1 && (c->bpp == 6 || c->bpp == 8) && c->format != CHUNKY) {
293  if (c->palette_size != (1 << (c->bpp - 1)))
294  return AVERROR_INVALIDDATA;
295  avctx->pix_fmt = AV_PIX_FMT_BGR24;
296  } else if (!encoding && c->bpp == 24 && c->format == CHUNKY &&
297  !c->palette_size) {
298  avctx->pix_fmt = AV_PIX_FMT_RGB24;
299  } else {
300  avpriv_request_sample(avctx, "Encoding %d, bpp %d and format 0x%x",
301  encoding, c->bpp, c->format);
302  return AVERROR_PATCHWELCOME;
303  }
304 
305  if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
306  return ret;
308  p->key_frame = 1;
309 
310  if (encoding) {
311  av_fast_padded_malloc(&c->new_video, &c->new_video_size,
313  if (!c->new_video)
314  return AVERROR(ENOMEM);
315  if (c->bpp == 8)
316  cdxl_decode_ham8(c, p);
317  else
318  cdxl_decode_ham6(c, p);
319  } else if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
320  cdxl_decode_rgb(c, p);
321  } else {
322  cdxl_decode_raw(c, p);
323  }
324  *got_frame = 1;
325 
326  return buf_size;
327 }
328 
330 {
331  CDXLVideoContext *c = avctx->priv_data;
332 
333  av_freep(&c->new_video);
334 
335  return 0;
336 }
337 
339  .p.name = "cdxl",
340  CODEC_LONG_NAME("Commodore CDXL video"),
341  .p.type = AVMEDIA_TYPE_VIDEO,
342  .p.id = AV_CODEC_ID_CDXL,
343  .priv_data_size = sizeof(CDXLVideoContext),
345  .close = cdxl_decode_end,
347  .p.capabilities = AV_CODEC_CAP_DR1,
348 };
r
const char * r
Definition: vf_curves.c:116
AVERROR
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
out
FILE * out
Definition: movenc.c:54
CDXLVideoContext::video_size
int video_size
Definition: cdxl.c:52
GetByteContext
Definition: bytestream.h:33
CDXLVideoContext::format
int format
Definition: cdxl.c:47
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
w
uint8_t w
Definition: llviddspenc.c:38
AVPacket::data
uint8_t * data
Definition: packet.h:374
b
#define b
Definition: input.c:41
FFCodec
Definition: codec_internal.h:119
CDXLVideoContext::palette
const uint8_t * palette
Definition: cdxl.c:49
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
cdxl_decode_rgb
static void cdxl_decode_rgb(CDXLVideoContext *c, AVFrame *frame)
Definition: cdxl.c:145
ff_set_dimensions
int ff_set_dimensions(AVCodecContext *s, int width, int height)
Check that the provided frame dimensions are valid and set them on the codec context.
Definition: utils.c:91
CHUNKY
#define CHUNKY
Definition: cdxl.c:38
init
static int init
Definition: av_tx.c:47
skip_bits
static void skip_bits(GetBitContext *s, int n)
Definition: get_bits.h:467
rgb
Definition: rpzaenc.c:59
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:123
GetBitContext
Definition: get_bits.h:61
AVFrame::key_frame
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:417
pkt
AVPacket * pkt
Definition: movenc.c:59
av_cold
#define av_cold
Definition: attributes.h:90
init_get_bits8
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
Definition: get_bits.h:667
cdxl_decode_end
static av_cold int cdxl_decode_end(AVCodecContext *avctx)
Definition: cdxl.c:329
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:279
intreadwrite.h
g
const char * g
Definition: vf_curves.c:117
op
static int op(uint8_t **dst, const uint8_t *dst_end, GetByteContext *gb, int pixel, int count, int *x, int width, int linesize)
Perform decode operation.
Definition: anm.c:76
CDXLVideoContext
Definition: cdxl.c:43
decode.h
get_bits.h
bitplanar2chunky
static void bitplanar2chunky(CDXLVideoContext *c, int linesize, uint8_t *out)
Definition: cdxl.c:85
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:264
import_format
static void import_format(CDXLVideoContext *c, int linesize, uint8_t *out)
Definition: cdxl.c:128
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
AVPALETTE_SIZE
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
AV_WL24
#define AV_WL24(p, d)
Definition: intreadwrite.h:464
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
get_bits1
static unsigned int get_bits1(GetBitContext *s)
Definition: get_bits.h:498
bytestream2_get_buffer
static av_always_inline unsigned int bytestream2_get_buffer(GetByteContext *g, uint8_t *dst, unsigned int size)
Definition: bytestream.h:267
CDXLVideoContext::type
int type
Definition: cdxl.c:46
index
int index
Definition: gxfenc.c:89
c
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
AVFrame::pict_type
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:422
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1450
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:68
bitline2chunky
static void bitline2chunky(CDXLVideoContext *c, int linesize, uint8_t *out)
Definition: cdxl.c:101
BIT_LINE
#define BIT_LINE
Definition: cdxl.c:40
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:375
codec_internal.h
AV_WN32
#define AV_WN32(p, v)
Definition: intreadwrite.h:376
cdxl_decode_raw
static void cdxl_decode_raw(CDXLVideoContext *c, AVFrame *frame)
Definition: cdxl.c:154
CDXLVideoContext::avctx
AVCodecContext * avctx
Definition: cdxl.c:44
CDXLVideoContext::bpp
int bpp
Definition: cdxl.c:45
chunky2chunky
static void chunky2chunky(CDXLVideoContext *c, int linesize, uint8_t *out)
Definition: cdxl.c:117
CDXLVideoContext::new_video
uint8_t * new_video
Definition: cdxl.c:53
import_palette
static void import_palette(CDXLVideoContext *c, uint32_t *new_palette)
Definition: cdxl.c:67
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
cdxl_decode_init
static av_cold int cdxl_decode_init(AVCodecContext *avctx)
Definition: cdxl.c:57
av_fast_padded_malloc
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
Definition: utils.c:49
cdxl_decode_ham6
static void cdxl_decode_ham6(CDXLVideoContext *c, AVFrame *frame)
Definition: cdxl.c:159
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
ff_cdxl_decoder
const FFCodec ff_cdxl_decoder
Definition: cdxl.c:338
AVCodecContext::height
int height
Definition: avcodec.h:571
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
avcodec.h
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
ret
ret
Definition: filter_design.txt:187
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AV_INPUT_BUFFER_PADDING_SIZE
#define AV_INPUT_BUFFER_PADDING_SIZE
Definition: defs.h:40
AVCodecContext
main external API structure.
Definition: avcodec.h:398
CDXLVideoContext::new_video_size
int new_video_size
Definition: cdxl.c:54
CDXLVideoContext::video
const uint8_t * video
Definition: cdxl.c:51
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
avpriv_request_sample
#define avpriv_request_sample(...)
Definition: tableprint_vlc.h:36
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:78
CDXLVideoContext::padded_bits
int padded_bits
Definition: cdxl.c:48
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
cdxl_decode_ham8
static void cdxl_decode_ham8(CDXLVideoContext *c, AVFrame *frame)
Definition: cdxl.c:202
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
bytestream.h
bytestream2_init
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
h
h
Definition: vp9dsp_template.c:2038
cdxl_decode_frame
static int cdxl_decode_frame(AVCodecContext *avctx, AVFrame *p, int *got_frame, AVPacket *pkt)
Definition: cdxl.c:245
AV_RB24
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_RB24
Definition: bytestream.h:97
BIT_PLANAR
#define BIT_PLANAR
Definition: cdxl.c:37
AV_CODEC_ID_CDXL
@ AV_CODEC_ID_CDXL
Definition: codec_id.h:211
CDXLVideoContext::palette_size
int palette_size
Definition: cdxl.c:50
AV_RB16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:98