Ticket #8491: mikmod.diff

base/main.cpp

@@ -113 +113 @@
         "MP3 "
 #endif
 
+#ifdef USE_MIKMOD
+        "MikMod "
+#endif
+
 #ifdef USE_ALSA
         "ALSA "
 #endif

configure

@@ -39 +39 @@
 _tremor=auto
 _flac=auto
 _mad=auto
+_mikmod=auto
 _alsa=auto
 _zlib=auto
 _mpeg2=auto
@@ -322 +323 @@
   --with-flac-prefix=DIR   Prefix where libFLAC is installed (optional)
   --disable-flac           disable FLAC support [autodetect]
 
+  --with-mikmod-prefix=DIR Prefix where libmikmod is installed (optional)
+  --disable-mikmod         disable MikMod support [autodetect]
+
   --with-zlib-prefix=DIR   Prefix where zlib is installed (optional)
   --disable-zlib           disable zlib (compression) support [autodetect]
 
@@ -375 +379 @@
       --disable-flac)           _flac=no        ;;
       --enable-mad)             _mad=yes        ;;
       --disable-mad)            _mad=no         ;;
+      --enable-mikmod)          _mikmod=yes     ;;
+      --disable-mikmod)         _mikmod=no      ;;
       --enable-zlib)            _zlib=yes       ;;
       --disable-zlib)           _zlib=no        ;;
       --enable-nasm)            _nasm=yes       ;;
@@ -424 +430 @@
         MAD_CFLAGS="-I$_prefix/include"
         MAD_LIBS="-L$_prefix/lib"
         ;;
+      --with-mikmod-prefix=*)
+        _prefix=`echo $ac_option | cut -d '=' -f 2`
+        MIKMOD_CFLAGS="-I$_prefix/include"
+        MIKMOD_LIBS="-L$_prefix/lib"
+        ;;
       --with-zlib-prefix=*)
         _prefix=`echo $ac_option | cut -d '=' -f 2`
         ZLIB_CFLAGS="-I$_prefix/include"
@@ -1054 +1065 @@
 echo "$_mad"
 
 #
+# Check for MikMod (MOD decoder library)
+#
+
+echocheck "MikMod"
+if test "$_mikmod" = auto ; then
+        _mikmod=no
+        cat > $TMPC << EOF
+#include <mikmod.h>
+int main(void) {return 0; }
+EOF
+        cc_check $LDFLAGS $CXXFLAGS $MIKMOD_CFLAGS $MIKMOD_LIBS -lmikmod && _mikmod=yes
+fi
+if test "$_mikmod" = yes ; then
+        _def_mikmod='#define USE_MIKMOD'
+        LIBS="$LIBS $MIKMOD_LIBS -lmikmod"
+        INCLUDES="$INCLUDES $MIKMOD_CFLAGS"
+else
+        _def_mikmod='#undef USE_MIKMOD'
+fi
+echo "$_mikmod"
+
+#
 # Check for ALSA
 #
 echocheck "ALSA >= 0.9"
@@ -1304 +1337 @@
 $_def_vorbis
 $_def_tremor
 $_def_flac
+$_def_mikmod
 $_def_mad
 $_def_alsa
 $_def_zlib

sound/audiocd.cpp

@@ -25 +25 @@
 #include "sound/mp3.h"
 #include "sound/vorbis.h"
 #include "sound/flac.h"
+#include "sound/mod.h"
 #include "base/engine.h"
 #include "common/file.h"
 #include "common/util.h"
@@ -53 +54 @@
 #ifdef USE_MAD
         { "Mpeg Layer 3",       getMP3Track },
 #endif
+#ifdef USE_MIKMOD
+        { "MOD",                        getMODTrack },
+#endif
 
         { NULL, NULL } // Terminator
 };

sound/mixer.cpp

@@ -32 +32 @@
 #include "sound/flac.h"
 #include "sound/mp3.h"
 #include "sound/vorbis.h"
+#include "sound/mod.h"
 
 
 namespace Audio {
@@ -125 +126 @@
                 error("OSystem returned invalid sample rate");
 
         debug(1, "Output sample rate: %d Hz", _outputRate);
+
+#ifdef USE_MIKMOD
+        initMOD(this);
+#endif
 }
 
 Mixer::~Mixer() {
@@ -133 +138 @@
 
         delete _premixChannel;
         _premixChannel = 0;
+
+#ifdef USE_MIKMOD
+        exitMOD();
+#endif
 }
 
 bool Mixer::isPaused() {

sound/mod.cpp

@@ +1 @@
+/* ScummVM - Scumm Interpreter
+ * Copyright (C) 2003-2005 The ScummVM project
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $Header:$
+ *
+ */
+
+#include "sound/mod.h"
+
+#ifdef USE_MIKMOD
+
+#include "common/file.h"
+#include "common/util.h"
+
+#include "sound/audiostream.h"
+#include "sound/audiocd.h"
+
+#include <mikmod.h>
+
+
+using Common::File;
+
+
+void initMOD(Audio::Mixer *mixer) {
+        // We only use the MikMod library for decoding. Therefore, we only need
+        // the "No Sound" driver.
+        MikMod_RegisterDriver(&drv_nos);
+        MikMod_RegisterAllLoaders();
+
+        md_mixfreq = mixer->getOutputRate();
+
+        CHAR mmArgs[] = "";
+
+        MikMod_Init(mmArgs);
+}
+
+void exitMOD() {
+        MikMod_Exit();
+}
+
+
+#pragma mark -
+#pragma mark --- MOD Audio CD emulation ---
+#pragma mark -
+
+class MODTrackInfo : public DigitalTrackInfo {
+private:
+        File *_file;
+        MODULE *_module;
+        bool _error_flag;
+
+public:
+        MODTrackInfo(File *file);
+        ~MODTrackInfo();
+        bool openTrack();
+        bool error() { return _error_flag; }
+        void play(Audio::Mixer *mixer, Audio::SoundHandle *handle, int startFrame, int duration);
+};
+
+
+// These are wrapper functions to allow using a File object to provide data to
+// the MOD reader
+
+struct MFILEREADER {
+        MREADER core;
+        MODULE *module;
+        File *file;
+};
+
+static int mm_eof_wrapper(struct MREADER *reader) {
+        return ((MFILEREADER *)reader)->file->eof();
+}
+
+static BOOL mm_read_wrapper(struct MREADER *reader, void *dest, size_t length) {
+        return ((MFILEREADER *)reader)->file->read(dest, length);
+}
+
+static int mm_get_wrapper(struct MREADER *reader) {
+        File *file = ((MFILEREADER *)reader)->file;
+
+        if (file->eof())
+                return EOF;
+
+        return file->readByte();
+}
+
+static BOOL mm_seek_wrapper(struct MREADER *reader, long offset, int whence) {
+        ((MFILEREADER *)reader)->file->seek(offset, whence);
+        return 0;
+}
+
+static long mm_tell_wrapper(struct MREADER *reader) {
+        return ((MFILEREADER *)reader)->file->pos();
+}
+
+static MODULE *loadModuleFromFile(File *file) {
+        assert(file);
+
+        MFILEREADER *reader = (MFILEREADER *)malloc(sizeof(MFILEREADER));
+
+        assert(reader);
+
+        reader->core.Eof = &mm_eof_wrapper;
+        reader->core.Read = &mm_read_wrapper;
+        reader->core.Get = &mm_get_wrapper;
+        reader->core.Seek = &mm_seek_wrapper;
+        reader->core.Tell = &mm_tell_wrapper;
+
+        reader->file = file;
+
+        MODULE *module = Player_LoadGeneric((MREADER *)reader, 64, 0);
+
+        if (!module) {
+                free(reader);
+                return NULL;
+        }
+
+        file->incRef();
+
+        Player_Start(module);
+        Player_SetPosition(0);
+
+        return module;
+}
+
+MODTrackInfo::MODTrackInfo(File *file) {
+        _file = file;
+
+        if (openTrack()) {
+                warning("Invalid file format");
+                _error_flag = true;
+                _file = 0;
+        } else {
+                _error_flag = false;
+                _file->incRef();
+        }
+}
+
+MODTrackInfo::~MODTrackInfo() {
+        if (!_error_flag) {
+                Player_Free(_module);
+        }
+}
+
+bool MODTrackInfo::openTrack() {
+        assert(_file);
+
+        _module = loadModuleFromFile(_file);
+
+        if (!_module) {
+                return 1;
+        }
+
+        return 0;
+}
+
+void MODTrackInfo::play(Audio::Mixer *mixer, Audio::SoundHandle *handle, int startFrame, int duration) {
+        // TODO: We don't handle position or duration at all
+
+        bool err = openTrack();
+        assert(!err);
+
+        AudioStream *input = makeMODStream(_file);
+        mixer->playInputStream(Audio::Mixer::kMusicSoundType, handle, input);
+}
+
+DigitalTrackInfo *getMODTrack(int track) {
+        char track_name[32];
+        File *file = new File();
+
+        // TODO: MikMod can handle a lot more MOD file types than this
+        sprintf(track_name, "track%d.mod", track);
+        file->open(track_name);
+
+        if (file->isOpen()) {
+                MODTrackInfo *trackInfo = new MODTrackInfo(file);
+                file->decRef();
+                if (!trackInfo->error())
+                        return trackInfo;
+                delete trackInfo;
+        }
+        delete file;
+        return NULL;
+}
+
+#pragma mark -
+#pragma mark --- MOD stream ---
+#pragma mark -
+
+
+class MODInputStream : public AudioStream {
+private:
+        int16 _buffer[4096];
+        const int16 *_bufferEnd;
+        const int16 *_pos;
+        MODULE *_module;
+
+        void refill();
+        inline bool eosIntern() const;
+
+public:
+        MODInputStream(File *file);
+        ~MODInputStream();
+
+        int readBuffer(int16 *buffer, const int numSamples);
+
+        bool endOfData() const          { return eosIntern(); }
+        bool isStereo() const           { return true; }
+
+        int getRate() const             { return md_mixfreq; }
+};
+
+MODInputStream::MODInputStream(File *file) {
+        _module = loadModuleFromFile(file);
+
+        // Read in initial data
+        refill();
+}
+
+MODInputStream::~MODInputStream() {
+        if (_module) {
+                Player_Free(_module);
+        }
+}
+
+inline bool MODInputStream::eosIntern() const {
+        return _pos >= _bufferEnd;
+}
+
+int MODInputStream::readBuffer(int16 *buffer, const int numSamples) {
+        int samples = 0;
+        while (samples < numSamples && !eosIntern()) {
+                const int len = MIN(numSamples - samples, (int)(_bufferEnd - _pos));
+                memcpy(buffer, _pos, len * 2);
+                buffer += len;
+                _pos += len;
+                samples += len;
+                if (_pos >= _bufferEnd) {
+                        refill();
+                }
+        }
+        return samples;
+}
+
+void MODInputStream::refill() {
+        // Read the samples
+        uint len_left = sizeof(_buffer);
+        char *read_pos = (char *)_buffer;
+
+        Player_Start(_module);
+
+        int len = VC_WriteBytes((SBYTE *)_buffer, len_left);
+
+        len_left -= len;
+        read_pos += len;
+
+        _pos = _buffer;
+        _bufferEnd = (int16 *)read_pos;
+}
+
+AudioStream *makeMODStream(File *file) {
+        return new MODInputStream(file);
+}
+
+#endif

sound/mod.h

@@ +1 @@
+/* ScummVM - Scumm Interpreter
+ * Copyright (C) 2003-2005 The ScummVM project
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $Header:$
+ *
+ */
+
+#ifndef SOUND_MOD_H
+#define SOUND_MOD_H
+
+#include "common/stdafx.h"
+#include "common/scummsys.h"
+
+#ifdef USE_MIKMOD
+
+class AudioStream;
+class DigitalTrackInfo;
+namespace Common {
+        class File;
+}
+namespace Audio {
+        class Mixer;
+}
+
+DigitalTrackInfo *getMODTrack(int track);
+
+void initMOD(Audio::Mixer *mixer);
+void exitMOD();
+
+AudioStream *makeMODStream(Common::File *file);
+
+#endif
+
+#endif

sound/module.mk

@@ -11 +11 @@
         sound/midiparser_smf.o \
         sound/midiparser_xmidi.o \
         sound/mixer.o \
+        sound/mod.o \
         sound/mp3.o \
         sound/mpu401.o \
         sound/rate.o \