3 * Copyright (c) 2007 Christian Ohm, 2008 Eli Friedman
5 * This file is part of FFmpeg.
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.
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.
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
25 #include "libavutil/avstring.h"
26 #include "libavutil/dict.h"
30 #define RPL_SIGNATURE "ARMovie\x0A"
31 #define RPL_SIGNATURE_SIZE 8
33 /** 256 is arbitrary, but should be big enough for any reasonable file. */
34 #define RPL_LINE_LENGTH 256
36 static int rpl_probe(const AVProbeData *p)
38 if (memcmp(p->buf, RPL_SIGNATURE, RPL_SIGNATURE_SIZE))
41 return AVPROBE_SCORE_MAX;
44 typedef struct RPLContext {
46 int32_t frames_per_chunk;
48 // Stream position data
49 uint32_t chunk_number;
51 uint32_t frame_in_part;
54 static int read_line(AVIOContext * pb, char* line, int bufsize)
57 for (i = 0; i < bufsize - 1; i++) {
63 return avio_feof(pb) ? -1 : 0;
71 static int32_t read_int(const char* line, const char** endptr, int* error)
73 unsigned long result = 0;
74 for (; *line>='0' && *line<='9'; line++) {
75 if (result > (0x7FFFFFFF - 9) / 10)
77 result = 10 * result + *line - '0';
83 static int32_t read_line_and_int(AVIOContext * pb, int* error)
85 char line[RPL_LINE_LENGTH];
87 *error |= read_line(pb, line, sizeof(line));
88 return read_int(line, &endptr, error);
91 /** Parsing for fps, which can be a fraction. Unfortunately,
92 * the spec for the header leaves out a lot of details,
93 * so this is mostly guessing.
95 static AVRational read_fps(const char* line, int* error)
99 num = read_int(line, &line, error);
102 for (; *line>='0' && *line<='9'; line++) {
103 // Truncate any numerator too large to fit into an int64_t
104 if (num > (INT64_MAX - 9) / 10 || den > INT64_MAX / 10)
106 num = 10 * num + *line - '0';
111 av_reduce(&result.num, &result.den, num, den, 0x7FFFFFFF);
115 static int rpl_read_header(AVFormatContext *s)
117 AVIOContext *pb = s->pb;
118 RPLContext *rpl = s->priv_data;
119 AVStream *vst = NULL, *ast = NULL;
120 int total_audio_size;
123 char audio_type[RPL_LINE_LENGTH];
127 int32_t video_format, audio_format, chunk_catalog_offset, number_of_chunks;
130 char line[RPL_LINE_LENGTH];
132 // The header for RPL/ARMovie files is 21 lines of text
133 // containing the various header fields. The fields are always
134 // in the same order, and other text besides the first
135 // number usually isn't important.
136 // (The spec says that there exists some significance
137 // for the text in a few cases; samples needed.)
138 error |= read_line(pb, line, sizeof(line)); // ARMovie
139 error |= read_line(pb, line, sizeof(line)); // movie name
140 av_dict_set(&s->metadata, "title" , line, 0);
141 error |= read_line(pb, line, sizeof(line)); // date/copyright
142 av_dict_set(&s->metadata, "copyright", line, 0);
143 error |= read_line(pb, line, sizeof(line)); // author and other
144 av_dict_set(&s->metadata, "author" , line, 0);
147 video_format = read_line_and_int(pb, &error);
149 vst = avformat_new_stream(s, NULL);
151 return AVERROR(ENOMEM);
152 vst->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
153 vst->codecpar->codec_tag = video_format;
154 vst->codecpar->width = read_line_and_int(pb, &error); // video width
155 vst->codecpar->height = read_line_and_int(pb, &error); // video height
156 vst->codecpar->bits_per_coded_sample = read_line_and_int(pb, &error); // video bits per sample
158 // Figure out the video codec
159 switch (vst->codecpar->codec_tag) {
162 vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE122;
166 vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE124;
167 // The header is wrong here, at least sometimes
168 vst->codecpar->bits_per_coded_sample = 16;
171 vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE130;
174 avpriv_report_missing_feature(s, "Video format %s",
175 av_fourcc2str(vst->codecpar->codec_tag));
176 vst->codecpar->codec_id = AV_CODEC_ID_NONE;
179 for (i = 0; i < 3; i++)
180 error |= read_line(pb, line, sizeof(line));
183 error |= read_line(pb, line, sizeof(line)); // video frames per second
184 fps = read_fps(line, &error);
186 avpriv_set_pts_info(vst, 32, fps.den, fps.num);
190 // ARMovie supports multiple audio tracks; I don't have any
191 // samples, though. This code will ignore additional tracks.
192 audio_format = read_line_and_int(pb, &error); // audio format ID
194 ast = avformat_new_stream(s, NULL);
196 return AVERROR(ENOMEM);
197 ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
198 ast->codecpar->codec_tag = audio_format;
199 ast->codecpar->sample_rate = read_line_and_int(pb, &error); // audio bitrate
200 ast->codecpar->channels = read_line_and_int(pb, &error); // number of audio channels
201 error |= read_line(pb, line, sizeof(line));
202 ast->codecpar->bits_per_coded_sample = read_int(line, &endptr, &error); // audio bits per sample
203 av_strlcpy(audio_type, endptr, RPL_LINE_LENGTH);
204 // At least one sample uses 0 for ADPCM, which is really 4 bits
206 if (ast->codecpar->bits_per_coded_sample == 0)
207 ast->codecpar->bits_per_coded_sample = 4;
209 ast->codecpar->bit_rate = ast->codecpar->sample_rate *
210 ast->codecpar->bits_per_coded_sample *
211 ast->codecpar->channels;
213 ast->codecpar->codec_id = AV_CODEC_ID_NONE;
214 switch (audio_format) {
216 if (ast->codecpar->bits_per_coded_sample == 16) {
217 // 16-bit audio is always signed
218 ast->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
220 } else if (ast->codecpar->bits_per_coded_sample == 8) {
221 if(av_stristr(audio_type, "unsigned") != NULL) {
222 ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
224 } else if(av_stristr(audio_type, "linear") != NULL) {
225 ast->codecpar->codec_id = AV_CODEC_ID_PCM_S8;
228 ast->codecpar->codec_id = AV_CODEC_ID_PCM_VIDC;
232 // There are some other formats listed as legal per the spec;
236 if (ast->codecpar->bits_per_coded_sample == 8) {
237 // The samples with this kind of audio that I have
239 ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
241 } else if (ast->codecpar->bits_per_coded_sample == 4) {
242 ast->codecpar->codec_id = AV_CODEC_ID_ADPCM_IMA_EA_SEAD;
247 if (ast->codecpar->codec_id == AV_CODEC_ID_NONE)
248 avpriv_request_sample(s, "Audio format %"PRId32,
250 avpriv_set_pts_info(ast, 32, 1, ast->codecpar->bit_rate);
252 for (i = 0; i < 3; i++)
253 error |= read_line(pb, line, sizeof(line));
256 rpl->frames_per_chunk = read_line_and_int(pb, &error); // video frames per chunk
257 if (vst && rpl->frames_per_chunk > 1 && vst->codecpar->codec_tag != 124)
258 av_log(s, AV_LOG_WARNING,
259 "Don't know how to split frames for video format %s. "
260 "Video stream will be broken!\n", av_fourcc2str(vst->codecpar->codec_tag));
262 number_of_chunks = read_line_and_int(pb, &error); // number of chunks in the file
263 // The number in the header is actually the index of the last chunk.
266 error |= read_line(pb, line, sizeof(line)); // "even" chunk size in bytes
267 error |= read_line(pb, line, sizeof(line)); // "odd" chunk size in bytes
268 chunk_catalog_offset = // offset of the "chunk catalog"
269 read_line_and_int(pb, &error); // (file index)
270 error |= read_line(pb, line, sizeof(line)); // offset to "helpful" sprite
271 error |= read_line(pb, line, sizeof(line)); // size of "helpful" sprite
273 error |= read_line(pb, line, sizeof(line)); // offset to key frame list
274 vst->duration = number_of_chunks * rpl->frames_per_chunk;
278 avio_seek(pb, chunk_catalog_offset, SEEK_SET);
279 total_audio_size = 0;
280 for (i = 0; !error && i < number_of_chunks; i++) {
281 int64_t offset, video_size, audio_size;
282 error |= read_line(pb, line, sizeof(line));
283 if (3 != sscanf(line, "%"SCNd64" , %"SCNd64" ; %"SCNd64,
284 &offset, &video_size, &audio_size)) {
289 av_add_index_entry(vst, offset, i * rpl->frames_per_chunk,
290 video_size, rpl->frames_per_chunk, 0);
292 av_add_index_entry(ast, offset + video_size, total_audio_size,
293 audio_size, audio_size * 8, 0);
294 total_audio_size += audio_size * 8;
297 if (error) return AVERROR(EIO);
302 static int rpl_read_packet(AVFormatContext *s, AVPacket *pkt)
304 RPLContext *rpl = s->priv_data;
305 AVIOContext *pb = s->pb;
307 AVIndexEntry* index_entry;
310 if (rpl->chunk_part == s->nb_streams) {
315 stream = s->streams[rpl->chunk_part];
317 if (rpl->chunk_number >= stream->nb_index_entries)
320 index_entry = &stream->index_entries[rpl->chunk_number];
322 if (rpl->frame_in_part == 0)
323 if (avio_seek(pb, index_entry->pos, SEEK_SET) < 0)
326 if (stream->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
327 stream->codecpar->codec_tag == 124) {
328 // We have to split Escape 124 frames because there are
329 // multiple frames per chunk in Escape 124 samples.
332 avio_skip(pb, 4); /* flags */
333 frame_size = avio_rl32(pb);
334 if (avio_seek(pb, -8, SEEK_CUR) < 0)
337 ret = av_get_packet(pb, pkt, frame_size);
340 if (ret != frame_size) {
341 av_packet_unref(pkt);
345 pkt->pts = index_entry->timestamp + rpl->frame_in_part;
346 pkt->stream_index = rpl->chunk_part;
348 rpl->frame_in_part++;
349 if (rpl->frame_in_part == rpl->frames_per_chunk) {
350 rpl->frame_in_part = 0;
354 ret = av_get_packet(pb, pkt, index_entry->size);
357 if (ret != index_entry->size) {
358 av_packet_unref(pkt);
362 if (stream->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
363 // frames_per_chunk should always be one here; the header
364 // parsing will warn if it isn't.
365 pkt->duration = rpl->frames_per_chunk;
367 // All the audio codecs supported in this container
368 // (at least so far) are constant-bitrate.
369 pkt->duration = ret * 8;
371 pkt->pts = index_entry->timestamp;
372 pkt->stream_index = rpl->chunk_part;
376 // None of the Escape formats have keyframes, and the ADPCM
377 // format used doesn't have keyframes.
378 if (rpl->chunk_number == 0 && rpl->frame_in_part == 0)
379 pkt->flags |= AV_PKT_FLAG_KEY;
384 AVInputFormat ff_rpl_demuxer = {
386 .long_name = NULL_IF_CONFIG_SMALL("RPL / ARMovie"),
387 .priv_data_size = sizeof(RPLContext),
388 .read_probe = rpl_probe,
389 .read_header = rpl_read_header,
390 .read_packet = rpl_read_packet,