win32-sound 0.5.1 → 0.6.0

data/lib/win32/windows/functions.rb

@@ -0,0 +1,41 @@
+require 'ffi'
+
+module Windows
+  module SoundFunctions
+    extend FFI::Library
+
+    typedef :ulong, :dword
+    typedef :uintptr_t, :hmodule
+    typedef :uintptr_t, :hwaveout
+    typedef :uint, :mmresult
+
+    ffi_lib :kernel32
+
+    private
+
+    # Make FFI functions private
+    def self.attach_pfunc(*args)
+      attach_function(*args)
+      private args[0]
+    end
+
+    attach_pfunc :Beep, [:dword, :dword], :bool
+
+    ffi_lib :winmm
+
+    attach_pfunc :PlaySound, [:string, :hmodule, :dword], :bool
+    attach_pfunc :waveOutSetVolume, [:hwaveout, :dword], :int
+    attach_pfunc :waveOutGetVolume, [:hwaveout, :pointer], :int
+    attach_pfunc :waveOutGetNumDevs, [], :int
+    attach_pfunc :waveInGetNumDevs, [], :int
+    attach_pfunc :midiOutGetNumDevs, [], :int
+    attach_pfunc :midiInGetNumDevs, [], :int
+    attach_pfunc :auxGetNumDevs, [], :int
+    attach_pfunc :mixerGetNumDevs, [], :int
+    attach_pfunc :waveOutOpen, [:pointer, :uint, :pointer, :dword, :dword, :dword], :mmresult
+    attach_pfunc :waveOutPrepareHeader, [:hwaveout, :pointer, :uint], :mmresult
+    attach_pfunc :waveOutWrite, [:hwaveout, :pointer, :uint], :mmresult
+    attach_pfunc :waveOutUnprepareHeader, [:hwaveout, :pointer, :uint], :mmresult
+    attach_pfunc :waveOutClose, [:hwaveout], :mmresult
+  end
+end

data/lib/win32/windows/structs.rb

@@ -0,0 +1,78 @@
+require 'ffi'
+
+module Windows
+  module SoundStructs
+    extend FFI::Library
+    
+    # Define an HWAVEOUT struct for use by all the waveOut functions.
+    # It is a handle to a waveOut stream, so starting up multiple
+    # streams using different handles allows for simultaneous playback.
+    # You never need to actually look at the struct, C takes care of
+    # its value.
+    #
+    class HWAVEOUT < FFI::Struct
+      layout :i, :int
+    end
+
+    # Define WAVEFORMATEX which defines the format (PCM in this case)
+    # and various properties like sampling rate, number of channels, etc.
+    #
+    class WAVEFORMATEX < FFI::Struct
+  
+      # Initializes struct with sensible defaults for most commonly used
+      # values.  While setting these manually is possible, please be
+      # sure you know what changes will result in, as an incorrectly
+      # set struct will result in unpredictable behavior.
+      #
+      def initialize(nSamplesPerSec = 44100, wBitsPerSample = 16, nChannels = 1, cbSize = 0)
+        self[:wFormatTag] = Win32::Sound::WAVE_FORMAT_PCM
+        self[:nChannels] = nChannels
+        self[:nSamplesPerSec] = nSamplesPerSec
+        self[:wBitsPerSample] = wBitsPerSample
+        self[:cbSize] = cbSize
+        self[:nBlockAlign] = (self[:wBitsPerSample] >> 3) * self[:nChannels]
+        self[:nAvgBytesPerSec] = self[:nBlockAlign] * self[:nSamplesPerSec]
+      end
+    
+      layout(
+        :wFormatTag,      :ushort,
+        :nChannels,       :ushort,
+        :nSamplesPerSec,  :ulong,
+        :nAvgBytesPerSec, :ulong,
+        :nBlockAlign,     :ushort,
+        :wBitsPerSample,  :ushort,
+        :cbSize,          :ushort
+      )
+    end
+
+    #define WAVEHDR which is a header to a block of audio
+    #lpData is a pointer to the block of native memory that,
+    # in this case, is an integer array of PCM data
+
+    class WAVEHDR < FFI::Struct
+    
+      # Initializes struct with sensible defaults for most commonly used
+      # values.  While setting these manually is possible, please be
+      # sure you know what changes will result in, as an incorrectly
+      # set struct will result in unpredictable behavior.
+      #
+      def initialize(lpData, dwBufferLength, dwFlags = 0, dwLoops = 1)
+        self[:lpData] = lpData
+        self[:dwBufferLength] = dwBufferLength
+        self[:dwFlags] = dwFlags
+        self[:dwLoops] = dwLoops
+      end
+      
+      layout(
+        :lpData,          :pointer,
+        :dwBufferLength,  :ulong,
+        :dwBytesRecorded, :ulong,
+        :dwUser,          :ulong,
+        :dwFlags,         :ulong,
+        :dwLoops,         :ulong,
+        :lpNext,          :pointer,
+        :reserved,        :ulong
+      )
+    end
+  end # SoundStructs
+end # Windows

data/test/test_win32_sound.rb

@@ -1,103 +1,141 @@
-##########################################################################
-# test_win32_sound.rb
-#
-# Test suite for the win32-sound library. You should run this test case
-# via the 'rake test' task.
-##########################################################################
-require 'test-unit'
-require 'win32/sound'
-include Win32
-
-class TC_Win32_Sound < Test::Unit::TestCase
-  def setup
-    @wav = "c:\\windows\\media\\chimes.wav"
-  end
-
-  def test_version
-    assert_equal('0.5.1', Sound::VERSION)
-  end
-
-  def test_beep
-    assert_respond_to(Sound, :beep)
-    assert_nothing_raised{ Sound.beep(55, 100) }
-  end
-
-  def test_beep_expected_errors
-    assert_raises(ArgumentError){ Sound.beep(0, 100) }
-    assert_raises(ArgumentError){ Sound.beep }
-    assert_raises(ArgumentError){ Sound.beep(500) }
-    assert_raises(ArgumentError){ Sound.beep(500, 500, 5) }
-  end
-
-  def test_devices
-    assert_respond_to(Sound, :devices)
-    assert_nothing_raised{ Sound.devices }
-    assert_kind_of(Array,Sound.devices)
-  end
-
-  def test_stop
-    assert_respond_to(Sound, :stop)
-    assert_nothing_raised{ Sound.stop }
-    assert_nothing_raised{ Sound.stop(true) }
-  end
-
-  def test_get_volume_basic
-    assert_respond_to(Sound, :wave_volume)
-    assert_respond_to(Sound, :get_wave_volume)
-    assert_nothing_raised{ Sound.get_wave_volume }
-  end
-
-  def test_get_volume
-    assert_kind_of(Array, Sound.get_wave_volume)
-    assert_equal(2, Sound.get_wave_volume.length)
-  end
-
-  def test_set_volume
-    assert_respond_to(Sound, :set_wave_volume)
-    assert_nothing_raised{ Sound.set_wave_volume(30000) } # About half
-    assert_nothing_raised{ Sound.set_wave_volume(30000, 30000) }
-  end
-
-  def test_play
-    assert_respond_to(Sound, :play)
-    assert_nothing_raised{ Sound.play(@wav) }
-  end
-
-  def test_play_alias
-    assert_nothing_raised{ Sound.play('SystemAsterisk', Sound::ALIAS) }
-  end
-
-  def test_expected_errors
-    assert_raises(ArgumentError){ Sound.beep(-1, 1) }
-  end
-
-  def test_constants
-    assert_not_nil(Sound::ALIAS)
-    assert_not_nil(Sound::APPLICATION)
-    assert_not_nil(Sound::ASYNC)
-    assert_not_nil(Sound::FILENAME)
-    assert_not_nil(Sound::LOOP)
-    assert_not_nil(Sound::MEMORY)
-    assert_not_nil(Sound::NODEFAULT)
-    assert_not_nil(Sound::NOSTOP)
-    assert_not_nil(Sound::NOWAIT)
-    assert_not_nil(Sound::PURGE)
-    assert_not_nil(Sound::SYNC)
-  end
-
-  test "ffi functions are private" do
-    assert_not_respond_to(Sound, :Beep)
-    assert_not_respond_to(Sound, :waveOutSetVolume)
-    assert_not_respond_to(Sound, :waveOutGetVolume)
-    assert_not_respond_to(Sound, :waveOutGetNumDevs)
-    assert_not_respond_to(Sound, :waveInGetNumDevs)
-    assert_not_respond_to(Sound, :midiInGetNumDevs)
-    assert_not_respond_to(Sound, :midiOutGetNumDevs)
-    assert_not_respond_to(Sound, :auxGetNumDevs)
-    assert_not_respond_to(Sound, :mixerGetNumDevs)
-  end
-
-  def teardown
-    @wav = nil
-  end
-end
+##########################################################################
+# test_win32_sound.rb
+#
+# Test suite for the win32-sound library. You should run this test case
+# via the 'rake test' task.
+##########################################################################
+require 'test-unit'
+require 'stringio'
+require 'win32/sound'
+include Win32
+
+class TC_Win32_Sound < Test::Unit::TestCase
+  def setup
+    @wav = "c:\\windows\\media\\chimes.wav"
+  end
+
+  test "version constant is set to expected value" do
+    assert_equal('0.6.0', Sound::VERSION)
+  end
+
+  def test_beep
+    assert_respond_to(Sound, :beep)
+    assert_nothing_raised{ Sound.beep(55, 100) }
+  end
+
+  def test_beep_expected_errors
+    assert_raises(ArgumentError){ Sound.beep(0, 100) }
+    assert_raises(ArgumentError){ Sound.beep }
+    assert_raises(ArgumentError){ Sound.beep(500) }
+    assert_raises(ArgumentError){ Sound.beep(500, 500, 5) }
+  end
+
+  def test_devices
+    assert_respond_to(Sound, :devices)
+    assert_nothing_raised{ Sound.devices }
+    assert_kind_of(Array,Sound.devices)
+  end
+
+  def test_stop
+    assert_respond_to(Sound, :stop)
+    assert_nothing_raised{ Sound.stop }
+    assert_nothing_raised{ Sound.stop(true) }
+  end
+
+  def test_get_volume_basic
+    assert_respond_to(Sound, :wave_volume)
+    assert_respond_to(Sound, :get_wave_volume)
+    assert_nothing_raised{ Sound.get_wave_volume }
+  end
+
+  def test_get_volume
+    assert_kind_of(Array, Sound.get_wave_volume)
+    assert_equal(2, Sound.get_wave_volume.length)
+  end
+
+  def test_set_volume
+    assert_respond_to(Sound, :set_wave_volume)
+    assert_nothing_raised{ Sound.set_wave_volume(30000) } # About half
+    assert_nothing_raised{ Sound.set_wave_volume(30000, 30000) }
+  end
+
+  def test_play
+    assert_respond_to(Sound, :play)
+    assert_nothing_raised{ Sound.play(@wav) }
+  end
+
+  def test_play_alias
+    assert_nothing_raised{ Sound.play('SystemAsterisk', Sound::ALIAS) }
+  end
+
+  def test_expected_errors
+    assert_raises(ArgumentError){ Sound.beep(-1, 1) }
+  end
+
+  test "play_freq basic functionality" do
+    assert_respond_to(Sound, :play_freq)
+    assert_nothing_raised{ Sound.play_freq(660.0, 500) }
+  end
+
+  test "play_freq raises an error if the frequency is too high or too low" do
+    assert_raise(ArgumentError){ Sound.play_freq(999999999, 500) }
+    assert_raise(ArgumentError){ Sound.play_freq(1, 500) }
+  end
+
+  test "play_freq raises an error if the duration is too high or too low" do
+    assert_raise(ArgumentError){ Sound.play_freq(660.0, 9999999) }
+    assert_raise(ArgumentError){ Sound.play_freq(660.0, -1) }
+  end
+
+  test "play_freq displays a warning if volume is too large" do
+    @orig_stderr = $stderr
+    $stderr = StringIO.new
+    Sound.play_freq(440, 200, 2)
+    $stderr.rewind
+    assert_equal("WARNING: Volume greater than 1 will cause audio clipping.",
+      $stderr.string.chomp)
+    $stderr = @orig_stderr
+  end
+
+  test "expected constants are defined" do
+    assert_not_nil(Sound::ALIAS)
+    assert_not_nil(Sound::APPLICATION)
+    assert_not_nil(Sound::ASYNC)
+    assert_not_nil(Sound::FILENAME)
+    assert_not_nil(Sound::LOOP)
+    assert_not_nil(Sound::MEMORY)
+    assert_not_nil(Sound::NODEFAULT)
+    assert_not_nil(Sound::NOSTOP)
+    assert_not_nil(Sound::NOWAIT)
+    assert_not_nil(Sound::PURGE)
+    assert_not_nil(Sound::SYNC)
+    assert_not_nil(Sound::VERSION)
+    assert_not_nil(Sound::WAVE_FORMAT_PCM)
+    assert_not_nil(Sound::WAVE_MAPPER)
+    assert_not_nil(Sound::HWAVEOUT)
+    assert_not_nil(Sound::WAVEFORMATEX)
+    assert_not_nil(Sound::WAVEHDR)
+  end
+
+  test "ffi functions are private" do
+    assert_not_respond_to(Sound, :Beep)
+    assert_not_respond_to(Sound, :PlaySound)
+    assert_not_respond_to(Sound, :waveOutSetVolume)
+    assert_not_respond_to(Sound, :waveOutGetVolume)
+    assert_not_respond_to(Sound, :waveOutGetNumDevs)
+    assert_not_respond_to(Sound, :waveInGetNumDevs)
+    assert_not_respond_to(Sound, :midiInGetNumDevs)
+    assert_not_respond_to(Sound, :midiOutGetNumDevs)
+    assert_not_respond_to(Sound, :auxGetNumDevs)
+    assert_not_respond_to(Sound, :mixerGetNumDevs)
+    assert_not_respond_to(Sound, :waveOutOpen)
+    assert_not_respond_to(Sound, :waveOutPrepareHeader)
+    assert_not_respond_to(Sound, :waveOutWrite)
+    assert_not_respond_to(Sound, :waveOutUnprepareHeader)
+    assert_not_respond_to(Sound, :waveOutClose)
+  end
+
+  def teardown
+    @wav = nil
+  end
+end

data/win32-sound.gemspec

@@ -1,25 +1,25 @@
-require 'rubygems'
-
-Gem::Specification.new do |spec|
-  spec.name      = 'win32-sound'
-  spec.version   = '0.5.1'
-  spec.author    = 'Daniel J. Berger'
-  spec.license   = 'Artistic 2.0'
-  spec.email     = 'djberg96@gmail.com'
-  spec.homepage  = 'http://github.com/djberg96/win32-sound'
-  spec.summary   = 'A library for playing with sound on MS Windows.'
-  spec.test_file = 'test/test_win32_sound.rb'
-  spec.files     = Dir['**/*'] << ".gemtest"
-
-  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
-  spec.rubyforge_project = 'win32utils'
-
-  spec.add_dependency('ffi')
-  spec.add_development_dependency('test-unit')
-
-  spec.description = <<-EOF
-    The win32-sound library provides an interface for playing various
-    sounds on MS Windows operating systems, including system sounds and
-    wave files, as well as querying and configuring sound related properties.
-  EOF
-end
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name      = 'win32-sound'
+  spec.version   = '0.6.0'
+  spec.author    = 'Daniel J. Berger'
+  spec.license   = 'Artistic 2.0'
+  spec.email     = 'djberg96@gmail.com'
+  spec.homepage  = 'http://github.com/djberg96/win32-sound'
+  spec.summary   = 'A library for playing with sound on MS Windows.'
+  spec.test_file = 'test/test_win32_sound.rb'
+  spec.files     = Dir['**/*'] << ".gemtest"
+
+  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
+
+  spec.add_dependency('ffi')
+  spec.add_development_dependency('test-unit')
+  spec.add_development_dependency('rake')
+
+  spec.description = <<-EOF
+    The win32-sound library provides an interface for playing various
+    sounds on MS Windows operating systems, including system sounds and
+    wave files, as well as querying and configuring sound related properties.
+  EOF
+end

metadata

@@ -1,51 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: win32-sound
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    The win32-sound library provides an interface for playing various\n
-  \   sounds on MS Windows operating systems, including system sounds and\n    wave
-  files, as well as querying and configuring sound related properties.\n"
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      The win32-sound library provides an interface for playing various
+      sounds on MS Windows operating systems, including system sounds and
+      wave files, as well as querying and configuring sound related properties.
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -54,39 +64,40 @@ extra_rdoc_files:
 - README
 - MANIFEST
 files:
+- .gemtest
 - CHANGES
-- examples/example_win32_sound.rb
-- lib/win32/sound.rb
 - MANIFEST
-- Rakefile
 - README
+- Rakefile
+- examples/example_win32_sound.rb
+- lib/win32/sound.rb
+- lib/win32/windows/functions.rb
+- lib/win32/windows/structs.rb
 - test/test_win32_sound.rb
 - win32-sound.gemspec
-- .gemtest
 homepage: http://github.com/djberg96/win32-sound
 licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: win32utils
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A library for playing with sound on MS Windows.
 test_files:
 - test/test_win32_sound.rb