git.sesse.net Git - ffmpeg/blob - libavformat/bethsoftvid.c

   1 /*
   2  * Bethsoft VID format Demuxer
   3  * Copyright (c) 2007 Nicholas Tung
   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
  24  * @brief Bethesda Softworks VID (.vid) file demuxer
  25  * @author Nicholas Tung [ntung (at. ntung com] (2007-03)
  26  * @see http://wiki.multimedia.cx/index.php?title=Bethsoft_VID
  27  * @see http://www.svatopluk.com/andux/docs/dfvid.html
  28  */
  29
  30 #include "libavutil/channel_layout.h"
  31 #include "libavutil/imgutils.h"
  32 #include "libavutil/intreadwrite.h"
  33 #include "avformat.h"
  34 #include "internal.h"
  35 #include "libavcodec/bethsoftvideo.h"
  36
  37 #define BVID_PALETTE_SIZE 3 * 256
  38
  39 #define DEFAULT_SAMPLE_RATE 11111
  40
  41 typedef struct BVID_DemuxContext
  42 {
  43     int nframes;
  44     int sample_rate;        /**< audio sample rate */
  45     int width;              /**< video width       */
  46     int height;             /**< video height      */
  47     /** delay value between frames, added to individual frame delay.
  48      * custom units, which will be added to other custom units (~=16ms according
  49      * to free, unofficial documentation) */
  50     int bethsoft_global_delay;
  51     int video_index;        /**< video stream index */
  52     int audio_index;        /**< audio stream index */
  53     int has_palette;
  54     uint8_t palette[BVID_PALETTE_SIZE];
  55
  56     int is_finished;
  57
  58 } BVID_DemuxContext;
  59
  60 static int vid_probe(const AVProbeData *p)
  61 {
  62     // little-endian VID tag, file starts with "VID\0"
  63     if (AV_RL32(p->buf) != MKTAG('V', 'I', 'D', 0))
  64         return 0;
  65
  66     if (p->buf[4] != 2)
  67         return AVPROBE_SCORE_MAX / 4;
  68
  69     return AVPROBE_SCORE_MAX;
  70 }
  71
  72 static int vid_read_header(AVFormatContext *s)
  73 {
  74     BVID_DemuxContext *vid = s->priv_data;
  75     AVIOContext *pb = s->pb;
  76     int ret;
  77
  78     /* load main header. Contents:
  79     *    bytes: 'V' 'I' 'D'
  80     *    int16s: always_512, nframes, width, height, delay, always_14
  81     */
  82     avio_skip(pb, 5);
  83     vid->nframes = avio_rl16(pb);
  84     vid->width   = avio_rl16(pb);
  85     vid->height  = avio_rl16(pb);
  86     vid->bethsoft_global_delay = avio_rl16(pb);
  87     avio_rl16(pb);
  88
  89     ret = av_image_check_size(vid->width, vid->height, 0, s);
  90     if (ret < 0)
  91         return ret;
  92
  93     // wait until the first packet to create each stream
  94     vid->video_index = -1;
  95     vid->audio_index = -1;
  96     vid->sample_rate = DEFAULT_SAMPLE_RATE;
  97     s->ctx_flags |= AVFMTCTX_NOHEADER;
  98
  99     return 0;
 100 }
 101
 102 #define BUFFER_PADDING_SIZE 1000
 103 static int read_frame(BVID_DemuxContext *vid, AVIOContext *pb, AVPacket *pkt,
 104                       uint8_t block_type, AVFormatContext *s)
 105 {
 106     uint8_t * vidbuf_start = NULL;
 107     int vidbuf_nbytes = 0;
 108     int code;
 109     int bytes_copied = 0;
 110     int position, duration, npixels;
 111     unsigned int vidbuf_capacity;
 112     int ret = 0;
 113     AVStream *st;
 114
 115     if (vid->video_index < 0) {
 116         st = avformat_new_stream(s, NULL);
 117         if (!st)
 118             return AVERROR(ENOMEM);
 119         vid->video_index = st->index;
 120         if (vid->audio_index < 0) {
 121             avpriv_request_sample(s, "Using default video time base since "
 122                                   "having no audio packet before the first "
 123                                   "video packet");
 124         }
 125         avpriv_set_pts_info(st, 64, 185, vid->sample_rate);
 126         st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
 127         st->codecpar->codec_id   = AV_CODEC_ID_BETHSOFTVID;
 128         st->codecpar->width      = vid->width;
 129         st->codecpar->height     = vid->height;
 130     }
 131     st      = s->streams[vid->video_index];
 132     npixels = st->codecpar->width * st->codecpar->height;
 133
 134     vidbuf_start = av_malloc(vidbuf_capacity = BUFFER_PADDING_SIZE);
 135     if(!vidbuf_start)
 136         return AVERROR(ENOMEM);
 137
 138     // save the file position for the packet, include block type
 139     position = avio_tell(pb) - 1;
 140
 141     vidbuf_start[vidbuf_nbytes++] = block_type;
 142
 143     // get the current packet duration
 144     duration = vid->bethsoft_global_delay + avio_rl16(pb);
 145
 146     // set the y offset if it exists (decoder header data should be in data section)
 147     if(block_type == VIDEO_YOFF_P_FRAME){
 148         if (avio_read(pb, &vidbuf_start[vidbuf_nbytes], 2) != 2) {
 149             ret = AVERROR(EIO);
 150             goto fail;
 151         }
 152         vidbuf_nbytes += 2;
 153     }
 154
 155     do{
 156         uint8_t *tmp = av_fast_realloc(vidbuf_start, &vidbuf_capacity,
 157                                        vidbuf_nbytes + BUFFER_PADDING_SIZE);
 158         if (!tmp) {
 159             ret = AVERROR(ENOMEM);
 160             goto fail;
 161         }
 162         vidbuf_start = tmp;
 163
 164         code = avio_r8(pb);
 165         vidbuf_start[vidbuf_nbytes++] = code;
 166
 167         if(code >= 0x80){ // rle sequence
 168             if(block_type == VIDEO_I_FRAME)
 169                 vidbuf_start[vidbuf_nbytes++] = avio_r8(pb);
 170         } else if(code){ // plain sequence
 171             if (avio_read(pb, &vidbuf_start[vidbuf_nbytes], code) != code) {
 172                 ret = AVERROR(EIO);
 173                 goto fail;
 174             }
 175             vidbuf_nbytes += code;
 176         }
 177         bytes_copied += code & 0x7F;
 178         if(bytes_copied == npixels){ // sometimes no stop character is given, need to keep track of bytes copied
 179             // may contain a 0 byte even if read all pixels
 180             if(avio_r8(pb))
 181                 avio_seek(pb, -1, SEEK_CUR);
 182             break;
 183         }
 184         if (bytes_copied > npixels) {
 185             ret = AVERROR_INVALIDDATA;
 186             goto fail;
 187         }
 188     } while(code);
 189
 190     // copy data into packet
 191     if ((ret = av_new_packet(pkt, vidbuf_nbytes)) < 0)
 192         goto fail;
 193     memcpy(pkt->data, vidbuf_start, vidbuf_nbytes);
 194
 195     pkt->pos = position;
 196     pkt->stream_index = vid->video_index;
 197     pkt->duration = duration;
 198     if (block_type == VIDEO_I_FRAME)
 199         pkt->flags |= AV_PKT_FLAG_KEY;
 200
 201     /* if there is a new palette available, add it to packet side data */
 202     if (vid->has_palette) {
 203         uint8_t *pdata = av_packet_new_side_data(pkt, AV_PKT_DATA_PALETTE,
 204                                                  BVID_PALETTE_SIZE);
 205         if (!pdata) {
 206             ret = AVERROR(ENOMEM);
 207             av_log(s, AV_LOG_ERROR, "Failed to allocate palette side data\n");
 208             goto fail;
 209         }
 210         memcpy(pdata, vid->palette, BVID_PALETTE_SIZE);
 211         vid->has_palette = 0;
 212     }
 213
 214     vid->nframes--;  // used to check if all the frames were read
 215 fail:
 216     av_free(vidbuf_start);
 217     return ret;
 218 }
 219
 220 static int vid_read_packet(AVFormatContext *s,
 221                            AVPacket *pkt)
 222 {
 223     BVID_DemuxContext *vid = s->priv_data;
 224     AVIOContext *pb = s->pb;
 225     unsigned char block_type;
 226     int audio_length;
 227     int ret_value;
 228
 229     if(vid->is_finished || avio_feof(pb))
 230         return AVERROR_EOF;
 231
 232     block_type = avio_r8(pb);
 233     switch(block_type){
 234         case PALETTE_BLOCK:
 235             if (vid->has_palette) {
 236                 av_log(s, AV_LOG_WARNING, "discarding unused palette\n");
 237                 vid->has_palette = 0;
 238             }
 239             if (avio_read(pb, vid->palette, BVID_PALETTE_SIZE) != BVID_PALETTE_SIZE) {
 240                 return AVERROR(EIO);
 241             }
 242             vid->has_palette = 1;
 243             return vid_read_packet(s, pkt);
 244
 245         case FIRST_AUDIO_BLOCK:
 246             avio_rl16(pb);
 247             // soundblaster DAC used for sample rate, as on specification page (link above)
 248             vid->sample_rate = 1000000 / (256 - avio_r8(pb));
 249         case AUDIO_BLOCK:
 250             if (vid->audio_index < 0) {
 251                 AVStream *st = avformat_new_stream(s, NULL);
 252                 if (!st)
 253                     return AVERROR(ENOMEM);
 254                 vid->audio_index                 = st->index;
 255                 st->codecpar->codec_type            = AVMEDIA_TYPE_AUDIO;
 256                 st->codecpar->codec_id              = AV_CODEC_ID_PCM_U8;
 257                 st->codecpar->channels              = 1;
 258                 st->codecpar->channel_layout        = AV_CH_LAYOUT_MONO;
 259                 st->codecpar->bits_per_coded_sample = 8;
 260                 st->codecpar->sample_rate           = vid->sample_rate;
 261                 st->codecpar->bit_rate              = 8 * st->codecpar->sample_rate;
 262                 st->start_time                   = 0;
 263                 avpriv_set_pts_info(st, 64, 1, vid->sample_rate);
 264             }
 265             audio_length = avio_rl16(pb);
 266             if ((ret_value = av_get_packet(pb, pkt, audio_length)) != audio_length) {
 267                 if (ret_value < 0)
 268                     return ret_value;
 269                 av_log(s, AV_LOG_ERROR, "incomplete audio block\n");
 270                 return AVERROR(EIO);
 271             }
 272             pkt->stream_index = vid->audio_index;
 273             pkt->duration     = audio_length;
 274             pkt->flags |= AV_PKT_FLAG_KEY;
 275             return 0;
 276
 277         case VIDEO_P_FRAME:
 278         case VIDEO_YOFF_P_FRAME:
 279         case VIDEO_I_FRAME:
 280             return read_frame(vid, pb, pkt, block_type, s);
 281
 282         case EOF_BLOCK:
 283             if(vid->nframes != 0)
 284                 av_log(s, AV_LOG_VERBOSE, "reached terminating character but not all frames read.\n");
 285             vid->is_finished = 1;
 286             return AVERROR(EIO);
 287         default:
 288             av_log(s, AV_LOG_ERROR, "unknown block (character = %c, decimal = %d, hex = %x)!!!\n",
 289                    block_type, block_type, block_type);
 290             return AVERROR_INVALIDDATA;
 291     }
 292 }
 293
 294 AVInputFormat ff_bethsoftvid_demuxer = {
 295     .name           = "bethsoftvid",
 296     .long_name      = NULL_IF_CONFIG_SMALL("Bethesda Softworks VID"),
 297     .priv_data_size = sizeof(BVID_DemuxContext),
 298     .read_probe     = vid_probe,
 299     .read_header    = vid_read_header,
 300     .read_packet    = vid_read_packet,
 301 };