fmod-ruby 0.2.0 → 0.3.0

data/README.md

@@ -33,6 +33,8 @@ No formal test suite yet.  However, the +examples/+ directory includes several e
 History
 =======
 
+* release 0.3.0 - added FMOD::Error, more detailed error reporting
+* release 0.2.0 - added Convert.samples_to_ms
 * release 0.1.1 - added Channel#set_volume, Sound#release
 * release 0.1.0 - added keyword options to System#initialize and whatnot to support offline wav creation (examples write.rb and contact.rb)
 

data/lib/fmod.rb

@@ -26,4 +26,7 @@ module FMOD
   def self.system_pointer
     @system.pointer
   end
+
+  class Error < ::RuntimeError
+  end
 end

data/lib/fmod/channel.rb

@@ -21,51 +21,51 @@ module FMOD
     # result = FMOD_Channel_IsPlaying(channel, &playing);
     def playing?
       FFI::MemoryPointer.new(:int) do |ptr|
-        error_check FMOD_Channel_IsPlaying(pointer, ptr)
+        error_check(:FMOD_Channel_IsPlaying, pointer, ptr)
         return ptr.read_int == 1
       end
     end
     
     def pause
-      error_check FMOD_Channel_SetPaused(pointer, ((paused?) ? 0 : 1))
+      error_check(:FMOD_Channel_SetPaused, pointer, ((paused?) ? 0 : 1))
     end
 
     def set_paused(bool)
-      error_check FMOD_Channel_SetPaused(pointer, (bool ? 1 : 0))
+      error_check(:FMOD_Channel_SetPaused, pointer, (bool ? 1 : 0))
     end
     
     def paused?
       FFI::MemoryPointer.new(:int) do |ptr|
-        error_check FMOD_Channel_GetPaused(pointer, ptr)
+        error_check(:FMOD_Channel_GetPaused, pointer, ptr)
         return ptr.read_int == 1
       end
     end
     
     def set_position(int = 0)
-      error_check FMOD_Channel_SetPosition(pointer, int, FMOD_TIMEUNIT_MS)
+      error_check(:FMOD_Channel_SetPosition, pointer, int, FMOD_TIMEUNIT_MS)
     end
     
     def pan=(float)
       float = 1.0 if float > 1.0
       float = 0.0 if float < 0.0
-      error_check FMOD_Channel_SetPan(pointer, float)
+      error_check(:FMOD_Channel_SetPan, pointer, float)
     end
     
     def frequency
       FFI::MemoryPointer.new(:float) do |ptr|
-        error_check FMOD_Channel_GetFrequency(pointer, ptr)
+        error_check(:FMOD_Channel_GetFrequency, pointer, ptr)
         return ptr.read_float
       end
     end
     
     def frequency=(float)
-      error_check FMOD_Channel_SetFrequency(pointer, float)
+      error_check(:FMOD_Channel_SetFrequency, pointer, float)
     end
 
     def set_delay(samples, opts={})
       opts = opts.keyword_args(:delaytype => :required)
       hi, lo = Convert.int64_to_32(samples)
-      error_check FMOD_Channel_SetDelay(pointer, opts.delaytype, hi, lo)
+      error_check(:FMOD_Channel_SetDelay, pointer, opts.delaytype, hi, lo)
     end
 
     def get_delay(opts={})
@@ -73,14 +73,14 @@ module FMOD
 
       FFI::MemoryPointer.new(:int) { |hi|
         FFI::MemoryPointer.new(:int) { |lo|
-          error_check FMOD_Channel_GetDelay(pointer, opts.delaytype, hi, lo)
+          error_check(:FMOD_Channel_GetDelay, pointer, opts.delaytype, hi, lo)
           return Convert.int32_to_64(hi.read_int, lo.read_int)
         }
       }
     end
 
     def set_volume(volume)
-      error_check FMOD_Channel_SetVolume(pointer, volume)
+      error_check(:FMOD_Channel_SetVolume, pointer, volume)
     end
 
   end

data/lib/fmod/functions.rb

@@ -95,8 +95,10 @@ module FMOD
     attach_function :FMOD_Sound_Release, [:pointer], FMOD_RESULT  
 
     
-    def error_check(result)
-      raise "FMOD error! #{result}" if result != :FMOD_OK
+    def error_check(msg, *args)
+      if (result = send msg, *args) != :FMOD_OK
+        raise FMOD::Error, "Error in #{msg}(#{args.map(&:inspect).join(', ')}): #{result}"
+      end
     end
   end
 end

data/lib/fmod/sound.rb

@@ -12,7 +12,7 @@ module FMOD
 
     def length(unit = FMOD_TIMEUNIT_MS)
       FFI::MemoryPointer.new(:int) do |ptr|
-        error_check FMOD_Sound_GetLength(sound_ptr, ptr, FMOD_TIMEUNIT_MS)
+        error_check(:FMOD_Sound_GetLength, sound_ptr, ptr, FMOD_TIMEUNIT_MS)
         return ptr.read_int
       end
     end
@@ -20,13 +20,13 @@ module FMOD
     def play(opts={})
       opts = opts.keyword_args(:paused)
       # FMOD_RESULT = FMOD_System_PlaySound(system, FMOD_CHANNEL_FREE, sound1, 0, &channel);
-      error_check FMOD_System_PlaySound(FMOD.system.pointer, :FMOD_CHANNEL_FREE, sound_ptr, opts.paused ? 1 : 0, @channel.pointer_addr);
+      error_check(:FMOD_System_PlaySound, FMOD.system.pointer, :FMOD_CHANNEL_FREE, sound_ptr, opts.paused ? 1 : 0, @channel.pointer_addr)
       true
     end
 
     def release
       return unless @sound_ptr
-      error_check FMOD_Sound_Release(@sound_ptr)
+      error_check(:FMOD_Sound_Release, @sound_ptr)
       @sound_ptr = nil
     end
 
@@ -37,7 +37,7 @@ module FMOD
 
       @memory = FFI::MemoryPointer.new(:pointer)
       # FMOD_RESULT = FMOD_System_CreateSound(system, "drumloop.wav", FMOD_SOFTWARE, 0, &sound);
-      error_check FMOD_System_CreateSound(@system_pointer, @file, FMOD_DEFAULT, 0, @memory);
+      error_check(:FMOD_System_CreateSound, @system_pointer, @file, FMOD_DEFAULT, 0, @memory)
 
       @sound_ptr = @memory.read_pointer
     end

data/lib/fmod/system.rb

@@ -12,16 +12,16 @@ module FMOD
       @sample_rate = opts.sample_rate
 
       @memory = FFI::MemoryPointer.new(:pointer)
-      error_check FMOD_System_Create(@memory)  
+      error_check(:FMOD_System_Create, @memory)
       @pointer = @memory.read_pointer
 
       case
       when opts.output_wav
-        error_check FMOD_System_SetOutput(@pointer, :FMOD_OUTPUTTYPE_WAVWRITER_NRT)
-        error_check FMOD_System_SetSoftwareFormat(@pointer, sample_rate, :FMOD_SOUND_FORMAT_PCM16, 2, 6, :FMOD_DSP_RESAMPLER_LINEAR)
-        error_check FMOD_System_Init(@pointer, 100,  FMOD_INIT_STREAM_FROM_UPDATE, opts.output_wav)
+        error_check(:FMOD_System_SetOutput, @pointer, :FMOD_OUTPUTTYPE_WAVWRITER_NRT)
+        error_check(:FMOD_System_SetSoftwareFormat, @pointer, sample_rate, :FMOD_SOUND_FORMAT_PCM16, 2, 6, :FMOD_DSP_RESAMPLER_LINEAR)
+        error_check(:FMOD_System_Init, @pointer, 100,  FMOD_INIT_STREAM_FROM_UPDATE, opts.output_wav)
       else
-        error_check FMOD_System_Init(@pointer, 32, FMOD_INIT_NORMAL, nil)
+        error_check(:FMOD_System_Init, @pointer, 32, FMOD_INIT_NORMAL, nil)
       end
     end
     
@@ -29,7 +29,7 @@ module FMOD
       # unsigned int version;
       # result = FMOD_System_GetVersion(system, &version);
       FFI::MemoryPointer.new(:int) { |version_ptr|
-        error_check FMOD_System_GetVersion(@pointer, version_ptr);
+        error_check(:FMOD_System_GetVersion, @pointer, version_ptr)
         return version_ptr.read_int
       }
     end
@@ -38,14 +38,14 @@ module FMOD
       # unsigned int numdrivers;
       # result = FMOD_System_GetNumDrivers(system, &numdrivers);
       FFI::MemoryPointer.new(:int) { |count_ptr|
-        error_check FMOD_System_GetNumDrivers(@pointer, count_ptr)
+        error_check(:FMOD_System_GetNumDrivers, @pointer, count_ptr)
         count_ptr.read_int
       }
     end
     
     def software_channels
       FFI::MemoryPointer.new(:int) { |num_ptr|
-        error_check FMOD_System_GetSoftwareChannels(@pointer, num_ptr)
+        error_check(:FMOD_System_GetSoftwareChannels, @pointer, num_ptr)
         num_ptr.read_int
       }
     end
@@ -54,8 +54,7 @@ module FMOD
       FFI::MemoryPointer.new(:int) { |num2d|
         FFI::MemoryPointer.new(:int) { |num3d|
           FFI::MemoryPointer.new(:int) { |total|
-            error_check FMOD_System_GetHardwareChannels(@pointer, num2d, num3d, total)
-
+            error_check(:FMOD_System_GetHardwareChannels, @pointer, num2d, num3d, total)
             {
               :num2d => num2d.read_int,
               :num3d => num3d.read_int,
@@ -69,7 +68,7 @@ module FMOD
     def dsp_clock
       FFI::MemoryPointer.new(:int) { |hi|
         FFI::MemoryPointer.new(:int) { |lo|
-          error_check FMOD_System_GetDSPClock(@pointer, hi, lo)
+          error_check(:FMOD_System_GetDSPClock, @pointer, hi, lo)
           return Convert.int32_to_64(hi.read_int, lo.read_int)
         }
       }
@@ -77,17 +76,17 @@ module FMOD
 
     def buffer_size
       FFI::MemoryPointer.new(:int) { |size|
-        error_check FMOD_System_GetDSPBufferSize(@pointer, size, nil)
+        error_check(:FMOD_System_GetDSPBufferSize, @pointer, size, nil)
         return size.read_int
       }
     end
 
     def update
-      error_check FMOD_System_Update(@pointer)
+      error_check(:FMOD_System_Update, @pointer)
     end
 
     def release
-      error_check FMOD_System_Release(@pointer)
+      error_check(:FMOD_System_Release, @pointer)
     end
   end
 end

data/lib/fmod/version.rb

@@ -1,3 +1,3 @@
 module Fmod
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fmod-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-01 00:00:00.000000000 Z
+date: 2012-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70100818011000 !ruby/object:Gem::Requirement
+  requirement: &70299865565260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70100818011000
+  version_requirements: *70299865565260
 - !ruby/object:Gem::Dependency
   name: hash_keyword_args
-  requirement: &70100818010440 !ruby/object:Gem::Requirement
+  requirement: &70299865564080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70100818010440
+  version_requirements: *70299865564080
 description: Wrapper for the FMOD audio library
 email:
 - ronen@barzel.org