2 * Interplay MVE File Demuxer
3 * Copyright (c) 2003 The ffmpeg Project
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * Interplay MVE file demuxer
23 * by Mike Melanson (melanson@pcisys.net)
24 * For more information regarding the Interplay MVE file format, visit:
25 * http://www.pcisys.net/~melanson/codecs/
26 * The aforementioned site also contains a command line utility for parsing
27 * IP MVE files so that you can get a good idea of the typical structure of
28 * such files. This demuxer is not the best example to use if you are trying
29 * to write your own as it uses a rather roundabout approach for splitting
30 * up and sending out the chunks.
35 /* debugging support: #define DEBUG_IPMOVIE as non-zero to see extremely
36 * verbose information about the demux process */
37 #define DEBUG_IPMOVIE 0
40 #define debug_ipmovie printf
42 static inline void debug_ipmovie(const char *format, ...) { }
46 #define LE_16(x) ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
47 #define LE_32(x) ((((uint8_t*)(x))[3] << 24) | \
48 (((uint8_t*)(x))[2] << 16) | \
49 (((uint8_t*)(x))[1] << 8) | \
52 #define IPMOVIE_SIGNATURE "Interplay MVE File\x1A\0"
53 #define IPMOVIE_SIGNATURE_SIZE 20
54 #define CHUNK_PREAMBLE_SIZE 4
55 #define OPCODE_PREAMBLE_SIZE 4
57 #define CHUNK_INIT_AUDIO 0x0000
58 #define CHUNK_AUDIO_ONLY 0x0001
59 #define CHUNK_INIT_VIDEO 0x0002
60 #define CHUNK_VIDEO 0x0003
61 #define CHUNK_SHUTDOWN 0x0004
62 #define CHUNK_END 0x0005
63 /* these last types are used internally */
64 #define CHUNK_DONE 0xFFFC
65 #define CHUNK_NOMEM 0xFFFD
66 #define CHUNK_EOF 0xFFFE
67 #define CHUNK_BAD 0xFFFF
69 #define OPCODE_END_OF_STREAM 0x00
70 #define OPCODE_END_OF_CHUNK 0x01
71 #define OPCODE_CREATE_TIMER 0x02
72 #define OPCODE_INIT_AUDIO_BUFFERS 0x03
73 #define OPCODE_START_STOP_AUDIO 0x04
74 #define OPCODE_INIT_VIDEO_BUFFERS 0x05
75 #define OPCODE_UNKNOWN_06 0x06
76 #define OPCODE_SEND_BUFFER 0x07
77 #define OPCODE_AUDIO_FRAME 0x08
78 #define OPCODE_SILENCE_FRAME 0x09
79 #define OPCODE_INIT_VIDEO_MODE 0x0A
80 #define OPCODE_CREATE_GRADIENT 0x0B
81 #define OPCODE_SET_PALETTE 0x0C
82 #define OPCODE_SET_PALETTE_COMPRESSED 0x0D
83 #define OPCODE_UNKNOWN_0E 0x0E
84 #define OPCODE_SET_DECODING_MAP 0x0F
85 #define OPCODE_UNKNOWN_10 0x10
86 #define OPCODE_VIDEO_DATA 0x11
87 #define OPCODE_UNKNOWN_12 0x12
88 #define OPCODE_UNKNOWN_13 0x13
89 #define OPCODE_UNKNOWN_14 0x14
90 #define OPCODE_UNKNOWN_15 0x15
92 #define PALETTE_COUNT 256
94 typedef struct IPMVEContext {
102 unsigned int video_width;
103 unsigned int video_height;
106 unsigned int audio_bits;
107 unsigned int audio_channels;
108 unsigned int audio_sample_rate;
109 unsigned int audio_type;
110 unsigned int audio_frame_count;
112 int video_stream_index;
113 int audio_stream_index;
115 offset_t audio_chunk_offset;
116 int audio_chunk_size;
117 offset_t video_chunk_offset;
118 int video_chunk_size;
119 offset_t decode_map_chunk_offset;
120 int decode_map_chunk_size;
122 offset_t next_chunk_offset;
124 AVPaletteControl palette_control;
128 static int load_ipmovie_packet(IPMVEContext *s, ByteIOContext *pb,
132 int64_t audio_pts = 0;
134 if (s->audio_chunk_offset) {
136 /* adjust for PCM audio by skipping chunk header */
137 if (s->audio_type != CODEC_ID_INTERPLAY_DPCM) {
138 s->audio_chunk_offset += 6;
139 s->audio_chunk_size -= 6;
142 url_fseek(pb, s->audio_chunk_offset, SEEK_SET);
143 s->audio_chunk_offset = 0;
145 /* figure out the audio pts */
147 audio_pts *= s->audio_frame_count;
148 audio_pts /= s->audio_sample_rate;
150 if (av_new_packet(pkt, s->audio_chunk_size))
153 pkt->stream_index = s->audio_stream_index;
154 pkt->pts = audio_pts;
155 if (get_buffer(pb, pkt->data, s->audio_chunk_size) !=
156 s->audio_chunk_size) {
161 /* audio frame maintenance */
162 if (s->audio_type != CODEC_ID_INTERPLAY_DPCM)
163 s->audio_frame_count +=
164 (s->audio_chunk_size / s->audio_channels / (s->audio_bits / 8));
166 s->audio_frame_count +=
167 (s->audio_chunk_size - 6) / s->audio_channels;
169 debug_ipmovie("sending audio frame with pts %lld (%d audio frames)\n",
170 audio_pts, s->audio_frame_count);
172 chunk_type = CHUNK_VIDEO;
174 } else if (s->decode_map_chunk_offset) {
176 /* send both the decode map and the video data together */
178 if (av_new_packet(pkt, s->decode_map_chunk_size + s->video_chunk_size))
181 url_fseek(pb, s->decode_map_chunk_offset, SEEK_SET);
182 s->decode_map_chunk_offset = 0;
184 if (get_buffer(pb, pkt->data, s->decode_map_chunk_size) !=
185 s->decode_map_chunk_size) {
190 url_fseek(pb, s->video_chunk_offset, SEEK_SET);
191 s->video_chunk_offset = 0;
193 if (get_buffer(pb, pkt->data + s->decode_map_chunk_size,
194 s->video_chunk_size) != s->video_chunk_size) {
199 pkt->stream_index = s->video_stream_index;
200 pkt->pts = s->video_pts;
202 debug_ipmovie("sending video frame with pts %lld\n",
205 s->video_pts += s->frame_pts_inc;
207 chunk_type = CHUNK_VIDEO;
211 url_fseek(pb, s->next_chunk_offset, SEEK_SET);
212 chunk_type = CHUNK_DONE;
219 /* This function loads and processes a single chunk in an IP movie file.
220 * It returns the type of chunk that was processed. */
221 static int process_ipmovie_chunk(IPMVEContext *s, ByteIOContext *pb,
224 unsigned char chunk_preamble[CHUNK_PREAMBLE_SIZE];
227 unsigned char opcode_preamble[OPCODE_PREAMBLE_SIZE];
228 unsigned char opcode_type;
229 unsigned char opcode_version;
231 unsigned char scratch[1024];
233 int first_color, last_color;
236 /* see if there are any pending packets */
237 chunk_type = load_ipmovie_packet(s, pb, pkt);
238 if ((chunk_type == CHUNK_VIDEO) && (chunk_type != CHUNK_DONE))
241 /* read the next chunk, wherever the file happens to be pointing */
244 if (get_buffer(pb, chunk_preamble, CHUNK_PREAMBLE_SIZE) !=
247 chunk_size = LE_16(&chunk_preamble[0]);
248 chunk_type = LE_16(&chunk_preamble[2]);
250 debug_ipmovie("chunk type 0x%04X, 0x%04X bytes: ", chunk_type, chunk_size);
252 switch (chunk_type) {
254 case CHUNK_INIT_AUDIO:
255 debug_ipmovie("initialize audio\n");
258 case CHUNK_AUDIO_ONLY:
259 debug_ipmovie("audio only\n");
262 case CHUNK_INIT_VIDEO:
263 debug_ipmovie("initialize video\n");
267 debug_ipmovie("video (and audio)\n");
271 debug_ipmovie("shutdown\n");
275 debug_ipmovie("end\n");
279 debug_ipmovie("invalid chunk\n");
280 chunk_type = CHUNK_BAD;
285 while ((chunk_size > 0) && (chunk_type != CHUNK_BAD)) {
287 /* read the next chunk, wherever the file happens to be pointing */
289 chunk_type = CHUNK_EOF;
292 if (get_buffer(pb, opcode_preamble, CHUNK_PREAMBLE_SIZE) !=
293 CHUNK_PREAMBLE_SIZE) {
294 chunk_type = CHUNK_BAD;
298 opcode_size = LE_16(&opcode_preamble[0]);
299 opcode_type = opcode_preamble[2];
300 opcode_version = opcode_preamble[3];
302 chunk_size -= OPCODE_PREAMBLE_SIZE;
303 chunk_size -= opcode_size;
304 if (chunk_size < 0) {
305 debug_ipmovie("chunk_size countdown just went negative\n");
306 chunk_type = CHUNK_BAD;
310 debug_ipmovie(" opcode type %02X, version %d, 0x%04X bytes: ",
311 opcode_type, opcode_version, opcode_size);
312 switch (opcode_type) {
314 case OPCODE_END_OF_STREAM:
315 debug_ipmovie("end of stream\n");
316 url_fseek(pb, opcode_size, SEEK_CUR);
319 case OPCODE_END_OF_CHUNK:
320 debug_ipmovie("end of chunk\n");
321 url_fseek(pb, opcode_size, SEEK_CUR);
324 case OPCODE_CREATE_TIMER:
325 debug_ipmovie("create timer\n");
326 if ((opcode_version > 0) || (opcode_size > 6)) {
327 debug_ipmovie("bad create_timer opcode\n");
328 chunk_type = CHUNK_BAD;
331 if (get_buffer(pb, scratch, opcode_size) !=
333 chunk_type = CHUNK_BAD;
336 s->fps = 1000000.0 / (LE_32(&scratch[0]) * LE_16(&scratch[4]));
337 s->frame_pts_inc = 90000 / s->fps;
338 debug_ipmovie(" %.2f frames/second (timer div = %d, subdiv = %d)\n",
339 s->fps, LE_32(&scratch[0]), LE_16(&scratch[4]));
342 case OPCODE_INIT_AUDIO_BUFFERS:
343 debug_ipmovie("initialize audio buffers\n");
344 if ((opcode_version > 1) || (opcode_size > 10)) {
345 debug_ipmovie("bad init_audio_buffers opcode\n");
346 chunk_type = CHUNK_BAD;
349 if (get_buffer(pb, scratch, opcode_size) !=
351 chunk_type = CHUNK_BAD;
354 s->audio_sample_rate = LE_16(&scratch[4]);
355 audio_flags = LE_16(&scratch[2]);
356 /* bit 0 of the flags: 0 = mono, 1 = stereo */
357 s->audio_channels = (audio_flags & 1) + 1;
358 /* bit 1 of the flags: 0 = 8 bit, 1 = 16 bit */
359 s->audio_bits = (((audio_flags >> 1) & 1) + 1) * 8;
360 /* bit 2 indicates compressed audio in version 1 opcode */
361 if ((opcode_version == 1) && (audio_flags & 0x4))
362 s->audio_type = CODEC_ID_INTERPLAY_DPCM;
363 else if (s->audio_bits == 16)
364 s->audio_type = CODEC_ID_PCM_S16LE;
366 s->audio_type = CODEC_ID_PCM_U8;
367 debug_ipmovie("audio: %d bits, %d Hz, %s, %s format\n",
369 s->audio_sample_rate,
370 (s->audio_channels == 2) ? "stereo" : "mono",
371 (s->audio_type == CODEC_ID_INTERPLAY_DPCM) ?
372 "Interplay audio" : "PCM");
375 case OPCODE_START_STOP_AUDIO:
376 debug_ipmovie("start/stop audio\n");
377 url_fseek(pb, opcode_size, SEEK_CUR);
380 case OPCODE_INIT_VIDEO_BUFFERS:
381 debug_ipmovie("initialize video buffers\n");
382 if ((opcode_version > 2) || (opcode_size > 8)) {
383 debug_ipmovie("bad init_video_buffers opcode\n");
384 chunk_type = CHUNK_BAD;
387 if (get_buffer(pb, scratch, opcode_size) !=
389 chunk_type = CHUNK_BAD;
392 s->video_width = LE_16(&scratch[0]) * 8;
393 s->video_height = LE_16(&scratch[2]) * 8;
394 debug_ipmovie("video resolution: %d x %d\n",
395 s->video_width, s->video_height);
398 case OPCODE_UNKNOWN_06:
399 case OPCODE_UNKNOWN_0E:
400 case OPCODE_UNKNOWN_10:
401 case OPCODE_UNKNOWN_12:
402 case OPCODE_UNKNOWN_13:
403 case OPCODE_UNKNOWN_14:
404 case OPCODE_UNKNOWN_15:
405 debug_ipmovie("unknown (but documented) opcode %02X\n", opcode_type);
406 url_fseek(pb, opcode_size, SEEK_CUR);
409 case OPCODE_SEND_BUFFER:
410 debug_ipmovie("send buffer\n");
411 url_fseek(pb, opcode_size, SEEK_CUR);
414 case OPCODE_AUDIO_FRAME:
415 debug_ipmovie("audio frame\n");
417 /* log position and move on for now */
418 s->audio_chunk_offset = url_ftell(pb);
419 s->audio_chunk_size = opcode_size;
420 url_fseek(pb, opcode_size, SEEK_CUR);
423 case OPCODE_SILENCE_FRAME:
424 debug_ipmovie("silence frame\n");
425 url_fseek(pb, opcode_size, SEEK_CUR);
428 case OPCODE_INIT_VIDEO_MODE:
429 debug_ipmovie("initialize video mode\n");
430 url_fseek(pb, opcode_size, SEEK_CUR);
433 case OPCODE_CREATE_GRADIENT:
434 debug_ipmovie("create gradient\n");
435 url_fseek(pb, opcode_size, SEEK_CUR);
438 case OPCODE_SET_PALETTE:
439 debug_ipmovie("set palette\n");
440 /* check for the logical maximum palette size
441 * (3 * 256 + 4 bytes) */
442 if (opcode_size > 0x304) {
443 debug_ipmovie("demux_ipmovie: set_palette opcode too large\n");
444 chunk_type = CHUNK_BAD;
447 if (get_buffer(pb, scratch, opcode_size) != opcode_size) {
448 chunk_type = CHUNK_BAD;
452 /* load the palette into internal data structure */
453 first_color = LE_16(&scratch[0]);
454 last_color = first_color + LE_16(&scratch[2]);
455 /* sanity check (since they are 16 bit values) */
456 if ((first_color > 0xFF) || (last_color > 0xFF)) {
457 debug_ipmovie("demux_ipmovie: set_palette indices out of range (%d -> %d)\n",
458 first_color, last_color);
459 chunk_type = CHUNK_BAD;
462 j = 4; /* offset of first palette data */
463 for (i = first_color; i <= last_color; i++) {
464 /* the palette is stored as a 6-bit VGA palette, thus each
465 * component is shifted up to a 8-bit range */
466 s->palette_control.palette[i * 3 + 0] = scratch[j++] * 4;
467 s->palette_control.palette[i * 3 + 1] = scratch[j++] * 4;
468 s->palette_control.palette[i * 3 + 2] = scratch[j++] * 4;
470 /* indicate a palette change */
471 s->palette_control.palette_changed = 1;
474 case OPCODE_SET_PALETTE_COMPRESSED:
475 debug_ipmovie("set palette compressed\n");
476 url_fseek(pb, opcode_size, SEEK_CUR);
479 case OPCODE_SET_DECODING_MAP:
480 debug_ipmovie("set decoding map\n");
482 /* log position and move on for now */
483 s->decode_map_chunk_offset = url_ftell(pb);
484 s->decode_map_chunk_size = opcode_size;
485 url_fseek(pb, opcode_size, SEEK_CUR);
488 case OPCODE_VIDEO_DATA:
489 debug_ipmovie("set video data\n");
491 /* log position and move on for now */
492 s->video_chunk_offset = url_ftell(pb);
493 s->video_chunk_size = opcode_size;
494 url_fseek(pb, opcode_size, SEEK_CUR);
498 debug_ipmovie("*** unknown opcode type\n");
499 chunk_type = CHUNK_BAD;
505 /* make a note of where the stream is sitting */
506 s->next_chunk_offset = url_ftell(pb);
508 /* dispatch the first of any pending packets */
509 if ((chunk_type == CHUNK_VIDEO) || (chunk_type == CHUNK_AUDIO_ONLY))
510 chunk_type = load_ipmovie_packet(s, pb, pkt);
515 static int ipmovie_probe(AVProbeData *p)
517 if (p->buf_size < IPMOVIE_SIGNATURE_SIZE)
519 if (strncmp(p->buf, IPMOVIE_SIGNATURE, IPMOVIE_SIGNATURE_SIZE) != 0)
522 return AVPROBE_SCORE_MAX;
525 static int ipmovie_read_header(AVFormatContext *s,
526 AVFormatParameters *ap)
528 IPMVEContext *ipmovie = (IPMVEContext *)s->priv_data;
529 ByteIOContext *pb = &s->pb;
532 unsigned char chunk_preamble[CHUNK_PREAMBLE_SIZE];
535 /* initialize private context members */
536 ipmovie->video_pts = ipmovie->audio_frame_count = 0;
537 ipmovie->audio_chunk_offset = ipmovie->video_chunk_offset =
538 ipmovie->decode_map_chunk_offset = 0;
540 /* on the first read, this will position the stream at the first chunk */
541 ipmovie->next_chunk_offset = IPMOVIE_SIGNATURE_SIZE + 6;
543 /* process the first chunk which should be CHUNK_INIT_VIDEO */
544 if (process_ipmovie_chunk(ipmovie, pb, &pkt) != CHUNK_INIT_VIDEO)
545 return AVERROR_INVALIDDATA;
547 /* peek ahead to the next chunk-- if it is an init audio chunk, process
548 * it; if it is the first video chunk, this is a silent file */
549 if (get_buffer(pb, chunk_preamble, CHUNK_PREAMBLE_SIZE) !=
552 chunk_type = LE_16(&chunk_preamble[2]);
553 url_fseek(pb, -CHUNK_PREAMBLE_SIZE, SEEK_CUR);
555 if (chunk_type == CHUNK_VIDEO)
556 ipmovie->audio_type = 0; /* no audio */
557 else if (process_ipmovie_chunk(ipmovie, pb, &pkt) != CHUNK_INIT_AUDIO)
558 return AVERROR_INVALIDDATA;
560 /* set the pts reference (1 pts = 1/90000) */
564 /* initialize the stream decoders */
565 st = av_new_stream(s, 0);
567 return AVERROR_NOMEM;
568 ipmovie->video_stream_index = st->index;
569 st->codec.codec_type = CODEC_TYPE_VIDEO;
570 st->codec.codec_id = CODEC_ID_INTERPLAY_VIDEO;
571 st->codec.codec_tag = 0; /* no fourcc */
572 st->codec.width = ipmovie->video_width;
573 st->codec.height = ipmovie->video_height;
575 /* palette considerations */
576 st->codec.extradata_size = sizeof(AVPaletteControl);
577 st->codec.extradata = &ipmovie->palette_control;
579 if (ipmovie->audio_type) {
580 st = av_new_stream(s, 0);
582 return AVERROR_NOMEM;
583 ipmovie->audio_stream_index = st->index;
584 st->codec.codec_type = CODEC_TYPE_AUDIO;
585 st->codec.codec_id = ipmovie->audio_type;
586 st->codec.codec_tag = 0; /* no tag */
587 st->codec.channels = ipmovie->audio_channels;
588 st->codec.sample_rate = ipmovie->audio_sample_rate;
589 st->codec.bits_per_sample = ipmovie->audio_bits;
590 st->codec.bit_rate = st->codec.channels * st->codec.sample_rate *
591 st->codec.bits_per_sample;
592 if (st->codec.codec_id == CODEC_ID_INTERPLAY_DPCM)
593 st->codec.bit_rate /= 2;
594 st->codec.block_align = st->codec.channels * st->codec.bits_per_sample;
600 static int ipmovie_read_packet(AVFormatContext *s,
603 IPMVEContext *ipmovie = (IPMVEContext *)s->priv_data;
604 ByteIOContext *pb = &s->pb;
607 ret = process_ipmovie_chunk(ipmovie, pb, pkt);
608 if (ret == CHUNK_BAD)
609 ret = AVERROR_INVALIDDATA;
610 else if (ret == CHUNK_EOF)
612 else if (ret == CHUNK_NOMEM)
620 static int ipmovie_read_close(AVFormatContext *s)
622 // IPMVEContext *ipmovie = (IPMVEContext *)s->priv_data;
627 static AVInputFormat ipmovie_iformat = {
629 "Interplay MVE format",
630 sizeof(IPMVEContext),
637 int ipmovie_init(void)
639 av_register_input_format(&ipmovie_iformat);