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"
31 #include "libavutil/channel_layout.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;
69  int video_stream_index;
70  int audio_stream_index;
71 
72  AVPacket vpkt;
73 
74 } Wc3DemuxContext;
75 
76 static int wc3_read_close(AVFormatContext *s)
77 {
78  Wc3DemuxContext *wc3 = s->priv_data;
79 
80  if (wc3->vpkt.size > 0)
81  av_packet_unref(&wc3->vpkt);
82 
83  return 0;
84 }
85 
86 static int wc3_probe(const AVProbeData *p)
87 {
88  if (p->buf_size < 12)
89  return 0;
90 
91  if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
92  (AV_RL32(&p->buf[8]) != MOVE_TAG))
93  return 0;
94 
95  return AVPROBE_SCORE_MAX;
96 }
97 
98 static int wc3_read_header(AVFormatContext *s)
99 {
100  Wc3DemuxContext *wc3 = s->priv_data;
101  AVIOContext *pb = s->pb;
102  unsigned int fourcc_tag;
103  unsigned int size;
104  AVStream *st;
105  int ret = 0;
106  char *buffer;
107 
108  /* default context members */
109  wc3->width = WC3_DEFAULT_WIDTH;
110  wc3->height = WC3_DEFAULT_HEIGHT;
111  wc3->pts = 0;
112  wc3->video_stream_index = wc3->audio_stream_index = 0;
113  av_init_packet(&wc3->vpkt);
114  wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
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  ret = AVERROR(ENOMEM);
143  goto fail;
144  }
145  if ((ret = avio_read(pb, buffer, size)) != size) {
146  ret = AVERROR(EIO);
147  goto fail;
148  }
149  buffer[size] = 0;
150  av_dict_set(&s->metadata, "title", buffer,
151  AV_DICT_DONT_STRDUP_VAL);
152  break;
153 
154  case SIZE_TAG:
155  /* video resolution override */
156  wc3->width = avio_rl32(pb);
157  wc3->height = avio_rl32(pb);
158  break;
159 
160  case PALT_TAG:
161  /* one of several palettes */
162  avio_seek(pb, -8, SEEK_CUR);
163  av_append_packet(pb, &wc3->vpkt, 8 + PALETTE_SIZE);
164  break;
165 
166  default:
167  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
168  av_fourcc2str(fourcc_tag));
169  ret = AVERROR_INVALIDDATA;
170  goto fail;
171  }
172 
173  fourcc_tag = avio_rl32(pb);
174  /* chunk sizes are 16-bit aligned */
175  size = (avio_rb32(pb) + 1) & (~1);
176  if (avio_feof(pb)) {
177  ret = AVERROR(EIO);
178  goto fail;
179  }
180 
181  } while (fourcc_tag != BRCH_TAG);
182 
183  /* initialize the decoder streams */
184  st = avformat_new_stream(s, NULL);
185  if (!st) {
186  ret = AVERROR(ENOMEM);
187  goto fail;
188  }
189  avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
190  wc3->video_stream_index = st->index;
191  st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
192  st->codecpar->codec_id = AV_CODEC_ID_XAN_WC3;
193  st->codecpar->codec_tag = 0; /* no fourcc */
194  st->codecpar->width = wc3->width;
195  st->codecpar->height = wc3->height;
196 
197  st = avformat_new_stream(s, NULL);
198  if (!st) {
199  ret = AVERROR(ENOMEM);
200  goto fail;
201  }
202  avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
203  wc3->audio_stream_index = st->index;
204  st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
205  st->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
206  st->codecpar->codec_tag = 1;
207  st->codecpar->channels = WC3_AUDIO_CHANNELS;
208  st->codecpar->channel_layout = AV_CH_LAYOUT_MONO;
209  st->codecpar->bits_per_coded_sample = WC3_AUDIO_BITS;
210  st->codecpar->sample_rate = WC3_SAMPLE_RATE;
211  st->codecpar->bit_rate = st->codecpar->channels * st->codecpar->sample_rate *
212  st->codecpar->bits_per_coded_sample;
213  st->codecpar->block_align = WC3_AUDIO_BITS * WC3_AUDIO_CHANNELS;
214 
215  return 0;
216 fail:
217  wc3_read_close(s);
218  return ret;
219 }
220 
221 static int wc3_read_packet(AVFormatContext *s,
222  AVPacket *pkt)
223 {
224  Wc3DemuxContext *wc3 = s->priv_data;
225  AVIOContext *pb = s->pb;
226  unsigned int fourcc_tag;
227  unsigned int size;
228  int packet_read = 0;
229  int ret = 0;
230  unsigned char text[1024];
231 
232  while (!packet_read) {
233 
234  fourcc_tag = avio_rl32(pb);
235  /* chunk sizes are 16-bit aligned */
236  size = (avio_rb32(pb) + 1) & (~1);
237  if (avio_feof(pb))
238  return AVERROR(EIO);
239 
240  switch (fourcc_tag) {
241 
242  case BRCH_TAG:
243  /* no-op */
244  break;
245 
246  case SHOT_TAG:
247  /* load up new palette */
248  avio_seek(pb, -8, SEEK_CUR);
249  av_append_packet(pb, &wc3->vpkt, 8 + 4);
250  break;
251 
252  case VGA__TAG:
253  /* send out video chunk */
254  avio_seek(pb, -8, SEEK_CUR);
255  ret= av_append_packet(pb, &wc3->vpkt, 8 + size);
256  // ignore error if we have some data
257  if (wc3->vpkt.size > 0)
258  ret = 0;
259  *pkt = wc3->vpkt;
260  wc3->vpkt.data = NULL; wc3->vpkt.size = 0;
261  pkt->stream_index = wc3->video_stream_index;
262  pkt->pts = wc3->pts;
263  packet_read = 1;
264  break;
265 
266  case TEXT_TAG:
267  /* subtitle chunk */
268  if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
269  ret = AVERROR(EIO);
270  else {
271  int i = 0;
272  av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
273  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
274  return AVERROR_INVALIDDATA;
275  av_log (s, AV_LOG_DEBUG, " inglish: %s\n", &text[i + 1]);
276  i += text[i] + 1;
277  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
278  return AVERROR_INVALIDDATA;
279  av_log (s, AV_LOG_DEBUG, " doytsch: %s\n", &text[i + 1]);
280  i += text[i] + 1;
281  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
282  return AVERROR_INVALIDDATA;
283  av_log (s, AV_LOG_DEBUG, " fronsay: %s\n", &text[i + 1]);
284  }
285  break;
286 
287  case AUDI_TAG:
288  /* send out audio chunk */
289  ret= av_get_packet(pb, pkt, size);
290  pkt->stream_index = wc3->audio_stream_index;
291  pkt->pts = wc3->pts;
292 
293  /* time to advance pts */
294  wc3->pts++;
295 
296  packet_read = 1;
297  break;
298 
299  default:
300  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
301  av_fourcc2str(fourcc_tag));
302  ret = AVERROR_INVALIDDATA;
303  packet_read = 1;
304  break;
305  }
306  }
307 
308  return ret;
309 }
310 
311 AVInputFormat ff_wc3_demuxer = {
312  .name = "wc3movie",
313  .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III movie"),
314  .priv_data_size = sizeof(Wc3DemuxContext),
315  .read_probe = wc3_probe,
316  .read_header = wc3_read_header,
317  .read_packet = wc3_read_packet,
318  .read_close = wc3_read_close,
319 };
Wc3DemuxContext::audio_stream_index
int audio_stream_index
Definition: wc3movie.c:70
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: avcodec.h:463
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:599
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:4480
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3953
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:85
AVPacket::data
uint8_t * data
Definition: avcodec.h:1477
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3961
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:449
FORM_TAG
#define FORM_TAG
Definition: wc3movie.c:37
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:458
AVCodecParameters::channels
int channels
Audio only.
Definition: avcodec.h:4063
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:120
wc3_read_header
static int wc3_read_header(AVFormatContext *s)
Definition: wc3movie.c:98
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:800
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
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:448
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: avcodec.h:4023
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
ff_wc3_demuxer
AVInputFormat ff_wc3_demuxer
Definition: wc3movie.c:311
AVFormatContext
Format I/O context.
Definition: avformat.h:1342
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1017
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
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:140
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:446
MOVE_TAG
#define MOVE_TAG
Definition: wc3movie.c:38
WC3_DEFAULT_HEIGHT
#define WC3_DEFAULT_HEIGHT
Definition: wc3movie.c:53
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: avcodec.h:4067
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:769
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVPacket::size
int size
Definition: avcodec.h:1478
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:188
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:4910
size
int size
Definition: twinvq_data.h:11134
WC3_AUDIO_BITS
#define WC3_AUDIO_BITS
Definition: wc3movie.c:58
AV_CODEC_ID_XAN_WC3
@ AV_CODEC_ID_XAN_WC3
Definition: avcodec.h:258
wc3_probe
static int wc3_probe(const AVProbeData *p)
Definition: wc3movie.c:86
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470
AVCodecParameters::height
int height
Definition: avcodec.h:4024
AVCodecParameters::block_align
int block_align
Audio only.
Definition: avcodec.h:4074
wc3_read_packet
static int wc3_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wc3movie.c:221
wc3_read_close
static int wc3_read_close(AVFormatContext *s)
Definition: wc3movie.c:76
Wc3DemuxContext::vpkt
AVPacket vpkt
Definition: wc3movie.c:72
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:313
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:870
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
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:323
avformat.h
dict.h
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:88
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:871
channel_layout.h
PALETTE_SIZE
#define PALETTE_SIZE
Definition: wc3movie.c:63
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
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:647
AVPacket::stream_index
int stream_index
Definition: avcodec.h:1479
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
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: avcodec.h:3999
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: avcodec.h:3957
AVPacket
This structure stores compressed data.
Definition: avcodec.h:1454
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: avcodec.h:4059
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: avcodec.h:3986
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
av_init_packet
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:33
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:358
Generated on Wed Aug 24 2022 21:27:26 for FFmpeg by   doxygen 1.8.17