dtas 0.9.0 → 0.10.0

data/lib/dtas/player/client_handler.rb

@@ -1,8 +1,12 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../xs'
+require_relative '../parse_time'
+
+# client protocol handling for -player
 module DTAS::Player::ClientHandler # :nodoc:
   include DTAS::XS
+  include DTAS::ParseTime
 
   # returns true on success, wait_ctl arg on error
   def set_bool(io, kv, v)
@@ -69,7 +73,7 @@ module DTAS::Player::ClientHandler # :nodoc:
 
   def __sink_activate(sink)
     return if sink.pid
-    @targets.concat(sink.spawn(@format))
+    @targets.concat(sink.sink_spawn(@format))
     @targets.sort_by! { |t| t.sink.prio }
   end
 
@@ -150,7 +154,7 @@ module DTAS::Player::ClientHandler # :nodoc:
           rv = set_bool(io, kv, v) { |b| sink.__send__("#{k}=", b) }
           rv == true or return rv
         when "pipe_size"
-          rv = set_uint(io, kv, v, false) { |u| sink.pipe_size = u }
+          rv = set_uint(io, kv, v, true) { |u| sink.pipe_size = u }
           rv == true or return rv
         when "command" # nothing to validate, this could be "rm -rf /" :>
           sink.command = v.empty? ? DTAS::Sink::SINK_DEFAULTS["command"] : v
@@ -170,7 +174,7 @@ module DTAS::Player::ClientHandler # :nodoc:
       io.emit("OK")
     when "cat"
       sink = @sinks[name] or return io.emit("ERR #{name} not found")
-      io.emit(sink.to_hsh.to_yaml)
+      io.emit(sink.to_hash.to_yaml)
     else
       io.emit("ERR unknown sink op #{msg[0]}")
     end
@@ -181,6 +185,7 @@ module DTAS::Player::ClientHandler # :nodoc:
     bytes = bytes < 0 ? 0 : bytes # maybe negative in case of sink errors
   end
 
+  # returns seek offset as an Integer in sample count
   def __seek_offset_adj(dir, offset)
     if offset.sub!(/s\z/, '')
       offset = offset.to_i
@@ -463,7 +468,11 @@ module DTAS::Player::ClientHandler # :nodoc:
   def source_handler(io, msg)
     map = @source_map
     op = msg.shift
-    if op == "ls"
+    case op
+    when "restart"
+      __current_requeue
+      return io.emit("OK")
+    when "ls"
       s = map.keys.sort { |a,b| map[a].tryorder <=> map[b].tryorder }
       return io.emit(s.join(' '))
     end
@@ -474,7 +483,7 @@ module DTAS::Player::ClientHandler # :nodoc:
     when "cat"
       io.emit(src.to_source_cat.to_yaml)
     when "ed"
-      before = src.to_state_hash
+      before = src.to_state_hash.inspect
       sd = src.source_defaults
       msg.each do |kv|
         k, v = kv.split(/=/, 2)
@@ -492,7 +501,7 @@ module DTAS::Player::ClientHandler # :nodoc:
           source_map_reload
         end
       end
-      after = src.to_state_hash
+      after = src.to_state_hash.inspect
       __current_requeue if before != after && @current.class == src.class
       io.emit("OK")
     else
@@ -526,7 +535,7 @@ module DTAS::Player::ClientHandler # :nodoc:
       begin
         sf.dump(self)
       rescue => e
-        return io.emit("ERR dumping to #{xs(Array(dest))} #{e.message}")
+        return io.emit("ERR dumping to #{xs(dest)} #{e.message}")
       end
     end
     io.emit("OK")
@@ -674,5 +683,31 @@ module DTAS::Player::ClientHandler # :nodoc:
       io.emit("NOCUE")
     end
   end
+
+  def trim_handler(io, msg)
+    case msg.size
+    when 0
+      io.emit({ 'trim' => @trim }.to_yaml)
+    when 1, 2
+      case msg[0]
+      when 'off'
+        @trim = nil
+      else
+        begin
+          tbeg = parse_time(msg[0])
+          if tlen = msg[1]
+            absolute = tlen.sub!(/\A=/, '') # 44:00 =44:55
+            tlen = parse_time(tlen)
+            tlen -= tbeg if absolute
+          end
+          @trim = [ tbeg, tlen ] # seconds as float, since we don't know rate
+        rescue => e
+          return io.emit("ERR #{e.message}")
+        end
+      end
+      __current_requeue
+      io.emit('OK')
+    end
+  end
 end
 # :startdoc:

data/lib/dtas/process.rb

@@ -1,12 +1,14 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require 'io/wait'
 require_relative '../dtas'
 require_relative 'xs'
 
+# process management helpers
 module DTAS::Process # :nodoc:
   PIDS = {}
   include DTAS::XS
+  include DTAS::SpawnFix
 
   def self.reaper
     begin
@@ -47,12 +49,7 @@ module DTAS::Process # :nodoc:
     opts = { close_others: true, pgroup: true }.merge!(opts)
     env = env_expand(env, opts)
 
-    pid = begin
-      Process.spawn(env, cmd, opts)
-    rescue Errno::EINTR
-      # workaround for older Rubies https://bugs.ruby-lang.org/issues/8770
-      retry
-    end
+    pid = spawn(env, cmd, opts)
     warn [ :spawn, pid, cmd ].inspect if $DEBUG
     @spawn_at = Time.now.to_f
     PIDS[pid] = self
@@ -76,12 +73,7 @@ module DTAS::Process # :nodoc:
       opts[:err] = we
     end
     env = env_expand(env, opts)
-    pid = begin
-      Process.spawn(env, *cmd, opts)
-    rescue Errno::EINTR
-      # workaround for older Rubies https://bugs.ruby-lang.org/issues/8770
-      retry
-    end
+    pid = spawn(env, *cmd, opts)
     w.close
     if err_str
       we.close
@@ -107,6 +99,6 @@ module DTAS::Process # :nodoc:
     _, status = Process.waitpid2(pid)
     return res if status.success?
     return status if no_raise
-    raise RuntimeError, "`#{xs(Array(cmd))}' failed: #{status.inspect}"
+    raise RuntimeError, "`#{xs(cmd)}' failed: #{status.inspect}"
   end
 end

data/lib/dtas/replaygain.rb

@@ -1,7 +1,7 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
-#
-# Represents ReplayGain metadata for a DTAS::Source
+
+# Represents ReplayGain metadata for a DTAS::Source, only used by -player
 # cleanup/validate values to prevent malicious files from making us
 # run arbitrary commands
 # *_peak values are 0..inf (1.0 being full scale, but >1 is possible

data/lib/dtas/rg_state.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 #
 # provides support for generating appropriate effects for ReplayGain

data/lib/dtas/serialize.rb

@@ -1,5 +1,7 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# used to serialize player state to the state file
 module DTAS::Serialize # :nodoc:
   def ivars_to_hash(ivars, rv = {})
     ivars.each { |k| rv[k] = instance_variable_get("@#{k}") }

data/lib/dtas/sigevent.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 begin
   raise LoadError, "no eventfd with _DTAS_POSIX" if ENV["_DTAS_POSIX"]

data/lib/dtas/sigevent/efd.rb

@@ -1,10 +1,11 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
-class DTAS::Sigevent < SleepyPenguin::EventFD # :nodoc:
-  include SleepyPenguin
 
+# used in various places for safe wakeups from IO.select via signals
+# This requires a modern Linux system and the "sleepy_penguin" RubyGem
+class DTAS::Sigevent < SleepyPenguin::EventFD # :nodoc:
   def self.new
-    super(0, EventFD::CLOEXEC)
+    super(0, :CLOEXEC)
   end
 
   def signal

data/lib/dtas/sigevent/pipe.rb

@@ -1,5 +1,8 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# used in various places for safe wakeups from IO.select via signals
+# A fallback for non-Linux systems lacking the "sleepy_penguin" RubyGem
 class DTAS::Sigevent # :nodoc:
   attr_reader :to_io
 

data/lib/dtas/sink.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require 'yaml'
 require_relative '../dtas'
@@ -8,7 +8,7 @@ require_relative 'command'
 require_relative 'format'
 require_relative 'serialize'
 
-# this is a sink (endpoint, audio enters but never leaves)
+# this is a sink (endpoint, audio enters but never leaves), used by -player
 class DTAS::Sink # :nodoc:
   attr_accessor :prio    # any Integer
   attr_accessor :active  # boolean
@@ -66,8 +66,8 @@ class DTAS::Sink # :nodoc:
     super
   end
 
-  def spawn(format, opts = {})
-    raise "BUG: #{self.inspect}#spawn called twice" if @pid
+  def sink_spawn(format, opts = {})
+    raise "BUG: #{self.inspect}#sink_spawn called twice" if @pid
     rv = []
 
     pclass = @nonblock ? DTAS::PipeNB : DTAS::Pipe

data/lib/dtas/source.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../dtas'
 

data/lib/dtas/source/av.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../../dtas'
 require_relative 'av_ff_common'
@@ -10,7 +10,7 @@ class DTAS::Source::Av # :nodoc:
   AV_DEFAULTS = COMMAND_DEFAULTS.merge(
     "command" =>
       'avconv -v error $SSPOS $PROBE -i "$INFILE" $AMAP -f sox - |' \
-      'sox -p $SOXFMT - $RGFX',
+      'sox -p $SOXFMT - $TRIMFX $RGFX',
 
     # this is above ffmpeg because this av is the Debian default and
     # it's easier for me to test av than ff

data/lib/dtas/source/av_ff_common.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../../dtas'
 require_relative '../source'
@@ -19,8 +19,8 @@ module DTAS::Source::AvFfCommon # :nodoc:
   attr_reader :precision # always 32
   attr_reader :format
 
-  def try(infile, offset = nil)
-    rv = source_file_dup(infile, offset)
+  def try(infile, offset = nil, trim = nil)
+    rv = source_file_dup(infile, offset, trim)
     rv.av_ff_ok? or return
     rv
   end
@@ -101,10 +101,20 @@ module DTAS::Source::AvFfCommon # :nodoc:
     ! @astreams.compact.empty?
   end
 
-  def sspos(offset)
-    offset =~ /\A(\d+)s\z/ or return "-ss #{offset}"
-    samples = $1.to_f
-    sprintf("-ss %0.9g", samples / @format.rate)
+  def sspos
+    return unless @offset || @trim
+    off = offset_samples / @format.rate.to_f
+    sprintf('-ss %0.9g', off)
+  end
+
+  def av_ff_trimfx # for sox
+    return unless @trim
+    tbeg, tlen = @trim # Floats
+    tend = tbeg + tlen
+    off = offset_samples / @format.rate.to_f
+    tlen = tend - off
+    tlen = 0 if tlen < 0
+    sprintf('trim 0 %0.9g', tlen)
   end
 
   def select_astream(as)
@@ -127,8 +137,8 @@ module DTAS::Source::AvFfCommon # :nodoc:
     raise "BUG: no audio stream in #@infile"
   end
 
-  def spawn(player_format, rg_state, opts)
-    raise "BUG: #{self.inspect}#spawn called twice" if @to_io
+  def src_spawn(player_format, rg_state, opts)
+    raise "BUG: #{self.inspect}#src_spawn called twice" if @to_io
     amap = nil
 
     # try to find an audio stream which matches our channel count
@@ -148,10 +158,11 @@ module DTAS::Source::AvFfCommon # :nodoc:
 
     e["PROBE"] = @probe_harder ? @probe_harder.join(' ') : nil
     # make sure these are visible to the source command...
-    e["INFILE"] = @infile
+    e["INFILE"] = xs(@infile)
     e["AMAP"] = amap
-    e["SSPOS"] = @offset ? sspos(@offset) : nil
+    e["SSPOS"] = sspos
     e["RGFX"] = rg_state.effect(self) || nil
+    e["TRIMFX"] = av_ff_trimfx
     e.merge!(@rg.to_env) if @rg
 
     @pid = dtas_spawn(e, command_string, opts)

data/lib/dtas/source/cmd.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../../dtas'
 require_relative '../source'
@@ -31,8 +31,8 @@ class DTAS::Source::Cmd # :nodoc:
 
   alias to_hsh to_hash
 
-  def spawn(format, rg_state, opts)
-    raise "BUG: #{self.inspect}#spawn called twice" if @to_io
+  def src_spawn(format, rg_state, opts)
+    raise "BUG: #{self.inspect}#src_spawn called twice" if @to_io
     e = format.to_env
     @pid = dtas_spawn(e.merge!(@env), command_string, opts)
   end

data/lib/dtas/source/common.rb

@@ -1,10 +1,11 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 module DTAS::Source::Common # :nodoc:
-  attr_reader :dst_zero_byte
+  attr_reader :dst_zero_byte # first byte this source object saw
   attr_reader :dst
   attr_accessor :requeued
 
+  # buf - a DTAS::Buffer object (pipe)
   def dst_assoc(buf)
     @dst = buf
     @dst_zero_byte = buf.bytes_xfer + buf.inflight

data/lib/dtas/source/ff.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../../dtas'
 require_relative 'av_ff_common'
@@ -12,7 +12,7 @@ class DTAS::Source::Ff  # :nodoc:
   FF_DEFAULTS = COMMAND_DEFAULTS.merge(
     "command" =>
       'ffmpeg -v error $SSPOS $PROBE -i "$INFILE" $AMAP -f sox - |' \
-      'sox -p $SOXFMT - $RGFX',
+      'sox -p $SOXFMT - $TRIMFX $RGFX',
 
     # I haven't tested this much since av is in Debian stable and ff is not
     "tryorder" => 2,

data/lib/dtas/source/file.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014, Eric Wong <e@80x24.org> and all contributors
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 require_relative '../../dtas'
 require_relative '../source'
@@ -21,17 +21,18 @@ module DTAS::Source::File # :nodoc:
   FILE_SIVS = %w(infile comments command env) # for the "current" command
   SRC_SIVS = %w(command env tryorder)
 
-  def source_file_dup(infile, offset)
+  def source_file_dup(infile, offset, trim)
     rv = dup
-    rv.__file_init(infile, offset)
+    rv.__file_init(infile, offset, trim)
     rv
   end
 
-  def __file_init(infile, offset)
+  def __file_init(infile, offset, trim)
     @env = @env.dup
     @format = nil
     @infile = infile
     @offset = offset
+    @trim = trim
     @comments = nil
     @samples = nil
     @cuebp = nil
@@ -47,6 +48,13 @@ module DTAS::Source::File # :nodoc:
   # returns any offset in samples (relative to the original source file),
   # likely zero unless seek was used
   def offset_samples
+    off = __offset_samples
+    return off unless @trim
+    tbeg = @trim[0] * format.rate
+    tbeg < off ? off : tbeg
+  end
+
+  def __offset_samples
     return 0 unless @offset
     case @offset
     when /\A\d+s\z/
@@ -56,6 +64,16 @@ module DTAS::Source::File # :nodoc:
     end
   end
 
+  # creates the effect to fill the TRIMFX env
+  def trimfx
+    return unless @offset || @trim
+    fx = "trim #{offset_samples}s"
+    if @trim && @trim[1]
+      fx << sprintf(' =%0.9gs', (@trim[0] + @trim[1]) * format.rate)
+    end
+    fx
+  end
+
   # A user may be downloading the file and start playing
   # it before the download completes, this refreshes
   def samples!