2 * Interplay MVE File Demuxer
3 * Copyright (c) 2003 The ffmpeg Project
5 * This file is part of FFmpeg.
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.
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.
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
24 * Interplay MVE file demuxer
25 * by Mike Melanson (melanson@pcisys.net)
26 * For more information regarding the Interplay MVE file format, visit:
27 * http://www.pcisys.net/~melanson/codecs/
28 * The aforementioned site also contains a command line utility for parsing
29 * IP MVE files so that you can get a good idea of the typical structure of
30 * such files. This demuxer is not the best example to use if you are trying
31 * to write your own as it uses a rather roundabout approach for splitting
32 * up and sending out the chunks.
35 #include "libavutil/intreadwrite.h"
39 #define CHUNK_PREAMBLE_SIZE 4
40 #define OPCODE_PREAMBLE_SIZE 4
42 #define CHUNK_INIT_AUDIO 0x0000
43 #define CHUNK_AUDIO_ONLY 0x0001
44 #define CHUNK_INIT_VIDEO 0x0002
45 #define CHUNK_VIDEO 0x0003
46 #define CHUNK_SHUTDOWN 0x0004
47 #define CHUNK_END 0x0005
48 /* these last types are used internally */
49 #define CHUNK_DONE 0xFFFC
50 #define CHUNK_NOMEM 0xFFFD
51 #define CHUNK_EOF 0xFFFE
52 #define CHUNK_BAD 0xFFFF
54 #define OPCODE_END_OF_STREAM 0x00
55 #define OPCODE_END_OF_CHUNK 0x01
56 #define OPCODE_CREATE_TIMER 0x02
57 #define OPCODE_INIT_AUDIO_BUFFERS 0x03
58 #define OPCODE_START_STOP_AUDIO 0x04
59 #define OPCODE_INIT_VIDEO_BUFFERS 0x05
60 #define OPCODE_UNKNOWN_06 0x06
61 #define OPCODE_SEND_BUFFER 0x07
62 #define OPCODE_AUDIO_FRAME 0x08
63 #define OPCODE_SILENCE_FRAME 0x09
64 #define OPCODE_INIT_VIDEO_MODE 0x0A
65 #define OPCODE_CREATE_GRADIENT 0x0B
66 #define OPCODE_SET_PALETTE 0x0C
67 #define OPCODE_SET_PALETTE_COMPRESSED 0x0D
68 #define OPCODE_UNKNOWN_0E 0x0E
69 #define OPCODE_SET_DECODING_MAP 0x0F
70 #define OPCODE_UNKNOWN_10 0x10
71 #define OPCODE_VIDEO_DATA 0x11
72 #define OPCODE_UNKNOWN_12 0x12
73 #define OPCODE_UNKNOWN_13 0x13
74 #define OPCODE_UNKNOWN_14 0x14
75 #define OPCODE_UNKNOWN_15 0x15
77 #define PALETTE_COUNT 256
79 typedef struct IPMVEContext {
84 uint64_t frame_pts_inc;
86 unsigned int video_bpp;
87 unsigned int video_width;
88 unsigned int video_height;
90 uint32_t palette[256];
93 unsigned int audio_bits;
94 unsigned int audio_channels;
95 unsigned int audio_sample_rate;
96 enum CodecID audio_type;
97 unsigned int audio_frame_count;
99 int video_stream_index;
100 int audio_stream_index;
102 int64_t audio_chunk_offset;
103 int audio_chunk_size;
104 int64_t video_chunk_offset;
105 int video_chunk_size;
106 int64_t decode_map_chunk_offset;
107 int decode_map_chunk_size;
109 int64_t next_chunk_offset;
113 static int load_ipmovie_packet(IPMVEContext *s, AVIOContext *pb,
118 if (s->audio_chunk_offset && s->audio_channels && s->audio_bits) {
119 if (s->audio_type == CODEC_ID_NONE) {
120 av_log(NULL, AV_LOG_ERROR, "Can not read audio packet before"
121 "audio codec is known\n");
125 /* adjust for PCM audio by skipping chunk header */
126 if (s->audio_type != CODEC_ID_INTERPLAY_DPCM) {
127 s->audio_chunk_offset += 6;
128 s->audio_chunk_size -= 6;
131 avio_seek(pb, s->audio_chunk_offset, SEEK_SET);
132 s->audio_chunk_offset = 0;
134 if (s->audio_chunk_size != av_get_packet(pb, pkt, s->audio_chunk_size))
137 pkt->stream_index = s->audio_stream_index;
138 pkt->pts = s->audio_frame_count;
140 /* audio frame maintenance */
141 if (s->audio_type != CODEC_ID_INTERPLAY_DPCM)
142 s->audio_frame_count +=
143 (s->audio_chunk_size / s->audio_channels / (s->audio_bits / 8));
145 s->audio_frame_count +=
146 (s->audio_chunk_size - 6) / s->audio_channels;
148 av_dlog(NULL, "sending audio frame with pts %"PRId64" (%d audio frames)\n",
149 pkt->pts, s->audio_frame_count);
151 chunk_type = CHUNK_VIDEO;
153 } else if (s->decode_map_chunk_offset) {
155 /* send both the decode map and the video data together */
157 if (av_new_packet(pkt, s->decode_map_chunk_size + s->video_chunk_size))
160 if (s->has_palette) {
163 pal = av_packet_new_side_data(pkt, AV_PKT_DATA_PALETTE,
166 memcpy(pal, s->palette, AVPALETTE_SIZE);
171 pkt->pos= s->decode_map_chunk_offset;
172 avio_seek(pb, s->decode_map_chunk_offset, SEEK_SET);
173 s->decode_map_chunk_offset = 0;
175 if (avio_read(pb, pkt->data, s->decode_map_chunk_size) !=
176 s->decode_map_chunk_size) {
181 avio_seek(pb, s->video_chunk_offset, SEEK_SET);
182 s->video_chunk_offset = 0;
184 if (avio_read(pb, pkt->data + s->decode_map_chunk_size,
185 s->video_chunk_size) != s->video_chunk_size) {
190 pkt->stream_index = s->video_stream_index;
191 pkt->pts = s->video_pts;
193 av_dlog(NULL, "sending video frame with pts %"PRId64"\n", pkt->pts);
195 s->video_pts += s->frame_pts_inc;
197 chunk_type = CHUNK_VIDEO;
201 avio_seek(pb, s->next_chunk_offset, SEEK_SET);
202 chunk_type = CHUNK_DONE;
209 /* This function loads and processes a single chunk in an IP movie file.
210 * It returns the type of chunk that was processed. */
211 static int process_ipmovie_chunk(IPMVEContext *s, AVIOContext *pb,
214 unsigned char chunk_preamble[CHUNK_PREAMBLE_SIZE];
217 unsigned char opcode_preamble[OPCODE_PREAMBLE_SIZE];
218 unsigned char opcode_type;
219 unsigned char opcode_version;
221 unsigned char scratch[1024];
223 int first_color, last_color;
225 unsigned char r, g, b;
227 /* see if there are any pending packets */
228 chunk_type = load_ipmovie_packet(s, pb, pkt);
229 if (chunk_type != CHUNK_DONE)
232 /* read the next chunk, wherever the file happens to be pointing */
235 if (avio_read(pb, chunk_preamble, CHUNK_PREAMBLE_SIZE) !=
238 chunk_size = AV_RL16(&chunk_preamble[0]);
239 chunk_type = AV_RL16(&chunk_preamble[2]);
241 av_dlog(NULL, "chunk type 0x%04X, 0x%04X bytes: ", chunk_type, chunk_size);
243 switch (chunk_type) {
245 case CHUNK_INIT_AUDIO:
246 av_dlog(NULL, "initialize audio\n");
249 case CHUNK_AUDIO_ONLY:
250 av_dlog(NULL, "audio only\n");
253 case CHUNK_INIT_VIDEO:
254 av_dlog(NULL, "initialize video\n");
258 av_dlog(NULL, "video (and audio)\n");
262 av_dlog(NULL, "shutdown\n");
266 av_dlog(NULL, "end\n");
270 av_dlog(NULL, "invalid chunk\n");
271 chunk_type = CHUNK_BAD;
276 while ((chunk_size > 0) && (chunk_type != CHUNK_BAD)) {
278 /* read the next chunk, wherever the file happens to be pointing */
280 chunk_type = CHUNK_EOF;
283 if (avio_read(pb, opcode_preamble, CHUNK_PREAMBLE_SIZE) !=
284 CHUNK_PREAMBLE_SIZE) {
285 chunk_type = CHUNK_BAD;
289 opcode_size = AV_RL16(&opcode_preamble[0]);
290 opcode_type = opcode_preamble[2];
291 opcode_version = opcode_preamble[3];
293 chunk_size -= OPCODE_PREAMBLE_SIZE;
294 chunk_size -= opcode_size;
295 if (chunk_size < 0) {
296 av_dlog(NULL, "chunk_size countdown just went negative\n");
297 chunk_type = CHUNK_BAD;
301 av_dlog(NULL, " opcode type %02X, version %d, 0x%04X bytes: ",
302 opcode_type, opcode_version, opcode_size);
303 switch (opcode_type) {
305 case OPCODE_END_OF_STREAM:
306 av_dlog(NULL, "end of stream\n");
307 avio_skip(pb, opcode_size);
310 case OPCODE_END_OF_CHUNK:
311 av_dlog(NULL, "end of chunk\n");
312 avio_skip(pb, opcode_size);
315 case OPCODE_CREATE_TIMER:
316 av_dlog(NULL, "create timer\n");
317 if ((opcode_version > 0) || (opcode_size > 6)) {
318 av_dlog(NULL, "bad create_timer opcode\n");
319 chunk_type = CHUNK_BAD;
322 if (avio_read(pb, scratch, opcode_size) !=
324 chunk_type = CHUNK_BAD;
327 s->frame_pts_inc = ((uint64_t)AV_RL32(&scratch[0])) * AV_RL16(&scratch[4]);
328 av_dlog(NULL, " %.2f frames/second (timer div = %d, subdiv = %d)\n",
329 1000000.0 / s->frame_pts_inc, AV_RL32(&scratch[0]),
330 AV_RL16(&scratch[4]));
333 case OPCODE_INIT_AUDIO_BUFFERS:
334 av_dlog(NULL, "initialize audio buffers\n");
335 if ((opcode_version > 1) || (opcode_size > 10)) {
336 av_dlog(NULL, "bad init_audio_buffers opcode\n");
337 chunk_type = CHUNK_BAD;
340 if (avio_read(pb, scratch, opcode_size) !=
342 chunk_type = CHUNK_BAD;
345 s->audio_sample_rate = AV_RL16(&scratch[4]);
346 audio_flags = AV_RL16(&scratch[2]);
347 /* bit 0 of the flags: 0 = mono, 1 = stereo */
348 s->audio_channels = (audio_flags & 1) + 1;
349 /* bit 1 of the flags: 0 = 8 bit, 1 = 16 bit */
350 s->audio_bits = (((audio_flags >> 1) & 1) + 1) * 8;
351 /* bit 2 indicates compressed audio in version 1 opcode */
352 if ((opcode_version == 1) && (audio_flags & 0x4))
353 s->audio_type = CODEC_ID_INTERPLAY_DPCM;
354 else if (s->audio_bits == 16)
355 s->audio_type = CODEC_ID_PCM_S16LE;
357 s->audio_type = CODEC_ID_PCM_U8;
358 av_dlog(NULL, "audio: %d bits, %d Hz, %s, %s format\n",
359 s->audio_bits, s->audio_sample_rate,
360 (s->audio_channels == 2) ? "stereo" : "mono",
361 (s->audio_type == CODEC_ID_INTERPLAY_DPCM) ?
362 "Interplay audio" : "PCM");
365 case OPCODE_START_STOP_AUDIO:
366 av_dlog(NULL, "start/stop audio\n");
367 avio_skip(pb, opcode_size);
370 case OPCODE_INIT_VIDEO_BUFFERS:
371 av_dlog(NULL, "initialize video buffers\n");
372 if ((opcode_version > 2) || (opcode_size > 8)) {
373 av_dlog(NULL, "bad init_video_buffers opcode\n");
374 chunk_type = CHUNK_BAD;
377 if (avio_read(pb, scratch, opcode_size) !=
379 chunk_type = CHUNK_BAD;
382 s->video_width = AV_RL16(&scratch[0]) * 8;
383 s->video_height = AV_RL16(&scratch[2]) * 8;
384 if (opcode_version < 2 || !AV_RL16(&scratch[6])) {
389 av_dlog(NULL, "video resolution: %d x %d\n",
390 s->video_width, s->video_height);
393 case OPCODE_UNKNOWN_06:
394 case OPCODE_UNKNOWN_0E:
395 case OPCODE_UNKNOWN_10:
396 case OPCODE_UNKNOWN_12:
397 case OPCODE_UNKNOWN_13:
398 case OPCODE_UNKNOWN_14:
399 case OPCODE_UNKNOWN_15:
400 av_dlog(NULL, "unknown (but documented) opcode %02X\n", opcode_type);
401 avio_skip(pb, opcode_size);
404 case OPCODE_SEND_BUFFER:
405 av_dlog(NULL, "send buffer\n");
406 avio_skip(pb, opcode_size);
409 case OPCODE_AUDIO_FRAME:
410 av_dlog(NULL, "audio frame\n");
412 /* log position and move on for now */
413 s->audio_chunk_offset = avio_tell(pb);
414 s->audio_chunk_size = opcode_size;
415 avio_skip(pb, opcode_size);
418 case OPCODE_SILENCE_FRAME:
419 av_dlog(NULL, "silence frame\n");
420 avio_skip(pb, opcode_size);
423 case OPCODE_INIT_VIDEO_MODE:
424 av_dlog(NULL, "initialize video mode\n");
425 avio_skip(pb, opcode_size);
428 case OPCODE_CREATE_GRADIENT:
429 av_dlog(NULL, "create gradient\n");
430 avio_skip(pb, opcode_size);
433 case OPCODE_SET_PALETTE:
434 av_dlog(NULL, "set palette\n");
435 /* check for the logical maximum palette size
436 * (3 * 256 + 4 bytes) */
437 if (opcode_size > 0x304) {
438 av_dlog(NULL, "demux_ipmovie: set_palette opcode too large\n");
439 chunk_type = CHUNK_BAD;
442 if (avio_read(pb, scratch, opcode_size) != opcode_size) {
443 chunk_type = CHUNK_BAD;
447 /* load the palette into internal data structure */
448 first_color = AV_RL16(&scratch[0]);
449 last_color = first_color + AV_RL16(&scratch[2]) - 1;
450 /* sanity check (since they are 16 bit values) */
451 if ((first_color > 0xFF) || (last_color > 0xFF)) {
452 av_dlog(NULL, "demux_ipmovie: set_palette indexes out of range (%d -> %d)\n",
453 first_color, last_color);
454 chunk_type = CHUNK_BAD;
457 j = 4; /* offset of first palette data */
458 for (i = first_color; i <= last_color; i++) {
459 /* the palette is stored as a 6-bit VGA palette, thus each
460 * component is shifted up to a 8-bit range */
461 r = scratch[j++] * 4;
462 g = scratch[j++] * 4;
463 b = scratch[j++] * 4;
464 s->palette[i] = (0xFFU << 24) | (r << 16) | (g << 8) | (b);
465 s->palette[i] |= s->palette[i] >> 6 & 0x30303;
470 case OPCODE_SET_PALETTE_COMPRESSED:
471 av_dlog(NULL, "set palette compressed\n");
472 avio_skip(pb, opcode_size);
475 case OPCODE_SET_DECODING_MAP:
476 av_dlog(NULL, "set decoding map\n");
478 /* log position and move on for now */
479 s->decode_map_chunk_offset = avio_tell(pb);
480 s->decode_map_chunk_size = opcode_size;
481 avio_skip(pb, opcode_size);
484 case OPCODE_VIDEO_DATA:
485 av_dlog(NULL, "set video data\n");
487 /* log position and move on for now */
488 s->video_chunk_offset = avio_tell(pb);
489 s->video_chunk_size = opcode_size;
490 avio_skip(pb, opcode_size);
494 av_dlog(NULL, "*** unknown opcode type\n");
495 chunk_type = CHUNK_BAD;
501 /* make a note of where the stream is sitting */
502 s->next_chunk_offset = avio_tell(pb);
504 /* dispatch the first of any pending packets */
505 if ((chunk_type == CHUNK_VIDEO) || (chunk_type == CHUNK_AUDIO_ONLY))
506 chunk_type = load_ipmovie_packet(s, pb, pkt);
511 static const char signature[] = "Interplay MVE File\x1A\0\x1A";
513 static int ipmovie_probe(AVProbeData *p)
516 uint8_t *b_end = p->buf + p->buf_size - sizeof(signature);
518 if (memcmp(b++, signature, sizeof(signature)) == 0)
519 return AVPROBE_SCORE_MAX;
525 static int ipmovie_read_header(AVFormatContext *s,
526 AVFormatParameters *ap)
528 IPMVEContext *ipmovie = s->priv_data;
529 AVIOContext *pb = s->pb;
532 unsigned char chunk_preamble[CHUNK_PREAMBLE_SIZE];
534 uint8_t signature_buffer[sizeof(signature)];
536 avio_read(pb, signature_buffer, sizeof(signature_buffer));
537 while (memcmp(signature_buffer, signature, sizeof(signature))) {
538 memmove(signature_buffer, signature_buffer + 1, sizeof(signature_buffer) - 1);
539 signature_buffer[sizeof(signature_buffer) - 1] = avio_r8(pb);
543 /* initialize private context members */
544 ipmovie->video_pts = ipmovie->audio_frame_count = 0;
545 ipmovie->audio_chunk_offset = ipmovie->video_chunk_offset =
546 ipmovie->decode_map_chunk_offset = 0;
548 /* on the first read, this will position the stream at the first chunk */
549 ipmovie->next_chunk_offset = avio_tell(pb) + 4;
551 for (i = 0; i < 256; i++)
552 ipmovie->palette[i] = 0xFFU << 24;
554 /* process the first chunk which should be CHUNK_INIT_VIDEO */
555 if (process_ipmovie_chunk(ipmovie, pb, &pkt) != CHUNK_INIT_VIDEO)
556 return AVERROR_INVALIDDATA;
558 /* peek ahead to the next chunk-- if it is an init audio chunk, process
559 * it; if it is the first video chunk, this is a silent file */
560 if (avio_read(pb, chunk_preamble, CHUNK_PREAMBLE_SIZE) !=
563 chunk_type = AV_RL16(&chunk_preamble[2]);
564 avio_seek(pb, -CHUNK_PREAMBLE_SIZE, SEEK_CUR);
566 if (chunk_type == CHUNK_VIDEO)
567 ipmovie->audio_type = CODEC_ID_NONE; /* no audio */
568 else if (process_ipmovie_chunk(ipmovie, pb, &pkt) != CHUNK_INIT_AUDIO)
569 return AVERROR_INVALIDDATA;
571 /* initialize the stream decoders */
572 st = avformat_new_stream(s, NULL);
574 return AVERROR(ENOMEM);
575 avpriv_set_pts_info(st, 63, 1, 1000000);
576 ipmovie->video_stream_index = st->index;
577 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
578 st->codec->codec_id = CODEC_ID_INTERPLAY_VIDEO;
579 st->codec->codec_tag = 0; /* no fourcc */
580 st->codec->width = ipmovie->video_width;
581 st->codec->height = ipmovie->video_height;
582 st->codec->bits_per_coded_sample = ipmovie->video_bpp;
584 if (ipmovie->audio_type) {
585 st = avformat_new_stream(s, NULL);
587 return AVERROR(ENOMEM);
588 avpriv_set_pts_info(st, 32, 1, ipmovie->audio_sample_rate);
589 ipmovie->audio_stream_index = st->index;
590 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
591 st->codec->codec_id = ipmovie->audio_type;
592 st->codec->codec_tag = 0; /* no tag */
593 st->codec->channels = ipmovie->audio_channels;
594 st->codec->sample_rate = ipmovie->audio_sample_rate;
595 st->codec->bits_per_coded_sample = ipmovie->audio_bits;
596 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
597 st->codec->bits_per_coded_sample;
598 if (st->codec->codec_id == CODEC_ID_INTERPLAY_DPCM)
599 st->codec->bit_rate /= 2;
600 st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
606 static int ipmovie_read_packet(AVFormatContext *s,
609 IPMVEContext *ipmovie = s->priv_data;
610 AVIOContext *pb = s->pb;
613 ret = process_ipmovie_chunk(ipmovie, pb, pkt);
614 if (ret == CHUNK_BAD)
615 ret = AVERROR_INVALIDDATA;
616 else if (ret == CHUNK_EOF)
618 else if (ret == CHUNK_NOMEM)
619 ret = AVERROR(ENOMEM);
620 else if (ret == CHUNK_VIDEO)
628 AVInputFormat ff_ipmovie_demuxer = {
630 .long_name = NULL_IF_CONFIG_SMALL("Interplay MVE format"),
631 .priv_data_size = sizeof(IPMVEContext),
632 .read_probe = ipmovie_probe,
633 .read_header = ipmovie_read_header,
634 .read_packet = ipmovie_read_packet,