dtas 0.9.0 → 0.10.0

data/lib/dtas/buffer/splice.rb

@@ -1,17 +1,17 @@
-# 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/nonblock'
 require 'io/splice'
 require_relative '../../dtas'
 require_relative '../pipe'
 
+# Used by -player on Linux systems with the "io-splice" RubyGem installed
 module DTAS::Buffer::Splice # :nodoc:
   MAX_AT_ONCE = 4096 # page size in Linux
   MAX_AT_ONCE_1 = 65536
   MAX_SIZE = File.read("/proc/sys/fs/pipe-max-size").to_i
   DEVNULL = File.open("/dev/null", "r+")
   F_MOVE = IO::Splice::F_MOVE
-  WAITALL = IO::Splice::WAITALL
 
   def buffer_size
     @to_io.pipe_size
@@ -28,9 +28,10 @@ module DTAS::Buffer::Splice # :nodoc:
     IO.splice(@to_io, nil, DEVNULL, nil, bytes)
   end
 
-  def broadcast_one(targets)
+  def broadcast_one(targets, limit = nil)
     # single output is always non-blocking
-    s = IO.trysplice(@to_io, nil, targets[0], nil, MAX_AT_ONCE_1, F_MOVE)
+    limit ||= MAX_AT_ONCE_1
+    s = IO.trysplice(@to_io, nil, targets[0], nil, limit, F_MOVE)
     if Symbol === s
       targets # our one and only target blocked on write
     else
@@ -43,6 +44,26 @@ module DTAS::Buffer::Splice # :nodoc:
     nil # do not return error here, we already spewed an error message
   end
 
+  def __tee_in_full(src, dst, bytes)
+    rv = 0
+    while bytes > 0
+      s = IO.tee(src, dst, bytes)
+      bytes -= s
+      rv += s
+    end
+    rv
+  end
+
+  def __splice_in_full(src, dst, bytes, flags)
+    rv = 0
+    while bytes > 0
+      s = IO.splice(src, nil, dst, nil, bytes, flags)
+      rv += s
+      bytes -= s
+    end
+    rv
+  end
+
   # returns the largest value we teed
   def __broadcast_tee(blocked, targets, chunk_size)
     most_teed = 0
@@ -50,7 +71,7 @@ module DTAS::Buffer::Splice # :nodoc:
       begin
         t = (dst.nonblock? || most_teed == 0) ?
             IO.trytee(@to_io, dst, chunk_size) :
-            IO.tee(@to_io, dst, chunk_size, WAITALL)
+            __tee_in_full(@to_io, dst, chunk_size)
         if Integer === t
           if t > most_teed
             chunk_size = t if most_teed == 0
@@ -68,7 +89,7 @@ module DTAS::Buffer::Splice # :nodoc:
     most_teed
   end
 
-  def broadcast_inf(targets)
+  def broadcast_inf(targets, limit = nil)
     if targets.all?(&:ready_write_optimized?)
       blocked = []
     elsif targets.none?(&:nonblock?)
@@ -85,7 +106,7 @@ module DTAS::Buffer::Splice # :nodoc:
     end
 
     # don't pin too much on one target
-    bytes = MAX_AT_ONCE
+    bytes = limit || MAX_AT_ONCE
     last = targets.pop # we splice to the last one, tee to the rest
 
     # this may return zero if all targets were non-blocking
@@ -116,7 +137,7 @@ module DTAS::Buffer::Splice # :nodoc:
         end
       else
         # the blocking case is simple
-        s = IO.splice(@to_io, nil, last, nil, bytes, WAITALL|F_MOVE)
+        s = __splice_in_full(@to_io, last, bytes, F_MOVE)
       end
       @bytes_xfer += s
 

data/lib/dtas/command.rb

@@ -1,9 +1,9 @@
-# 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)
-# common code for wrapping SoX/ecasound/... commands
 require_relative 'serialize'
 require 'shellwords'
 
+# common code for wrapping SoX/ecasound/... commands
 module DTAS::Command # :nodoc:
   include DTAS::Serialize
   attr_reader :pid

data/lib/dtas/compat_onenine.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)
 
 # Make Ruby 1.9.3 look like Ruby 2.0.0 to us

data/lib/dtas/cue_index.rb

@@ -1,6 +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)
 require_relative '../dtas'
+
+# embedded CUE sheet representation for -player
 class DTAS::CueIndex
   attr_reader :offset
   attr_reader :index

data/lib/dtas/disclaimer.rb

@@ -1,5 +1,5 @@
 # :enddoc:
-# 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)
 DTAS_PROGNAME = File.basename($0)
 DTAS_DISCLAIMER = <<EOF

data/lib/dtas/edit_client.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 'tempfile'
 require 'yaml'

data/lib/dtas/fadefx.rb

@@ -0,0 +1,100 @@
+# 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 'parse_time'
+require_relative 'xs'
+
+# note: This is sox-specific
+# --------- time --------->
+# _____   _______   ______
+#      \ /       \ /
+# prev  X   cur   X   next
+# _____/ \_______/ \______
+#
+# out_prev - controls the downward slope from prev
+# in_cur   - controls the upward slope into cur
+# out_cur  - controls the downward slope from cur
+# in_next  - controls the upward slope into next
+class DTAS::FadeFX # :nodoc:
+  include DTAS::ParseTime
+  include DTAS::XS
+
+  attr_reader :out_prev, :in_cur, :out_cur, :in_next
+  F = Struct.new(:type, :flen)
+
+  def initialize(args)
+    args =~ /\A([^,]*),([^,]*);([^,]*),([^,]*)\z/ or
+      raise ArgumentError, "bad fade format"
+    fades = [ $1, $2, $3, $4 ]
+    %w(out_prev in_cur out_cur in_next).each do |iv|
+      instance_variable_set("@#{iv}", parse!(fades.shift))
+    end
+  end
+
+  def fade_cur_fx(format, tbeg, tlen, args = [])
+    fx = %W(trim #{tbeg}s #{tlen}s)
+    fx.concat(args)
+    if @in_cur && @out_cur && @in_cur.type == @out_cur.type
+      f = %W(fade #{@in_cur.type} #{@in_cur.flen} #{tlen}s #{@out_cur.flen})
+      fx.concat(f)
+    else # differing fade types for in/out, chain them:
+      fpart = @in_cur and
+        fx.concat(%W(fade #{fpart.type} #{fpart.flen} 0 0))
+      fpart = @out_cur and
+        fx.concat(%W(fade #{fpart.type} 0 #{tlen}s #{fpart.flen}))
+    end
+    fx
+  end
+
+  def fade_out_prev_fx(format, tbeg, tlen)
+    fx = %W(trim #{tbeg}s)
+
+    if fpart = @out_prev
+      out_len = format.hhmmss_to_samples(fpart.flen)
+      fx.concat(%W(fade #{fpart.type} 0 #{out_len}s #{out_len}s))
+      remain = tlen - out_len
+
+      # fade-out is longer than tlen, so truncate again:
+      remain < 0 and fx.concat(%W(trim 0 #{tlen}s))
+
+      # pad with silence, this is where fade_cur_fx goes
+      remain > 0 and fx.concat(%W(pad #{remain}s@#{out_len}s))
+    end
+    fx
+  end
+
+  def fade_in_next_fx(format, tbeg, tlen)
+    fpart = @in_next
+    flen = fpart ? fpart.flen : 0
+    nlen = format.hhmmss_to_samples(flen)
+    nbeg = tbeg + tlen - nlen
+    npad = nbeg - tbeg
+    if npad < 0
+      warn("in_next should not exceed range: #{inspect} @trim " \
+           "#{tbeg}s #{tlen}s\nclamping to #{tbeg}")
+      nbeg = tbeg
+    end
+
+    fx = %W(trim #{nbeg}s #{nlen}s)
+    nlen != 0 and
+      fx.concat(%W(fade #{fpart.type} #{nlen}s 0 0))
+
+    # likely, the pad section is where fade_cur_fx goes
+    npad > 0 and fx.concat(%W(pad #{npad}s@0s))
+    fx
+  end
+
+  # q - quarter of a sine wave
+  # h - half a sine wave
+  # t - linear (`triangular') slope
+  # l - logarithmic
+  # p - inverted parabola
+  # default is 't' (sox defaults to 'l', but triangular makes more sense
+  # when concatenating
+  def parse!(str)
+    return nil if str.empty?
+    type = "t"
+    str.sub!(/\A([a-z])/, "") and type = $1
+    F.new(type, parse_time(str))
+  end
+end

data/lib/dtas/format.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 represents an audio format (type/bits/channels/sample rate/...)
 require_relative '../dtas'
 require_relative 'process'
 require_relative 'serialize'
 
+# class represents an audio format (type/bits/channels/sample rate/...)
+# used throughout dtas
 class DTAS::Format # :nodoc:
   include DTAS::Process
   include DTAS::Serialize
@@ -164,6 +165,7 @@ class DTAS::Format # :nodoc:
   # HH:MM:SS.frac (don't bother with more complex times, too much code)
   # part of me wants to drop this feature from playq, feels like bloat...
   def hhmmss_to_samples(hhmmss)
+    Numeric === hhmmss and return hhmmss * @rate
     time = hhmmss.dup
     rv = 0
     if time.sub!(/\.(\d+)\z/, "")

data/lib/dtas/parse_time.rb

@@ -1,7 +1,9 @@
-# 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'
+
 module DTAS::ParseTime
+  # convert a string time to seconds, returning a Flot or Integer
   def parse_time(time)
     case time
     when /\A\d+\z/

data/lib/dtas/partstats.rb

@@ -1,15 +1,17 @@
 # -*- encoding: binary -*-
-# 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)
-# Unlike the stuff for dtas-player, dtas-partstats is fairly tied to sox
 require_relative '../dtas'
 require_relative 'xs'
 require_relative 'process'
 require_relative 'sigevent'
 
+# backend for the dtas-partstats(1) command
+# Unlike the stuff for dtas-player, dtas-partstats is fairly tied to sox
 class DTAS::PartStats
   CMD = 'sox "$INFILE" -n $TRIMFX $SOXFX stats $STATSOPTS'
   include DTAS::Process
+  include DTAS::SpawnFix
   attr_reader :key_idx
   attr_reader :key_width
 
@@ -49,18 +51,14 @@ class DTAS::PartStats
     rv
   end
 
-  def spawn(trim_part, opts)
+  def partstats_spawn(trim_part, opts)
     rd, wr = IO.pipe
     env = opts[:env]
     env = env ? env.dup : {}
-    env["INFILE"] = @infile
+    env["INFILE"] = xs(@infile)
     env["TRIMFX"] = "trim #{trim_part.tbeg}s #{trim_part.tlen}s"
     opts = { pgroup: true, close_others: true, err: wr }
-    pid = begin
-      Process.spawn(env, CMD, opts)
-    rescue Errno::EINTR # Ruby bug?
-      retry
-    end
+    pid = spawn(env, CMD, opts)
     wr.close
     [ pid, rd ]
   end
@@ -74,7 +72,7 @@ class DTAS::PartStats
     stats = []
     fails = []
     do_spawn = lambda do |trim_part|
-      pid, rpipe = spawn(trim_part, opts)
+      pid, rpipe = partstats_spawn(trim_part, opts)
       rset[rpipe] = [ trim_part, "" ]
       pids[pid] = [ trim_part, rpipe ]
     end

data/lib/dtas/pipe.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
   require 'io/splice'
@@ -7,6 +7,7 @@ end
 require_relative '../dtas'
 require_relative 'writable_iter'
 
+# pipe wrapper for -player sinks
 class DTAS::Pipe < IO # :nodoc:
   include DTAS::WritableIter
   attr_accessor :sink

data/lib/dtas/player.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 'shellwords'
@@ -8,6 +8,7 @@ require_relative 'source'
 require_relative 'source/sox'
 require_relative 'source/av'
 require_relative 'source/ff'
+require_relative 'source/splitfx'
 require_relative 'source/cmd'
 require_relative 'sink'
 require_relative 'unix_server'
@@ -17,6 +18,7 @@ require_relative 'rg_state'
 require_relative 'state_file'
 require_relative 'tracklist'
 
+# the core of dtas-player(1)
 class DTAS::Player # :nodoc:
   require_relative 'player/client_handler'
   include DTAS::XS
@@ -43,10 +45,12 @@ class DTAS::Player # :nodoc:
     @sink_buf = DTAS::Buffer.new
     @current = nil
     @watchers = {}
+    @trim = nil
     @source_map = {
-      "sox" => DTAS::Source::Sox.new,
+      "sox" => (sox = DTAS::Source::Sox.new),
       "av" => DTAS::Source::Av.new,
       "ff" => DTAS::Source::Ff.new,
+      "splitfx" => DTAS::Source::SplitFX.new(sox),
     }
     source_map_reload
   end
@@ -56,7 +60,7 @@ class DTAS::Player # :nodoc:
   end
 
   def wall(msg)
-    __wall(xs(Array(msg)))
+    __wall(xs(msg))
   end
 
   def __wall(msg)
@@ -80,6 +84,7 @@ class DTAS::Player # :nodoc:
     rv = {}
     rv["socket"] = @socket
     rv["paused"] = @paused if @paused
+    rv["trim"] = @trim if @trim
     src_map = rv["source"] = {}
     @source_map.each do |name, src|
       src_hsh = src.to_state_hash
@@ -117,6 +122,10 @@ class DTAS::Player # :nodoc:
     rv
   end
 
+  def to_omap(hash)
+    YAML::Omap === hash ? hash : YAML::Omap.new.merge!(hash)
+  end
+
   def self.load(hash)
     rv = new
     rv.instance_eval do
@@ -128,7 +137,7 @@ class DTAS::Player # :nodoc:
         v = v["buffer_size"]
         @sink_buf.buffer_size = v
       end
-      %w(socket queue paused bypass).each do |k|
+      %w(socket queue paused bypass trim).each do |k|
         v = hash[k] or next
         instance_variable_set("@#{k}", v)
       end
@@ -147,6 +156,7 @@ class DTAS::Player # :nodoc:
         @source_map.each do |name, src|
           src_hsh = v[name] or next
           src.load!(src_hsh)
+          src.env = to_omap(src.env)
         end
         source_map_reload
       end
@@ -158,6 +168,7 @@ class DTAS::Player # :nodoc:
       if sinks = hash["sinks"]
         sinks.each do |sink_hsh|
           sink = DTAS::Sink.load(sink_hsh)
+          sink.env = to_omap(sink.env)
           @sinks[sink.name] = sink
         end
       end
@@ -238,6 +249,8 @@ class DTAS::Player # :nodoc:
       io.emit(Dir.pwd)
     when "tl"
       tl_handler(io, msg)
+    when "trim"
+      trim_handler(io, msg)
     end
   end
 
@@ -346,7 +359,7 @@ class DTAS::Player # :nodoc:
     @sinks.each_value do |sink|
       sink.active or next
       next if sink.pid
-      @targets.concat(sink.spawn(@format))
+      @targets.concat(sink.sink_spawn(@format))
     end
     if @targets[0]
       @targets.sort_by! { |t| t.sink.prio }
@@ -358,23 +371,25 @@ class DTAS::Player # :nodoc:
     end
   end
 
-  def try_file(*args)
+  def try_file(file, offset = nil)
     @sources.each do |src|
-      rv = src.try(*args) and return rv
+      rv = src.try(file, offset, @trim) and return rv
     end
 
     # keep going down the list until we find something
     while source_spec = @queue.shift
+      path, off = source_spec
       @sources.each do |src|
-        rv = src.try(*source_spec) and return rv
+        rv = src.try(path, off, @trim) and return rv
       end
     end
 
     # don't get stuck in an infinite loop if @tl.repeat==true and we can't
     # decode anything (FS errors, sox uninstalled, etc...)
     while path_off = @tl.advance_track(false)
+      path, off = path_off
       @sources.each do |src|
-        rv = src.try(*path_off) and return rv
+        rv = src.try(path, off, @trim) and return rv
       end
     end
 
@@ -383,6 +398,7 @@ class DTAS::Player # :nodoc:
   end
 
   def next_source(source_spec)
+    @current.respond_to?(:watch_end) and @current.watch_end(@srv)
     @current = nil
     if source_spec
       case source_spec
@@ -397,7 +413,7 @@ class DTAS::Player # :nodoc:
         msg = %W(command #{pending.command_string})
       end
 
-      unless @bypass.empty?
+      if ! @bypass.empty? && pending.respond_to?(:format)
         new_fmt = bypass_match!(@format.dup, pending.format)
         if new_fmt != @format
           stop_sinks # we may fail to start below
@@ -410,7 +426,13 @@ class DTAS::Player # :nodoc:
 
       dst = @sink_buf
       pending.dst_assoc(dst)
-      pending.spawn(@format, @rg, out: dst.wr, in: "/dev/null")
+      pending.src_spawn(@format, @rg, out: dst.wr, in: "/dev/null")
+
+      # watch and restart on modifications
+      pending.respond_to?(:watch_begin) and
+        @srv.wait_ctl(pending.watch_begin(method(:__current_requeue)),
+                      :wait_readable)
+
       @current = pending
       @srv.wait_ctl(dst, :wait_readable)
       wall(msg)