Get rid of unnecessary pointer casts.
[ffmpeg.git] / libavformat / flic.c
1 /*
2  * FLI/FLC Animation File Demuxer
3  * Copyright (c) 2003 The ffmpeg Project
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 flic.c
24  * FLI/FLC file demuxer
25  * by Mike Melanson (melanson@pcisys.net)
26  * for more information on the .fli/.flc file format and all of its many
27  * variations, visit:
28  *   http://www.compuphase.com/flic.htm
29  *
30  * This demuxer handles standard 0xAF11- and 0xAF12-type FLIs. It also
31  * handles special FLIs from the PC game "Magic Carpet".
32  */
33
34 #include "avformat.h"
35
36 #define FLIC_FILE_MAGIC_1 0xAF11
37 #define FLIC_FILE_MAGIC_2 0xAF12
38 #define FLIC_FILE_MAGIC_3 0xAF44  /* Flic Type for Extended FLX Format which
39                                      originated in Dave's Targa Animator (DTA) */
40 #define FLIC_CHUNK_MAGIC_1 0xF1FA
41 #define FLIC_CHUNK_MAGIC_2 0xF5FA
42 #define FLIC_MC_PTS_INC 6000  /* pts increment for Magic Carpet game FLIs */
43 #define FLIC_DEFAULT_PTS_INC 6000  /* for FLIs that have 0 speed */
44
45 #define FLIC_HEADER_SIZE 128
46 #define FLIC_PREAMBLE_SIZE 6
47
48 typedef struct FlicDemuxContext {
49     int frame_pts_inc;
50     int64_t pts;
51     int video_stream_index;
52 } FlicDemuxContext;
53
54 static int flic_probe(AVProbeData *p)
55 {
56     int magic_number;
57
58     magic_number = AV_RL16(&p->buf[4]);
59     if ((magic_number != FLIC_FILE_MAGIC_1) &&
60         (magic_number != FLIC_FILE_MAGIC_2) &&
61         (magic_number != FLIC_FILE_MAGIC_3))
62         return 0;
63
64     return AVPROBE_SCORE_MAX;
65 }
66
67 static int flic_read_header(AVFormatContext *s,
68                             AVFormatParameters *ap)
69 {
70     FlicDemuxContext *flic = s->priv_data;
71     ByteIOContext *pb = &s->pb;
72     unsigned char header[FLIC_HEADER_SIZE];
73     AVStream *st;
74     int speed;
75     int magic_number;
76
77     flic->pts = 0;
78
79     /* load the whole header and pull out the width and height */
80     if (get_buffer(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
81         return AVERROR_IO;
82
83     magic_number = AV_RL16(&header[4]);
84     speed = AV_RL32(&header[0x10]);
85
86     /* initialize the decoder streams */
87     st = av_new_stream(s, 0);
88     if (!st)
89         return AVERROR_NOMEM;
90     flic->video_stream_index = st->index;
91     st->codec->codec_type = CODEC_TYPE_VIDEO;
92     st->codec->codec_id = CODEC_ID_FLIC;
93     st->codec->codec_tag = 0;  /* no fourcc */
94     st->codec->width = AV_RL16(&header[0x08]);
95     st->codec->height = AV_RL16(&header[0x0A]);
96
97     if (!st->codec->width || !st->codec->height)
98         return AVERROR_INVALIDDATA;
99
100     /* send over the whole 128-byte FLIC header */
101     st->codec->extradata_size = FLIC_HEADER_SIZE;
102     st->codec->extradata = av_malloc(FLIC_HEADER_SIZE);
103     memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
104
105     av_set_pts_info(st, 33, 1, 90000);
106
107     /* Time to figure out the framerate: If there is a FLIC chunk magic
108      * number at offset 0x10, assume this is from the Bullfrog game,
109      * Magic Carpet. */
110     if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
111
112         flic->frame_pts_inc = FLIC_MC_PTS_INC;
113
114         /* rewind the stream since the first chunk is at offset 12 */
115         url_fseek(pb, 12, SEEK_SET);
116
117         /* send over abbreviated FLIC header chunk */
118         av_free(st->codec->extradata);
119         st->codec->extradata_size = 12;
120         st->codec->extradata = av_malloc(12);
121         memcpy(st->codec->extradata, header, 12);
122
123     } else if (magic_number == FLIC_FILE_MAGIC_1) {
124         /*
125          * in this case, the speed (n) is number of 1/70s ticks between frames:
126          *
127          *    pts        n * frame #
128          *  --------  =  -----------  => pts = n * (90000/70) * frame #
129          *   90000           70
130          *
131          *  therefore, the frame pts increment = n * 1285.7
132          */
133         flic->frame_pts_inc = speed * 1285.7;
134     } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
135                (magic_number == FLIC_FILE_MAGIC_3)) {
136         /*
137          * in this case, the speed (n) is number of milliseconds between frames:
138          *
139          *    pts        n * frame #
140          *  --------  =  -----------  => pts = n * 90 * frame #
141          *   90000          1000
142          *
143          *  therefore, the frame pts increment = n * 90
144          */
145         flic->frame_pts_inc = speed * 90;
146     } else {
147         av_log(s, AV_LOG_INFO, "Invalid or unsupported magic chunk in file\n");
148         return AVERROR_INVALIDDATA;
149     }
150
151     if (flic->frame_pts_inc == 0)
152         flic->frame_pts_inc = FLIC_DEFAULT_PTS_INC;
153
154     return 0;
155 }
156
157 static int flic_read_packet(AVFormatContext *s,
158                             AVPacket *pkt)
159 {
160     FlicDemuxContext *flic = s->priv_data;
161     ByteIOContext *pb = &s->pb;
162     int packet_read = 0;
163     unsigned int size;
164     int magic;
165     int ret = 0;
166     unsigned char preamble[FLIC_PREAMBLE_SIZE];
167
168     while (!packet_read) {
169
170         if ((ret = get_buffer(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
171             FLIC_PREAMBLE_SIZE) {
172             ret = AVERROR_IO;
173             break;
174         }
175
176         size = AV_RL32(&preamble[0]);
177         magic = AV_RL16(&preamble[4]);
178
179         if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
180             if (av_new_packet(pkt, size)) {
181                 ret = AVERROR_IO;
182                 break;
183             }
184             pkt->stream_index = flic->video_stream_index;
185             pkt->pts = flic->pts;
186             pkt->pos = url_ftell(pb);
187             memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
188             ret = get_buffer(pb, pkt->data + FLIC_PREAMBLE_SIZE,
189                 size - FLIC_PREAMBLE_SIZE);
190             if (ret != size - FLIC_PREAMBLE_SIZE) {
191                 av_free_packet(pkt);
192                 ret = AVERROR_IO;
193             }
194             flic->pts += flic->frame_pts_inc;
195             packet_read = 1;
196         } else {
197             /* not interested in this chunk */
198             url_fseek(pb, size - 6, SEEK_CUR);
199         }
200     }
201
202     return ret;
203 }
204
205 static int flic_read_close(AVFormatContext *s)
206 {
207 //    FlicDemuxContext *flic = s->priv_data;
208
209     return 0;
210 }
211
212 AVInputFormat flic_demuxer = {
213     "flic",
214     "FLI/FLC/FLX animation format",
215     sizeof(FlicDemuxContext),
216     flic_probe,
217     flic_read_header,
218     flic_read_packet,
219     flic_read_close,
220 };