hallon-fifo 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hallon-fifo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Elliott Williams
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Hallon::FIFO
+
+An audio driver for Hallon, a ruby client for the official Spotify API. Streams audio into a raw PCM-formatted FIFO queue, ideal for input into other applications.
+
+Among other things, FIFO queues can be piped into unix utilities, like SoX, or read as a stream (which is exactly why I wrote this).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hallon-fifo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hallon-fifo
+
+## Usage
+
+Initialize a Hallon player with the FIFO driver. Pass a `&block` as the second argument to set the FIFO queue's path and customize the audio format, if you want:
+
+```ruby
+# After loading Hallon and creating a session...
+
+player = Hallon::Player.new Hallon::FIFO, Proc.new do
+	@driver.output = "hallon-fifo.pcm"
+	@driver.format = {:rate => 44100, :channels => 2, :type => :int16}
+end
+```
+
+Play the FIFO queue elsewhere, for example, with SoX:
+
+```bash
+$ play -r 44100 -c 2 -t s16 hallon-fifo.pcm
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hallon-fifo.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hallon-fifo/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hallon-fifo"
+  gem.version       = Hallon::Fifo::VERSION
+  gem.authors       = ["Elliott Williams"]
+  gem.email         = ["e@elliottwillia.ms"]
+  gem.description   = "An audio driver for Hallon, a ruby client for the official " +
+    "Spotify API. Streams audio into a raw PCM-formatted FIFO queue, ideal for " +
+    "input into other applications."
+  gem.summary       = "Stream Spotify through Hallon to a FIFO queue."
+  gem.homepage      = "http://github.com/elliottwilliams/hallon-fifo"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/hallon-fifo/fifo.rb

@@ -0,0 +1,90 @@
+module Hallon
+	class Fifo
+
+		def initialize
+			@buffer = Array.new
+			@playing, @stopped = false
+			@buffer_size = 22050
+
+			@output ||= "hallon-fifo.pcm"
+			File.delete(@output) if File.exists?(@output)
+			File.mkfifo(@output) # Will error if it's overwriting another file
+		end
+
+		def format
+			@format
+		end
+
+		def format=(new_format)
+			@format = new_format
+			@buffer_size = new_format[:rate] / 2
+		end
+
+		def output
+			@output
+		end
+
+		def output=(new_output)
+			old_output, @output = @output, new_output
+
+			File.delete(old_output)
+			File.delete(new_output) if File.exists?(new_output)
+			File.mkfifo(new_output)
+		end
+
+		def drops
+			# This SHOULD return the number of times the queue "stuttered"
+			0
+		end
+
+		def pause
+			@playing = false
+		end
+
+		def play
+			@playing = true
+			@stopped = false
+		end
+
+		def stop
+			@stopped = true
+			@stream_thread.exit if @stream_thread
+
+			@buffer.clear
+		end
+
+		def stream # runs indefinitely
+			@stream_thread = Thread.new do
+				queue = File.new(@output, "wb")
+
+				loop do
+
+					# Get the next block from Spotify.
+					audio_data = yield(@buffer_size)
+
+					if audio_data.nil? # Audio format has changed, reset buffer.
+						@buffer.clear # reset structure
+					else # Write to our buffer and, if playing, to the FIFO queue.
+						@buffer += audio_data
+
+						queue.syswrite packed_samples(@buffer)
+						@buffer.clear
+					end
+
+					ensure_playing
+				end
+			end
+		end
+
+		private
+
+		def packed_samples(frames)
+			frames.flatten.map { |i| [i].pack("s_") }.join
+		end
+
+		def ensure_playing
+			play unless @playing
+		end
+
+	end
+end

data/lib/hallon-fifo/version.rb

@@ -0,0 +1,5 @@
+module Hallon
+  module Fifo
+    VERSION = "0.0.1"
+  end
+end

data/lib/hallon-fifo.rb

@@ -0,0 +1,2 @@
+require "hallon-fifo/version"
+require "hallon-fifo/fifo"

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: hallon-fifo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Elliott Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-31 00:00:00.000000000 Z
+dependencies: []
+description: An audio driver for Hallon, a ruby client for the official Spotify API.
+  Streams audio into a raw PCM-formatted FIFO queue, ideal for input into other applications.
+email:
+- e@elliottwillia.ms
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hallon-fifo.gemspec
+- lib/hallon-fifo.rb
+- lib/hallon-fifo/fifo.rb
+- lib/hallon-fifo/version.rb
+homepage: http://github.com/elliottwilliams/hallon-fifo
+licenses: []
+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: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Stream Spotify through Hallon to a FIFO queue.
+test_files: []
+has_rdoc: