muzak 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554e40f18c30b64f0e2c9be0ee3ee6227b7449a3
-  data.tar.gz: feaadbe0d3ceb603cb7d8013d9ca2faad3e703a0
+  metadata.gz: 5d627d0c95c41896f1c8acb0b47403f240924571
+  data.tar.gz: 11f8e33ea6d45befe35fdffcc20b1cba87a05b7a
 SHA512:
-  metadata.gz: 3fcce8ffa18023a30c59f79e8ea5795972378af99b4d69df3969de23922773c37634bffd0bebe05d3da6eedfef7cb734fdb224fe927a8c9642139e590663d8d2
-  data.tar.gz: 2d940d322ec8116e4873da8d24d9318c61a2397fec5639ff8e2526a52d0a4dd0f1e1dcfefc5c4dd2467b0b7abdf4620e3df969678595cec232b417764176ea46
+  metadata.gz: e6581bb5f6a785076619b44596f09ab3835a47be33e23e0e0bd1b1b032caee4ceefde24144abbc23c0e09d4158abc86ee7e33fbb04a09e1c3d91b336aded6ded
+  data.tar.gz: 6c46c4694d1cfbb67e2e9cbfdbd2eb02899747cef65d10a195efd8daccb27dcc0b39a737108923e11d8470b73bb7f4b59761755936a6095d095b93a263151ec2

data/CONFIGURATION.md

@@ -76,6 +76,16 @@ These are the configuration keys observed by muzak's "core," particularly
 
 In no particular order:
 
+### `event`
+
+*Optional.*
+
+*Default:* `true`
+
+If `event: false` is set in the configuration file, then muzak will not
+attempt to propagate events to plugins. This might be useful for debugging
+or when using multiple players at once via {Muzak::Player::MultiPlayer}.
+
 ### `debug`
 
 *Optional.*
@@ -131,6 +141,34 @@ set, then `mpv` will be instructed to disable all video output entirely.
 This option is primarily useful in conjunction with plugins that provide
 album art display, or for making Muzak entirely non-graphical.
 
+### `multiplayer-players`
+
+*Mandatory if using `multiplayer`.*
+
+*No default.*
+
+If the `player` key is set to `multiplayer`, then this should be set to the
+array of players to use together. For example,
+`multiplayer-players: [mpv, mpd]`.
+
+### `mpd-host`
+
+*Optional.*
+
+*Default:* `localhost`
+
+If `mpd-host` is set *and* the `mpd` player is used, then `mpd` will use this
+value as the MPD host to connect to.
+
+### `mpd-port`
+
+*Optional.*
+
+*Default:* `6600`
+
+If `mpd-port` is set *and* the `mpd` player is used, then `mpd` will use this
+value as the MPD port to connect to.
+
 ### `jukebox-size`
 
 *Mandatory.*

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.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

data/lib/muzak/config.rb

@@ -57,6 +57,7 @@ module Muzak
     # The default configuration keys and values.
     DEFAULT_CONFIG = {
       # core defaults
+      "events" => true,
       "debug" => false,
       "verbose" => true,
       "music" => File.expand_path("~/music"),

data/lib/muzak/index.rb

@@ -38,6 +38,7 @@ module Muzak
     def reload!
       debug "reloading index from '#{file}'..."
       @hash = Marshal.load(File.read file)
+      @albums_hash = nil
       memoize_collections!
     end
 
@@ -53,7 +54,7 @@ module Muzak
 
     # @return [Array<String>] a list of all artists in the index
     def artists
-      @artists ||= @hash["artists"].keys
+      @hash["artists"].keys
     end
 
     # @return [Hash{String => Album}] a hash of all album names with their

data/lib/muzak/instance.rb

@@ -61,6 +61,8 @@ module Muzak
     # @return [void]
     # @note {Config::PLUGIN_EVENTS} contains all valid events.
     def event(type, *args)
+      # don't propagate events if disabled by the user
+      return unless Config.events
       return unless Config::PLUGIN_EVENTS.include?(type)
 
       plugins.each do |plugin|

data/lib/muzak/player/mpd.rb

@@ -0,0 +1,153 @@
+require "ruby-mpd"
+
+module Muzak
+  module Player
+    # Exposes a MPD connection to muzak for playback control.
+    class MPD < StubPlayer
+      def running?
+        !!@mpd&.connected?
+      end
+
+      # Activates the MPD connection.
+      # @return [void]
+      def activate!
+        return if running?
+
+        debug "activating #{self.class}"
+
+        host = Config.mpd_host || "localhost"
+        port = Config.mpd_port || 6600
+
+        @mpd = ::MPD.new host, port
+        @mpd.connect
+        @mpd.clear
+
+        instance.event :player_activated
+      end
+
+      # Deactivates the MPD connection.
+      # @return [void]
+      def deactivate!
+        @mpd.clear
+        sleep 0.1 # give mpd a little bit of time to process
+        @mpd.disconnect
+
+        debug "deactivating #{self.class}"
+
+        instance.event :player_deactivated
+      end
+
+      # Tell MPD to begin playback.
+      # @return [void]
+      # @note Does nothing is playback is already in progress.
+      def play
+        @mpd.play
+      end
+
+      # Tell MPD to pause playback.
+      # @return [void]
+      # @note Does nothing is playback is already paused.
+      def pause
+        @mpd.pause
+      end
+
+      # @return [Boolean] whether or not MPD is currently playing.
+      def playing?
+        return false unless running?
+
+        @mpd.playing?
+      end
+
+      # Tell MPD to play the next song in its queue.
+      # @return [void]
+      # @note Does nothing if the current song is the last.
+      def next_song
+        @mpd.next
+      end
+
+      # Tell MPD to play the previous song in its queue.
+      # @return [void]
+      # @note Restarts the song if the current song is the first.
+      def previous_song
+        @mpd.previous
+      end
+
+      # Tell MPD to add the given song to its queue.
+      # @param song [Song] the song to add
+      # @return [void]
+      # @note Activates MPD if not already activated.
+      def enqueue_song(song)
+        activate! unless running?
+
+        load_song song
+      end
+
+      # Tell MPD to add the given album to its queue.
+      # @param album [Album] the album to add
+      # @return [void]
+      # @note Activates MPD if not already activated.
+      def enqueue_album(album)
+        activate! unless running?
+
+        album.songs.each do |song|
+          load_song song
+        end
+      end
+
+      # Tell MPD to add the given playlist to its queue.
+      # @param playlist [Playlist] the playlist to add
+      # @return [void]
+      # @note Activates MPD if not already activated.
+      def enqueue_playlist(playlist)
+        activate! unless running?
+
+        playlist.songs.each do |song|
+          load_song song
+        end
+      end
+
+      # Get MPD's internal queue.
+      # @return [Array<Song>] all songs in MPD's queue
+      # @note This includes songs already played.
+      # @todo Implement this.
+      def list_queue
+        debug @mpd.playlist.to_s
+        danger "this player doesn't support list_queue"
+        []
+      end
+
+      # Shuffle MPD's internal queue.
+      # @return [void]
+      # @todo Implement this.
+      def shuffle
+        danger "this player doesn't support shuffling (?)"
+      end
+
+      # Clear MPD's internal queue.
+      # @return [void]
+      def clear_queue
+        return unless running?
+        @mpd.clear
+      end
+
+      # Get MPD's currently loaded song.
+      # @return [Song, nil] the currently loaded song
+      def now_playing
+        return unless playing?
+
+        path = "#{Config.music}/#{@mpd.current_song.file}"
+        Song.new(path)
+      end
+
+      # Load a song into MPD.
+      # @param song [Song] the song to load
+      # @return [void]
+      # @api private
+      def load_song(song)
+        path = song.path.sub("#{Config.music}/", "")
+        @mpd.add(path)
+        @mpd.play if Config.autoplay
+      end
+    end
+  end
+end

data/lib/muzak/player/mpv.rb

@@ -166,8 +166,7 @@ module Muzak
       # @return [void]
       def clear_queue
         return unless running?
-
-        @mpv.command "playlist-clear"
+        @mpv.command "stop"
       end
 
       # Get mpv's currently loaded song.

data/lib/muzak/player/multiplayer.rb

@@ -0,0 +1,141 @@
+module Muzak
+  module Player
+    # Wraps multiple players into a single class.
+    # This can be useful for controlling a local and remote player
+    # simultaneously, e.g. one {MPD} and one {MPV} via the same Muzak instance.
+    class MultiPlayer < StubPlayer
+      # @return [Array<StubPlayer>] the players associated with this multiplayer
+      attr_reader :players
+
+      # @return [Boolean] whether or not all of the players are available
+      def self.available?
+        klasses = Config.multiplayer_players.map { |p| Player::PLAYER_MAP[p] }
+        klasses.all?(&:available?)
+      end
+
+      # @param instance [Instance] the instance associated with the player
+      def initialize(instance)
+        super(instance)
+
+        klasses = Config.multiplayer_players.map { |p| Player::PLAYER_MAP[p] }
+        @players = klasses.map { |pk| pk.new(instance) }
+      end
+
+      # @return [Boolean] whether or not any of the players are currently running.
+      def running?
+        @players.any?(&:running?)
+      end
+
+      # Activates each player under the multiplayer.
+      # @return [void]
+      def activate!
+        debug "activating #{self.class}"
+        @players.each(&:activate!)
+      end
+
+      # Deactivates each player under the multiplayer.
+      # @return [void]
+      def deactivate!
+        debug "deactivating #{self.class}"
+        @players.each(&:deactivate!)
+      end
+
+      # Tell all players to begin playback.
+      # @return [void]
+      # @note Does nothing is playback is already in progress.
+      def play
+        return unless running?
+        @players.each(&:play)
+      end
+
+      # Tell all players to pause playback.
+      # @return [void]
+      # @note Does nothing is playback is already paused.
+      def pause
+        return unless running?
+        @players.each(&:pause)
+      end
+
+      # @return [Boolean] Whether or not any of the players are currently playing.
+      def playing?
+        return false unless running?
+        @players.any?(&:playing?)
+      end
+
+      # Tell all players to play the next song in its queue.
+      # @return [void]
+      # @note Does nothing if the current song is the last.
+      def next_song
+        @players.each(&:next_song)
+      end
+
+      # Tell all players to play the previous song in its queue.
+      # @return [void]
+      # @note Does nothing if the current song is the first.
+      def previous_song
+        @players.each(&:previous_song)
+      end
+
+      # Tell all players to add the given song to its queue.
+      # @param song [Song] the song to add
+      # @return [void]
+      # @note Activates all players if not already activated.
+      def enqueue_song(song)
+        activate! unless running?
+        @players.each { |p| p.enqueue_song(song) }
+      end
+
+      # Tell all players to add the given album to its queue.
+      # @param album [Album] the album to add
+      # @return [void]
+      # @note Activates all players if not already activated.
+      def enqueue_album(album)
+        activate! unless running?
+        @players.each { |p| p.enqueue_album(album) }
+      end
+
+      # Tell all players to add the given playlist to its queue.
+      # @param playlist [Playlist] the playlist to add
+      # @return [void]
+      # @note Activates all players if not already activated.
+      def enqueue_playlist(playlist)
+        activate! unless running?
+        @players.each { |p| p.enqueue_playlist(playlist) }
+      end
+
+      # Get the internal queue of the first player.
+      # @return [Array<Song>] all songs in all players's queue
+      # @note This includes songs already played.
+      def list_queue
+        @players.first.list_queue
+      end
+
+      # Shuffle the internal queue.
+      # @return [void]
+      def shuffle_queue
+        return unless running?
+        # XXX: shuffling is currently done internally within each player,
+        # meaning that shuffling within multiplayer would leave each
+        # player in an inconsistent queue state.
+        # the solution to this is probably to list the queue, shuffle that
+        # list, clear the player's queue, and then load the single shuffled
+        # list back into each player.
+        danger "shuffling doesn't currently make any sense in multiplayer!"
+      end
+
+      # Clears the internal queue.
+      # @return [void]
+      def clear_queue
+        return unless running?
+        @players.each(&:clear_queue)
+      end
+
+      # Get the currently loaded song.
+      # @return [Song, nil] the currently loaded song
+      def now_playing
+        @players[1].now_playing
+        @players.first.now_playing
+      end
+    end
+  end
+end

data/lib/muzak/player/vlc.rb

@@ -46,7 +46,6 @@ module Muzak
         @vlc.play
       end
 
-
       # Tell VLC to pause playback.
       # @return [void]
       # @note Does nothing is playback is already paused.
@@ -130,6 +129,7 @@ module Muzak
       # Clear VLC's internal queue.
       # @return [void]
       def clear_queue
+        return unless running?
         @vlc.clear
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muzak
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: ruby-mpd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
 description: A library for controlling playlists and media players.
 email: william@tuffbizz.com
 executables:
@@ -105,7 +119,9 @@ files:
 - lib/muzak/index.rb
 - lib/muzak/instance.rb
 - lib/muzak/player.rb
+- lib/muzak/player/mpd.rb
 - lib/muzak/player/mpv.rb
+- lib/muzak/player/multiplayer.rb
 - lib/muzak/player/stub_player.rb
 - lib/muzak/player/vlc.rb
 - lib/muzak/playlist.rb
@@ -133,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: muzak - A metamusic player.