libavformat/rpl.c

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