1 /*
2 * This file is part of FFmpeg.
3 *
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.
8 *
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.
13 *
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
17 */
18
19 /**
20 * @file
21 * ModPlug demuxer
22 * @todo better probing than extensions matching
23 */
24
25 #define MODPLUG_STATIC
26 #include <libmodplug/modplug.h>
27 #include "libavutil/avstring.h"
28 #include "libavutil/eval.h"
29 #include "libavutil/opt.h"
30 #include "avformat.h"
31 #include "internal.h"
32
33 typedef struct ModPlugContext {
34 const AVClass *class;
35 ModPlugFile *f;
36 uint8_t *buf; ///< input file content
37
38 /* options */
39 int noise_reduction;
40 int reverb_depth;
41 int reverb_delay;
42 int bass_amount;
43 int bass_range;
44 int surround_depth;
45 int surround_delay;
46
47 int max_size; ///< max file size to allocate
48
49 /* optional video stream */
50 double ts_per_packet; ///< used to define the pts/dts using packet_count;
51 int packet_count; ///< total number of audio packets
52 int print_textinfo; ///< bool flag for printing speed, tempo, order, ...
53 int video_stream; ///< 1 if the user want a video stream, otherwise 0
54 int w; ///< video stream width in char (one char = 8x8px)
55 int h; ///< video stream height in char (one char = 8x8px)
56 int video_switch; ///< 1 if current packet is video, otherwise 0
57 int fsize; ///< constant frame size
58 int linesize; ///< line size in bytes
59 char *color_eval; ///< color eval user input expression
60 AVExpr *expr; ///< parsed color eval expression
61 } ModPlugContext;
62
63 static const char * const var_names[] = {
64 "x", "y",
65 "w", "h",
66 "t",
67 "speed", "tempo", "order", "pattern", "row",
68 NULL
69 };
70
71 enum var_name {
72 VAR_X, VAR_Y,
73 VAR_W, VAR_H,
74 VAR_TIME,
75 VAR_SPEED, VAR_TEMPO, VAR_ORDER, VAR_PATTERN, VAR_ROW,
76 VAR_VARS_NB
77 };
78
79 #define FF_MODPLUG_MAX_FILE_SIZE (100 * 1<<20) // 100M
80 #define FF_MODPLUG_DEF_FILE_SIZE ( 5 * 1<<20) // 5M
81
82 #define OFFSET(x) offsetof(ModPlugContext, x)
83 #define D AV_OPT_FLAG_DECODING_PARAM
84 static const AVOption options[] = {
85 {"noise_reduction", "Enable noise reduction 0(off)-1(on)", OFFSET(noise_reduction), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D},
86 {"reverb_depth", "Reverb level 0(quiet)-100(loud)", OFFSET(reverb_depth), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100, D},
87 {"reverb_delay", "Reverb delay in ms, usually 40-200ms", OFFSET(reverb_delay), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D},
88 {"bass_amount", "XBass level 0(quiet)-100(loud)", OFFSET(bass_amount), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100, D},
89 {"bass_range", "XBass cutoff in Hz 10-100", OFFSET(bass_range), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100, D},
90 {"surround_depth", "Surround level 0(quiet)-100(heavy)", OFFSET(surround_depth), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100, D},
91 {"surround_delay", "Surround delay in ms, usually 5-40ms", OFFSET(surround_delay), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D},
92 {"max_size", "Max file size supported (in bytes). Default is 5MB. Set to 0 for no limit (not recommended)",
93 OFFSET(max_size), AV_OPT_TYPE_INT, {.i64 = FF_MODPLUG_DEF_FILE_SIZE}, 0, FF_MODPLUG_MAX_FILE_SIZE, D},
94 {"video_stream_expr", "Color formula", OFFSET(color_eval), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, D},
95 {"video_stream", "Make demuxer output a video stream", OFFSET(video_stream), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D},
96 {"video_stream_w", "Video stream width in char (one char = 8x8px)", OFFSET(w), AV_OPT_TYPE_INT, {.i64 = 30}, 20, 512, D},
97 {"video_stream_h", "Video stream height in char (one char = 8x8px)", OFFSET(h), AV_OPT_TYPE_INT, {.i64 = 30}, 20, 512, D},
98 {"video_stream_ptxt", "Print speed, tempo, order, ... in video stream", OFFSET(print_textinfo), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, D},
99 {NULL},
100 };
101
modplug_read_close(AVFormatContext * s)102 static int modplug_read_close(AVFormatContext *s)
103 {
104 ModPlugContext *modplug = s->priv_data;
105 ModPlug_Unload(modplug->f);
106 av_freep(&modplug->buf);
107 return 0;
108 }
109
110 #define SET_OPT_IF_REQUESTED(libopt, opt, flag) do { \
111 if (modplug->opt) { \
112 settings.libopt = modplug->opt; \
113 settings.mFlags |= flag; \
114 } \
115 } while (0)
116
117 #define ADD_META_MULTIPLE_ENTRIES(entry_name, fname) do { \
118 if (n_## entry_name ##s) { \
119 unsigned i, n = 0; \
120 \
121 for (i = 0; i < n_## entry_name ##s; i++) { \
122 char item_name[64] = {0}; \
123 fname(f, i, item_name); \
124 if (!*item_name) \
125 continue; \
126 if (n) \
127 av_dict_set(&s->metadata, #entry_name, "\n", AV_DICT_APPEND); \
128 av_dict_set(&s->metadata, #entry_name, item_name, AV_DICT_APPEND); \
129 n++; \
130 } \
131 \
132 extra = av_asprintf(", %u/%u " #entry_name "%s", \
133 n, n_## entry_name ##s, n > 1 ? "s" : ""); \
134 if (!extra) \
135 return AVERROR(ENOMEM); \
136 av_dict_set(&s->metadata, "extra info", extra, AV_DICT_APPEND); \
137 av_free(extra); \
138 } \
139 } while (0)
140
modplug_load_metadata(AVFormatContext * s)141 static int modplug_load_metadata(AVFormatContext *s)
142 {
143 ModPlugContext *modplug = s->priv_data;
144 ModPlugFile *f = modplug->f;
145 char *extra;
146 const char *name = ModPlug_GetName(f);
147 const char *msg = ModPlug_GetMessage(f);
148
149 unsigned n_instruments = ModPlug_NumInstruments(f);
150 unsigned n_samples = ModPlug_NumSamples(f);
151 unsigned n_patterns = ModPlug_NumPatterns(f);
152 unsigned n_channels = ModPlug_NumChannels(f);
153
154 if (name && *name) av_dict_set(&s->metadata, "name", name, 0);
155 if (msg && *msg) av_dict_set(&s->metadata, "message", msg, 0);
156
157 extra = av_asprintf("%u pattern%s, %u channel%s",
158 n_patterns, n_patterns > 1 ? "s" : "",
159 n_channels, n_channels > 1 ? "s" : "");
160 if (!extra)
161 return AVERROR(ENOMEM);
162 av_dict_set(&s->metadata, "extra info", extra, AV_DICT_DONT_STRDUP_VAL);
163
164 ADD_META_MULTIPLE_ENTRIES(instrument, ModPlug_InstrumentName);
165 ADD_META_MULTIPLE_ENTRIES(sample, ModPlug_SampleName);
166
167 return 0;
168 }
169
170 #define AUDIO_PKT_SIZE 512
171
modplug_read_header(AVFormatContext * s)172 static int modplug_read_header(AVFormatContext *s)
173 {
174 AVStream *st;
175 AVIOContext *pb = s->pb;
176 ModPlug_Settings settings;
177 ModPlugContext *modplug = s->priv_data;
178 int64_t sz = avio_size(pb);
179 int ret;
180
181 if (sz < 0) {
182 av_log(s, AV_LOG_WARNING, "Could not determine file size\n");
183 sz = modplug->max_size;
184 } else if (modplug->max_size && sz > modplug->max_size) {
185 sz = modplug->max_size;
186 av_log(s, AV_LOG_WARNING, "Max file size reach%s, allocating %"PRIi64"B "
187 "but demuxing is likely to fail due to incomplete buffer\n",
188 sz == FF_MODPLUG_DEF_FILE_SIZE ? " (see -max_size)" : "", sz);
189 }
190
191 if (modplug->color_eval) {
192 int r = av_expr_parse(&modplug->expr, modplug->color_eval, var_names,
193 NULL, NULL, NULL, NULL, 0, s);
194 if (r < 0)
195 return r;
196 }
197
198 modplug->buf = av_malloc(modplug->max_size);
199 if (!modplug->buf)
200 return AVERROR(ENOMEM);
201 sz = avio_read(pb, modplug->buf, sz);
202
203 ModPlug_GetSettings(&settings);
204 settings.mChannels = 2;
205 settings.mBits = 16;
206 settings.mFrequency = 44100;
207 settings.mResamplingMode = MODPLUG_RESAMPLE_FIR; // best quality
208 settings.mLoopCount = 0; // prevents looping forever
209
210 if (modplug->noise_reduction) settings.mFlags |= MODPLUG_ENABLE_NOISE_REDUCTION;
211 SET_OPT_IF_REQUESTED(mReverbDepth, reverb_depth, MODPLUG_ENABLE_REVERB);
212 SET_OPT_IF_REQUESTED(mReverbDelay, reverb_delay, MODPLUG_ENABLE_REVERB);
213 SET_OPT_IF_REQUESTED(mBassAmount, bass_amount, MODPLUG_ENABLE_MEGABASS);
214 SET_OPT_IF_REQUESTED(mBassRange, bass_range, MODPLUG_ENABLE_MEGABASS);
215 SET_OPT_IF_REQUESTED(mSurroundDepth, surround_depth, MODPLUG_ENABLE_SURROUND);
216 SET_OPT_IF_REQUESTED(mSurroundDelay, surround_delay, MODPLUG_ENABLE_SURROUND);
217
218 if (modplug->reverb_depth) settings.mReverbDepth = modplug->reverb_depth;
219 if (modplug->reverb_delay) settings.mReverbDelay = modplug->reverb_delay;
220 if (modplug->bass_amount) settings.mBassAmount = modplug->bass_amount;
221 if (modplug->bass_range) settings.mBassRange = modplug->bass_range;
222 if (modplug->surround_depth) settings.mSurroundDepth = modplug->surround_depth;
223 if (modplug->surround_delay) settings.mSurroundDelay = modplug->surround_delay;
224
225 ModPlug_SetSettings(&settings);
226
227 modplug->f = ModPlug_Load(modplug->buf, sz);
228 if (!modplug->f) {
229 av_freep(&modplug->buf);
230 return AVERROR_INVALIDDATA;
231 }
232 st = avformat_new_stream(s, NULL);
233 if (!st) {
234 ret = AVERROR(ENOMEM);
235 goto fail;
236 }
237 avpriv_set_pts_info(st, 64, 1, 1000);
238 st->duration = ModPlug_GetLength(modplug->f);
239 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
240 st->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
241 st->codecpar->channels = settings.mChannels;
242 st->codecpar->sample_rate = settings.mFrequency;
243
244 // timebase = 1/1000, 2ch 16bits 44.1kHz-> 2*2*44100
245 modplug->ts_per_packet = 1000*AUDIO_PKT_SIZE / (4*44100.);
246
247 if (modplug->video_stream) {
248 AVStream *vst = avformat_new_stream(s, NULL);
249 if (!vst) {
250 ret = AVERROR(ENOMEM);
251 goto fail;
252 }
253 avpriv_set_pts_info(vst, 64, 1, 1000);
254 vst->duration = st->duration;
255 vst->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
256 vst->codecpar->codec_id = AV_CODEC_ID_XBIN;
257 vst->codecpar->width = modplug->w << 3;
258 vst->codecpar->height = modplug->h << 3;
259 modplug->linesize = modplug->w * 3;
260 modplug->fsize = modplug->linesize * modplug->h;
261 }
262
263 ret = modplug_load_metadata(s);
264 if (ret < 0)
265 goto fail;
266 return 0;
267 fail:
268 modplug_read_close(s);
269 return ret;
270 }
271
write_text(uint8_t * dst,const char * s,int linesize,int x,int y)272 static void write_text(uint8_t *dst, const char *s, int linesize, int x, int y)
273 {
274 int i;
275 dst += y*linesize + x*3;
276 for (i = 0; s[i]; i++, dst += 3) {
277 dst[0] = 0x0; // count - 1
278 dst[1] = s[i]; // char
279 dst[2] = 0x0f; // background / foreground
280 }
281 }
282
283 #define PRINT_INFO(line, name, idvalue) do { \
284 snprintf(intbuf, sizeof(intbuf), "%.0f", var_values[idvalue]); \
285 write_text(pkt->data, name ":", modplug->linesize, 0+1, line+1); \
286 write_text(pkt->data, intbuf, modplug->linesize, 10+1, line+1); \
287 } while (0)
288
modplug_read_packet(AVFormatContext * s,AVPacket * pkt)289 static int modplug_read_packet(AVFormatContext *s, AVPacket *pkt)
290 {
291 ModPlugContext *modplug = s->priv_data;
292 int ret;
293
294 if (modplug->video_stream) {
295 modplug->video_switch ^= 1; // one video packet for one audio packet
296 if (modplug->video_switch) {
297 double var_values[VAR_VARS_NB];
298
299 var_values[VAR_W ] = modplug->w;
300 var_values[VAR_H ] = modplug->h;
301 var_values[VAR_TIME ] = modplug->packet_count * modplug->ts_per_packet;
302 var_values[VAR_SPEED ] = ModPlug_GetCurrentSpeed (modplug->f);
303 var_values[VAR_TEMPO ] = ModPlug_GetCurrentTempo (modplug->f);
304 var_values[VAR_ORDER ] = ModPlug_GetCurrentOrder (modplug->f);
305 var_values[VAR_PATTERN] = ModPlug_GetCurrentPattern(modplug->f);
306 var_values[VAR_ROW ] = ModPlug_GetCurrentRow (modplug->f);
307
308 if ((ret = av_new_packet(pkt, modplug->fsize)) < 0)
309 return ret;
310 pkt->stream_index = 1;
311 memset(pkt->data, 0, modplug->fsize);
312
313 if (modplug->print_textinfo) {
314 char intbuf[32];
315 PRINT_INFO(0, "speed", VAR_SPEED);
316 PRINT_INFO(1, "tempo", VAR_TEMPO);
317 PRINT_INFO(2, "order", VAR_ORDER);
318 PRINT_INFO(3, "pattern", VAR_PATTERN);
319 PRINT_INFO(4, "row", VAR_ROW);
320 PRINT_INFO(5, "ts", VAR_TIME);
321 }
322
323 if (modplug->expr) {
324 int x, y;
325 for (y = 0; y < modplug->h; y++) {
326 for (x = 0; x < modplug->w; x++) {
327 double color;
328 var_values[VAR_X] = x;
329 var_values[VAR_Y] = y;
330 color = av_expr_eval(modplug->expr, var_values, NULL);
331 pkt->data[y*modplug->linesize + x*3 + 2] |= av_clip((int)color, 0, 0xf)<<4;
332 }
333 }
334 }
335 pkt->pts = pkt->dts = var_values[VAR_TIME];
336 pkt->flags |= AV_PKT_FLAG_KEY;
337 return 0;
338 }
339 }
340
341 if ((ret = av_new_packet(pkt, AUDIO_PKT_SIZE)) < 0)
342 return ret;
343
344 if (modplug->video_stream)
345 pkt->pts = pkt->dts = modplug->packet_count++ * modplug->ts_per_packet;
346
347 pkt->size = ModPlug_Read(modplug->f, pkt->data, AUDIO_PKT_SIZE);
348 if (pkt->size <= 0) {
349 return pkt->size == 0 ? AVERROR_EOF : AVERROR(EIO);
350 }
351 return 0;
352 }
353
modplug_read_seek(AVFormatContext * s,int stream_idx,int64_t ts,int flags)354 static int modplug_read_seek(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
355 {
356 ModPlugContext *modplug = s->priv_data;
357 ModPlug_Seek(modplug->f, (int)ts);
358 if (modplug->video_stream)
359 modplug->packet_count = ts / modplug->ts_per_packet;
360 return 0;
361 }
362
363 static const char modplug_extensions[] = "669,abc,amf,ams,dbm,dmf,dsm,far,it,mdl,med,mid,mod,mt2,mtm,okt,psm,ptm,s3m,stm,ult,umx,xm,itgz,itr,itz,mdgz,mdr,mdz,s3gz,s3r,s3z,xmgz,xmr,xmz";
364
modplug_probe(const AVProbeData * p)365 static int modplug_probe(const AVProbeData *p)
366 {
367 if (av_match_ext(p->filename, modplug_extensions)) {
368 if (p->buf_size < 16384)
369 return AVPROBE_SCORE_EXTENSION/2-1;
370 else
371 return AVPROBE_SCORE_EXTENSION;
372 }
373 return 0;
374 }
375
376 static const AVClass modplug_class = {
377 .class_name = "ModPlug demuxer",
378 .item_name = av_default_item_name,
379 .option = options,
380 .version = LIBAVUTIL_VERSION_INT,
381 };
382
383 AVInputFormat ff_libmodplug_demuxer = {
384 .name = "libmodplug",
385 .long_name = NULL_IF_CONFIG_SMALL("ModPlug demuxer"),
386 .priv_data_size = sizeof(ModPlugContext),
387 .read_probe = modplug_probe,
388 .read_header = modplug_read_header,
389 .read_packet = modplug_read_packet,
390 .read_close = modplug_read_close,
391 .read_seek = modplug_read_seek,
392 .extensions = modplug_extensions,
393 .priv_class = &modplug_class,
394 };
395