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  int channels;
44  double duration;
45  /* options */
47  int64_t layout;
48  int subsong;
50 
51 #define OFFSET(x) offsetof(OpenMPTContext, x)
52 #define A AV_OPT_FLAG_AUDIO_PARAM
53 #define D AV_OPT_FLAG_DECODING_PARAM
54 static const AVOption options[] = {
55  { "sample_rate", "set sample rate", OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 48000 }, 1000, INT_MAX, A | D },
56  { "layout", "set channel layout", OFFSET(layout), AV_OPT_TYPE_CHANNEL_LAYOUT, { .i64 = AV_CH_LAYOUT_STEREO }, 0, INT64_MAX, A | D },
57  { "subsong", "set subsong", OFFSET(subsong), AV_OPT_TYPE_INT, { .i64 = -2 }, -2, INT_MAX, A | D, "subsong"},
58  { "all", "all", 0, AV_OPT_TYPE_CONST, { .i64 = -1}, 0, 0, A | D, "subsong" },
59  { "auto", "auto", 0, AV_OPT_TYPE_CONST, { .i64 = -2}, 0, 0, A | D, "subsong" },
60  { NULL }
61 };
62 
63 static void openmpt_logfunc(const char *message, void *userdata)
64 {
65  int level = AV_LOG_INFO;
66  if (strstr(message, "ERROR") != NULL) {
68  }
69  av_log(userdata, level, "%s\n", message);
70 }
71 
72 #define add_meta(s, name, meta) \
73 do { \
74  const char *value = meta; \
75  if (value && value[0]) \
76  av_dict_set(&s->metadata, name, value, 0); \
77  openmpt_free_string(value); \
78 } while(0)
79 
81 {
82  AVStream *st;
83  OpenMPTContext *openmpt = s->priv_data;
84  int64_t size;
85  char *buf;
86 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
87  int error;
88 #endif
89  int ret;
90 
91  size = avio_size(s->pb);
92  if (size <= 0)
93  return AVERROR_INVALIDDATA;
94  buf = av_malloc(size);
95  if (!buf)
96  return AVERROR(ENOMEM);
97  size = avio_read(s->pb, buf, size);
98  if (size < 0) {
99  av_log(s, AV_LOG_ERROR, "Reading input buffer failed.\n");
100  av_freep(&buf);
101  return size;
102  }
103 
104 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
105  error = OPENMPT_ERROR_OK;
106  openmpt->module = openmpt_module_create_from_memory2(buf, size, openmpt_logfunc, s, NULL, NULL, &error, NULL, NULL);
107  av_freep(&buf);
108  if (!openmpt->module) {
109  if (error == OPENMPT_ERROR_OUT_OF_MEMORY)
110  return AVERROR(ENOMEM);
111  else if (error >= OPENMPT_ERROR_GENERAL)
112  return AVERROR_INVALIDDATA;
113  else
114  return AVERROR_UNKNOWN;
115  }
116 #else
117  openmpt->module = openmpt_module_create_from_memory(buf, size, openmpt_logfunc, s, NULL);
118  av_freep(&buf);
119  if (!openmpt->module)
120  return AVERROR_INVALIDDATA;
121 #endif
122 
124 
125  if (openmpt->subsong >= openmpt_module_get_num_subsongs(openmpt->module)) {
126  av_log(s, AV_LOG_ERROR, "Invalid subsong index: %d\n", openmpt->subsong);
127  return AVERROR(EINVAL);
128  }
129 
130  if (openmpt->subsong != -2) {
131  if (openmpt->subsong >= 0) {
132  av_dict_set_int(&s->metadata, "track", openmpt->subsong + 1, 0);
133  }
134  ret = openmpt_module_select_subsong(openmpt->module, openmpt->subsong);
135  if (!ret){
136  av_log(s, AV_LOG_ERROR, "Could not select requested subsong: %d", openmpt->subsong);
137  return AVERROR(EINVAL);
138  }
139  }
140 
141  openmpt->duration = openmpt_module_get_duration_seconds(openmpt->module);
142 
143  add_meta(s, "artist", openmpt_module_get_metadata(openmpt->module, "artist"));
144  add_meta(s, "title", openmpt_module_get_metadata(openmpt->module, "title"));
145  add_meta(s, "encoder", openmpt_module_get_metadata(openmpt->module, "tracker"));
146  add_meta(s, "comment", openmpt_module_get_metadata(openmpt->module, "message"));
147  add_meta(s, "date", openmpt_module_get_metadata(openmpt->module, "date"));
148 
149  st = avformat_new_stream(s, NULL);
150  if (!st)
151  return AVERROR(ENOMEM);
152  avpriv_set_pts_info(st, 64, 1, AV_TIME_BASE);
153  st->duration = llrint(openmpt->duration*AV_TIME_BASE);
154 
157  st->codecpar->channels = openmpt->channels;
158  st->codecpar->sample_rate = openmpt->sample_rate;
159 
160  return 0;
161 }
162 
163 #define AUDIO_PKT_SIZE 2048
164 
166 {
167  OpenMPTContext *openmpt = s->priv_data;
168  int n_samples = AUDIO_PKT_SIZE / (openmpt->channels ? openmpt->channels*4 : 4);
169  int ret;
170 
171  if ((ret = av_new_packet(pkt, AUDIO_PKT_SIZE)) < 0)
172  return ret;
173 
174  switch (openmpt->channels) {
175  case 1:
176  ret = openmpt_module_read_float_mono(openmpt->module, openmpt->sample_rate,
177  n_samples, (float *)pkt->data);
178  break;
179  case 2:
180  ret = openmpt_module_read_interleaved_float_stereo(openmpt->module, openmpt->sample_rate,
181  n_samples, (float *)pkt->data);
182  break;
183  case 4:
184  ret = openmpt_module_read_interleaved_float_quad(openmpt->module, openmpt->sample_rate,
185  n_samples, (float *)pkt->data);
186  break;
187  default:
188  av_log(s, AV_LOG_ERROR, "Unsupported number of channels: %d", openmpt->channels);
189  return AVERROR(EINVAL);
190  }
191 
192  if (ret < 1) {
193  pkt->size = 0;
194  return AVERROR_EOF;
195  }
196 
197  pkt->size = ret * (openmpt->channels * 4);
198 
199  return 0;
200 }
201 
203 {
204  OpenMPTContext *openmpt = s->priv_data;
205  if (openmpt->module) {
206  openmpt_module_destroy(openmpt->module);
207  openmpt->module = NULL;
208  }
209  return 0;
210 }
211 
212 static int read_seek_openmpt(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
213 {
214  OpenMPTContext *openmpt = s->priv_data;
215  openmpt_module_set_position_seconds(openmpt->module, (double)ts/AV_TIME_BASE);
216  return 0;
217 }
218 
220 {
221  const char *ext;
222  if (p->filename) {
223  ext = strrchr(p->filename, '.');
224  if (ext && strlen(ext + 1) > 0) {
225  ext++; /* skip '.' */
226  if (openmpt_is_extension_supported(ext) == 1)
228  }
229  }
230  return 0;
231 }
232 
233 static int read_probe_openmpt(const AVProbeData *p)
234 {
235 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
236  int probe_result;
237  if (p->buf && p->buf_size > 0) {
238  probe_result = openmpt_probe_file_header_without_filesize(
239  OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT,
240  p->buf, p->buf_size,
242  if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS) {
243  /* As probing here relies on code external to FFmpeg, do not return
244  * AVPROBE_SCORE_MAX in order to reduce the impact in the rare
245  * cases of false positives.
246  */
247  return AVPROBE_SCORE_MIME + 1;
248  } else if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA) {
249  if (probe_openmpt_extension(p) > 0) {
250  return AVPROBE_SCORE_RETRY;
251  } else {
252  if (p->buf_size >= openmpt_probe_file_header_get_recommended_size()) {
253  /* We have already received the recommended amount of data
254  * and still cannot decide. Return a rather low score.
255  */
256  return AVPROBE_SCORE_RETRY / 2;
257  } else {
258  /* The file extension is unknown and we have very few data
259  * bytes available. libopenmpt cannot decide anything here,
260  * and returning any score > 0 would result in successful
261  * probing of random data.
262  */
263  return 0;
264  }
265  }
266  } else if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE) {
267  return 0;
268  }
269  }
270 #endif
271  /* for older libopenmpt, fall back to file extension probing */
272  return probe_openmpt_extension(p);
273 }
274 
275 static const AVClass class_openmpt = {
276  .class_name = "libopenmpt",
277  .item_name = av_default_item_name,
278  .option = options,
279  .version = LIBAVUTIL_VERSION_INT,
280 };
281 
283  .name = "libopenmpt",
284  .long_name = NULL_IF_CONFIG_SMALL("Tracker formats (libopenmpt)"),
285  .priv_data_size = sizeof(OpenMPTContext),
286  .flags_internal = FF_FMT_INIT_CLEANUP,
292  .priv_class = &class_openmpt,
294  .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",
295 #else
296  .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",
297 #endif
298 };
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:63
AV_CODEC_ID_PCM_F32BE
@ AV_CODEC_ID_PCM_F32BE
Definition: codec_id.h:334
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:48
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: utils.c:760
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
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:233
OpenMPTContext::duration
double duration
Definition: libopenmpt.c:44
AVPacket::data
uint8_t * data
Definition: packet.h:373
AVOption
AVOption.
Definition: opt.h:247
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:450
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
avio_size
int64_t avio_size(AVIOContext *s)
Get the filesize.
Definition: aviobuf.c:352
sample_rate
sample_rate
Definition: ffmpeg_filter.c:156
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:31
OpenMPTContext::subsong
int subsong
Definition: libopenmpt.c:48
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
read_seek
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:149
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:141
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:978
read_packet_openmpt
static int read_packet_openmpt(AVFormatContext *s, AVPacket *pkt)
Definition: libopenmpt.c:165
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:91
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:643
s
#define s(width, name)
Definition: cbs_vp9.c:257
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:99
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:648
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:449
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
OFFSET
#define OFFSET(x)
Definition: libopenmpt.c:51
AVProbeData::filename
const char * filename
Definition: avformat.h:448
AUDIO_PKT_SIZE
#define AUDIO_PKT_SIZE
Definition: libopenmpt.c:163
AVFormatContext
Format I/O context.
Definition: avformat.h:1193
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1088
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
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:235
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:447
read_header_openmpt
static int read_header_openmpt(AVFormatContext *s)
Definition: libopenmpt.c:80
probe_openmpt_extension
static int probe_openmpt_extension(const AVProbeData *p)
Definition: libopenmpt.c:219
AVPROBE_SCORE_EXTENSION
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:457
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
av_get_channel_layout_nb_channels
int av_get_channel_layout_nb_channels(uint64_t channel_layout)
Return the number of channels in the channel layout.
Definition: channel_layout.c:226
AVPacket::size
int size
Definition: packet.h:374
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
OpenMPTContext::layout
int64_t layout
Definition: libopenmpt.c:47
size
int size
Definition: twinvq_data.h:10344
AV_OPT_TYPE_CHANNEL_LAYOUT
@ AV_OPT_TYPE_CHANNEL_LAYOUT
Definition: opt.h:240
ff_libopenmpt_demuxer
const AVInputFormat ff_libopenmpt_demuxer
Definition: libopenmpt.c:282
OpenMPTContext::channels
int channels
Definition: libopenmpt.c:43
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
layout
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 layout
Definition: filter_design.txt:18
read_close_openmpt
static int read_close_openmpt(AVFormatContext *s)
Definition: libopenmpt.c:202
AVPROBE_SCORE_MIME
#define AVPROBE_SCORE_MIME
score for file mime type
Definition: avformat.h:458
AV_TIME_BASE
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:254
D
#define D
Definition: libopenmpt.c:53
AVPROBE_SCORE_RETRY
#define AVPROBE_SCORE_RETRY
Definition: avformat.h:454
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:928
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:275
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:641
A
#define A
Definition: libopenmpt.c:52
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:1186
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:147
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:60
AVPacket
This structure stores compressed data.
Definition: packet.h:350
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
read_seek_openmpt
static int read_seek_openmpt(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
Definition: libopenmpt.c:212
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
AV_CODEC_ID_PCM_F32LE
@ AV_CODEC_ID_PCM_F32LE
Definition: codec_id.h:335
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
avstring.h
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
OpenMPTContext::sample_rate
int sample_rate
Definition: libopenmpt.c:46
options
static const AVOption options[]
Definition: libopenmpt.c:54
add_meta
#define add_meta(s, name, meta)
Definition: libopenmpt.c:72