FFmpeg
smacker.c
Go to the documentation of this file.
1 /*
2  * Smacker demuxer
3  * Copyright (c) 2006 Konstantin Shishkov
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  * Based on http://wiki.multimedia.cx/index.php?title=Smacker
24  */
25 
26 #include <inttypes.h>
27 
29 #include "libavutil/intreadwrite.h"
30 #include "avformat.h"
31 #include "avio_internal.h"
32 #include "internal.h"
33 
34 #define SMACKER_PAL 0x01
35 #define SMACKER_FLAG_RING_FRAME 0x01
36 
37 enum SAudFlags {
43 };
44 
45 typedef struct SmackerContext {
46  uint32_t frames;
47  /* frame info */
48  uint32_t *frm_size;
50  /* internal variables */
51  int cur_frame;
52  /* current frame for demuxing */
53  uint8_t pal[768];
54  int indexes[7];
57  int buf_sizes[7];
58  int stream_id[7];
59  int curstream;
60  int64_t nextpos;
61  int64_t aud_pts[7];
63 
64 /* palette used in Smacker */
65 static const uint8_t smk_pal[64] = {
66  0x00, 0x04, 0x08, 0x0C, 0x10, 0x14, 0x18, 0x1C,
67  0x20, 0x24, 0x28, 0x2C, 0x30, 0x34, 0x38, 0x3C,
68  0x41, 0x45, 0x49, 0x4D, 0x51, 0x55, 0x59, 0x5D,
69  0x61, 0x65, 0x69, 0x6D, 0x71, 0x75, 0x79, 0x7D,
70  0x82, 0x86, 0x8A, 0x8E, 0x92, 0x96, 0x9A, 0x9E,
71  0xA2, 0xA6, 0xAA, 0xAE, 0xB2, 0xB6, 0xBA, 0xBE,
72  0xC3, 0xC7, 0xCB, 0xCF, 0xD3, 0xD7, 0xDB, 0xDF,
73  0xE3, 0xE7, 0xEB, 0xEF, 0xF3, 0xF7, 0xFB, 0xFF
74 };
75 
76 
77 static int smacker_probe(const AVProbeData *p)
78 {
79  if ( AV_RL32(p->buf) != MKTAG('S', 'M', 'K', '2')
80  && AV_RL32(p->buf) != MKTAG('S', 'M', 'K', '4'))
81  return 0;
82 
83  if (AV_RL32(p->buf+4) > 32768U || AV_RL32(p->buf+8) > 32768U)
84  return AVPROBE_SCORE_MAX/4;
85 
86  return AVPROBE_SCORE_MAX;
87 }
88 
90 {
91  AVIOContext *pb = s->pb;
92  SmackerContext *smk = s->priv_data;
93  AVStream *st;
94  AVCodecParameters *par;
95  uint32_t magic, width, height, flags, treesize;
96  int i, ret, pts_inc;
97  int tbase;
98 
99  /* read and check header */
100  magic = avio_rl32(pb);
101  if (magic != MKTAG('S', 'M', 'K', '2') && magic != MKTAG('S', 'M', 'K', '4'))
102  return AVERROR_INVALIDDATA;
103  width = avio_rl32(pb);
104  height = avio_rl32(pb);
105  smk->frames = avio_rl32(pb);
106  pts_inc = avio_rl32(pb);
107  if (pts_inc > INT_MAX / 100) {
108  av_log(s, AV_LOG_ERROR, "pts_inc %d is too large\n", pts_inc);
109  return AVERROR_INVALIDDATA;
110  }
111 
112  flags = avio_rl32(pb);
113  if (flags & SMACKER_FLAG_RING_FRAME)
114  smk->frames++;
115  if (smk->frames > 0xFFFFFF) {
116  av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n", smk->frames);
117  return AVERROR_INVALIDDATA;
118  }
119 
120  avio_skip(pb, 28); /* Unused audio related data */
121 
122  treesize = avio_rl32(pb);
123  if (treesize >= UINT_MAX/4) {
124  // treesize + 16 must not overflow (this check is probably redundant)
125  av_log(s, AV_LOG_ERROR, "treesize too large\n");
126  return AVERROR_INVALIDDATA;
127  }
128 
129  st = avformat_new_stream(s, NULL);
130  if (!st)
131  return AVERROR(ENOMEM);
132 
133  smk->videoindex = st->index;
134  /* Smacker uses 100000 as internal timebase */
135  if (pts_inc < 0)
136  pts_inc = -pts_inc;
137  else
138  pts_inc *= 100;
139  tbase = 100000;
140  av_reduce(&tbase, &pts_inc, tbase, pts_inc, (1UL << 31) - 1);
141  avpriv_set_pts_info(st, 33, pts_inc, tbase);
142  st->duration = smk->frames;
143 
144  /* init video codec */
145  par = st->codecpar;
146  par->width = width;
147  par->height = height;
148  par->format = AV_PIX_FMT_PAL8;
151  par->codec_tag = magic;
152 
153  if ((ret = ff_alloc_extradata(par, treesize + 16)) < 0) {
154  av_log(s, AV_LOG_ERROR,
155  "Cannot allocate %"PRIu32" bytes of extradata\n",
156  treesize + 16);
157  return ret;
158  }
159  if ((ret = ffio_read_size(pb, par->extradata, 16)) < 0)
160  return ret;
161 
162  /* handle possible audio streams */
163  for (i = 0; i < 7; i++) {
164  uint32_t rate = avio_rl24(pb);
165  uint8_t aflag = avio_r8(pb);
166 
167  smk->indexes[i] = -1;
168 
169  if (rate) {
170  AVStream *ast = avformat_new_stream(s, NULL);
171  AVCodecParameters *par;
172  if (!ast)
173  return AVERROR(ENOMEM);
174 
175  smk->indexes[i] = ast->index;
176  par = ast->codecpar;
178  if (aflag & SMK_AUD_BINKAUD) {
180  } else if (aflag & SMK_AUD_USEDCT) {
182  } else if (aflag & SMK_AUD_PACKED) {
184  par->codec_tag = MKTAG('S', 'M', 'K', 'A');
185  } else {
187  }
188  if (aflag & SMK_AUD_STEREO) {
189  par->channels = 2;
191  } else {
192  par->channels = 1;
194  }
195  par->sample_rate = rate;
196  par->bits_per_coded_sample = (aflag & SMK_AUD_16BITS) ? 16 : 8;
197  if (par->bits_per_coded_sample == 16 &&
200  avpriv_set_pts_info(ast, 64, 1, par->sample_rate * par->channels
201  * par->bits_per_coded_sample / 8);
202  }
203  }
204 
205  avio_rl32(pb); /* padding */
206 
207  /* setup data */
208  smk->frm_size = av_malloc_array(smk->frames, sizeof(*smk->frm_size));
209  smk->frm_flags = av_malloc(smk->frames);
210  if (!smk->frm_size || !smk->frm_flags) {
211  av_freep(&smk->frm_size);
212  av_freep(&smk->frm_flags);
213  return AVERROR(ENOMEM);
214  }
215 
216  /* read frame info */
217  for (i = 0; i < smk->frames; i++) {
218  smk->frm_size[i] = avio_rl32(pb);
219  }
220  for (i = 0; i < smk->frames; i++) {
221  smk->frm_flags[i] = avio_r8(pb);
222  }
223 
224  /* load trees to extradata, they will be unpacked by decoder */
225  ret = avio_read(pb, par->extradata + 16, par->extradata_size - 16);
226  if (ret != par->extradata_size - 16) {
227  av_freep(&smk->frm_size);
228  av_freep(&smk->frm_flags);
229  return AVERROR(EIO);
230  }
231 
232  smk->curstream = -1;
233  smk->nextpos = avio_tell(pb);
234 
235  return 0;
236 }
237 
238 
240 {
241  SmackerContext *smk = s->priv_data;
242  int flags;
243  int ret;
244  int i;
245  int frame_size = 0;
246  int palchange = 0;
247 
248  if (avio_feof(s->pb) || smk->cur_frame >= smk->frames)
249  return AVERROR_EOF;
250 
251  /* if we demuxed all streams, pass another frame */
252  if(smk->curstream < 0) {
253  avio_seek(s->pb, smk->nextpos, 0);
254  frame_size = smk->frm_size[smk->cur_frame] & (~3);
255  flags = smk->frm_flags[smk->cur_frame];
256  /* handle palette change event */
257  if(flags & SMACKER_PAL){
258  int size, sz, t, off, j, pos;
259  uint8_t *pal = smk->pal;
260  uint8_t oldpal[768];
261 
262  memcpy(oldpal, pal, 768);
263  size = avio_r8(s->pb);
264  size = size * 4 - 1;
265  if(size + 1 > frame_size)
266  return AVERROR_INVALIDDATA;
267  frame_size -= size;
268  frame_size--;
269  sz = 0;
270  pos = avio_tell(s->pb) + size;
271  while(sz < 256){
272  t = avio_r8(s->pb);
273  if(t & 0x80){ /* skip palette entries */
274  sz += (t & 0x7F) + 1;
275  pal += ((t & 0x7F) + 1) * 3;
276  } else if(t & 0x40){ /* copy with offset */
277  off = avio_r8(s->pb);
278  j = (t & 0x3F) + 1;
279  if (off + j > 0x100) {
280  av_log(s, AV_LOG_ERROR,
281  "Invalid palette update, offset=%d length=%d extends beyond palette size\n",
282  off, j);
283  return AVERROR_INVALIDDATA;
284  }
285  off *= 3;
286  while(j-- && sz < 256) {
287  *pal++ = oldpal[off + 0];
288  *pal++ = oldpal[off + 1];
289  *pal++ = oldpal[off + 2];
290  sz++;
291  off += 3;
292  }
293  } else { /* new entries */
294  *pal++ = smk_pal[t];
295  *pal++ = smk_pal[avio_r8(s->pb) & 0x3F];
296  *pal++ = smk_pal[avio_r8(s->pb) & 0x3F];
297  sz++;
298  }
299  }
300  avio_seek(s->pb, pos, 0);
301  palchange |= 1;
302  }
303  flags >>= 1;
304  smk->curstream = -1;
305  /* if audio chunks are present, put them to stack and retrieve later */
306  for(i = 0; i < 7; i++) {
307  if(flags & 1) {
308  uint32_t size;
309  int err;
310 
311  size = avio_rl32(s->pb) - 4;
312  if (!size || size + 4LL > frame_size) {
313  av_log(s, AV_LOG_ERROR, "Invalid audio part size\n");
314  return AVERROR_INVALIDDATA;
315  }
316  frame_size -= size;
317  frame_size -= 4;
318  smk->curstream++;
319  if ((err = av_reallocp(&smk->bufs[smk->curstream], size)) < 0) {
320  smk->buf_sizes[smk->curstream] = 0;
321  return err;
322  }
323  smk->buf_sizes[smk->curstream] = size;
324  ret = avio_read(s->pb, smk->bufs[smk->curstream], size);
325  if(ret != size)
326  return AVERROR(EIO);
327  smk->stream_id[smk->curstream] = smk->indexes[i];
328  }
329  flags >>= 1;
330  }
331  if (frame_size < 0 || frame_size >= INT_MAX/2)
332  return AVERROR_INVALIDDATA;
333  if ((ret = av_new_packet(pkt, frame_size + 769)) < 0)
334  return ret;
335  if(smk->frm_size[smk->cur_frame] & 1)
336  palchange |= 2;
337  pkt->data[0] = palchange;
338  memcpy(pkt->data + 1, smk->pal, 768);
339  ret = avio_read(s->pb, pkt->data + 769, frame_size);
340  if(ret != frame_size)
341  return AVERROR(EIO);
342  pkt->stream_index = smk->videoindex;
343  pkt->pts = smk->cur_frame;
344  pkt->size = ret + 769;
345  smk->cur_frame++;
346  smk->nextpos = avio_tell(s->pb);
347  } else {
348  if (smk->stream_id[smk->curstream] < 0 || !smk->bufs[smk->curstream])
349  return AVERROR_INVALIDDATA;
350  if ((ret = av_new_packet(pkt, smk->buf_sizes[smk->curstream])) < 0)
351  return ret;
352  memcpy(pkt->data, smk->bufs[smk->curstream], smk->buf_sizes[smk->curstream]);
353  pkt->size = smk->buf_sizes[smk->curstream];
354  pkt->stream_index = smk->stream_id[smk->curstream];
355  pkt->pts = smk->aud_pts[smk->curstream];
356  smk->aud_pts[smk->curstream] += AV_RL32(pkt->data);
357  smk->curstream--;
358  }
359 
360  return 0;
361 }
362 
364 {
365  SmackerContext *smk = s->priv_data;
366  int i;
367 
368  for(i = 0; i < 7; i++)
369  av_freep(&smk->bufs[i]);
370  av_freep(&smk->frm_size);
371  av_freep(&smk->frm_flags);
372 
373  return 0;
374 }
375 
377  .name = "smk",
378  .long_name = NULL_IF_CONFIG_SMALL("Smacker"),
379  .priv_data_size = sizeof(SmackerContext),
384 };
#define NULL
Definition: coverity.c:32
SAudFlags
Definition: smacker.c:37
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4943
int ffio_read_size(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:694
uint32_t * frm_size
Definition: smacker.c:48
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:4036
int index
stream index in AVFormatContext
Definition: avformat.h:877
int size
Definition: avcodec.h:1534
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:241
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:329
static AVPacket pkt
int64_t aud_pts[7]
Definition: smacker.c:61
#define AV_CH_LAYOUT_STEREO
This struct describes the properties of an encoded stream.
Definition: avcodec.h:4028
static int smacker_probe(const AVProbeData *p)
Definition: smacker.c:77
Format I/O context.
Definition: avformat.h:1353
uint8_t
#define av_malloc(s)
int width
Video only.
Definition: avcodec.h:4102
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
uint8_t pal[768]
Definition: smacker.c:53
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4524
int64_t nextpos
Definition: smacker.c:60
#define height
uint8_t * data
Definition: avcodec.h:1533
#define AVERROR_EOF
End of file.
Definition: error.h:55
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
ptrdiff_t size
Definition: opengl_enc.c:100
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
Reduce a fraction.
Definition: rational.c:35
uint64_t channel_layout
Audio only.
Definition: avcodec.h:4138
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:645
int videoindex
Definition: smacker.c:55
#define U(x)
Definition: vp56_arith.h:37
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:86
#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
int buf_sizes[7]
Definition: smacker.c:57
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:767
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
unsigned int pos
Definition: spdifenc.c:410
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:4032
uint8_t * frm_flags
Definition: smacker.c:49
#define SMACKER_FLAG_RING_FRAME
Definition: smacker.c:35
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:4054
static const uint8_t smk_pal[64]
Definition: smacker.c:65
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:636
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
audio channel layout utility functions
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3323
static int smacker_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: smacker.c:239
#define width
#define s(width, name)
Definition: cbs_vp9.c:257
int curstream
Definition: smacker.c:59
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
static int smacker_read_close(AVFormatContext *s)
Definition: smacker.c:363
Stream structure.
Definition: avformat.h:876
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
#define SMACKER_PAL
Definition: smacker.c:34
int frame_size
Definition: mxfenc.c:2140
int av_reallocp(void *ptr, size_t size)
Allocate, reallocate, or free a block of memory through a pointer to a pointer.
Definition: mem.c:163
AVIOContext * pb
I/O context.
Definition: avformat.h:1395
static int smacker_read_header(AVFormatContext *s)
Definition: smacker.c:89
int cur_frame
Definition: smacker.c:51
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
#define flags(name, subs,...)
Definition: cbs_av1.c:564
AVInputFormat ff_smacker_demuxer
Definition: smacker.c:376
int stream_id[7]
Definition: smacker.c:58
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
uint8_t * bufs[7]
Definition: smacker.c:56
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:925
int sample_rate
Audio only.
Definition: avcodec.h:4146
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
int indexes[7]
Definition: smacker.c:54
Main libavformat public API header.
uint32_t frames
Definition: smacker.c:46
void * priv_data
Format private data.
Definition: avformat.h:1381
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:4078
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:4050
int channels
Audio only.
Definition: avcodec.h:4142
#define av_freep(p)
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:650
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1023
#define av_malloc_array(a, b)
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:356
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:4040
unsigned int avio_rl24(AVIOContext *s)
Definition: aviobuf.c:759
int stream_index
Definition: avcodec.h:1535
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 AV_CH_LAYOUT_MONO
#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:1510
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1526