vlcraptor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6303432e0bfc5db3263ba6121fff94d9652dc0df2b00d427f06febeef2f8f27c
-  data.tar.gz: 2f6af90fb8a4a589f9e58d5bd7dc0bdbdb6fc7520051c4682ea9caa5183c71b3
+  metadata.gz: 18dde28c420aa7dc5fb8c6860d6e8d27d1ccc33bcb58373bc75183fee76f95f8
+  data.tar.gz: e16ae43b48b13443efc10d48a3abaa78cfc7f787161f4b6865d99f257e4372ce
 SHA512:
-  metadata.gz: 88c1e136354b579b937860753c4874f1af62bdf0bd0ebcf7f49e6cea0be96969c16c17423ddd228e745ac72a78936c08a4bc16cc724a973353d90edbab20cb98
-  data.tar.gz: 0e229b3e1db2d596661593d9a85866e5d234fc705b0d019ec468a8a174bb0ae3b1e6d47a19b46390f688e4583d0aa87cfb8fb4f5177ce0528b3c830ed279512c
+  metadata.gz: 1058cbc603c80fbc5b19d105fc590e0a4b0b05baab659cbdb07fe3a03d5c4e409f02a9bebc367e2c76d46bbae88cdf0f8fe534357069d7dcbfd9e69fe554ef42
+  data.tar.gz: e4a699a72240b67fbf66c92893e8b62641425c0faa39625bb4e7ce7ebfd9460308571d3a36994188adeab450723ca2d2ebf925fe7cc4294b801864a751b7e704

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    vlcraptor (0.1.0)
+    vlcraptor (0.3.0)
+      curses
       rainbow
       vlc-client
 
@@ -11,6 +12,7 @@ GEM
     ast (2.4.2)
     backport (1.2.0)
     benchmark (0.2.0)
+    curses (1.4.4)
     diff-lcs (1.5.0)
     e2mmap (0.1.0)
     jaro_winkler (1.5.4)

data/README.md

@@ -1,28 +1,65 @@
 # Vlcraptor
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/vlcraptor`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a queueing daemon for VLC - kind of like `mpd` but nowhere near as flexible or useful.
 
-TODO: Delete this and the text above, and describe your gem
+The player daemon starts two instances of VLC and then uses those to play any tracks placed in the queue.
 
-## Installation
+Why two VLC instances? VLC doesn't support cross fading between tracks so this crossfades by starting the
+other VLC instance playing the next track and adjusting volume between both.
 
-Add this line to your application's Gemfile:
+At the moment, only mac os is supported - minor changes would be required to allow this to work on linux.
 
-```ruby
-gem 'vlcraptor'
-```
+## Installation
 
-And then execute:
+You need to install VLC in the default location for mac os (`/Applications/VLC.app`).
 
-    $ bundle install
+`brew install ffmpeg` is required by the `queue` command for extracting tags to place in the queue.
 
-Or install it yourself as:
+`brew install terminal-notifier` is optional depending if you want terminal notifications when new tracks start.
 
-    $ gem install vlcraptor
+This gem can be installed with `gem install vlcraptor`.
 
 ## Usage
 
-TODO: Write usage instructions here
+Running `vlcraptor` without any parameters will list the available subcommands.
+
+### Player
+
+Run `vlcraptor player` in a shell session.
+
+This is the player daemon that controls two instances
+of VLC and is an ncurses application which will take over the display in that terminal.
+
+You can quit with 'q', pause with ' ', stop with 's', play (resume) with 'p' and skip with 'n'.
+
+### Adding tracks to the queue
+
+`vlcraptor queue folder_containing_audio_files audio_file.mp3` will place any number of audio files in the
+queue and the player should immediately start playing the first track.
+
+### Listing queue contents
+
+`vlcraptor list` will list currently queued tracks with an estimated start time if the player is currently
+running and playing a track.
+
+### Media controls
+
+`vlcraptor pause` will pause, `vlcraptor stop` will stop and `vlcraptor play` will resume.
+
+`vlcraptor skip` will fade out the current track and start the next one (unless the queue is empty). 
+
+### Optional features
+
+A number of features can be turned on/off while the player is running that will determine certain behaviour:
+
+`vlcraptor autoplay off` will cause the player to stop and politely wait after the current track has finished.
+`vlcraptor autoplay on` and tracks will start playing again.
+
+`vlcraptor crossfade off` will turn off crossfading so new tracks will start once the previous one is
+completely finished.
+
+`vlcraptor scrobble on` will turn on last.fm scrobbling - you will require your own application api key
+and secret to enable this.
 
 ## Development
 
@@ -32,4 +69,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vlcraptor.
+Bug reports and pull requests are welcome on GitHub at https://github.com/markryall/vlcraptor.

data/exe/vlcraptor

@@ -13,6 +13,8 @@ when "autoplay"
   Vlcraptor.autoplay(ARGV.shift)
 when "crossfade"
   Vlcraptor.crossfade(ARGV.shift)
+when "history"
+  Vlcraptor.history
 when "list"
   Vlcraptor.list
 when "pause"
@@ -33,6 +35,7 @@ else
   puts "Unknown command \"#{command}\":"
   puts "  autoplay on/off: continue playing tracks or stop at the end of current track"
   puts "  crossfade on/off: 5 second crossfade when changing tracks"
+  puts "  history: display play history"
   puts "  list: list current queue"
   puts "  pause: pause current track (resume with play)"
   puts "  play: resume after pause/stop"

data/lib/vlcraptor/notifiers.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require "rainbow"
-require_relative "console"
+require_relative "preferences"
 require_relative "scrobbler"
 
 module Vlcraptor
   class Notifiers
-    def initialize(preferences)
-      @preferences = preferences
-      @console = Vlcraptor::Console.new
+    def initialize
+      @preferences = Vlcraptor::Preferences.new
+      @history = "#{File.expand_path("~")}/.player_history"
     end
 
     def track_suspended
@@ -22,45 +22,34 @@ module Vlcraptor
       @preferences[:started] = track[:start_time].to_i
     end
 
-    def track_progress(track, remaining)
-      return unless track
-
-      rem = if remaining > 60
-              "#{remaining / 60} minutes and #{remaining % 60} seconds remaining"
-            else
-              "#{remaining} seconds remaining"
-            end
-      @console.change(
-        [
-          "        ",
-          display_time(Time.now + remaining),
-          remaining < 20 ? Rainbow(rem).tomato : rem,
-        ].join(" ")
-      )
-    end
-
     def track_started(track)
       return unless track
 
-      @preferences[:started] = Time.now.to_i
       track[:start_time] = Time.now
+      @preferences[:started] = track[:start_time].to_i
       scrobbler&.now_playing(track[:artist], track[:title])
       terminal_notify(
         message: "#{track[:title]} by #{track[:artist]}",
         title: "Now Playing",
       )
-      @console.replace(
-        [
-          display_time(Time.now),
-          display_time(Time.now + track[:length]),
-          Rainbow(track[:title]).green,
-          "by",
-          Rainbow(track[:artist]).yellow,
-          "from",
-          Rainbow(track[:album]).cyan,
-          "(#{track[:length] / 60}:#{track[:length] % 60})",
-        ].join(" ")
-      )
+
+      len = if track[:length] > 60
+              "(#{track[:length] / 60}m and #{track[:length] % 60}s)"
+            else
+              "(#{track[:length]}s)"
+            end
+
+      message = [
+        display_time(track[:start_time]),
+        Rainbow(track[:title]).green,
+        "by",
+        Rainbow(track[:artist]).yellow,
+        "from",
+        Rainbow(track[:album]).cyan,
+        len,
+      ].join(" ")
+
+      File.open(@history, "a") { |file| file.puts message }
     end
 
     def track_finished(track)

data/lib/vlcraptor/player_controller.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require_relative "player"
+require_relative "preferences"
+require_relative "queue"
+require_relative "notifiers"
+
+module Vlcraptor
+  class PlayerController
+    def initialize
+      @player = Vlcraptor::Player.new
+      @preferences = Vlcraptor::Preferences.new
+      @queue = Vlcraptor::Queue.new
+      @notifiers = Vlcraptor::Notifiers.new
+      @track = nil
+      @suspended = false
+    end
+
+    def next
+      return on_pause if @preferences.pause?
+      return on_stop if @preferences.stop?
+      return on_play if @preferences.play?
+      return when_suspended if @suspended
+      return when_playing if @player.playing?
+      return when_auto if @preferences.continue?
+
+      when_manual
+    end
+
+    def cleanup
+      @player.cleanup
+    end
+
+    private
+
+    def on_pause
+      @player.fadeout
+      @player.pause
+      @suspended = true
+      @status = "Now Paused"
+      @notifiers.track_suspended
+      when_suspended
+    end
+
+    def on_stop
+      @player.fadeout
+      @player.stop
+      @suspended = true
+      @status = "Now Stopped"
+      @notifiers.track_suspended
+      when_suspended
+    end
+
+    def on_play
+      @player.fadein
+      @suspended = false
+      @status = ""
+      @notifiers.track_resumed(@track, @player.time)
+      when_playing_track(@player.remaining)
+    end
+
+    def when_suspended
+      build
+    end
+
+    def when_playing
+      return on_skip if @preferences.skip?
+      return on_crossfade if @preferences.crossfade? && @player.remaining < 5
+
+      when_playing_track(@player.remaining)
+    end
+
+    def on_skip
+      @track = @queue.next
+      if @track
+        @notifiers.track_started(@track)
+        @player.crossfade(@track[:path])
+        when_playing_track(@player.remaining)
+      else
+        @player.fadeout
+        when_empty
+      end
+    end
+
+    def on_crossfade
+      @notifiers.track_finished(@track)
+      @track = @queue.next
+      if @track
+        @notifiers.track_started(@track)
+        @player.crossfade(@track[:path])
+        when_playing_track(@player.remaining)
+      else
+        @player.fadeout
+        when_empty
+      end
+    end
+
+    def when_auto
+      @notifiers.track_finished(@track)
+      @track = @queue.next
+      return when_empty unless @track
+
+      @notifiers.track_started(@track)
+      @player.play(@track[:path])
+      when_playing_track(@track[:length])
+    end
+
+    def when_playing_track(remaining)
+      @status = "Now Playing"
+      remaining_color = remaining < 30 ? 9 : 5
+      build(
+        [2, @track[:title]],
+        [0, "by"],
+        [11, @track[:artist]],
+        [0, "from"],
+        [6, @track[:album]],
+        [0, "(#{duration(@track[:length])})"],
+        [remaining_color, "#{duration(remaining)} remaining"],
+      )
+    end
+
+    def when_empty
+      @status = "Now Waiting"
+      build
+    end
+
+    def when_manual
+      @status = "Now Waiting"
+      build
+    end
+
+    def display_time(time)
+      time.strftime("%I:%M:%S")
+    end
+
+    def duration(seconds)
+      if seconds > 60
+        "#{seconds / 60}m and #{seconds % 60}s"
+      else
+        "#{seconds}s"
+      end
+    end
+
+    def build(*extra)
+      autoplay = @preferences[:autoplay] ? "+" : "-"
+      crossfade = @preferences[:crossfade] ? "+" : "-"
+      scrobble = @preferences[:scrobble] ? "+" : "-"
+      [
+        [0, display_time(Time.now)],
+        [0, @status],
+        [0, "#{Vlcraptor::Queue.length} items in queue"],
+        [8, "#{autoplay}autoplay #{crossfade}crossfade #{scrobble}scrobble"],
+      ] + extra
+    end
+  end
+end

data/lib/vlcraptor/queue.rb

@@ -12,7 +12,14 @@ module Vlcraptor
     def next
       `rm -f #{@current_path}` if @current_path
       @current_path = Dir["/tmp/queue/*.yml"].min
-      YAML.load_file(@current_path) if @current_path
+      return unless @current_path
+
+      result = YAML.load_file(@current_path)
+      File.exist?(result[:path]) ? result : self.next
+    end
+
+    def self.length
+      Dir["/tmp/queue/*.yml"].length
     end
 
     def self.each

data/lib/vlcraptor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vlcraptor
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/vlcraptor.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "curses"
 require "rainbow"
 require_relative "vlcraptor/player"
+require_relative "vlcraptor/player_controller"
 require_relative "vlcraptor/preferences"
 require_relative "vlcraptor/queue"
 require_relative "vlcraptor/notifiers"
@@ -15,6 +17,10 @@ module Vlcraptor
     Vlcraptor::Preferences.new[:crossfade] = value == "on"
   end
 
+  def self.history
+    system("cat #{File.expand_path("~")}/.player_history")
+  end
+
   def self.list
     started = Vlcraptor::Preferences.new[:started]
     offset = 0
@@ -42,83 +48,52 @@ module Vlcraptor
   end
 
   def self.player
-    player = Vlcraptor::Player.new
-    queue = Vlcraptor::Queue.new
-    preferences = Vlcraptor::Preferences.new
-    notifiers = Vlcraptor::Notifiers.new(preferences)
-    track = nil
-    suspended = false
+    Curses.init_screen
+    Curses.start_color
+    Curses.curs_set(0)
+    Curses.noecho
+
+    Curses.init_pair(0, 0, 0) # white
+    Curses.init_pair(2, 2, 0) # green
+    Curses.init_pair(5, 5, 0) # magenta
+    Curses.init_pair(6, 6, 0) # cyan
+    Curses.init_pair(8, 8, 0) # grey
+    Curses.init_pair(9, 9, 0) # orange
+    Curses.init_pair(11, 11, 0) # yellow
+
+    player_controller = Vlcraptor::PlayerController.new
+    window = Curses::Window.new(0, 0, 1, 2)
+    window.nodelay = true
 
     loop do
-      sleep 0.2
-
-      if preferences.pause?
-        player.fadeout
-        player.pause
-        suspended = true
-        notifiers.track_suspended
+      window.setpos(0, 0)
 
-        next
+      player_controller.next.each do |pair|
+        window.attron(Curses.color_pair(pair.first)) { window << pair.last }
+        Curses.clrtoeol
+        window << "\n"
       end
-
-      if preferences.stop?
-        player.fadeout
-        player.stop
-        suspended = true
-        notifiers.track_suspended
-
-        next
+      (window.maxy - window.cury).times { window.deleteln }
+      window.refresh
+
+      case window.getch.to_s
+      when " "
+        pause
+      when "n"
+        skip
+      when "p"
+        play
+      when "s"
+        stop
+      when "q"
+        break
       end
 
-      if preferences.play?
-        player.fadein
-        suspended = false
-        notifiers.track_resumed(track, player.time)
-
-        next
-      end
-
-      next if suspended
-
-      if player.playing?
-        if preferences.skip?
-          track = queue.next
-          if track
-            notifiers.track_started(track)
-            player.crossfade(track[:path])
-          else
-            player.fadeout
-          end
-          next
-        end
-
-        if preferences.crossfade? && player.remaining < 5
-          notifiers.track_finished(track)
-          track = queue.next
-          if track
-            notifiers.track_started(track)
-            player.crossfade(track[:path])
-          end
-        end
-
-        notifiers.track_progress(track, player.remaining)
-
-        next
-      end
-
-      next unless preferences.continue?
-
-      notifiers.track_finished(track)
-      track = queue.next
-      next unless track
-
-      notifiers.track_started(track)
-      player.play(track[:path])
+      sleep 0.1
     end
-  rescue Interrupt
-    notifiers.track_suspended
-    player.cleanup
-    puts "Exiting"
+  ensure
+    player_controller.cleanup
+    Curses.close_screen
   end
 
   def self.queue(paths)

data/vlcraptor.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "curses"
   spec.add_dependency "rainbow"
   spec.add_dependency "vlc-client"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vlcraptor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Ryall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -57,10 +71,10 @@ files:
 - bin/setup
 - exe/vlcraptor
 - lib/vlcraptor.rb
-- lib/vlcraptor/console.rb
 - lib/vlcraptor/ffmpeg.rb
 - lib/vlcraptor/notifiers.rb
 - lib/vlcraptor/player.rb
+- lib/vlcraptor/player_controller.rb
 - lib/vlcraptor/preferences.rb
 - lib/vlcraptor/queue.rb
 - lib/vlcraptor/scrobbler.rb

data/lib/vlcraptor/console.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Vlcraptor
-  class Console
-    LENGTH = 120
-
-    def initialize
-      @first = true
-    end
-
-    def change(line)
-      print "\b" * LENGTH unless @first
-      @first = false
-      print line[0...LENGTH].ljust LENGTH
-    end
-
-    def replace(line)
-      print "\b" * LENGTH unless @first
-      @first = true
-      puts line
-    end
-  end
-end