fmod 0.9.0 → 0.9.1

data/lib/fmod/core/sound_format.rb

@@ -1,27 +1,35 @@
 module FMOD
   module Core
+
     ##
     # These definitions describe the native format of the hardware or software
     # buffer that will be used.
     module SoundFormat
+
       ##
       # Uninitialized / unknown.
       NONE = 0
+
       ##
       # 8-bit integer PCM data.
       PCM_8 = 1
+
       ##
       # 16-bit integer PCM data.
       PCM_16 = 2
+
       ##
       # 24-bit integer PCM data.
       PCM_24 = 3
+
       ##
       # 32-bit integer PCM data.
       PCM_32 = 4
+
       ##
       # 32-bit floating point PCM data.
       PCM_FLOAT = 5
+
       ##
       # Sound data is in its native compressed format.
       BIT_STREAM = 6

data/lib/fmod/core/sound_type.rb

@@ -1,5 +1,6 @@
 module FMOD
   module Core
+
     ##
     # These definitions describe the type of song being played.
     module SoundType

data/lib/fmod/core/speaker_index.rb

@@ -1,17 +1,56 @@
 module FMOD
   module Core
+
+    ##
+    # Assigns an enumeration for a speaker index.
     module SpeakerIndex
+
+      ##
+      # The front left speaker.
       FRONT_LEFT = 0
+
+      ##
+      # The front right speaker.
       FRONT_RIGHT = 1
+
+      ##
+      # The front center speaker.
       FRONT_CENTER = 2
+
+      ##
+      # The LFE or "subwoofer" speaker.
       LOW_FREQUENCY = 3
+
+      ##
+      # The surround left (usually to the side) speaker.
       SURROUND_LEFT = 4
+
+      ##
+      # The surround right (usually to the side) speaker.
       SURROUND_RIGHT = 5
+
+      ##
+      # The back left speaker.
       BACK_LEFT = 6
+
+      ##
+      # The back right speaker.
       BACK_RIGHT = 7
+
+      ##
+      # The top front left speaker.
       TOP_FRONT_LEFT = 8
+
+      ##
+      # The top front right speaker.
       TOP_FRONT_RIGHT = 9
+
+      ##
+      # The top back left speaker.
       TOP_BACK_LEFT = 10
+
+      ##
+      # The top back right speaker.
       TOP_BACK_RIGHT = 11
     end
   end

data/lib/fmod/core/speaker_mode.rb

@@ -1,15 +1,53 @@
 
 module FMOD
   module Core
+
+    ##
+    # These are speaker types defined for use with the software format commands.
     module SpeakerMode
+
+      ##
+      # Default speaker mode for the chosen output mode which will resolve after
+      # System.create.
       DEFAULT = 0
+
+      ##
+      # Assume there is no special mapping from a given channel to a speaker,
+      # channels map 1:1 in order.
       RAW = 1
+
+      ##
+      # 1 speaker setup (monaural).
       MONO = 2
+
+      ##
+      # 2 speaker setup (stereo) front left, front right.
       STEREO = 3
+
+      ##
+      # 4 speaker setup (4.0) front left, front right, surround left, surround
+      # right.
       QUAD = 4
+
+      ##
+      # 5 speaker setup (5.0) front left, front right, center, surround left,
+      # surround right.
       SURROUND = 5
+
+      ##
+      # 6 speaker setup (5.1) front left, front right, center, low frequency,
+      # surround left, surround right.
       FIVE_POINT_ONE = 6
+
+      ##
+      # 8 speaker setup (7.1) front left, front right, center, low frequency,
+      # surround left, surround right, back left, back right.
       SEVEN_POINT_ONE = 7
+
+      ##
+      # 12 speaker setup (7.1.4) front left, front right, center, low frequency,
+      # surround left, surround right, back left, back right, top front left,
+      # top front right, top back left, top back right.
       SEVEN_POINT_FOUR = 9
     end
   end

data/lib/fmod/core/structure.rb

@@ -1,12 +1,23 @@
-require 'fiddle'
 
 module FMOD
   module Core
+
+    ##
+    # @abstract
+    # Expands upon a the built-in Fiddle::CStructEntity to provide some
+    # additional common functionality for FMOD structures.
     class Structure < Fiddle::CStructEntity
 
       include Fiddle
       include FMOD::Core
 
+      ##
+      # @param address [Integer, String] The memory address of the structure as
+      #   an integer or packed binary string.
+      # @param types [Array<Integer>] Array of primitive C-type flags for the
+      #   data type used by each field.
+      # @param members [Array<Symbol>] Array of names as symbols to use for the
+      #   fields.
       def initialize(address, types, members)
         address = Pointer[address] if address.is_a?(String)
         address ||= Fiddle.malloc(self.class.size(types)).to_i
@@ -14,6 +25,22 @@ module FMOD
         assign_names members
       end
 
+      ##
+      # @return [Array<Symbol>] the names of the structure's fields as symbols.
+      # @since 0.9.1
+      def names
+        @members
+      end
+
+      ##
+      # @return [Array<Object>] the values of the structure's fields.
+      # @since 0.9.1
+      def values
+        @members.map { |sym| self[sym] }
+      end
+
+      ##
+      # @return [String] the structure as a string.
       def inspect
         values = @members.map { |sym| "#{sym}=#{self[sym]}"}.join(', ')
         super.sub(/free=0x(.)*/, values << '>')

data/lib/fmod/system.rb

@@ -1026,9 +1026,9 @@ module FMOD
     end
 
     def [](index)
-      reverb = int_ptr
+      reverb = Reverb.new
       FMOD.invoke(:System_GetReverbProperties, self, index, reverb)
-      Reverb.new(reverb.unpack1('J'))
+      reverb
     end
 
     def []=(index, reverb)

data/lib/fmod/version.rb

@@ -1,3 +1,3 @@
 module FMOD
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmod
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
-- Eric "ForeverZero" Freed
+- Eric "ForeverZer0" Freed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,48 +52,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: |-
-  A full-featured (complete Ruby wrapper) of the ultra-powerful FMOD Low-Level API. Uses the built-in Fiddle library (Ruby 2.0+), and has no external gem dependencies, all that is needed is the native FMOD platform-specific native FMOD libraries (included).
-
-  FMOD supports a host of audio formats including:
-
-  - Audio Interchange File Format (.aiff )
-  - Advanced Systems Format (.asf)
-  - Advanced Stream Redirector (.asx)
-  - Downloadable Sound (.dls)
-  - Free Lossless Audio Codec (.flac)
-  - FMOD Sound Bank (.fsb)
-  - Impulse Tracker (.it)
-  - MPEG Audio Layer 3 URL (.m3u)
-  - Musical Instrument Digital Interface (.mid, .midi)
-  - Module Format (.mod)
-  - MPEG Audio Layer 2 (.mp2)
-  - MPEG Audio Layer 3 (.mp3)
-  - OGG Vorbis (.ogg)
-  - Playlist (.pls)
-  - ScreamTracker 3 Module (.s3m )
-  - PS2/PSP Format (.vag )
-  - Waveform Audio File Forma (.wav )
-  - Windows Media Audio Redirector (.wax )
-  - Windows Media Audio (.wma )
-  - Extended Module (.xm )
-  - Windows Media Audio (Xbox 360) (.xma)
-
-  FMOD is most widely known for its application in video games for sound effects, as it fully supports 3D sound, and can be found in all popular video game consoles (Sony, Microsoft, and Nintendo), as well as a large number of popular PC and mobile games. Built-in is a large collection of audio effects that can be applied to a sound, including various equalizers, advanced reverb environments, pitch-shifting, frequency, flange, chorus, and many, many more.
-
-  The wrapper supports callbacks for various events, such as sync-points in wave files, sound playback ending (either by user or end of data), and various other scenarios. It additionally supports access to raw PCM data directly from the sound card, for creating visualizations or examining the sound in real-time.
+description: A full-featured (complete Ruby wrapper) of the ultra-powerful FMOD Low-Level
+  API. Uses the built-in Fiddle library (Ruby 2.0+), and has no external gem dependencies,
+  all that is needed is the FMOD platform-specific libraries (included). FMOD supports
+  a host of audio formats including .aiff, .asf, .asx, .dls, .flac, .fsb, .it, .m3u,
+  .mid, .midi, .mod, .mp2, .mp3, .ogg .pls, .s3m , vag, .wav, .wax, .wma, .xm, and.xma.
 email:
 - efreed09@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- HISTORY.txt
 - LICENSE.txt
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
 - bin/console