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