audio-playback 0.0.2

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

@@ -0,0 +1,52 @@
+module AudioPlayback
+
+  module Playback
+
+    # Playback data for the Device::Stream
+    class StreamData
+
+      # A C pointer version of the audio data
+      def self.to_pointer(playback)
+        stream_data = new(playback)
+        stream_data.to_pointer
+      end
+
+      # @param [Playback::Action] playback
+      def initialize(playback)
+        @playback = playback
+        populate
+      end
+
+      # A C pointer version of the audio data
+      # @return [FFI::Pointer]
+      def to_pointer
+        pointer = FFI::LibC.malloc(@playback.data_size)
+        pointer.write_array_of_float(@data.flatten)
+        pointer
+      end
+
+      private
+
+      # Populate the playback stream data
+      # @return [FrameSet]
+      def populate
+        @data = FrameSet.new(@playback)
+        add_metadata
+        @data
+      end
+
+      # Add playback metadata to the stream data
+      # @return [FrameSet]
+      def add_metadata
+        @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
+      end
+
+    end
+
+  end
+
+end

data/lib/audio-playback/sound.rb

@@ -0,0 +1,54 @@
+module AudioPlayback
+
+  class Sound
+
+    extend Forwardable
+
+    attr_reader :audio_file, :data, :size
+    def_delegators :@audio_file, :num_channels, :sample_rate
+
+    # Load a sound from the given file path
+    # @param [::File, String] file_or_path
+    # @param [Hash] options
+    # @option options [IO] logger
+    # @return [Sound]
+    def self.load(file_or_path, options = {})
+      file = AudioPlayback::File.new(file_or_path)
+      new(file, options)
+    end
+
+    # @param [AudioPlayback::File] audio_file
+    # @param [Hash] options
+    # @option options [IO] logger
+    def initialize(audio_file, options = {})
+      @audio_file = audio_file
+      populate(options)
+      report(options[:logger]) if options[:logger]
+    end
+
+    # Log a report about the sound
+    # @param [IO] logger
+    # @return [Boolean]
+    def report(logger)
+      logger.puts("Sound report for #{@audio_file.path}")
+      logger.puts("  Sample rate: #{@audio_file.sample_rate}")
+      logger.puts("  Channels: #{@audio_file.num_channels}")
+      logger.puts("  File size: #{@audio_file.size}")
+      true
+    end
+
+    private
+
+    # Populate the sound meta/data
+    # @param [Hash] options
+    # @option options [IO] :logger
+    # @return [Sound]
+    def populate(options = {})
+      @data = @audio_file.read(options)
+      @size = data.size
+      self
+    end
+
+  end
+
+end

data/test/device/output_test.rb

@@ -0,0 +1,141 @@
+require "helper"
+
+class AudioPlayback::Device::OutputTest < Minitest::Test
+
+  context "Output" do
+
+    setup do
+      @outputs = AudioPlayback::Device::Output.all
+    end
+
+    context ".all" do
+
+      should "return available outputs" do
+        refute_nil @outputs
+        refute_empty @outputs
+        assert_equal TestHelper::OUTPUT_INFO.map { |info| info[:name] }, @outputs.map(&:name)
+      end
+
+    end
+
+    context ".by_id" do
+
+      should "return an output with the given id" do
+        @outputs.each do |output|
+          assert_equal output, AudioPlayback::Device::Output.by_id(output.id)
+        end
+      end
+
+    end
+
+    context ".by_name" do
+
+      should "return an output with the given name" do
+        @outputs.each do |output|
+          assert_equal output, AudioPlayback::Device::Output.by_name(output.name)
+        end
+      end
+
+    end
+
+    context "#populate" do
+
+      setup do
+        @id = 0
+        @output = AudioPlayback::Device::Output.new(@id)
+      end
+
+      should "populate id" do
+        refute_nil @output.id
+        assert_kind_of Fixnum, @output.id
+      end
+
+      should "populate latency" do
+        refute_nil @output.latency
+        assert_kind_of Numeric, @output.latency
+      end
+
+      should "populate number of channels" do
+        refute_nil @output.num_channels
+        assert_kind_of Fixnum, @output.num_channels
+      end
+
+      should "populate name" do
+        refute_nil @output.name
+        assert_kind_of String, @output.name
+        assert_equal "Test Output #{@id+1}", @output.name
+      end
+
+    end
+
+    context "#latency" do
+
+      setup do
+        @test_id = (0..TestHelper::OUTPUT_INFO.size-1).to_a.sample
+        @test_info = TestHelper::OUTPUT_INFO[@test_id]
+      end
+
+      context "latency option" do
+
+        setup do
+          @output = AudioPlayback::Device::Output.new(@test_id, :latency => 20)
+        end
+
+        should "return correct latency" do
+          refute_nil @output.latency
+          assert_kind_of Float, @output.latency
+          assert_equal 20, @output.latency
+        end
+
+      end
+
+      context "no options" do
+
+        setup do
+          @output = AudioPlayback::Device::Output.new(@test_id)
+        end
+
+        should "return correct latency" do
+          refute_nil @output.latency
+          assert_kind_of Float, @output.latency
+          assert_equal @test_info[:defaultHighOutputLatency], @output.latency
+        end
+
+      end
+
+    end
+
+    context "#num_channels" do
+
+      setup do
+        @test_id = (0..TestHelper::OUTPUT_INFO.size-1).to_a.sample
+        @test_info = TestHelper::OUTPUT_INFO[@test_id]
+        @output = AudioPlayback::Device::Output.new(@test_id)
+      end
+
+      should "return correct num_channels" do
+        refute_nil @output.num_channels
+        assert_kind_of Fixnum, @output.num_channels
+        assert_equal @test_info[:maxOutputChannels], @output.num_channels
+      end
+
+    end
+
+    context "#id" do
+
+      setup do
+        @test_id = (0..TestHelper::OUTPUT_INFO.size-1).to_a.sample
+        @output = AudioPlayback::Device::Output.new(@test_id)
+      end
+
+      should "return correct id" do
+        refute_nil @output.id
+        assert_kind_of Fixnum, @output.id
+        assert_equal @test_id, @output.id
+      end
+
+    end
+
+  end
+
+end

data/test/device/stream_test.rb

@@ -0,0 +1,54 @@
+require "helper"
+
+class AudioPlayback::Device::StreamTest < Minitest::Test
+
+  context "Stream" do
+
+    setup do
+      @path = "test/media/1-mono-44100.wav"
+      @sound = AudioPlayback::Sound.load(@path)
+      @output = AudioPlayback::Device::Output.by_id(0)
+    end
+
+    context "#exit_callback" do
+
+      setup do
+        @stream = AudioPlayback::Device::Stream.new(@output)
+        @stream.expects(:close).once
+      end
+
+      teardown do
+        @stream.unstub(:close)
+      end
+
+      should "initialize exit callback" do
+        assert @stream.send(:exit_callback)
+      end
+
+    end
+
+    context "#play" do
+
+      setup do
+        @stream = AudioPlayback::Device::Stream.new(@output)
+        @playback = AudioPlayback::Playback.new(@sound, @output)
+        @stream.expects(:report).once
+        @stream.expects(:open_playback).once
+        @stream.expects(:start).once
+      end
+
+      teardown do
+        @stream.unstub(:report)
+        @stream.unstub(:open_playback)
+        @stream.unstub(:start)
+      end
+
+      should "return self" do
+        assert_equal @stream, @stream.play(@playback)
+      end
+
+    end
+
+  end
+
+end

data/test/device_test.rb

@@ -0,0 +1,75 @@
+require "helper"
+
+class AudioPlayback::DeviceTest < Minitest::Test
+
+  context "Device" do
+
+    setup do
+      @outputs = AudioPlayback::Device.outputs
+    end
+
+    context ".outputs" do
+
+      should "return available outputs" do
+        refute_nil @outputs
+        refute_empty @outputs
+        assert_equal TestHelper::OUTPUT_INFO.map { |info| info[:name] }, @outputs.map(&:name)
+      end
+
+    end
+
+    context ".output?" do
+
+      should "return whether device is an output" do
+        assert @outputs.all? { |output| AudioPlayback::Device.send(:output?, output.id) }
+      end
+
+    end
+
+    context ".device_info" do
+
+      should "return requested device info" do
+        assert @outputs.all? do |output|
+          info = AudioPlayback::Device.send(:device_info, output.id)
+          TestHelper::OUTPUT_INFO.include?(info)
+        end
+      end
+
+    end
+
+    context ".by_id" do
+
+      should "return an output with the given id" do
+        @outputs.each do |output|
+          assert_equal output, AudioPlayback::Device.by_id(output.id)
+        end
+      end
+
+    end
+
+    context ".by_name" do
+
+      should "return an output with the given name" do
+        @outputs.each do |output|
+          assert_equal output, AudioPlayback::Device.by_name(output.name)
+        end
+      end
+
+    end
+
+    context ".default_output" do
+
+      setup do
+        @output = AudioPlayback::Device.default_output
+      end
+
+      should "return the default output" do
+        refute_nil @output
+        assert_equal TestHelper::DEFAULT_OUTPUT_ID, @output.id
+      end
+
+    end
+
+  end
+
+end

data/test/file_test.rb

@@ -0,0 +1,105 @@
+require "helper"
+
+class AudioPlayback::FileTest < Minitest::Test
+
+  context "AudioFile" do
+
+    context ".new" do
+
+      context "mono" do
+
+        setup do
+          @path = "test/media/1-mono-44100.wav"
+          @file = AudioPlayback::File.new(@path)
+        end
+
+        should "populate" do
+          refute_nil @file
+          refute_nil @file.num_channels
+          refute_nil @file.sample_rate
+          refute_nil @file.path
+          refute_nil @file.size
+        end
+
+        should "have correct information" do
+          assert_equal 1, @file.num_channels
+          assert_equal 44100, @file.sample_rate.to_i
+          assert_equal @path, @file.path
+          assert_equal File.size(@path), @file.size
+        end
+
+      end
+
+      context "stereo" do
+
+        setup do
+          @path = "test/media/1-stereo-44100.wav"
+          @file_obj = File.new(@path)
+          @file = AudioPlayback::File.new(@file_obj)
+        end
+
+        should "populate" do
+          refute_nil @file
+          refute_nil @file.num_channels
+          refute_nil @file.sample_rate
+          refute_nil @file.path
+          refute_nil @file.size
+        end
+
+        should "have correct information" do
+          assert_equal 2, @file.num_channels
+          assert_equal 44100, @file.sample_rate.to_i
+          assert_equal @path, @file.path
+          assert_equal File.size(@path), @file.size
+        end
+
+      end
+
+    end
+
+    context "#read" do
+
+      context "mono" do
+
+        setup do
+          @path = "test/media/1-mono-44100.wav"
+          @file = AudioPlayback::File.new(@path)
+          @data = @file.read
+        end
+
+        should "populate data" do
+          refute_nil @data
+          assert @data.kind_of?(Array)
+          refute_empty @data
+          assert @data.all? { |frame| frame.kind_of?(Float) }
+          assert @data.all? { |frame| frame >= -1 }
+          assert @data.all? { |frame| frame <= 1 }
+        end
+
+      end
+
+      context "stereo" do
+
+        setup do
+          @path = "test/media/1-stereo-44100.wav"
+          @file = AudioPlayback::File.new(@path)
+          @data = @file.read
+        end
+
+        should "populate data" do
+          refute_nil @data
+          assert @data.kind_of?(Array)
+          refute_empty @data
+          assert @data.all? { |frame_channels| frame_channels.kind_of?(Array) }
+          assert @data.all? { |frame_channels| frame_channels.all? { |frame| frame.kind_of?(Float) } }
+          assert @data.all? { |frame_channels| frame_channels.all? { |frame| frame >= -1 } }
+          assert @data.all? { |frame_channels| frame_channels.all? { |frame| frame <= 1 } }
+        end
+
+      end
+
+    end
+
+  end
+
+end