alsa-backup 0.0.8

data/.autotest

@@ -0,0 +1,4 @@
+Autotest.add_hook :initialize do |autotest|
+  autotest.add_exception(/tmp/)
+  autotest.add_exception(/log/)
+end

data/History.txt

@@ -0,0 +1,32 @@
+== 0.0.7
+
+* Make configurable channels, sample rate and alsa device
+
+== 0.0.6
+
+* Fix file writing problem
+
+== 0.0.5
+
+* Fix half buffer writing in recording file
+
+== 0.0.4
+
+* Replace :int by :off_t in Sndfile#write_int prototype
+* Add logger in Sndfile
+* Use a 500ms buffer in ALSA::Capture#read
+* Add daemons in gem dependencies
+
+== 0.0.3
+
+* Support --background to daemonize process
+* Support --pidfile option
+* Rename existing file
+
+== 0.0.2 2009-05-19
+
+* Improve capture by support partial reads and recovering errors
+
+== 0.0.1 2009-05-14
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,32 @@
+.autotest
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+TODO
+alsa-backup.gemspec
+bin/alsa-backup
+config.sample
+lib/alsa.rb
+lib/alsa_backup.rb
+lib/alsa_backup/cli.rb
+lib/alsa_backup/core_ext.rb
+lib/alsa_backup/length_controller.rb
+lib/alsa_backup/recorder.rb
+lib/alsa_backup/writer.rb
+lib/sndfile.rb
+script/console
+script/destroy
+script/generate
+spec/alsa/pcm_spec.rb
+spec/alsa_backup/cli_spec.rb
+spec/alsa_backup/core_ext_spec.rb
+spec/alsa_backup/recorder_spec.rb
+spec/alsa_backup/writer_spec.rb
+spec/alsa_backup_spec.rb
+spec/fixtures/config_test.rb
+spec/sndfile/info_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on alsa_backup, see http://alsa_backup.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,106 @@
+= AlsaBackup
+
+* http://github.com/alban.peignier/alsa-backup
+
+== DESCRIPTION:
+
+ALSA client to perform continuous recording
+
+== FEATURES/PROBLEMS:
+
+* configurable file name strategy
+
+== SYNOPSIS:
+
+By using the default settings :
+
+  alsa-backup 
+
+will record in record.wav the default alsa device
+
+By using command line arguments :
+
+  alsa-backup --directory=/tmp --file=test.wav --length=2
+
+will record 2 seconds in /tmp/test.wav
+
+By loading a configuration :
+
+  alsa-backup --config=/path/to/config
+
+will load the specified configuration
+
+== CONFIGURATION:
+
+The configuration file is a Ruby file. This piece of code can
+configurate the AlsaBacup recorder :
+
+  AlsaBackup.config do |recorder|
+    # configure recorder here :
+    recorder.file = "record.wav"
+  end
+
+=== Recorder File 
+
+The recorder file can be specified as a simple string :
+
+  recorder.file = "record.wav"
+
+The recorder file can be specified by a Proc which returns the string :
+
+  recorder.file = Proc.new {
+    Time.now.strftime("%Y/%m-%b/%d-%a/%Hh.wav")
+  }
+
+will use the current time to create file names like these :
+
+  2009/05-May/17-Sun/19h.wav
+  2009/05-May/17-Sun/20h.wav
+
+To use different files every 15 minutes :
+
+  recorder.file = Proc.new {
+    Time.now.floor(:min, 15).strftime("%Y/%m-%b/%d-%a/%Hh%M.wav")
+  }
+
+will create files like these : 
+
+  2009/05-May/17-Sun/19h00.wav
+  2009/05-May/17-Sun/19h15.wav
+
+See config.sample.
+
+== REQUIREMENTS:
+
+* alsa library (http://www.alsa-project.org/)
+* libsndfile library (http://www.mega-nerd.com/libsndfile/)
+
+== INSTALL:
+
+  sudo apt-get install libasound2 libsndfile1
+  sudo gem install --source http://gems.github.com albanpeignier-alsa-backup
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Alban Peignier 
+
+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/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem hoe rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/alsa_backup'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec('alsa-backup') do |p|
+  p.version = AlsaBackup::VERSION
+  p.readme_file   = 'README.rdoc'
+  p.developer('Alban Peignier', 'alban@tryphon.eu')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['ffi','>= 0.3.5'], [ 'newgem', ">= #{::Newgem::VERSION}" ], [ 'daemons', '>= 1.0.10' ]
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  p.url = 'http://projects.tryphon.eu/alsa-backup'
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+desc 'Recreate Manifest.txt to include ALL files'
+task :manifest do
+  `rake check_manifest | patch -p0 > Manifest.txt`
+end
+
+desc "Generate a #{$hoe.name}.gemspec file"
+task :gemspec do
+  File.open("#{$hoe.name}.gemspec", "w") do |file|
+    file.puts $hoe.spec.to_ruby
+  end
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => :spec
+
+namespace :gems do
+  task :install do
+    gems = %w{active_support ffi rspec daemons}
+    sh "sudo gem install #{gems.join(' ')}"
+  end
+end
+
+require 'debian/build'
+
+include Debian::Build
+require 'debian/build/config'
+
+namespace "package" do
+  Package.new(:"alsa-backup") do |t|
+    t.version = '0.0.8'
+    t.debian_increment = 1
+
+    t.source_provider = GitExportProvider.new
+  end
+end
+
+require 'debian/build/tasks'

data/TODO

@@ -0,0 +1,3 @@
+* check write permissions of directories created by Writer
+* replace ALSA::try_to blocks by Proxy with method_missing
+* improve spec coverage

data/alsa-backup.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{alsa-backup}
+  s.version = "0.0.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alban Peignier"]
+  s.date = %q{2010-01-23}
+  s.default_executable = %q{alsa-backup}
+  s.description = %q{ALSA client to perform continuous recording}
+  s.email = ["alban@tryphon.eu"]
+  s.executables = ["alsa-backup"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
+  s.files = [".autotest", "History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "TODO", "alsa-backup.gemspec", "bin/alsa-backup", "config.sample", "lib/alsa.rb", "lib/alsa_backup.rb", "lib/alsa_backup/cli.rb", "lib/alsa_backup/core_ext.rb", "lib/alsa_backup/length_controller.rb", "lib/alsa_backup/recorder.rb", "lib/alsa_backup/writer.rb", "lib/sndfile.rb", "script/console", "script/destroy", "script/generate", "spec/alsa/pcm_spec.rb", "spec/alsa_backup/cli_spec.rb", "spec/alsa_backup/core_ext_spec.rb", "spec/alsa_backup/recorder_spec.rb", "spec/alsa_backup/writer_spec.rb", "spec/alsa_backup_spec.rb", "spec/fixtures/config_test.rb", "spec/sndfile/info_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
+  s.homepage = %q{http://projects.tryphon.eu/alsa-backup}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{alsa-backup}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ALSA client to perform continuous recording}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, [">= 0.3.5"])
+      s.add_runtime_dependency(%q<newgem>, [">= 1.5.2"])
+      s.add_runtime_dependency(%q<daemons>, [">= 1.0.10"])
+      s.add_development_dependency(%q<newgem>, [">= 1.5.2"])
+      s.add_development_dependency(%q<hoe>, [">= 2.5.0"])
+    else
+      s.add_dependency(%q<ffi>, [">= 0.3.5"])
+      s.add_dependency(%q<newgem>, [">= 1.5.2"])
+      s.add_dependency(%q<daemons>, [">= 1.0.10"])
+      s.add_dependency(%q<newgem>, [">= 1.5.2"])
+      s.add_dependency(%q<hoe>, [">= 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<ffi>, [">= 0.3.5"])
+    s.add_dependency(%q<newgem>, [">= 1.5.2"])
+    s.add_dependency(%q<daemons>, [">= 1.0.10"])
+    s.add_dependency(%q<newgem>, [">= 1.5.2"])
+    s.add_dependency(%q<hoe>, [">= 2.5.0"])
+  end
+end

data/bin/alsa-backup

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-5-14.
+#  Copyright (c) 2009. All rights reserved.
+
+require 'alsa_backup'
+require 'alsa_backup/cli'
+
+AlsaBackup::CLI.execute(STDOUT, *ARGV)

data/config.sample

@@ -0,0 +1,91 @@
+#
+# Config sample for Alsa.Backup
+#
+# Usage: 
+#   alsa-backup --config /path/to/this/file
+#
+
+#
+# To use syslog
+#
+#require 'syslog_logger'
+#AlsaBackup.logger = SyslogLogger.new('alsa-backup').tap do |logger|
+#  logger.level = Logger::INFO
+#end
+
+#
+# To debug
+#
+#Sndfile::logger = ALSA::logger = AlsaBackup.logger = Logger.new(STDOUT)
+
+AlsaBackup.logger.info("load config #{__FILE__}")
+
+AlsaBackup.config do |recorder|
+
+  # 
+  # To specify the alsa device to be used
+  #
+  #recorder.device = "plughw:0"
+
+  # 
+  # To specify the channel count to be used
+  #
+  #recorder.channels = 1
+  #recorder.channels = 4
+
+  # 
+  # To specify the sample_rate to be used
+  #
+  #recorder.sample_rate = 48000
+                  
+  #
+  # To use files named like this :
+  # - 2009/05-May/17-Sun/19h.wav
+  # - 2009/05-May/17-Sun/20h.wav
+  #
+  #recorder.file = Proc.new {
+  #  Time.now.strftime("%Y/%m-%b/%d-%a/%Hh.wav")
+  #}
+
+  #
+  # To use files named like this :
+  # - 2009/05-May/17-Sun/19h00.wav
+  # - 2009/05-May/17-Sun/19h15.wav
+  #
+  #recorder.file = Proc.new {
+  #  Time.now.floor(:min, 15).strftime("%Y/%m-%b/%d-%a/%Hh%M.wav")
+  #}
+
+  #
+  # Define where the files are created
+  #
+  #recorder.directory = "/var/lib/alsa-backup"
+
+  # 
+  # Customize error handler during record
+  # 
+
+  # To sleep 30 seconds on error
+  #recorder.error_handler = Proc.new do |exception| 
+  #  30
+  #end
+
+  # To fail on any error
+  #recorder.error_handler = Proc.new do |exception| 
+  #  false
+  #end
+
+  # To sleep the default time
+  #recorder.error_handler = Proc.new do |exception| 
+  #  true
+  #end
+
+  # To process created files
+  # WARN: don't forget the & in the command line or fork
+  #recorder.on_close do |file|
+  #  AlsaBackup.logger.info "encode in ogg : #{file}"
+  #  system "oggenc -Q -q7 #{file} &"
+  #end
+end
+
+

data/lib/alsa.rb

@@ -0,0 +1,299 @@
+require 'ffi'
+
+require 'logger'
+
+module ALSA
+
+  def self.logger
+    unless @logger
+      @logger = Logger.new(STDERR)
+      @logger.level = Logger::WARN
+    end
+
+    @logger
+  end
+
+  def self.logger=(logger); @logger = logger; end
+
+  def self.try_to(message, &block)
+    logger.debug { message }
+    if ALSA::Native::error_code?(response = yield)
+      raise "cannot #{message} (#{ALSA::Native::strerror(response)})"
+    else
+      response
+    end
+  end
+
+  module Native
+    extend FFI::Library
+    ffi_lib "libasound.so"
+
+    attach_function :strerror, :snd_strerror, [:int], :string
+
+    def self.error_code?(response)
+      response < 0
+    end
+  end
+
+  module PCM
+
+    class Capture
+
+      attr_accessor :handle
+
+      def self.open(device, hardware_attributes = {}, &block)
+        Capture.new.open(device, hardware_attributes, &block)
+      end
+
+      def open(device, hardware_attributes = {}, &block)
+        capture_handle = FFI::MemoryPointer.new :pointer
+        ALSA::try_to "open audio device #{device}" do
+          ALSA::PCM::Native::open capture_handle, device, ALSA::PCM::Native::STREAM_CAPTURE, ALSA::PCM::Native::BLOCK
+        end
+        self.handle = capture_handle.read_pointer
+
+        self.hardware_parameters=hardware_attributes
+
+        if block_given?
+          begin
+            yield self 
+          ensure
+            self.close
+          end
+        end
+      end
+
+      def change_hardware_parameters
+        hw_params = HwParameters.new(self).default_for_device
+
+        begin
+          yield hw_params
+
+          ALSA::try_to "set hw parameters" do
+            ALSA::PCM::Native::hw_params self.handle, hw_params.handle
+          end
+        ensure
+          hw_params.free
+        end
+      end
+
+      def hardware_parameters
+        HwParameters.new(self).current_for_device
+      end
+      alias_method :hw_params, :hardware_parameters
+
+      def hardware_parameters=(attributes= {})
+        attributes = {:access => :rw_interleaved}.update(attributes)
+        change_hardware_parameters do |hw_params|
+          hw_params.update_attributes(attributes)
+        end
+      end
+
+      def read
+        ALSA.logger.debug { "start read with #{hw_params.sample_rate}, #{hw_params.channels} channels"}
+
+        # use an 500ms buffer
+        frame_count = hw_params.sample_rate / 2
+        ALSA.logger.debug { "allocate #{hw_params.buffer_size_for(frame_count)} bytes for #{frame_count} frames" }
+        FFI::MemoryPointer.new(:char, hw_params.buffer_size_for(frame_count)) do |buffer|
+          begin
+            read_buffer buffer, frame_count
+          end while yield buffer, frame_count
+        end
+      end
+
+      def read_buffer(buffer, frame_count)
+        read_count = ALSA::try_to "read from audio interface" do
+          response = ALSA::PCM::Native::readi(self.handle, buffer, frame_count)
+          if ALSA::Native::error_code?(response)
+            ALSA.logger.warn { "try to recover '#{ALSA::Native::strerror(response)}' on read"}
+            ALSA::PCM::Native::pcm_recover(self.handle, response, 1)
+          else
+            response
+          end
+        end
+
+        missing_frame_count = frame_count - read_count
+        if missing_frame_count > 0
+          ALSA.logger.debug { "re-read missing frame count: #{missing_frame_count}"}
+          read_buffer_size = hw_params.buffer_size_for(read_count)
+          # buffer[read_buffer_size] doesn't return a MemoryPointer
+          read_buffer(buffer + read_buffer_size, missing_frame_count)
+        end
+      end
+
+      def close
+        ALSA::try_to "close audio device" do
+          ALSA::PCM::Native::close self.handle
+        end
+      end
+
+      class HwParameters
+
+        attr_accessor :handle, :device
+
+        def initialize(device = nil)
+          hw_params_pointer = FFI::MemoryPointer.new :pointer
+
+          ALSA::PCM::Native::hw_params_malloc hw_params_pointer        
+          self.handle = hw_params_pointer.read_pointer
+
+          self.device = device if device
+        end
+
+        def update_attributes(attributes)
+          attributes.each_pair { |name, value| send("#{name}=", value) }
+        end
+
+        def default_for_device
+          ALSA::try_to "initialize hardware parameter structure" do
+            ALSA::PCM::Native::hw_params_any device.handle, self.handle
+          end
+          self
+        end
+
+        def current_for_device
+          ALSA::try_to "retrieve current hardware parameters" do
+            ALSA::PCM::Native::hw_params_current device.handle, self.handle
+          end
+          self
+        end
+
+        def access=(access)
+          ALSA::try_to "set access type" do
+            ALSA::PCM::Native::hw_params_set_access self.device.handle, self.handle, ALSA::PCM::Native::Access.const_get(access.to_s.upcase)
+          end
+        end
+
+        def channels=(channels)
+          ALSA::try_to "set channel count : #{channels}" do
+            ALSA::PCM::Native::hw_params_set_channels self.device.handle, self.handle, channels
+          end
+        end
+
+        def sample_rate=(sample_rate)
+          ALSA::try_to "set sample rate" do
+            rate = FFI::MemoryPointer.new(:int)
+            rate.write_int(sample_rate)
+
+            dir = FFI::MemoryPointer.new(:int)
+            dir.write_int(0)
+
+            error_code = ALSA::PCM::Native::hw_params_set_rate_near self.device.handle, self.handle, rate, dir
+
+            rate.free
+            dir.free
+
+            error_code
+          end
+        end
+
+        def sample_rate
+          rate = nil
+          ALSA::try_to "get sample rate" do
+            rate_pointer = FFI::MemoryPointer.new(:int)
+            dir_pointer = FFI::MemoryPointer.new(:int)
+            dir_pointer.write_int(0)
+
+            error_code = ALSA::PCM::Native::hw_params_get_rate self.handle, rate_pointer, dir_pointer
+
+            rate = rate_pointer.read_int
+
+            rate_pointer.free
+            dir_pointer.free
+
+            error_code
+          end
+          rate
+        end
+
+        def sample_format=(sample_format)
+          ALSA::try_to "set sample format" do
+            ALSA::PCM::Native::hw_params_set_format self.device.handle, self.handle, ALSA::PCM::Native::Format.const_get(sample_format.to_s.upcase)
+          end
+        end
+
+        def sample_format
+          format = nil
+          FFI::MemoryPointer.new(:int) do |format_pointer|
+            ALSA::try_to "get sample format" do
+              ALSA::PCM::Native::hw_params_get_format self.handle, format_pointer
+            end
+            format = format_pointer.read_int
+          end
+          format
+        end
+
+        def channels
+          channels = nil
+          FFI::MemoryPointer.new(:int) do |channels_pointer|
+            ALSA::try_to "get channels" do
+              ALSA::PCM::Native::hw_params_get_channels self.handle, channels_pointer
+            end
+            channels = channels_pointer.read_int
+          end
+          channels
+        end
+
+        def buffer_size_for(frame_count)
+          ALSA::PCM::Native::format_size(self.sample_format, frame_count) * self.channels
+        end
+
+        def free
+          ALSA::try_to "unallocate hw_params" do
+            ALSA::PCM::Native::hw_params_free self.handle
+          end
+        end
+
+      end
+
+    end
+
+    module Native
+      extend FFI::Library
+      ffi_lib "libasound.so"
+
+      STREAM_CAPTURE = 1
+      BLOCK = 0
+      attach_function :open, :snd_pcm_open, [:pointer, :string, :int, :int], :int
+      attach_function :prepare, :snd_pcm_prepare, [ :pointer ], :int
+      attach_function :close, :snd_pcm_close, [:pointer], :int
+
+      attach_function :readi, :snd_pcm_readi, [ :pointer, :pointer, :ulong ], :long
+
+      attach_function :pcm_recover, :snd_pcm_recover, [ :pointer, :int, :int ], :int
+
+      attach_function :hw_params_malloc, :snd_pcm_hw_params_malloc, [:pointer], :int
+      attach_function :hw_params_free, :snd_pcm_hw_params_free, [:pointer], :int
+
+      attach_function :hw_params, :snd_pcm_hw_params, [ :pointer, :pointer ], :int
+      attach_function :hw_params_any, :snd_pcm_hw_params_any, [:pointer, :pointer], :int
+      attach_function :hw_params_current, :snd_pcm_hw_params_current, [ :pointer, :pointer ], :int
+
+
+      module Access
+        MMAP_INTERLEAVED = 0
+        MMAP_NONINTERLEAVED = 1
+        MMAP_COMPLEX = 2
+        RW_INTERLEAVED = 3
+        RW_NONINTERLEAVED = 4
+      end
+
+      attach_function :hw_params_set_access, :snd_pcm_hw_params_set_access, [ :pointer, :pointer, :int ], :int
+
+      module Format
+        S16_LE = 2
+      end
+      
+      attach_function :hw_params_set_format, :snd_pcm_hw_params_set_format, [ :pointer, :pointer, :int ], :int
+      attach_function :hw_params_get_format, :snd_pcm_hw_params_get_format, [ :pointer, :pointer ], :int
+      attach_function :hw_params_get_rate, :snd_pcm_hw_params_get_rate, [ :pointer, :pointer, :pointer ], :int
+      attach_function :hw_params_set_rate_near, :snd_pcm_hw_params_set_rate_near, [ :pointer, :pointer, :pointer, :pointer ], :int
+      attach_function :hw_params_set_channels, :snd_pcm_hw_params_set_channels, [ :pointer, :pointer, :uint ], :int
+      attach_function :hw_params_get_channels, :snd_pcm_hw_params_get_format, [ :pointer, :pointer ], :int
+      attach_function :hw_params_set_periods, :snd_pcm_hw_params_set_periods, [ :pointer, :pointer, :uint, :int ], :int
+
+      attach_function :format_size, :snd_pcm_format_size, [ :int, :uint ], :int
+    end
+  end
+end