listlace 0.0.7 → 0.0.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    listlace (0.0.6)
+    listlace (0.0.7)
       activerecord
       activesupport
       open4

data/lib/listlace/commands/player_commands.rb

@@ -123,14 +123,14 @@ module Listlace
             end
           when :playing
             if player.started?
-              name = player.current_track.name
+              title = player.current_track.title
               artist = player.current_track.artist
-              time = player.formatted_current_time
-              total_time = player.current_track.formatted_total_time
+              time = Listlace.format_time(player.current_time, include_milliseconds: false)
+              total_time = Listlace.format_time(player.total_time, include_milliseconds: false)
               paused = player.paused? ? "|| " : ""
               speed = player.speed
               speed = speed != 1 ? "#{TIMES_SYMBOL}#{speed} " : ""
-              puts "%s - %s (%s / %s) %s%s" % [name, artist, time, total_time, paused, speed]
+              puts "%s - %s (%s / %s) %s%s" % [title, artist, time, total_time, paused, speed]
             else
               puts "Stopped."
             end

data/lib/listlace/library/database.rb

@@ -41,7 +41,7 @@ module Listlace
         ActiveRecord::Schema.define do
           create_table :tracks do |t|
             t.integer :original_id
-            t.string :name
+            t.string :title
             t.string :artist
             t.string :composer
             t.string :album
@@ -61,8 +61,7 @@ module Listlace
             t.integer :sample_rate
             t.text :comments
             t.integer :play_count
-            t.integer :play_date
-            t.datetime :play_date_utc
+            t.datetime :play_date
             t.integer :skip_count
             t.datetime :skip_date
             t.integer :rating

data/lib/listlace/library/selectors.rb

@@ -1,7 +1,7 @@
 module Listlace
   class Library
     module Selectors
-      STRING_SELECTORS = %w(name artist composer album album_artist genre comments location)
+      STRING_SELECTORS = %w(title artist composer album album_artist genre comments location)
       INTEGER_SELECTORS = %w(disc_number disc_count track_number track_count year bit_rate sample_rate play_count skip_count rating)
 
       STRING_SELECTORS.each do |column|
@@ -20,10 +20,6 @@ module Listlace
         end
       end
 
-      # rename the "name" selector to "song"
-      alias_method :song, :name
-      remove_method :name
-
       # The length selector is an integer selector for the length of a track. A
       # plain integer given to it represents the number of seconds. It can also take
       # a String in the format "1:23", to represent 83 seconds, for example. These
@@ -32,7 +28,7 @@ module Listlace
         normalize = lambda do |value|
           case value
           when String
-            Track.parse_time(value)
+            Listlace.parse_time(value)
           when Integer
             value * 1000
           when Range
@@ -72,16 +68,12 @@ module Listlace
       #
       # This method shouldn't have to be used directly. Many convenient methods are
       # generated for you, one for each string field you may want to select on.
-      # These are: artist, composer, album, album_artist, genre, comments, location.
-      # For example:
+      # These are: title, artist, composer, album, album_artist, genre, comments,
+      # location. For example:
       #
       #   artist :muse, match: :exact #=> playlist (108 tracks)
       #   composer :rachmanino #=> playlist (33 tracks)
       #
-      # To match the name of a track, use song:
-      #
-      #   song "frontier psychiatrist" #=> playlist (1 track)
-      #
       def string_selector(column, query, options = {})
         options[:match] ||= :middle
 

data/lib/listlace/library.rb

@@ -70,9 +70,11 @@ module Listlace
           # row already contains a hash of attributes almost ready to be passed to
           # ActiveRecord. We just need to modify the keys, e.g. change "Play Count"
           # to "play_count".
+          row["Title"] = row.delete("Name")
+          row["Play Date"] = row.delete("Play Date UTC")
+          row["Original ID"] = row.delete("Track ID")
           attributes = row.inject({}) do |acc, (key, value)|
             attribute = key.gsub(" ", "").underscore
-            attribute = "original_id" if attribute == "track_id"
             acc[attribute] = value if whitelist.include? attribute
             acc
           end

data/lib/listlace/models/track.rb

@@ -3,30 +3,14 @@ module Listlace
     has_many :playlist_items
     has_many :playlists, through: :playlist_items
 
-    def formatted_total_time
-      Track.format_time(total_time)
+    def increment_skip_count
+      increment! :skip_count
+      update_column :skip_date, Time.now
     end
 
-    def self.format_time(milliseconds)
-      total_seconds = milliseconds / 1000
-
-      seconds = total_seconds % 60
-      minutes = (total_seconds / 60) % 60
-      hours = total_seconds / 3600
-
-      if hours > 0
-        "%d:%02d:%02d" % [hours, minutes, seconds]
-      else
-        "%d:%02d" % [minutes, seconds]
-      end
-    end
-
-    def self.parse_time(string)
-      parts = string.split(":").map(&:to_i)
-      parts = [0] + parts if parts.length == 2
-      hours, minutes, seconds = parts
-      seconds = hours * 3600 + minutes * 60 + seconds
-      seconds * 1000
+    def increment_play_count
+      increment! :play_count
+      update_column :play_date, Time.now
     end
   end
 end

data/lib/listlace/player.rb

@@ -18,7 +18,6 @@ module Listlace
     def initialize
       @single_player = DEFAULT_SINGLE_PLAYER.new
       @queue = []
-      @queue.name = :queue
       @current_track = nil
       @current_track_index = nil
       @playlist_paused = false
@@ -28,11 +27,13 @@ module Listlace
 
     def queue(playlist = nil)
       if playlist.is_a? Array
-        if @queue.empty? && playlist.name && !playlist.name.empty?
-          @queue = playlist.dup
+        playlist = playlist.dup
+        playlist.map! { |track| track.is_a?(String) ? SimpleTrack.new(track) : track }
+        playlist.select! { |track| track.respond_to? :location }
+        if @queue.empty?
+          @queue = playlist
         else
           @queue += playlist
-          @queue.name = :queue
         end
       end
       @queue.dup
@@ -41,7 +42,6 @@ module Listlace
     def clear
       stop
       @queue.clear
-      @queue.name = :queue
       true
     end
 
@@ -118,9 +118,8 @@ module Listlace
     end
 
     def skip(n = 1)
-      if @current_track
-        @current_track.increment! :skip_count
-        @current_track.update_column :skip_date, Time.now
+      if @current_track.respond_to?(:increment_skip_count)
+        @current_track.increment_skip_count
       end
       change_track(n)
     end
@@ -138,7 +137,7 @@ module Listlace
           seconds = where.begin * 60 + where.end
           @single_player.seek(seconds * 1000, :absolute)
         when String
-          @single_player.seek(Track.parse_time(where), :absolute)
+          @single_player.seek(Listlace.parse_time(where), :absolute)
         when Hash
           if where[:abs]
             if where[:abs].is_a? Integer
@@ -154,11 +153,27 @@ module Listlace
     end
 
     def speed
-      @single_player.active? ? @single_player.speed : 1.0
+      @single_player.speed || 1.0
     end
 
     def speed=(new_speed)
-      @single_player.speed(new_speed)
+      @single_player.speed = new_speed
+    end
+
+    def mute
+      @single_player.mute
+    end
+
+    def unmute
+      @single_player.unmute
+    end
+
+    def volume
+      @single_player.volume
+    end
+
+    def volume=(new_volume)
+      @single_player.volume = new_volume
     end
 
     def shuffle
@@ -180,20 +195,19 @@ module Listlace
     end
 
     def current_time
-      @single_player.active? ? @single_player.current_time : 0
+      @single_player.current_time || 0
     end
 
-    def formatted_current_time
-      Track.format_time(current_time)
+    def total_time
+      @single_player.total_time
     end
 
     private
 
     def change_track(by = 1, options = {})
       if started?
-        if options[:auto]
-          @current_track.increment! :play_count
-          @current_track.update_column :play_date_utc, Time.now
+        if options[:auto] && @current_track.respond_to?(:increment_play_count)
+          @current_track.increment_play_count
         end
         @current_track_index += by
         if options[:auto] && @repeat_mode

data/lib/listlace/simple_track.rb

@@ -0,0 +1,13 @@
+module Listlace
+  # The bare minimum needed to represent a track. This is used by the Player and
+  # SinglePlayer, in case they get passed a String containing a path to an audio
+  # file. That way, users don't have to worry about creating track objects, if
+  # they want.
+  class SimpleTrack
+    attr_accessor :location
+
+    def initialize(location = nil)
+      @location = location
+    end
+  end
+end

data/lib/listlace/single_player.rb

@@ -20,9 +20,21 @@ module Listlace
       raise NotImplementedError
     end
 
-    # Begin playing a track. The track should respond to #location, which is the
-    # path where the audio file is located. The &on_end callback will be called
-    # when the track is finished playing.
+    # Get the current track object which was passed to the play method.
+    def track
+      raise NotImplementedError
+    end
+
+    # Get the title of the current track. First tries to call the title method on
+    # the current track, if that doesn't work it tries to get the title from the
+    # metadata of the audio file, and if that doesn't work it uses the filename.
+    def track_title
+      raise NotImplementedError
+    end
+
+    # Begin playing a track. The track should be either a String representing a
+    # path to an audio file, or an object responding to #location. The &on_end
+    # callback will be called when the track is finished playing.
     def play(track, &on_end)
       raise NotImplementedError
     end
@@ -52,17 +64,48 @@ module Listlace
         raise NotImplementedError
       when :relative
         raise NotImplementedError
-      when :perent
+      when :percent
         raise NotImplementedError
       else
         raise NotImplementedError
       end
     end
 
-    # Gets or sets the playback speed. If a new speed is passed as an argument,
-    # it sets it to that speed. The speed is a multiplier. For example, for
-    # double speed you'd call speed(2) and for half-speed you'd call speed(0.5).
-    def speed(new_speed = nil)
+    # 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
 
@@ -70,5 +113,17 @@ module Listlace
     def current_time
       raise NotImplementedError
     end
+
+    # Returns the length of the current track, in milliseconds.
+    def total_time
+      raise NotImplementedError
+    end
+
+    # Get metadata for the current track from the audio player. Returns a Hash
+    # with keys like :artist and :album. Values should be Strings, or nil if the
+    # value is blank.
+    def metadata
+      raise NotImplementedError
+    end
   end
 end

data/lib/listlace/single_players/mplayer.rb

@@ -1,37 +1,89 @@
 module Listlace
   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 < SinglePlayer
+      # 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
-        @active = false
         @paused = false
+        @muted = false
+        @volume = 50
+        @speed = 1.0
+        @track = nil
       end
 
       def active?
-        @active
+        not @track.nil?
       end
 
       def paused?
         @paused
       end
 
+      def track
+        @track
+      end
+
+      def track_title
+        if active?
+          if @track.respond_to? :title
+            @track.title
+          elsif title = metadata[:title]
+            title
+          else
+            _command "get_file_name", expect_answer: /^ANS_FILENAME='(.+)'$/
+          end
+        else
+          false
+        end
+      end
+
       def play(track, &on_end)
+        # Make sure we're only playing one song at any one time.
         _quit
 
+        # If a path to an audio file passed as the track, wrap it in a SimpleTrack.
+        track = SimpleTrack.new(track) if track.is_a? String
+
+        # The track object must respond to #location to be a track.
+        if not track.respond_to? :location
+          raise ArgumentError, "got a #{track.class} instead of a track"
+        end
+
         if File.exists? track.location
+          # Run the mplayer process in slave mode, passing it the location of
+          # the track's audio file.
           cmd = ["mplayer", "-slave", "-quiet", track.location]
           @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
 
-          @active = true
           @paused = false
+          @track = track
+
+          # 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
-            @active = false
+            @paused = false
+            @track = nil
             on_end.call
           end
 
@@ -47,6 +99,7 @@ module Listlace
 
       def pause
         if not @paused
+          @paused = true
           _command "pause"
         else
           false
@@ -55,6 +108,7 @@ module Listlace
 
       def resume
         if @paused
+          @paused = false
           _command "pause"
         else
           false
@@ -62,7 +116,8 @@ module Listlace
       end
 
       def seek(where, type = :absolute)
-        seconds = where.to_f / 1000
+        # mplayer talks seconds, not milliseconds.
+        seconds = where.to_f / 1_000
         case type
         when :absolute
           _command "seek #{seconds} 2", expect_answer: true
@@ -75,44 +130,97 @@ module Listlace
         end
       end
 
-      def speed(new_speed = nil)
-        if new_speed
-          answer = _command "speed_set #{new_speed.to_f}", expect_answer: true
-          !!answer
-        else
-          answer = _command "get_property speed", expect_answer: true
-          if answer && answer =~ /^ANS_speed=([0-9.]+)$/
-            $1.to_f
-          else
-            false
-          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 current_time
-        answer = _command "get_time_pos", expect_answer: true
-        if answer && answer =~ /^ANS_TIME_POSITION=([0-9.]+)$/
-          ($1.to_f * 1000).to_i
-        else
-          false
+        answer = _command "get_time_pos", expect_answer: /^ANS_TIME_POSITION=([0-9.]+)$/
+        answer ? (answer.to_f * 1000).to_i : false
+      end
+
+      def total_time
+        answer = _command "get_time_length", expect_answer: /^ANS_LENGTH=([0-9.]+)$/
+        answer ? (answer.to_f * 1000).to_i : false
+      end
+
+      def metadata
+        properties = %w(album artist comment genre title track year)
+        properties.inject({}) do |hash, property|
+          answer = _command "get_meta_#{property}", expect_answer: /^ANS_META_#{property.upcase}='(.+)'$/
+          hash[property.to_sym] = answer || nil
+          hash
         end
       end
 
       private
 
+      # Issue a command to mplayer through the slave protocol. False is returned
+      # if the process is dead (not playing anything).
+      #
+      # If :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 active?
-          if cmd == "pause"
-            @paused = !@paused
-          elsif @paused
+          # 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"
-            answer = @stdout.gets.sub("\e[A\r\e[K", "") while 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
@@ -122,16 +230,19 @@ module Listlace
         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"
-          @active = false
           @paused = false
+          @track = nil
         end
         true
       end
 
+      # Check if the mplayer process is still around.
       def _alive?
         return false if @pid.nil?
         Process.getpgid(@pid)

data/lib/listlace/time_helper.rb

@@ -0,0 +1,34 @@
+module Listlace
+  # 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 self.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 self.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/lib/listlace.rb

@@ -5,6 +5,7 @@ require "plist"
 require "active_support/core_ext/string"
 
 require "listlace/core_ext/array"
+require "listlace/time_helper"
 
 require "listlace/models/track"
 require "listlace/models/playlist"
@@ -14,6 +15,7 @@ require "listlace/library"
 require "listlace/library/database"
 require "listlace/library/selectors"
 
+require "listlace/simple_track"
 require "listlace/single_player"
 require "listlace/single_players/mplayer"
 require "listlace/player"

data/listlace.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "listlace"
-  s.version = "0.0.7"
-  s.date = "2012-09-03"
+  s.version = "0.0.8"
+  s.date = "2012-09-07"
   s.summary = "A music player in a REPL."
   s.description = "Listlace is a music player which is interacted with through a Ruby REPL."
   s.author = "Jeremy Ruten"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listlace
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-03 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -147,8 +147,10 @@ files:
 - lib/listlace/models/playlist_item.rb
 - lib/listlace/models/track.rb
 - lib/listlace/player.rb
+- lib/listlace/simple_track.rb
 - lib/listlace/single_player.rb
 - lib/listlace/single_players/mplayer.rb
+- lib/listlace/time_helper.rb
 - lib/listlace.rb
 homepage: http://github.com/yjerem/listlace
 licenses: