3b7e2433a46a7c8f6f0fc5b3653fb2cd33b752b9
[ffmpeg.git] / libavformat / libmodplug.c
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 */
23
24 #include <libmodplug/modplug.h>
25 #include "libavutil/avstring.h"
26 #include "libavutil/opt.h"
27 #include "avformat.h"
28
29 typedef struct ModPlugContext {
30     const AVClass *class;
31     ModPlugFile *f;
32     uint8_t *buf; ///< input file content
33
34     /* options */
35     int noise_reduction;
36     int reverb_depth;
37     int reverb_delay;
38     int bass_amount;
39     int bass_range;
40     int surround_depth;
41     int surround_delay;
42
43     int max_size; ///< max file size to allocate
44 } ModPlugContext;
45
46 #define FF_MODPLUG_MAX_FILE_SIZE (100 * 1<<20) // 100M
47 #define FF_MODPLUG_DEF_FILE_SIZE (  5 * 1<<20) //   5M
48
49 #define OFFSET(x) offsetof(ModPlugContext, x)
50 #define D AV_OPT_FLAG_DECODING_PARAM
51 static const AVOption options[] = {
52     {"noise_reduction", "Enable noise reduction 0(off)-1(on)",  OFFSET(noise_reduction), FF_OPT_TYPE_INT, {.dbl = 0}, 0,       1, D},
53     {"reverb_depth",    "Reverb level 0(quiet)-100(loud)",      OFFSET(reverb_depth),    FF_OPT_TYPE_INT, {.dbl = 0}, 0,     100, D},
54     {"reverb_delay",    "Reverb delay in ms, usually 40-200ms", OFFSET(reverb_delay),    FF_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, D},
55     {"bass_amount",     "XBass level 0(quiet)-100(loud)",       OFFSET(bass_amount),     FF_OPT_TYPE_INT, {.dbl = 0}, 0,     100, D},
56     {"bass_range",      "XBass cutoff in Hz 10-100",            OFFSET(bass_range),      FF_OPT_TYPE_INT, {.dbl = 0}, 0,     100, D},
57     {"surround_depth",  "Surround level 0(quiet)-100(heavy)",   OFFSET(surround_depth),  FF_OPT_TYPE_INT, {.dbl = 0}, 0,     100, D},
58     {"surround_delay",  "Surround delay in ms, usually 5-40ms", OFFSET(surround_delay),  FF_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, D},
59     {"max_size",        "Max file size supported (in bytes). Default is 5MB. Set to 0 for no limit (not recommended)",
60      OFFSET(max_size), FF_OPT_TYPE_INT, {.dbl = FF_MODPLUG_DEF_FILE_SIZE}, 0, FF_MODPLUG_MAX_FILE_SIZE, D},
61     {NULL},
62 };
63
64 #define SET_OPT_IF_REQUESTED(libopt, opt, flag) do {        \
65     if (modplug->opt) {                                     \
66         settings.libopt  = modplug->opt;                    \
67         settings.mFlags |= flag;                            \
68     }                                                       \
69 } while (0)
70
71 #define ADD_META_MULTIPLE_ENTRIES(entry_name, fname) do {                      \
72     if (n_## entry_name ##s) {                                                 \
73         unsigned i, n = 0;                                                     \
74                                                                                \
75         for (i = 0; i < n_## entry_name ##s; i++) {                            \
76             char item_name[64] = {0};                                          \
77             fname(f, i, item_name);                                            \
78             if (!*item_name)                                                   \
79                 continue;                                                      \
80             if (n)                                                             \
81                 av_dict_set(&s->metadata, #entry_name, "\n", AV_DICT_APPEND);  \
82             av_dict_set(&s->metadata, #entry_name, item_name, AV_DICT_APPEND); \
83             n++;                                                               \
84         }                                                                      \
85                                                                                \
86         extra = av_asprintf(", %u/%u " #entry_name "%s",                       \
87                             n, n_## entry_name ##s, n > 1 ? "s" : "");         \
88         if (!extra)                                                            \
89             return AVERROR(ENOMEM);                                            \
90         av_dict_set(&s->metadata, "extra info", extra, AV_DICT_APPEND);        \
91         av_free(extra);                                                        \
92     }                                                                          \
93 } while (0)
94
95 static int modplug_load_metadata(AVFormatContext *s)
96 {
97     ModPlugContext *modplug = s->priv_data;
98     ModPlugFile *f = modplug->f;
99     char *extra;
100     const char *name = ModPlug_GetName(f);
101     const char *msg  = ModPlug_GetMessage(f);
102
103     unsigned n_instruments = ModPlug_NumInstruments(f);
104     unsigned n_samples     = ModPlug_NumSamples(f);
105     unsigned n_patterns    = ModPlug_NumPatterns(f);
106     unsigned n_channels    = ModPlug_NumChannels(f);
107
108     if (name && *name) av_dict_set(&s->metadata, "name",    name, 0);
109     if (msg  && *msg)  av_dict_set(&s->metadata, "message", msg,  0);
110
111     extra = av_asprintf("%u pattern%s, %u channel%s",
112                         n_patterns, n_patterns > 1 ? "s" : "",
113                         n_channels, n_channels > 1 ? "s" : "");
114     if (!extra)
115         return AVERROR(ENOMEM);
116     av_dict_set(&s->metadata, "extra info", extra, AV_DICT_DONT_STRDUP_VAL);
117
118     ADD_META_MULTIPLE_ENTRIES(instrument, ModPlug_InstrumentName);
119     ADD_META_MULTIPLE_ENTRIES(sample,     ModPlug_SampleName);
120
121     return 0;
122 }
123
124 static int modplug_read_header(AVFormatContext *s, AVFormatParameters *ap)
125 {
126     AVStream *st;
127     AVIOContext *pb = s->pb;
128     ModPlug_Settings settings;
129     ModPlugContext *modplug = s->priv_data;
130     int sz = avio_size(pb);
131
132     if (sz < 0) {
133         av_log(s, AV_LOG_WARNING, "Could not determine file size\n");
134         sz = modplug->max_size;
135     } else if (modplug->max_size && sz > modplug->max_size) {
136         sz = modplug->max_size;
137         av_log(s, AV_LOG_WARNING, "Max file size reach%s, allocating %dB "
138                "but demuxing is likely to fail due to incomplete buffer\n",
139                sz == FF_MODPLUG_DEF_FILE_SIZE ? " (see -max_size)" : "", sz);
140     }
141     modplug->buf = av_malloc(modplug->max_size);
142     if (!modplug->buf)
143         return AVERROR(ENOMEM);
144     sz = avio_read(pb, modplug->buf, sz);
145
146     ModPlug_GetSettings(&settings);
147     settings.mChannels       = 2;
148     settings.mBits           = 16;
149     settings.mFrequency      = 44100;
150     settings.mResamplingMode = MODPLUG_RESAMPLE_FIR; // best quality
151     settings.mLoopCount      = 0; // prevents looping forever
152
153     if (modplug->noise_reduction) settings.mFlags     |= MODPLUG_ENABLE_NOISE_REDUCTION;
154     SET_OPT_IF_REQUESTED(mReverbDepth,   reverb_depth,   MODPLUG_ENABLE_REVERB);
155     SET_OPT_IF_REQUESTED(mReverbDelay,   reverb_delay,   MODPLUG_ENABLE_REVERB);
156     SET_OPT_IF_REQUESTED(mBassAmount,    bass_amount,    MODPLUG_ENABLE_MEGABASS);
157     SET_OPT_IF_REQUESTED(mBassRange,     bass_range,     MODPLUG_ENABLE_MEGABASS);
158     SET_OPT_IF_REQUESTED(mSurroundDepth, surround_depth, MODPLUG_ENABLE_SURROUND);
159     SET_OPT_IF_REQUESTED(mSurroundDelay, surround_delay, MODPLUG_ENABLE_SURROUND);
160
161     if (modplug->reverb_depth)   settings.mReverbDepth   = modplug->reverb_depth;
162     if (modplug->reverb_delay)   settings.mReverbDelay   = modplug->reverb_delay;
163     if (modplug->bass_amount)    settings.mBassAmount    = modplug->bass_amount;
164     if (modplug->bass_range)     settings.mBassRange     = modplug->bass_range;
165     if (modplug->surround_depth) settings.mSurroundDepth = modplug->surround_depth;
166     if (modplug->surround_delay) settings.mSurroundDelay = modplug->surround_delay;
167
168     ModPlug_SetSettings(&settings);
169
170     modplug->f = ModPlug_Load(modplug->buf, sz);
171     if (!modplug->f)
172         return AVERROR_INVALIDDATA;
173
174     st = av_new_stream(s, 0);
175     if (!st)
176         return AVERROR(ENOMEM);
177     av_set_pts_info(st, 64, 1, 1000);
178     st->duration = ModPlug_GetLength(modplug->f);
179     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
180     st->codec->codec_id    = CODEC_ID_PCM_S16LE;
181     st->codec->channels    = settings.mChannels;
182     st->codec->sample_rate = settings.mFrequency;
183
184     return modplug_load_metadata(s);
185 }
186
187 static int modplug_read_packet(AVFormatContext *s, AVPacket *pkt)
188 {
189     ModPlugContext *modplug = s->priv_data;
190
191     if (av_new_packet(pkt, 512) < 0)
192         return AVERROR(ENOMEM);
193
194     pkt->size = ModPlug_Read(modplug->f, pkt->data, 512);
195     if (pkt->size <= 0) {
196         av_free_packet(pkt);
197         return pkt->size == 0 ? AVERROR_EOF : AVERROR(EIO);
198     }
199     return 0;
200 }
201
202 static int modplug_read_close(AVFormatContext *s)
203 {
204     ModPlugContext *modplug = s->priv_data;
205     ModPlug_Unload(modplug->f);
206     return 0;
207 }
208
209 static int modplug_read_seek(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
210 {
211     const ModPlugContext *modplug = s->priv_data;
212     ModPlug_Seek(modplug->f, (int)ts);
213     return 0;
214 }
215
216 static const AVClass modplug_class = {
217     .class_name = "ModPlug demuxer",
218     .item_name  = av_default_item_name,
219     .option     = options,
220     .version    = LIBAVUTIL_VERSION_INT,
221 };
222
223 AVInputFormat ff_libmodplug_demuxer = {
224     .name           = "libmodplug",
225     .long_name      = NULL_IF_CONFIG_SMALL("ModPlug demuxer"),
226     .priv_data_size = sizeof(ModPlugContext),
227     .read_header    = modplug_read_header,
228     .read_packet    = modplug_read_packet,
229     .read_close     = modplug_read_close,
230     .read_seek      = modplug_read_seek,
231     .extensions     = "669,abc,amf,ams,dbm,dmf,dsm,far,it,mdl,med,mid,mod,mt2,mtm,okt,psm,ptm,s3m,stm,ult,umx,xm"
232                       ",itgz,itr,itz,mdgz,mdr,mdz,s3gz,s3r,s3z,xmgz,xmr,xmz", // compressed mods
233     .priv_class     = &modplug_class,
234 };