FFmpeg
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 
77 {
78  Wc3DemuxContext *wc3 = s->priv_data;
79 
80  av_packet_free(&wc3->vpkt);
81 
82  return 0;
83 }
84 
85 static int wc3_probe(const AVProbeData *p)
86 {
87  if (p->buf_size < 12)
88  return 0;
89 
90  if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
91  (AV_RL32(&p->buf[8]) != MOVE_TAG))
92  return 0;
93 
94  return AVPROBE_SCORE_MAX;
95 }
96 
98 {
99  Wc3DemuxContext *wc3 = s->priv_data;
100  AVIOContext *pb = s->pb;
101  unsigned int fourcc_tag;
102  unsigned int size;
103  AVStream *st;
104  int ret = 0;
105  char *buffer;
106 
107  /* default context members */
108  wc3->width = WC3_DEFAULT_WIDTH;
109  wc3->height = WC3_DEFAULT_HEIGHT;
110  wc3->pts = 0;
111  wc3->video_stream_index = wc3->audio_stream_index = 0;
112  wc3->vpkt = av_packet_alloc();
113  if (!wc3->vpkt)
114  return AVERROR(ENOMEM);
115 
116  /* skip the first 3 32-bit numbers */
117  avio_skip(pb, 12);
118 
119  /* traverse through the chunks and load the header information before
120  * the first BRCH tag */
121  fourcc_tag = avio_rl32(pb);
122  size = (avio_rb32(pb) + 1) & (~1);
123 
124  do {
125  switch (fourcc_tag) {
126 
127  case SOND_TAG:
128  case INDX_TAG:
129  /* SOND unknown, INDX unnecessary; ignore both */
130  avio_skip(pb, size);
131  break;
132 
133  case PC__TAG:
134  /* number of palettes, unneeded */
135  avio_skip(pb, 12);
136  break;
137 
138  case BNAM_TAG:
139  /* load up the name */
140  buffer = av_malloc(size+1);
141  if (!buffer)
142  if (!buffer) {
143  ret = AVERROR(ENOMEM);
144  goto fail;
145  }
146  if ((ret = avio_read(pb, buffer, size)) != size) {
147  av_freep(&buffer);
148  ret = AVERROR(EIO);
149  goto fail;
150  }
151  buffer[size] = 0;
152  av_dict_set(&s->metadata, "title", buffer,
154  break;
155 
156  case SIZE_TAG:
157  /* video resolution override */
158  wc3->width = avio_rl32(pb);
159  wc3->height = avio_rl32(pb);
160  break;
161 
162  case PALT_TAG:
163  /* one of several palettes */
164  avio_seek(pb, -8, SEEK_CUR);
165  av_append_packet(pb, wc3->vpkt, 8 + PALETTE_SIZE);
166  break;
167 
168  default:
169  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
170  av_fourcc2str(fourcc_tag));
172  goto fail;
173  }
174 
175  fourcc_tag = avio_rl32(pb);
176  /* chunk sizes are 16-bit aligned */
177  size = (avio_rb32(pb) + 1) & (~1);
178  if (avio_feof(pb)) {
179  ret = AVERROR(EIO);
180  goto fail;
181  }
182 
183  } while (fourcc_tag != BRCH_TAG);
184 
185  /* initialize the decoder streams */
186  st = avformat_new_stream(s, NULL);
187  if (!st) {
188  ret = AVERROR(ENOMEM);
189  goto fail;
190  }
192  wc3->video_stream_index = st->index;
195  st->codecpar->codec_tag = 0; /* no fourcc */
196  st->codecpar->width = wc3->width;
197  st->codecpar->height = wc3->height;
198 
199  st = avformat_new_stream(s, NULL);
200  if (!st) {
201  ret = AVERROR(ENOMEM);
202  goto fail;
203  }
205  wc3->audio_stream_index = st->index;
208  st->codecpar->codec_tag = 1;
216 
217  return 0;
218 fail:
219  wc3_read_close(s);
220  return ret;
221 }
222 
224  AVPacket *pkt)
225 {
226  Wc3DemuxContext *wc3 = s->priv_data;
227  AVIOContext *pb = s->pb;
228  unsigned int fourcc_tag;
229  unsigned int size;
230  int packet_read = 0;
231  int ret = 0;
232  unsigned char text[1024];
233 
234  while (!packet_read) {
235 
236  fourcc_tag = avio_rl32(pb);
237  /* chunk sizes are 16-bit aligned */
238  size = (avio_rb32(pb) + 1) & (~1);
239  if (avio_feof(pb))
240  return AVERROR(EIO);
241 
242  switch (fourcc_tag) {
243 
244  case BRCH_TAG:
245  /* no-op */
246  break;
247 
248  case SHOT_TAG:
249  /* load up new palette */
250  avio_seek(pb, -8, SEEK_CUR);
251  av_append_packet(pb, wc3->vpkt, 8 + 4);
252  break;
253 
254  case VGA__TAG:
255  /* send out video chunk */
256  avio_seek(pb, -8, SEEK_CUR);
257  ret= av_append_packet(pb, wc3->vpkt, 8 + size);
258  // ignore error if we have some data
259  if (wc3->vpkt->size > 0)
260  ret = 0;
261  av_packet_move_ref(pkt, wc3->vpkt);
263  pkt->pts = wc3->pts;
264  packet_read = 1;
265  break;
266 
267  case TEXT_TAG:
268  /* subtitle chunk */
269  if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
270  ret = AVERROR(EIO);
271  else {
272  int i = 0;
273  av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
274  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
275  return AVERROR_INVALIDDATA;
276  av_log (s, AV_LOG_DEBUG, " inglish: %s\n", &text[i + 1]);
277  i += text[i] + 1;
278  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
279  return AVERROR_INVALIDDATA;
280  av_log (s, AV_LOG_DEBUG, " doytsch: %s\n", &text[i + 1]);
281  i += text[i] + 1;
282  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
283  return AVERROR_INVALIDDATA;
284  av_log (s, AV_LOG_DEBUG, " fronsay: %s\n", &text[i + 1]);
285  }
286  break;
287 
288  case AUDI_TAG:
289  /* send out audio chunk */
290  ret= av_get_packet(pb, pkt, size);
292  pkt->pts = wc3->pts;
293 
294  /* time to advance pts */
295  wc3->pts++;
296 
297  packet_read = 1;
298  break;
299 
300  default:
301  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
302  av_fourcc2str(fourcc_tag));
304  packet_read = 1;
305  break;
306  }
307  }
308 
309  return ret;
310 }
311 
313  .name = "wc3movie",
314  .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III movie"),
315  .priv_data_size = sizeof(Wc3DemuxContext),
320 };
Wc3DemuxContext::audio_stream_index
int audio_stream_index
Definition: wc3movie.c:70
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:313
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4553
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:90
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
FORM_TAG
#define FORM_TAG
Definition: wc3movie.c:37
av_packet_free
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
Definition: avpacket.c:75
PC__TAG
#define PC__TAG
Definition: wc3movie.c:39
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:31
Wc3DemuxContext::pts
int64_t pts
Definition: wc3movie.c:68
Wc3DemuxContext
Definition: wc3movie.c:65
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
WC3_SAMPLE_RATE
#define WC3_SAMPLE_RATE
Definition: wc3movie.c:56
AUDI_TAG
#define AUDI_TAG
Definition: wc3movie.c:49
fail
#define fail()
Definition: checkasm.h:133
wc3_read_header
static int wc3_read_header(AVFormatContext *s)
Definition: wc3movie.c:97
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
AV_DICT_DONT_STRDUP_VAL
#define AV_DICT_DONT_STRDUP_VAL
Take ownership of a value that's been allocated with av_malloc() or another memory allocation functio...
Definition: dict.h:74
avio_rb32
unsigned int avio_rb32(AVIOContext *s)
Definition: aviobuf.c:781
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
AVInputFormat
Definition: avformat.h:640
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:645
TEXT_TAG
#define TEXT_TAG
Definition: wc3movie.c:48
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:126
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:215
ff_wc3_demuxer
AVInputFormat ff_wc3_demuxer
Definition: wc3movie.c:312
AVFormatContext
Format I/O context.
Definition: avformat.h:1231
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1038
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
SOND_TAG
#define SOND_TAG
Definition: wc3movie.c:40
NULL
#define NULL
Definition: coverity.c:32
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
av_strnlen
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:141
VGA__TAG
#define VGA__TAG
Definition: wc3movie.c:47
WC3_AUDIO_CHANNELS
#define WC3_AUDIO_CHANNELS
Definition: wc3movie.c:57
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
MOVE_TAG
#define MOVE_TAG
Definition: wc3movie.c:38
av_packet_move_ref
void av_packet_move_ref(AVPacket *dst, AVPacket *src)
Move every field in src to dst and reset src.
Definition: avpacket.c:690
WC3_DEFAULT_HEIGHT
#define WC3_DEFAULT_HEIGHT
Definition: wc3movie.c:53
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
BRCH_TAG
#define BRCH_TAG
Definition: wc3movie.c:45
SHOT_TAG
#define SHOT_TAG
Definition: wc3movie.c:46
BNAM_TAG
#define BNAM_TAG
Definition: wc3movie.c:41
avio_rl32
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:750
Wc3DemuxContext::vpkt
AVPacket * vpkt
Definition: wc3movie.c:72
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVPacket::size
int size
Definition: packet.h:370
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
avpriv_set_pts_info
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:4999
size
int size
Definition: twinvq_data.h:10344
av_packet_alloc
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: avpacket.c:64
WC3_AUDIO_BITS
#define WC3_AUDIO_BITS
Definition: wc3movie.c:58
AV_CODEC_ID_XAN_WC3
@ AV_CODEC_ID_XAN_WC3
Definition: codec_id.h:89
wc3_probe
static int wc3_probe(const AVProbeData *p)
Definition: wc3movie.c:85
i
int i
Definition: input.c:407
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:362
AVCodecParameters::height
int height
Definition: codec_par.h:127
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:177
wc3_read_packet
static int wc3_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wc3movie.c:223
wc3_read_close
static int wc3_read_close(AVFormatContext *s)
Definition: wc3movie.c:76
Wc3DemuxContext::width
int width
Definition: wc3movie.c:66
av_get_packet
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:310
ret
ret
Definition: filter_design.txt:187
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVStream
Stream structure.
Definition: avformat.h:873
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:253
av_append_packet
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:326
avformat.h
dict.h
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:874
channel_layout.h
PALETTE_SIZE
#define PALETTE_SIZE
Definition: wc3movie.c:63
SIZE_TAG
#define SIZE_TAG
Definition: wc3movie.c:42
buffer
the frame and frame reference mechanism is intended to as much as expensive copies of that data while still allowing the filters to produce correct results The data is stored in buffers represented by AVFrame structures Several references can point to the same frame buffer
Definition: filter_design.txt:49
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:633
AVPacket::stream_index
int stream_index
Definition: packet.h:371
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:337
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
PALT_TAG
#define PALT_TAG
Definition: wc3movie.c:43
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
AVPacket
This structure stores compressed data.
Definition: packet.h:346
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
av_dict_set
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
AVCodecParameters::channel_layout
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
INDX_TAG
#define INDX_TAG
Definition: wc3movie.c:44
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
Wc3DemuxContext::video_stream_index
int video_stream_index
Definition: wc3movie.c:69
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
Wc3DemuxContext::height
int height
Definition: wc3movie.c:67
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
WC3_DEFAULT_WIDTH
#define WC3_DEFAULT_WIDTH
Definition: wc3movie.c:52
avstring.h
WC3_FRAME_FPS
#define WC3_FRAME_FPS
Definition: wc3movie.c:61
av_fourcc2str
#define av_fourcc2str(fourcc)
Definition: avutil.h:348
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:364