ruby-groove 0.1.0

data/lib/groove/loudness.rb

@@ -0,0 +1,133 @@
+# Generated by ffi_gen. Please do not change this file by hand.
+
+require 'ffi'
+
+module Groove::Loudness
+  extend FFI::Library
+  ffi_lib 'grooveloudness'
+  
+  def self.attach_function(name, *_)
+    begin; super; rescue FFI::NotFoundError => e
+      (class << self; self; end).class_eval { define_method(name) { |*_| raise e } }
+    end
+  end
+  
+  # (Not documented)
+  # 
+  # = Fields:
+  # :loudness ::
+  #   (Float) loudness is in LUFS. 1 LUFS == 1 dB
+  #   EBU R128 specifies that playback should target -23 LUFS. replaygain on
+  #   the other hand is a suggestion of how many dB to adjust the gain so
+  #   that it equals -18 dB.
+  #   so, for playback you might adjust the gain so that it is equal to -18 dB
+  #   (this would be the replaygain standard) or so that it is equal to -23 dB
+  #   (this would be the EBU R128 standard).
+  # :peak ::
+  #   (Float) peak amplitude in float format
+  # :duration ::
+  #   (Float) how many seconds long this song is
+  # :item ::
+  #   (FFI::Pointer(*GroovePlaylistItem)) if item is NULL, this info applies to all songs analyzed until
+  #   this point. otherwise it is the playlist item that this info
+  #   applies to.
+  #   when disable_album is set, this sentinel is still sent, but loudness
+  #   will be set to 0
+  class GrooveLoudnessDetectorInfo < FFI::Struct
+    layout :loudness, :double,
+           :peak, :double,
+           :duration, :double,
+           :item, :pointer
+  end
+  
+  # (Not documented)
+  # 
+  # = Fields:
+  # :info_queue_size ::
+  #   (Integer) maximum number of GrooveLoudnessDetectorInfo items to store in this
+  #   loudness detector's queue. this defaults to MAX_INT, meaning that
+  #   the loudness detector will cause the decoder to decode the entire
+  #   playlist. if you want to instead, for example, obtain loudness info
+  #   at the same time as playback, you might set this value to 1.
+  # :sink_buffer_size ::
+  #   (Integer) how big the sink buffer should be, in sample frames.
+  #   groove_loudness_detector_create defaults this to 8192
+  # :disable_album ::
+  #   (Integer) set to 1 to only compute track loudness. This is faster and requires
+  #   less memory than computing both.
+  # :playlist ::
+  #   (FFI::Pointer(*GroovePlaylist)) read-only. set when attached and cleared when detached
+  class GrooveLoudnessDetector < FFI::Struct
+    layout :info_queue_size, :int,
+           :sink_buffer_size, :int,
+           :disable_album, :int,
+           :playlist, :pointer
+  end
+  
+  # (Not documented)
+  # 
+  # @method loudness_detector_create()
+  # @return [GrooveLoudnessDetector] 
+  # @scope class
+  attach_function :loudness_detector_create, :groove_loudness_detector_create, [], GrooveLoudnessDetector
+  
+  # (Not documented)
+  # 
+  # @method loudness_detector_destroy(detector)
+  # @param [GrooveLoudnessDetector] detector 
+  # @return [nil] 
+  # @scope class
+  attach_function :loudness_detector_destroy, :groove_loudness_detector_destroy, [GrooveLoudnessDetector], :void
+  
+  # once you attach, you must detach before destroying the playlist
+  # 
+  # @method loudness_detector_attach(detector, playlist)
+  # @param [GrooveLoudnessDetector] detector 
+  # @param [FFI::Pointer(*GroovePlaylist)] playlist 
+  # @return [Integer] 
+  # @scope class
+  attach_function :loudness_detector_attach, :groove_loudness_detector_attach, [GrooveLoudnessDetector, :pointer], :int
+  
+  # (Not documented)
+  # 
+  # @method loudness_detector_detach(detector)
+  # @param [GrooveLoudnessDetector] detector 
+  # @return [Integer] 
+  # @scope class
+  attach_function :loudness_detector_detach, :groove_loudness_detector_detach, [GrooveLoudnessDetector], :int
+  
+  # returns < 0 on error, 0 on aborted (block=1) or no info ready (block=0),
+  # 1 on info returned
+  # 
+  # @method loudness_detector_info_get(detector, info, block)
+  # @param [GrooveLoudnessDetector] detector 
+  # @param [GrooveLoudnessDetectorInfo] info 
+  # @param [Integer] block 
+  # @return [Integer] 
+  # @scope class
+  attach_function :loudness_detector_info_get, :groove_loudness_detector_info_get, [GrooveLoudnessDetector, GrooveLoudnessDetectorInfo, :int], :int
+  
+  # returns < 0 on error, 0 on no info ready, 1 on info ready
+  # if block is 1, block until info is ready
+  # 
+  # @method loudness_detector_info_peek(detector, block)
+  # @param [GrooveLoudnessDetector] detector 
+  # @param [Integer] block 
+  # @return [Integer] 
+  # @scope class
+  attach_function :loudness_detector_info_peek, :groove_loudness_detector_info_peek, [GrooveLoudnessDetector, :int], :int
+  
+  # get the position of the detect head
+  # both the current playlist item and the position in seconds in the playlist
+  # item are given. item will be set to NULL if the playlist is empty
+  # you may pass NULL for item or seconds
+  # 
+  # @method loudness_detector_position(detector, item, seconds)
+  # @param [GrooveLoudnessDetector] detector 
+  # @param [FFI::Pointer(**GroovePlaylistItem)] item 
+  # @param [FFI::Pointer(*Double)] seconds 
+  # @return [nil] 
+  # @scope class
+  attach_function :loudness_detector_position, :groove_loudness_detector_position, [GrooveLoudnessDetector, :pointer, :pointer], :void
+  
+end

data/lib/groove/player.rb

@@ -0,0 +1,183 @@
+# Generated by ffi_gen. Please do not change this file by hand.
+
+require 'ffi'
+
+module Groove::Player
+  extend FFI::Library
+  ffi_lib 'grooveplayer'
+  
+  def self.attach_function(name, *_)
+    begin; super; rescue FFI::NotFoundError => e
+      (class << self; self; end).class_eval { define_method(name) { |*_| raise e } }
+    end
+  end
+  
+  # (Not documented)
+  # 
+  # <em>This entry is only for documentation and no real method. The FFI::Enum can be accessed via #enum_type(:groove_player_event_type).</em>
+  # 
+  # === Options:
+  # :nowplaying ::
+  #   when the currently playing track changes.
+  # :bufferunderrun ::
+  #   when something tries to read from an empty buffer
+  # 
+  # @method _enum_groove_player_event_type_
+  # @return [Symbol]
+  # @scope class
+  enum :groove_player_event_type, [
+    :nowplaying, 0,
+    :bufferunderrun, 1
+  ]
+  
+  # (Not documented)
+  # 
+  # = Fields:
+  # :type ::
+  #   (Symbol from _enum_groove_player_event_type_) 
+  class GroovePlayerEvent < FFI::Union
+    layout :type, :groove_player_event_type
+  end
+  
+  # (Not documented)
+  # 
+  # = Fields:
+  # :device_index ::
+  #   (Integer) set this to the device you want to open
+  #   could also be GROOVE_PLAYER_DEFAULT_DEVICE or GROOVE_PLAYER_DUMMY_DEVICE
+  # :target_audio_format ::
+  #   (unknown) The desired audio format settings with which to open the device.
+  #   groove_player_create defaults these to 44100 Hz,
+  #   signed 16-bit int, stereo.
+  #   These are preferences; if a setting cannot be used, a substitute will be
+  #   used instead. actual_audio_format is set to the actual values.
+  # :device_buffer_size ::
+  #   (Integer) how big the device buffer should be, in sample frames.
+  #   must be a power of 2.
+  #   groove_player_create defaults this to 1024
+  # :sink_buffer_size ::
+  #   (Integer) how big the sink buffer should be, in sample frames.
+  #   groove_player_create defaults this to 8192
+  # :gain ::
+  #   (Float) This volume adjustment to make to this player.
+  #   It is recommended that you leave this at 1.0 and instead adjust the
+  #   gain of the underlying playlist.
+  #   If you want to change this value after you have already attached the
+  #   sink to the playlist, you must use groove_player_set_gain.
+  #   float format. Defaults to 1.0
+  # :playlist ::
+  #   (FFI::Pointer(*GroovePlaylist)) read-only. set when you call groove_player_attach and cleared when
+  #   you call groove_player_detach
+  # :actual_audio_format ::
+  #   (unknown) read-only. set to the actual format you get when you open the device.
+  #   ideally will be the same as target_audio_format but might not be.
+  class GroovePlayer < FFI::Struct
+    layout :device_index, :int,
+           :target_audio_format, :char,
+           :device_buffer_size, :int,
+           :sink_buffer_size, :int,
+           :gain, :double,
+           :playlist, :pointer,
+           :actual_audio_format, :char
+  end
+  
+  # (Not documented)
+  # 
+  # @method device_count()
+  # @return [Integer] 
+  # @scope class
+  attach_function :device_count, :groove_device_count, [], :int
+  
+  # Returns the name of the audio device at the requested index, or NULL on error
+  # The string returned by this function is UTF-8 encoded, read-only, and
+  # managed internally. You are not to free it. If you need to keep the string
+  # for any length of time, you should make your own copy of it.
+  # 
+  # @method device_name(index)
+  # @param [Integer] index 
+  # @return [String] 
+  # @scope class
+  attach_function :device_name, :groove_device_name, [:int], :string
+  
+  # (Not documented)
+  # 
+  # @method player_create()
+  # @return [GroovePlayer] 
+  # @scope class
+  attach_function :player_create, :groove_player_create, [], GroovePlayer
+  
+  # (Not documented)
+  # 
+  # @method player_destroy(player)
+  # @param [GroovePlayer] player 
+  # @return [nil] 
+  # @scope class
+  attach_function :player_destroy, :groove_player_destroy, [GroovePlayer], :void
+  
+  # Attaches the player to the playlist instance and opens the device to
+  # begin playback.
+  # Internally this creates a GrooveSink and sends the samples to the device.
+  # you must detach a player before destroying it or the playlist it is
+  # attached to
+  # returns 0 on success, < 0 on error
+  # 
+  # @method player_attach(player, playlist)
+  # @param [GroovePlayer] player 
+  # @param [FFI::Pointer(*GroovePlaylist)] playlist 
+  # @return [Integer] 
+  # @scope class
+  attach_function :player_attach, :groove_player_attach, [GroovePlayer, :pointer], :int
+  
+  # returns 0 on success, < 0 on error
+  # 
+  # @method player_detach(player)
+  # @param [GroovePlayer] player 
+  # @return [Integer] 
+  # @scope class
+  attach_function :player_detach, :groove_player_detach, [GroovePlayer], :int
+  
+  # get the position of the play head
+  # both the current playlist item and the position in seconds in the playlist
+  # item are given. item will be set to NULL if the playlist is empty
+  # you may pass NULL for item or seconds
+  # 
+  # @method player_position(player, item, seconds)
+  # @param [GroovePlayer] player 
+  # @param [FFI::Pointer(**GroovePlaylistItem)] item 
+  # @param [FFI::Pointer(*Double)] seconds 
+  # @return [nil] 
+  # @scope class
+  attach_function :player_position, :groove_player_position, [GroovePlayer, :pointer, :pointer], :void
+  
+  # returns < 0 on error, 0 on no event ready, 1 on got event
+  # 
+  # @method player_event_get(player, event, block)
+  # @param [GroovePlayer] player 
+  # @param [GroovePlayerEvent] event 
+  # @param [Integer] block 
+  # @return [Integer] 
+  # @scope class
+  attach_function :player_event_get, :groove_player_event_get, [GroovePlayer, GroovePlayerEvent, :int], :int
+  
+  # returns < 0 on error, 0 on no event ready, 1 on event ready
+  # if block is 1, block until event is ready
+  # 
+  # @method player_event_peek(player, block)
+  # @param [GroovePlayer] player 
+  # @param [Integer] block 
+  # @return [Integer] 
+  # @scope class
+  attach_function :player_event_peek, :groove_player_event_peek, [GroovePlayer, :int], :int
+  
+  # See the gain property of GrooveSink. It is recommended that you leave this
+  # at 1.0 and instead adjust the gain of the playlist.
+  # returns 0 on success, < 0 on error
+  # 
+  # @method player_set_gain(player, gain)
+  # @param [GroovePlayer] player 
+  # @param [Float] gain 
+  # @return [Integer] 
+  # @scope class
+  attach_function :player_set_gain, :groove_player_set_gain, [GroovePlayer, :double], :int
+  
+end

data/lib/groove/version.rb

@@ -0,0 +1,5 @@
+module Groove
+  # This is the ruby-groove version.
+  # To get the libgroove version use: Groove.version
+  VERSION = "0.1.0"
+end

data/test/lib/groove.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+describe Groove do
+  it 'heyo' do
+  end
+end

data/test/lib/test_version.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+describe Groove::VERSION do
+  it 'must be a valid version' do
+    Groove::VERSION.must_be_kind_of String
+    Groove::VERSION.must_match /\d+\.\d+\.\d/
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'groove'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: ruby-groove
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- john muhl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: ffi_gen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- me@johnmuhl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/groove.rb
+- lib/groove/fingerprinter.rb
+- lib/groove/groove.rb
+- lib/groove/loudness.rb
+- lib/groove/player.rb
+- lib/groove/version.rb
+- test/lib/groove.rb
+- test/lib/test_version.rb
+- test/test_helper.rb
+homepage: http://github.com/johnmuhl/ruby-groove
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: FFI bindings to libgroove
+test_files: []
+has_rdoc: