git.sesse.net Git - ffmpeg/blob - libavformat/libopenmpt.c

   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
  25 #include "libavutil/avstring.h"
  26 #include "libavutil/opt.h"
  27 #include "avformat.h"
  28 #include "internal.h"
  29
  30 typedef struct OpenMPTContext {
  31     const AVClass *class;
  32     openmpt_module *module;
  33
  34     int channels;
  35     double duration;
  36     /* options */
  37     int sample_rate;
  38     int64_t layout;
  39     int subsong;
  40 } OpenMPTContext;
  41
  42 #define OFFSET(x) offsetof(OpenMPTContext, x)
  43 #define A AV_OPT_FLAG_AUDIO_PARAM
  44 #define D AV_OPT_FLAG_DECODING_PARAM
  45 static const AVOption options[] = {
  46     { "sample_rate", "set sample rate",    OFFSET(sample_rate), AV_OPT_TYPE_INT,            { .i64 = 48000 },               1000, INT_MAX,   A | D },
  47     { "layout",      "set channel layout", OFFSET(layout),      AV_OPT_TYPE_CHANNEL_LAYOUT, { .i64 = AV_CH_LAYOUT_STEREO }, 0,    INT64_MAX, A | D },
  48     { "subsong",     "set subsong",        OFFSET(subsong),     AV_OPT_TYPE_INT,            { .i64 = -2 },                  -2,   INT_MAX,   A | D, "subsong"},
  49     { "all",         "all",                0,                   AV_OPT_TYPE_CONST,          { .i64 = -1},                   0,    0,         A | D, "subsong" },
  50     { "auto",        "auto",               0,                   AV_OPT_TYPE_CONST,          { .i64 = -2},                   0,    0,         A | D, "subsong" },
  51     { NULL }
  52 };
  53
  54 static void openmpt_logfunc(const char *message, void *userdata)
  55 {
  56     int level = AV_LOG_INFO;
  57     if (strstr(message, "ERROR") != NULL) {
  58         level = AV_LOG_ERROR;
  59     }
  60     av_log(userdata, level, "%s\n", message);
  61 }
  62
  63 #define add_meta(s, name, meta)                    \
  64 do {                                               \
  65     const char *value = meta;                      \
  66     if (value && value[0])                         \
  67         av_dict_set(&s->metadata, name, value, 0); \
  68     openmpt_free_string(value);                    \
  69 } while(0)
  70
  71 static int read_header_openmpt(AVFormatContext *s)
  72 {
  73     AVStream *st;
  74     OpenMPTContext *openmpt = s->priv_data;
  75     int64_t size = avio_size(s->pb);
  76     if (!size)
  77         return AVERROR_INVALIDDATA;
  78     char *buf = av_malloc(size);
  79     int ret;
  80
  81
  82     if (!buf)
  83         return AVERROR(ENOMEM);
  84     size = avio_read(s->pb, buf, size);
  85
  86     openmpt->module = openmpt_module_create_from_memory(buf, size, openmpt_logfunc, s, NULL);
  87     av_freep(&buf);
  88     if (!openmpt->module)
  89             return AVERROR_INVALIDDATA;
  90
  91     openmpt->channels   = av_get_channel_layout_nb_channels(openmpt->layout);
  92     openmpt->duration   = openmpt_module_get_duration_seconds(openmpt->module);
  93
  94     add_meta(s, "artist",  openmpt_module_get_metadata(openmpt->module, "artist"));
  95     add_meta(s, "title",   openmpt_module_get_metadata(openmpt->module, "title"));
  96     add_meta(s, "encoder", openmpt_module_get_metadata(openmpt->module, "tracker"));
  97     add_meta(s, "comment", openmpt_module_get_metadata(openmpt->module, "message"));
  98     add_meta(s, "date",    openmpt_module_get_metadata(openmpt->module, "date"));
  99
 100     if (openmpt->subsong >= openmpt_module_get_num_subsongs(openmpt->module)) {
 101         openmpt_module_destroy(openmpt->module);
 102         av_log(s, AV_LOG_ERROR, "Invalid subsong index: %d\n", openmpt->subsong);
 103         return AVERROR(EINVAL);
 104     }
 105
 106     if (openmpt->subsong != -2) {
 107         if (openmpt->subsong >= 0) {
 108             av_dict_set_int(&s->metadata, "track", openmpt->subsong + 1, 0);
 109         }
 110         ret = openmpt_module_select_subsong(openmpt->module, openmpt->subsong);
 111         if (!ret){
 112             openmpt_module_destroy(openmpt->module);
 113             av_log(s, AV_LOG_ERROR, "Could not select requested subsong: %d", openmpt->subsong);
 114             return AVERROR(EINVAL);
 115         }
 116     }
 117
 118     st = avformat_new_stream(s, NULL);
 119     if (!st) {
 120         openmpt_module_destroy(openmpt->module);
 121         openmpt->module = NULL;
 122         return AVERROR(ENOMEM);
 123     }
 124     avpriv_set_pts_info(st, 64, 1, AV_TIME_BASE);
 125     st->duration = llrint(openmpt->duration*AV_TIME_BASE);
 126
 127     st->codecpar->codec_type  = AVMEDIA_TYPE_AUDIO;
 128     st->codecpar->codec_id    = AV_NE(AV_CODEC_ID_PCM_F32BE, AV_CODEC_ID_PCM_F32LE);
 129     st->codecpar->channels    = openmpt->channels;
 130     st->codecpar->sample_rate = openmpt->sample_rate;
 131
 132     return 0;
 133 }
 134
 135 #define AUDIO_PKT_SIZE 2048
 136
 137 static int read_packet_openmpt(AVFormatContext *s, AVPacket *pkt)
 138 {
 139     OpenMPTContext *openmpt = s->priv_data;
 140     int n_samples = AUDIO_PKT_SIZE / (openmpt->channels ? openmpt->channels*4 : 4);
 141     int ret;
 142
 143     if ((ret = av_new_packet(pkt, AUDIO_PKT_SIZE)) < 0)
 144         return ret;
 145
 146     switch (openmpt->channels) {
 147     case 1:
 148         ret = openmpt_module_read_float_mono(openmpt->module, openmpt->sample_rate,
 149                                              n_samples, (float *)pkt->data);
 150         break;
 151     case 2:
 152         ret = openmpt_module_read_interleaved_float_stereo(openmpt->module, openmpt->sample_rate,
 153                                                            n_samples, (float *)pkt->data);
 154         break;
 155     case 4:
 156         ret = openmpt_module_read_interleaved_float_quad(openmpt->module, openmpt->sample_rate,
 157                                                          n_samples, (float *)pkt->data);
 158         break;
 159     default:
 160         av_log(s, AV_LOG_ERROR, "Unsupported number of channels: %d", openmpt->channels);
 161         return AVERROR(EINVAL);
 162     }
 163
 164     if (ret < 1) {
 165         pkt->size = 0;
 166         return AVERROR_EOF;
 167     }
 168
 169     pkt->size = ret * (openmpt->channels * 4);
 170
 171     return 0;
 172 }
 173
 174 static int read_close_openmpt(AVFormatContext *s)
 175 {
 176     OpenMPTContext *openmpt = s->priv_data;
 177     openmpt_module_destroy(openmpt->module);
 178     openmpt->module = NULL;
 179     return 0;
 180 }
 181
 182 static int read_seek_openmpt(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
 183 {
 184     OpenMPTContext *openmpt = s->priv_data;
 185     openmpt_module_set_position_seconds(openmpt->module, (double)ts/AV_TIME_BASE);
 186     return 0;
 187 }
 188
 189 static const AVClass class_openmpt = {
 190     .class_name = "libopenmpt",
 191     .item_name  = av_default_item_name,
 192     .option     = options,
 193     .version    = LIBAVUTIL_VERSION_INT,
 194 };
 195
 196 AVInputFormat ff_libopenmpt_demuxer = {
 197     .name           = "libopenmpt",
 198     .long_name      = NULL_IF_CONFIG_SMALL("Tracker formats (libopenmpt)"),
 199     .priv_data_size = sizeof(OpenMPTContext),
 200     .read_header    = read_header_openmpt,
 201     .read_packet    = read_packet_openmpt,
 202     .read_close     = read_close_openmpt,
 203     .read_seek      = read_seek_openmpt,
 204     .priv_class     = &class_openmpt,
 205     .extensions     = "669,amf,ams,dbm,digi,dmf,dsm,far,gdm,imf,it,j2b,m15,mdl,med,mmcmp,mms,mo3,mod,mptm,mt2,mtm,nst,okt,plm,ppm,psm,pt36,ptm,s3m,sfx,sfx2,stk,stm,ult,umx,wow,xm,xpk",
 206 };