yading@11: /*
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: /**
yading@11: * @file
yading@11: * ModPlug demuxer
yading@11: * @todo better probing than extensions matching
yading@11: */
yading@11: 
yading@11: #include <libmodplug/modplug.h>
yading@11: #include "libavutil/avstring.h"
yading@11: #include "libavutil/eval.h"
yading@11: #include "libavutil/opt.h"
yading@11: #include "avformat.h"
yading@11: #include "internal.h"
yading@11: 
yading@11: typedef struct ModPlugContext {
yading@11:     const AVClass *class;
yading@11:     ModPlugFile *f;
yading@11:     uint8_t *buf; ///< input file content
yading@11: 
yading@11:     /* options */
yading@11:     int noise_reduction;
yading@11:     int reverb_depth;
yading@11:     int reverb_delay;
yading@11:     int bass_amount;
yading@11:     int bass_range;
yading@11:     int surround_depth;
yading@11:     int surround_delay;
yading@11: 
yading@11:     int max_size; ///< max file size to allocate
yading@11: 
yading@11:     /* optional video stream */
yading@11:     double ts_per_packet; ///< used to define the pts/dts using packet_count;
yading@11:     int packet_count;     ///< total number of audio packets
yading@11:     int print_textinfo;   ///< bool flag for printing speed, tempo, order, ...
yading@11:     int video_stream;     ///< 1 if the user want a video stream, otherwise 0
yading@11:     int w;                ///< video stream width  in char (one char = 8x8px)
yading@11:     int h;                ///< video stream height in char (one char = 8x8px)
yading@11:     int video_switch;     ///< 1 if current packet is video, otherwise 0
yading@11:     int fsize;            ///< constant frame size
yading@11:     int linesize;         ///< line size in bytes
yading@11:     char *color_eval;     ///< color eval user input expression
yading@11:     AVExpr *expr;         ///< parsed color eval expression
yading@11: } ModPlugContext;
yading@11: 
yading@11: static const char *var_names[] = {
yading@11:     "x", "y",
yading@11:     "w", "h",
yading@11:     "t",
yading@11:     "speed", "tempo", "order", "pattern", "row",
yading@11:     NULL
yading@11: };
yading@11: 
yading@11: enum var_name {
yading@11:     VAR_X, VAR_Y,
yading@11:     VAR_W, VAR_H,
yading@11:     VAR_TIME,
yading@11:     VAR_SPEED, VAR_TEMPO, VAR_ORDER, VAR_PATTERN, VAR_ROW,
yading@11:     VAR_VARS_NB
yading@11: };
yading@11: 
yading@11: #define FF_MODPLUG_MAX_FILE_SIZE (100 * 1<<20) // 100M
yading@11: #define FF_MODPLUG_DEF_FILE_SIZE (  5 * 1<<20) //   5M
yading@11: 
yading@11: #define OFFSET(x) offsetof(ModPlugContext, x)
yading@11: #define D AV_OPT_FLAG_DECODING_PARAM
yading@11: static const AVOption options[] = {
yading@11:     {"noise_reduction", "Enable noise reduction 0(off)-1(on)",  OFFSET(noise_reduction), AV_OPT_TYPE_INT, {.i64 = 0}, 0,       1, D},
yading@11:     {"reverb_depth",    "Reverb level 0(quiet)-100(loud)",      OFFSET(reverb_depth),    AV_OPT_TYPE_INT, {.i64 = 0}, 0,     100, D},
yading@11:     {"reverb_delay",    "Reverb delay in ms, usually 40-200ms", OFFSET(reverb_delay),    AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D},
yading@11:     {"bass_amount",     "XBass level 0(quiet)-100(loud)",       OFFSET(bass_amount),     AV_OPT_TYPE_INT, {.i64 = 0}, 0,     100, D},
yading@11:     {"bass_range",      "XBass cutoff in Hz 10-100",            OFFSET(bass_range),      AV_OPT_TYPE_INT, {.i64 = 0}, 0,     100, D},
yading@11:     {"surround_depth",  "Surround level 0(quiet)-100(heavy)",   OFFSET(surround_depth),  AV_OPT_TYPE_INT, {.i64 = 0}, 0,     100, D},
yading@11:     {"surround_delay",  "Surround delay in ms, usually 5-40ms", OFFSET(surround_delay),  AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D},
yading@11:     {"max_size",        "Max file size supported (in bytes). Default is 5MB. Set to 0 for no limit (not recommended)",
yading@11:      OFFSET(max_size), AV_OPT_TYPE_INT, {.i64 = FF_MODPLUG_DEF_FILE_SIZE}, 0, FF_MODPLUG_MAX_FILE_SIZE, D},
yading@11:     {"video_stream_expr", "Color formula",                                  OFFSET(color_eval),     AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, D},
yading@11:     {"video_stream",      "Make demuxer output a video stream",             OFFSET(video_stream),   AV_OPT_TYPE_INT, {.i64 = 0},   0,   1, D},
yading@11:     {"video_stream_w",    "Video stream width in char (one char = 8x8px)",  OFFSET(w),              AV_OPT_TYPE_INT, {.i64 = 30}, 20, 512, D},
yading@11:     {"video_stream_h",    "Video stream height in char (one char = 8x8px)", OFFSET(h),              AV_OPT_TYPE_INT, {.i64 = 30}, 20, 512, D},
yading@11:     {"video_stream_ptxt", "Print speed, tempo, order, ... in video stream", OFFSET(print_textinfo), AV_OPT_TYPE_INT, {.i64 = 1},   0,   1, D},
yading@11:     {NULL},
yading@11: };
yading@11: 
yading@11: #define SET_OPT_IF_REQUESTED(libopt, opt, flag) do {        \
yading@11:     if (modplug->opt) {                                     \
yading@11:         settings.libopt  = modplug->opt;                    \
yading@11:         settings.mFlags |= flag;                            \
yading@11:     }                                                       \
yading@11: } while (0)
yading@11: 
yading@11: #define ADD_META_MULTIPLE_ENTRIES(entry_name, fname) do {                      \
yading@11:     if (n_## entry_name ##s) {                                                 \
yading@11:         unsigned i, n = 0;                                                     \
yading@11:                                                                                \
yading@11:         for (i = 0; i < n_## entry_name ##s; i++) {                            \
yading@11:             char item_name[64] = {0};                                          \
yading@11:             fname(f, i, item_name);                                            \
yading@11:             if (!*item_name)                                                   \
yading@11:                 continue;                                                      \
yading@11:             if (n)                                                             \
yading@11:                 av_dict_set(&s->metadata, #entry_name, "\n", AV_DICT_APPEND);  \
yading@11:             av_dict_set(&s->metadata, #entry_name, item_name, AV_DICT_APPEND); \
yading@11:             n++;                                                               \
yading@11:         }                                                                      \
yading@11:                                                                                \
yading@11:         extra = av_asprintf(", %u/%u " #entry_name "%s",                       \
yading@11:                             n, n_## entry_name ##s, n > 1 ? "s" : "");         \
yading@11:         if (!extra)                                                            \
yading@11:             return AVERROR(ENOMEM);                                            \
yading@11:         av_dict_set(&s->metadata, "extra info", extra, AV_DICT_APPEND);        \
yading@11:         av_free(extra);                                                        \
yading@11:     }                                                                          \
yading@11: } while (0)
yading@11: 
yading@11: static int modplug_load_metadata(AVFormatContext *s)
yading@11: {
yading@11:     ModPlugContext *modplug = s->priv_data;
yading@11:     ModPlugFile *f = modplug->f;
yading@11:     char *extra;
yading@11:     const char *name = ModPlug_GetName(f);
yading@11:     const char *msg  = ModPlug_GetMessage(f);
yading@11: 
yading@11:     unsigned n_instruments = ModPlug_NumInstruments(f);
yading@11:     unsigned n_samples     = ModPlug_NumSamples(f);
yading@11:     unsigned n_patterns    = ModPlug_NumPatterns(f);
yading@11:     unsigned n_channels    = ModPlug_NumChannels(f);
yading@11: 
yading@11:     if (name && *name) av_dict_set(&s->metadata, "name",    name, 0);
yading@11:     if (msg  && *msg)  av_dict_set(&s->metadata, "message", msg,  0);
yading@11: 
yading@11:     extra = av_asprintf("%u pattern%s, %u channel%s",
yading@11:                         n_patterns, n_patterns > 1 ? "s" : "",
yading@11:                         n_channels, n_channels > 1 ? "s" : "");
yading@11:     if (!extra)
yading@11:         return AVERROR(ENOMEM);
yading@11:     av_dict_set(&s->metadata, "extra info", extra, AV_DICT_DONT_STRDUP_VAL);
yading@11: 
yading@11:     ADD_META_MULTIPLE_ENTRIES(instrument, ModPlug_InstrumentName);
yading@11:     ADD_META_MULTIPLE_ENTRIES(sample,     ModPlug_SampleName);
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: #define AUDIO_PKT_SIZE 512
yading@11: 
yading@11: static int modplug_read_header(AVFormatContext *s)
yading@11: {
yading@11:     AVStream *st;
yading@11:     AVIOContext *pb = s->pb;
yading@11:     ModPlug_Settings settings;
yading@11:     ModPlugContext *modplug = s->priv_data;
yading@11:     int sz = avio_size(pb);
yading@11: 
yading@11:     if (sz < 0) {
yading@11:         av_log(s, AV_LOG_WARNING, "Could not determine file size\n");
yading@11:         sz = modplug->max_size;
yading@11:     } else if (modplug->max_size && sz > modplug->max_size) {
yading@11:         sz = modplug->max_size;
yading@11:         av_log(s, AV_LOG_WARNING, "Max file size reach%s, allocating %dB "
yading@11:                "but demuxing is likely to fail due to incomplete buffer\n",
yading@11:                sz == FF_MODPLUG_DEF_FILE_SIZE ? " (see -max_size)" : "", sz);
yading@11:     }
yading@11: 
yading@11:     if (modplug->color_eval) {
yading@11:         int r = av_expr_parse(&modplug->expr, modplug->color_eval, var_names,
yading@11:                               NULL, NULL, NULL, NULL, 0, s);
yading@11:         if (r < 0)
yading@11:             return r;
yading@11:     }
yading@11: 
yading@11:     modplug->buf = av_malloc(modplug->max_size);
yading@11:     if (!modplug->buf)
yading@11:         return AVERROR(ENOMEM);
yading@11:     sz = avio_read(pb, modplug->buf, sz);
yading@11: 
yading@11:     ModPlug_GetSettings(&settings);
yading@11:     settings.mChannels       = 2;
yading@11:     settings.mBits           = 16;
yading@11:     settings.mFrequency      = 44100;
yading@11:     settings.mResamplingMode = MODPLUG_RESAMPLE_FIR; // best quality
yading@11:     settings.mLoopCount      = 0; // prevents looping forever
yading@11: 
yading@11:     if (modplug->noise_reduction) settings.mFlags     |= MODPLUG_ENABLE_NOISE_REDUCTION;
yading@11:     SET_OPT_IF_REQUESTED(mReverbDepth,   reverb_depth,   MODPLUG_ENABLE_REVERB);
yading@11:     SET_OPT_IF_REQUESTED(mReverbDelay,   reverb_delay,   MODPLUG_ENABLE_REVERB);
yading@11:     SET_OPT_IF_REQUESTED(mBassAmount,    bass_amount,    MODPLUG_ENABLE_MEGABASS);
yading@11:     SET_OPT_IF_REQUESTED(mBassRange,     bass_range,     MODPLUG_ENABLE_MEGABASS);
yading@11:     SET_OPT_IF_REQUESTED(mSurroundDepth, surround_depth, MODPLUG_ENABLE_SURROUND);
yading@11:     SET_OPT_IF_REQUESTED(mSurroundDelay, surround_delay, MODPLUG_ENABLE_SURROUND);
yading@11: 
yading@11:     if (modplug->reverb_depth)   settings.mReverbDepth   = modplug->reverb_depth;
yading@11:     if (modplug->reverb_delay)   settings.mReverbDelay   = modplug->reverb_delay;
yading@11:     if (modplug->bass_amount)    settings.mBassAmount    = modplug->bass_amount;
yading@11:     if (modplug->bass_range)     settings.mBassRange     = modplug->bass_range;
yading@11:     if (modplug->surround_depth) settings.mSurroundDepth = modplug->surround_depth;
yading@11:     if (modplug->surround_delay) settings.mSurroundDelay = modplug->surround_delay;
yading@11: 
yading@11:     ModPlug_SetSettings(&settings);
yading@11: 
yading@11:     modplug->f = ModPlug_Load(modplug->buf, sz);
yading@11:     if (!modplug->f)
yading@11:         return AVERROR_INVALIDDATA;
yading@11: 
yading@11:     st = avformat_new_stream(s, NULL);
yading@11:     if (!st)
yading@11:         return AVERROR(ENOMEM);
yading@11:     avpriv_set_pts_info(st, 64, 1, 1000);
yading@11:     st->duration = ModPlug_GetLength(modplug->f);
yading@11:     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
yading@11:     st->codec->codec_id    = AV_CODEC_ID_PCM_S16LE;
yading@11:     st->codec->channels    = settings.mChannels;
yading@11:     st->codec->sample_rate = settings.mFrequency;
yading@11: 
yading@11:     // timebase = 1/1000, 2ch 16bits 44.1kHz-> 2*2*44100
yading@11:     modplug->ts_per_packet = 1000*AUDIO_PKT_SIZE / (4*44100.);
yading@11: 
yading@11:     if (modplug->video_stream) {
yading@11:         AVStream *vst = avformat_new_stream(s, NULL);
yading@11:         if (!vst)
yading@11:             return AVERROR(ENOMEM);
yading@11:         avpriv_set_pts_info(vst, 64, 1, 1000);
yading@11:         vst->duration = st->duration;
yading@11:         vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
yading@11:         vst->codec->codec_id   = AV_CODEC_ID_XBIN;
yading@11:         vst->codec->width      = modplug->w << 3;
yading@11:         vst->codec->height     = modplug->h << 3;
yading@11:         modplug->linesize = modplug->w * 3;
yading@11:         modplug->fsize    = modplug->linesize * modplug->h;
yading@11:     }
yading@11: 
yading@11:     return modplug_load_metadata(s);
yading@11: }
yading@11: 
yading@11: static void write_text(uint8_t *dst, const char *s, int linesize, int x, int y)
yading@11: {
yading@11:     int i;
yading@11:     dst += y*linesize + x*3;
yading@11:     for (i = 0; s[i]; i++, dst += 3) {
yading@11:         dst[0] = 0x0;   // count - 1
yading@11:         dst[1] = s[i];  // char
yading@11:         dst[2] = 0x0f;  // background / foreground
yading@11:     }
yading@11: }
yading@11: 
yading@11: #define PRINT_INFO(line, name, idvalue) do {                            \
yading@11:     snprintf(intbuf, sizeof(intbuf), "%.0f", var_values[idvalue]);      \
yading@11:     write_text(pkt->data, name ":", modplug->linesize,  0+1, line+1);   \
yading@11:     write_text(pkt->data, intbuf,   modplug->linesize, 10+1, line+1);   \
yading@11: } while (0)
yading@11: 
yading@11: static int modplug_read_packet(AVFormatContext *s, AVPacket *pkt)
yading@11: {
yading@11:     ModPlugContext *modplug = s->priv_data;
yading@11: 
yading@11:     if (modplug->video_stream) {
yading@11:         modplug->video_switch ^= 1; // one video packet for one audio packet
yading@11:         if (modplug->video_switch) {
yading@11:             double var_values[VAR_VARS_NB];
yading@11: 
yading@11:             var_values[VAR_W      ] = modplug->w;
yading@11:             var_values[VAR_H      ] = modplug->h;
yading@11:             var_values[VAR_TIME   ] = modplug->packet_count * modplug->ts_per_packet;
yading@11:             var_values[VAR_SPEED  ] = ModPlug_GetCurrentSpeed  (modplug->f);
yading@11:             var_values[VAR_TEMPO  ] = ModPlug_GetCurrentTempo  (modplug->f);
yading@11:             var_values[VAR_ORDER  ] = ModPlug_GetCurrentOrder  (modplug->f);
yading@11:             var_values[VAR_PATTERN] = ModPlug_GetCurrentPattern(modplug->f);
yading@11:             var_values[VAR_ROW    ] = ModPlug_GetCurrentRow    (modplug->f);
yading@11: 
yading@11:             if (av_new_packet(pkt, modplug->fsize) < 0)
yading@11:                 return AVERROR(ENOMEM);
yading@11:             pkt->stream_index = 1;
yading@11:             memset(pkt->data, 0, modplug->fsize);
yading@11: 
yading@11:             if (modplug->print_textinfo) {
yading@11:                 char intbuf[32];
yading@11:                 PRINT_INFO(0, "speed",   VAR_SPEED);
yading@11:                 PRINT_INFO(1, "tempo",   VAR_TEMPO);
yading@11:                 PRINT_INFO(2, "order",   VAR_ORDER);
yading@11:                 PRINT_INFO(3, "pattern", VAR_PATTERN);
yading@11:                 PRINT_INFO(4, "row",     VAR_ROW);
yading@11:                 PRINT_INFO(5, "ts",      VAR_TIME);
yading@11:             }
yading@11: 
yading@11:             if (modplug->expr) {
yading@11:                 int x, y;
yading@11:                 for (y = 0; y < modplug->h; y++) {
yading@11:                     for (x = 0; x < modplug->w; x++) {
yading@11:                         double color;
yading@11:                         var_values[VAR_X] = x;
yading@11:                         var_values[VAR_Y] = y;
yading@11:                         color = av_expr_eval(modplug->expr, var_values, NULL);
yading@11:                         pkt->data[y*modplug->linesize + x*3 + 2] |= av_clip((int)color, 0, 0xf)<<4;
yading@11:                     }
yading@11:                 }
yading@11:             }
yading@11:             pkt->pts = pkt->dts = var_values[VAR_TIME];
yading@11:             pkt->flags |= AV_PKT_FLAG_KEY;
yading@11:             return 0;
yading@11:         }
yading@11:     }
yading@11: 
yading@11:     if (av_new_packet(pkt, AUDIO_PKT_SIZE) < 0)
yading@11:         return AVERROR(ENOMEM);
yading@11: 
yading@11:     if (modplug->video_stream)
yading@11:         pkt->pts = pkt->dts = modplug->packet_count++ * modplug->ts_per_packet;
yading@11: 
yading@11:     pkt->size = ModPlug_Read(modplug->f, pkt->data, AUDIO_PKT_SIZE);
yading@11:     if (pkt->size <= 0) {
yading@11:         av_free_packet(pkt);
yading@11:         return pkt->size == 0 ? AVERROR_EOF : AVERROR(EIO);
yading@11:     }
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static int modplug_read_close(AVFormatContext *s)
yading@11: {
yading@11:     ModPlugContext *modplug = s->priv_data;
yading@11:     ModPlug_Unload(modplug->f);
yading@11:     av_freep(&modplug->buf);
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static int modplug_read_seek(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
yading@11: {
yading@11:     ModPlugContext *modplug = s->priv_data;
yading@11:     ModPlug_Seek(modplug->f, (int)ts);
yading@11:     if (modplug->video_stream)
yading@11:         modplug->packet_count = ts / modplug->ts_per_packet;
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static const AVClass modplug_class = {
yading@11:     .class_name = "ModPlug demuxer",
yading@11:     .item_name  = av_default_item_name,
yading@11:     .option     = options,
yading@11:     .version    = LIBAVUTIL_VERSION_INT,
yading@11: };
yading@11: 
yading@11: AVInputFormat ff_libmodplug_demuxer = {
yading@11:     .name           = "libmodplug",
yading@11:     .long_name      = NULL_IF_CONFIG_SMALL("ModPlug demuxer"),
yading@11:     .priv_data_size = sizeof(ModPlugContext),
yading@11:     .read_header    = modplug_read_header,
yading@11:     .read_packet    = modplug_read_packet,
yading@11:     .read_close     = modplug_read_close,
yading@11:     .read_seek      = modplug_read_seek,
yading@11:     .extensions     = "669,abc,amf,ams,dbm,dmf,dsm,far,it,mdl,med,mid,mod,mt2,mtm,okt,psm,ptm,s3m,stm,ult,umx,xm"
yading@11:                       ",itgz,itr,itz,mdgz,mdr,mdz,s3gz,s3r,s3z,xmgz,xmr,xmz", // compressed mods
yading@11:     .priv_class     = &modplug_class,
yading@11: };