muzak 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 917b86d06294801e33561fe181e64fd755f09828
-  data.tar.gz: 3aebb78550918a276f0cefc7fc11e57d277759a3
+  metadata.gz: a2c396ccd25b5ca8dad7e33aad87e5e6f277f82f
+  data.tar.gz: 28f0518d153ca7dffa8713884a481b583ccdbdbb
 SHA512:
-  metadata.gz: 2f9bcb70833ce12b36e14e2f56e6042cdbfef39dc88362b8e9908a255f1eaad19d185956ebde3dbf8608f562e41a3e52151390a9c49b6afb2b38435646c53e77
-  data.tar.gz: 817a120b22297d8f3ba64afa8fe11a42452914c628de0f4b1a5f64d4d701b44c371024b2cdba0e9191cb9555ed4a0bd7d84fd8cadc2f8921c2e0e3e7f231e1fd
+  metadata.gz: 7619e9fec7c0413fadbd240c3abc828cef121aa8e9f34ba0a1c504750c31171a29aa0c43f18fdbac8d99de2ed68815db88266852ddaf0ed353dd525ee53f598a
+  data.tar.gz: a3b2b9fa7d6606a4d1f081878034890358fe97b763bcc8816365bf7cd24690905414631754c39450b1aca3d01aabe45792daa40eb0ef2a7978022effe5a045e3

data/CONFIGURATION.md

@@ -111,7 +111,9 @@ Muzak uses this key to point the indexer at the correct directory.
 
 *Default:* `mpv`
 
-`player: <player>` should be set to the short name of the user's music player.
+`player: <player>` should be set to the human-friendly name of the user's music
+player. This human-friendly name is generated from the player's ruby class name
+just like a plugin (e.g., `Muzak::Player::MPV` becomes `mpv`).
 Muzak uses this key to find the correct {Muzak::Player} underclass to
 initialize and control.
 
@@ -143,11 +145,24 @@ It's entirely up to the user's player to obey this value.
 
 *Optional.*
 
+*Default:* `false`
+
+If `autoplay: true` is set in the configuration file, then muzak will begin
+tell the player to begin playing as soon as media is loaded.
+
+### `default_playlist`
+
+*Optional.*
+
 *No default.*
 
-`autoplay: <playlist>` should be set to a playlist that the user wishes to
-automatically start when muzak starts. If not set, no playlist is automatically
-played.
+`default_playlist: <playlist>` should be set to a playlist that the user wishes
+to automatically load when muzak starts. If not set, no playlist is
+automatically loaded.
+
+*Note:* `default_playlist` does not automatically play the specified playlist
+(it only loads it). `autoplay: true` must be set to automatically play the
+default playlist.
 
 ## Daemon/client configuration
 

data/README.md

@@ -35,6 +35,5 @@ as well as on RubyDoc.
 ### TODO
 
 * GUI "frontend"?
-* isolation of art and music output (`Muzak::ArtProvider`?)
 * current indexing/sorting logic is terrible
-* replace MPV IPC implementation with [ruby-mpv](https://github.com/woodruffw/ruby-mpv)
+* figure out how to do events/album art in VLC

data/lib/muzak.rb

@@ -12,5 +12,5 @@ require_relative "muzak/instance"
 # The primary namespace for muzak.
 module Muzak
   # Muzak's current version
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

data/lib/muzak/cmd/meta.rb

@@ -39,6 +39,7 @@ module Muzak
       verbose "muzak is quitting..."
       player.deactivate!
 
+      event :instance_quitting
       build_response data: "quitting"
     end
   end

data/lib/muzak/cmd/player.rb

@@ -6,7 +6,7 @@ module Muzak
     # @note Many playback commands will automatically activate the player.
     def player_activate
       if player.running?
-        warn "player is already running"
+        danger "player is already running"
       else
         player.activate!
       end
@@ -21,7 +21,7 @@ module Muzak
     # @cmdexample `muzak> player-deactivate`
     # @note Deactivating the player (usually) ends playback immediately.
     def player_deactivate
-      warn "player is not running" unless player.running?
+      danger "player is not running" unless player.running?
 
       # do cleanup even if the player isn't running, just in case
       player.deactivate!
@@ -160,7 +160,7 @@ module Muzak
     def now_playing
       if player.playing?
         build_response data: {
-          playing: player.now_playing.full_title
+          playing: player.now_playing&.full_title
         }
       else
         build_response error: "no currently playing song"

data/lib/muzak/config.rb

@@ -46,6 +46,7 @@ module Muzak
     # All events currently propagated by {Muzak::Instance#event}
     PLUGIN_EVENTS = [
       :instance_started,
+      :instance_quitting,
       :player_activated,
       :player_deactivated,
       :song_loaded,
@@ -61,6 +62,7 @@ module Muzak
       "music" => File.expand_path("~/music"),
       "player" => "mpv",
       "jukebox-size" => 100,
+      "autoplay" => false,
 
       # client/daemon defaults
       "daemon-port" => 2669,

data/lib/muzak/instance.rb

@@ -7,6 +7,7 @@ module Muzak
     # Sends a command to the instance.
     # @param cmd [String] the name of the command
     # @param args [Array<String>] the command's arguments
+    # @return [Hash] the command's response hash
     # @example
     #   instance.command "enqueue-playlist", "favorites"
     #   instance.command "pause"
@@ -19,7 +20,7 @@ module Muzak
           build_response error: "got #{args.size} args, needed #{meth.arity}"
         end
       else
-        warn "unknown command: '#{cmd}'"
+        danger "unknown command: '#{cmd}'"
         build_response error: "unknown command '#{cmd}'"
       end
     end
@@ -36,7 +37,7 @@ module Muzak
     # @return [Hash{String => Playlist}] the instance's playlists
     attr_reader :playlists
 
-    def initialize(opts = {})
+    def initialize
       verbose "muzak is starting..."
 
       error! "#{Config.music} doesn't exist" unless File.exist?(Config.music)
@@ -49,7 +50,7 @@ module Muzak
 
       @playlists = Playlist.load_playlists!
 
-      enqueue_playlist Config.autoplay if Config.autoplay
+      enqueue_playlist Config.default_playlist if Config.default_playlist
 
       event :instance_started, self
     end
@@ -57,6 +58,7 @@ module Muzak
     # Dispatch an event to all plugins.
     # @param type [Symbol] the type of event to dispatch
     # @param args [Array] the event's arguments
+    # @return [void]
     # @note {Config::PLUGIN_EVENTS} contains all valid events.
     def event(type, *args)
       return unless Config::PLUGIN_EVENTS.include?(type)

data/lib/muzak/player.rb

@@ -8,11 +8,18 @@ module Muzak
   module Player
     extend Utils
 
-    # An association of shorthand player "names" to Class objects.
-    PLAYER_MAP = {
-      "stub" => Player::StubPlayer,
-      "mpv" => Player::MPV
-    }.freeze
+    # All classes (player implementations) under the {Player} namespace.
+    # @api private
+    PLAYER_CLASSES = constants.map(&Player.method(:const_get)).grep(Class).freeze
+
+    # All human-friendly player names.
+    # @see Player::StubPlayer.player_name
+    # @api private
+    PLAYER_NAMES = PLAYER_CLASSES.map(&:player_name).freeze
+
+    # An association of human-friendly player names to implementation classes.
+    # @api private
+    PLAYER_MAP = PLAYER_NAMES.zip(PLAYER_CLASSES).to_h.freeze
 
     # Returns an instantiated player as specified in `Config.player`.
     # @return [StubPlayer] the player instance

data/lib/muzak/player/mpv.rb

@@ -8,14 +8,14 @@ module Muzak
   module Player
     # Exposes MPV's IPC to muzak for playback control.
     class MPV < StubPlayer
-      # @return [Boolean] Whether or not MPV is available for execution
+      # @return [Boolean] whether or not MPV is available for execution
       def self.available?
         Utils.which?("mpv")
       end
 
-      # @return [Boolean] Whether or not the current instance is running.
+      # @return [Boolean] whether or not the current instance is running.
       def running?
-        @mpv&.running?
+        !!@mpv&.running?
       end
 
       # Activate mpv by executing it and preparing for event processing.
@@ -179,7 +179,8 @@ module Muzak
       # @return [void]
       # @api private
       def load_song(song, art)
-        cmds = ["loadfile", song.path, "append-play"]
+        append_type = Config.autoplay ? "append-play" : "append"
+        cmds = ["loadfile", song.path, append_type]
         cmds << "external-file=\"#{art}\"" if art
         @mpv.command *cmds
       end

data/lib/muzak/player/stub_player.rb

@@ -1,12 +1,20 @@
 module Muzak
   module Player
     # A no-op player that all players inherit from.
+    # @abstract Subclass and implement all public methods to implement
+    #  a player.
     class StubPlayer
       include Utils
 
       # @return [Instance] the instance associated with this player
       attr_reader :instance
 
+      # The player's human friendly name.
+      # @return [String] the name
+      def self.player_name
+        name.split("::").last.downcase
+      end
+
       # @return [true] whether or not this type of player is available
       def self.available?
         true

data/lib/muzak/player/vlc.rb

@@ -0,0 +1,173 @@
+require "vlc-client"
+
+module Muzak
+  module Player
+    # Exposes a VLC process to muzak for playback control.
+    class VLC < StubPlayer
+      # The expression used to extract the filename out of {#status}
+      # @api private
+      INPUT_REGEX = /\( new input: file:\/\/(.*) \)/.freeze
+
+      # The expression used to extract the volume out of {#status}
+      # @api private
+      VOLUME_REGEX = /\( audio volume: (\d+) \)/.freeze
+
+      # The expression used to extract the playing status out of {#status}
+      # @api private
+      PLAYING_REGEX = /\( state (.*) \)/.freeze
+
+      # @return [Boolean] whether or not VLC is available
+      def self.available?
+        Utils.which?("vlc") && Utils.which?("cvlc")
+      end
+
+      # @return [Boolean] whether or not the current instance is running.
+      def running?
+        !!@vlc&.connected?
+      end
+
+      # Activates a VLC process.
+      # @return [void]
+      def activate!
+        return if running?
+
+        debug "activating #{self.class}"
+
+        @vlc = ::VLC::System.new
+
+        instance.event :player_activated
+      end
+
+      # Deactivates the VLC process, if one is running.
+      # @return [void]
+      def deactivate!
+        return unless running?
+
+        debug "deactivating #{self.class}"
+
+        @vlc.client.disconnect
+        @vlc.server.stop
+
+        instance.event :player_deactivated
+      end
+
+      # Tell VLC to begin playback.
+      # @return [void]
+      # @note Does nothing is playback is already in progress.
+      def play
+        @vlc.play
+      end
+
+
+      # Tell VLC to pause playback.
+      # @return [void]
+      # @note Does nothing is playback is already paused.
+      def pause
+        @vlc.pause
+      end
+
+      # @return [Boolean] whether or not VLC is currently playing.
+      def playing?
+        @vlc.playing?
+      end
+
+      # Tell VLC to play the next song in its queue.
+      # @return [void]
+      # @note Does nothing if the current song is the last.
+      def next_song
+        @vlc.next
+      end
+
+      # Tell VLC to play the previous song in its queue.
+      # @return [void]
+      # @note Restarts the song if the current song is the first.
+      def previous_song
+        @vlc.previous
+      end
+
+      # Tell VLC to add the given song to its queue.
+      # @param song [Song] the song to add
+      # @return [void]
+      # @note Activates VLC if not already activated.
+      def enqueue_song(song)
+        activate! unless running?
+
+        load_song song
+      end
+
+      # Tell VLC to add the given album to its queue.
+      # @param album [Album] the album to add
+      # @return [void]
+      # @note Activates VLC if not already activated.
+      def enqueue_album(album)
+        activate! unless running?
+
+        album.songs.each do |song|
+          load_song song
+        end
+      end
+
+      # Tell VLC to add the given playlist to its queue.
+      # @param playlist [Playlist] the playlist to add
+      # @return [void]
+      # @note Activates VLC if not already activated.
+      def enqueue_playlist(playlist)
+        activate! unless running?
+
+        playlist.songs.each do |song|
+          load_song song
+        end
+      end
+
+      # Get VLC's internal queue.
+      # @return [Array<Song>] all songs in VLC's queue
+      # @note This includes songs already played.
+      # @todo Implement this.
+      def list_queue
+        debug @vlc.playlist.to_s
+        danger "this player doesn't support list_queue"
+        # TODO: figure out how to get VLC::Client#playlist to return filenames
+        []
+      end
+
+      # Shuffle VLC's internal queue.
+      # @return [void]
+      # @todo Implement this.
+      def shuffle
+        danger "this player doesn't support shuffling (?)"
+      end
+
+      # Clear VLC's internal queue.
+      # @return [void]
+      def clear_queue
+        @vlc.clear
+      end
+
+      # Get VLC's currently loaded song.
+      # @return [Song, nil] the currently loaded song
+      def now_playing
+        filename = INPUT_REGEX.match(status.first)[1]
+        Song.new(filename)
+      end
+
+      # Load a song into VLC.
+      # @param song [Song] the song to load
+      # @return [void]
+      # @api private
+      def load_song(song)
+        @vlc.add_to_playlist song.path
+        @vlc.play if Config.autoplay
+      end
+
+      # Get VLC's status.
+      # @return [Array<String>] the loaded file, volume, and playing statuses
+      # @api private
+      # @note The strings returned by this method can be handled via
+      #  {INPUT_REGEX}, {VOLUME_REGEX}, and {PLAYING_REGEX}.
+      def status
+        @vlc.connection.write "status"
+        3.times.collect { @vlc.connection.read }
+      end
+    end
+  end
+end

data/lib/muzak/plugin.rb

@@ -10,27 +10,24 @@ module Muzak
     # load plugins included by the user
     Dir.glob(File.join(Config::USER_PLUGIN_DIR, "*")) { |file| require file }
 
-    # @return [Array<Class>] all plugin classes visible under Plugin
-    def self.plugin_classes
-      constants.map(&Plugin.method(:const_get)).grep(Class)
-    end
+    # All classes (plugins) under the {Player} namespace.
+    # @see Plugin::StubPlugin.plugin_name
+    # @api private
+    PLUGIN_CLASSES = constants.map(&Plugin.method(:const_get)).grep(Class).freeze
 
-    # @return [Array<String>] the names of all plugin classes under Plugin
-    # @see StubPlugin.plugin_name
-    def self.plugin_names
-      plugin_classes.map do |pk|
-        pk.plugin_name
-      end
-    end
+    # All human-friendly player plugin names.
+    # @api private
+    PLUGIN_NAMES = PLUGIN_CLASSES.map(&:plugin_name).freeze
+
+    # An association of human-friendly plugin names to plugin classes.
+    # @api private
+    PLUGIN_MAP = PLUGIN_NAMES.zip(PLUGIN_CLASSES).to_h.freeze
 
     # Instantiates all configured plugins and returns them.
     # @return [Array<StubPlugin>] the instantiated plugins
     def self.load_plugins!
-      pks = Plugin.plugin_classes.select { |pk| Config.plugin? pk.plugin_name }
+      pks = PLUGIN_CLASSES.select { |pk| Config.plugin? pk.plugin_name }
       pks.map { |pk| pk.new }
     end
-
-    # An association of plugin names to their Class objects.
-    PLUGIN_MAP = plugin_names.zip(plugin_classes).to_h.freeze
   end
 end

data/lib/muzak/plugin/stub_plugin.rb

@@ -1,6 +1,8 @@
 module Muzak
   module Plugin
     # A no-op plugin that all real plugins inherit from.
+    # @abstract Subclass and define any of {Config::PLUGIN_EVENTS}
+    #  as methods to implement plugins.
     class StubPlugin
       include Utils
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muzak
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-22 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: vlc-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
 description: A library for controlling playlists and media players.
 email: william@tuffbizz.com
 executables:
@@ -77,6 +91,7 @@ files:
 - lib/muzak/player.rb
 - lib/muzak/player/mpv.rb
 - lib/muzak/player/stub_player.rb
+- lib/muzak/player/vlc.rb
 - lib/muzak/playlist.rb
 - lib/muzak/plugin.rb
 - lib/muzak/plugin/stub_plugin.rb