about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/dtas-archive.pod11
-rw-r--r--Documentation/dtas-player.pod10
-rw-r--r--Documentation/dtas-sourceedit.pod8
-rw-r--r--Documentation/dtas-splitfx.pod68
-rw-r--r--Documentation/dtas-tl.pod4
5 files changed, 78 insertions, 23 deletions
diff --git a/Documentation/dtas-archive.pod b/Documentation/dtas-archive.pod
index 157ea70..50237e8 100644
--- a/Documentation/dtas-archive.pod
+++ b/Documentation/dtas-archive.pod
@@ -52,11 +52,20 @@ Continue after error
 
 Number of times to repeat the L<sndfile-cmp(1)> check.  Default: 1
 
+=item -m, --match REGEX
+
+Only archive files matching a given Ruby (or Perl-compatible) regular
+expression.  The regular expression is implementation-dependent and
+using the Perl-compatible subset of Ruby regexps is recommended as dtas
+will be moving away from Ruby at some point.
+
+Added for dtas v0.22.0
+
 =back
 
 =head1 COPYRIGHT
 
-Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>
+Copyright all contributors L<mailto:dtas-all@nongnu.org>
 
 License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>
 
diff --git a/Documentation/dtas-player.pod b/Documentation/dtas-player.pod
index 932441a..4cfdd12 100644
--- a/Documentation/dtas-player.pod
+++ b/Documentation/dtas-player.pod
@@ -70,10 +70,10 @@ To play audio on my favorite USB DAC directly to ALSA, I use:
 =head2 Seeking/playing audio from large video containers (e.g. VOB) fails
 
 This is a problem with large VOBs.  We recommend breaking up the
-VOB into smaller files or using L<avconv(1)> or L<ffmpeg(1)> to extract
-the desired audio stream.
+VOB into smaller files or using L<ffmpeg(1)> to extract
+the desired audio stream at C<$STREAM_NR>.
 
-      avconv -analyzeduration 2G -probesize 2G \
+      ffmpeg -analyzeduration 2G -probesize 2G \
         -i input.vob -vn -sn -c:a copy -map 0:$STREAM_NR output.ext
 
 =head1 ADVANCED EXAMPLES
@@ -115,7 +115,7 @@ No subscription is necessary to post to the mailing list.
 
 =head1 COPYRIGHT
 
-Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>
+Copyright all contributors L<mailto:dtas-all@nongnu.org>
 
 License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>
 
@@ -123,4 +123,4 @@ License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>
 
 L<dtas-player_protocol(7)>, L<dtas-ctl(1)>, L<dtas-enq(1)>,
 L<dtas-sourceedit(1)>, L<dtas-sinkedit(1)>, L<sox(1)>, L<play(1)>,
-L<avconv(1)>, L<ffmpeg(1)>, L<screen(1)>, L<tmux(1)>
+L<ffmpeg(1)>, L<screen(1)>, L<tmux(1)>
diff --git a/Documentation/dtas-sourceedit.pod b/Documentation/dtas-sourceedit.pod
index 67ecabf..593bcf5 100644
--- a/Documentation/dtas-sourceedit.pod
+++ b/Documentation/dtas-sourceedit.pod
@@ -51,11 +51,7 @@ of a previous "dtas-ctl source cat sox" invocation:
 
         $ dtas-sourceedit sox < saved.yml
 
-To change the way dtas-player calls avconv (part of libav):
-
-        $ dtas-sourceedit av
-
-To change the way dtas-player calls ffmpeg (lightly-tested):
+To change the way dtas-player calls ffmpeg:
 
         $ dtas-sourceedit ff
 
@@ -77,7 +73,7 @@ No subscription is necessary to post to the mailing list.
 
 =head1 COPYRIGHT
 
-Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>
+Copyright all contributors L<mailto:dtas-all@nongnu.org>
 
 License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>
 
diff --git a/Documentation/dtas-splitfx.pod b/Documentation/dtas-splitfx.pod
index f10c6a3..88179d7 100644
--- a/Documentation/dtas-splitfx.pod
+++ b/Documentation/dtas-splitfx.pod
@@ -26,7 +26,8 @@ to use L<ecasound(1)>, too.
 =item -j, --jobs [JOBS]
 
 Number of jobs to run in parallel.  If no number is specified, all
-jobs are run in parallel.
+jobs are run in parallel.  Default: number of CPUS (dtas 0.20.0+),
+previous versions of dtas defaulted to 1.
 
 =item -n, --dry-run
 
@@ -36,6 +37,12 @@ Print, but do not run the commands to be executed
 
 Silent operation, commands are not printed as executed
 
+=item -S, --stats
+
+Add the sox "stats" effect to the end of the effects chain,
+use this with L</--err-suffix> to get a C<.stats> file with
+every track output
+
 =item -D, --no-dither
 
 Disable automatic setting of the DITHERFX env.  This also passes
@@ -45,7 +52,8 @@ the option to L<sox(1)> via SOX_OPTS.
 
 Write the contents of C<stderr>.  This is useful for capturing
 the per-track output of the L<sox(1)> C<stats> effect when
-combined with parallel C<--jobs>.
+combined with parallel C<--jobs>.  Recommended for use with the
+L</--stats> switch.
 
 =item -O, --outdir OUTDIR
 
@@ -76,6 +84,16 @@ 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.
 
+This switch may not be combined with L</--filter>
+
+=item -f, --filter [FIELD=]VALUE
+
+Only process tracks matching a given comment FIELD and VALUE.
+If no C<=> is exists, then all comment fields are matched
+against the specified VALUE.
+
+This switch may not be combined with L</--trim>
+
 =item -p, --sox-pipe
 
 Used in place of an output target to specify outputting audio data in
@@ -90,9 +108,9 @@ moves printing of output to stderr and disables parallel job invocation.
 
 =item infile - string, the pathname of the original audio file
 
-=item env - ordered hash of environment variables to set for all commands
+=item env - hash of environment variables to set for all commands
 
-    env: !omap
+    env:
       FX: gain 3 stats
 
 =item comments - hash of common tags for all audio (e.g. ARTIST, ALBUM, YEAR)
@@ -121,7 +139,12 @@ highest-numbered track.  Default: true
 
 =item targets - hash, see "TARGETS" section
 
-=item command - used only by L<dtas-player(1)>
+=item command - override the default sox invocation
+
+This command may be used to specify an alternate command to process each
+track.
+
+Default: sox "$INFILE" $COMMENTS $OUTFMT $OUTDST $TRIMFX $FX $RATEFX $DITHERFX
 
 =back
 
@@ -133,11 +156,36 @@ segment.
 
 =over
 
-=item t TIME TITLE [fade_in/fade_out=FADE_ARGS]
+=item t TIME TITLE [fade_in/fade_out=FADE_ARGS] [.FIELD=VALUE] [env.X=Y]
+
+The start of a new track at TIME with TITLE.
+An optional L</fade_in> and L</fade_out> may be specified for any tracks.
+Per-track comments may be specified in the form of C<.FIELD=VALUE>.
+Using per-track C<.ARTIST=FOO> allows proper tagging of multi-artist
+compilations.
+
+Per-track environment variables may be specified in the form
+of C<env.K=V> where C<K> is the environment variable name and
+C<V> is its value.  Per-track environment variables do not affect
+playback of YAML files via L<dtas-player(1)> nor use of the L</--trim>
+command-line option.  However, per-track environment variables do affect
+any tracks written to the filesystem, including those using the L</--filter>
+switch.   These environment variables are intended to affect the specified
+L</command> or default L<sox(1)> invocation.
+
+=item tshift TIME
+
+Increment subsequent time stamps for L</t>, L</skip>, and L</stop>
+directives by the specified TIME offset.  TIME can be prefixed by
+C<+=> or C<-=> to adjust the existing C<tshift> value.  Negative
+values can be specified by prefixing with C<-> for a backwards
+time shift.
+
+This directive is useful for working with multiple recordings of the
+same source and cutting a section from the middle of a recording after
+initial tracking is done.
 
-The start of a new track
-at TIME with TITLE.  An optional fade_in and fade_out may be specified
-for the first/last tracks.
+Default: 0
 
 =item skip TIME - skip a segment starting at TIME
 
@@ -268,7 +316,7 @@ imbalance in a live concert recording from the audience:
 
 =head1 COPYRIGHT
 
-Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>
+Copyright all contributors L<mailto:dtas-all@nongnu.org>
 
 License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>
 
diff --git a/Documentation/dtas-tl.pod b/Documentation/dtas-tl.pod
index ac1b47d..b5a4b31 100644
--- a/Documentation/dtas-tl.pod
+++ b/Documentation/dtas-tl.pod
@@ -60,6 +60,8 @@ optionally seek to POS.  POS should be a timestamp in HH:MM:SS.FRAC format.
 
 =item prev - play the previous track in the tracklist
 
+=item prune - cull non-existent pathnames from the tracklist
+
 =item repeat 1 - repeat the current track
 
 =item repeat false - disable repeat
@@ -120,7 +122,7 @@ No subscription is necessary to post to the mailing list.
 
 =head1 COPYRIGHT
 
-Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>
+Copyright all contributors L<mailto:dtas-all@nongnu.org>
 
 License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>