mpd_client 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4e6e63e19367101a4fe97e8cc2cec2c9670a2db
+  data.tar.gz: 885cada023e75ab8891ef8c092fdf86ffddefa8f
+SHA512:
+  metadata.gz: 2063ffee152d4698f8e8c593b113c50c7d41d4a57fc98ad145fc72a2485e19781a8f93f2c1ae5f4ac75a8d53e221ae472df200289e698ac44d1cf8c0dba153ae
+  data.tar.gz: 5b9cb922941282c395da464aebcb4149b3acdfbc920872680e83256c66c621897496dee28318e7a66111574af01ed31803bb722cf98eb49a4fdb3d389e645904

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# MPDClient CHANGELOG
+
+### 0.0.4
+
+* Added support for readcomments, toggleoutput, volume
+* Added a mutex protecting execution of MPD commands
+* Automatic reconnect after the server dropped the connection
+
+### 0.0.3
+
+* Support for logging
+* Better support for fetching stickers from MPD
+* Fixed sticker commands
+* Add support for ranges
+
+### 0.0.2
+
+* Support for connecting to unix domain sockets
+* Fixed some bugs
+
+### 0.0.1
+
+* Porting code from mpd-python2

data/MPD_COMMANDS.md

@@ -1,4 +1,15 @@
-### Status Commands
+* [Status Commands](#status-commands)
+* [Playback Option Commands](#playback-option-commands)
+* [Playback Control Commands](#playback-control-commands)
+* [Playlist Commands](#playlist-commands)
+* [Stored Playlist Commands](#stored-playlist-commands)
+* [Database Commands](#database-commands)
+* [Sticker Commands](#sticker-commands)
+* [Connection Commands](#connection-commands)
+* [Reflection Commands](#reflection-commands)
+* [Client to client](#client-to-client)
+
+### Status Commands ###
 
 ---
 `clearerror => fetch_nothing`
@@ -27,7 +38,7 @@
 * `subscription`: a client has subscribed or unsubscribed to a channel
 * `message`: a message was received on a channel this client is subscribed to; this event is only emitted when the queue is empty
 
-> While a client is waiting for `idle` results, the server disables timeouts, allowing a client to wait for events as long as mpd runs. The `idle` command can be canceled by sending the command `noidle` (no other commands are allowed). MPD will then leave `idle` mode and print results immediately; might be empty at this time. 
+> While a client is waiting for `idle` results, the server disables timeouts, allowing a client to wait for events as long as mpd runs. The `idle` command can be canceled by sending the command `noidle` (no other commands are allowed). MPD will then leave `idle` mode and print results immediately; might be empty at this time.
 
 > If the optional `SUBSYSTEMS` argument is used, MPD will only send notifications when something changed in one of the specified subsytems.
 
@@ -75,7 +86,7 @@
 * `db_update`: last db update in UNIX time
 * `playtime`: time length of music played
 
-### Playback Option Commands
+### Playback Option Commands ###
 
 ---
 `consume {STATE} => fetch_nothing`
@@ -90,7 +101,7 @@
 ---
 `mixrampdb {deciBels} => fetch_nothing`
 
-> Sets the threshold at which songs will be overlapped. Like crossfading but doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp tags crossfading will be used. See http://sourceforge.net/projects/mixramp 
+> Sets the threshold at which songs will be overlapped. Like crossfading but doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp tags crossfading will be used. See http://sourceforge.net/projects/mixramp
 
 ---
 `mixrampdelay {SECONDS} => fetch_nothing`
@@ -115,7 +126,7 @@
 ---
 `single {STATE} => fetch_nothing`
 
-> Sets single state to `STATE`, `STATE` should be 0 or 1. When single is activated, playback is stopped after current song, or song is repeated if the 'repeat' mode is enabled. 
+> Sets single state to `STATE`, `STATE` should be 0 or 1. When single is activated, playback is stopped after current song, or song is repeated if the 'repeat' mode is enabled.
 
 ---
 `replay_gain_mode {MODE} => fetch_nothing`
@@ -131,8 +142,12 @@
 
 > Prints replay gain options. Currently, only the variable `replay_gain_mode` is returned.
 
+---
+`volume {CHANGE} => fetch_nothing`
+
+> Changes volume by amount `CHANGE`.
 
-### Playback Control Commands
+### Playback Control Commands ###
 
 ---
 `next => fetch_nothing`
@@ -181,7 +196,7 @@
 > Stops playing.
 
 
-### Playlist Commands
+### Playlist Commands ###
 
 ---
 `add {URI} => fetch_nothing`
@@ -257,7 +272,7 @@
 ---
 `plchangesposid {VERSION} => fetch_changes`
 
-> Displays changed songs currently in the playlist since `VERSION`. This function only returns the position and the id of the changed song, not the complete metadata. This is more bandwidth efficient. 
+> Displays changed songs currently in the playlist since `VERSION`. This function only returns the position and the id of the changed song, not the complete metadata. This is more bandwidth efficient.
 
 > To detect songs that were deleted at the end of the playlist, use `playlistlength` returned by status command.
 
@@ -288,7 +303,7 @@
 
 Swaps the positions of `SONG1` and `SONG2` (both song ids).
 
-### Stored Playlist Commands
+### Stored Playlist Commands ###
 
 Playlists are stored inside the configured playlist directory. They are addressed with their file name (without the directory and without the .m3u suffix).
 
@@ -309,7 +324,7 @@ Some of the commands described in this section can be used to run playlist plugi
 
 > Prints a list of the playlist directory.
 
-> After each playlist name the server sends its last modification time as attribute "Last-Modified" in ISO 8601 format. To avoid problems due to clock differences between clients and the server, clients should not compare this value with their local clock. 
+> After each playlist name the server sends its last modification time as attribute "Last-Modified" in ISO 8601 format. To avoid problems due to clock differences between clients and the server, clients should not compare this value with their local clock.
 
 ---
 `load {NAME} [START:END] => fetch_nothing`
@@ -353,7 +368,7 @@ Some of the commands described in this section can be used to run playlist plugi
 
 > Saves the current playlist to `NAME.m3u` in the playlist directory.
 
-### Database Commands
+### Database Commands ###
 
 ---
 `count {TAG} {NEEDLE} => fetch_object`
@@ -363,7 +378,7 @@ Some of the commands described in this section can be used to run playlist plugi
 ---
 `find {TYPE} {WHAT} [...] => fetch_songs`
 
-> Finds songs in the db that are exactly `WHAT`. `TYPE` can be any tag supported by MPD, or one of the two special parameters — file to search by full path (relative to database root), and any to match against all available tags. `WHAT` is what to find. 
+> Finds songs in the db that are exactly `WHAT`. `TYPE` can be any tag supported by MPD, or one of the two special parameters — file to search by full path (relative to database root), and any to match against all available tags. `WHAT` is what to find.
 
 ---
 `findadd {TYPE} {WHAT} [...] => fetch_nothing`
@@ -431,9 +446,18 @@ Some of the commands described in this section can be used to run playlist plugi
 
 > Same as `update`, but also rescans unmodified files.
 
-### Sticker Commands
+---
+`readcomments [URI] => fetch_object`
+
+> Read "comments" (i.e. key-value pairs) from the file specified by `URI`. This `URI` can be a path relative to the music directory or a URL in the form `file:///foo/bar.ogg`.
+
+> The response consists of lines in the form "KEY: VALUE". Comments with suspicious characters (e.g. newlines) are ignored silently.
 
-"Stickers" are pieces of information attached to existing MPD objects (e.g. song files, directories, albums). Clients can create arbitrary name/value pairs. MPD itself does not assume any special meaning in them. 
+> The meaning of these depends on the codec, and not all decoder plugins support it.  For example, on Ogg files, this lists the Vorbis comments.
+
+### Sticker Commands ###
+
+"Stickers" are pieces of information attached to existing MPD objects (e.g. song files, directories, albums). Clients can create arbitrary name/value pairs. MPD itself does not assume any special meaning in them.
 
 The goal is to allow clients to share additional (possibly dynamic) information about songs, which is neither stored on the client (not available to other clients), nor stored in the song files (MPD has no write access).
 
@@ -466,7 +490,7 @@ Objects which may have stickers are addressed by their object type ("song" for s
 
 > Searches the sticker database for stickers with the specified name, below the specified directory (`URI`). For each matching song, it prints the URI and that one sticker's value.
 
-### Connection Commands
+### Connection Commands ###
 
 ---
 `close`
@@ -505,7 +529,13 @@ Objects which may have stickers are addressed by their object type ("song" for s
 
 > Shows information about all outputs.
 
-### Reflection Commands
+---
+`toggleoutput {ID} => fetch_nothing`
+
+> Turns an output on or off, depending on the current state.
+
+
+### Reflection Commands ###
 
 ---
 `config => fetch_item`
@@ -544,11 +574,11 @@ Objects which may have stickers are addressed by their object type ("song" for s
 
 > Print a list of decoder plugins, followed by their supported suffixes and MIME types.
 
-### Client to client
+### Client to client ###
 
-Clients can communicate with each others over "channels". A channel is created by a client subscribing to it. More than one client can be subscribed to a channel at a time; all of them will receive the messages which get sent to it. 
+Clients can communicate with each others over "channels". A channel is created by a client subscribing to it. More than one client can be subscribed to a channel at a time; all of them will receive the messages which get sent to it.
 
-Each time a client subscribes or unsubscribes, the global idle event subscription is generated. In conjunction with the channels command, this may be used to auto-detect clients providing additional services. 
+Each time a client subscribes or unsubscribes, the global idle event subscription is generated. In conjunction with the channels command, this may be used to auto-detect clients providing additional services.
 
 New messages are indicated by the message idle event.
 

data/README.md

@@ -110,6 +110,8 @@ For more information about logging configuration, see http://www.ruby-doc.org/st
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## License
+## License and Author
+
+Copyright (c) 2013 by Anton Maminov
 
 This library is distributed under the MIT license.  Please see the LICENSE file.

data/lib/mpd_client.rb

@@ -31,6 +31,7 @@ COMMANDS = {
   "single"             => "fetch_nothing",
   "replay_gain_mode"   => "fetch_nothing",
   "replay_gain_status" => "fetch_item",
+  "volume"             => "fetch_nothing",
   # Playback Control Commands
   "next"               => "fetch_nothing",
   "pause"              => "fetch_nothing",
@@ -86,6 +87,7 @@ COMMANDS = {
   "searchaddp1"        => "fetch_nothing",
   "update"             => "fetch_item",
   "rescan"             => "fetch_item",
+  "readcomments"       => "fetch_item",
   # Sticker Commands
   "sticker get"        => "fetch_sticker",
   "sticker set"        => "fetch_nothing",
@@ -101,6 +103,7 @@ COMMANDS = {
   "disableoutput"      => "fetch_nothing",
   "enableoutput"       => "fetch_nothing",
   "outputs"            => "fetch_outputs",
+  "toggleoutput"       => "fetch_nothing",
   # Reflection Commands
   "config"             => "fetch_item",
   "commands"           => "fetch_list",
@@ -151,22 +154,29 @@ class MPDClient
   end
 
   def initialize
+    @mutex = Mutex.new
     reset
   end
 
   def connect(host = 'localhost', port = 6600)
-    log.info("MPD connect #{host}, #{port}") if log
-    if host.start_with?('/')
-      @socket = UNIXSocket.new(host)
+    @host = host
+    @port = port
+    reconnect
+  end
+
+  def reconnect
+    log.info("MPD (re)connect #{host}, #{port}") if log
+    if @host.start_with?('/')
+      @socket = UNIXSocket.new(@host)
       hello
     else
-      @socket = TCPSocket.new(host, port)
+      @socket = TCPSocket.new(@host, @port)
       hello
     end
   end
 
   def disconnect
-    log.info("MPD disconnect")
+    log.info("MPD disconnect") if log
     @socket.close
     reset
   end
@@ -181,7 +191,7 @@ class MPDClient
   def command_list_end
     raise "Not in command list" if @command_list.nil?
     write_command('command_list_end')
-    
+
     return fetch_command_list
   end
 
@@ -200,17 +210,24 @@ class MPDClient
   private
 
   def execute(command, *args, retval)
-    if !@command_list.nil?
-      write_command(command, *args)
-      @command_list << retval
-    else
-      write_command(command, *args)
-      eval retval
+    @mutex.synchronize do
+      if !@command_list.nil?
+        write_command(command, *args)
+        @command_list << retval
+      else
+        write_command(command, *args)
+        eval retval
+      end
     end
   end
 
   def write_line(line)
-    @socket.puts line
+    begin
+      @socket.puts line
+    rescue Errno::EPIPE
+      reconnect
+      @socket.puts line
+    end
     @socket.flush
   end
 
@@ -319,19 +336,19 @@ class MPDClient
   end
 
   def fetch_changes; fetch_objects(['cpos']); end
-  
+
   def fetch_songs; fetch_objects(['file']); end
 
   def fetch_messages; fetch_objects('channel'); end
 
   def fetch_outputs; fetch_objects(['outputid']); end
-  
+
   def fetch_plugins; fetch_objects(['plugin']); end
 
   def fetch_database; fetch_objects(['file', 'directory', 'playlist']); end
-  
+
   def fetch_playlists; fetch_objects(['playlist']); end
-  
+
   def fetch_playlist
     result = []
     read_pairs(':').each do |key, value|
@@ -363,7 +380,7 @@ class MPDClient
     ensure
       @command_list = nil
     end
-  
+
     return result
   end
 

data/lib/mpd_client/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class MPDClient
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpd_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Anton Maminov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-19 00:00:00.000000000 Z
+date: 2014-12-06 00:00:00.000000000 Z
 dependencies: []
 description: Yet another Ruby MPD client library
 email:
@@ -18,7 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - MPD_COMMANDS.md
@@ -33,26 +33,25 @@ files:
 - mpd_client.gemspec
 homepage: https://github.com/mamantoha/mpd_client
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Music Player Daemon library written entirely in Ruby
 test_files: []