fmod 0.9.0

data/lib/fmod/channel_group.rb

@@ -0,0 +1,61 @@
+
+module FMOD
+  class ChannelGroup < ChannelControl
+
+    include Fiddle
+    include Enumerable
+
+    integer_reader(:subgroup_count, :ChannelGroup_GetNumGroups)
+    integer_reader(:channel_count, :ChannelGroup_GetNumChannels)
+
+    def name
+      buffer = "\0" * 512
+      FMOD.invoke(:ChannelGroup_GetName, self, buffer, 512)
+      buffer.delete("\0")
+    end
+
+    def subgroup(index)
+      FMOD.valid_range?(index, 0, subgroup_count - 1)
+      FMOD.invoke(:ChannelGroup_GetGroup, self, index, group = int_ptr)
+      ChannelGroup.new(group)
+    end
+
+    def parent_group
+      FMOD.invoke(:ChannelGroup_GetParentGroup, self, group = int_ptr)
+      group.null? ? nil : ChannelGroup.new(group)
+    end
+
+    def [](index)
+      FMOD.valid_range?(index, 0, channel_count - 1)
+      FMOD.invoke(:ChannelGroup_GetChannel, self, index, channel = int_ptr)
+      Channel.new(channel)
+    end
+
+    def each
+      return to_enum(:each) unless block_given?
+      (0...channel_count).each { |i| yield self[i] }
+      self
+    end
+
+    def <<(channel_control)
+      return add_channel(channel_control) if channel_control.is_a?(Channel)
+      return add_group(channel_control) if channel_control.is_a?(ChannelGroup)
+      raise TypeError, "#{channel_control} is not a #{ChannelControl}."
+    end
+
+    def add_channel(channel)
+      FMOD.type?(channel, Channel)
+      channel.group = self
+      channel
+    end
+
+    def add_group(group, propagate_clock = true)
+      FMOD.type?(group, ChannelGroup)
+      FMOD.invoke(:ChannelGroup_AddGroup, self, group,
+        propagate_clock.to_i, connection = int_ptr)
+      DspConnection.new(connection)
+    end
+
+    alias_method :channel, :[]
+  end
+end

data/lib/fmod/core.rb

@@ -0,0 +1,35 @@
+
+require_relative './core/structure'
+require_relative './core/structures'
+require_relative './core/bool_description'
+require_relative './core/channel_mask'
+require_relative './core/data_description'
+require_relative './core/driver'
+require_relative './core/dsp_description'
+require_relative './core/dsp_index'
+require_relative './core/dsp_type'
+require_relative './core/extensions'
+require_relative './core/file_system'
+require_relative './core/filter_type'
+require_relative './core/float_description'
+require_relative './core/guid'
+require_relative './core/init_flags'
+require_relative './core/integer_description'
+require_relative './core/mode'
+require_relative './core/output_type'
+require_relative './core/parameter_info'
+require_relative './core/parameter_type'
+require_relative './core/result'
+require_relative './core/reverb'
+require_relative './core/sound_ex_info'
+require_relative './core/sound_format'
+require_relative './core/sound_group_behavior'
+require_relative './core/sound_type'
+require_relative './core/speaker_index'
+require_relative './core/speaker_mode'
+require_relative './core/spectrum_data'
+require_relative './core/tag'
+require_relative './core/tag_data_type'
+require_relative './core/time_unit'
+require_relative './core/vector'
+require_relative './core/window_type'

data/lib/fmod/core/bool_description.rb

@@ -0,0 +1,18 @@
+module FMOD
+  module Core
+    class BoolDescription < Structure
+
+      def initialize(address = nil)
+        super(address, [TYPE_INT, TYPE_VOIDP], [:default, :names])
+      end
+
+      def default
+        self[:default] != 0
+      end
+
+      def names
+        %w(true false)
+      end
+    end
+  end
+end

data/lib/fmod/core/channel_mask.rb

@@ -0,0 +1,24 @@
+module FMOD
+  module Core
+    module ChannelMask
+      FRONT_LEFT = 0x00000001
+      FRONT_RIGHT = 0x00000002
+      FRONT_CENTER = 0x00000004
+      LOW_FREQUENCY = 0x00000008
+      SURROUND_LEFT = 0x00000010
+      SURROUND_RIGHT = 0x00000020
+      BACK_LEFT = 0x00000040
+      BACK_RIGHT = 0x00000080
+      BACK_CENTER = 0x00000100
+      MONO = FRONT_LEFT
+      STEREO = FRONT_LEFT | FRONT_RIGHT
+      LRC = FRONT_LEFT | FRONT_RIGHT | FRONT_CENTER
+      QUAD = FRONT_LEFT | FRONT_RIGHT | SURROUND_LEFT | SURROUND_RIGHT
+      SURROUND = FRONT_LEFT | FRONT_RIGHT | FRONT_CENTER | SURROUND_LEFT | SURROUND_RIGHT
+      FIVE_POINT_ONE = FRONT_LEFT | FRONT_RIGHT | FRONT_CENTER | LOW_FREQUENCY | SURROUND_LEFT | SURROUND_RIGHT
+      FIVE_POINT_ONE_REARS = FRONT_LEFT | FRONT_RIGHT | FRONT_CENTER | LOW_FREQUENCY | BACK_LEFT | BACK_RIGHT
+      SEVEN_POINT_ZERO = FRONT_LEFT | FRONT_RIGHT | FRONT_CENTER | SURROUND_LEFT | SURROUND_RIGHT | BACK_LEFT | BACK_RIGHT
+      SEVEN_POINT_ONE = FRONT_LEFT | FRONT_RIGHT | FRONT_CENTER | LOW_FREQUENCY | SURROUND_LEFT | SURROUND_RIGHT | BACK_LEFT | BACK_RIGHT
+    end
+  end
+end

data/lib/fmod/core/data_description.rb

@@ -0,0 +1,14 @@
+module FMOD
+  module Core
+    class DataDescription < Structure
+
+      def initialize(address = nil)
+        super(address, [TYPE_INT], [:data_type])
+      end
+
+      def data_type
+        self[:data_type]
+      end
+    end
+  end
+end

data/lib/fmod/core/driver.rb

@@ -0,0 +1,59 @@
+module FMOD
+  module Core
+
+    ##
+    # Identification information about a sound device.
+    class Driver
+
+      private_class_method :new
+
+      ##
+      # @return [Integer] the enumerated driver ID.
+      attr_reader :id
+
+      ##
+      # @return [String] the name of the device encoded in a UTF-8 string.
+      attr_reader :name
+
+      ##
+      # @return [Guid] the GUID that uniquely identifies the device.
+      attr_reader :guid
+
+      ##
+      # @return [Integer] the sample rate this device operates at.
+      attr_reader :rate
+
+      ##
+      # @return [Integer] the speaker setup this device is currently using.
+      # @see SpeakerMode
+      attr_reader :speaker_mode
+
+      ##
+      # @return [Integer] the number of channels in the current speaker setup.
+      attr_reader :channels
+
+      ##
+      # @return [Integer] flags that provide additional information about the
+      #   driver.
+      attr_reader :state
+
+      ##
+      # @param args [Array] Array of binary data.
+      # @api private
+      def initialize(args)
+        @id = args.shift
+        # noinspection RubyResolve
+        @name = args.shift.delete("\0").force_encoding(Encoding::UTF_8)
+        args.shift
+        @guid = args.shift
+        @rate, @speaker_mode, @channels, @state = args.join.unpack('l*')
+      end
+
+      ##
+      # @return [Boolean] +true+ if this a record driver, otherwise +false+.
+      def record_driver?
+        !@state.nil?
+      end
+    end
+  end
+end

data/lib/fmod/core/dsp_description.rb

@@ -0,0 +1,7 @@
+module FMOD
+  module Core
+    class DspDescription < Structure
+      # TODO
+    end
+  end
+end

data/lib/fmod/core/dsp_index.rb

@@ -0,0 +1,9 @@
+module FMOD
+  module Core
+    module DspIndex
+      HEAD = -1
+      FADER = -2
+      TAIL = -3
+    end
+  end
+end

data/lib/fmod/core/dsp_type.rb

@@ -0,0 +1,43 @@
+module FMOD
+  module Core
+    module DspType
+      UNKNOWN = 0
+      MIXER = 1
+      OSCILLATOR = 2
+      LOW_PASS = 3
+      IT_LOW_PASS = 4
+      HIGH_PASS = 5
+      ECHO = 6
+      FADER = 7
+      FLANGE = 8
+      DISTORTION = 9
+      NORMALIZE = 10
+      LIMITER = 11
+      PARAM_EQ = 12
+      PITCH_SHIFT = 13
+      CHORUS = 14
+      VST_PLUGIN = 15
+      WINAMP_PLUGIN = 16
+      IT_ECHO = 17
+      COMPRESSOR = 18
+      SFX_REVERB = 19
+      LOW_PASS_SIMPLE = 20
+      DELAY = 21
+      TREMOLO = 22
+      LADSPA_PLUGIN = 23
+      SEND = 24
+      RETURN = 25
+      HIGH_PASS_SIMPLE = 26
+      PAN = 27
+      THREE_EQ = 28
+      FFT = 29
+      LOUDNESS_METER = 30
+      ENVELOPE_FOLLOWER = 31
+      CONVOLUTION_REVERB = 32
+      CHANNEL_MIX = 33
+      TRANSCEIVER = 34
+      OBJECT_PAN = 35
+      MULTIBAND_EQ = 36
+    end
+  end
+end

data/lib/fmod/core/extensions.rb

@@ -0,0 +1,28 @@
+
+class Numeric
+
+  def clamp(min, max)
+    [min, self, max].sort[1]
+  end
+end
+
+class String
+
+  unless method_defined?(:unpack1)
+    def unpack1(format)
+      unpack(format).first
+    end
+  end
+end
+
+class TrueClass
+  def to_i
+    1
+  end
+end
+
+class FalseClass
+  def to_i
+    0
+  end
+end

data/lib/fmod/core/file_system.rb

@@ -0,0 +1,86 @@
+module FMOD
+  module Core
+    class FileSystem
+
+      include Fiddle
+
+      # TODO: Upsets the stack, causing a segfault with STD_CALL.
+
+      def initialize(system)
+        @callbacks = []
+        @cbs = [open_cb, close_cb, seek_cb, close_cb]
+        FMOD.invoke(:System_AttachFileSystem, system, *@cbs)
+      end
+
+      def on_open(proc = nil, &block)
+        set_callback(0, &(block_given? ? block : proc))
+      end
+
+      def on_close(proc = nil, &block)
+        set_callback(1, &(block_given? ? block : proc))
+      end
+
+      def on_read(proc = nil, &block)
+        set_callback(2, &(block_given? ? block : proc))
+      end
+
+      def on_seek(proc = nil, &block)
+        set_callback(3, &(block_given? ? block : proc))
+      end
+
+      private
+
+      def set_callback(index, &block)
+        raise LocalJumpError, "No block given." unless block_given?
+        @callbacks[index] = block
+      end
+
+      def open_cb
+        sig = Array.new(4, TYPE_VOIDP)
+        abi = FMOD::ABI
+        Closure::BlockCaller.new(TYPE_INT, sig, abi) do |name, size, ptr, user|
+          if @callbacks[0]
+            size = size.to_s(SIZEOF_INT).unpack1('L')
+            @callbacks[0].call(name, size, ptr, user)
+          end
+          Result::OK
+        end
+      end
+
+      def close_cb
+        sig = [TYPE_VOIDP, TYPE_VOIDP]
+        abi = FMOD::ABI
+        Closure::BlockCaller.new(TYPE_INT, sig, abi) do |handle, user_data|
+          @callbacks[1].call(handle, user_data) if @callbacks[1]
+          Result::OK
+        end
+      end
+
+      def read_cb
+        sig = Array.new(5, TYPE_VOIDP)
+        abi = FMOD::ABI
+        Closure::BlockCaller.new(TYPE_INT, sig, abi) do |handle, buffer, size, read, user|
+          if @callbacks[2]
+            @callbacks[2].call(handle, buffer, size, read, user)
+          end
+          Result::OK
+        end
+      end
+
+      def seek_cb
+        sig = Array.new(3, TYPE_VOIDP)
+        abi = FMOD::ABI
+        Closure::BlockCaller.new(TYPE_INT, sig, abi) do |handle, position, user|
+          if @callbacks[3]
+            @callbacks[3].call(handle, position, user)
+          end
+          Result::OK
+        end
+      end
+    end
+
+    # TODO: Remove after fixing
+    private_constant :FileSystem
+
+  end
+end

data/lib/fmod/core/filter_type.rb

@@ -0,0 +1,19 @@
+module FMOD
+  module Core
+    module FilterType
+      DISABLED = 0
+      LOW_PASS_12DB = 1
+      LOW_PASS_24DB = 2
+      LOW_PASS_48DB = 3
+      HIGH_PASS_12DB = 4
+      HIGH_PASS_24DB = 5
+      HIGH_PASS_48DB = 6
+      LOW_SHELF = 7
+      HIGH_SHELF = 8
+      PEAKING = 9
+      BANDPASS = 10
+      NOTCH = 11
+      ALL_PASS = 12
+    end
+  end
+end

data/lib/fmod/core/float_description.rb

@@ -0,0 +1,16 @@
+module FMOD
+  module Core
+    class FloatDescription < Structure
+
+      def initialize(address = nil)
+        types = [TYPE_FLOAT, TYPE_FLOAT, TYPE_FLOAT, TYPE_INT]
+        members = [:min, :max, :default, :mapping]
+        super(address, types, members)
+      end
+
+      [:min, :max, :default, :mapping].each do |symbol|
+        define_method(symbol) { self[symbol] }
+      end
+    end
+  end
+end

data/lib/fmod/core/guid.rb

@@ -0,0 +1,50 @@
+
+
+module FMOD
+  module Core
+    class Guid < Structure
+
+      def initialize(address = nil)
+        types = [TYPE_INT, TYPE_SHORT, TYPE_SHORT, [TYPE_CHAR, 8]]
+        members = [:data1, :data2, :data3, :data4]
+        super(address, types, members)
+      end
+
+      def data1
+        [self[:data1]].pack('l').unpack1('L')
+      end
+
+      def data2
+        [self[:data2]].pack('s').unpack1('S')
+      end
+
+      def data3
+        [self[:data3]].pack('s').unpack1('S')
+      end
+
+      def data4
+        self[:data4].pack('c*').unpack('C*')
+      end
+
+      def eql?(obj)
+        if obj.is_a?(Guid)
+          return false unless data1 == obj.data1
+          return false unless data2 == obj.data2
+          return false unless data3 == obj.data3
+          return data4 == obj.data4
+        end
+        to_s.tr('-', '').casecmp(obj.to_s.tr('-', '')).zero?
+      end
+
+      def ==(obj)
+        eql?(obj)
+      end
+
+      def to_s
+        d4 = data4
+        last = d4[2, 6].map { |byte| "%02X" % byte }.join
+        "%08X-%04X-%04X-%02X%02X-#{last}" % [data1, data2, data3, d4[0], d4[1]]
+      end
+    end
+  end
+end