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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 "libavutil/bswap.h"
27 #include "libavutil/intreadwrite.h"
28 #include "avformat.h"
29 #include "internal.h"
30 
31 #define SMACKER_PAL 0x01
32 #define SMACKER_FLAG_RING_FRAME 0x01
33 
34 enum SAudFlags {
40 };
41 
42 typedef struct SmackerContext {
43  /* Smacker file header */
44  uint32_t magic;
45  uint32_t width, height;
46  uint32_t frames;
47  int pts_inc;
48  uint32_t flags;
49  uint32_t audio[7];
50  uint32_t treesize;
52  uint8_t aflags[7];
53  uint32_t rates[7];
54  uint32_t pad;
55  /* frame info */
56  uint32_t *frm_size;
57  uint8_t *frm_flags;
58  /* internal variables */
59  int cur_frame;
60  int is_ver4;
61  int64_t cur_pts;
62  /* current frame for demuxing */
63  uint8_t pal[768];
64  int indexes[7];
66  uint8_t *bufs[7];
67  int buf_sizes[7];
68  int stream_id[7];
69  int curstream;
70  int64_t nextpos;
71  int64_t aud_pts[7];
73 
74 typedef struct SmackerFrame {
75  int64_t pts;
76  int stream;
77 } SmackerFrame;
78 
79 /* palette used in Smacker */
80 static const uint8_t smk_pal[64] = {
81  0x00, 0x04, 0x08, 0x0C, 0x10, 0x14, 0x18, 0x1C,
82  0x20, 0x24, 0x28, 0x2C, 0x30, 0x34, 0x38, 0x3C,
83  0x41, 0x45, 0x49, 0x4D, 0x51, 0x55, 0x59, 0x5D,
84  0x61, 0x65, 0x69, 0x6D, 0x71, 0x75, 0x79, 0x7D,
85  0x82, 0x86, 0x8A, 0x8E, 0x92, 0x96, 0x9A, 0x9E,
86  0xA2, 0xA6, 0xAA, 0xAE, 0xB2, 0xB6, 0xBA, 0xBE,
87  0xC3, 0xC7, 0xCB, 0xCF, 0xD3, 0xD7, 0xDB, 0xDF,
88  0xE3, 0xE7, 0xEB, 0xEF, 0xF3, 0xF7, 0xFB, 0xFF
89 };
90 
91 
92 static int smacker_probe(AVProbeData *p)
93 {
94  if(p->buf[0] == 'S' && p->buf[1] == 'M' && p->buf[2] == 'K'
95  && (p->buf[3] == '2' || p->buf[3] == '4'))
96  return AVPROBE_SCORE_MAX;
97  else
98  return 0;
99 }
100 
102 {
103  AVIOContext *pb = s->pb;
104  SmackerContext *smk = s->priv_data;
105  AVStream *st, *ast[7];
106  int i, ret;
107  int tbase;
108 
109  /* read and check header */
110  smk->magic = avio_rl32(pb);
111  if (smk->magic != MKTAG('S', 'M', 'K', '2') && smk->magic != MKTAG('S', 'M', 'K', '4'))
112  return -1;
113  smk->width = avio_rl32(pb);
114  smk->height = avio_rl32(pb);
115  smk->frames = avio_rl32(pb);
116  smk->pts_inc = (int32_t)avio_rl32(pb);
117  smk->flags = avio_rl32(pb);
118  if(smk->flags & SMACKER_FLAG_RING_FRAME)
119  smk->frames++;
120  for(i = 0; i < 7; i++)
121  smk->audio[i] = avio_rl32(pb);
122  smk->treesize = avio_rl32(pb);
123 
124  if(smk->treesize >= UINT_MAX/4){ // smk->treesize + 16 must not overflow (this check is probably redundant)
125  av_log(s, AV_LOG_ERROR, "treesize too large\n");
126  return -1;
127  }
128 
129 //FIXME remove extradata "rebuilding"
130  smk->mmap_size = avio_rl32(pb);
131  smk->mclr_size = avio_rl32(pb);
132  smk->full_size = avio_rl32(pb);
133  smk->type_size = avio_rl32(pb);
134  for(i = 0; i < 7; i++) {
135  smk->rates[i] = avio_rl24(pb);
136  smk->aflags[i] = avio_r8(pb);
137  }
138  smk->pad = avio_rl32(pb);
139  /* setup data */
140  if(smk->frames > 0xFFFFFF) {
141  av_log(s, AV_LOG_ERROR, "Too many frames: %i\n", smk->frames);
142  return -1;
143  }
144  smk->frm_size = av_malloc(smk->frames * 4);
145  smk->frm_flags = av_malloc(smk->frames);
146 
147  smk->is_ver4 = (smk->magic != MKTAG('S', 'M', 'K', '2'));
148 
149  /* read frame info */
150  for(i = 0; i < smk->frames; i++) {
151  smk->frm_size[i] = avio_rl32(pb);
152  }
153  for(i = 0; i < smk->frames; i++) {
154  smk->frm_flags[i] = avio_r8(pb);
155  }
156 
157  /* init video codec */
158  st = avformat_new_stream(s, NULL);
159  if (!st)
160  return -1;
161  smk->videoindex = st->index;
162  st->codec->width = smk->width;
163  st->codec->height = smk->height;
164  st->codec->pix_fmt = PIX_FMT_PAL8;
167  st->codec->codec_tag = smk->magic;
168  /* Smacker uses 100000 as internal timebase */
169  if(smk->pts_inc < 0)
170  smk->pts_inc = -smk->pts_inc;
171  else
172  smk->pts_inc *= 100;
173  tbase = 100000;
174  av_reduce(&tbase, &smk->pts_inc, tbase, smk->pts_inc, (1UL<<31)-1);
175  avpriv_set_pts_info(st, 33, smk->pts_inc, tbase);
176  st->duration = smk->frames;
177  /* handle possible audio streams */
178  for(i = 0; i < 7; i++) {
179  smk->indexes[i] = -1;
180  if (smk->rates[i]) {
181  ast[i] = avformat_new_stream(s, NULL);
182  smk->indexes[i] = ast[i]->index;
184  if (smk->aflags[i] & SMK_AUD_BINKAUD) {
186  } else if (smk->aflags[i] & SMK_AUD_USEDCT) {
188  } else if (smk->aflags[i] & SMK_AUD_PACKED){
190  ast[i]->codec->codec_tag = MKTAG('S', 'M', 'K', 'A');
191  } else {
192  ast[i]->codec->codec_id = CODEC_ID_PCM_U8;
193  }
194  ast[i]->codec->channels = (smk->aflags[i] & SMK_AUD_STEREO) ? 2 : 1;
195  ast[i]->codec->sample_rate = smk->rates[i];
196  ast[i]->codec->bits_per_coded_sample = (smk->aflags[i] & SMK_AUD_16BITS) ? 16 : 8;
197  if(ast[i]->codec->bits_per_coded_sample == 16 && ast[i]->codec->codec_id == CODEC_ID_PCM_U8)
198  ast[i]->codec->codec_id = CODEC_ID_PCM_S16LE;
199  avpriv_set_pts_info(ast[i], 64, 1, ast[i]->codec->sample_rate
200  * ast[i]->codec->channels * ast[i]->codec->bits_per_coded_sample / 8);
201  }
202  }
203 
204 
205  /* load trees to extradata, they will be unpacked by decoder */
206  st->codec->extradata = av_mallocz(smk->treesize + 16 +
208  st->codec->extradata_size = smk->treesize + 16;
209  if(!st->codec->extradata){
210  av_log(s, AV_LOG_ERROR, "Cannot allocate %i bytes of extradata\n", smk->treesize + 16);
211  av_free(smk->frm_size);
212  av_free(smk->frm_flags);
213  return -1;
214  }
215  ret = avio_read(pb, st->codec->extradata + 16, st->codec->extradata_size - 16);
216  if(ret != st->codec->extradata_size - 16){
217  av_free(smk->frm_size);
218  av_free(smk->frm_flags);
219  return AVERROR(EIO);
220  }
221  ((int32_t*)st->codec->extradata)[0] = av_le2ne32(smk->mmap_size);
222  ((int32_t*)st->codec->extradata)[1] = av_le2ne32(smk->mclr_size);
223  ((int32_t*)st->codec->extradata)[2] = av_le2ne32(smk->full_size);
224  ((int32_t*)st->codec->extradata)[3] = av_le2ne32(smk->type_size);
225 
226  smk->curstream = -1;
227  smk->nextpos = avio_tell(pb);
228 
229  return 0;
230 }
231 
232 
234 {
235  SmackerContext *smk = s->priv_data;
236  int flags;
237  int ret;
238  int i;
239  int frame_size = 0;
240  int palchange = 0;
241 
242  if (s->pb->eof_reached || smk->cur_frame >= smk->frames)
243  return AVERROR_EOF;
244 
245  /* if we demuxed all streams, pass another frame */
246  if(smk->curstream < 0) {
247  avio_seek(s->pb, smk->nextpos, 0);
248  frame_size = smk->frm_size[smk->cur_frame] & (~3);
249  flags = smk->frm_flags[smk->cur_frame];
250  /* handle palette change event */
251  if(flags & SMACKER_PAL){
252  int size, sz, t, off, j, pos;
253  uint8_t *pal = smk->pal;
254  uint8_t oldpal[768];
255 
256  memcpy(oldpal, pal, 768);
257  size = avio_r8(s->pb);
258  size = size * 4 - 1;
259  frame_size -= size;
260  frame_size--;
261  sz = 0;
262  pos = avio_tell(s->pb) + size;
263  while(sz < 256){
264  t = avio_r8(s->pb);
265  if(t & 0x80){ /* skip palette entries */
266  sz += (t & 0x7F) + 1;
267  pal += ((t & 0x7F) + 1) * 3;
268  } else if(t & 0x40){ /* copy with offset */
269  off = avio_r8(s->pb);
270  j = (t & 0x3F) + 1;
271  if (off + j > 0xff) {
272  av_log(s, AV_LOG_ERROR,
273  "Invalid palette update, offset=%d length=%d extends beyond palette size\n",
274  off, j);
275  return AVERROR_INVALIDDATA;
276  }
277  off *= 3;
278  while(j-- && sz < 256) {
279  *pal++ = oldpal[off + 0];
280  *pal++ = oldpal[off + 1];
281  *pal++ = oldpal[off + 2];
282  sz++;
283  off += 3;
284  }
285  } else { /* new entries */
286  *pal++ = smk_pal[t];
287  *pal++ = smk_pal[avio_r8(s->pb) & 0x3F];
288  *pal++ = smk_pal[avio_r8(s->pb) & 0x3F];
289  sz++;
290  }
291  }
292  avio_seek(s->pb, pos, 0);
293  palchange |= 1;
294  }
295  flags >>= 1;
296  smk->curstream = -1;
297  /* if audio chunks are present, put them to stack and retrieve later */
298  for(i = 0; i < 7; i++) {
299  if(flags & 1) {
300  uint32_t size;
301  uint8_t *tmpbuf;
302 
303  size = avio_rl32(s->pb) - 4;
304  if (!size || size > frame_size) {
305  av_log(s, AV_LOG_ERROR, "Invalid audio part size\n");
306  return AVERROR_INVALIDDATA;
307  }
308  frame_size -= size;
309  frame_size -= 4;
310  smk->curstream++;
311  tmpbuf = av_realloc(smk->bufs[smk->curstream], size);
312  if (!tmpbuf)
313  return AVERROR(ENOMEM);
314  smk->bufs[smk->curstream] = tmpbuf;
315  smk->buf_sizes[smk->curstream] = size;
316  ret = avio_read(s->pb, smk->bufs[smk->curstream], size);
317  if(ret != size)
318  return AVERROR(EIO);
319  smk->stream_id[smk->curstream] = smk->indexes[i];
320  }
321  flags >>= 1;
322  }
323  if (frame_size < 0 || frame_size >= INT_MAX/2)
324  return AVERROR_INVALIDDATA;
325  if (av_new_packet(pkt, frame_size + 769))
326  return AVERROR(ENOMEM);
327  if(smk->frm_size[smk->cur_frame] & 1)
328  palchange |= 2;
329  pkt->data[0] = palchange;
330  memcpy(pkt->data + 1, smk->pal, 768);
331  ret = avio_read(s->pb, pkt->data + 769, frame_size);
332  if(ret != frame_size)
333  return AVERROR(EIO);
334  pkt->stream_index = smk->videoindex;
335  pkt->size = ret + 769;
336  smk->cur_frame++;
337  smk->nextpos = avio_tell(s->pb);
338  } else {
339  if (smk->stream_id[smk->curstream] < 0)
340  return AVERROR_INVALIDDATA;
341  if (av_new_packet(pkt, smk->buf_sizes[smk->curstream]))
342  return AVERROR(ENOMEM);
343  memcpy(pkt->data, smk->bufs[smk->curstream], smk->buf_sizes[smk->curstream]);
344  pkt->size = smk->buf_sizes[smk->curstream];
345  pkt->stream_index = smk->stream_id[smk->curstream];
346  pkt->pts = smk->aud_pts[smk->curstream];
347  smk->aud_pts[smk->curstream] += AV_RL32(pkt->data);
348  smk->curstream--;
349  }
350 
351  return 0;
352 }
353 
355 {
356  SmackerContext *smk = s->priv_data;
357  int i;
358 
359  for(i = 0; i < 7; i++)
360  av_free(smk->bufs[i]);
361  av_free(smk->frm_size);
362  av_free(smk->frm_flags);
363 
364  return 0;
365 }
366 
368  .name = "smk",
369  .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
370  .priv_data_size = sizeof(SmackerContext),
375 };