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 #include <libopenmpt/libopenmpt_version.h>
25 /* Shims to support libopenmpt < 0.3.0 (as documented by libopenmpt) */
26 #if !defined(OPENMPT_API_VERSION_MAKE)
27 #define OPENMPT_API_VERSION_MAKE(major, minor, patch) (((major)<<24)|((minor)<<16)|((patch)<<0))
28 #endif
29 #if !defined(OPENMPT_API_VERSION_AT_LEAST)
30 #define OPENMPT_API_VERSION_AT_LEAST(major, minor, patch) (OPENMPT_API_VERSION >= OPENMPT_API_VERSION_MAKE((major), (minor), (patch)))
31 #endif
32
33 #include "libavutil/avstring.h"
34 #include "libavutil/channel_layout.h"
35 #include "libavutil/opt.h"
36 #include "avformat.h"
37 #include "internal.h"
38
39 typedef struct OpenMPTContext {
40 const AVClass *class;
41 openmpt_module *module;
42
43 double duration;
44 /* options */
45 int sample_rate;
46 AVChannelLayout ch_layout;
47 int subsong;
48 } OpenMPTContext;
49
50 #define OFFSET(x) offsetof(OpenMPTContext, x)
51 #define A AV_OPT_FLAG_AUDIO_PARAM
52 #define D AV_OPT_FLAG_DECODING_PARAM
53 static const AVOption options[] = {
54 { "sample_rate", "set sample rate", OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 48000 }, 1000, INT_MAX, A | D },
55 { "layout", "set channel layout", OFFSET(ch_layout), AV_OPT_TYPE_CHLAYOUT, { .str = "stereo" }, 0, 0, A | D },
56 { "subsong", "set subsong", OFFSET(subsong), AV_OPT_TYPE_INT, { .i64 = -2 }, -2, INT_MAX, A | D, "subsong"},
57 { "all", "all", 0, AV_OPT_TYPE_CONST, { .i64 = -1}, 0, 0, A | D, "subsong" },
58 { "auto", "auto", 0, AV_OPT_TYPE_CONST, { .i64 = -2}, 0, 0, A | D, "subsong" },
59 { NULL }
60 };
61
openmpt_logfunc(const char * message,void * userdata)62 static void openmpt_logfunc(const char *message, void *userdata)
63 {
64 int level = AV_LOG_INFO;
65 if (strstr(message, "ERROR") != NULL) {
66 level = AV_LOG_ERROR;
67 }
68 av_log(userdata, level, "%s\n", message);
69 }
70
71 #define add_meta(s, name, meta) \
72 do { \
73 const char *value = meta; \
74 if (value && value[0]) \
75 av_dict_set(&s->metadata, name, value, 0); \
76 openmpt_free_string(value); \
77 } while(0)
78
read_header_openmpt(AVFormatContext * s)79 static int read_header_openmpt(AVFormatContext *s)
80 {
81 AVStream *st;
82 OpenMPTContext *openmpt = s->priv_data;
83 int64_t size;
84 char *buf;
85 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
86 int error;
87 #endif
88 int ret;
89
90 size = avio_size(s->pb);
91 if (size <= 0)
92 return AVERROR_INVALIDDATA;
93 buf = av_malloc(size);
94 if (!buf)
95 return AVERROR(ENOMEM);
96 size = avio_read(s->pb, buf, size);
97 if (size < 0) {
98 av_log(s, AV_LOG_ERROR, "Reading input buffer failed.\n");
99 av_freep(&buf);
100 return size;
101 }
102
103 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
104 error = OPENMPT_ERROR_OK;
105 openmpt->module = openmpt_module_create_from_memory2(buf, size, openmpt_logfunc, s, NULL, NULL, &error, NULL, NULL);
106 av_freep(&buf);
107 if (!openmpt->module) {
108 if (error == OPENMPT_ERROR_OUT_OF_MEMORY)
109 return AVERROR(ENOMEM);
110 else if (error >= OPENMPT_ERROR_GENERAL)
111 return AVERROR_INVALIDDATA;
112 else
113 return AVERROR_UNKNOWN;
114 }
115 #else
116 openmpt->module = openmpt_module_create_from_memory(buf, size, openmpt_logfunc, s, NULL);
117 av_freep(&buf);
118 if (!openmpt->module)
119 return AVERROR_INVALIDDATA;
120 #endif
121
122 if (openmpt->subsong >= openmpt_module_get_num_subsongs(openmpt->module)) {
123 av_log(s, AV_LOG_ERROR, "Invalid subsong index: %d\n", openmpt->subsong);
124 return AVERROR(EINVAL);
125 }
126
127 if (openmpt->subsong != -2) {
128 if (openmpt->subsong >= 0) {
129 av_dict_set_int(&s->metadata, "track", openmpt->subsong + 1, 0);
130 }
131 ret = openmpt_module_select_subsong(openmpt->module, openmpt->subsong);
132 if (!ret){
133 av_log(s, AV_LOG_ERROR, "Could not select requested subsong: %d", openmpt->subsong);
134 return AVERROR(EINVAL);
135 }
136 }
137
138 openmpt->duration = openmpt_module_get_duration_seconds(openmpt->module);
139
140 add_meta(s, "artist", openmpt_module_get_metadata(openmpt->module, "artist"));
141 add_meta(s, "title", openmpt_module_get_metadata(openmpt->module, "title"));
142 add_meta(s, "encoder", openmpt_module_get_metadata(openmpt->module, "tracker"));
143 add_meta(s, "comment", openmpt_module_get_metadata(openmpt->module, "message"));
144 add_meta(s, "date", openmpt_module_get_metadata(openmpt->module, "date"));
145
146 st = avformat_new_stream(s, NULL);
147 if (!st)
148 return AVERROR(ENOMEM);
149 avpriv_set_pts_info(st, 64, 1, AV_TIME_BASE);
150 st->duration = llrint(openmpt->duration*AV_TIME_BASE);
151
152 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
153 st->codecpar->codec_id = AV_NE(AV_CODEC_ID_PCM_F32BE, AV_CODEC_ID_PCM_F32LE);
154 st->codecpar->sample_rate = openmpt->sample_rate;
155 ret = av_channel_layout_copy(&st->codecpar->ch_layout, &openmpt->ch_layout);
156 if (ret < 0)
157 return ret;
158
159 return 0;
160 }
161
162 #define AUDIO_PKT_SIZE 2048
163
read_packet_openmpt(AVFormatContext * s,AVPacket * pkt)164 static int read_packet_openmpt(AVFormatContext *s, AVPacket *pkt)
165 {
166 OpenMPTContext *openmpt = s->priv_data;
167 int n_samples = AUDIO_PKT_SIZE / (openmpt->ch_layout.nb_channels ? openmpt->ch_layout.nb_channels*4 : 4);
168 int ret;
169
170 if ((ret = av_new_packet(pkt, AUDIO_PKT_SIZE)) < 0)
171 return ret;
172
173 switch (openmpt->ch_layout.nb_channels) {
174 case 1:
175 ret = openmpt_module_read_float_mono(openmpt->module, openmpt->sample_rate,
176 n_samples, (float *)pkt->data);
177 break;
178 case 2:
179 ret = openmpt_module_read_interleaved_float_stereo(openmpt->module, openmpt->sample_rate,
180 n_samples, (float *)pkt->data);
181 break;
182 case 4:
183 ret = openmpt_module_read_interleaved_float_quad(openmpt->module, openmpt->sample_rate,
184 n_samples, (float *)pkt->data);
185 break;
186 default:
187 av_log(s, AV_LOG_ERROR, "Unsupported number of channels: %d", openmpt->ch_layout.nb_channels);
188 return AVERROR(EINVAL);
189 }
190
191 if (ret < 1) {
192 pkt->size = 0;
193 return AVERROR_EOF;
194 }
195
196 pkt->size = ret * (openmpt->ch_layout.nb_channels * 4);
197
198 return 0;
199 }
200
read_close_openmpt(AVFormatContext * s)201 static int read_close_openmpt(AVFormatContext *s)
202 {
203 OpenMPTContext *openmpt = s->priv_data;
204 if (openmpt->module) {
205 openmpt_module_destroy(openmpt->module);
206 openmpt->module = NULL;
207 }
208 return 0;
209 }
210
read_seek_openmpt(AVFormatContext * s,int stream_idx,int64_t ts,int flags)211 static int read_seek_openmpt(AVFormatContext *s, int stream_idx, int64_t ts, int flags)
212 {
213 OpenMPTContext *openmpt = s->priv_data;
214 openmpt_module_set_position_seconds(openmpt->module, (double)ts/AV_TIME_BASE);
215 return 0;
216 }
217
probe_openmpt_extension(const AVProbeData * p)218 static int probe_openmpt_extension(const AVProbeData *p)
219 {
220 const char *ext;
221 if (p->filename) {
222 ext = strrchr(p->filename, '.');
223 if (ext && strlen(ext + 1) > 0) {
224 ext++; /* skip '.' */
225 if (openmpt_is_extension_supported(ext) == 1)
226 return AVPROBE_SCORE_EXTENSION;
227 }
228 }
229 return 0;
230 }
231
read_probe_openmpt(const AVProbeData * p)232 static int read_probe_openmpt(const AVProbeData *p)
233 {
234 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
235 int probe_result;
236 if (p->buf && p->buf_size > 0) {
237 probe_result = openmpt_probe_file_header_without_filesize(
238 OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT,
239 p->buf, p->buf_size,
240 &openmpt_logfunc, NULL, NULL, NULL, NULL, NULL);
241 if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS) {
242 /* As probing here relies on code external to FFmpeg, do not return
243 * AVPROBE_SCORE_MAX in order to reduce the impact in the rare
244 * cases of false positives.
245 */
246 return AVPROBE_SCORE_MIME + 1;
247 } else if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA) {
248 if (probe_openmpt_extension(p) > 0) {
249 return AVPROBE_SCORE_RETRY;
250 } else {
251 if (p->buf_size >= openmpt_probe_file_header_get_recommended_size()) {
252 /* We have already received the recommended amount of data
253 * and still cannot decide. Return a rather low score.
254 */
255 return AVPROBE_SCORE_RETRY / 2;
256 } else {
257 /* The file extension is unknown and we have very few data
258 * bytes available. libopenmpt cannot decide anything here,
259 * and returning any score > 0 would result in successful
260 * probing of random data.
261 */
262 return 0;
263 }
264 }
265 } else if (probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE) {
266 return 0;
267 }
268 }
269 #endif
270 /* for older libopenmpt, fall back to file extension probing */
271 return probe_openmpt_extension(p);
272 }
273
274 static const AVClass class_openmpt = {
275 .class_name = "libopenmpt",
276 .item_name = av_default_item_name,
277 .option = options,
278 .version = LIBAVUTIL_VERSION_INT,
279 };
280
281 const AVInputFormat ff_libopenmpt_demuxer = {
282 .name = "libopenmpt",
283 .long_name = NULL_IF_CONFIG_SMALL("Tracker formats (libopenmpt)"),
284 .priv_data_size = sizeof(OpenMPTContext),
285 .flags_internal = FF_FMT_INIT_CLEANUP,
286 .read_probe = read_probe_openmpt,
287 .read_header = read_header_openmpt,
288 .read_packet = read_packet_openmpt,
289 .read_close = read_close_openmpt,
290 .read_seek = read_seek_openmpt,
291 .priv_class = &class_openmpt,
292 #if OPENMPT_API_VERSION_AT_LEAST(0,3,0)
293 .extensions = "669,amf,ams,dbm,digi,dmf,dsm,dtm,far,gdm,ice,imf,it,j2b,m15,mdl,med,mmcmp,mms,mo3,mod,mptm,mt2,mtm,nst,okt,plm,ppm,psm,pt36,ptm,s3m,sfx,sfx2,st26,stk,stm,stp,ult,umx,wow,xm,xpk",
294 #else
295 .extensions = "669,amf,ams,dbm,digi,dmf,dsm,far,gdm,ice,imf,it,j2b,m15,mdl,med,mmcmp,mms,mo3,mod,mptm,mt2,mtm,nst,okt,plm,ppm,psm,pt36,ptm,s3m,sfx,sfx2,st26,stk,stm,ult,umx,wow,xm,xpk",
296 #endif
297 };
298