plllayer 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    plllayer (0.0.1)
+      bundler
+      open4
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    open4 (1.3.0)
+    rake (10.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  plllayer!
+  rake

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Jeremy Ruten
+
+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/lib/plllayer/single_player.rb

@@ -0,0 +1,110 @@
+class Plllayer
+  # A SinglePlayer takes care of playing a single track, and controlling the
+  # playback with commands like pause, resume, seek, and so on. It probably
+  # starts an external audio player process to do this job. This class is an
+  # interface that is to be implemented for different audio players. Then the
+  # user can choose which SinglePlayer to use based on what audio players they
+  # have installed.
+  #
+  # All methods that perform an action should return false if the action isn't
+  # applicable, and return a truthy value otherwise.
+  class SinglePlayer
+    # Returns true if a track is currently loaded, i.e. either playing or
+    # paused.
+    def playing?
+      raise NotImplementedError
+    end
+
+    # Get the current track path which was passed to the play method.
+    def track_path
+      raise NotImplementedError
+    end
+
+    # Begin playing a track. The track_path should be a String representing a
+    # path to an audio file. The &on_end callback should be called when the track
+    # is finished playing.
+    def play(track_path, &on_end)
+      raise NotImplementedError
+    end
+
+    # Stop playback.
+    def stop
+      raise NotImplementedError
+    end
+
+    # Pauses playback.
+    def pause
+      raise NotImplementedError
+    end
+
+    # Resumes playback.
+    def resume
+      raise NotImplementedError
+    end
+
+    # Seek to a particular position in the track. Different types can be
+    # supported, such as absolute, relative, or percent. All times are specified
+    # in milliseconds. A NotImplementedError should be raised when a certain type
+    # isn't supported.
+    def seek(where, type = :absolute)
+      case type
+      when :absolute
+        raise NotImplementedError
+      when :relative
+        raise NotImplementedError
+      when :percent
+        raise NotImplementedError
+      else
+        raise NotImplementedError
+      end
+    end
+
+    # Gets the current playback speed. The speed is a multiplier. For example,
+    # double speed is 2 and half-speed is 0.5. Normal speed is 1.
+    def speed
+      raise NotImplementedError
+    end
+
+    # Sets the playback speed. The speed is a multiplier. For example, for
+    # double speed you'd set it to 2 and for half-speed you'd set it to 0.5. And
+    # for normal speed: 1.
+    def speed=(new_speed)
+      raise NotImplementedError
+    end
+
+    # Returns true if audio is muted.
+    def muted?
+      raise NotImplementedError
+    end
+
+    # Mutes the audio player.
+    def mute
+      raise NotImplementedError
+    end
+
+    # Unmutes the audio player.
+    def unmute
+      raise NotImplementedError
+    end
+
+    # Get the current volume as a percentage.
+    def volume
+      raise NotImplementedError
+    end
+
+    # Set the volume as a percentage. The player is automatically unmuted.
+    def volume=(new_volume)
+      raise NotImplementedError
+    end
+
+    # Returns the current time into the song, in milliseconds.
+    def position
+      raise NotImplementedError
+    end
+
+    # Returns the length of the current track, in milliseconds.
+    def track_length
+      raise NotImplementedError
+    end
+  end
+end

data/lib/plllayer/single_players/mplayer.rb

@@ -0,0 +1,218 @@
+class Plllayer
+  module SinglePlayers
+    # This is the SinglePlayer implementation for mplayer. It requires mplayer
+    # to be in your $PATH. It uses open4 to start up and communicate with the
+    # mplayer process, and mplayer's slave protocol to issue commands to mplayer.
+    class MPlayer < Plllayer::SinglePlayer
+      attr_reader :track_path
+
+      # Create a new MPlayer. The mplayer process is only started when the #play
+      # method is called to start playing a song. The process quits when the
+      # song ends. Even though a new process is started for each song, the
+      # MPlayer object keeps track of the volume, speed, and mute properties and
+      # sets these properties when a new song is played.
+      def initialize
+        @paused = false
+        @muted = false
+        @volume = 50
+        @speed = 1.0
+        @track_path = nil
+      end
+
+      def playing?
+        not @track_path.nil?
+      end
+
+      def play(track_path, &on_end)
+        # Make sure we're only playing one song at any one time.
+        _quit
+
+        if File.exists? track_path
+          # Run the mplayer process in slave mode, passing it the location of
+          # the track's audio file.
+          cmd = ["mplayer", "-slave", "-quiet", track_path]
+          @pid, @stdin, @stdout, @stderr = Open4.popen4(*cmd)
+
+          # This should skip past mplayer's initial lines of output so we can
+          # start reading its replies to our commands.
+          until @stdout.gets["playback"]
+          end
+
+          @paused = false
+          @track_path = track_path
+
+          # Persist the previous speed, volume, and mute properties into this
+          # process.
+          self.speed = @speed
+          self.volume = @volume
+          mute if @muted
+
+          # Start a thread that waits for the mplayer process to end, then calls
+          # the end of song callback. If the #quit method is called, this thread
+          # will be killed if it's still waiting for the process to end.
+          @quit_hook_active = false
+          @quit_hook = Thread.new do
+            Process.wait(@pid)
+            @quit_hook_active = true
+            @paused = false
+            @track_path = nil
+            on_end.call
+          end
+
+          true
+        else
+          false
+        end
+      end
+
+      def stop
+        _quit
+      end
+
+      def pause
+        if not @paused
+          @paused = true
+          _command "pause"
+        else
+          false
+        end
+      end
+
+      def resume
+        if @paused
+          @paused = false
+          _command "pause"
+        else
+          false
+        end
+      end
+
+      def seek(where, type = :absolute)
+        # mplayer talks seconds, not milliseconds.
+        seconds = where.to_f / 1_000
+        case type
+        when :absolute
+          _command "seek #{seconds} 2", expect_answer: true
+        when :relative
+          _command "seek #{seconds} 0", expect_answer: true
+        when :percent
+          _command "seek #{where} 1", expect_answer: true
+        else
+          raise NotImplementedError
+        end
+      end
+
+      def speed
+        @speed
+      end
+
+      def speed=(new_speed)
+        @speed = new_speed.to_f
+        answer = _command "speed_set #{@speed}", expect_answer: true
+        !!answer
+      end
+
+      def muted?
+        @muted
+      end
+
+      def mute
+        @muted = true
+        answer = _command "mute 1", expect_answer: true
+        !!answer
+      end
+
+      def unmute
+        @muted = false
+        answer = _command "mute 0", expect_answer: true
+        !!answer
+      end
+
+      def volume
+        @volume
+      end
+
+      def volume=(new_volume)
+        @muted = false
+        @volume = new_volume.to_f
+        answer = _command "volume #{@volume} 1", expect_answer: true
+        !!answer
+      end
+
+      def position
+        answer = _command "get_time_pos", expect_answer: /^ANS_TIME_POSITION=([0-9.]+)$/
+        answer ? (answer.to_f * 1000).to_i : false
+      end
+
+      def track_length
+        answer = _command "get_time_length", expect_answer: /^ANS_LENGTH=([0-9.]+)$/
+        answer ? (answer.to_f * 1000).to_i : false
+      end
+
+      private
+
+      # Issue a command to mplayer through the slave protocol. False is returned
+      # if the process is dead (not playing anything).
+      #
+      # If the :expect_answer option is set to true, this will wait for a legible
+      # answer back from mplayer, and send it as a return value. If :expect_answer
+      # is set to a Regexp, the answer mplayer gives back will be matched to that
+      # Regexp and the first match will be returned. If there are no matches, nil
+      # will be returned.
+      def _command(cmd, options = {})
+        if _alive? and playing?
+          # If the player is paused, prefix the command with "pausing ".
+          # Otherwise it unpauses when it runs a command. The only exception to
+          # this is when the "pause" command itself is issued.
+          if @paused and cmd != "pause"
+            cmd = "pausing #{cmd}"
+          end
+
+          # Send the command to mplayer.
+          @stdin.puts cmd
+
+          if options[:expect_answer]
+            # Read lines of output from mplayer until we get an actual message.
+            answer = "\n"
+            while answer == "\n"
+              answer = @stdout.gets.sub("\e[A\r\e[K", "")
+              answer = "\n" if options[:expect_answer].is_a?(Regexp) && answer !~ options[:expect_answer]
+            end
+
+            if options[:expect_answer].is_a? Regexp
+              matches = answer.match(options[:expect_answer])
+              answer = matches && matches[1]
+            end
+
+            answer
+          else
+            true
+          end
+        else
+          false
+        end
+      end
+
+      # Quit the mplayer process, stopping playback. The end of song callback
+      # will not be called if this method is called.
+      def _quit
+        if _alive?
+          @quit_hook.kill unless @quit_hook_active
+          _command "quit"
+          @paused = false
+          @track_path = nil
+        end
+        true
+      end
+
+      # Check if the mplayer process is still around.
+      def _alive?
+        return false if @pid.nil?
+        Process.getpgid(@pid)
+        true
+      rescue Errno::ESRCH
+        false
+      end
+    end
+  end
+end

data/lib/plllayer.rb

@@ -0,0 +1,307 @@
+require "open4"
+
+require "plllayer/single_player"
+require "plllayer/single_players/mplayer"
+
+class Plllayer
+  attr_reader :repeat_mode
+
+  def initialize(*args)
+    options = {}
+    options = args.pop if args.last.is_a? Hash
+
+    @single_player = Plllayer::SinglePlayers::MPlayer.new
+    @playlist = []
+    append(args.first) unless args.empty?
+    @index = nil
+    @paused = false
+    @playing = false
+    @repeat_mode = nil
+
+    at_exit { stop }
+  end
+
+  def load(playlist = nil)
+    clear
+    append(playlist)
+  end
+
+  def append(tracks)
+    tracks = Array(tracks).dup
+    tracks.select! { |track| track.respond_to?(:location) || (track.is_a?(String) && File.exists?(track)) }
+    @playlist += tracks
+    @playlist.dup
+  end
+  alias :<< :append
+
+  def playlist
+    @playlist.dup
+  end
+
+  def track
+    @index ? @playlist[@index] : nil
+  end
+
+  def track_index
+    @index
+  end
+
+  def track_path
+    if track.respond_to? :location
+      track.location
+    else
+      track
+    end
+  end
+
+  def clear
+    stop
+    @playlist.clear
+    true
+  end
+
+  def paused?
+    @paused
+  end
+
+  def playing?
+    @playing
+  end
+
+  def play
+    unless @playlist.empty?
+      @playing = true
+      @paused = false
+      @index = 0
+      play_track
+      true
+    else
+      false
+    end
+  end
+
+  def stop
+    @single_player.stop
+    @track = nil
+    @index = nil
+    @paused = false
+    @playing = false
+    true
+  end
+
+  def pause
+    if playing?
+      @paused = true
+      @single_player.pause
+    else
+      false
+    end
+  end
+
+  def resume
+    if playing?
+      @paused = false
+      if @single_player.playing?
+        @single_player.resume
+      else
+        play_track @track
+        @playlist_paused = false
+        true
+      end
+    else
+      false
+    end
+  end
+
+  def repeat(one_or_all_or_off)
+    case one_or_all_or_off
+    when :one
+      @repeat_mode = :one
+    when :all
+      @repeat_mode = :all
+    when :off
+      @repeat_mode = nil
+    end
+    true
+  end
+
+  def restart
+    change_track(0)
+  end
+
+  def back(n = 1)
+    change_track(-n)
+  end
+
+  def skip(n = 1)
+    change_track(n)
+  end
+
+  def seek(where)
+    if paused? && !@single_player.playing?
+      resume
+      pause
+    end
+
+    case where
+    when Integer
+      @single_player.seek(where, :relative)
+    when Range
+      seconds = where.begin * 60 + where.end
+      @single_player.seek(seconds * 1000, :absolute)
+    when String
+      @single_player.seek(parse_time(where), :absolute)
+    when Hash
+      if where[:abs]
+        if where[:abs].is_a? Integer
+          @single_player.seek(where[:abs], :absolute)
+        else
+          seek(where[:abs])
+        end
+      elsif where[:percent]
+        @single_player.seek(where[:percent], :percent)
+      end
+    end
+  end
+
+  def speed
+    @single_player.speed || 1.0
+  end
+
+  def speed=(new_speed)
+    @single_player.speed = new_speed
+  end
+
+  def mute
+    @single_player.mute
+  end
+
+  def unmute
+    @single_player.unmute
+  end
+
+  def muted?
+    @single_player.muted?
+  end
+
+  def volume
+    @single_player.volume
+  end
+
+  def volume=(new_volume)
+    @single_player.volume = new_volume
+  end
+
+  def shuffle
+    current_track = track
+    @playlist.shuffle!
+    if playing?
+      index = @playlist.index(current_track)
+      @playlist[0], @playlist[index] = @playlist[index], @playlist[0]
+      @index = 0
+    end
+    true
+  end
+
+  def sort(&by)
+    current_track = track
+    @playlist.sort! &by
+    if playing?
+      @index = @playlist.index(current_track)
+    end
+    true
+  end
+
+  def position
+    @single_player.position || 0
+  end
+
+  def formatted_position(options = {})
+    format_time(position, options)
+  end
+
+  def track_length
+    if paused? && !@single_player.playing?
+      resume
+      pause
+    end
+    @single_player.track_length
+  end
+
+  def formatted_track_length(options = {})
+    if length = track_length
+      format_time(length, options)
+    end
+  end
+
+  private
+
+  def change_track(by = 1, options = {})
+    if playing?
+      if options[:auto] && track.respond_to?(:increment_play_count)
+        track.increment_play_count
+      end
+      @index += by
+      if @repeat_mode
+        case @repeat_mode
+        when :one
+          @index -= by if options[:auto]
+        when :all
+          @index %= @playlist.length
+        end
+      end
+      if track && @index >= 0
+        @single_player.stop if paused? && @single_player.active?
+        play_track if not paused?
+      else
+        stop
+      end
+      true
+    else
+      false
+    end
+  end
+
+  def play_track
+    @single_player.play(track_path) do
+      change_track(1, auto: true)
+      ActiveRecord::Base.connection.close if defined?(ActiveRecord)
+    end
+    @paused = false
+    true
+  end
+
+  # Helper method to format a number of milliseconds as a string like
+  # "1:03:56.555". The only option is :include_milliseconds, true by default. If
+  # false, milliseconds won't be included in the formatted string.
+  def format_time(milliseconds, options = {})
+    ms = milliseconds % 1000
+    seconds = (milliseconds / 1000) % 60
+    minutes = (milliseconds / 60000) % 60
+    hours = milliseconds / 3600000
+
+    if ms.zero? || options[:include_milliseconds] == false
+      ms_string = ""
+    else
+      ms_string = ".%03d" % [ms]
+    end
+
+    if hours > 0
+      "%d:%02d:%02d%s" % [hours, minutes, seconds, ms_string]
+    else
+      "%d:%02d%s" % [minutes, seconds, ms_string]
+    end
+  end
+
+  # Helper method to parse a string like "1:03:56.555" and return the number of
+  # milliseconds that time length represents.
+  def parse_time(string)
+    parts = string.split(":").map(&:to_f)
+    parts = [0] + parts if parts.length == 2
+    hours, minutes, seconds = parts
+    seconds = hours * 3600 + minutes * 60 + seconds
+    milliseconds = seconds * 1000
+    milliseconds.to_i
+  end
+end
+

data/plllayer.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = "plllayer"
+  s.version = "0.0.1"
+  s.date = "2012-12-06"
+  s.summary = "An audio playback library for Ruby."
+  s.description = "plllayer is an audio playback library for Ruby. It is a Ruby interface to some external media player, such as mplayer."
+  s.author = "Jeremy Ruten"
+  s.email = "jeremy.ruten@gmail.com"
+  s.homepage = "http://github.com/yjerem/plllayer"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.files = ["Gemfile", "Gemfile.lock", "LICENSE", "plllayer.gemspec"]
+  s.files += Dir["lib/**/*.rb"]
+
+  %w(bundler open4).each do |gem_name|
+    s.add_runtime_dependency gem_name
+  end
+
+  %w(rake).each do |gem_name|
+    s.add_development_dependency gem_name
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: plllayer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Ruten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: plllayer is an audio playback library for Ruby. It is a Ruby interface
+  to some external media player, such as mplayer.
+email: jeremy.ruten@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- plllayer.gemspec
+- lib/plllayer/single_player.rb
+- lib/plllayer/single_players/mplayer.rb
+- lib/plllayer.rb
+homepage: http://github.com/yjerem/plllayer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An audio playback library for Ruby.
+test_files: []