rubysdl_mixer.c

/*
  Ruby/SDL   Ruby extension library for SDL

  Copyright (C) 2001-2007 Ohbayashi Ippei
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
#include "rubysdl.h"
#ifdef HAVE_SDL_MIXER
#define USE_RWOPS
#include <SDL_mixer.h>

static VALUE mMixer;
static VALUE cWave;
static VALUE cMusic;

static VALUE playing_wave = Qnil;
static VALUE playing_music = Qnil;

static int Mix_opened(void)
{
  return Mix_QuerySpec(NULL, NULL, NULL);
}

typedef struct {
  Mix_Chunk* chunk;
} Wave;

typedef struct {
  Mix_Music* music;
} Music;

DEFINE_GET_STRUCT(Wave, GetWave, cWave, "SDL::Mixer::Wave");
static Mix_Chunk* Get_Mix_Chunk(VALUE obj)
{
  Wave* wave = GetWave(obj);
  if(wave->chunk == NULL)
    rb_raise(eSDLError, "Wave data is already disposed");
  return wave->chunk;
}
static void Wave_free(Wave* wave)
{
  if(Mix_opened() && wave->chunk)
    Mix_FreeChunk(wave->chunk);
  free(wave);
}

static VALUE Wave_s_alloc(VALUE klass)
{
  Wave* wave = ALLOC(Wave);
  wave->chunk = NULL;
  return Data_Wrap_Struct(klass, 0, Wave_free, wave);
}
static VALUE Wave_create(Mix_Chunk* chunk)
{
  VALUE newobj = Wave_s_alloc(cWave);
  GetWave(newobj)->chunk = chunk;
  return newobj;
}

DEFINE_GET_STRUCT(Music, GetMusic, cMusic, "SDL::Mixer::Music");
static Mix_Music* Get_Mix_Music(VALUE obj)
{
  Music* mus = GetMusic(obj);
  if(mus->music == NULL)
    rb_raise(eSDLError, "Wave data is already disposed");
  return mus->music;
}
static void Music_free(Music* mus)
{
  if(Mix_opened() && mus->music)
    Mix_FreeMusic(mus->music);
  free(mus);
}
static VALUE Music_s_alloc(VALUE klass)
{
  Music* mus = ALLOC(Music);
  mus->music = NULL;
  return Data_Wrap_Struct(klass, 0, Music_free, mus);
}
static VALUE Music_create(Mix_Music* music)
{
  VALUE newobj = Music_s_alloc(cMusic);
  GetMusic(newobj)->music = music;
  return newobj;
}

static VALUE Mixer_s_driverName(VALUE mod)
{
  char driver_name[512];
  if(SDL_AudioDriverName(driver_name, sizeof(driver_name)) == NULL)
    rb_raise(eSDLError, "No driver has been initialized: %s", SDL_GetError());
  return rb_str_new2(driver_name);
}

static VALUE Mixer_s_open(VALUE mod, VALUE frequency, VALUE format,
			   VALUE channels, VALUE chunksize)
{
  
  if(Mix_opened()){
    rb_raise(eSDLError, "already initialize SDL::Mixer");
  }
  if( Mix_OpenAudio(NUM2INT(frequency), NUM2UINT(format), NUM2INT(channels), 
                    NUM2INT(chunksize)) < 0 ){
    rb_raise(eSDLError, "Couldn't open audio: %s", SDL_GetError());
  }

  return Qnil;
}

static VALUE Mixer_s_close(VALUE mod)
{
  Mix_CloseAudio();
  return Qnil;
}

static VALUE Mixer_s_spec(VALUE mod)
{
  int rate;
  Uint16 format;
  int channels;

  if( !Mix_QuerySpec(&rate, &format, &channels) )
    rb_raise(eSDLError,"audio have not been opened yet: %s",
             Mix_GetError());
  return rb_ary_new3(3, INT2NUM(rate), UINT2NUM(format), INT2NUM(channels));

}

static VALUE Mixer_s_allocateChannels(VALUE mod, VALUE numchannels)
{
  return INT2FIX( Mix_AllocateChannels(NUM2INT(numchannels)) );  
}

/* Returns which channel was used to play the sound. */
static VALUE Mixer_s_playChannel(VALUE mod, VALUE channel, VALUE wave, VALUE loops)
{
  int play_channel;

  play_channel = Mix_PlayChannel(NUM2INT(channel),
                                 Get_Mix_Chunk(wave),
                                 NUM2INT(loops));
                            
  if( play_channel == -1 )
    rb_raise(eSDLError, "couldn't play wave: %s",
             Mix_GetError());
  
  rb_ary_store(playing_wave, play_channel, wave);/* to avoid gc problem */
  return INT2FIX(play_channel);
}
  
static VALUE Mixer_s_playChannelTimed(VALUE mod,
                                      VALUE channel,
                                      VALUE wave,
                                      VALUE loops,
                                      VALUE ticks)
{
  int play_channel;
  
  play_channel = Mix_PlayChannelTimed(NUM2INT(channel),
                                      Get_Mix_Chunk(wave),
                                      NUM2INT(loops),
                                      NUM2INT(ticks));
  if( play_channel == -1 ){
    rb_raise(eSDLError, "couldn't play wave: %s",
             Mix_GetError());
  }

  rb_ary_store(playing_wave, play_channel, wave);/* to avoid gc problem */
  return INT2FIX(play_channel);
}

static VALUE Mixer_s_fadeInChannel(VALUE mod,
                                   VALUE channel,
                                   VALUE wave,
                                   VALUE loops,
                                   VALUE ms)
{
  int playing_channel;
  
  playing_channel = Mix_FadeInChannel(NUM2INT(channel),
                                      Get_Mix_Chunk(wave),
                                      NUM2INT(loops),
                                      NUM2INT(ms));
  if( playing_channel == -1 ){
    rb_raise(eSDLError, "couldn't play wave: %s",
             Mix_GetError());
  }
  /* to avoid gc problem */
  rb_ary_store(playing_wave, playing_channel, wave);
  return INT2FIX(playing_channel);
}

static VALUE Mixer_s_fadeInChannelTimed(VALUE mod,
                                        VALUE channel,
                                        VALUE wave,
                                        VALUE loops,
                                        VALUE ms, VALUE ticks)
{
  int playing_channel;
  
  playing_channel = Mix_FadeInChannelTimed(NUM2INT(channel),
                                           Get_Mix_Chunk(wave),
                                           NUM2INT(loops),
                                           NUM2INT(ms),
                                           NUM2INT(ticks));
  if( playing_channel == -1 ){
    rb_raise(eSDLError, "couldn't play wave: %s",
             Mix_GetError());
  }
  /* to avoid gc problem */
  rb_ary_store(playing_wave, playing_channel, wave);
  return INT2FIX(playing_channel);
}

static VALUE Mixer_s_play_p(VALUE mod, VALUE channel)
{
  return INT2BOOL(Mix_Playing(NUM2INT(channel)));
}

static VALUE Mixer_s_playing_channels(VALUE mod)
{
  return INT2NUM(Mix_Playing(-1));
}

static VALUE Wave_s_load(VALUE class, VALUE filename)
{
  Mix_Chunk *chunk;
  
  ExportFilenameStringValue(filename);
  
  chunk = Mix_LoadWAV(RSTRING_PTR(filename));
  if( chunk == NULL ){
    rb_raise(eSDLError, "Couldn't load wave file %s: %s",
             RSTRING_PTR(filename), SDL_GetError());
  }
  return Wave_create(chunk);
}

static VALUE Wave_s_loadFromIO(VALUE class, VALUE io)
{
  Mix_Chunk *wave;
  wave = Mix_LoadWAV_RW(rubysdl_RWops_from_ruby_obj(io), 1);
  if( wave == NULL ){
    rb_raise(eSDLError, "Couldn't load wave file from IO: %s",
             Mix_GetError());
  }
  return Wave_create(wave);
}

static VALUE Wave_s_loadFromString(VALUE class, VALUE str)
{
  Mix_Chunk *wave;
  SafeStringValue(str);
  
  wave = Mix_LoadWAV_RW(SDL_RWFromConstMem(RSTRING_PTR(str),
                                           RSTRING_LEN(str)),
                        1);
  if( wave == NULL ){
    rb_raise(eSDLError, "Couldn't load wave file from String: %s",
             Mix_GetError());
  }
  return Wave_create(wave);
}


/* Volume setting functions and methods : volume in 0..128 */
static VALUE Mixer_s_setVolume(VALUE mod, VALUE channel, VALUE volume)
{
  return INT2FIX(Mix_Volume(NUM2INT(channel), NUM2INT(volume)));
}

static VALUE Wave_s_setVolume(VALUE self, VALUE volume)
{
  return INT2FIX(Mix_VolumeChunk(Get_Mix_Chunk(self), NUM2INT(volume)));
}

/* Halt,Pause function */
static VALUE Mixer_s_halt(VALUE mod, VALUE channel)
{
  Mix_HaltChannel(NUM2INT(channel));
  return Qnil;
}

static VALUE Mixer_s_pause(VALUE mod, VALUE channel)
{
  Mix_Pause(NUM2INT(channel));
  return Qnil;
}

static VALUE Mixer_s_resume(VALUE mod, VALUE channel)
{
  Mix_Resume(NUM2INT(channel));
  return Qnil;
}

static VALUE Mixer_s_pause_p(VALUE mod, VALUE channel)
{
  return INT2FIX(Mix_Paused(NUM2INT(channel)));
}
static VALUE Mixer_s_fadeOut(VALUE mod, VALUE channel, VALUE ms)
{
  return INT2FIX(Mix_FadeOutChannel(NUM2INT(channel), NUM2INT(ms)));
}
static VALUE Mixer_s_expire(VALUE mod, VALUE channel, VALUE ticks)
{
  return INT2FIX(Mix_ExpireChannel(NUM2INT(channel),NUM2INT(ticks)));
}
static VALUE Mixer_s_fading(VALUE mod, VALUE which)
{
  if( NUM2INT(which) < 0 || Mix_AllocateChannels(-1) <= NUM2INT(which))
    rb_raise(eSDLError, "channel %d out of range", NUM2INT(which));
  return INT2FIX(Mix_FadingChannel(NUM2INT(which)));
}
  
/* music functions */
#define MakeSimpleRubyFunc(rubyFunc, sdlFunc) \
static VALUE rubyFunc(VALUE mod) \
{ \
  sdlFunc(); \
  return Qnil; \
} \

static VALUE Mixer_s_playMusic(VALUE mod, VALUE music, VALUE loops)
{

  Mix_PlayMusic(Get_Mix_Music(music), NUM2INT(loops));
  playing_music = music; /* to avoid gc problem */
  return Qnil;
}

static VALUE Mixer_s_fadeInMusic(VALUE mod, VALUE music, VALUE loops, VALUE ms)
{
  Mix_FadeInMusic(Get_Mix_Music(music), NUM2INT(loops), NUM2INT(ms));
  playing_music = music; /* to avoid gc problem */
  return Qnil;
}

static VALUE Mixer_s_setVolumeMusic(VALUE mod, VALUE volume)
{
  Mix_VolumeMusic( NUM2INT(volume) );
  return Qnil;
}

static VALUE Mixer_s_fadeOutMusic(VALUE mod, VALUE ms)
{
  Mix_FadeOutMusic(NUM2INT(ms));
  return Qnil;
}

MakeSimpleRubyFunc(Mixer_s_haltMusic, Mix_HaltMusic)
MakeSimpleRubyFunc(Mixer_s_pauseMusic, Mix_PauseMusic)
MakeSimpleRubyFunc(Mixer_s_resumeMusic, Mix_ResumeMusic)
MakeSimpleRubyFunc(Mixer_s_rewindMusic, Mix_RewindMusic)

static VALUE Mixer_s_pauseMusic_p(VALUE mod)
{
  return INT2BOOL(Mix_PausedMusic());
}

static VALUE Mixer_s_playMusic_p(VALUE mod)
{
  return INT2BOOL(Mix_PlayingMusic());
}

static VALUE Mixer_s_fadingMusic(VALUE mod)
{
  return INT2FIX(Mix_FadingMusic());
}

static VALUE Music_s_load(VALUE class, VALUE filename)
{
  Mix_Music* music;
  
  ExportFilenameStringValue(filename);
  
  music = Mix_LoadMUS(RSTRING_PTR(filename));
  if( music == NULL )
        rb_raise(eSDLError, 
                 "Couldn't load %s: %s", RSTRING_PTR(filename),
                 SDL_GetError());
  return Music_create(music);
}

#ifdef HAVE_MIX_LOADMUS_RW
static VALUE Mixer_s_loadMusFromString(VALUE class, VALUE str)
{
  Mix_Music* music;
  volatile VALUE result;
  volatile VALUE buf;
  
  StringValue(str);
  buf = rb_str_dup(str);
  music = Mix_LoadMUS_RW(SDL_RWFromConstMem(RSTRING_PTR(buf),
                                            RSTRING_LEN(buf)));
  
  if( music == NULL )
    rb_raise(eSDLError,
	     "Couldn't load from String: %s",Mix_GetError());
  
  result = Music_create(music);
  rb_iv_set(result, "buf", buf);

  RB_GC_GUARD(result); RB_GC_GUARD(buf);
  return result;
}
#endif

static VALUE Wave_destroy(VALUE self)
{
  Wave* wave = GetWave(self);
  if (wave->chunk) {
    Mix_FreeChunk(wave->chunk);
    wave->chunk = NULL;
  }
  return Qnil;
}
static VALUE Wave_destroyed(VALUE self)
{
  Wave* wave = GetWave(self);
  return INT2BOOL(wave->chunk == NULL);
}

static VALUE Music_destroy(VALUE self)
{
  Music* mus = GetMusic(self);
  if (mus->music) {
    Mix_FreeMusic(mus->music);
    mus->music = NULL;
  }
  return Qnil;
}
static VALUE Music_destroyed(VALUE self)
{
  Music* mus = GetMusic(self);
  return INT2BOOL(mus->music == NULL);
}

void rubysdl_init_Mixer(VALUE mSDL)
{
  mMixer = rb_define_module_under(mSDL, "Mixer");
  rb_define_module_function(mMixer, "open", Mixer_s_open, 4);
  rb_define_module_function(mMixer, "close", Mixer_s_close, 0);
  rb_define_module_function(mMixer, "spec", Mixer_s_spec, 0);
  rb_define_module_function(mMixer, "driverName", Mixer_s_driverName, 0);
  rb_define_module_function(mMixer, "playChannel", Mixer_s_playChannel, 3);
  rb_define_module_function(mMixer, "playChannelTimed", Mixer_s_playChannelTimed, 4);
  rb_define_module_function(mMixer, "fadeInChannel", Mixer_s_fadeInChannel, 4);
  rb_define_module_function(mMixer, "fadeInChannelTimed", Mixer_s_fadeInChannelTimed, 5);
  
  rb_define_module_function(mMixer, "play?", Mixer_s_play_p, 1);
  rb_define_module_function(mMixer, "playingChannels", Mixer_s_playing_channels, 0);
  rb_define_module_function(mMixer, "setVolume", Mixer_s_setVolume, 2);
  rb_define_module_function(mMixer, "allocateChannels", Mixer_s_allocateChannels, 1);
  
  rb_define_module_function(mMixer, "halt", Mixer_s_halt, 1);
  rb_define_module_function(mMixer, "pause", Mixer_s_pause, 1);
  rb_define_module_function(mMixer, "resume", Mixer_s_resume, 1);
  rb_define_module_function(mMixer, "pause?", Mixer_s_pause_p, 1);
  rb_define_module_function(mMixer, "expire", Mixer_s_expire, 2);
  rb_define_module_function(mMixer, "fading", Mixer_s_fading, 1);
  rb_define_module_function(mMixer, "fadeOut", Mixer_s_fadeOut, 2);
  
  rb_define_module_function(mMixer, "playMusic", Mixer_s_playMusic, 2);
  rb_define_module_function(mMixer, "fadeInMusic", Mixer_s_fadeInMusic, 3);
  rb_define_module_function(mMixer, "setVolumeMusic", Mixer_s_setVolumeMusic, 1);
  rb_define_module_function(mMixer, "haltMusic", Mixer_s_haltMusic, 0);
  rb_define_module_function(mMixer, "fadeOutMusic", Mixer_s_fadeOutMusic, 1);
  rb_define_module_function(mMixer, "pauseMusic", Mixer_s_pauseMusic, 0);
  rb_define_module_function(mMixer, "resumeMusic", Mixer_s_resumeMusic, 0);
  rb_define_module_function(mMixer, "rewindMusic", Mixer_s_rewindMusic, 0);
  rb_define_module_function(mMixer, "pauseMusic?", Mixer_s_pauseMusic_p, 0);
  rb_define_module_function(mMixer, "playMusic?", Mixer_s_playMusic_p, 0);
  rb_define_module_function(mMixer, "fadingMusic", Mixer_s_fadingMusic, 0);

  cWave = rb_define_class_under(mMixer, "Wave", rb_cObject);
  rb_define_singleton_method(cWave, "load", Wave_s_load, 1);
  rb_define_singleton_method(cWave, "loadFromIO", Wave_s_loadFromIO,1);
  rb_define_singleton_method(cWave, "loadFromString", Wave_s_loadFromString,1);
  rb_define_method(cWave, "setVolume", Wave_s_setVolume, 1);
  
  cMusic = rb_define_class_under(mMixer, "Music", rb_cObject);
  rb_define_singleton_method(cMusic, "load", Music_s_load, 1);
#ifdef HAVE_MIX_LOADMUS_RW
  rb_define_singleton_method(cMusic, "loadFromString",
                             Mixer_s_loadMusFromString,1);
#endif
  rb_define_method(cWave, "destroy", Wave_destroy, 0);
  rb_define_method(cWave, "destroyed?", Wave_destroyed, 0);
  rb_define_method(cMusic, "destroy", Music_destroy, 0);
  rb_define_method(cMusic, "destroyed?", Music_destroyed, 0);
  
  /* to avoid to do garbage collect when playing */
  rb_global_variable( &playing_wave );
  rb_global_variable( &playing_music );
  playing_wave = rb_ary_new();

  rb_define_const(mMixer, "FORMAT_U8", UINT2NUM(AUDIO_U8));
  rb_define_const(mMixer, "FORMAT_S8", UINT2NUM(AUDIO_S8));
  rb_define_const(mMixer, "FORMAT_U16LSB", UINT2NUM(AUDIO_U16LSB));
  rb_define_const(mMixer, "FORMAT_S16LSB", UINT2NUM(AUDIO_S16LSB));
  rb_define_const(mMixer, "FORMAT_U16MSB", UINT2NUM(AUDIO_U16MSB));
  rb_define_const(mMixer, "FORMAT_S16MSB", UINT2NUM(AUDIO_S16MSB));
  rb_define_const(mMixer, "FORMAT_U16", UINT2NUM(AUDIO_U16));
  rb_define_const(mMixer, "FORMAT_S16", UINT2NUM(AUDIO_S16));

  rb_define_const(mMixer, "FORMAT_U16SYS", UINT2NUM(AUDIO_U16SYS));
  rb_define_const(mMixer, "FORMAT_S16SYS", UINT2NUM(AUDIO_S16SYS));

  rb_define_const(mMixer, "CHANNELS", INT2NUM(MIX_CHANNELS));
  rb_define_const(mMixer, "DEFAULT_FREQUENCY", INT2NUM(MIX_DEFAULT_FREQUENCY));
  rb_define_const(mMixer, "DEFAULT_FORMAT", UINT2NUM(MIX_DEFAULT_FORMAT));
  rb_define_const(mMixer, "DEFAULT_CHANNELS", UINT2NUM(MIX_DEFAULT_CHANNELS));
  rb_define_const(mMixer, "MAX_VOLUME", INT2NUM(MIX_MAX_VOLUME));

  rb_define_const(mMixer, "NO_FADING", INT2NUM(MIX_NO_FADING));
  rb_define_const(mMixer, "FADING_OUT", INT2NUM(MIX_FADING_OUT));
  rb_define_const(mMixer, "FADING_IN", INT2NUM(MIX_FADING_IN));
  return;
}

void rubysdl_quit_Mixer(void)
{
  if(Mix_opened()){
    Mix_CloseAudio();
  }
}
#else /* HAVE_SDL_MIXER */
void rubysdl_init_Mixer(VALUE mSDL)
{
}
void rubysdl_quit_Mixer(void)
{
}
#endif  /* HAVE_SDL_MIXER */