wc3movie.c
Go to the documentation of this file.
1 /*
2  * Wing Commander III Movie (.mve) File Demuxer
3  * Copyright (c) 2003 The ffmpeg Project
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 
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/dict.h"
32 #include "avformat.h"
33 #include "internal.h"
34 
35 #define FORM_TAG MKTAG('F', 'O', 'R', 'M')
36 #define MOVE_TAG MKTAG('M', 'O', 'V', 'E')
37 #define PC__TAG MKTAG('_', 'P', 'C', '_')
38 #define SOND_TAG MKTAG('S', 'O', 'N', 'D')
39 #define BNAM_TAG MKTAG('B', 'N', 'A', 'M')
40 #define SIZE_TAG MKTAG('S', 'I', 'Z', 'E')
41 #define PALT_TAG MKTAG('P', 'A', 'L', 'T')
42 #define INDX_TAG MKTAG('I', 'N', 'D', 'X')
43 #define BRCH_TAG MKTAG('B', 'R', 'C', 'H')
44 #define SHOT_TAG MKTAG('S', 'H', 'O', 'T')
45 #define VGA__TAG MKTAG('V', 'G', 'A', ' ')
46 #define TEXT_TAG MKTAG('T', 'E', 'X', 'T')
47 #define AUDI_TAG MKTAG('A', 'U', 'D', 'I')
48 
49 /* video resolution unless otherwise specified */
50 #define WC3_DEFAULT_WIDTH 320
51 #define WC3_DEFAULT_HEIGHT 165
52 
53 /* always use the same PCM audio parameters */
54 #define WC3_SAMPLE_RATE 22050
55 #define WC3_AUDIO_CHANNELS 1
56 #define WC3_AUDIO_BITS 16
57 
58 /* nice, constant framerate */
59 #define WC3_FRAME_FPS 15
60 
61 #define PALETTE_SIZE (256 * 3)
62 
63 typedef struct Wc3DemuxContext {
64  int width;
65  int height;
66  int64_t pts;
69 
71 
73 
74 static int wc3_probe(AVProbeData *p)
75 {
76  if (p->buf_size < 12)
77  return 0;
78 
79  if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
80  (AV_RL32(&p->buf[8]) != MOVE_TAG))
81  return 0;
82 
83  return AVPROBE_SCORE_MAX;
84 }
85 
88 {
89  Wc3DemuxContext *wc3 = s->priv_data;
90  AVIOContext *pb = s->pb;
91  unsigned int fourcc_tag;
92  unsigned int size;
93  AVStream *st;
94  int ret = 0;
95  char *buffer;
96 
97  /* default context members */
98  wc3->width = WC3_DEFAULT_WIDTH;
100  wc3->pts = 0;
101  wc3->video_stream_index = wc3->audio_stream_index = 0;
102  av_init_packet(&wc3->vpkt);
103  wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
104 
105  /* skip the first 3 32-bit numbers */
106  avio_skip(pb, 12);
107 
108  /* traverse through the chunks and load the header information before
109  * the first BRCH tag */
110  fourcc_tag = avio_rl32(pb);
111  size = (avio_rb32(pb) + 1) & (~1);
112 
113  do {
114  switch (fourcc_tag) {
115 
116  case SOND_TAG:
117  case INDX_TAG:
118  /* SOND unknown, INDX unnecessary; ignore both */
119  avio_skip(pb, size);
120  break;
121 
122  case PC__TAG:
123  /* number of palettes, unneeded */
124  avio_skip(pb, 12);
125  break;
126 
127  case BNAM_TAG:
128  /* load up the name */
129  buffer = av_malloc(size+1);
130  if (!buffer)
131  return AVERROR(ENOMEM);
132  if ((ret = avio_read(pb, buffer, size)) != size)
133  return AVERROR(EIO);
134  buffer[size] = 0;
135  av_dict_set(&s->metadata, "title", buffer,
137  break;
138 
139  case SIZE_TAG:
140  /* video resolution override */
141  wc3->width = avio_rl32(pb);
142  wc3->height = avio_rl32(pb);
143  break;
144 
145  case PALT_TAG:
146  /* one of several palettes */
147  avio_seek(pb, -8, SEEK_CUR);
148  av_append_packet(pb, &wc3->vpkt, 8 + PALETTE_SIZE);
149  break;
150 
151  default:
152  av_log(s, AV_LOG_ERROR, " unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
153  (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
154  (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
155  return AVERROR_INVALIDDATA;
156  }
157 
158  fourcc_tag = avio_rl32(pb);
159  /* chunk sizes are 16-bit aligned */
160  size = (avio_rb32(pb) + 1) & (~1);
161  if (pb->eof_reached)
162  return AVERROR(EIO);
163 
164  } while (fourcc_tag != BRCH_TAG);
165 
166  /* initialize the decoder streams */
167  st = avformat_new_stream(s, NULL);
168  if (!st)
169  return AVERROR(ENOMEM);
171  wc3->video_stream_index = st->index;
174  st->codec->codec_tag = 0; /* no fourcc */
175  st->codec->width = wc3->width;
176  st->codec->height = wc3->height;
177 
178  st = avformat_new_stream(s, NULL);
179  if (!st)
180  return AVERROR(ENOMEM);
182  wc3->audio_stream_index = st->index;
185  st->codec->codec_tag = 1;
189  st->codec->bit_rate = st->codec->channels * st->codec->sample_rate *
192 
193  return 0;
194 }
195 
197  AVPacket *pkt)
198 {
199  Wc3DemuxContext *wc3 = s->priv_data;
200  AVIOContext *pb = s->pb;
201  unsigned int fourcc_tag;
202  unsigned int size;
203  int packet_read = 0;
204  int ret = 0;
205  unsigned char text[1024];
206 
207  while (!packet_read) {
208 
209  fourcc_tag = avio_rl32(pb);
210  /* chunk sizes are 16-bit aligned */
211  size = (avio_rb32(pb) + 1) & (~1);
212  if (pb->eof_reached)
213  return AVERROR(EIO);
214 
215  switch (fourcc_tag) {
216 
217  case BRCH_TAG:
218  /* no-op */
219  break;
220 
221  case SHOT_TAG:
222  /* load up new palette */
223  avio_seek(pb, -8, SEEK_CUR);
224  av_append_packet(pb, &wc3->vpkt, 8 + 4);
225  break;
226 
227  case VGA__TAG:
228  /* send out video chunk */
229  avio_seek(pb, -8, SEEK_CUR);
230  ret= av_append_packet(pb, &wc3->vpkt, 8 + size);
231  // ignore error if we have some data
232  if (wc3->vpkt.size > 0)
233  ret = 0;
234  *pkt = wc3->vpkt;
235  wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
236  pkt->stream_index = wc3->video_stream_index;
237  pkt->pts = wc3->pts;
238  packet_read = 1;
239  break;
240 
241  case TEXT_TAG:
242  /* subtitle chunk */
243 #if 0
244  avio_skip(pb, size);
245 #else
246  if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
247  ret = AVERROR(EIO);
248  else {
249  int i = 0;
250  av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
251  av_log (s, AV_LOG_DEBUG, " inglish: %s\n", &text[i + 1]);
252  i += text[i] + 1;
253  av_log (s, AV_LOG_DEBUG, " doytsch: %s\n", &text[i + 1]);
254  i += text[i] + 1;
255  av_log (s, AV_LOG_DEBUG, " fronsay: %s\n", &text[i + 1]);
256  }
257 #endif
258  break;
259 
260  case AUDI_TAG:
261  /* send out audio chunk */
262  ret= av_get_packet(pb, pkt, size);
263  pkt->stream_index = wc3->audio_stream_index;
264  pkt->pts = wc3->pts;
265 
266  /* time to advance pts */
267  wc3->pts++;
268 
269  packet_read = 1;
270  break;
271 
272  default:
273  av_log (s, AV_LOG_ERROR, " unrecognized WC3 chunk: %c%c%c%c (0x%02X%02X%02X%02X)\n",
274  (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24),
275  (uint8_t)fourcc_tag, (uint8_t)(fourcc_tag >> 8), (uint8_t)(fourcc_tag >> 16), (uint8_t)(fourcc_tag >> 24));
276  ret = AVERROR_INVALIDDATA;
277  packet_read = 1;
278  break;
279  }
280  }
281 
282  return ret;
283 }
284 
286 {
287  Wc3DemuxContext *wc3 = s->priv_data;
288 
289  if (wc3->vpkt.size > 0)
290  av_free_packet(&wc3->vpkt);
291 
292  return 0;
293 }
294 
296  .name = "wc3movie",
297  .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III movie format"),
298  .priv_data_size = sizeof(Wc3DemuxContext),
303 };
Bytestream IO Context.
Definition: avio.h:68
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:54
#define WC3_AUDIO_BITS
Definition: wc3movie.c:56
#define BRCH_TAG
Definition: wc3movie.c:43
int size
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the pts for a given stream.
Definition: utils.c:3828
struct Wc3DemuxContext Wc3DemuxContext
int index
stream index in AVFormatContext
Definition: avformat.h:621
int size
Definition: avcodec.h:909
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:211
#define SIZE_TAG
Definition: wc3movie.c:40
#define WC3_DEFAULT_HEIGHT
Definition: wc3movie.c:51
#define INDX_TAG
Definition: wc3movie.c:42
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:1751
int video_stream_index
Definition: wc3movie.c:67
Format I/O context.
Definition: avformat.h:863
static int wc3_read_header(AVFormatContext *s, AVFormatParameters *ap)
Definition: wc3movie.c:86
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:46
Public dictionary API.
int64_t pts
Definition: wc3movie.c:66
#define SHOT_TAG
Definition: wc3movie.c:44
#define TEXT_TAG
Definition: wc3movie.c:46
#define SOND_TAG
Definition: wc3movie.c:38
static int wc3_read_close(AVFormatContext *s)
Definition: wc3movie.c:285
unsigned int avio_rb32(AVIOContext *s)
Definition: aviobuf.c:769
AVInputFormat ff_wc3_demuxer
Definition: wc3movie.c:295
static int read_header(FFV1Context *f)
Definition: ffv1.c:1513
uint8_t * data
Definition: avcodec.h:908
void av_free_packet(AVPacket *pkt)
Free a packet.
Definition: avpacket.c:151
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:140
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:269
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1974
#define BNAM_TAG
Definition: wc3movie.c:39
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:652
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size)
Read data and append it to the current content of the AVPacket.
Definition: utils.c:287
#define PALT_TAG
Definition: wc3movie.c:41
AVDictionary * metadata
Definition: avformat.h:1085
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:738
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:191
#define AUDI_TAG
Definition: wc3movie.c:47
AV_RL32
Definition: bytestream.h:89
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:140
AVStream * avformat_new_stream(AVFormatContext *s, AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:2776
AVCodecContext * codec
codec context
Definition: avformat.h:623
#define WC3_DEFAULT_WIDTH
Definition: wc3movie.c:50
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:342
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:341
int bit_rate
the average bitrate
Definition: avcodec.h:1340
#define AV_DICT_DONT_STRDUP_VAL
Take ownership of a value that's been allocated with av_malloc() and chilren.
Definition: dict.h:66
int width
picture width / height.
Definition: avcodec.h:1408
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: avio.h:483
static int read_probe(AVProbeData *p)
Definition: img2.c:185
static char buffer[20]
Definition: seek-test.c:34
Stream structure.
Definition: avformat.h:620
NULL
Definition: eval.c:50
enum AVMediaType codec_type
Definition: avcodec.h:1574
int sample_rate
samples per second
Definition: avcodec.h:1456
AVIOContext * pb
Definition: avformat.h:896
int audio_stream_index
Definition: wc3movie.c:68
#define PALETTE_SIZE
Definition: wc3movie.c:61
#define PC__TAG
Definition: wc3movie.c:37
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:111
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition: avcodec.h:1590
static int wc3_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wc3movie.c:196
#define WC3_FRAME_FPS
Definition: wc3movie.c:59
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:109
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:50
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:64
#define FORM_TAG
Definition: wc3movie.c:35
This structure contains the data a format has to probe a file.
Definition: avformat.h:339
#define WC3_AUDIO_CHANNELS
Definition: wc3movie.c:55
#define AVPROBE_SCORE_MAX
maximum score, half of that is used for file-extension-based detection
Definition: avformat.h:345
Main libavformat public API header.
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:125
#define WC3_SAMPLE_RATE
Definition: wc3movie.c:54
static int wc3_probe(AVProbeData *p)
Definition: wc3movie.c:74
AVPacket vpkt
Definition: wc3movie.c:70
int eof_reached
true if eof reached
Definition: avio.h:98
int channels
number of audio channels
Definition: avcodec.h:1457
void * priv_data
Format private data.
Definition: avformat.h:883
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:460
#define VGA__TAG
Definition: wc3movie.c:45
int stream_index
Definition: avcodec.h:910
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:901
#define MOVE_TAG
Definition: wc3movie.c:36
enum CodecID codec_id
Definition: avcodec.h:1575