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