dhun 0.5.0 → 0.5.1

data/README.md

@@ -1,4 +1,4 @@
-# Introduction
+## Introduction
 
 > A dhun (Hindi: धुन; literally "tune") is a light instrumental piece in the
 > Hindustani classical music of North India.
@@ -9,24 +9,99 @@ Dhun is a minimalist commandline music player for OS X.
 
 It uses Spotlight to search for audio files on your computer and play them.
 
-# Features
+## Quickstart
 
-### Sneak Peek
+### Installing Dhun
 
-    deepak@vyombook ~/code/personal/dhun (master) $ ./dhun Spirit
-    Querying for kMDItemContentTypeTree == 'public.audio' && kMDItemAlbum == '*Spirit*'wc
-    /Users/deepak/Dropbox/shared/music/Coke Studio/Mai-Ne.mp3
-    /Users/deepak/Dropbox/shared/music/Coke Studio/Saari-Raat.mp3
-    /Users/deepak/Dropbox/shared/music/Coke Studio/Bulleya.mp3
-    /Users/deepak/Dropbox/shared/music/Coke Studio/Mahi-Ve.mp3
+Run the following commands to install Dhun. This will download the latest gem
+from [http://gemcutter.org](http://gemcutter.org), compile the extensions and
+put the binaries in the right place.
+
+    $ gem sources -a http://gemcutter.org
+    $ gem install dhun
+
+### Starting Dhun
+
+    $ dhun start
+    Starting Dhun
+
+Currently it runs in the foreground and displays a lot of random output. There
+are plans to daemonize the service once the codebase has stabilized a bit, and
+I have implemented some logging capabilities.
+
+### Playing Files
+
+Dhun uses Spotlight to query for music files. Just specify a keyword, and Dhun
+will look for files matching that keyword and start playing them
+
+    $ dhun play
+    9 files queued for playing
+    /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/01 40 Day Dream.mp3
+    /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/02 Janglin.mp3
+    /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/03 Carries On.mp3
+    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/01 - 40 Day Dream.mp3
+    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/02 - Janglin.mp3
+    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/03 - Carries On.mp3
+    /Users/deepak/Dropbox/shared/music/Here Comes/02 - Janglin.mp3
+    /Users/deepak/Dropbox/shared/music/Here Comes/01 - 40 Day Dream.mp3
+    /Users/deepak/Dropbox/shared/music/Here Comes/03 - Carries On.mp3
+
+More advanced querying support is coming soon.
+
+### Controlling Playback
+
+Pausing playback.
+
+    $ dhun pause
+    Dhun is paused. Next track is /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/02 Janglin.mp3
+
+Resuming playback
+
+    $ dhun resume
+    Dhun is playing. Next track is /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/02 Janglin.mp3
+
+Skipping to next file
+
+    $ dhun next
+    Dhun is playing /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/03 Carries On.mp3
+
+Status
+
+    $ dhun status
+    Dhun is running
+    Now playing /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/03 Carries On.mp3
+    /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/02 Janglin.mp3
+    /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/03 Carries On.mp3
+    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/01 - 40 Day Dream.mp3
+    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/02 - Janglin.mp3
+    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/03 - Carries On.mp3
+    /Users/deepak/Dropbox/shared/music/Here Comes/02 - Janglin.mp3
+    /Users/deepak/Dropbox/shared/music/Here Comes/01 - 40 Day Dream.mp3
+    /Users/deepak/Dropbox/shared/music/Here Comes/03 - Carries On.mp3
+
+Enqueuing more files. Note that `dhun play` will empty the current queue
+before adding new files.
+
+    $ dhun enqueue chup
+    1 files queued for playing.
     /Users/deepak/Dropbox/shared/music/Coke Studio/Chup.mp3
-    5 results total
-    Now Playing /Users/deepak/Dropbox/shared/music/Coke Studio/Mai-Ne.mp3
 
-Here is what is planned.
+### Stopping Dhun
+
+    $ dhun stop
+
+## Coming Soon
+
+These features are planned in the next few releases
 
-* Client server model, where you can issue commands to the server like
-  `dhun play Spirit`, `dhun pause`, `dhun next`, `dhun prev` and `dhun stop`
+* Option to run Dhun server as a daemon
+* Logging
+* Playing previous song, using something like `dhun prev`
+* Skipping ahead by more than one file, like `dhun next 2` or `dhun prev 2`
+* Advanced querying support with filters, like `dhun play "artist:Rahman"`
 
-* Flexible query syntax (like `artist:Rahman` or `album spirit`)
+And someday..
 
+* iTunes integration
+* Ability to pause and play in the middle of music files.
+* Displaying IDv3 information instead of just file names

data/TODO.md

@@ -1,5 +1,3 @@
-* Gem files
-
 TODO
 ====
 

data/dhun.gemspec

@@ -0,0 +1,41 @@
+Gem::Specification.new do |s|
+  s.name = 'dhun'
+  s.version = '0.5.1'
+  s.summary = "Minimalist music for OS X"
+  s.date = '2009-12-08'
+  s.email = 'deepak.jois@gmail.com'
+  s.homepage = 'http://github.com/deepakjois/dhun'
+  s.has_rdoc = false
+  s.authors = ["Deepak Jois"]
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE.txt
+    README.md
+    Rakefile
+    TODO.md
+    bin/dhun
+    dhun.gemspec
+    ext/Makefile
+    ext/dhun.h
+    ext/dhun_ext.c
+    ext/extconf.rb
+    ext/player.c
+    ext/query.c
+    lib/dhun.rb
+    lib/dhun/command.rb
+    lib/dhun/controller.rb
+    lib/dhun/dhun_client.rb
+    lib/dhun/dhun_server.rb
+    lib/dhun/handler.rb
+    lib/dhun/player.rb
+    lib/dhun/query.rb
+    lib/dhun/result.rb
+    lib/dhun/runner.rb
+    lib/dhun/server.rb
+  ]
+  # = MANIFEST =
+  s.extensions = ["ext/extconf.rb"]
+  s.executables = ["dhun"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = 'dhun'
+end

data/lib/dhun.rb

@@ -1,5 +1,5 @@
 module Dhun
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
   
   autoload :Runner, 'dhun/runner'
   autoload :Controller, 'dhun/controller'

data/lib/dhun/handler.rb

@@ -57,7 +57,7 @@ module Dhun
     def next(*args)
       @player = Player.instance
       next_track = @player.next
-      result = Result.new :success, (next_track || "No More Tracks")
+      result = Result.new :success, ("Dhun is playing #{next_track}" || "No More Tracks")
       return result.to_json
     end
 
@@ -73,7 +73,7 @@ module Dhun
       @player = Player.instance
       track = @player.queue.first
       @player.play
-      result = Result.new :success,  (track ? "Dhun is playing. Next track is #{track}" : "No more tracks in queue.")
+      result = Result.new :success,  (track ? "Dhun is playing #{track}" : "No more tracks in queue.")
       return result.to_json
     end
   end

data/lib/dhun/runner.rb

@@ -46,6 +46,8 @@ Usage:
    dhun enqueue rahman
    dhun status
    dhun stop
+   
+   For more details see README at http://github.com/deepakjois/dhun
 EOF
         opts.separator ""
         opts.separator "Options:"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dhun
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Deepak Jois
@@ -27,6 +27,7 @@ files:
 - Rakefile
 - TODO.md
 - bin/dhun
+- dhun.gemspec
 - ext/Makefile
 - ext/dhun.h
 - ext/dhun_ext.c
@@ -71,6 +72,6 @@ rubyforge_project: dhun
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Minimalist MP3 Player for OS X
+summary: Minimalist music for OS X
 test_files: []