1 /*
2 * ARMovie/RPL demuxer
3 * Copyright (c) 2007 Christian Ohm, 2008 Eli Friedman
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 #include <inttypes.h>
23 #include <stdlib.h>
24
25 #include "libavutil/avstring.h"
26 #include "libavutil/dict.h"
27 #include "avformat.h"
28 #include "internal.h"
29
30 #define RPL_SIGNATURE "ARMovie\x0A"
31 #define RPL_SIGNATURE_SIZE 8
32
33 /** 256 is arbitrary, but should be big enough for any reasonable file. */
34 #define RPL_LINE_LENGTH 256
35
rpl_probe(const AVProbeData * p)36 static int rpl_probe(const AVProbeData *p)
37 {
38 if (memcmp(p->buf, RPL_SIGNATURE, RPL_SIGNATURE_SIZE))
39 return 0;
40
41 return AVPROBE_SCORE_MAX;
42 }
43
44 typedef struct RPLContext {
45 // RPL header data
46 int32_t frames_per_chunk;
47
48 // Stream position data
49 uint32_t chunk_number;
50 uint32_t chunk_part;
51 uint32_t frame_in_part;
52 } RPLContext;
53
read_line(AVIOContext * pb,char * line,int bufsize)54 static int read_line(AVIOContext * pb, char* line, int bufsize)
55 {
56 int i;
57 for (i = 0; i < bufsize - 1; i++) {
58 int b = avio_r8(pb);
59 if (b == 0)
60 break;
61 if (b == '\n') {
62 line[i] = '\0';
63 return avio_feof(pb) ? -1 : 0;
64 }
65 line[i] = b;
66 }
67 line[i] = '\0';
68 return -1;
69 }
70
read_int(const char * line,const char ** endptr,int * error)71 static int32_t read_int(const char* line, const char** endptr, int* error)
72 {
73 unsigned long result = 0;
74 for (; *line>='0' && *line<='9'; line++) {
75 if (result > (0x7FFFFFFF - 9) / 10)
76 *error = -1;
77 result = 10 * result + *line - '0';
78 }
79 *endptr = line;
80 return result;
81 }
82
read_line_and_int(AVIOContext * pb,int * error)83 static int32_t read_line_and_int(AVIOContext * pb, int* error)
84 {
85 char line[RPL_LINE_LENGTH];
86 const char *endptr;
87 *error |= read_line(pb, line, sizeof(line));
88 return read_int(line, &endptr, error);
89 }
90
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.
94 */
read_fps(const char * line,int * error)95 static AVRational read_fps(const char* line, int* error)
96 {
97 int64_t num, den = 1;
98 AVRational result;
99 num = read_int(line, &line, error);
100 if (*line == '.')
101 line++;
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)
105 break;
106 num = 10 * num + (*line - '0');
107 den *= 10;
108 }
109 if (!num)
110 *error = -1;
111 av_reduce(&result.num, &result.den, num, den, 0x7FFFFFFF);
112 return result;
113 }
114
rpl_read_header(AVFormatContext * s)115 static int rpl_read_header(AVFormatContext *s)
116 {
117 AVIOContext *pb = s->pb;
118 RPLContext *rpl = s->priv_data;
119 AVStream *vst = NULL, *ast = NULL;
120 int total_audio_size;
121 int error = 0;
122 const char *endptr;
123 char audio_type[RPL_LINE_LENGTH];
124 char audio_codec[RPL_LINE_LENGTH];
125
126 uint32_t i;
127
128 int32_t video_format, audio_format, chunk_catalog_offset, number_of_chunks;
129 AVRational fps;
130
131 char line[RPL_LINE_LENGTH];
132
133 // The header for RPL/ARMovie files is 21 lines of text
134 // containing the various header fields. The fields are always
135 // in the same order, and other text besides the first
136 // number usually isn't important.
137 // (The spec says that there exists some significance
138 // for the text in a few cases; samples needed.)
139 error |= read_line(pb, line, sizeof(line)); // ARMovie
140 error |= read_line(pb, line, sizeof(line)); // movie name
141 av_dict_set(&s->metadata, "title" , line, 0);
142 error |= read_line(pb, line, sizeof(line)); // date/copyright
143 av_dict_set(&s->metadata, "copyright", line, 0);
144 error |= read_line(pb, line, sizeof(line)); // author and other
145 av_dict_set(&s->metadata, "author" , line, 0);
146
147 // video headers
148 video_format = read_line_and_int(pb, &error);
149 if (video_format) {
150 vst = avformat_new_stream(s, NULL);
151 if (!vst)
152 return AVERROR(ENOMEM);
153 vst->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
154 vst->codecpar->codec_tag = video_format;
155 vst->codecpar->width = read_line_and_int(pb, &error); // video width
156 vst->codecpar->height = read_line_and_int(pb, &error); // video height
157 vst->codecpar->bits_per_coded_sample = read_line_and_int(pb, &error); // video bits per sample
158
159 // Figure out the video codec
160 switch (vst->codecpar->codec_tag) {
161 #if 0
162 case 122:
163 vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE122;
164 break;
165 #endif
166 case 124:
167 vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE124;
168 // The header is wrong here, at least sometimes
169 vst->codecpar->bits_per_coded_sample = 16;
170 break;
171 case 130:
172 vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE130;
173 break;
174 default:
175 avpriv_report_missing_feature(s, "Video format %s",
176 av_fourcc2str(vst->codecpar->codec_tag));
177 vst->codecpar->codec_id = AV_CODEC_ID_NONE;
178 }
179 } else {
180 for (i = 0; i < 3; i++)
181 error |= read_line(pb, line, sizeof(line));
182 }
183
184 error |= read_line(pb, line, sizeof(line)); // video frames per second
185 fps = read_fps(line, &error);
186 if (vst)
187 avpriv_set_pts_info(vst, 32, fps.den, fps.num);
188
189 // Audio headers
190
191 // ARMovie supports multiple audio tracks; I don't have any
192 // samples, though. This code will ignore additional tracks.
193 error |= read_line(pb, line, sizeof(line));
194 audio_format = read_int(line, &endptr, &error); // audio format ID
195 av_strlcpy(audio_codec, endptr, RPL_LINE_LENGTH);
196 if (audio_format) {
197 int channels;
198 ast = avformat_new_stream(s, NULL);
199 if (!ast)
200 return AVERROR(ENOMEM);
201 ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
202 ast->codecpar->codec_tag = audio_format;
203 ast->codecpar->sample_rate = read_line_and_int(pb, &error); // audio bitrate
204 channels = read_line_and_int(pb, &error); // number of audio channels
205 error |= read_line(pb, line, sizeof(line));
206 ast->codecpar->bits_per_coded_sample = read_int(line, &endptr, &error); // audio bits per sample
207 av_strlcpy(audio_type, endptr, RPL_LINE_LENGTH);
208 ast->codecpar->ch_layout.nb_channels = channels;
209 // At least one sample uses 0 for ADPCM, which is really 4 bits
210 // per sample.
211 if (ast->codecpar->bits_per_coded_sample == 0)
212 ast->codecpar->bits_per_coded_sample = 4;
213
214 ast->codecpar->bit_rate = ast->codecpar->sample_rate *
215 (int64_t)ast->codecpar->ch_layout.nb_channels;
216 if (ast->codecpar->bit_rate > INT64_MAX / ast->codecpar->bits_per_coded_sample)
217 return AVERROR_INVALIDDATA;
218 ast->codecpar->bit_rate *= ast->codecpar->bits_per_coded_sample;
219
220 ast->codecpar->codec_id = AV_CODEC_ID_NONE;
221 switch (audio_format) {
222 case 1:
223 if (ast->codecpar->bits_per_coded_sample == 16) {
224 // 16-bit audio is always signed
225 ast->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
226 } else if (ast->codecpar->bits_per_coded_sample == 8) {
227 if (av_stristr(audio_type, "unsigned") != NULL)
228 ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
229 else if (av_stristr(audio_type, "linear") != NULL)
230 ast->codecpar->codec_id = AV_CODEC_ID_PCM_S8;
231 else
232 ast->codecpar->codec_id = AV_CODEC_ID_PCM_VIDC;
233 }
234 // There are some other formats listed as legal per the spec;
235 // samples needed.
236 break;
237 case 2:
238 if (av_stristr(audio_codec, "adpcm") != NULL) {
239 ast->codecpar->codec_id = AV_CODEC_ID_ADPCM_IMA_ACORN;
240 }
241 break;
242 case 101:
243 if (ast->codecpar->bits_per_coded_sample == 8) {
244 // The samples with this kind of audio that I have
245 // are all unsigned.
246 ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
247 } else if (ast->codecpar->bits_per_coded_sample == 4) {
248 ast->codecpar->codec_id = AV_CODEC_ID_ADPCM_IMA_EA_SEAD;
249 }
250 break;
251 }
252 if (ast->codecpar->codec_id == AV_CODEC_ID_NONE)
253 avpriv_request_sample(s, "Audio format %"PRId32" (%s)",
254 audio_format, audio_codec);
255 avpriv_set_pts_info(ast, 32, 1, ast->codecpar->bit_rate);
256 } else {
257 for (i = 0; i < 3; i++)
258 error |= read_line(pb, line, sizeof(line));
259 }
260
261 if (s->nb_streams == 0)
262 return AVERROR_INVALIDDATA;
263
264 rpl->frames_per_chunk = read_line_and_int(pb, &error); // video frames per chunk
265 if (vst && rpl->frames_per_chunk > 1 && vst->codecpar->codec_tag != 124)
266 av_log(s, AV_LOG_WARNING,
267 "Don't know how to split frames for video format %s. "
268 "Video stream will be broken!\n", av_fourcc2str(vst->codecpar->codec_tag));
269
270 number_of_chunks = read_line_and_int(pb, &error); // number of chunks in the file
271 if (number_of_chunks == INT_MAX)
272 return AVERROR_INVALIDDATA;
273
274 // The number in the header is actually the index of the last chunk.
275 number_of_chunks++;
276
277 error |= read_line(pb, line, sizeof(line)); // "even" chunk size in bytes
278 error |= read_line(pb, line, sizeof(line)); // "odd" chunk size in bytes
279 chunk_catalog_offset = // offset of the "chunk catalog"
280 read_line_and_int(pb, &error); // (file index)
281 error |= read_line(pb, line, sizeof(line)); // offset to "helpful" sprite
282 error |= read_line(pb, line, sizeof(line)); // size of "helpful" sprite
283 if (vst) {
284 error |= read_line(pb, line, sizeof(line)); // offset to key frame list
285 vst->duration = number_of_chunks * (int64_t)rpl->frames_per_chunk;
286 }
287
288 // Read the index
289 avio_seek(pb, chunk_catalog_offset, SEEK_SET);
290 total_audio_size = 0;
291 for (i = 0; !error && i < number_of_chunks; i++) {
292 int64_t offset, video_size, audio_size;
293 error |= read_line(pb, line, sizeof(line));
294 if (3 != sscanf(line, "%"SCNd64" , %"SCNd64" ; %"SCNd64,
295 &offset, &video_size, &audio_size)) {
296 error = -1;
297 continue;
298 }
299 if (vst)
300 av_add_index_entry(vst, offset, i * rpl->frames_per_chunk,
301 video_size, rpl->frames_per_chunk, 0);
302 if (ast)
303 av_add_index_entry(ast, offset + video_size, total_audio_size,
304 audio_size, audio_size * 8, 0);
305 total_audio_size += audio_size * 8;
306 }
307
308 if (error)
309 return AVERROR(EIO);
310
311 return 0;
312 }
313
rpl_read_packet(AVFormatContext * s,AVPacket * pkt)314 static int rpl_read_packet(AVFormatContext *s, AVPacket *pkt)
315 {
316 RPLContext *rpl = s->priv_data;
317 AVIOContext *pb = s->pb;
318 AVStream* stream;
319 FFStream *sti;
320 AVIndexEntry* index_entry;
321 int ret;
322
323 if (rpl->chunk_part == s->nb_streams) {
324 rpl->chunk_number++;
325 rpl->chunk_part = 0;
326 }
327
328 stream = s->streams[rpl->chunk_part];
329 sti = ffstream(stream);
330
331 if (rpl->chunk_number >= sti->nb_index_entries)
332 return AVERROR_EOF;
333
334 index_entry = &sti->index_entries[rpl->chunk_number];
335
336 if (rpl->frame_in_part == 0) {
337 if (avio_seek(pb, index_entry->pos, SEEK_SET) < 0)
338 return AVERROR(EIO);
339 }
340
341 if (stream->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
342 stream->codecpar->codec_tag == 124) {
343 // We have to split Escape 124 frames because there are
344 // multiple frames per chunk in Escape 124 samples.
345 uint32_t frame_size;
346
347 avio_skip(pb, 4); /* flags */
348 frame_size = avio_rl32(pb);
349 if (avio_feof(pb) || avio_seek(pb, -8, SEEK_CUR) < 0 || !frame_size)
350 return AVERROR(EIO);
351
352 ret = av_get_packet(pb, pkt, frame_size);
353 if (ret < 0)
354 return ret;
355 if (ret != frame_size)
356 return AVERROR(EIO);
357
358 pkt->duration = 1;
359 pkt->pts = index_entry->timestamp + rpl->frame_in_part;
360 pkt->stream_index = rpl->chunk_part;
361
362 rpl->frame_in_part++;
363 if (rpl->frame_in_part == rpl->frames_per_chunk) {
364 rpl->frame_in_part = 0;
365 rpl->chunk_part++;
366 }
367 } else {
368 ret = av_get_packet(pb, pkt, index_entry->size);
369 if (ret < 0)
370 return ret;
371 if (ret != index_entry->size)
372 return AVERROR(EIO);
373
374 if (stream->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
375 // frames_per_chunk should always be one here; the header
376 // parsing will warn if it isn't.
377 pkt->duration = rpl->frames_per_chunk;
378 } else {
379 // All the audio codecs supported in this container
380 // (at least so far) are constant-bitrate.
381 pkt->duration = ret * 8;
382 }
383 pkt->pts = index_entry->timestamp;
384 pkt->stream_index = rpl->chunk_part;
385 rpl->chunk_part++;
386 }
387
388 // None of the Escape formats have keyframes, and the ADPCM
389 // format used doesn't have keyframes.
390 if (rpl->chunk_number == 0 && rpl->frame_in_part == 0)
391 pkt->flags |= AV_PKT_FLAG_KEY;
392
393 return ret;
394 }
395
396 const AVInputFormat ff_rpl_demuxer = {
397 .name = "rpl",
398 .long_name = NULL_IF_CONFIG_SMALL("RPL / ARMovie"),
399 .priv_data_size = sizeof(RPLContext),
400 .read_probe = rpl_probe,
401 .read_header = rpl_read_header,
402 .read_packet = rpl_read_packet,
403 };
404