dtas 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 469ec379619540656d9a2decafe6eea0a53d963c
-  data.tar.gz: 7893b222746613c3365c1ea7a2b98276708a1ad5
+  metadata.gz: 57d7fc892d1c758901d66f4fc6348ca9c3e069eb
+  data.tar.gz: 7241a23c3693df03bbeb014a52fea25639cf0f05
 SHA512:
-  metadata.gz: 762b5e63dadda1b2c6128103a7899b6d981f52b025ebeb967139d9a6253bca433fcd8b96a3d066eb73aebcc4362ba289d2a88fa882f8fdbaefd66a231ceef59d
-  data.tar.gz: 278c853d6f5bb6116bf8d9c6516c2a6412d72ce2036d77fe9d6abc19b088208af78b1027f5949b1625d8d6e846235a3477c28fa9c59ad94de28437ba20032962
+  metadata.gz: dbbdc46c30c791b495aa2c0381c3ad1638f5bc3f0bc8213ce1b917196d5b0103e422df7b60e3337166e460023780a36b3bc35225cec5fa596851dc463150b465
+  data.tar.gz: eed8758a7a8701ac38b68232972ae15260ea1b4fd69920218d23098500012897a232f0929e36899522e8f4b436690272e99dbf69d4e9007f41c790771dd885ac

data/.gitattributes

@@ -0,0 +1,4 @@
+*.gemspec diff=ruby
+*.rb diff=ruby
+Rakefile diff=ruby
+bin/* diff=ruby

data/Documentation/GNUmakefile

@@ -48,7 +48,7 @@ install-man: man
 	$(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
 	$(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
 %.1 %.7 : %.txt
-	$(pandoc) -s -t man < $< > $@+ && mv $@+ $@
+	$(pandoc) -s -t man < $< > $@
 
 clean::
 	$(RM) $(man1) $(man7)

data/Documentation/dtas-console.txt

@@ -33,6 +33,7 @@ Key bindings are inspired partially by mplayer(1)
 - 'f'/'F' - decrease/increase ReplayGain fallback_gain value
 - 'r'/'R' - cycle forward/backwards through ReplayGain modes
 - 'q'/Ctrl-C - exit dtas-console
+- 'o' - toggle display between HH:MM:SS and absolute seconds
 
 # ENVIRONMENT
 

data/Documentation/dtas-player_protocol.txt

@@ -20,9 +20,7 @@ This must stay over Unix sockets because filesystem permissions are
 needed to enforce code execution permissions.  dtas-player is really a
 shell in disguise, after all.
 
-Protocol feedback greatly appreciated email me at
-
-e@80x24.org
+Protocol feedback greatly appreciated email us at dtas-all@nongnu.org
 
 *********************************************************
 
@@ -166,6 +164,11 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
 * play_pause - toggle the play/pause state.  This starts playback if
   paused, and pauses playback if playing.
 
+* queue cat - dump the contents of the queue as YAML
+  This may include arbitrary commands to be executed, filenames,
+  and offsets for playback.  The format is not intended to be
+  stable and subject to internal changes in dtas-player.
+
 * restart - restarts all processes in the current pipeline.  Playback
   will be momentarily interrupted while this change occurs.  This is
   necessary if one of the commands (e.g. sox or ecasound) or loaded
@@ -258,19 +261,24 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
   currently playing track with the newly-added one.
   Returns the TRACKID of the newly added track
 
+* tl clear - clear current tracklist
+
 * tl current - display the pathname to the currently playing track
 
 * tl current-id - display the TRACKID of the currently playing track
 
 * tl remove TRACKID - remove the track with the given TRACKID from
-  the track list
+  the track list and returns the FILENAME if successful
 
 * tl get [TRACKIDS]
   returns a list of TRACKIDS mapped to shell-escaped filenames.
 
 * tl goto TRACKID [TIMESTAMP] - plays the given TRACKID
   An optional timestamp may be added to prevent playing the
-  same part(s) repeated.y
+  same part(s) repeatedly
+
+* tl max [MAXIMUM] - sets or gets the maximum number of tracks
+  allowed in the tracklist
 
 * tl next - jump to the next track in the tracklist
 
@@ -279,6 +287,12 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
 * tl repeat [BOOLEAN|1] - show/or change repeat status of the tracklist.
   With no args, this will show "true", "false", or "1"
   If set to "1", dtas-player will repeat the current track.
+  Returns the previous repeat status.
+
+* tl shuffle [BOOLEAN] - show/or change the current shuffle status of
+  the tracklist.  Returns the previous shuffle status.
+
+* tl swap TRACKID_A TRACKID_B - swaps the positions of two tracks.
 
 * tl tracks
   returns a list of all TRACKIDS in the tracklist

data/Documentation/dtas-splitfx.txt

@@ -51,6 +51,19 @@ to use ecasound(1), too.
 -b, \--bits BITS
 :    Override the output bit depth in the specified TARGET
 
+-t, \--trim POSITION
+:    Passes a POSITION argument to the sox "trim" effect to allow
+     limiting output to only process a portion of the original.
+     This bypasses the "tracks" section and of the YAML file and
+     outputs the result as a single file with the TRACKNUMBER
+     of "000".  For ease-of-typing, commas in this command-line
+     argument are automatically expanded to spaces when passed to sox.
+
+-p, \--sox-pipe
+:    Used in place of an output target to specify outputting audio data in
+     the native "sox" format to another sox(1) or play(1) command.  This
+     moves printing of output to stderr and disables parallel job invocation.
+
 # FILE FORMAT
 
 * infile - string, the pathname of the original audio file

data/Documentation/dtas-tl.txt

@@ -26,6 +26,8 @@ client).
 * cat - display a newline-delimited list of TRACK_ID=PATH output
   Note: this is shell-escaped, multibyte characters may not show up properly.
 * clear - remove all tracks from the tracklist
+* edit - spawn an editor to allow editing the tracklist as a text file
+  See EDITING for more information.
 * goto TRACKID [POS] - play TRACKID immediately, optionally seek to POS
 TRACKID may be looked up via cat, and POS should be a timestamp in
 HH:MM:SS.FRAC format.
@@ -57,8 +59,22 @@ to skip backwards in the tracklist
 
         $ dtas-tl prev
 
+# EDITING
+
+It is possible to edit the player tracklist from your favorite text
+editor.  Existing lines denoting tracks may be rearranged, deleted,
+copied or entirely new lines with path names (without a trailing "
+=TRACK_ID") may be added.
+
+Changes to the tracklist are sent to the player when the user exits the
+editor.  This functionality only works when there is one user editing
+the tracklist at a time, and when no files in the tracklist contain rare
+newline characters.
+
 # ENVIRONMENT
 
+VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset.
+
 DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
 This defaults to ~/.dtas/player.sock
 

data/GIT-VERSION-GEN

@@ -4,7 +4,7 @@
 CONSTANT = "DTAS::VERSION"
 RVF = "lib/dtas/version.rb"
 GVF = "GIT-VERSION-FILE"
-DEF_VER = "v0.11.0"
+DEF_VER = "v0.12.0"
 vn = DEF_VER
 
 # First see if there is a version file (included in release tarballs),

data/GNUmakefile

@@ -46,9 +46,9 @@ pkg_extra := GIT-VERSION-FILE lib/dtas/version.rb NEWS
 NEWS:
 	rake -s $@
 gem-man:
-	$(MAKE) -C Documentation/ gem-man
+	-$(MAKE) -C Documentation/ gem-man
 tgz-man:
-	$(MAKE) -C Documentation/ install-man mandir=$(CURDIR)/man
+	-$(MAKE) -C Documentation/ install-man mandir=$(CURDIR)/man
 .PHONY: tgz-man gem-man
 
 .gem-manifest: .manifest gem-man

data/INSTALL

@@ -40,10 +40,10 @@ For future upgrades of dtas (upgrades to dtas-linux will be infrequent)
 
 Grab the latest tarball from our HTTP site:
 
-    http://dtas.80x24.org/2015/dtas-0.10.0.tar.gz
+    http://dtas.80x24.org/2015/dtas-0.12.0.tar.gz
 
-    $ tar zxvf dtas-0.10.0.tar.gz
-    $ cd dtas-0.10.0
+    $ tar zxvf dtas-0.12.0.tar.gz
+    $ cd dtas-0.12.0
     $ sudo ruby setup.rb
 
 GNU/Linux users may optionally install "io_splice" and

data/README

@@ -51,6 +51,7 @@ Familiarity with the Ruby programming language is absolutely NOT required.
 
 Coming:
 
+* mpd (Music Player Daemon) bridge for partial dtas-player control
 * MPRIS/MPRIS 2.0 bridge for partial dtas-player control
 * whatever command-line tools come to mind...
 * better error handling, many bugfixes, etc...
@@ -78,6 +79,9 @@ HTML will not be read.  dtas is for GUI-phobes, by GUI-phobes.\
 Mailing list archives available at <ftp://lists.gnu.org/dtas-all>
 or <http://80x24.org/dtas-all/>
 No subscription is necessary to post to the mailing list.
+You may also read via:
+NNTP: <nntp://news.public-inbox.org/inbox.comp.audio.dtas>
+Atom: <http://80x24.org/dtas-all/new.atom>
 
 ## Copyright
 

data/bin/dtas-archive

@@ -27,10 +27,14 @@
 repeat = 1
 stats = false
 keep_going = false
+compression = []
 
 OptionParser.new('', 24, '  ') do |op|
   op.banner = usage
   op.on('-t', '--type [TYPE]', 'FILE-TYPE (default: flac)') { |t| type = t }
+  op.on('-C', '--compression [FACTOR]', 'compression factor for sox') { |c|
+    compression = [ '-C', c ]
+  }
   op.on('-j', '--jobs [JOBS]', Integer) { |j| jobs = j }
   op.on('-S', '--stats', 'save stats on the file') { stats = true }
   op.on('-k', '--keep-going', 'continue after error') { keep_going = true }
@@ -146,7 +150,7 @@
         end
       end
 
-      cmd = [ 'sox', input, output ]
+      cmd = [ 'sox', input, *compression, output ]
       if stats
         cmd << 'stats'
         cmd = [ *cmd, { err: stats_out } ]

data/bin/dtas-console

@@ -3,6 +3,7 @@
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 #
 # Note: no idea what I'm doing, especially w.r.t. curses
+require 'dtas'
 require 'dtas/unix_client'
 require 'dtas/rg_state'
 require 'dtas/sigevent'
@@ -13,6 +14,7 @@
   abort "please install the 'curses' RubyGem to use #$0"
 end
 
+tsec = false
 se = DTAS::Sigevent.new
 trap(:WINCH) { se.signal }
 w = DTAS::UNIXClient.new
@@ -29,8 +31,12 @@
   rg_mode_i = 0
 end
 
-def update_tfmt(prec)
-  prec == 0 ? '%H:%M:%S' : "%H:%M:%S.%#{prec}N"
+def update_tfmt(prec, tsec)
+  if tsec
+    prec == 0 ? '%_8s' : "%_8s.%#{prec}N"
+  else
+    prec == 0 ? '%H:%M:%S' : "%H:%M:%S.%#{prec}N"
+  end
 end
 trap(:INT) { exit(0) }
 trap(:TERM) { exit(0) }
@@ -39,7 +45,7 @@ def update_tfmt(prec)
 prec_nr = 1
 prec_step = (0..9).to_a
 prec_max = prec_step.size - 1
-tfmt = update_tfmt(prec_step[prec_nr])
+tfmt = update_tfmt(prec_step[prec_nr], tsec)
 events = []
 interval = 1.0 / 10 ** prec_nr
 
@@ -135,7 +141,7 @@ def may_fail(res, events)
         Curses.addstr(current['command'])
       end
 
-      elapsed = Time.now.to_f - current['spawn_at']
+      elapsed = DTAS.now - current['spawn_at']
       if (nr = cur['current_initial']) && (current_format = current['format'])
         rate = current_format['rate'].to_f
         elapsed += nr / rate
@@ -208,6 +214,7 @@ def may_fail(res, events)
         when "<" then c.req_ok("tl prev")
         when "!" then may_fail(c.req("cue prev"), events)
         when "@" then may_fail(c.req("cue next"), events)
+        when "o" then tfmt = update_tfmt(prec_step[prec_nr], tsec = !tsec)
         when " "
           c.req("play_pause")
         when "r" # cycle through replaygain modes
@@ -218,13 +225,13 @@ def may_fail(res, events)
         when "p" # lower precision of time display
           if prec_nr >= 1
             prec_nr -= 1
-            tfmt = update_tfmt(prec_step[prec_nr])
+            tfmt = update_tfmt(prec_step[prec_nr], tsec)
             interval = 1.0 / 10 ** prec_nr
           end
         when "P" # increase precision of time display
           if prec_nr < prec_max
             prec_nr += 1
-            tfmt = update_tfmt(prec_step[prec_nr])
+            tfmt = update_tfmt(prec_step[prec_nr], tsec)
             interval = 1.0 / 10 ** prec_nr
           end
         when 27 # TODO readline/edit mode?

data/bin/dtas-cueedit

@@ -44,7 +44,7 @@ def tmpfile(file, suffix)
     backup.write(original) if backup
 
     # user edits the file
-    x!("#{editor} #{tmp.path}")
+    x!("#{editor} #{xs(tmp.path)}")
 
     # avoid an expensive update if the user didn't change anything
     current = File.binread(tmp.path)

data/bin/dtas-mlib

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2015 all contributors <dtas-all@nongnu.org>
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+usage = "#$0 [-d DATABASE-URI] ACTION [ARGS]"
+Thread.abort_on_exception = $stderr.sync = $stdout.sync = true
+trap(:INT, 'SYSTEM_DEFAULT')
+trap(:PIPE, 'SYSTEM_DEFAULT')
+require 'dtas/mlib'
+require 'optparse'
+path = '~/.dtas/mlib.sqlite'
+db = File.expand_path(path)
+OptionParser.new('', 24, '  ') do |op|
+  op.banner = usage
+  op.on('-d', '--database <URI|PATH>', "database (default: #{path}") do |d|
+    db = d
+  end
+  op.on('-h', '--help') do
+    puts(op.to_s)
+    exit
+  end
+  op.parse!(ARGV)
+end
+
+unless db.include?('://')
+  dir = File.dirname(db)
+  unless File.directory?(dir)
+    require 'fileutils'
+    FileUtils.mkpath(dir)
+  end
+end
+
+def mlib(db, migrate = false)
+  m = DTAS::Mlib.new(db)
+  m.migrate if migrate
+  m
+end
+
+case action = ARGV.shift
+when 'update', 'up'
+  directory = ARGV.shift or abort "DIRECTORY required\n#{usage}"
+  mlib(db, migrate = true).update(directory)
+when 'dump' # mainly for debugging
+  directory = ARGV.shift || '/'
+  mlib(db).dump(directory)
+else
+  abort usage
+end

data/bin/dtas-readahead

@@ -0,0 +1,211 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2015 all contributors <dtas-all@nongnu.org>
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+#
+# Really janky readahead script.  Requires dtas-player to be
+# running and unlikely to work outside of Linux as it depends on
+# the contents of /proc
+unless RUBY_PLATFORM =~ /linux/
+  warn "this relies on Linux /proc and probably does not work well for you"
+end
+
+require 'yaml'
+require 'io/wait'
+require 'dtas/unix_client'
+require 'dtas/process'
+
+include DTAS::Process
+include DTAS::SpawnFix
+trap(:CHLD) { DTAS::Process.reaper {} }
+trap(:INT) { exit(0) }
+trap(:TERM) { exit(0) }
+w = DTAS::UNIXClient.new
+w.req_ok('watch')
+c = DTAS::UNIXClient.new
+@max_ra = 30 * 1024 * 1024
+null = DTAS.null
+@redir = { err: null, out: null, in: null }.freeze
+require 'pp'
+
+if RUBY_VERSION.to_r >= '2.3'.to_r
+  # Old Rubies did FIONREAD, which breaks on SOCK_SEQPACKET
+  def wait_read(w, timeout)
+    w.to_io.wait_readable(timeout)
+  end
+else
+  def wait_read(w, timeout)
+    r = IO.select([w], nil, nil, timeout)
+    r ? r[0] : nil
+  end
+end
+
+def seek_to_cur_pos(cur_pid, fp)
+  cur_fd = []
+  fpst = fp.stat
+  begin
+    Dir["/proc/#{cur_pid}/fd/*"].each do |l|
+      path = File.readlink(l)
+      begin
+        st = File.stat(path)
+        if st.dev == fpst.dev && st.ino == fpst.ino
+          cur_fd << l.split('/')[-1]
+        end
+      rescue Errno::ENOENT, Errno::EPERM
+      end
+    end
+  rescue Errno::ENOENT => e # race, process is dead
+    return false
+  rescue => e
+    warn "error reading FDs from for PID:#{cur_pid}: #{e.message}"
+  end
+  pos = 0
+  # get the position of the file of the sox process
+  cur_fd.each do |fd|
+    if File.read("/proc/#{cur_pid}/fdinfo/#{fd}") =~ /^pos:\s*(\d+)$/
+      n = $1.to_i
+      pos = n if n > pos
+    end
+  end
+  pos
+rescue Errno::ENOENT => e # race, process is dead
+  return false
+end
+
+def children_of(ppid)
+  `ps h -o pid --ppid=#{ppid}`.split(/\s+/s).map(&:to_i)
+end
+
+def expand_pid(pid)
+  to_scan = Array(pid)
+  pids = []
+  while pid = to_scan.shift
+    pid > 0 or next
+    to_scan.concat(children_of(pid))
+    pids << pid
+  end
+  pids.uniq
+end
+
+def do_ra(fp, pos, w)
+  size = fp.size
+  len = size - pos
+  len = @todo_ra if len > @todo_ra
+  return if len <= 0
+  path = fp.path
+  pp({start_ra: File.basename(path),
+      len: '%.3f' % (len / (1024 * 1024.0)),
+      pos: pos })
+  Process.spawn('soxi', path, @redir)
+  Process.spawn('avprobe', path, @redir)
+  Process.spawn('ffprobe', path, @redir)
+  fp.advise(:sequential, pos, len)
+  Thread.new(fp.dup) { |d| d.advise(:willneed, pos, len); d.close }
+
+  at_once = 8192
+  adj = len
+  while len > 0
+    n = len > at_once ? at_once : len
+    n = IO.copy_stream(fp, DTAS.null, n, pos)
+    pos += n
+    len -= n
+
+    # stop reading immediately if there's an event
+    if wait_read(w, 0)
+      adj = @todo_ra
+      pos += size
+      break
+    end
+  end
+  @todo_ra -= adj
+  (pos + len) >= size ? fp.close : nil
+end
+
+def do_open(path)
+  if path =~ /\.ya?ml\z/
+    File.open(path) do |fp|
+      buf = fp.read(4)
+      case buf
+      when "---\n"
+        buf << fp.read(fp.size - 4)
+        Dir.chdir(File.dirname(path)) do
+          yml = YAML.load(buf)
+          x = yml['infile'] and return File.open(File.expand_path(x).freeze)
+        end
+      end
+    end
+  end
+  File.open(path)
+end
+
+begin
+  work = {}
+  cur_pid = nil
+  @todo_ra = @max_ra
+  t0 = DTAS.now
+  fp = nil
+  cur = YAML.load(c.req('current'))
+  while @todo_ra > 0 && fp.nil?
+    if current = cur['current']
+      track = current['infile'].freeze
+      work[track] ||= fp = do_open(track)
+      cur_pid = current['pid']
+      if fp
+        pos = expand_pid(cur_pid).map do |pid|
+          seek_to_cur_pos(pid, fp)
+        end.compact.max
+        pos and fp = do_ra(fp, pos, w)
+      end
+    else
+      break
+    end
+
+    # queue has priority, work on it, first
+    queue = YAML.load(c.req('queue cat'))
+    while @todo_ra > 0 && track = queue.shift
+      fp = nil
+      begin
+        work[track] ||= fp = do_open(track)
+      rescue SystemCallError
+      end
+      fp = do_ra(fp, 0, w) if fp
+    end
+    break if @todo_ra <= 0
+
+    # the normal tracklist
+    ids = c.req('tl tracks').split
+    ids.shift # ignore count
+    idx = ids.find_index(c.req('tl current-id'))
+    repeat = c.req('tl repeat').split[-1]
+    while @todo_ra > 0 && idx && (cid = ids[idx])
+      fp = nil
+      track = c.req("tl get #{cid}").sub!(/\A1 \d+=/, '').freeze
+      begin
+        work[track] ||= fp = do_open(track)
+      rescue SystemCallError
+      end
+      fp = do_ra(fp, 0, w) if fp
+      if @todo_ra > 0 && fp.nil? && ids[idx += 1].nil?
+        idx = repeat == 'true' ? 0 : nil
+      end
+    end
+    idx or break
+    cur = YAML.load(c.req('current'))
+    current = cur['current'] or break
+  end
+  if current
+    elapsed = DTAS.now - t0
+    p [:elapsed, elapsed]
+    timeout = 5 - elapsed
+    timeout = 0 if timeout < 0
+  else
+    timeout = nil
+  end
+  r = wait_read(w, timeout)
+  p w.res_wait if r
+rescue EOFError
+  abort "dtas-player exited"
+rescue => e
+  warn "#{e.message} #{e.class})"
+  e.backtrace.each {|l| warn l }
+  sleep 5
+end while true