FFmpeg
apm.c
Go to the documentation of this file.
1 /*
2  * Rayman 2 APM (De)muxer
3  *
4  * Copyright (C) 2020 Zane van Iperen (zane@zanevaniperen.com)
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 #include "avformat.h"
23 #include "internal.h"
24 #include "rawenc.h"
26 #include "libavutil/internal.h"
27 #include "libavutil/intreadwrite.h"
28 
29 #define APM_FILE_HEADER_SIZE 20
30 #define APM_FILE_EXTRADATA_SIZE 80
31 #define APM_EXTRADATA_SIZE 28
32 
33 #define APM_MAX_READ_SIZE 4096
34 
35 #define APM_TAG_CODEC 0x2000
36 #define APM_TAG_VS12 MKTAG('v', 's', '1', '2')
37 #define APM_TAG_DATA MKTAG('D', 'A', 'T', 'A')
38 
39 typedef struct APMState {
47 } APMState;
48 
49 typedef struct APMExtraData {
50  uint32_t magic;
51  uint32_t file_size;
52  uint32_t data_size;
53  uint32_t unk1;
54  uint32_t unk2;
56  uint32_t unk3[7];
57  uint32_t data;
58 } APMExtraData;
59 
60 #if CONFIG_APM_DEMUXER
61 static void apm_parse_extradata(APMExtraData *ext, const uint8_t *buf)
62 {
63  ext->magic = AV_RL32(buf + 0);
64  ext->file_size = AV_RL32(buf + 4);
65  ext->data_size = AV_RL32(buf + 8);
66  ext->unk1 = AV_RL32(buf + 12);
67  ext->unk2 = AV_RL32(buf + 16);
68 
69  ext->state.has_saved = AV_RL32(buf + 20);
70  ext->state.predictor_r = AV_RL32(buf + 24);
71  ext->state.step_index_r = AV_RL32(buf + 28);
72  ext->state.saved_r = AV_RL32(buf + 32);
73  ext->state.predictor_l = AV_RL32(buf + 36);
74  ext->state.step_index_l = AV_RL32(buf + 40);
75  ext->state.saved_l = AV_RL32(buf + 44);
76 
77  for (int i = 0; i < FF_ARRAY_ELEMS(ext->unk3); i++)
78  ext->unk3[i] = AV_RL32(buf + 48 + (i * 4));
79 
80  ext->data = AV_RL32(buf + 76);
81 }
82 
83 static int apm_probe(const AVProbeData *p)
84 {
85  if (AV_RL16(p->buf) != APM_TAG_CODEC)
86  return 0;
87 
88  if (p->buf_size < 100)
89  return 0;
90 
91  if (AV_RL32(p->buf + 20) != APM_TAG_VS12)
92  return 0;
93 
94  if (AV_RL32(p->buf + 96) != APM_TAG_DATA)
95  return 0;
96 
97  return AVPROBE_SCORE_MAX - 1;
98 }
99 
100 static int apm_read_header(AVFormatContext *s)
101 {
102  int64_t ret;
103  AVStream *st;
104  APMExtraData extradata;
105  AVCodecParameters *par;
106  uint8_t buf[APM_FILE_EXTRADATA_SIZE];
107 
108  if (!(st = avformat_new_stream(s, NULL)))
109  return AVERROR(ENOMEM);
110 
111  /*
112  * This is 98% a WAVEFORMATEX, but there's something screwy with the extradata
113  * that ff_get_wav_header() can't (and shouldn't) handle properly.
114  */
115  if (avio_rl16(s->pb) != APM_TAG_CODEC)
116  return AVERROR_INVALIDDATA;
117 
118  par = st->codecpar;
119  par->channels = avio_rl16(s->pb);
120  par->sample_rate = avio_rl32(s->pb);
121 
122  /* Skip the bitrate, it's usually wrong anyway. */
123  if ((ret = avio_skip(s->pb, 4)) < 0)
124  return ret;
125 
126  par->block_align = avio_rl16(s->pb);
127  par->bits_per_coded_sample = avio_rl16(s->pb);
128 
129  if (avio_rl32(s->pb) != APM_FILE_EXTRADATA_SIZE)
130  return AVERROR_INVALIDDATA;
131 
132  /* 8 = bits per sample * max channels */
133  if (par->sample_rate > (INT_MAX / 8))
134  return AVERROR_INVALIDDATA;
135 
136  if (par->bits_per_coded_sample != 4)
137  return AVERROR_INVALIDDATA;
138 
139  if (par->channels == 2)
141  else if (par->channels == 1)
143  else
144  return AVERROR_INVALIDDATA;
145 
148  par->format = AV_SAMPLE_FMT_S16;
149  par->bit_rate = par->channels *
150  par->sample_rate *
152 
153  if ((ret = avio_read(s->pb, buf, APM_FILE_EXTRADATA_SIZE)) < 0)
154  return ret;
155  else if (ret != APM_FILE_EXTRADATA_SIZE)
156  return AVERROR(EIO);
157 
158  apm_parse_extradata(&extradata, buf);
159 
160  if (extradata.magic != APM_TAG_VS12 || extradata.data != APM_TAG_DATA)
161  return AVERROR_INVALIDDATA;
162 
163  if (extradata.state.has_saved) {
164  avpriv_request_sample(s, "Saved Samples");
165  return AVERROR_PATCHWELCOME;
166  }
167 
168  if ((ret = ff_alloc_extradata(par, APM_EXTRADATA_SIZE)) < 0)
169  return ret;
170 
171  /* Use the entire state as extradata. */
172  memcpy(par->extradata, buf + 20, APM_EXTRADATA_SIZE);
173 
174  avpriv_set_pts_info(st, 64, 1, par->sample_rate);
175  st->start_time = 0;
176  st->duration = extradata.data_size *
177  (8 / par->bits_per_coded_sample) /
178  par->channels;
179  return 0;
180 }
181 
182 static int apm_read_packet(AVFormatContext *s, AVPacket *pkt)
183 {
184  int ret;
185  AVCodecParameters *par = s->streams[0]->codecpar;
186 
187  /*
188  * For future reference: if files with the `has_saved` field set ever
189  * surface, `saved_l`, and `saved_r` will each contain 8 "saved" samples
190  * that should be sent to the decoder before the actual data.
191  */
192 
193  if ((ret = av_get_packet(s->pb, pkt, APM_MAX_READ_SIZE)) < 0)
194  return ret;
195 
197  pkt->stream_index = 0;
198  pkt->duration = ret * (8 / par->bits_per_coded_sample) / par->channels;
199 
200  return 0;
201 }
202 
204  .name = "apm",
205  .long_name = NULL_IF_CONFIG_SMALL("Ubisoft Rayman 2 APM"),
206  .read_probe = apm_probe,
207  .read_header = apm_read_header,
208  .read_packet = apm_read_packet
209 };
210 #endif
211 
212 #if CONFIG_APM_MUXER
213 static int apm_write_init(AVFormatContext *s)
214 {
215  AVCodecParameters *par;
216 
217  if (s->nb_streams != 1) {
218  av_log(s, AV_LOG_ERROR, "APM files have exactly one stream\n");
219  return AVERROR(EINVAL);
220  }
221 
222  par = s->streams[0]->codecpar;
223 
224  if (par->codec_id != AV_CODEC_ID_ADPCM_IMA_APM) {
225  av_log(s, AV_LOG_ERROR, "%s codec not supported\n",
226  avcodec_get_name(par->codec_id));
227  return AVERROR(EINVAL);
228  }
229 
230  if (par->channels > 2) {
231  av_log(s, AV_LOG_ERROR, "APM files only support up to 2 channels\n");
232  return AVERROR(EINVAL);
233  }
234 
235  if (par->sample_rate > (INT_MAX / 8)) {
236  av_log(s, AV_LOG_ERROR, "Sample rate too large\n");
237  return AVERROR(EINVAL);
238  }
239 
240  if (par->extradata_size != APM_EXTRADATA_SIZE) {
241  av_log(s, AV_LOG_ERROR, "Invalid/missing extradata\n");
242  return AVERROR(EINVAL);
243  }
244 
245  if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL)) {
246  av_log(s, AV_LOG_ERROR, "Stream not seekable, unable to write output file\n");
247  return AVERROR(EINVAL);
248  }
249 
250  return 0;
251 }
252 
253 static int apm_write_header(AVFormatContext *s)
254 {
255  uint8_t buf[APM_FILE_EXTRADATA_SIZE] = { 0 };
256  AVCodecParameters *par = s->streams[0]->codecpar;
257 
258  /*
259  * Bodge a WAVEFORMATEX manually, ff_put_wav_header() can't
260  * be used because of the extra 2 bytes.
261  */
262  avio_wl16(s->pb, APM_TAG_CODEC);
263  avio_wl16(s->pb, par->channels);
264  avio_wl32(s->pb, par->sample_rate);
265  /* This is the wrong calculation, but it's what the orginal files have. */
266  avio_wl32(s->pb, par->sample_rate * par->channels * 2);
267  avio_wl16(s->pb, par->block_align);
268  avio_wl16(s->pb, par->bits_per_coded_sample);
270 
271  /*
272  * Build the extradata. Assume the codec's given us correct data.
273  * File and data sizes are fixed later.
274  */
275  AV_WL32(buf + 0, APM_TAG_VS12); /* magic */
276  AV_WL32(buf + 12, 0xFFFFFFFF); /* unk1 */
277  memcpy( buf + 20, par->extradata, APM_EXTRADATA_SIZE);
278  AV_WL32(buf + 76, APM_TAG_DATA); /* data */
279 
281  return 0;
282 }
283 
284 static int apm_write_trailer(AVFormatContext *s)
285 {
286  int64_t file_size, data_size;
287 
288  file_size = avio_tell(s->pb);
289  data_size = file_size - (APM_FILE_HEADER_SIZE + APM_FILE_EXTRADATA_SIZE);
290 
291  if (file_size >= UINT32_MAX) {
293  "Filesize %"PRId64" invalid for APM, output file will be broken\n",
294  file_size);
295  return AVERROR(ERANGE);
296  }
297 
298  avio_seek(s->pb, 24, SEEK_SET);
299  avio_wl32(s->pb, (uint32_t)file_size);
300  avio_wl32(s->pb, (uint32_t)data_size);
301 
302  return 0;
303 }
304 
306  .name = "apm",
307  .long_name = NULL_IF_CONFIG_SMALL("Ubisoft Rayman 2 APM"),
308  .extensions = "apm",
309  .audio_codec = AV_CODEC_ID_ADPCM_IMA_APM,
310  .video_codec = AV_CODEC_ID_NONE,
311  .init = apm_write_init,
312  .write_header = apm_write_header,
313  .write_packet = ff_raw_write_packet,
314  .write_trailer = apm_write_trailer
315 };
316 #endif
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
AVOutputFormat::name
const char * name
Definition: avformat.h:496
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:724
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
AV_WL32
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
APMExtraData::unk3
uint32_t unk3[7]
Definition: apm.c:56
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
APMState::predictor_r
int32_t predictor_r
Definition: apm.c:41
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:90
APMExtraData::state
APMState state
Definition: apm.c:55
APMState::saved_l
int32_t saved_l
Definition: apm.c:46
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:391
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:449
avio_wl16
void avio_wl16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:451
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:458
APMState
Definition: apm.c:39
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
APMExtraData::data_size
uint32_t data_size
Definition: apm.c:52
ff_apm_muxer
const AVOutputFormat ff_apm_muxer
APMExtraData
Definition: apm.c:49
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:486
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:888
avio_rl16
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:726
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:91
APM_FILE_HEADER_SIZE
#define APM_FILE_HEADER_SIZE
Definition: apm.c:29
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:626
FF_ARRAY_ELEMS
#define FF_ARRAY_ELEMS(a)
Definition: sinewin_tablegen.c:29
AV_PKT_FLAG_CORRUPT
#define AV_PKT_FLAG_CORRUPT
The packet content is corrupted.
Definition: packet.h:426
APMExtraData::data
uint32_t data
Definition: apm.c:57
APMState::step_index_r
int32_t step_index_r
Definition: apm.c:42
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
APMState::step_index_l
int32_t step_index_l
Definition: apm.c:45
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:631
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
ff_raw_write_packet
int ff_raw_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: rawenc.c:29
AV_RL16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:94
AVFormatContext
Format I/O context.
Definition: avformat.h:1097
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:992
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:446
APM_MAX_READ_SIZE
#define APM_MAX_READ_SIZE
Definition: apm.c:33
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:78
avio_rl32
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:742
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
APM_TAG_DATA
#define APM_TAG_DATA
Definition: apm.c:37
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
avio_wl32
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:371
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:379
rawenc.h
APMState::saved_r
int32_t saved_r
Definition: apm.c:43
avcodec_get_name
const char * avcodec_get_name(enum AVCodecID id)
Get the name of a codec.
Definition: utils.c:453
ff_apm_demuxer
const AVInputFormat ff_apm_demuxer
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:48
AVOutputFormat
Definition: avformat.h:495
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
internal.h
APM_TAG_CODEC
#define APM_TAG_CODEC
Definition: apm.c:35
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:177
APM_TAG_VS12
#define APM_TAG_VS12
Definition: apm.c:36
AV_CODEC_ID_ADPCM_IMA_APM
@ AV_CODEC_ID_ADPCM_IMA_APM
Definition: codec_id.h:397
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:61
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:196
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:845
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
avformat.h
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
APMExtraData::file_size
uint32_t file_size
Definition: apm.c:51
channel_layout.h
APMExtraData::unk2
uint32_t unk2
Definition: apm.c:54
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
APMState::has_saved
int32_t has_saved
Definition: apm.c:40
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:625
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: utils.c:1146
AVPacket::stream_index
int stream_index
Definition: packet.h:375
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:333
APM_EXTRADATA_SIZE
#define APM_EXTRADATA_SIZE
Definition: apm.c:31
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
APM_FILE_EXTRADATA_SIZE
#define APM_FILE_EXTRADATA_SIZE
Definition: apm.c:30
avpriv_request_sample
#define avpriv_request_sample(...)
Definition: tableprint_vlc.h:37
AVCodecParameters::format
int format
Definition: codec_par.h:84
APMExtraData::unk1
uint32_t unk1
Definition: apm.c:53
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:350
AVCodecParameters::channel_layout
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
int32_t
int32_t
Definition: audioconvert.c:56
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AVStream::start_time
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base.
Definition: avformat.h:878
APMExtraData::magic
uint32_t magic
Definition: apm.c:50
APMState::predictor_l
int32_t predictor_l
Definition: apm.c:44
ff_alloc_extradata
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0.
Definition: utils.c:451