dtas 0.9.0 → 0.10.0

data/lib/dtas/source/mp3gain.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 '../process'
 

data/lib/dtas/source/sox.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'
@@ -38,13 +38,13 @@ class DTAS::Source::Sox # :nodoc:
     command_init(SOX_DEFAULTS)
   end
 
-  def try(infile, offset = nil)
+  def try(infile, offset = nil, trim = nil)
     err = ""
     cmd = %W(soxi -s #{infile})
     s = qx(@env.dup, cmd, err_str: err, no_raise: true)
     return if err =~ /soxi FAIL formats:/
     self.class.try_to_fail_harder(infile, s, cmd) or return
-    source_file_dup(infile, offset)
+    source_file_dup(infile, offset, trim)
   end
 
   def format
@@ -75,13 +75,13 @@ class DTAS::Source::Sox # :nodoc:
     tmp
   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
     e = @env.merge!(player_format.to_env)
-    e["INFILE"] = @infile
+    e["INFILE"] = xs(@infile)
 
     # make sure these are visible to the "current" command...
-    e["TRIMFX"] = @offset ? "trim #@offset" : nil
+    e["TRIMFX"] = trimfx
     e["RGFX"] = rg_state.effect(self) || nil
     e.merge!(@rg.to_env) if @rg
 

data/lib/dtas/source/splitfx.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 2014-2015 all contributors <dtas-all@nongnu.org>
+# License: GPLv3 or later <https://www.gnu.org/licenses/gpl-3.0.txt>
+require 'yaml'
+require_relative 'sox'
+require_relative '../splitfx'
+require_relative '../watchable'
+
+class DTAS::Source::SplitFX < DTAS::Source::Sox # :nodoc:
+  MAX_YAML_SIZE = 512 * 1024
+  attr_writer :sox, :sfx
+  include DTAS::Watchable if defined?(DTAS::Watchable)
+
+  SPLITFX_DEFAULTS = SOX_DEFAULTS.merge(
+    "command" => "#{SOX_DEFAULTS["command"]} $FX",
+    "tryorder" => 3,
+  )
+
+  def initialize(sox = DTAS::Source::Sox.new)
+    command_init(SPLITFX_DEFAULTS)
+    @sox = sox
+  end
+
+  def try(ymlfile, offset = nil, trim = nil)
+    @splitfx = @ymlhash = nil
+    st = File.stat(ymlfile)
+    return false if !st.file? || st.size > MAX_YAML_SIZE
+
+    # read 4 bytes first to ensure we have a YAML file with a hash:
+    buf = ""
+    File.open(ymlfile, "rb") do |fp|
+      return false if fp.read(4, buf) != "---\n"
+      buf << fp.read
+    end
+
+    sfx = DTAS::SplitFX.new
+    Dir.chdir(File.dirname(ymlfile)) do # ugh
+      @ymlhash = YAML.load(buf)
+      @ymlhash['tracks'] ||= [ "t 0 default" ]
+      sfx.import(@ymlhash)
+      sfx.infile.replace(File.expand_path(sfx.infile))
+    end
+    @splitfx = sfx
+    @infile = ymlfile
+    sox = @sox.try(sfx.infile, offset, trim) or return false
+    rv = source_file_dup(ymlfile, offset, trim)
+    rv.sox = sox
+    rv.env = sfx.env
+    rv.sfx = sfx
+    rv
+  rescue => e
+    warn "#{e.message} (#{e.class})"
+    false
+  end
+
+  def __load_comments
+    @ymlhash["comments"] || @sox.__load_comments
+  end
+
+  def command_string
+    @ymlhash["command"] || super
+  end
+
+  def src_spawn(player_format, rg_state, opts)
+    raise "BUG: #{self.inspect}#src_spawn called twice" if @to_io
+    e = @env.merge!(player_format.to_env)
+    @sfx.infile_env(e, @sox.infile)
+
+    # make sure these are visible to the "current" command...
+    e["TRIMFX"] = trimfx
+    e["RGFX"] = rg_state.effect(self) || nil
+    e.merge!(@rg.to_env) if @rg
+
+    @pid = dtas_spawn(e, command_string, opts)
+  end
+
+  def to_hsh
+    to_hash.delete_if { |k,v| v == SPLITFX_DEFAULTS[k] }
+  end
+
+  def format
+    @sox.format
+  end
+
+  def samples!
+    @sox.samples!
+  end
+
+  def samples
+    @sox.samples
+  end
+
+  def source_defaults
+    SPLITFX_DEFAULTS
+  end
+
+  def cuebreakpoints
+    @splitfx.cuebreakpoints
+  end
+end

data/lib/dtas/spawn_fix.rb

@@ -0,0 +1,10 @@
+# Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# workaround for older Rubies: https://bugs.ruby-lang.org/issues/8770
+module DTAS::SpawnFix # :nodoc:
+  def spawn(*args)
+    super(*args)
+  rescue Errno::EINTR
+    retry
+  end if RUBY_VERSION.to_f <= 2.1
+end

data/lib/dtas/splitfx.rb

@@ -1,28 +1,31 @@
-# 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-splitfx is fairly tied to sox
-# (but we may still pipe to ecasound or anything else)
 require_relative '../dtas'
 require_relative 'format'
 require_relative 'process'
 require_relative 'xs'
 require 'tempfile'
+
+# The backend for dtas-splitfx(1) command, but also supported by dtas-player
+# Unlike the stuff for dtas-player, dtas-splitfx is fairly tied to sox
+# (but we may still pipe to ecasound or anything else)
 class DTAS::SplitFX # :nodoc:
   CMD = 'sox "$INFILE" $COMMENTS $OUTFMT "$TRACKNUMBER.$SUFFIX" '\
-        '$TRIMFX $RATEFX $DITHERFX'
+        '$TRIMFX $FX $RATEFX $DITHERFX'
   include DTAS::Process
   include DTAS::XS
+  attr_reader :infile, :env
 
-  class Skip < Struct.new(:tstart) # :nodoc:
+  class Skip < Struct.new(:tbeg) # :nodoc:
     def commit(_)
       # noop
     end
   end
 
-  class T < Struct.new(:env, :comments, :tstart, :fade_in, :fade_out) # :nodoc:
+  class T < Struct.new(:env, :comments, :tbeg, :fade_in, :fade_out) # :nodoc:
     def commit(advance_track_samples)
-      tlen = advance_track_samples - tstart
-      trimfx = "trim #{tstart}s #{tlen}s"
+      tlen = advance_track_samples - tbeg
+      trimfx = "trim #{tbeg}s #{tlen}s"
       if fade_in
         trimfx << " #{fade_in}"
       end
@@ -34,6 +37,10 @@ class DTAS::SplitFX # :nodoc:
         fade = " fade #{fade_type} 0 #{tlen}s #{fade_out_len}"
         trimfx << fade
       end
+
+      # raw sample counts (without 's' suffix)
+      env["TBEG"] = tbeg.to_s
+      env["TLEN"] = tlen.to_s
       env["TRIMFX"] = trimfx
     end
   end
@@ -60,7 +67,7 @@ class DTAS::SplitFX # :nodoc:
       },
       "opusenc" => {
         "command" => 'sox "$INFILE" $COMMENTS $OUTFMT - ' \
-           '$TRIMFX $RATEFX $DITHERFX | opusenc --music ' \
+           '$TRIMFX $FX $RATEFX $DITHERFX | opusenc --music ' \
            '--raw-bits $BITS_PER_SAMPLE ' \
            '$OPUSENC_BITRATE --raw-rate $RATE --raw-chan $CHANNELS ' \
            '--raw-endianness $ENDIAN_OPUSENC ' \
@@ -76,6 +83,8 @@ class DTAS::SplitFX # :nodoc:
     }
     @tracks = []
     @infmt = nil # wait until input is assigned
+    @cuebp = nil # for playback
+    @command = nil # top-level, for playback
   end
 
   def _bool(hash, key)
@@ -98,7 +107,6 @@ class DTAS::SplitFX # :nodoc:
       end
     end
 
-    hash = hash.merge(overrides)
     case v = hash["track_zpad"]
     when Integer then @track_zpad = val
     else
@@ -132,6 +140,7 @@ class DTAS::SplitFX # :nodoc:
 
     load_input!(hash)
     load_tracks!(hash)
+    @command = hash["command"] # nil by default
   end
 
   def load_input!(hash)
@@ -149,7 +158,7 @@ class DTAS::SplitFX # :nodoc:
     { "command" => CMD, "format" => outfmt }
   end
 
-  def spawn(target, t, opts)
+  def splitfx_spawn(target, t, opts)
     target = @targets[target] || generic_target(target)
     outfmt = target["format"]
 
@@ -185,16 +194,29 @@ class DTAS::SplitFX # :nodoc:
       comments.puts("#{k}=#{v}")
     end
     env["COMMENTS"] = "--comment-file=#{comments.path}"
-    env["INFILE"] = @infile
+    infile_env(env, @infile)
     env["OUTFMT"] = xs(outfmt.to_sox_arg)
     env["SUFFIX"] = outfmt.type
     env.merge!(t.env)
 
     command = target["command"]
-    tmp = Shellwords.split(command).map do |arg|
-      qx(env, "printf %s \"#{arg}\"")
+
+    # if a default dtas-player command is set, use that.
+    # we'll clobber our default environment since we assume play_cmd
+    # already takes those into account.  In other words, use our
+    # target-specific commands like a dtas-player sink:
+    #   @command | (INFILE= FX= TRIMFX=; target['command'])
+    if player_cmd = @command
+      sub_env = { 'INFILE' => '-', 'FX' => '', 'TRIMFX' => '' }
+      sub_env_s = sub_env.inject("") { |s,(k,v)| s << "#{k}=#{v} " }
+      command = "#{player_cmd} | (#{sub_env_s}; #{command})"
+      show_cmd = [ _expand_cmd(env, player_cmd), '|', '(', "#{sub_env_s};",
+                   _expand_cmd(env.merge(sub_env), command), ')' ].flatten
+    else
+      show_cmd = _expand_cmd(env, command)
     end
-    echo = "echo #{xs(tmp)}"
+
+    echo = "echo #{xs(show_cmd)}"
     if opts[:dryrun]
       command = echo
     else
@@ -216,8 +238,6 @@ class DTAS::SplitFX # :nodoc:
       fmt = "%0#{max.to_s.size}d"
     when Integer
       fmt = "%0#{@track_zpad}d"
-    else
-      fmt = "%d"
     end
     nr = @track_start
     @tracks.delete_if do |t|
@@ -241,7 +261,7 @@ class DTAS::SplitFX # :nodoc:
       start_time = argv.shift
       title = argv.shift
       t = T.new
-      t.tstart = @t2s.call(start_time)
+      t.tbeg = @t2s.call(start_time)
       t.comments = @comments.dup
       t.comments["TITLE"] = title
       t.env = @env.dup
@@ -260,17 +280,17 @@ class DTAS::SplitFX # :nodoc:
         end
       end
 
-      prev = @tracks.last and prev.commit(t.tstart)
+      prev = @tracks.last and prev.commit(t.tbeg)
       @tracks << t
     when "skip"
       stop_time = argv.shift
       argv.empty? or raise ArgumentError, "skip does not take extra args"
       s = Skip.new
-      s.tstart = @t2s.call(stop_time)
+      s.tbeg = @t2s.call(stop_time)
       # s.comments = {}
       # s.env = {}
       prev = @tracks.last or raise ArgumentError, "no tracks to skip"
-      prev.commit(s.tstart)
+      prev.commit(s.tbeg)
       @tracks << s
     when "stop"
       stop_time = argv.shift
@@ -278,7 +298,7 @@ class DTAS::SplitFX # :nodoc:
       samples = @t2s.call(stop_time)
       prev = @tracks.last and prev.commit(samples)
     else
-      raise ArgumentError, "unknown command: #{xs(Array(cmd))}"
+      raise ArgumentError, "unknown command: #{xs(cmd)}"
     end
   end
 
@@ -309,7 +329,7 @@ class DTAS::SplitFX # :nodoc:
     jobs = opts[:jobs] || tracks.size # jobs == nil => everything at once
     jobs.times.each do
       t = tracks.shift or break
-      pid, tmp = spawn(target, t, opts)
+      pid, tmp = splitfx_spawn(target, t, opts)
       pids[pid] = [ t, tmp ]
     end
 
@@ -318,7 +338,7 @@ class DTAS::SplitFX # :nodoc:
       done = pids.delete(pid)
       if status.success?
         if t = tracks.shift
-          pid, tmp = spawn(target, t, opts)
+          pid, tmp = splitfx_spawn(target, t, opts)
           pids[pid] = [ t, tmp ]
         end
         puts "DONE #{done[0].inspect}" if $DEBUG
@@ -334,4 +354,23 @@ class DTAS::SplitFX # :nodoc:
     end
     false
   end
+
+  def cuebreakpoints
+    rv = @cuebp and return rv
+    require_relative 'cue_index'
+    @cuebp = @tracks.map { |t| DTAS::CueIndex.new(1, "#{t.tbeg}s") }
+  end
+
+  def infile_env(env, infile)
+    env["INFILE"] = xs(infile)
+    dir, base = File.split(File.expand_path(infile))
+    env["INDIR"] = xs(dir)
+    env["INBASE"] = xs(base)
+  end
+
+  def _expand_cmd(env, command)
+    Shellwords.split(command).map do |arg|
+      qx(env, "printf %s \"#{arg}\"")
+    end
+  end
 end

data/lib/dtas/state_file.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 'yaml'
 require 'tempfile'
+
+# state file preserves state across restarts of dtas-player
 class DTAS::StateFile # :nodoc:
   attr_reader :path
 

data/lib/dtas/{trimfx.rb → tfx.rb}

@@ -1,19 +1,26 @@
-# 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 'parse_time'
+require_relative 'format'
 require 'shellwords'
 
-class DTAS::TrimFX
+# this will represent a trim section inside -splitfx for applying
+# effects to only a part of the output
+class DTAS::TFX
   include DTAS::ParseTime
 
   attr_reader :tbeg
   attr_reader :tlen
   attr_reader :cmd
 
-  def initialize(args)
+  def initialize(args, format = DTAS::Format.new)
+    @format = format
     args = args.dup
     case args.shift
+    when :pad # [ :pad, start_time, end_time ]
+      @tbeg = args.shift
+      @tlen = args.shift - @tbeg
     when "trim"
       parse_trim!(args)
     when "all"
@@ -22,7 +29,7 @@ class DTAS::TrimFX
     else
       raise ArgumentError, "#{args.inspect} not understood"
     end
-    case tmp =  args.shift
+    case tmp = args.shift
     when "sh" then @cmd = args
     when "sox" then tfx_sox(args)
     when "eca" then tfx_eca(args)
@@ -45,34 +52,32 @@ class DTAS::TrimFX
     @cmd.concat(%w(| sox $ECA2SOX - $SOXOUT))
   end
 
-  def to_sox_arg(format)
+  def to_sox_arg
     if @tbeg && @tlen
-      beg = @tbeg * format.rate
-      len = @tlen * format.rate
-      %W(trim #{beg.round}s #{len.round}s)
+      %W(trim #{@tbeg}s #{@tlen}s)
     elsif @tbeg
       return [] if @tbeg == 0
-      beg = @tbeg * format.rate
-      %W(trim #{beg.round}s)
+      %W(trim #{@tbeg}s)
     else
       []
     end
   end
 
+  # tries to interpret "trim" time args the same way the sox trim effect does
+  # This takes _time_ arguments only, not sample counts;
+  # otherwise, deviations from sox are considered bugs in dtas
   def parse_trim!(args)
     tbeg = parse_time(args.shift)
     if args[0] =~ /\A=?[\d\.]+\z/
       tlen = args.shift
       is_stop_time = tlen.sub!(/\A=/, "") ? true : false
       tlen = parse_time(tlen)
-      if is_stop_time
-        tlen = tlen - tbeg
-      end
+      tlen = tlen - tbeg if is_stop_time
+      @tlen = (tlen * @format.rate).round
     else
-      tlen = nil
+      @tlen = nil
     end
-    @tbeg = tbeg
-    @tlen = tlen
+    @tbeg = (tbeg * @format.rate).round
   end
 
   def <=>(other)
@@ -87,7 +92,20 @@ class DTAS::TrimFX
     end
   end
 
-  # there'll be multiple epochs if ranges overlap
+  # sorts and converts an array of TFX objects into non-overlapping arrays
+  # of epochs
+  #
+  # input:
+  #   [ tfx1, tfx2, tfx3, ... ]
+  #
+  # output:
+  #   [
+  #     [ tfx1 ],         # first epoch
+  #     [ tfx2, tfx3 ],   # second epoch
+  #     ...
+  #   ]
+  # There are multiple epochs only if ranges overlap,
+  # There is only one epoch if there are no overlaps
   def self.schedule(ary)
     sorted = []
     ary.each_with_index { |tfx, i| sorted << TFXSort[tfx, i] }
@@ -96,41 +114,49 @@ class DTAS::TrimFX
     epoch = 0
     prev_end = 0
     defer = []
+
     begin
       while tfxsort = sorted.shift
         tfx = tfxsort.tfx
         if tfx.tbeg >= prev_end
+          # great, no overlap, append to the current epoch
           prev_end = tfx.tbeg + tfx.tlen
           (rv[epoch] ||= []) << tfx
         else
+          # overlapping region, we'll need a new epoch
           defer << tfxsort
         end
       end
-      if defer[0]
+
+      if defer[0] # do we need another epoch?
         epoch += 1
         sorted = defer
         defer = []
         prev_end = 0
       end
     end while sorted[0]
+
     rv
   end
 
-  def self.expand(ary, total_len)
+  # like schedule, but fills in the gaps with pass-through (no-op) TFX objs
+  # This does not change the number of epochs.
+  def self.expand(ary, total_samples)
     rv = []
-    schedule(ary).each_with_index do |sary, i|
+    schedule(ary).each_with_index do |sary, epoch|
       tip = 0
-      dst = rv[i] = []
+      dst = rv[epoch] = []
       while tfx = sary.shift
         if tfx.tbeg > tip
-          nfx = new(%W(trim #{tip} =#{tfx.tbeg}))
+          # fill in the previous gap
+          nfx = new([:pad, tip, tfx.tbeg])
           dst << nfx
           dst << tfx
           tip = tfx.tbeg + tfx.tlen
         end
       end
-      if tip < total_len
-        nfx = new(%W(trim #{tip} =#{total_len}))
+      if tip < total_samples # fill until the last chunk
+        nfx = new([:pad, tip, total_samples])
         dst << nfx
       end
     end