ruby-sdl-ffi 0.1

data/lib/ruby-sdl-ffi/mixer.rb

@@ -0,0 +1,215 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#++
+
+
+this_dir = File.expand_path( File.dirname(__FILE__) )
+
+require File.join( this_dir, "sdl" )
+
+
+module SDL
+  module Mixer
+    extend NiceFFI::Library
+    load_library "SDL_mixer", SDL::LOAD_PATHS
+
+
+    def self.mix_func( name, args, ret )
+      func name, "Mix_#{name}", args, ret
+    end
+
+
+    mix_func  :Linked_Version, [], SDL::Version.typed_pointer
+
+
+    CHANNELS          = 8
+    DEFAULT_FREQUENCY = 22050
+    DEFAULT_CHANNELS  = 2
+
+    DEFAULT_FORMAT    = if( FFI::Platform::BYTE_ORDER ==
+                            FFI::Platform::LITTLE_ENDIAN)
+                          AUDIO_S16LSB
+                        else
+                          AUDIO_S16MSB
+                        end
+
+    MAX_VOLUME        = 128
+
+
+    class Chunk < NiceFFI::Struct
+      layout( :allocated, :int,
+              :abuf,      :pointer,
+              :alen,      :uint32,
+              :volume,    :uint8 )
+
+      def self.release( pointer )
+        SDL::Mixer.FreeChunk( pointer )
+      end
+    end
+
+
+
+    class Music < NiceFFI::OpaqueStruct
+      #--
+      # Mix_Music struct (in C) has a hidden layout, which changes
+      # depending on which sound format libraries were available
+      # at compile time.
+      #++
+
+      def self.release( pointer )
+        SDL::Mixer.FreeMusic( pointer )
+      end
+    end
+
+
+
+    NO_FADING   = 0
+    FADING_OUT  = 1
+    FADING_IN   = 2
+
+    MUS_NONE    = 0
+    MUS_CMD     = 1
+    MUS_WAV     = 2
+    MUS_MOD     = 3
+    MUS_MID     = 4
+    MUS_OGG     = 5
+    MUS_MP3     = 6
+    MUS_MP3_MAD = 7
+
+
+    mix_func  :OpenAudio,        [ :int, :uint16, :int, :int    ], :int
+    mix_func  :AllocateChannels, [ :int                         ], :int
+    mix_func  :QuerySpec,        [ :pointer, :pointer, :pointer ], :int
+
+
+    def self.LoadWAV( file )
+      LoadWAV_RW( SDL.RWFromFile(file, "rb"), 1 )
+    end
+
+    mix_func  :LoadWAV_RW,    [ :pointer, :int    ], Chunk.typed_pointer
+    mix_func  :LoadMUS,       [ :string           ], Music.typed_pointer
+    mix_func  :LoadMUS_RW,    [ :pointer          ], Music.typed_pointer
+    mix_func  :QuickLoad_WAV, [ :pointer          ], Chunk.typed_pointer
+    mix_func  :QuickLoad_RAW, [ :pointer, :uint32 ], Chunk.typed_pointer
+
+
+    mix_func  :FreeChunk,     [ :pointer ], :void
+    mix_func  :FreeMusic,     [ :pointer ], :void
+
+
+    mix_func  :GetMusicType,  [ :pointer ], :int
+
+
+    callback( :mix_hook_cb, [:pointer, :pointer, :int], :void)
+
+    mix_func  :SetPostMix,        [ :mix_hook_cb, :pointer  ], :void
+    mix_func  :HookMusic,         [ :mix_hook_cb, :pointer  ], :void
+    mix_func  :HookMusicFinished, [ callback([], :void)     ], :void
+    mix_func  :GetMusicHookData,  [                         ], :pointer
+    mix_func  :ChannelFinished,   [ callback([:int], :void) ], :void
+
+
+    CHANNEL_POST = -2
+
+
+    callback(:mix_effectfunc_cb, [ :int, :pointer, :int, :pointer ], :void)
+    callback(:mix_effectdone_cb, [ :int, :pointer ], :void)
+
+    mix_func  :RegisterEffect,
+          [ :int, :mix_effectfunc_cb, :mix_effectdone_cb, :pointer ], :int
+
+    mix_func  :UnregisterEffect,     [ :int, :mix_effectfunc_cb ], :int
+    mix_func  :UnregisterAllEffects, [ :int ], :int
+
+
+    EFFECTSMAXSPEED = "MIX_EFFECTSMAXSPEED"
+
+
+    mix_func  :SetPanning,         [ :int, :uint8, :uint8 ], :int
+    mix_func  :SetPosition,        [ :int, :int16, :uint8 ], :int
+    mix_func  :SetDistance,        [ :int, :uint8         ], :int
+    mix_func  :SetReverseStereo,   [ :int, :int           ], :int
+
+               
+    mix_func  :ReserveChannels,    [ :int                 ], :int
+    mix_func  :GroupChannel,       [ :int, :int           ], :int
+    mix_func  :GroupChannels,      [ :int, :int, :int     ], :int
+    mix_func  :GroupAvailable,     [ :int                 ], :int
+    mix_func  :GroupCount,         [ :int                 ], :int
+    mix_func  :GroupOldest,        [ :int                 ], :int
+    mix_func  :GroupNewer,         [ :int                 ], :int
+
+
+    mix_func  :PlayChannelTimed,   [ :int, :pointer, :int, :int       ], :int
+    mix_func  :PlayMusic,          [ :pointer, :int                   ], :int
+    mix_func  :FadeInMusic,        [ :pointer, :int, :int             ], :int
+    mix_func  :FadeInMusicPos,     [ :pointer, :int, :int, :double    ], :int
+    mix_func  :FadeInChannelTimed, [ :int, :pointer, :int, :int, :int ], :int
+
+
+    mix_func  :Volume,             [ :int, :int     ], :int
+    mix_func  :VolumeChunk,        [ :pointer, :int ], :int
+    mix_func  :VolumeMusic,        [ :int           ], :int
+
+
+    mix_func  :HaltChannel,        [ :int           ], :int
+    mix_func  :HaltGroup,          [ :int           ], :int
+    mix_func  :HaltMusic,          [                ], :int
+    mix_func  :ExpireChannel,      [ :int, :int     ], :int
+
+
+    mix_func  :FadeOutChannel,     [ :int, :int     ], :int
+    mix_func  :FadeOutGroup,       [ :int, :int     ], :int
+    mix_func  :FadeOutMusic,       [ :int           ], :int
+    mix_func  :FadingMusic,        [                ], :int
+    mix_func  :FadingChannel,      [ :int           ], :int
+
+
+    mix_func  :Pause,              [ :int           ], :void
+    mix_func  :Resume,             [ :int           ], :void
+    mix_func  :Paused,             [ :int           ], :int
+    mix_func  :PauseMusic,         [                ], :void
+    mix_func  :ResumeMusic,        [                ], :void
+    mix_func  :RewindMusic,        [                ], :void
+    mix_func  :PausedMusic,        [                ], :int
+
+
+    mix_func  :SetMusicPosition,   [ :double ], :int
+    mix_func  :Playing,            [ :int    ], :int
+    mix_func  :PlayingMusic,       [         ], :int
+    mix_func  :SetMusicCMD,        [ :string ], :int
+
+    mix_func  :SetSynchroValue,    [ :int    ], :int
+    mix_func  :GetSynchroValue,    [         ], :int
+
+    mix_func  :GetChunk,           [ :int    ], Chunk.typed_pointer
+
+    mix_func  :CloseAudio,         [         ], :void
+
+  end
+end

data/lib/ruby-sdl-ffi/sdl.rb

@@ -0,0 +1,76 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#++
+
+
+require 'nice-ffi'
+
+
+module SDL
+  extend NiceFFI::Library
+
+  unless defined? SDL::LOAD_PATHS
+    # Check if the application has defined SDL_PATHS with some
+    # paths to check first for SDL libraries.
+    SDL::LOAD_PATHS = if defined? ::SDL_PATHS
+                        NiceFFI::PathSet::DEFAULT.prepend( ::SDL_PATHS )
+                      else
+                        NiceFFI::PathSet::DEFAULT
+                      end
+  end
+
+  load_library "SDL", SDL::LOAD_PATHS
+
+  def self.sdl_func( name, args, ret )
+    func name, "SDL_#{name}", args, ret
+  end
+
+end
+
+
+this_dir = File.expand_path( File.dirname(__FILE__) )
+
+# NOTE: keyboard and video are deliberately loaded early,
+# because event and mouse depend on them, respectively.
+
+%w{
+  core
+  keyboard
+  video
+  audio
+  cdrom
+  event
+  joystick
+  keysyms
+  mouse
+  mutex
+  rwops
+  timer
+}.each do |f|
+  require File.join( this_dir, "sdl", f )
+end

data/lib/ruby-sdl-ffi/sdl/audio.rb

@@ -0,0 +1,132 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#++
+
+
+module SDL
+
+  class AudioSpec < NiceFFI::Struct
+
+    SDL::callback(:audiospec_cb, [ :pointer, :pointer, :int ], :void)
+
+    layout( :freq,     :int,
+            :format,   :uint16,
+            :channels, :uint8,
+            :silence,  :uint8,
+            :samples,  :uint16,
+            :padding,  :uint16,
+            :size,     :uint32,
+            :callback, :audiospec_cb,
+            :userdata, :pointer )
+
+    def callback=(cb)
+      @callback = cb
+      self[:callback] = @callback
+    end
+
+    def callback
+      @callback
+    end
+
+  end
+
+
+  AUDIO_U8     = 0x0008
+  AUDIO_S8     = 0x8008
+  AUDIO_U16LSB = 0x0010
+  AUDIO_S16LSB = 0x8010
+  AUDIO_U16MSB = 0x1010
+  AUDIO_S16MSB = 0x9010
+  AUDIO_U16    = 0x0010
+  AUDIO_S16    = 0x8010
+  AUDIO_U16SYS = 0x0010
+  AUDIO_S16SYS = 0x8010
+
+
+#     callback( :filters_cb, [ :pointer, :uint16 ], :void)
+
+#     class AudioCVT < NiceFFI::Struct
+#       layout( :needed,       :int,
+#               :src_format,   :uint16,
+#               :dst_format,   :uint16,
+#               :rate_incr,    :double,
+#               :buf,          :pointer,
+#               :len,          :int,
+#               :len_cvt,      :int,
+#               :len_mult,     :int,
+#               :len_ratio,    :double,
+#               :filters,      [:filters_cb, 10],
+#               :filter_index, :int )
+#     end
+
+
+  sdl_func  :AudioInit,       [ :string            ], :int
+  sdl_func  :AudioQuit,       [                    ], :void
+  sdl_func  :OpenAudio,       [ :pointer, :pointer ], :int
+
+  
+  func  :__AudioDriverName, "SDL_AudioDriverName", [:pointer, :int], :pointer
+
+  def self.AudioDriverName
+    b = FFI::Buffer.new(:char, 1024)
+    result = __AudioDriverName( b, 1024 )
+    if result.null?
+      nil
+    else
+      b.get_string(0,1024)
+    end
+  end
+
+
+  AUDIO_STOPPED = 0
+  AUDIO_PLAYING = 1
+  AUDIO_PAUSED  = 2
+
+  sdl_func  :GetAudioStatus, [      ], SDL::ENUM
+  sdl_func  :PauseAudio,     [ :int ], :void
+
+  sdl_func  :LoadWAV_RW,
+            [ :pointer, :int, :pointer, :pointer, :pointer ], :pointer
+
+  sdl_func  :FreeWAV, [ :pointer ], :void
+
+  sdl_func  :BuildAudioCVT,
+            [ :pointer, :uint16, :uint8, :int, :uint16, :uint8, :int ], :int
+
+  sdl_func  :ConvertAudio, [ :pointer ], :int
+
+
+  MIX_MAXVOLUME = 128
+
+  sdl_func  :MixAudio, [ :pointer, :pointer, :uint32, :int ], :void
+
+  sdl_func  :LockAudio,   [  ], :void
+  sdl_func  :UnlockAudio, [  ], :void
+  sdl_func  :CloseAudio,  [  ], :void
+
+end

data/lib/ruby-sdl-ffi/sdl/cdrom.rb

@@ -0,0 +1,87 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#++
+
+
+module SDL
+
+  CD_ERROR     = -1
+  CD_TRAYEMPTY = 0
+  CD_STOPPED   = 1
+  CD_PLAYING   = 2
+  CD_PAUSED    = 3
+
+  AUDIO_TRACK  = 0x00
+  DATA_TRACK   = 0x04
+
+  MAX_TRACKS   = 99
+
+  class CDtrack < NiceFFI::Struct
+    layout( :id,     :uint8,
+            :type,   :uint8,
+            :unused, :uint16,
+            :length, :uint32,
+            :offset, :uint32 )
+
+    hidden( :unused )
+
+  end
+
+
+  if RUBY_PLATFORM =~ /java/
+    # 2009-10-21: JRuby FFI does not support arrays of structs in structs.
+    # Attempting it can raise an un-rescuable NotImplementedError! :(
+    puts "Warning: Skipping class SDL::CD due to JRuby limitations."
+  else
+
+    class CD < NiceFFI::Struct
+      layout( :id,        :int,
+              :status,    SDL::ENUM,
+              :numtracks, :int,
+              :cur_track, :int,
+              :cur_frame, :int,
+              :track,     [CDtrack.by_value, SDL::MAX_TRACKS+1] )
+    end
+
+  end
+
+  CD_FPS = 75
+
+  sdl_func  :CDNumDrives,  [                                  ], :int
+  sdl_func  :CDName,       [ :int                             ], :string
+  sdl_func  :CDOpen,       [ :int                             ], :pointer
+  sdl_func  :CDStatus,     [ :pointer                         ], SDL::ENUM
+  sdl_func  :CDPlayTracks, [ :pointer, :int, :int, :int, :int ], :int
+  sdl_func  :CDPlay,       [ :pointer, :int, :int             ], :int
+  sdl_func  :CDPause,      [ :pointer                         ], :int
+  sdl_func  :CDResume,     [ :pointer                         ], :int
+  sdl_func  :CDStop,       [ :pointer                         ], :int
+  sdl_func  :CDEject,      [ :pointer                         ], :int
+  sdl_func  :CDClose,      [ :pointer                         ], :void
+
+end