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 
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/intreadwrite.h"
30 #include "avformat.h"
31 #include "avio_internal.h"
32 #include "demux.h"
33 #include "internal.h"
34 
35 #define SMACKER_PAL 0x01
36 #define SMACKER_FLAG_RING_FRAME 0x01
37 
38 enum SAudFlags {
39     SMK_AUD_PACKED  = 0x80,
40     SMK_AUD_16BITS  = 0x20,
41     SMK_AUD_STEREO  = 0x10,
42     SMK_AUD_BINKAUD = 0x08,
43     SMK_AUD_USEDCT  = 0x04
44 };
45 
46 typedef struct SmackerContext {
47     uint32_t frames;
48     /* frame info */
49     uint32_t *frm_size;
50     uint8_t  *frm_flags;
51     /* internal variables */
52     int64_t next_frame_pos;
53     int cur_frame;
54     int videoindex;
55     int indexes[7];
56     int duration_size[7];
57     /* current frame for demuxing */
58     uint32_t frame_size;
59     int flags;
60     int next_audio_index;
61     int new_palette;
62     uint8_t pal[768];
63     int64_t aud_pts[7];
64 } SmackerContext;
65 
66 /* palette used in Smacker */
67 static const uint8_t smk_pal[64] = {
68     0x00, 0x04, 0x08, 0x0C, 0x10, 0x14, 0x18, 0x1C,
69     0x20, 0x24, 0x28, 0x2C, 0x30, 0x34, 0x38, 0x3C,
70     0x41, 0x45, 0x49, 0x4D, 0x51, 0x55, 0x59, 0x5D,
71     0x61, 0x65, 0x69, 0x6D, 0x71, 0x75, 0x79, 0x7D,
72     0x82, 0x86, 0x8A, 0x8E, 0x92, 0x96, 0x9A, 0x9E,
73     0xA2, 0xA6, 0xAA, 0xAE, 0xB2, 0xB6, 0xBA, 0xBE,
74     0xC3, 0xC7, 0xCB, 0xCF, 0xD3, 0xD7, 0xDB, 0xDF,
75     0xE3, 0xE7, 0xEB, 0xEF, 0xF3, 0xF7, 0xFB, 0xFF
76 };
77 
78 
smacker_probe(const AVProbeData *p)79 static int smacker_probe(const AVProbeData *p)
80 {
81     if (   AV_RL32(p->buf) != MKTAG('S', 'M', 'K', '2')
82         && AV_RL32(p->buf) != MKTAG('S', 'M', 'K', '4'))
83         return 0;
84 
85     if (AV_RL32(p->buf+4) > 32768U || AV_RL32(p->buf+8) > 32768U)
86         return AVPROBE_SCORE_MAX/4;
87 
88     return AVPROBE_SCORE_MAX;
89 }
90 
smacker_read_header(AVFormatContext *s)91 static int smacker_read_header(AVFormatContext *s)
92 {
93     AVIOContext *pb = s->pb;
94     SmackerContext *smk = s->priv_data;
95     AVStream *st;
96     AVCodecParameters *par;
97     uint32_t magic, width, height, flags, treesize;
98     int64_t pos;
99     int i, ret, pts_inc;
100     int tbase;
101 
102     /* read and check header */
103     magic  = avio_rl32(pb);
104     if (magic != MKTAG('S', 'M', 'K', '2') && magic != MKTAG('S', 'M', 'K', '4'))
105         return AVERROR_INVALIDDATA;
106     width  = avio_rl32(pb);
107     height = avio_rl32(pb);
108     smk->frames = avio_rl32(pb);
109     pts_inc = avio_rl32(pb);
110     if (pts_inc > INT_MAX / 100 || pts_inc == INT_MIN) {
111         av_log(s, AV_LOG_ERROR, "pts_inc %d is invalid\n", pts_inc);
112         return AVERROR_INVALIDDATA;
113     }
114 
115     flags = avio_rl32(pb);
116     if (flags & SMACKER_FLAG_RING_FRAME)
117         smk->frames++;
118     if (smk->frames > 0xFFFFFF) {
119         av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n", smk->frames);
120         return AVERROR_INVALIDDATA;
121     }
122 
123     avio_skip(pb, 28); /* Unused audio related data */
124 
125     treesize = avio_rl32(pb);
126     if (treesize >= UINT_MAX/4) {
127         // treesize + 16 must not overflow (this check is probably redundant)
128         av_log(s, AV_LOG_ERROR, "treesize too large\n");
129         return AVERROR_INVALIDDATA;
130     }
131 
132     st = avformat_new_stream(s, NULL);
133     if (!st)
134         return AVERROR(ENOMEM);
135 
136     smk->videoindex = st->index;
137     /* Smacker uses 100000 as internal timebase */
138     if (pts_inc < 0)
139         pts_inc = -pts_inc;
140     else
141         pts_inc *= 100;
142     tbase = 100000;
143     av_reduce(&tbase, &pts_inc, tbase, pts_inc, (1UL << 31) - 1);
144     avpriv_set_pts_info(st, 33, pts_inc, tbase);
145     st->duration = smk->frames;
146 
147     /* init video codec */
148     par = st->codecpar;
149     par->width      = width;
150     par->height     = height;
151     par->format     = AV_PIX_FMT_PAL8;
152     par->codec_type = AVMEDIA_TYPE_VIDEO;
153     par->codec_id   = AV_CODEC_ID_SMACKVIDEO;
154     par->codec_tag  = magic;
155 
156     if ((ret = ff_alloc_extradata(par, treesize + 16)) < 0) {
157         av_log(s, AV_LOG_ERROR,
158                "Cannot allocate %"PRIu32" bytes of extradata\n",
159                treesize + 16);
160         return ret;
161     }
162     if ((ret = ffio_read_size(pb, par->extradata, 16)) < 0)
163         return ret;
164 
165     /* handle possible audio streams */
166     for (i = 0; i < 7; i++) {
167         uint32_t rate = avio_rl24(pb);
168         uint8_t aflag = avio_r8(pb);
169 
170         smk->indexes[i] = -1;
171 
172         if (rate) {
173             AVStream *ast = avformat_new_stream(s, NULL);
174             AVCodecParameters *par;
175             if (!ast)
176                 return AVERROR(ENOMEM);
177 
178             smk->indexes[i] = ast->index;
179             par = ast->codecpar;
180             par->codec_type = AVMEDIA_TYPE_AUDIO;
181             if (aflag & SMK_AUD_BINKAUD) {
182                 par->codec_id  = AV_CODEC_ID_BINKAUDIO_RDFT;
183             } else if (aflag & SMK_AUD_USEDCT) {
184                 par->codec_id  = AV_CODEC_ID_BINKAUDIO_DCT;
185             } else if (aflag & SMK_AUD_PACKED) {
186                 par->codec_id  = AV_CODEC_ID_SMACKAUDIO;
187                 par->codec_tag = MKTAG('S', 'M', 'K', 'A');
188             } else {
189                 par->codec_id  = AV_CODEC_ID_PCM_U8;
190             }
191             av_channel_layout_default(&par->ch_layout,
192                                       !!(aflag & SMK_AUD_STEREO) + 1);
193             par->sample_rate = rate;
194             par->bits_per_coded_sample = (aflag & SMK_AUD_16BITS) ? 16 : 8;
195             if (par->bits_per_coded_sample == 16 &&
196                 par->codec_id == AV_CODEC_ID_PCM_U8)
197                 par->codec_id = AV_CODEC_ID_PCM_S16LE;
198             else
199                 smk->duration_size[i] = 4;
200             avpriv_set_pts_info(ast, 64, 1, par->sample_rate * par->ch_layout.nb_channels
201                                             * par->bits_per_coded_sample / 8);
202         }
203     }
204 
205     avio_rl32(pb); /* padding */
206 
207     /* setup data */
208     st->priv_data  = av_malloc_array(smk->frames, sizeof(*smk->frm_size) +
209                                                   sizeof(*smk->frm_flags));
210     if (!st->priv_data)
211         return AVERROR(ENOMEM);
212     smk->frm_size  = st->priv_data;
213     smk->frm_flags = (void*)(smk->frm_size + smk->frames);
214 
215     /* read frame info */
216     pos = 0;
217     for (i = 0; i < smk->frames; i++) {
218         smk->frm_size[i] = avio_rl32(pb);
219         if ((ret = av_add_index_entry(st, pos, i, smk->frm_size[i], 0,
220                                       (i == 0 || (smk->frm_size[i] & 1)) ? AVINDEX_KEYFRAME : 0)) < 0)
221             return ret;
222         pos += smk->frm_size[i];
223     }
224     if ((ret = ffio_read_size(pb, smk->frm_flags, smk->frames)) < 0 ||
225         /* load trees to extradata, they will be unpacked by decoder */
226         (ret = ffio_read_size(pb, par->extradata + 16,
227                               par->extradata_size - 16)) < 0) {
228         return ret;
229     }
230 
231     return 0;
232 }
233 
smacker_read_packet(AVFormatContext *s, AVPacket *pkt)234 static int smacker_read_packet(AVFormatContext *s, AVPacket *pkt)
235 {
236     SmackerContext *smk = s->priv_data;
237     int flags;
238     int ret;
239 
240     if (avio_feof(s->pb) || smk->cur_frame >= smk->frames)
241         return AVERROR_EOF;
242 
243     /* if we demuxed all streams, pass another frame */
244     if (!smk->next_audio_index) {
245         smk->frame_size = smk->frm_size[smk->cur_frame] & (~3);
246         smk->next_frame_pos = avio_tell(s->pb) + smk->frame_size;
247         flags = smk->frm_flags[smk->cur_frame];
248         smk->flags = flags >> 1;
249         /* handle palette change event */
250         if (flags & SMACKER_PAL) {
251             int size, sz, t, off, j, pos;
252             uint8_t *pal = smk->pal;
253             uint8_t oldpal[768];
254 
255             memcpy(oldpal, pal, 768);
256             size = avio_r8(s->pb);
257             size = size * 4;
258             if (size > smk->frame_size) {
259                 ret = AVERROR_INVALIDDATA;
260                 goto next_frame;
261             }
262             smk->frame_size -= size--;
263             sz = 0;
264             pos = avio_tell(s->pb) + size;
265             while (sz < 256) {
266                 t = avio_r8(s->pb);
267                 if (t & 0x80) { /* skip palette entries */
268                     sz  +=  (t & 0x7F) + 1;
269                     pal += ((t & 0x7F) + 1) * 3;
270                 } else if (t & 0x40) { /* copy with offset */
271                     off = avio_r8(s->pb);
272                     j = (t & 0x3F) + 1;
273                     if (off + j > 0x100) {
274                         av_log(s, AV_LOG_ERROR,
275                                "Invalid palette update, offset=%d length=%d extends beyond palette size\n",
276                                off, j);
277                         ret = AVERROR_INVALIDDATA;
278                         goto next_frame;
279                     }
280                     off *= 3;
281                     while (j-- && sz < 256) {
282                         *pal++ = oldpal[off + 0];
283                         *pal++ = oldpal[off + 1];
284                         *pal++ = oldpal[off + 2];
285                         sz++;
286                         off += 3;
287                     }
288                 } else { /* new entries */
289                     *pal++ = smk_pal[t];
290                     *pal++ = smk_pal[avio_r8(s->pb) & 0x3F];
291                     *pal++ = smk_pal[avio_r8(s->pb) & 0x3F];
292                     sz++;
293                 }
294             }
295             avio_seek(s->pb, pos, 0);
296             smk->new_palette = 1;
297         }
298     }
299 
300     for (int i = smk->next_audio_index; i < 7; i++) {
301         if (smk->flags & (1 << i)) {
302             uint32_t size;
303 
304             size = avio_rl32(s->pb);
305             if ((int)size < 4 + smk->duration_size[i] || size > smk->frame_size) {
306                 av_log(s, AV_LOG_ERROR, "Invalid audio part size\n");
307                 ret = AVERROR_INVALIDDATA;
308                 goto next_frame;
309             }
310             smk->frame_size -= size;
311             size            -= 4;
312 
313             if (smk->indexes[i] < 0 ||
314                 s->streams[smk->indexes[i]]->discard >= AVDISCARD_ALL) {
315                 smk->aud_pts[i] += smk->duration_size[i] ? avio_rl32(s->pb)
316                                                          : size;
317                 avio_skip(s->pb, size - smk->duration_size[i]);
318                 continue;
319             }
320             if ((ret = av_get_packet(s->pb, pkt, size)) != size) {
321                 ret = ret < 0 ? ret : AVERROR_INVALIDDATA;
322                 goto next_frame;
323             }
324             pkt->stream_index = smk->indexes[i];
325             pkt->pts          = smk->aud_pts[i];
326             pkt->duration     = smk->duration_size[i] ? AV_RL32(pkt->data)
327                                                       : size;
328             smk->aud_pts[i]  += pkt->duration;
329             smk->next_audio_index = i + 1;
330             return 0;
331         }
332     }
333 
334     if (s->streams[smk->videoindex]->discard >= AVDISCARD_ALL) {
335         ret = FFERROR_REDO;
336         goto next_frame;
337     }
338     if (smk->frame_size >= INT_MAX/2) {
339         ret = AVERROR_INVALIDDATA;
340         goto next_frame;
341     }
342     if ((ret = av_new_packet(pkt, smk->frame_size + 769)) < 0)
343         goto next_frame;
344     flags = smk->new_palette;
345     if ((smk->frm_size[smk->cur_frame] & 1) || smk->cur_frame == 0)
346         flags |= 2;
347     pkt->data[0] = flags;
348     memcpy(pkt->data + 1, smk->pal, 768);
349     ret = ffio_read_size(s->pb, pkt->data + 769, smk->frame_size);
350     if (ret < 0)
351         goto next_frame;
352     pkt->stream_index = smk->videoindex;
353     pkt->pts          = smk->cur_frame;
354     pkt->duration = 1;
355     if (flags & 2)
356         pkt->flags |= AV_PKT_FLAG_KEY;
357     smk->next_audio_index = 0;
358     smk->new_palette = 0;
359     smk->cur_frame++;
360 
361     return 0;
362 next_frame:
363     avio_seek(s->pb, smk->next_frame_pos, SEEK_SET);
364     smk->next_audio_index = 0;
365     smk->cur_frame++;
366     return ret;
367 }
368 
smacker_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)369 static int smacker_read_seek(AVFormatContext *s, int stream_index,
370                              int64_t timestamp, int flags)
371 {
372     AVStream *st = s->streams[stream_index];
373     SmackerContext *smk = s->priv_data;
374     int64_t pos;
375     int ret;
376 
377     if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL))
378         return -1;
379 
380     if (timestamp < 0 || timestamp >= smk->frames)
381         return AVERROR(EINVAL);
382 
383     ret = av_index_search_timestamp(st, timestamp, flags);
384     if (ret < 0)
385         return ret;
386 
387     pos  = ffformatcontext(s)->data_offset;
388     pos += ffstream(st)->index_entries[ret].pos;
389     pos  = avio_seek(s->pb, pos, SEEK_SET);
390     if (pos < 0)
391         return pos;
392 
393     smk->cur_frame = ret;
394     smk->next_audio_index = 0;
395     smk->new_palette = 0;
396     memset(smk->pal, 0, sizeof(smk->pal));
397     memset(smk->aud_pts, 0, sizeof(smk->aud_pts));
398 
399     return 0;
400 }
401 
402 const AVInputFormat ff_smacker_demuxer = {
403     .name           = "smk",
404     .long_name      = NULL_IF_CONFIG_SMALL("Smacker"),
405     .priv_data_size = sizeof(SmackerContext),
406     .read_probe     = smacker_probe,
407     .read_header    = smacker_read_header,
408     .read_packet    = smacker_read_packet,
409     .read_seek      = smacker_read_seek,
410 };
411