FFmpeg  4.3
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 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  * Wing Commander III Movie file demuxer
25  * by Mike Melanson (melanson@pcisys.net)
26  * for more information on the WC3 .mve file format, visit:
27  * http://www.pcisys.net/~melanson/codecs/
28  */
29 
30 #include "libavutil/avstring.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/dict.h"
34 #include "avformat.h"
35 #include "internal.h"
36 
37 #define FORM_TAG MKTAG('F', 'O', 'R', 'M')
38 #define MOVE_TAG MKTAG('M', 'O', 'V', 'E')
39 #define PC__TAG MKTAG('_', 'P', 'C', '_')
40 #define SOND_TAG MKTAG('S', 'O', 'N', 'D')
41 #define BNAM_TAG MKTAG('B', 'N', 'A', 'M')
42 #define SIZE_TAG MKTAG('S', 'I', 'Z', 'E')
43 #define PALT_TAG MKTAG('P', 'A', 'L', 'T')
44 #define INDX_TAG MKTAG('I', 'N', 'D', 'X')
45 #define BRCH_TAG MKTAG('B', 'R', 'C', 'H')
46 #define SHOT_TAG MKTAG('S', 'H', 'O', 'T')
47 #define VGA__TAG MKTAG('V', 'G', 'A', ' ')
48 #define TEXT_TAG MKTAG('T', 'E', 'X', 'T')
49 #define AUDI_TAG MKTAG('A', 'U', 'D', 'I')
50 
51 /* video resolution unless otherwise specified */
52 #define WC3_DEFAULT_WIDTH 320
53 #define WC3_DEFAULT_HEIGHT 165
54 
55 /* always use the same PCM audio parameters */
56 #define WC3_SAMPLE_RATE 22050
57 #define WC3_AUDIO_CHANNELS 1
58 #define WC3_AUDIO_BITS 16
59 
60 /* nice, constant framerate */
61 #define WC3_FRAME_FPS 15
62 
63 #define PALETTE_SIZE (256 * 3)
64 
65 typedef struct Wc3DemuxContext {
66  int width;
67  int height;
68  int64_t pts;
71 
73 
75 
76 static int wc3_probe(const AVProbeData *p)
77 {
78  if (p->buf_size < 12)
79  return 0;
80 
81  if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
82  (AV_RL32(&p->buf[8]) != MOVE_TAG))
83  return 0;
84 
85  return AVPROBE_SCORE_MAX;
86 }
87 
89 {
90  Wc3DemuxContext *wc3 = s->priv_data;
91  AVIOContext *pb = s->pb;
92  unsigned int fourcc_tag;
93  unsigned int size;
94  AVStream *st;
95  int ret = 0;
96  char *buffer;
97 
98  /* default context members */
99  wc3->width = WC3_DEFAULT_WIDTH;
100  wc3->height = WC3_DEFAULT_HEIGHT;
101  wc3->pts = 0;
102  wc3->video_stream_index = wc3->audio_stream_index = 0;
103  av_init_packet(&wc3->vpkt);
104  wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
105 
106  /* skip the first 3 32-bit numbers */
107  avio_skip(pb, 12);
108 
109  /* traverse through the chunks and load the header information before
110  * the first BRCH tag */
111  fourcc_tag = avio_rl32(pb);
112  size = (avio_rb32(pb) + 1) & (~1);
113 
114  do {
115  switch (fourcc_tag) {
116 
117  case SOND_TAG:
118  case INDX_TAG:
119  /* SOND unknown, INDX unnecessary; ignore both */
120  avio_skip(pb, size);
121  break;
122 
123  case PC__TAG:
124  /* number of palettes, unneeded */
125  avio_skip(pb, 12);
126  break;
127 
128  case BNAM_TAG:
129  /* load up the name */
130  buffer = av_malloc(size+1);
131  if (!buffer)
132  return AVERROR(ENOMEM);
133  if ((ret = avio_read(pb, buffer, size)) != size) {
134  av_freep(&buffer);
135  return AVERROR(EIO);
136  }
137  buffer[size] = 0;
138  av_dict_set(&s->metadata, "title", buffer,
140  break;
141 
142  case SIZE_TAG:
143  /* video resolution override */
144  wc3->width = avio_rl32(pb);
145  wc3->height = avio_rl32(pb);
146  break;
147 
148  case PALT_TAG:
149  /* one of several palettes */
150  avio_seek(pb, -8, SEEK_CUR);
151  av_append_packet(pb, &wc3->vpkt, 8 + PALETTE_SIZE);
152  break;
153 
154  default:
155  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
156  av_fourcc2str(fourcc_tag));
157  return AVERROR_INVALIDDATA;
158  }
159 
160  fourcc_tag = avio_rl32(pb);
161  /* chunk sizes are 16-bit aligned */
162  size = (avio_rb32(pb) + 1) & (~1);
163  if (avio_feof(pb))
164  return AVERROR(EIO);
165 
166  } while (fourcc_tag != BRCH_TAG);
167 
168  /* initialize the decoder streams */
169  st = avformat_new_stream(s, NULL);
170  if (!st)
171  return AVERROR(ENOMEM);
173  wc3->video_stream_index = st->index;
176  st->codecpar->codec_tag = 0; /* no fourcc */
177  st->codecpar->width = wc3->width;
178  st->codecpar->height = wc3->height;
179 
180  st = avformat_new_stream(s, NULL);
181  if (!st)
182  return AVERROR(ENOMEM);
184  wc3->audio_stream_index = st->index;
187  st->codecpar->codec_tag = 1;
195 
196  return 0;
197 }
198 
200  AVPacket *pkt)
201 {
202  Wc3DemuxContext *wc3 = s->priv_data;
203  AVIOContext *pb = s->pb;
204  unsigned int fourcc_tag;
205  unsigned int size;
206  int packet_read = 0;
207  int ret = 0;
208  unsigned char text[1024];
209 
210  while (!packet_read) {
211 
212  fourcc_tag = avio_rl32(pb);
213  /* chunk sizes are 16-bit aligned */
214  size = (avio_rb32(pb) + 1) & (~1);
215  if (avio_feof(pb))
216  return AVERROR(EIO);
217 
218  switch (fourcc_tag) {
219 
220  case BRCH_TAG:
221  /* no-op */
222  break;
223 
224  case SHOT_TAG:
225  /* load up new palette */
226  avio_seek(pb, -8, SEEK_CUR);
227  av_append_packet(pb, &wc3->vpkt, 8 + 4);
228  break;
229 
230  case VGA__TAG:
231  /* send out video chunk */
232  avio_seek(pb, -8, SEEK_CUR);
233  ret= av_append_packet(pb, &wc3->vpkt, 8 + size);
234  // ignore error if we have some data
235  if (wc3->vpkt.size > 0)
236  ret = 0;
237  *pkt = wc3->vpkt;
238  wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
239  pkt->stream_index = wc3->video_stream_index;
240  pkt->pts = wc3->pts;
241  packet_read = 1;
242  break;
243 
244  case TEXT_TAG:
245  /* subtitle chunk */
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  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
252  return AVERROR_INVALIDDATA;
253  av_log (s, AV_LOG_DEBUG, " inglish: %s\n", &text[i + 1]);
254  i += text[i] + 1;
255  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
256  return AVERROR_INVALIDDATA;
257  av_log (s, AV_LOG_DEBUG, " doytsch: %s\n", &text[i + 1]);
258  i += text[i] + 1;
259  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
260  return AVERROR_INVALIDDATA;
261  av_log (s, AV_LOG_DEBUG, " fronsay: %s\n", &text[i + 1]);
262  }
263  break;
264 
265  case AUDI_TAG:
266  /* send out audio chunk */
267  ret= av_get_packet(pb, pkt, size);
268  pkt->stream_index = wc3->audio_stream_index;
269  pkt->pts = wc3->pts;
270 
271  /* time to advance pts */
272  wc3->pts++;
273 
274  packet_read = 1;
275  break;
276 
277  default:
278  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
279  av_fourcc2str(fourcc_tag));
280  ret = AVERROR_INVALIDDATA;
281  packet_read = 1;
282  break;
283  }
284  }
285 
286  return ret;
287 }
288 
290 {
291  Wc3DemuxContext *wc3 = s->priv_data;
292 
293  if (wc3->vpkt.size > 0)
294  av_packet_unref(&wc3->vpkt);
295 
296  return 0;
297 }
298 
300  .name = "wc3movie",
301  .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III movie"),
302  .priv_data_size = sizeof(Wc3DemuxContext),
307 };
#define NULL
Definition: coverity.c:32
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
#define WC3_AUDIO_BITS
Definition: wc3movie.c:58
#define BRCH_TAG
Definition: wc3movie.c:45
int size
size_t static size_t av_strnlen(const char *s, size_t len)
Get the count of continuous non zero chars starting from the beginning.
Definition: avstring.h:140
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4938
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
int index
stream index in AVFormatContext
Definition: avformat.h:877
int size
Definition: packet.h:356
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:241
#define SIZE_TAG
Definition: wc3movie.c:42
#define WC3_DEFAULT_HEIGHT
Definition: wc3movie.c:53
#define INDX_TAG
Definition: wc3movie.c:44
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:329
static AVPacket pkt
int video_stream_index
Definition: wc3movie.c:69
Format I/O context.
Definition: avformat.h:1351
Public dictionary API.
int64_t pts
Definition: wc3movie.c:68
static char buffer[20]
Definition: seek.c:32
#define SHOT_TAG
Definition: wc3movie.c:46
#define TEXT_TAG
Definition: wc3movie.c:48
#define SOND_TAG
Definition: wc3movie.c:40
#define av_malloc(s)
int width
Video only.
Definition: codec_par.h:126
static int wc3_read_close(AVFormatContext *s)
Definition: wc3movie.c:289
unsigned int avio_rb32(AVIOContext *s)
Definition: aviobuf.c:778
AVInputFormat ff_wc3_demuxer
Definition: wc3movie.c:299
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4519
uint8_t * data
Definition: packet.h:355
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
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:304
#define BNAM_TAG
Definition: wc3movie.c:41
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:625
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:314
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
#define PALT_TAG
Definition: wc3movie.c:43
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1591
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:747
#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:186
#define AUDI_TAG
Definition: wc3movie.c:49
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
#define av_fourcc2str(fourcc)
Definition: avutil.h:348
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
#define WC3_DEFAULT_WIDTH
Definition: wc3movie.c:52
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
int block_align
Audio only.
Definition: codec_par.h:177
audio channel layout utility functions
#define AV_DICT_DONT_STRDUP_VAL
Take ownership of a value that&#39;s been allocated with av_malloc() or another memory allocation functio...
Definition: dict.h:76
#define s(width, name)
Definition: cbs_vp9.c:257
#define AV_RL32
Definition: intreadwrite.h:146
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:876
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVIOContext * pb
I/O context.
Definition: avformat.h:1393
int audio_stream_index
Definition: wc3movie.c:70
#define PALETTE_SIZE
Definition: wc3movie.c:63
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:605
#define PC__TAG
Definition: wc3movie.c:39
static int wc3_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wc3movie.c:199
#define WC3_FRAME_FPS
Definition: wc3movie.c:61
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:70
#define FORM_TAG
Definition: wc3movie.c:37
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
#define WC3_AUDIO_CHANNELS
Definition: wc3movie.c:57
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
int sample_rate
Audio only.
Definition: codec_par.h:170
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
Main libavformat public API header.
#define WC3_SAMPLE_RATE
Definition: wc3movie.c:56
static int wc3_read_header(AVFormatContext *s)
Definition: wc3movie.c:88
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:35
AVPacket vpkt
Definition: wc3movie.c:72
void * priv_data
Format private data.
Definition: avformat.h:1379
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
int channels
Audio only.
Definition: codec_par.h:166
#define av_freep(p)
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:650
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1023
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:356
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
#define VGA__TAG
Definition: wc3movie.c:47
static int wc3_probe(const AVProbeData *p)
Definition: wc3movie.c:76
int stream_index
Definition: packet.h:357
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
Definition: packet.h:332
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:348
#define MOVE_TAG
Definition: wc3movie.c:38