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_BITS 16
58 
59 /* nice, constant framerate */
60 #define WC3_FRAME_FPS 15
61 
62 #define PALETTE_SIZE (256 * 3)
63 
64 typedef struct Wc3DemuxContext {
65  int width;
66  int height;
67  int64_t pts;
68  int video_stream_index;
69  int audio_stream_index;
70 
71  AVPacket *vpkt;
72 
73 } Wc3DemuxContext;
74 
75 static int wc3_read_close(AVFormatContext *s)
76 {
77  Wc3DemuxContext *wc3 = s->priv_data;
78 
79  av_packet_free(&wc3->vpkt);
80 
81  return 0;
82 }
83 
84 static int wc3_probe(const AVProbeData *p)
85 {
86  if (p->buf_size < 12)
87  return 0;
88 
89  if ((AV_RL32(&p->buf[0]) != FORM_TAG) ||
90  (AV_RL32(&p->buf[8]) != MOVE_TAG))
91  return 0;
92 
93  return AVPROBE_SCORE_MAX;
94 }
95 
96 static int wc3_read_header(AVFormatContext *s)
97 {
98  Wc3DemuxContext *wc3 = s->priv_data;
99  AVIOContext *pb = s->pb;
100  unsigned int fourcc_tag;
101  unsigned int size;
102  AVStream *st;
103  int ret = 0;
104  char *buffer;
105 
106  /* default context members */
107  wc3->width = WC3_DEFAULT_WIDTH;
108  wc3->height = WC3_DEFAULT_HEIGHT;
109  wc3->pts = 0;
110  wc3->video_stream_index = wc3->audio_stream_index = 0;
111  wc3->vpkt = av_packet_alloc();
112  if (!wc3->vpkt)
113  return AVERROR(ENOMEM);
114 
115  /* skip the first 3 32-bit numbers */
116  avio_skip(pb, 12);
117 
118  /* traverse through the chunks and load the header information before
119  * the first BRCH tag */
120  fourcc_tag = avio_rl32(pb);
121  size = (avio_rb32(pb) + 1) & (~1);
122 
123  do {
124  switch (fourcc_tag) {
125 
126  case SOND_TAG:
127  case INDX_TAG:
128  /* SOND unknown, INDX unnecessary; ignore both */
129  avio_skip(pb, size);
130  break;
131 
132  case PC__TAG:
133  /* number of palettes, unneeded */
134  avio_skip(pb, 12);
135  break;
136 
137  case BNAM_TAG:
138  /* load up the name */
139  buffer = av_malloc(size+1);
140  if (!buffer)
141  return AVERROR(ENOMEM);
142  if ((ret = avio_read(pb, buffer, size)) != size) {
143  av_freep(&buffer);
144  return AVERROR(EIO);
145  }
146  buffer[size] = 0;
147  av_dict_set(&s->metadata, "title", buffer,
148  AV_DICT_DONT_STRDUP_VAL);
149  break;
150 
151  case SIZE_TAG:
152  /* video resolution override */
153  wc3->width = avio_rl32(pb);
154  wc3->height = avio_rl32(pb);
155  break;
156 
157  case PALT_TAG:
158  /* one of several palettes */
159  avio_seek(pb, -8, SEEK_CUR);
160  av_append_packet(pb, wc3->vpkt, 8 + PALETTE_SIZE);
161  break;
162 
163  default:
164  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
165  av_fourcc2str(fourcc_tag));
166  return AVERROR_INVALIDDATA;
167  }
168 
169  fourcc_tag = avio_rl32(pb);
170  /* chunk sizes are 16-bit aligned */
171  size = (avio_rb32(pb) + 1) & (~1);
172  if (avio_feof(pb))
173  return AVERROR(EIO);
174 
175  } while (fourcc_tag != BRCH_TAG);
176 
177  /* initialize the decoder streams */
178  st = avformat_new_stream(s, NULL);
179  if (!st)
180  return AVERROR(ENOMEM);
181  avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
182  wc3->video_stream_index = st->index;
183  st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
184  st->codecpar->codec_id = AV_CODEC_ID_XAN_WC3;
185  st->codecpar->codec_tag = 0; /* no fourcc */
186  st->codecpar->width = wc3->width;
187  st->codecpar->height = wc3->height;
188 
189  st = avformat_new_stream(s, NULL);
190  if (!st)
191  return AVERROR(ENOMEM);
192  avpriv_set_pts_info(st, 33, 1, WC3_FRAME_FPS);
193  wc3->audio_stream_index = st->index;
194  st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
195  st->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
196  st->codecpar->codec_tag = 1;
197  st->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_MONO;
198  st->codecpar->bits_per_coded_sample = WC3_AUDIO_BITS;
199  st->codecpar->sample_rate = WC3_SAMPLE_RATE;
200  st->codecpar->bit_rate = st->codecpar->ch_layout.nb_channels * st->codecpar->sample_rate *
201  st->codecpar->bits_per_coded_sample;
202  st->codecpar->block_align = WC3_AUDIO_BITS * st->codecpar->ch_layout.nb_channels;
203 
204  return 0;
205 }
206 
207 static int wc3_read_packet(AVFormatContext *s,
208  AVPacket *pkt)
209 {
210  Wc3DemuxContext *wc3 = s->priv_data;
211  AVIOContext *pb = s->pb;
212  unsigned int fourcc_tag;
213  unsigned int size;
214  int packet_read = 0;
215  int ret = 0;
216  unsigned char text[1024];
217 
218  while (!packet_read) {
219 
220  fourcc_tag = avio_rl32(pb);
221  /* chunk sizes are 16-bit aligned */
222  size = (avio_rb32(pb) + 1) & (~1);
223  if (avio_feof(pb))
224  return AVERROR(EIO);
225 
226  switch (fourcc_tag) {
227 
228  case BRCH_TAG:
229  /* no-op */
230  break;
231 
232  case SHOT_TAG:
233  /* load up new palette */
234  avio_seek(pb, -8, SEEK_CUR);
235  av_append_packet(pb, wc3->vpkt, 8 + 4);
236  break;
237 
238  case VGA__TAG:
239  /* send out video chunk */
240  avio_seek(pb, -8, SEEK_CUR);
241  ret= av_append_packet(pb, wc3->vpkt, 8 + size);
242  // ignore error if we have some data
243  if (wc3->vpkt->size > 0)
244  ret = 0;
245  av_packet_move_ref(pkt, wc3->vpkt);
246  pkt->stream_index = wc3->video_stream_index;
247  pkt->pts = wc3->pts;
248  packet_read = 1;
249  break;
250 
251  case TEXT_TAG:
252  /* subtitle chunk */
253  if ((unsigned)size > sizeof(text) || (ret = avio_read(pb, text, size)) != size)
254  ret = AVERROR(EIO);
255  else {
256  int i = 0;
257  av_log (s, AV_LOG_DEBUG, "Subtitle time!\n");
258  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
259  return AVERROR_INVALIDDATA;
260  av_log (s, AV_LOG_DEBUG, " inglish: %s\n", &text[i + 1]);
261  i += text[i] + 1;
262  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
263  return AVERROR_INVALIDDATA;
264  av_log (s, AV_LOG_DEBUG, " doytsch: %s\n", &text[i + 1]);
265  i += text[i] + 1;
266  if (i >= size || av_strnlen(&text[i + 1], size - i - 1) >= size - i - 1)
267  return AVERROR_INVALIDDATA;
268  av_log (s, AV_LOG_DEBUG, " fronsay: %s\n", &text[i + 1]);
269  }
270  break;
271 
272  case AUDI_TAG:
273  /* send out audio chunk */
274  ret= av_get_packet(pb, pkt, size);
275  pkt->stream_index = wc3->audio_stream_index;
276  pkt->pts = wc3->pts;
277 
278  /* time to advance pts */
279  wc3->pts++;
280 
281  packet_read = 1;
282  break;
283 
284  default:
285  av_log(s, AV_LOG_ERROR, "unrecognized WC3 chunk: %s\n",
286  av_fourcc2str(fourcc_tag));
287  ret = AVERROR_INVALIDDATA;
288  packet_read = 1;
289  break;
290  }
291  }
292 
293  return ret;
294 }
295 
296 const AVInputFormat ff_wc3_demuxer = {
297  .name = "wc3movie",
298  .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III movie"),
299  .priv_data_size = sizeof(Wc3DemuxContext),
300  .flags_internal = FF_FMT_INIT_CLEANUP,
301  .read_probe = wc3_probe,
302  .read_header = wc3_read_header,
303  .read_packet = wc3_read_packet,
304  .read_close = wc3_read_close,
305 };
Wc3DemuxContext::audio_stream_index
int audio_stream_index
Definition: wc3movie.c:69
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:326
FF_FMT_INIT_CLEANUP
#define FF_FMT_INIT_CLEANUP
For an AVInputFormat with this flag set read_close() needs to be called by the caller upon read_heade...
Definition: internal.h:47
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: options.c:237
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:58
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:66
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:456
FORM_TAG
#define FORM_TAG
Definition: wc3movie.c:37
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:311
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:73
PC__TAG
#define PC__TAG
Definition: wc3movie.c:39
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
Wc3DemuxContext::pts
int64_t pts
Definition: wc3movie.c:67
Wc3DemuxContext
Definition: wc3movie.c:64
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:465
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: avformat.c:763
WC3_SAMPLE_RATE
#define WC3_SAMPLE_RATE
Definition: wc3movie.c:56
AUDI_TAG
#define AUDI_TAG
Definition: wc3movie.c:49
wc3_read_header
static int wc3_read_header(AVFormatContext *s)
Definition: wc3movie.c:96
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:143
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:79
avio_rb32
unsigned int avio_rb32(AVIOContext *s)
Definition: aviobuf.c:792
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:180
AVInputFormat
Definition: avformat.h:656
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:256
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:661
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:455
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:128
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
AVFormatContext
Format I/O context.
Definition: avformat.h:1216
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1108
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:540
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:142
VGA__TAG
#define VGA__TAG
Definition: wc3movie.c:47
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:453
MOVE_TAG
#define MOVE_TAG
Definition: wc3movie.c:38
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:213
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:479
WC3_DEFAULT_HEIGHT
#define WC3_DEFAULT_HEIGHT
Definition: wc3movie.c:53
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:178
ff_wc3_demuxer
const AVInputFormat ff_wc3_demuxer
Definition: wc3movie.c:296
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:761
Wc3DemuxContext::vpkt
AVPacket * vpkt
Definition: wc3movie.c:71
AVIOContext
Bytestream IO Context.
Definition: avio.h:166
AVPacket::size
int size
Definition: packet.h:375
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:115
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:301
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:62
WC3_AUDIO_BITS
#define WC3_AUDIO_BITS
Definition: wc3movie.c:57
AV_CODEC_ID_XAN_WC3
@ AV_CODEC_ID_XAN_WC3
Definition: codec_id.h:92
wc3_probe
static int wc3_probe(const AVProbeData *p)
Definition: wc3movie.c:84
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
AVCodecParameters::height
int height
Definition: codec_par.h:129
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:185
wc3_read_packet
static int wc3_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: wc3movie.c:207
wc3_read_close
static int wc3_read_close(AVFormatContext *s)
Definition: wc3movie.c:75
Wc3DemuxContext::width
int width
Definition: wc3movie.c:65
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:102
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:948
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:262
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:118
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:956
channel_layout.h
PALETTE_SIZE
#define PALETTE_SIZE
Definition: wc3movie.c:62
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:643
AVPacket::stream_index
int stream_index
Definition: packet.h:376
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:349
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:104
AV_CHANNEL_LAYOUT_MONO
#define AV_CHANNEL_LAYOUT_MONO
Definition: channel_layout.h:368
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:62
AVPacket
This structure stores compressed data.
Definition: packet.h:351
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
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:86
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:91
Wc3DemuxContext::video_stream_index
int video_stream_index
Definition: wc3movie.c:68
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
Wc3DemuxContext::height
int height
Definition: wc3movie.c:66
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
WC3_DEFAULT_WIDTH
#define WC3_DEFAULT_WIDTH
Definition: wc3movie.c:52
avstring.h
WC3_FRAME_FPS
#define WC3_FRAME_FPS
Definition: wc3movie.c:60
av_fourcc2str
#define av_fourcc2str(fourcc)
Definition: avutil.h:354
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:377
Generated on Sun Dec 4 2022 19:21:50 for FFmpeg by   doxygen 1.8.17