FFmpeg  4.4
rpl.c
Go to the documentation of this file.
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 
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
47 
48  // Stream position data
49  uint32_t chunk_number;
50  uint32_t chunk_part;
51  uint32_t frame_in_part;
52 } RPLContext;
53 
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 
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 
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  */
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 
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 
125  uint32_t i;
126 
127  int32_t video_format, audio_format, chunk_catalog_offset, number_of_chunks;
128  AVRational fps;
129 
130  char line[RPL_LINE_LENGTH];
131 
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);
145 
146  // video headers
147  video_format = read_line_and_int(pb, &error);
148  if (video_format) {
149  vst = avformat_new_stream(s, NULL);
150  if (!vst)
151  return AVERROR(ENOMEM);
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
157 
158  // Figure out the video codec
159  switch (vst->codecpar->codec_tag) {
160 #if 0
161  case 122:
162  vst->codecpar->codec_id = AV_CODEC_ID_ESCAPE122;
163  break;
164 #endif
165  case 124:
167  // The header is wrong here, at least sometimes
168  vst->codecpar->bits_per_coded_sample = 16;
169  break;
170  case 130:
172  break;
173  default:
174  avpriv_report_missing_feature(s, "Video format %s",
177  }
178  } else {
179  for (i = 0; i < 3; i++)
180  error |= read_line(pb, line, sizeof(line));
181  }
182 
183  error |= read_line(pb, line, sizeof(line)); // video frames per second
184  fps = read_fps(line, &error);
185  if (vst)
186  avpriv_set_pts_info(vst, 32, fps.den, fps.num);
187 
188  // Audio headers
189 
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
193  if (audio_format) {
194  ast = avformat_new_stream(s, NULL);
195  if (!ast)
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
205  // per sample.
206  if (ast->codecpar->bits_per_coded_sample == 0)
207  ast->codecpar->bits_per_coded_sample = 4;
208 
209  ast->codecpar->bit_rate = ast->codecpar->sample_rate *
210  ast->codecpar->bits_per_coded_sample *
211  ast->codecpar->channels;
212 
213  ast->codecpar->codec_id = AV_CODEC_ID_NONE;
214  switch (audio_format) {
215  case 1:
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;
219  break;
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;
223  break;
224  } else if(av_stristr(audio_type, "linear") != NULL) {
225  ast->codecpar->codec_id = AV_CODEC_ID_PCM_S8;
226  break;
227  } else {
228  ast->codecpar->codec_id = AV_CODEC_ID_PCM_VIDC;
229  break;
230  }
231  }
232  // There are some other formats listed as legal per the spec;
233  // samples needed.
234  break;
235  case 101:
236  if (ast->codecpar->bits_per_coded_sample == 8) {
237  // The samples with this kind of audio that I have
238  // are all unsigned.
239  ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
240  break;
241  } else if (ast->codecpar->bits_per_coded_sample == 4) {
242  ast->codecpar->codec_id = AV_CODEC_ID_ADPCM_IMA_EA_SEAD;
243  break;
244  }
245  break;
246  }
247  if (ast->codecpar->codec_id == AV_CODEC_ID_NONE)
248  avpriv_request_sample(s, "Audio format %"PRId32,
249  audio_format);
250  avpriv_set_pts_info(ast, 32, 1, ast->codecpar->bit_rate);
251  } else {
252  for (i = 0; i < 3; i++)
253  error |= read_line(pb, line, sizeof(line));
254  }
255 
256  if (s->nb_streams == 0)
257  return AVERROR_INVALIDDATA;
258 
259  rpl->frames_per_chunk = read_line_and_int(pb, &error); // video frames per chunk
260  if (vst && rpl->frames_per_chunk > 1 && vst->codecpar->codec_tag != 124)
262  "Don't know how to split frames for video format %s. "
263  "Video stream will be broken!\n", av_fourcc2str(vst->codecpar->codec_tag));
264 
265  number_of_chunks = read_line_and_int(pb, &error); // number of chunks in the file
266  // The number in the header is actually the index of the last chunk.
267  number_of_chunks++;
268 
269  error |= read_line(pb, line, sizeof(line)); // "even" chunk size in bytes
270  error |= read_line(pb, line, sizeof(line)); // "odd" chunk size in bytes
271  chunk_catalog_offset = // offset of the "chunk catalog"
272  read_line_and_int(pb, &error); // (file index)
273  error |= read_line(pb, line, sizeof(line)); // offset to "helpful" sprite
274  error |= read_line(pb, line, sizeof(line)); // size of "helpful" sprite
275  if (vst) {
276  error |= read_line(pb, line, sizeof(line)); // offset to key frame list
277  vst->duration = number_of_chunks * rpl->frames_per_chunk;
278  }
279 
280  // Read the index
281  avio_seek(pb, chunk_catalog_offset, SEEK_SET);
282  total_audio_size = 0;
283  for (i = 0; !error && i < number_of_chunks; i++) {
284  int64_t offset, video_size, audio_size;
285  error |= read_line(pb, line, sizeof(line));
286  if (3 != sscanf(line, "%"SCNd64" , %"SCNd64" ; %"SCNd64,
287  &offset, &video_size, &audio_size)) {
288  error = -1;
289  continue;
290  }
291  if (vst)
293  video_size, rpl->frames_per_chunk, 0);
294  if (ast)
295  av_add_index_entry(ast, offset + video_size, total_audio_size,
296  audio_size, audio_size * 8, 0);
297  total_audio_size += audio_size * 8;
298  }
299 
300  if (error) return AVERROR(EIO);
301 
302  return 0;
303 }
304 
306 {
307  RPLContext *rpl = s->priv_data;
308  AVIOContext *pb = s->pb;
309  AVStream* stream;
310  AVIndexEntry* index_entry;
311  int ret;
312 
313  if (rpl->chunk_part == s->nb_streams) {
314  rpl->chunk_number++;
315  rpl->chunk_part = 0;
316  }
317 
318  stream = s->streams[rpl->chunk_part];
319 
320  if (rpl->chunk_number >= stream->nb_index_entries)
321  return AVERROR_EOF;
322 
323  index_entry = &stream->index_entries[rpl->chunk_number];
324 
325  if (rpl->frame_in_part == 0)
326  if (avio_seek(pb, index_entry->pos, SEEK_SET) < 0)
327  return AVERROR(EIO);
328 
329  if (stream->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
330  stream->codecpar->codec_tag == 124) {
331  // We have to split Escape 124 frames because there are
332  // multiple frames per chunk in Escape 124 samples.
333  uint32_t frame_size;
334 
335  avio_skip(pb, 4); /* flags */
336  frame_size = avio_rl32(pb);
337  if (avio_seek(pb, -8, SEEK_CUR) < 0)
338  return AVERROR(EIO);
339 
340  ret = av_get_packet(pb, pkt, frame_size);
341  if (ret < 0)
342  return ret;
343  if (ret != frame_size) {
344  return AVERROR(EIO);
345  }
346  pkt->duration = 1;
347  pkt->pts = index_entry->timestamp + rpl->frame_in_part;
348  pkt->stream_index = rpl->chunk_part;
349 
350  rpl->frame_in_part++;
351  if (rpl->frame_in_part == rpl->frames_per_chunk) {
352  rpl->frame_in_part = 0;
353  rpl->chunk_part++;
354  }
355  } else {
356  ret = av_get_packet(pb, pkt, index_entry->size);
357  if (ret < 0)
358  return ret;
359  if (ret != index_entry->size) {
360  return AVERROR(EIO);
361  }
362 
363  if (stream->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
364  // frames_per_chunk should always be one here; the header
365  // parsing will warn if it isn't.
366  pkt->duration = rpl->frames_per_chunk;
367  } else {
368  // All the audio codecs supported in this container
369  // (at least so far) are constant-bitrate.
370  pkt->duration = ret * 8;
371  }
372  pkt->pts = index_entry->timestamp;
373  pkt->stream_index = rpl->chunk_part;
374  rpl->chunk_part++;
375  }
376 
377  // None of the Escape formats have keyframes, and the ADPCM
378  // format used doesn't have keyframes.
379  if (rpl->chunk_number == 0 && rpl->frame_in_part == 0)
381 
382  return ret;
383 }
384 
386  .name = "rpl",
387  .long_name = NULL_IF_CONFIG_SMALL("RPL / ARMovie"),
388  .priv_data_size = sizeof(RPLContext),
392 };
int32_t
Main libavformat public API header.
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:310
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:253
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:364
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:337
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:750
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:624
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
#define s(width, name)
Definition: cbs_vp9.c:257
#define NULL
Definition: coverity.c:32
Public dictionary API.
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
@ AV_CODEC_ID_ESCAPE124
Definition: codec_id.h:164
@ AV_CODEC_ID_PCM_U8
Definition: codec_id.h:318
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:313
@ AV_CODEC_ID_ADPCM_IMA_EA_SEAD
Definition: codec_id.h:376
@ AV_CODEC_ID_NONE
Definition: codec_id.h:47
@ AV_CODEC_ID_ESCAPE130
Definition: codec_id.h:219
@ AV_CODEC_ID_PCM_S8
Definition: codec_id.h:317
@ AV_CODEC_ID_PCM_VIDC
Definition: codec_id.h:349
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:410
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4505
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)
Add an index entry into a sorted list.
Definition: utils.c:2011
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:70
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
#define AVERROR_EOF
End of file.
Definition: error.h:55
#define AVERROR(e)
Definition: error.h:43
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:200
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
Reduce a fraction.
Definition: rational.c:35
#define av_fourcc2str(fourcc)
Definition: avutil.h:348
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
char * av_stristr(const char *s1, const char *s2)
Locate the first case-independent occurrence in the string haystack of the string needle.
Definition: avstring.c:56
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:83
int i
Definition: input.c:407
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4941
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
common internal API header
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
int frame_size
Definition: mxfenc.c:2206
#define RPL_LINE_LENGTH
256 is arbitrary, but should be big enough for any reasonable file.
Definition: rpl.c:34
static int read_line(AVIOContext *pb, char *line, int bufsize)
Definition: rpl.c:54
static int rpl_read_header(AVFormatContext *s)
Definition: rpl.c:115
static int rpl_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: rpl.c:305
static int32_t read_int(const char *line, const char **endptr, int *error)
Definition: rpl.c:71
#define RPL_SIGNATURE
Definition: rpl.c:30
#define RPL_SIGNATURE_SIZE
Definition: rpl.c:31
static int32_t read_line_and_int(AVIOContext *pb, int *error)
Definition: rpl.c:83
static int rpl_probe(const AVProbeData *p)
Definition: rpl.c:36
AVInputFormat ff_rpl_demuxer
Definition: rpl.c:385
static AVRational read_fps(const char *line, int *error)
Parsing for fps, which can be a fraction.
Definition: rpl.c:95
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
int width
Video only.
Definition: codec_par.h:126
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
Format I/O context.
Definition: avformat.h:1232
Bytestream IO Context.
Definition: avio.h:161
int64_t pos
Definition: avformat.h:804
int64_t timestamp
Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are...
Definition: avformat.h:805
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:645
This structure stores compressed data.
Definition: packet.h:346
int stream_index
Definition: packet.h:371
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:375
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:387
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:362
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int num
Numerator.
Definition: rational.h:59
int den
Denominator.
Definition: rational.h:60
Stream structure.
Definition: avformat.h:873
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1038
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:922
int nb_index_entries
Definition: avformat.h:1092
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1090
Definition: rpl.c:44
uint32_t chunk_number
Definition: rpl.c:49
uint32_t frame_in_part
Definition: rpl.c:51
int32_t frames_per_chunk
Definition: rpl.c:46
uint32_t chunk_part
Definition: rpl.c:50
Definition: graph2dot.c:48
#define avpriv_request_sample(...)
#define av_log(a,...)
static void error(const char *err)
AVPacket * pkt
Definition: movenc.c:59
const char * b
Definition: vf_curves.c:118
static const uint8_t offset[127][2]
Definition: vf_spp.c:107