audio-playback 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6610c16cd941a9fac1b38c72500b6d7cabb6e065
-  data.tar.gz: c6e6902a5c28a811f05a0e5bbc1cd425cef60fb1
+  metadata.gz: 6d31788d41c35211e2136b9e47ec91313124292c
+  data.tar.gz: b4266924f87e9120e0eef56427cca84f1c7a83da
 SHA512:
-  metadata.gz: e05488f906b9f0783b9b5fca1665bef683a37c0dfbf7c432bb5df866b34da7a11f32e57ba91bf5a3d3cdd6648ceab83d504c78934ff2be5ef5abf58315274ed4
-  data.tar.gz: 01dca1cea7cab6165770841b57ee11e7a7d136add803cd6a0ca6ac608325a43f4aa9e2ffad191a98ca880a85e59bd93d109b21a1ae6300f07c83faf28733f02b
+  metadata.gz: dd437d403ba74b706e8d28f62f9b9d65724bfde9fa84cb2ab0ca9ae5a9ed41939480b740e58b1f3bc24d36e743d97a83f058788fb674bf5d1849a6f09eeafb98
+  data.tar.gz: fa358efb5773f25ee46dfd88c9b97d2093f5b4b9b17442a68389f50d711a9d725b04185fedbe09490ce84af7a858bb2e7141d8ab5dadc679204c3cb612cfdbb9

data/README.md

@@ -1,15 +1,19 @@
 # Audio Playback
 
-Play audio files at the command line or using Ruby
+A command line and Ruby tool for playing audio files
+
+Under the hood the *portaudio* and *libsndfile* libraries are used, enabling the gem to be cross-platform on any systems where these libraries are available
 
 ## Installation
 
 These packages must be installed first:
 
-* portaudio
-* libsndfile
+* libsndfile ([link](https://github.com/erikd/libsndfile))
+* portaudio ([link](http://portaudio.com/docs/v19-doxydocs/pages.html))
+
+Both libraries are available in *Homebrew*, *APT*, *Yum* as well as many other package managers. For those who wish to compile themselves or need more information about those packages, follow the links above for more information
 
-Install the gem using
+Once those libraries are installed, install the gem itself using
 
     gem install audio-playback
 
@@ -29,7 +33,7 @@ Or if you're using Bundler, add this to your Gemfile
 
 * `-b` Buffer size in bytes.  Defaults to 4096
 
-* `-c` Output audio to the given channel(s).  Eg `-c 0,1` will direct audio to channels 0 and 1.  Defaults to use all available channels
+* `-c` Output audio to the given channel(s).  Eg `-c 0,1` will direct audio to channels 0 and 1.  Defaults to use channels 0 and 1 on the selected device
 
 * `-o` Output device id or name.  Defaults to the system default
 
@@ -58,6 +62,7 @@ options = {
 
 @playback = AudioPlayback.play("test/media/1-stereo-44100.wav", options)
 
+# Play in the foreground
 @playback.block
 
 ```
@@ -66,7 +71,7 @@ options = {
 
 * `:buffer_size` Buffer size in bytes.  Defaults to 4096
 
-* `:channel` or `:channels` Output audio to the given channel(s).  Eg `:channels => [0,1]` will direct the audio to channels 0 and 1. Defaults to use all available channels
+* `:channel` or `:channels` Output audio to the given channel(s).  Eg `:channels => [0,1]` will direct the audio to channels 0 and 1. Defaults to use channels 0 and 1 on the selected device
 
 * `:latency` Latency in seconds.  Defaults to use the default latency for the selected output device
 
@@ -74,6 +79,15 @@ options = {
 
 * `:output_device` Output device id or name
 
+#### More Examples
+
+More Ruby code examples:
+
+* [List devices](https://github.com/arirusso/audio-playback/blob/master/examples/list_devices.rb)
+* [Select a file and play](https://github.com/arirusso/audio-playback/blob/master/examples/select_and_play.rb)
+* [Play multiple files in one stream](https://github.com/arirusso/audio-playback/blob/master/examples/play_multiple.rb)
+* [Play multiple files in multiple streams](https://github.com/arirusso/audio-playback/blob/master/examples/play_multiple.rb)
+
 ## License
 
 Licensed under Apache 2.0, See the file LICENSE

data/bin/playback

@@ -12,11 +12,13 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 #
 # * `-b` Buffer size in bytes.  Defaults to 4096
 #
-# * `-c` Output audio to the given channel(s).  Eg `-c 0,1` will direct audio to channels 0 and 1.  Defaults to use all available channels
+# * `-c` Output audio to the given channel(s).  Eg `-c 0,1` will direct audio to channels 0 and 1.  Defaults to use channels 0 and 1 on the selected device
 #
 # * `-o` Output device id or name.  Defaults to the system default
 #
-# * `-v` Verbose
+# * `-v` or `--verbose` Verbose
+# 
+# * `--list-devices` List the available audio output devices
 #
 #
 

data/lib/audio-playback.rb

@@ -24,20 +24,21 @@ require "audio-playback/sound"
 # Play audio files
 module AudioPlayback
 
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   # Convenience method to play an audio file
-  # @param [::File, String] file_path
+  # @param [Array<::File>, Array<String>, ::File, String] file_paths
   # @param [Hash] options
   # @option options [Fixnum] :buffer_size Buffer size in bytes.  Defaults to 4096
   # @option options [Array<Fixnum>, Fixnum] :channels (or: :channel) Output audio to the given channel(s).  Eg `:channels => [0,1]` will direct the audio to channels 0 and 1. Defaults to use all available channels
   # @option options [Float] :latency Latency in seconds.  Defaults to use the default latency for the selected output device
   # @option options [IO] :logger Logger object
-  # @option options [Fixnum, String] :output_device Output device id or name
-  def self.play(file_path, options = {})
-    sound = Sound.load(file_path, options)
-    output = Device::Output.by_name(options[:output_device]) || Device::Output.by_id(options[:output_device]) || Device.default_output
-    Playback.play(sound, output, options)
+  # @option options [Fixnum, String] :output_device (or: :output) Output device id or name
+  def self.play(file_paths, options = {})
+    sounds = Array(file_paths).map { |path| Sound.load(path, options) }
+    requested_device = options[:output_device] || options[:output]
+    output = Device::Output.by_name(requested_device) || Device::Output.by_id(requested_device) || Device.default_output
+    Playback.play(sounds, output, options)
   end
 
   # List the available audio output devices

data/lib/audio-playback/device/stream.rb

@@ -4,6 +4,12 @@ module AudioPlayback
 
     class Stream < FFI::PortAudio::Stream
 
+      # Keep track of all streams
+      # @return [Array<Stream>]
+      def self.streams
+        @streams ||= []
+      end
+
       # @param [Output] output
       # @param [Hash] options
       # @option options [IO] logger
@@ -13,6 +19,7 @@ module AudioPlayback
         @input = nil
         @output = output.resource
         initialize_exit_callback(:logger => options[:logger])
+        Stream.streams << self
       end
 
       # Perform the given playback
@@ -36,14 +43,19 @@ module AudioPlayback
       # Block process until the current playback finishes
       # @return [Boolean]
       def block
-        while active?
-          sleep(0.0001)
-        end
-        while FFI::PortAudio::API.Pa_IsStreamActive(@stream.read_pointer) != :paNoError
-          sleep(1)
+        begin
+          while active?
+            sleep(0.0001)
+          end
+          while FFI::PortAudio::API.Pa_IsStreamActive(@stream.read_pointer) != :paNoError
+            sleep(1)
+          end
+        rescue SystemExit, Interrupt
+          # Control-C
+        ensure
+          exit
+          true
         end
-        exit
-        true
       end
 
       private
@@ -61,7 +73,7 @@ module AudioPlayback
         logger = options[:logger]
         logger.puts("Exit") if logger
         unless @stream.nil?
-          close
+          #close
           FFI::PortAudio::API.Pa_Terminate
         end
         true

data/lib/audio-playback/playback.rb

@@ -1,5 +1,6 @@
 require "audio-playback/playback/frame"
 require "audio-playback/playback/frame_set"
+require "audio-playback/playback/mixer"
 require "audio-playback/playback/stream_data"
 
 module AudioPlayback
@@ -19,18 +20,18 @@ module AudioPlayback
 
       extend Forwardable
 
-      attr_reader :buffer_size, :channels, :data, :output, :num_channels, :sound, :stream
-      def_delegators :@sound, :audio_file, :sample_rate, :size
+      attr_reader :buffer_size, :channels, :data, :output, :num_channels, :sounds, :stream
+      def_delegators :@sounds, :audio_files
 
-      # @param [Sound] sound
+      # @param [Array<Sound>, Sound] sounds
       # @param [Output] output
       # @param [Hash] options
       # @option options [Fixnum] :buffer_size
       # @option options [Array<Fixnum>, Fixnum] :channels (or: :channel)
       # @option options [IO] :logger
       # @option options [Stream] :stream
-      def initialize(sound, output, options = {})
-        @sound = sound
+      def initialize(sounds, output, options = {})
+        @sounds = Array(sounds)
         @buffer_size = options[:buffer_size] || DEFAULT[:buffer_size]
         @output = output
         @stream = options[:stream] || Device::Stream.new(@output, options)
@@ -38,12 +39,21 @@ module AudioPlayback
         report(options[:logger]) if options[:logger]
       end
 
+      def sample_rate
+        @sounds.last.sample_rate
+      end
+
+      def size
+        @sounds.map(&:size).max
+      end
+
       # Start playback
       # @return [Playback]
       def start
         @stream.play(self)
         self
       end
+      alias_method :play, :start
 
       # Block process until playback finishes
       # @return [Stream]
@@ -55,7 +65,8 @@ module AudioPlayback
       # @param [IO] logger
       # @return [Boolean]
       def report(logger)
-        logger.puts("Playback report for #{@sound.audio_file.path}")
+        paths = @sounds.map(&:audio_file).map(&:path)
+        logger.puts("Playback report for #{paths}")
         logger.puts("  Number of channels: #{@num_channels}")
         logger.puts("  Direct audio to channels #{@channels.to_s}") unless @channels.nil?
         logger.puts("  Buffer size: #{@buffer_size}")
@@ -66,10 +77,12 @@ module AudioPlayback
       # Total size of the playback's sound frames in bytes
       # @return [Fixnum]
       def data_size
-        frames = (@sound.size * @num_channels) + METADATA.count
+        frames = (size * @num_channels) + METADATA.count
         frames * FRAME_SIZE.size
       end
 
+      # Has a different channel configuration than the default been requested?
+      # @return [Boolean]
       def channels_requested?
         !@channels.nil?
       end

data/lib/audio-playback/playback/frame_set.rb

@@ -16,26 +16,35 @@ module AudioPlayback
 
       private
 
-      # Populate the Container
+      # Build the frame set data for the given playback action and sound
       # @param [Playback::Action] playback
+      # @param [Sound] sound
       # @return [Array<Array<Float>>]
-      def populate(playback)
-        data = playback.sound.data.dup
+      def build_for_sound(playback, sound)
+        data = sound.data
         data = ensure_array_frames(data)
         data = to_frame_objects(data)
+        data = build_channels(data, playback) if !channels_match?(playback, sound)
+        data
+      end
 
-        @data = if channels_match?(playback)
-          data
+      # Populate the Container
+      # @param [Playback::Action] playback
+      # @return [Array<Array<Float>>]
+      def populate(playback)
+        data = playback.sounds.map { |sound| build_for_sound(playback, sound) }
+        @data = if data.count > 1
+          Mixer.mix(data)
         else
-          build_channels(data, playback)
+          data[0]
         end
       end
 
       # Does the channel structure of the playback action match the channel structure of the sound?
       # @param [Playback::Action] playback
       # @return [Boolean]
-      def channels_match?(playback)
-        playback.sound.num_channels == playback.num_channels && playback.channels.nil?
+      def channels_match?(playback, sound)
+        sound.num_channels == playback.num_channels && playback.channels.nil?
       end
 
       # (Re-)build the channel structure of the frame set

data/lib/audio-playback/playback/mixer.rb

@@ -0,0 +1,60 @@
+module AudioPlayback
+
+  module Playback
+
+    # Mix sound data
+    class Mixer
+
+      # Mix multiple sounds at equal amplitude
+      # @param [Array<Array<Array<Fixnum>>>] sounds_data
+      # @return [Array<Array<Fixnum>>]
+      def self.mix(sounds_data)
+        mixer = new(sounds_data)
+        mixer.mix
+      end
+
+      # @param [Array<Array<Array<Fixnum>>>] sounds_data
+      def initialize(sounds_data)
+        @data = sounds_data
+        populate
+      end
+
+      # Mix multiple sounds at equal amplitude
+      # @return [Array<Array<Fixnum>>]
+      def mix
+        (0..@length-1).to_a.map { |index| mix_frame(index) }
+      end
+
+      private
+
+      # Populate the mixer metadata
+      # @return [Mixer]
+      def populate
+        @length = @data.map(&:size).max
+        @depth = @data.count
+        self
+      end
+
+      # Get all of the data frames for the given index
+      # For example for index 3, two two channel sounds, frames(3) might give you [[1, 3], [2, 3]]
+      # @param [Fixnum] index
+      # @return [Array<Array<Fixnum>>]
+      def frames(index)
+        @data.map { |sound_data| sound_data[index] }
+      end
+
+      # Mix the frame with the given index
+      # whereas frames(3) might give you [[1, 3], [2, 3]]
+      # mix_frame(3) might give you [1.5, 3]
+      # @param [Fixnum] index
+      # @return [Array<Fixnum>]
+      def mix_frame(index)
+        totals = frames(index).compact.transpose.map { |x| x && x.reduce(:+) || 0 }
+        totals.map { |frame| frame / @depth }
+      end
+
+    end
+
+  end
+
+end

data/lib/audio-playback/playback/stream_data.rb

@@ -6,6 +6,8 @@ module AudioPlayback
     class StreamData
 
       # A C pointer version of the audio data
+      # @param [Playback::Action] playback
+      # @return [FFI::Pointer]
       def self.to_pointer(playback)
         stream_data = new(playback)
         stream_data.to_pointer
@@ -41,7 +43,7 @@ module AudioPlayback
         @data.unshift(0.0) # 3. is_eof
         @data.unshift(0.0) # 2. counter
         @data.unshift(@playback.output.num_channels.to_f) # 1. num_channels
-        @data.unshift(@playback.sound.size.to_f) # 0. sample size
+        @data.unshift(@playback.size.to_f) # 0. sample size
         @data
       end
 

data/test/playback/mixer_test.rb

@@ -0,0 +1,25 @@
+require "helper"
+
+class AudioPlayback::Playback::MixerTest < Minitest::Test
+
+  context "Mixer" do
+
+    context ".mix" do
+
+      setup do
+        @sound1 = [[1,2],[3,4],[5, 6]]
+        @sound2 = [[7,8],[9, 10]]
+        @sound = [@sound1, @sound2]
+      end
+
+      should "mix channels" do
+        @result = AudioPlayback::Playback::Mixer.mix(@sound)
+        refute_nil @result
+        assert_equal [[4, 5], [6, 7], [2, 3]], @result
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audio-playback
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ari Russo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -170,6 +170,7 @@ files:
 - lib/audio-playback/playback.rb
 - lib/audio-playback/playback/frame.rb
 - lib/audio-playback/playback/frame_set.rb
+- lib/audio-playback/playback/mixer.rb
 - lib/audio-playback/playback/stream_data.rb
 - lib/audio-playback/sound.rb
 - test/device/output_test.rb
@@ -181,8 +182,10 @@ files:
 - test/media/1-mono-44100.wav
 - test/media/1-stereo-44100.aiff
 - test/media/1-stereo-44100.wav
+- test/media/2.wav
 - test/playback/frame_set_test.rb
 - test/playback/frame_test.rb
+- test/playback/mixer_test.rb
 - test/playback/stream_data_test.rb
 - test/playback_test.rb
 - test/sound_test.rb