simplify PTS handling
[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_SPEED 5  /* speed for Magic Carpet game FLIs */
43 #define FLIC_DEFAULT_SPEED 5  /* 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 video_stream_index;
50     int frame_number;
51 } FlicDemuxContext;
52
53 static int flic_probe(AVProbeData *p)
54 {
55     int magic_number;
56
57     magic_number = AV_RL16(&p->buf[4]);
58     if ((magic_number != FLIC_FILE_MAGIC_1) &&
59         (magic_number != FLIC_FILE_MAGIC_2) &&
60         (magic_number != FLIC_FILE_MAGIC_3))
61         return 0;
62
63     return AVPROBE_SCORE_MAX;
64 }
65
66 static int flic_read_header(AVFormatContext *s,
67                             AVFormatParameters *ap)
68 {
69     FlicDemuxContext *flic = s->priv_data;
70     ByteIOContext *pb = &s->pb;
71     unsigned char header[FLIC_HEADER_SIZE];
72     AVStream *st;
73     int speed;
74     int magic_number;
75
76     flic->frame_number = 0;
77
78     /* load the whole header and pull out the width and height */
79     if (get_buffer(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
80         return AVERROR(EIO);
81
82     magic_number = AV_RL16(&header[4]);
83     speed = AV_RL32(&header[0x10]);
84     if (speed == 0)
85         speed = FLIC_DEFAULT_SPEED;
86
87     /* initialize the decoder streams */
88     st = av_new_stream(s, 0);
89     if (!st)
90         return AVERROR(ENOMEM);
91     flic->video_stream_index = st->index;
92     st->codec->codec_type = CODEC_TYPE_VIDEO;
93     st->codec->codec_id = CODEC_ID_FLIC;
94     st->codec->codec_tag = 0;  /* no fourcc */
95     st->codec->width = AV_RL16(&header[0x08]);
96     st->codec->height = AV_RL16(&header[0x0A]);
97
98     if (!st->codec->width || !st->codec->height) {
99         /* Ugly hack needed for the following sample: */
100         /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
101         av_log(s, AV_LOG_WARNING,
102                "File with no specified width/height. Trying 640x480.\n");
103         st->codec->width  = 640;
104         st->codec->height = 480;
105     }
106
107     /* send over the whole 128-byte FLIC header */
108     st->codec->extradata_size = FLIC_HEADER_SIZE;
109     st->codec->extradata = av_malloc(FLIC_HEADER_SIZE);
110     memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
111
112     /* Time to figure out the framerate: If there is a FLIC chunk magic
113      * number at offset 0x10, assume this is from the Bullfrog game,
114      * Magic Carpet. */
115     if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
116
117         av_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
118
119         /* rewind the stream since the first chunk is at offset 12 */
120         url_fseek(pb, 12, SEEK_SET);
121
122         /* send over abbreviated FLIC header chunk */
123         av_free(st->codec->extradata);
124         st->codec->extradata_size = 12;
125         st->codec->extradata = av_malloc(12);
126         memcpy(st->codec->extradata, header, 12);
127
128     } else if (magic_number == FLIC_FILE_MAGIC_1) {
129         av_set_pts_info(st, 64, speed, 70);
130     } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
131                (magic_number == FLIC_FILE_MAGIC_3)) {
132         av_set_pts_info(st, 64, speed, 1000);
133     } else {
134         av_log(s, AV_LOG_INFO, "Invalid or unsupported magic chunk in file\n");
135         return AVERROR_INVALIDDATA;
136     }
137
138     return 0;
139 }
140
141 static int flic_read_packet(AVFormatContext *s,
142                             AVPacket *pkt)
143 {
144     FlicDemuxContext *flic = s->priv_data;
145     ByteIOContext *pb = &s->pb;
146     int packet_read = 0;
147     unsigned int size;
148     int magic;
149     int ret = 0;
150     unsigned char preamble[FLIC_PREAMBLE_SIZE];
151
152     while (!packet_read) {
153
154         if ((ret = get_buffer(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
155             FLIC_PREAMBLE_SIZE) {
156             ret = AVERROR(EIO);
157             break;
158         }
159
160         size = AV_RL32(&preamble[0]);
161         magic = AV_RL16(&preamble[4]);
162
163         if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
164             if (av_new_packet(pkt, size)) {
165                 ret = AVERROR(EIO);
166                 break;
167             }
168             pkt->stream_index = flic->video_stream_index;
169             pkt->pts = flic->frame_number++;
170             pkt->pos = url_ftell(pb);
171             memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
172             ret = get_buffer(pb, pkt->data + FLIC_PREAMBLE_SIZE,
173                 size - FLIC_PREAMBLE_SIZE);
174             if (ret != size - FLIC_PREAMBLE_SIZE) {
175                 av_free_packet(pkt);
176                 ret = AVERROR(EIO);
177             }
178             packet_read = 1;
179         } else {
180             /* not interested in this chunk */
181             url_fseek(pb, size - 6, SEEK_CUR);
182         }
183     }
184
185     return ret;
186 }
187
188 static int flic_read_close(AVFormatContext *s)
189 {
190 //    FlicDemuxContext *flic = s->priv_data;
191
192     return 0;
193 }
194
195 AVInputFormat flic_demuxer = {
196     "flic",
197     "FLI/FLC/FLX animation format",
198     sizeof(FlicDemuxContext),
199     flic_probe,
200     flic_read_header,
201     flic_read_packet,
202     flic_read_close,
203 };