2 * This file is part of FFmpeg.
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 * @todo better probing than extensions matching
25 #include <libmodplug/modplug.h>
26 #include "libavutil/avstring.h"
27 #include "libavutil/opt.h"
30 typedef struct ModPlugContext {
33 uint8_t *buf; ///< input file content
44 int max_size; ///< max file size to allocate
47 #define FF_MODPLUG_MAX_FILE_SIZE (100 * 1<<20) // 100M
48 #define FF_MODPLUG_DEF_FILE_SIZE ( 5 * 1<<20) // 5M
50 #define OFFSET(x) offsetof(ModPlugContext, x)
51 #define D AV_OPT_FLAG_DECODING_PARAM
52 static const AVOption options[] = {
53 {"noise_reduction", "Enable noise reduction 0(off)-1(on)", OFFSET(noise_reduction), FF_OPT_TYPE_INT, {.dbl = 0}, 0, 1, D},
54 {"reverb_depth", "Reverb level 0(quiet)-100(loud)", OFFSET(reverb_depth), FF_OPT_TYPE_INT, {.dbl = 0}, 0, 100, D},
55 {"reverb_delay", "Reverb delay in ms, usually 40-200ms", OFFSET(reverb_delay), FF_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, D},
56 {"bass_amount", "XBass level 0(quiet)-100(loud)", OFFSET(bass_amount), FF_OPT_TYPE_INT, {.dbl = 0}, 0, 100, D},
57 {"bass_range", "XBass cutoff in Hz 10-100", OFFSET(bass_range), FF_OPT_TYPE_INT, {.dbl = 0}, 0, 100, D},
58 {"surround_depth", "Surround level 0(quiet)-100(heavy)", OFFSET(surround_depth), FF_OPT_TYPE_INT, {.dbl = 0}, 0, 100, D},
59 {"surround_delay", "Surround delay in ms, usually 5-40ms", OFFSET(surround_delay), FF_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, D},
60 {"max_size", "Max file size supported (in bytes). Default is 5MB. Set to 0 for no limit (not recommended)",
61 OFFSET(max_size), FF_OPT_TYPE_INT, {.dbl = FF_MODPLUG_DEF_FILE_SIZE}, 0, FF_MODPLUG_MAX_FILE_SIZE, D},
65 #define SET_OPT_IF_REQUESTED(libopt, opt, flag) do { \
67 settings.libopt = modplug->opt; \
68 settings.mFlags |= flag; \
72 #define ADD_META_MULTIPLE_ENTRIES(entry_name, fname) do { \
73 if (n_## entry_name ##s) { \
76 for (i = 0; i < n_## entry_name ##s; i++) { \
77 char item_name[64] = {0}; \
78 fname(f, i, item_name); \
82 av_dict_set(&s->metadata, #entry_name, "\n", AV_DICT_APPEND); \
83 av_dict_set(&s->metadata, #entry_name, item_name, AV_DICT_APPEND); \
87 extra = av_asprintf(", %u/%u " #entry_name "%s", \
88 n, n_## entry_name ##s, n > 1 ? "s" : ""); \
90 return AVERROR(ENOMEM); \
91 av_dict_set(&s->metadata, "extra info", extra, AV_DICT_APPEND); \
96 static int modplug_load_metadata(AVFormatContext *s)
98 ModPlugContext *modplug = s->priv_data;
99 ModPlugFile *f = modplug->f;
101 const char *name = ModPlug_GetName(f);
102 const char *msg = ModPlug_GetMessage(f);
104 unsigned n_instruments = ModPlug_NumInstruments(f);
105 unsigned n_samples = ModPlug_NumSamples(f);
106 unsigned n_patterns = ModPlug_NumPatterns(f);
107 unsigned n_channels = ModPlug_NumChannels(f);
109 if (name && *name) av_dict_set(&s->metadata, "name", name, 0);
110 if (msg && *msg) av_dict_set(&s->metadata, "message", msg, 0);
112 extra = av_asprintf("%u pattern%s, %u channel%s",
113 n_patterns, n_patterns > 1 ? "s" : "",
114 n_channels, n_channels > 1 ? "s" : "");
116 return AVERROR(ENOMEM);
117 av_dict_set(&s->metadata, "extra info", extra, AV_DICT_DONT_STRDUP_VAL);
119 ADD_META_MULTIPLE_ENTRIES(instrument, ModPlug_InstrumentName);
120 ADD_META_MULTIPLE_ENTRIES(sample, ModPlug_SampleName);
125 static int modplug_read_header(AVFormatContext *s, AVFormatParameters *ap)
128 AVIOContext *pb = s->pb;
129 ModPlug_Settings settings;
130 ModPlugContext *modplug = s->priv_data;
131 int sz = avio_size(pb);
134 av_log(s, AV_LOG_WARNING, "Could not determine file size\n");
135 sz = modplug->max_size;
136 } else if (modplug->max_size && sz > modplug->max_size) {
137 sz = modplug->max_size;
138 av_log(s, AV_LOG_WARNING, "Max file size reach%s, allocating %dB "
139 "but demuxing is likely to fail due to incomplete buffer\n",
140 sz == FF_MODPLUG_DEF_FILE_SIZE ? " (see -max_size)" : "", sz);
142 modplug->buf = av_malloc(modplug->max_size);
144 return AVERROR(ENOMEM);
145 sz = avio_read(pb, modplug->buf, sz);
147 ModPlug_GetSettings(&settings);
148 settings.mChannels = 2;
150 settings.mFrequency = 44100;
151 settings.mResamplingMode = MODPLUG_RESAMPLE_FIR; // best quality
152 settings.mLoopCount = 0; // prevents looping forever
154 if (modplug->noise_reduction) settings.mFlags |= MODPLUG_ENABLE_NOISE_REDUCTION;
155 SET_OPT_IF_REQUESTED(mReverbDepth, reverb_depth, MODPLUG_ENABLE_REVERB);
156 SET_OPT_IF_REQUESTED(mReverbDelay, reverb_delay, MODPLUG_ENABLE_REVERB);
157 SET_OPT_IF_REQUESTED(mBassAmount, bass_amount, MODPLUG_ENABLE_MEGABASS);
158 SET_OPT_IF_REQUESTED(mBassRange, bass_range, MODPLUG_ENABLE_MEGABASS);
159 SET_OPT_IF_REQUESTED(mSurroundDepth, surround_depth, MODPLUG_ENABLE_SURROUND);
160 SET_OPT_IF_REQUESTED(mSurroundDelay, surround_delay, MODPLUG_ENABLE_SURROUND);
162 if (modplug->reverb_depth) settings.mReverbDepth = modplug->reverb_depth;
163 if (modplug->reverb_delay) settings.mReverbDelay = modplug->reverb_delay;
164 if (modplug->bass_amount) settings.mBassAmount = modplug->bass_amount;
165 if (modplug->bass_range) settings.mBassRange = modplug->bass_range;
166 if (modplug->surround_depth) settings.mSurroundDepth = modplug->surround_depth;
167 if (modplug->surround_delay) settings.mSurroundDelay = modplug->surround_delay;
169 ModPlug_SetSettings(&settings);
171 modplug->f = ModPlug_Load(modplug->buf, sz);
173 return AVERROR_INVALIDDATA;
175 st = av_new_stream(s, 0);
177 return AVERROR(ENOMEM);
178 av_set_pts_info(st, 64, 1, 1000);
179 st->duration = ModPlug_GetLength(modplug->f);
180 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
181 st->codec->codec_id = CODEC_ID_PCM_S16LE;
182 st->codec->channels = settings.mChannels;
183 st->codec->sample_rate = settings.mFrequency;
185 return modplug_load_metadata(s);
188 static int modplug_read_packet(AVFormatContext *s, AVPacket *pkt)
190 ModPlugContext *modplug = s->priv_data;
192 if (av_new_packet(pkt, 512) < 0)
193 return AVERROR(ENOMEM);
195 pkt->size = ModPlug_Read(modplug->f, pkt->data, 512);
196 if (pkt->size <= 0) {
198 return pkt->size == 0 ? AVERROR_EOF : AVERROR(EIO);
203 static int modplug_read_close(AVFormatContext *s)
205 ModPlugContext *modplug = s->priv_data;
206 ModPlug_Unload(modplug->f);
207 av_freep(&modplug->buf);
211 static int modplug_read_seek(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
213 const ModPlugContext *modplug = s->priv_data;
214 ModPlug_Seek(modplug->f, (int)ts);
218 static const AVClass modplug_class = {
219 .class_name = "ModPlug demuxer",
220 .item_name = av_default_item_name,
222 .version = LIBAVUTIL_VERSION_INT,
225 AVInputFormat ff_libmodplug_demuxer = {
226 .name = "libmodplug",
227 .long_name = NULL_IF_CONFIG_SMALL("ModPlug demuxer"),
228 .priv_data_size = sizeof(ModPlugContext),
229 .read_header = modplug_read_header,
230 .read_packet = modplug_read_packet,
231 .read_close = modplug_read_close,
232 .read_seek = modplug_read_seek,
233 .extensions = "669,abc,amf,ams,dbm,dmf,dsm,far,it,mdl,med,mid,mod,mt2,mtm,okt,psm,ptm,s3m,stm,ult,umx,xm"
234 ",itgz,itr,itz,mdgz,mdr,mdz,s3gz,s3r,s3z,xmgz,xmr,xmz", // compressed mods
235 .priv_class = &modplug_class,