plaything 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b370e69436137efbd0bb9964231b74bae9863a7
-  data.tar.gz: e8d93ef8632e8191f2be628a58618f04723e5cf6
+  metadata.gz: bf2e22e8a9aef3aa57e957acc4cab274b624131b
+  data.tar.gz: 19ccc9e6262d3b0fea35c91823b2caa830265077
 SHA512:
-  metadata.gz: 5026505b6b2650bbac2e3a644b10bdbbb78ff675a8c8b9d3c86ec9d33ab81ac5176b5596da5d117837546a99b6aadf4b455ff2630cdd53682c8a2e60cb4fb1bc
-  data.tar.gz: d5590baa1b903ea691266b1c38d9834ead39c9d669b01113f929055e730918afefbb4847ebbd73fd973b6e82016c4824662d9bd869dd4001107de3f11be488e0
+  metadata.gz: f187e04c89a299894e1cc498c9f5d8090a3ec4095cff8c02d1eeb27ab7ef8d3d1161d51482ce23cc75ecc40591e8c85c775e1fe3004bc2705f6f0d8c39da0ae5
+  data.tar.gz: 2ae6ed0336140daf95b323413b69ebb833fabbb95fb16626b89d6ea7912ac3656839abef6fbc8dbcb578aaa92f7857644ca8ca1bcc62579774dcc4e85f26c4ed

data/lib/plaything.rb

@@ -14,7 +14,7 @@ require "plaything/openal"
 # - {#play}, {#pause}, {#stop} — controls source playback state. If the source
 #   runs out of audio to play, it will forcefully stop playback.
 # - {#position}, can be used to retrieve playback position.
-# - {#queue_size}, {#drops} — status information; should be used by the streaming
+# - {#queue_size}, {#drops}, {#starved?} — status information; should be used by the streaming
 #   source to improve playback experience.
 # - {#format=} — allows you to change format, even during playback.
 # - {#stream}, {#<<} — fills the audio buffers with PCM audio.
@@ -55,7 +55,7 @@ class Plaything
     @queued_buffers = []
     @queued_frames = []
 
-    @drops = 0
+    @starved = false
     @total_buffers_processed = 0
 
     @monitor = Monitor.new
@@ -70,7 +70,10 @@ class Plaything
   #
   # @note You must continue to supply audio, or playback will cease.
   def play
-    synchronize { @source.play }
+    synchronize do
+      @starved = false
+      @source.play
+    end
   end
 
   # Pause playback of queued audio. Playback will resume from current position when {#play} is called.
@@ -107,13 +110,31 @@ class Plaything
     end
   end
 
-  # @return [Integer] how many audio drops since last call to drops.
+  # If audio is starved, and it has not been previously seen as starved, it
+  # will return 1. However, if audio is starved and {#drops} has already
+  # reported it as starved, it will return 0. Finally, if audio is not starved,
+  # it always returns 0.
+  #
+  # @return [Integer] number of drops since previous call to {#drops}.
   def drops
-    synchronize do
-      @drops.tap { @drops = 0 }
+    if starved?
+      if @starved_toggle
+        0
+      else
+        @starved_toggle = true
+        1
+      end
+    else
+      @starved_toggle = false
+      0
     end
   end
 
+  # @return [Boolean] true if audio stream has starved
+  def starved?
+    synchronize { @starved or @source.starved? }
+  end
+
   # @return [Hash] current audio format in the queues
   def format
     synchronize do
@@ -137,8 +158,8 @@ class Plaything
   def format=(format)
     synchronize do
       if @source.playing?
-        stop
-        @drops += 1
+        stop # clear audio buffers
+        @starved = true
       end
 
       @sample_type = format.fetch(:sample_type)
@@ -179,8 +200,8 @@ class Plaything
   # @return [Integer] number of frames consumed (consumed_samples / channels), a multiple of channels
   def stream(frames, frame_format)
     synchronize do
-      if @source.playing? and @source.buffers_processed > 0
-        FFI::MemoryPointer.new(OpenAL::Buffer, @source.buffers_processed) do |ptr|
+      if buffers_processed > 0
+        FFI::MemoryPointer.new(OpenAL::Buffer, buffers_processed) do |ptr|
           OpenAL.source_unqueue_buffers(@source, ptr.count, ptr)
           @total_buffers_processed += ptr.count
           @free_buffers.concat OpenAL::Buffer.extract(ptr, ptr.count)
@@ -218,6 +239,14 @@ class Plaything
 
   protected
 
+  def buffers_processed
+    if @source.playing?
+      @source.buffers_processed
+    else
+      @source.sample_offset.div(@buffer_length)
+    end
+  end
+
   def synchronize
     @monitor.synchronize { return yield }
   end

data/lib/plaything/objects/source.rb

@@ -5,19 +5,33 @@ class Plaything
 
       # Start playback.
       def play
+        @should_be_playing = true
         OpenAL.source_play(self)
       end
 
       # Pause playback.
       def pause
+        @should_be_playing = false
         OpenAL.source_pause(self)
       end
 
       # Stop playback and rewind the source.
       def stop
+        @should_be_playing = false
         OpenAL.source_stop(self)
       end
 
+      # @return [Boolean] true if audio should be playing (#play has been called,
+      #                        but not #stop or #pause), but isn’t playing
+      def starved?
+        should_be_playing? and not playing?
+      end
+
+      # @return [Boolean] true if source should currently be playing audio
+      def should_be_playing?
+        @should_be_playing
+      end
+
       # @return [Integer] how many samples (/ channels) that have been played from the queued buffers
       def sample_offset
         get(:sample_offset, Integer)

data/lib/plaything/openal.rb

@@ -20,7 +20,8 @@ class Plaything
       :invalid_operation, 0xA004,
       :out_of_memory, 0xA005,
     ]
-    attach_function :get_error, :alGetError, [ ], :error
+    attach_function :alGetError, [ ], :error
+    attach_function :alcGetError, [ ], :error
 
     # Overridden for three purposes.
     #
@@ -35,14 +36,15 @@ class Plaything
         .gsub(/(?<!\A)\p{Lu}/u, '_\0')
         .downcase
       bang_name = "#{ruby_name}!"
+      error_method = :"#{c_name.to_s[/\Aalc?/, 0]}GetError"
 
       super(ruby_name, c_name, params, returns, options)
       alias_method(bang_name, ruby_name)
 
       define_method(ruby_name) do |*args, &block|
-        get_error # clear error
+        public_send(error_method) # clear error
         public_send(bang_name, *args, &block).tap do
-          error = get_error
+          error = public_send(error_method) # clear error
           unless error == :no_error
             raise Error, "#{ruby_name} failed with #{error}"
           end
@@ -122,8 +124,8 @@ class Plaything
       :source_type, 0x1027,
 
       :frequency, 0x2001,
-      :bits, 0x2002,
-      :channels, 0x2003,
+      # :bits, 0x2002,
+      # :channels, 0x2003,
       :size, 0x2004,
       :unused, 0x2010,
       :pending, 0x2011,
@@ -141,14 +143,6 @@ class Plaything
     ## Utility
     attach_function :alGetEnumValue, [ :string ], :int
 
-    enum_type(:parameter).to_h.each do |name, value|
-      real_name  = "AL_#{name.to_s.upcase}"
-      real_value = get_enum_value(real_name)
-      if real_value != -1 && value != real_value
-        raise NameError, "#{name} has value #{value}, should be #{real_value}"
-      end
-    end
-
     ## Listeners
     attach_function :alListenerf, [ :parameter, :float ], :void
 

data/lib/plaything/version.rb

@@ -1,3 +1,3 @@
 class Plaything
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/plaything/source_spec.rb

@@ -0,0 +1,56 @@
+describe Plaything::OpenAL::Source do
+  subject(:source) { Plaything::OpenAL::Source.new(1337) }
+
+  describe "#starved?" do
+    it "returns true if source should be playing but isnt" do
+      Plaything::OpenAL.should_receive(:source_play).with(source)
+      source.should_receive(:playing?).and_return(false)
+
+      source.play
+
+      source.should be_starved
+    end
+
+    it "returns false if source should be playing and is" do
+      Plaything::OpenAL.should_receive(:source_play).with(source)
+      source.should_receive(:playing?).and_return(true)
+
+      source.play
+
+      source.should_not be_starved
+    end
+
+    it "returns false if source should not be playing and isnt" do
+      source.should_not be_starved
+    end
+  end
+
+  describe "#playing?" do
+    it "returns true when playing" do
+      source.should_receive(:state).and_return(:playing)
+      source.should be_playing
+    end
+
+    it "returns false when not playing" do
+      source.should_receive(:state).and_return(:stopped)
+      source.should_not be_playing
+    end
+  end
+
+  describe "#stopped?" do
+    it "returns true when stopped" do
+      source.should_receive(:state).and_return(:stopped)
+      source.should be_stopped
+    end
+
+    it "returns false when not stopped" do
+      source.should_receive(:state).and_return(:paused)
+      source.should_not be_stopped
+    end
+
+    it "returns false when not stopped" do
+      source.should_receive(:state).and_return(:playing)
+      source.should_not be_stopped
+    end
+  end
+end

data/spec/plaything_spec.rb

@@ -2,4 +2,14 @@ describe "Plaything" do
   specify "VERSION is defined" do
     defined?(Plaything::VERSION).should eq "constant"
   end
+
+  describe "parameter enum" do
+    Plaything::OpenAL.enum_type(:parameter).to_h.each do |name, value|
+      specify(name) do
+        real_name  = "AL_#{name.to_s.upcase}"
+        real_value = Plaything::OpenAL.get_enum_value(real_name)
+        value.should eq real_value # value will be -1 if it does not exist
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaything
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kim Burgestrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -78,6 +78,7 @@ files:
 - lib/plaything/support/type_class.rb
 - lib/plaything/version.rb
 - plaything.gemspec
+- spec/plaything/source_spec.rb
 - spec/plaything_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Burgestrand/plaything
@@ -105,5 +106,6 @@ signing_key:
 specification_version: 4
 summary: Blast raw PCM audio through your speakers using OpenAL.
 test_files:
+- spec/plaything/source_spec.rb
 - spec/plaything_spec.rb
 - spec/spec_helper.rb