FFmpeg
libopenmpt.c
Go to the documentation of this file.
1 /*
2  * Tracked MOD demuxer (libopenmpt)
3  * Copyright (c) 2016 Josh de Kock
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 #include <libopenmpt/libopenmpt.h>
23 #include <libopenmpt/libopenmpt_stream_callbacks_file.h>
24 #include <libopenmpt/libopenmpt_version.h>
25 /* Shims to support libopenmpt < 0.3.0 (as documented by libopenmpt) */
26 #if !defined(OPENMPT_API_VERSION_MAKE)
27 #define OPENMPT_API_VERSION_MAKE(major, minor, patch) (((major)<<24)|((minor)<<16)|((patch)<<0))
28 #endif
29 #if !defined(OPENMPT_API_VERSION_AT_LEAST)
30 #define OPENMPT_API_VERSION_AT_LEAST(major, minor, patch) (OPENMPT_API_VERSION >= OPENMPT_API_VERSION_MAKE((major), (minor), (patch)))
31 #endif
32 
33 #include "libavutil/avstring.h"
35 #include "libavutil/opt.h"
36 #include "avformat.h"
37 #include "internal.h"
38 
39 typedef struct OpenMPTContext {
40  const AVClass *class;
41  openmpt_module *module;
42 
43  double duration;
44  /* options */
47  int subsong;
49 
50 #define OFFSET(x) offsetof(OpenMPTContext, x)
51 #define A AV_OPT_FLAG_AUDIO_PARAM
52 #define D AV_OPT_FLAG_DECODING_PARAM
53 static const AVOption options[] = {
54  { "sample_rate", "set sample rate", OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 48000 }, 1000, INT_MAX, A | D },
55  { "layout", "set channel layout", OFFSET(ch_layout), AV_OPT_TYPE_CHLAYOUT, { .str = "stereo" }, 0, 0, A | D },
56  { "subsong", "set subsong", OFFSET(subsong), AV_OPT_TYPE_INT, { .i64 = -2 }, -2, INT_MAX, A | D, "subsong"},
57  { "all", "all", 0, AV_OPT_TYPE_CONST, { .i64 = -1}, 0, 0, A | D, "subsong" },
58  { "auto", "auto", 0, AV_OPT_TYPE_CONST, { .i64 = -2}, 0, 0, A | D, "subsong" },
59  { NULL }
60 };
61 
62 static void openmpt_logfunc(const char *message, void *userdata)
63 {
64  int level = AV_LOG_INFO;
65  if (strstr(message, "ERROR") != NULL) {
67  }
68  av_log(userdata, level, "%s\n", message);
69 }
70 
71 #define add_meta(s, name, meta) \
72 do { \
73  const char *value = meta; \
74  if (value && value[0]) \
75  av_dict_set(&s->metadata, name, value, 0); \
76  openmpt_free_string(value); \
77 } while(0)
78 
80 {
81  AVStream *st;
82  OpenMPTContext *openmpt = s->priv_data;
83  int64_t size;
84  char *buf;
85 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
86  int error;
87 #endif
88  int ret;
89 
90  size = avio_size(s->pb);
91  if (size <= 0)
92  return AVERROR_INVALIDDATA;
93  buf = av_malloc(size);
94  if (!buf)
95  return AVERROR(ENOMEM);
96  size = avio_read(s->pb, buf, size);
97  if (size < 0) {
98  av_log(s, AV_LOG_ERROR, "Reading input buffer failed.\n");
99  av_freep(&buf);
100  return size;
101  }
102 
103 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
104  error = OPENMPT_ERROR_OK;
105  openmpt->module = openmpt_module_create_from_memory2(buf, size, openmpt_logfunc, s, NULL, NULL, &error, NULL, NULL);
106  av_freep(&buf);
107  if (!openmpt->module) {
108  if (error == OPENMPT_ERROR_OUT_OF_MEMORY)
109  return AVERROR(ENOMEM);
110  else if (error >= OPENMPT_ERROR_GENERAL)
111  return AVERROR_INVALIDDATA;
112  else
113  return AVERROR_UNKNOWN;
114  }
115 #else
116  openmpt->module = openmpt_module_create_from_memory(buf, size, openmpt_logfunc, s, NULL);
117  av_freep(&buf);
118  if (!openmpt->module)
119  return AVERROR_INVALIDDATA;
120 #endif
121 
122  if (openmpt->subsong >= openmpt_module_get_num_subsongs(openmpt->module)) {
123  av_log(s, AV_LOG_ERROR, "Invalid subsong index: %d\n", openmpt->subsong);
124  return AVERROR(EINVAL);
125  }
126 
127  if (openmpt->subsong != -2) {
128  if (openmpt->subsong >= 0) {
129  av_dict_set_int(&s->metadata, "track", openmpt->subsong + 1, 0);
130  }
131  ret = openmpt_module_select_subsong(openmpt->module, openmpt->subsong);
132  if (!ret){
133  av_log(s, AV_LOG_ERROR, "Could not select requested subsong: %d", openmpt->subsong);
134  return AVERROR(EINVAL);
135  }
136  }
137 
138  openmpt->duration = openmpt_module_get_duration_seconds(openmpt->module);
139 
140  add_meta(s, "artist", openmpt_module_get_metadata(openmpt->module, "artist"));
141  add_meta(s, "title", openmpt_module_get_metadata(openmpt->module, "title"));
142  add_meta(s, "encoder", openmpt_module_get_metadata(openmpt->module, "tracker"));
143  add_meta(s, "comment", openmpt_module_get_metadata(openmpt->module, "message"));
144  add_meta(s, "date", openmpt_module_get_metadata(openmpt->module, "date"));
145 
146  st = avformat_new_stream(s, NULL);
147  if (!st)
148  return AVERROR(ENOMEM);
149  avpriv_set_pts_info(st, 64, 1, AV_TIME_BASE);
150  st->duration = llrint(openmpt->duration*AV_TIME_BASE);
151 
154  st->codecpar->sample_rate = openmpt->sample_rate;
156  if (ret < 0)
157  return ret;
158 
159  return 0;
160 }
161 
162 #define AUDIO_PKT_SIZE 2048
163 
165 {
166  OpenMPTContext *openmpt = s->priv_data;
167  int n_samples = AUDIO_PKT_SIZE / (openmpt->ch_layout.nb_channels ? openmpt->ch_layout.nb_channels*4 : 4);
168  int ret;
169 
170  if ((ret = av_new_packet(pkt, AUDIO_PKT_SIZE)) < 0)
171  return ret;
172 
173  switch (openmpt->ch_layout.nb_channels) {
174  case 1:
175  ret = openmpt_module_read_float_mono(openmpt->module, openmpt->sample_rate,
176  n_samples, (float *)pkt->data);
177  break;
178  case 2:
179  ret = openmpt_module_read_interleaved_float_stereo(openmpt->module, openmpt->sample_rate,
180  n_samples, (float *)pkt->data);
181  break;
182  case 4:
183  ret = openmpt_module_read_interleaved_float_quad(openmpt->module, openmpt->sample_rate,
184  n_samples, (float *)pkt->data);
185  break;
186  default:
187  av_log(s, AV_LOG_ERROR, "Unsupported number of channels: %d", openmpt->ch_layout.nb_channels);
188  return AVERROR(EINVAL);
189  }
190 
191  if (ret < 1) {
192  pkt->size = 0;
193  return AVERROR_EOF;
194  }
195 
196  pkt->size = ret * (openmpt->ch_layout.nb_channels * 4);
197 
198  return 0;
199 }
200 
202 {
203  OpenMPTContext *openmpt = s->priv_data;
204  if (openmpt->module) {
205  openmpt_module_destroy(openmpt->module);
206  openmpt->module = NULL;
207  }
208  return 0;
209 }
210 
211 static int read_seek_openmpt(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
212 {
213  OpenMPTContext *openmpt = s->priv_data;
214  openmpt_module_set_position_seconds(openmpt->module, (double)ts/AV_TIME_BASE);
215  return 0;
216 }
217 
219 {
220  const char *ext;
221  if (p->filename) {
222  ext = strrchr(p->filename, '.');
223  if (ext && strlen(ext + 1) > 0) {
224  ext++; /* skip '.' */
225  if (openmpt_is_extension_supported(ext) == 1)
227  }
228  }
229  return 0;
230 }
231 
232 static int read_probe_openmpt(const AVProbeData *p)
233 {
234 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
235  int probe_result;
236  if (p->buf && p->buf_size > 0) {
237  probe_result = openmpt_probe_file_header_without_filesize(
238  OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT,
239  p->buf, p->buf_size,
241  if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS) {
242  /* As probing here relies on code external to FFmpeg, do not return
243  * AVPROBE_SCORE_MAX in order to reduce the impact in the rare
244  * cases of false positives.
245  */
246  return AVPROBE_SCORE_MIME + 1;
247  } else if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA) {
248  if (probe_openmpt_extension(p) > 0) {
249  return AVPROBE_SCORE_RETRY;
250  } else {
251  if (p->buf_size >= openmpt_probe_file_header_get_recommended_size()) {
252  /* We have already received the recommended amount of data
253  * and still cannot decide. Return a rather low score.
254  */
255  return AVPROBE_SCORE_RETRY / 2;
256  } else {
257  /* The file extension is unknown and we have very few data
258  * bytes available. libopenmpt cannot decide anything here,
259  * and returning any score > 0 would result in successful
260  * probing of random data.
261  */
262  return 0;
263  }
264  }
265  } else if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE) {
266  return 0;
267  }
268  }
269 #endif
270  /* for older libopenmpt, fall back to file extension probing */
271  return probe_openmpt_extension(p);
272 }
273 
274 static const AVClass class_openmpt = {
275  .class_name = "libopenmpt",
276  .item_name = av_default_item_name,
277  .option = options,
278  .version = LIBAVUTIL_VERSION_INT,
279 };
280 
282  .name = "libopenmpt",
283  .long_name = NULL_IF_CONFIG_SMALL("Tracker formats (libopenmpt)"),
284  .priv_data_size = sizeof(OpenMPTContext),
285  .flags_internal = FF_FMT_INIT_CLEANUP,
291  .priv_class = &class_openmpt,
293  .extensions = "669,amf,ams,dbm,digi,dmf,dsm,dtm,far,gdm,ice,imf,it,j2b,m15,mdl,med,mmcmp,mms,mo3,mod,mptm,mt2,mtm,nst,okt,plm,ppm,psm,pt36,ptm,s3m,sfx,sfx2,st26,stk,stm,stp,ult,umx,wow,xm,xpk",
294 #else
295  .extensions = "669,amf,ams,dbm,digi,dmf,dsm,far,gdm,ice,imf,it,j2b,m15,mdl,med,mmcmp,mms,mo3,mod,mptm,mt2,mtm,nst,okt,plm,ppm,psm,pt36,ptm,s3m,sfx,sfx2,st26,stk,stm,ult,umx,wow,xm,xpk",
296 #endif
297 };
error
static void error(const char *err)
Definition: target_bsf_fuzzer.c:31
openmpt_logfunc
static void openmpt_logfunc(const char *message, void *userdata)
Definition: libopenmpt.c:62
AV_CODEC_ID_PCM_F32BE
@ AV_CODEC_ID_PCM_F32BE
Definition: codec_id.h:346
level
uint8_t level
Definition: svq3.c:204
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
opt.h
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
OpenMPTContext::module
openmpt_module * module
Definition: libopenmpt.c:41
message
Definition: api-threadmessage-test.c:46
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
read_probe_openmpt
static int read_probe_openmpt(const AVProbeData *p)
Definition: libopenmpt.c:232
OpenMPTContext::duration
double duration
Definition: libopenmpt.c:43
AVPacket::data
uint8_t * data
Definition: packet.h:374
AVOption
AVOption.
Definition: opt.h:251
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:456
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:311
avio_size
int64_t avio_size(AVIOContext *s)
Get the filesize.
Definition: aviobuf.c:354
sample_rate
sample_rate
Definition: ffmpeg_filter.c:156
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
OpenMPTContext::subsong
int subsong
Definition: libopenmpt.c:47
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
read_seek
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:151
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:143
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:998
read_packet_openmpt
static int read_packet_openmpt(AVFormatContext *s, AVPacket *pkt)
Definition: libopenmpt.c:164
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
s
#define s(width, name)
Definition: cbs_vp9.c:256
AV_NE
#define AV_NE(be, le)
Definition: macros.h:33
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:97
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:661
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
OFFSET
#define OFFSET(x)
Definition: libopenmpt.c:50
AVProbeData::filename
const char * filename
Definition: avformat.h:454
AUDIO_PKT_SIZE
#define AUDIO_PKT_SIZE
Definition: libopenmpt.c:162
AVFormatContext
Format I/O context.
Definition: avformat.h:1216
OpenMPTContext::ch_layout
AVChannelLayout ch_layout
Definition: libopenmpt.c:46
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1108
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:533
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:453
read_header_openmpt
static int read_header_openmpt(AVFormatContext *s)
Definition: libopenmpt.c:79
probe_openmpt_extension
static int probe_openmpt_extension(const AVProbeData *p)
Definition: libopenmpt.c:218
AV_OPT_TYPE_CHLAYOUT
@ AV_OPT_TYPE_CHLAYOUT
Definition: opt.h:245
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:213
AVPROBE_SCORE_EXTENSION
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:463
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:178
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
ff_libopenmpt_demuxer
const AVInputFormat ff_libopenmpt_demuxer
Definition: libopenmpt.c:281
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
read_close_openmpt
static int read_close_openmpt(AVFormatContext *s)
Definition: libopenmpt.c:201
AVPROBE_SCORE_MIME
#define AVPROBE_SCORE_MIME
score for file mime type
Definition: avformat.h:464
AV_TIME_BASE
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:254
D
#define D
Definition: libopenmpt.c:52
AVPROBE_SCORE_RETRY
#define AVPROBE_SCORE_RETRY
Definition: avformat.h:460
OpenMPTContext
Definition: libopenmpt.c:39
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
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
avformat.h
OPENMPT_API_VERSION_AT_LEAST
#define OPENMPT_API_VERSION_AT_LEAST(major, minor, patch)
Definition: libopenmpt.c:30
channel_layout.h
class_openmpt
static const AVClass class_openmpt
Definition: libopenmpt.c:274
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:643
A
#define A
Definition: libopenmpt.c:51
av_channel_layout_copy
int av_channel_layout_copy(AVChannelLayout *dst, const AVChannelLayout *src)
Make a copy of a channel layout.
Definition: channel_layout.c:639
av_dict_set_int
int av_dict_set_int(AVDictionary **pm, const char *key, int64_t value, int flags)
Convenience wrapper for av_dict_set() that converts the value to a string and stores it.
Definition: dict.c:167
llrint
#define llrint(x)
Definition: libm.h:394
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
read_seek_openmpt
static int read_seek_openmpt(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
Definition: libopenmpt.c:211
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
AV_CODEC_ID_PCM_F32LE
@ AV_CODEC_ID_PCM_F32LE
Definition: codec_id.h:347
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
avstring.h
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:234
OpenMPTContext::sample_rate
int sample_rate
Definition: libopenmpt.c:45
options
static const AVOption options[]
Definition: libopenmpt.c:53
add_meta
#define add_meta(s, name, meta)
Definition: libopenmpt.c:71