audio-playback 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6610c16cd941a9fac1b38c72500b6d7cabb6e065
+  data.tar.gz: c6e6902a5c28a811f05a0e5bbc1cd425cef60fb1
+SHA512:
+  metadata.gz: e05488f906b9f0783b9b5fca1665bef683a37c0dfbf7c432bb5df866b34da7a11f32e57ba91bf5a3d3cdd6648ceab83d504c78934ff2be5ef5abf58315274ed4
+  data.tar.gz: 01dca1cea7cab6165770841b57ee11e7a7d136add803cd6a0ca6ac608325a43f4aa9e2ffad191a98ca880a85e59bd93d109b21a1ae6300f07c83faf28733f02b

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Ari Russo
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,81 @@
+# Audio Playback
+
+Play audio files at the command line or using Ruby
+
+## Installation
+
+These packages must be installed first:
+
+* portaudio
+* libsndfile
+
+Install the gem using
+
+    gem install audio-playback
+
+Or if you're using Bundler, add this to your Gemfile
+
+    gem "audio-playback"
+
+## Usage
+
+### Command line
+
+`playback [filename] [options]`
+
+#### options:
+
+* `-l` Latency in seconds.  Defaults to use the default latency for the selected output device
+
+* `-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
+
+* `-o` Output device id or name.  Defaults to the system default
+
+* `-v` or `--verbose` Verbose
+
+* `--list-devices` List the available audio output devices
+
+
+#### example:
+
+`playback test/media/1-stereo-44100.wav -v -c 1`
+
+### With Ruby
+
+```ruby
+require "audio-playback"
+
+# Prompt the user to select an audio output
+@output = AudioPlayback::Device::Output.gets
+
+options = {
+  :channels => [0,1],
+  :latency => 1,
+  :output_device => @output
+}
+
+@playback = AudioPlayback.play("test/media/1-stereo-44100.wav", options)
+
+@playback.block
+
+```
+
+#### 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
+
+* `:latency` Latency in seconds.  Defaults to use the default latency for the selected output device
+
+* `:logger` Logger object
+
+* `:output_device` Output device id or name
+
+## License
+
+Licensed under Apache 2.0, See the file LICENSE
+
+Copyright (c) 2015 [Ari Russo](http://arirusso.com)

data/bin/playback

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+#
+# ## Usage
+#
+# `playback [filename] [options]`
+#
+# #### options:
+#
+# * `-l` Latency in seconds.  Defaults to use the default latency for the selected output device
+#
+# * `-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
+#
+# * `-o` Output device id or name.  Defaults to the system default
+#
+# * `-v` Verbose
+#
+#
+
+require "audio-playback"
+require "audio-playback/commandline"
+require "optparse"
+
+def help(opts)
+  puts(opts)
+  exit
+end
+
+options = {}
+
+parser = OptionParser.new do |opts|
+
+  opts.banner = "Usage: playback [file] [options]"
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  AudioPlayback::Commandline::OPTIONS.each do |key, spec|
+    opts.on(spec[:short], spec[:long], spec[:type], spec[:name]) do |value|
+      if value.is_a?(TrueClass) && !spec[:when_true].nil?
+        value = spec[:when_true]
+      end
+      options[key] = value
+    end
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") { help(opts) }
+
+  opts.on_tail("--version", "Show version") do
+    puts AudioPlayback::VERSION
+    exit
+  end
+
+  help(opts) if ARGV.empty?
+end
+
+parser.parse!
+
+if options[:list_devices]
+  AudioPlayback.list_devices
+else
+  playback = AudioPlayback.play(ARGV[0], options)
+  playback.block
+end

data/lib/audio-playback.rb

@@ -0,0 +1,55 @@
+#
+# AudioPlayback
+# Play audio files at the command line or with Ruby
+#
+# (c)2015 Ari Russo
+# Apache 2.0 License
+# https://github.com/arirusso/audio-playback
+#
+
+# libs
+require "ffi/libc"
+require "ffi-portaudio"
+require "forwardable"
+require "ruby-audio"
+
+# modules
+require "audio-playback/device"
+require "audio-playback/playback"
+
+# classes
+require "audio-playback/file"
+require "audio-playback/sound"
+
+# Play audio files
+module AudioPlayback
+
+  VERSION = "0.0.2"
+
+  # Convenience method to play an audio file
+  # @param [::File, String] file_path
+  # @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)
+  end
+
+  # List the available audio output devices
+  # @return [Array<String>]
+  def self.list_devices
+    Device::Output.list
+  end
+
+  # Ensure that the audio system is initialized
+  # @return [Boolean]
+  def self.ensure_initialized
+    @initialized ||= FFI::PortAudio::API.Pa_Initialize
+  end
+
+end

data/lib/audio-playback/commandline.rb

@@ -0,0 +1,50 @@
+module AudioPlayback
+
+  # Using the AudioPlayback module from the command line
+  module Commandline
+
+    OPTIONS = {
+      :buffer_size => {
+        :short => "-b",
+        :long => "--buffer-size [bytes]",
+        :type => Integer,
+        :name => "Buffer size"
+      },
+
+      :channels => {
+        :short => "-c",
+        :long => "--channels [channel1, channel2]",
+        :type => Array,
+        :name => "Direct to channel(s)"
+      },
+
+      :latency => {
+        :short => "-l",
+        :long => "--latency [seconds]",
+        :type => Float,
+        :name => "Latency"
+      },
+
+      :list_devices => {
+        :long => "--list-devices",
+        :name => "List devices"
+      },
+
+      :logger => {
+        :short => "-v",
+        :long => "--verbose",
+        :name => "Run verbosely",
+        :when_true => $>
+      },
+
+      :output_device => {
+        :short => "-o",
+        :long => "--output [name or id]",
+        :type => String,
+        :name => "Output device for playback"
+      }
+    }
+
+  end
+
+end

data/lib/audio-playback/device.rb

@@ -0,0 +1,61 @@
+require "audio-playback/device/output"
+require "audio-playback/device/stream"
+
+module AudioPlayback
+
+  # Audio IO devices
+  module Device
+
+    extend self
+
+    # All output devices
+    # @return [Array<Output>]
+    def outputs
+      AudioPlayback.ensure_initialized
+      if @devices.nil?
+        count = FFI::PortAudio::API.Pa_GetDeviceCount
+        ids = (0..count-1).to_a.select { |id| output?(id) }
+        @devices = ids.map { |id| Output.new(id) }
+      end
+      @devices
+    end
+
+    # Get a device by its ID
+    # @param [Fixnum] id
+    # @return [Output]
+    def by_id(id)
+      outputs.find { |device| [device, device.id].include?(id) }
+    end
+
+    # Get a device by its name
+    # @param [String] name
+    # @return [Output]
+    def by_name(name)
+      outputs.find { |device| device.name == name }
+    end
+
+    # The system default output
+    # @return [Output]
+    def default_output
+      by_id(FFI::PortAudio::API.Pa_GetDefaultOutputDevice)
+    end
+
+    # Get system device info given a device ID
+    # @param [Fixnum] id
+    # @return [FFI::PortAudio::API::PaDeviceInfo]
+    def device_info(id)
+      FFI::PortAudio::API.Pa_GetDeviceInfo(id)
+    end
+
+    private
+
+    # Is the device with the given ID an output?
+    # @param [Fixnum] id
+    # @return [Boolean]
+    def output?(id)
+      device_info(id)[:maxOutputChannels] > 0
+    end
+
+  end
+
+end

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

@@ -0,0 +1,113 @@
+module AudioPlayback
+
+  module Device
+    # An output device
+    class Output
+
+      attr_reader :id, :name, :resource
+
+      # All output devices
+      # @return [Array<Output>]
+      def self.all
+        Device.outputs
+      end
+
+      # Prints ids and names of each device to standard out
+      # @return [Array<String>]
+      def self.list
+        all.map do |device|
+          name = "#{device.id}. #{device.name}"
+          $>.puts(name)
+          name
+        end
+      end
+
+      # Streamlined console prompt that asks the user (via standard in) to select a device
+      # When their input is received, the device is selected and enabled
+      # @return [Output]
+      def self.gets
+        device = nil
+        puts ""
+        puts "Select an audio output..."
+        while device.nil?
+          list
+          print "> "
+          selection = $stdin.gets.chomp
+          if selection != ""
+            selection = Integer(selection) rescue nil
+            device = all.find { |d| d.id == selection } unless selection.nil?
+          end
+        end
+        device
+      end
+
+      # Select an output device by ID
+      # @param [Fixnum] id
+      # @return [Output]
+      def self.by_id(id)
+        Device.by_id(id)
+      end
+
+      # Select an output device by name
+      # @param [String] name
+      # @return [Output]
+      def self.by_name(name)
+        Device.by_name(name)
+      end
+
+      # @param [Fixnum] id
+      # @param [Hash] options
+      # @option options [Float] :latency Device latency in seconds
+      def initialize(id, options = {})
+        # Init audio output resource
+        AudioPlayback.ensure_initialized
+        populate(id, options)
+      end
+
+      # Device latency in seconds
+      # @return [Float]
+      def latency
+        @resource[:suggestedLatency]
+      end
+
+      # Number of channels the device supports
+      # @return [Fixnum]
+      def num_channels
+        @resource[:channelCount]
+      end
+
+      # ID of the device
+      # @return [Fixnum]
+      def id
+        @resource[:device]
+      end
+
+      private
+
+      # The underlying resource info struct for this output
+      # @return [FFI::PortAudio::API::PaDeviceInfo]
+      def info
+        @info ||= Device.device_info(id)
+      end
+
+      # Populate the output
+      # @param [Fixnum] id
+      # @param [Hash] options
+      # @option options [Float] :latency
+      # @return [FFI::PortAudio::API::PaStreamParameters]
+      def populate(id, options = {})
+        @resource = FFI::PortAudio::API::PaStreamParameters.new
+        @resource[:device] = id
+        @name = info[:name]
+        @resource[:suggestedLatency] = options[:latency] || info[:defaultHighOutputLatency]
+        @resource[:hostApiSpecificStreamInfo] = nil
+        @resource[:channelCount] = info[:maxOutputChannels]
+        @resource[:sampleFormat] = FFI::PortAudio::API::Float32
+        @resource
+      end
+
+    end
+
+  end
+
+end