dtas 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5583678ac4bac1a9255750144a74b243f6344f47
-  data.tar.gz: 7635bf1345477bc6ff1ca269be15f79090de639c
+  metadata.gz: d233bbb0a87d1fc6c4bdb7f18eba692c721a3333
+  data.tar.gz: 8f14c5645b6535bd6c22b1e4854ef39ec85d528a
 SHA512:
-  metadata.gz: 15424a207857ad4b102b109c02890db06337a3772ea071230bd6e40fee9da4d64e2c5c1666ba95878d8015b9021f31629a76c38585a37648e60d02cc42a4127d
-  data.tar.gz: bfec766d9470d8d0a09f3b7b8d2db33f748de0086d5362923c9aaf773e6cb8dcc773438ec0949ec5fc3c12eb3ac808fc471faae7931994fd29e64fbfba9fd665
+  metadata.gz: 93592a5294b214260e938746ad75408a32889aae8c3667a49ede5952364dd6a9f3d99b793a77c134a9bd66ec15a21eda0f078475d2d375543ebf153714170c68
+  data.tar.gz: 8fc83ba70d8a7a57f2e4ca26c936bd237b0fd9f4130142f8c500d7eeb4a0f7b15542bf305b79e891c7a2acd7f5edb3750281776ad7d730edc95fcdd3078c5b1b

data/Documentation/GNUmakefile

@@ -16,6 +16,8 @@ m1 += dtas-player
 m1 += dtas-xdelay
 m1 += dtas-sinkedit
 m1 += dtas-sourceedit
+m1 += dtas-tl
+m1 += dtas-splitfx
 
 m7 =
 m7 += dtas-player_protocol

data/Documentation/dtas-player_protocol.txt

@@ -53,6 +53,9 @@ dtas-sinkedit(1), and dtas-enq(1) also implement this protocol.
 - COMMAND, this may be quoted string passed to sh -c "",
            variable/argument expansion will be performed by the shell
 - SOURCENAME - "sox" or "av", more backends may be supported in the future
+- TIMESTAMP - a time stamp formatted in HH:MM:SS.FRAC (for seeking)
+- TRACKID - a unique unsigned integer in decimal (base-10) representing a
+            track in the tracklist
 - FILENAME - an expanded pathname relative to / is recommended since
              dtas-player and the client may run in different directories
 
@@ -161,7 +164,7 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
     + norm_level=FLOAT (1.0 == dBFS)
       Controls the level to normalize to when using album_norm or track_norm.
 
-* seek [+-]HH:MM:SS.FRAC - seek the current track to a specified time.
+* seek [+-]TIMESTAMP - seek the current track to a specified time.
   This is passed directly as the first argument for the sox(1) "trim"
   command.   See the sox(1) manpage for details.
   Seeking to a relative time is also supported by prefixing the time
@@ -211,6 +214,30 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
   users requiring fsync should open(2) that file and fsync(2) it
   themselves if necessary.
 
+* tl add FILENAME [TRACKID [BOOLEAN]] - add files to the tracklist
+  With one arg, adds FILENAME to the head of the tracklist.
+  If TRACKID is specified, FILENAME is added immediately after TRACKID
+  on the existing tracklist.  The final BOOLEAN argument replaces the
+  currently playing track with the newly-added one.
+  Returns the TRACKID of the newly added track
+
+* tl remove TRACKID - remove the track with the given TRACKID from
+  the track list
+
+* tl get [TRACKIDS]
+  returns a list of TRACKIDS mapped to filenames.
+
+* tl goto TRACKID [TIMESTAMP] - plays the given TRACKID
+  An optional timestamp may be added to prevent playing the
+  same part(s) repeated.y
+
+* 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.
+
+* tl tracks
+  returns a list of all TRACKIDS in the tracklist
+
 * watch - adds the client to the passive watch list for notifications.
   It is recommended clients issue no further commands and open
   another client socket to issue non-watch commands.

data/Documentation/dtas-splitfx.txt

@@ -0,0 +1,167 @@
+% dtas-splitfx(1) dtas user manual
+
+# NAME
+
+dtas-splitfx - split audio and apply effects to all tracks
+
+# SYNOPSIS
+
+dtas-splitfx SPLITFX_FILE.yml [OPTIONS] [TARGETS] [ARGS...]
+
+# DESCRIPTION
+
+dtas-splitfx reads as YAML file and can apply effects (including
+resampling/dither), split, tag, and encode files in parallel.
+dtas-splitfx is intended for splitting recordings from vinyl and live
+concerts into separate files.  dtas-splitfx is inspired by cuesheets for
+CD audio and the make(1) build tool.
+
+dtas-splitfx primarily uses sox(1), but it is possible to define targets
+to use ecasound(1), too.
+
+# OPTIONS
+
+-j, \--jobs [JOBS]
+:    Number of jobs to run in parallel.  If no number is specified, all
+     jobs are run in parallel.
+
+-n, \--dry-run
+:    Print, but do not run the commands to be executed
+
+-s, \--quiet, \--silent
+:    Silent operation, commands are not printed as executed
+
+# FILE FORMAT
+
+* infile - string, the pathname of the original audio file
+* env - hash of environment variables to set for all commands
+* comments - hash of common tags for all audio (e.g. ARTIST, ALBUM, YEAR)
+    comments:
+      ARTIST: John Smith
+      ALBUM: Hello World
+      YEAR: 2013
+* track_start - integer, number to start the track count at (default: 1)
+* cdda_align - boolean, enforce sector alignment for audio CDs (default: false)
+* track_zpad - boolean or integer.  Zero-pad the TRACKNUMBER in metadata and
+  filenames.  If an integer, this creates a fixed padding even if the
+  padding is not necessary.  If true, this only pads as needed for the
+  highest-numbered track (default: true)
+* tracks - array, see "TRACKS" section
+* targets - hash, see "TARGETS" section
+
+# TRACKS
+
+Tracks may be defined by a start time, with the stop time defined
+automatically by the start of the next track, stop time, or a skip
+segment.
+
+* t TIME TITLE [fade_in/fade_out=FADE_ARGS] - 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.
+* skip TIME - skip a segment starting at TIME.  "skip" segments are
+  useful for skipping long gaps between tracks (such as flipping vinyl
+  or intermission at concerts)
+* stop TIME - stop the last track  This should be the last directive in
+  the "tracks" array.
+
+An example of the tracks array for a 4 track EP follows:
+
+    tracks:
+      - t  0:21    "This is the first track of an EP" fade_in='t 1'
+      - t  7:11.6  "Second track of side A of an EP"
+      - skip 9:18  # this is where I flip the record, comments are allowed
+      - t  9:41    "3rd track of an EP"
+      - t 13:36.5  "Final track of the EP" fade_out='t 1'
+      - stop 18:11
+
+# FADES
+
+dtas-splitfx automatically sets up fade-in/fade-out effects for sox(1)
+based on track times.  These are to be used in "t" (track) directives in
+the "tracks" array:
+
+* fade_in="[TYPE] LENGTH"
+* fade_out="[TYPE] LENGTH"
+
+TYPE is optional, but LENGTH is required.  See sox(1) for a description
+of the fade type.
+
+# ENVIRONMENT
+
+dtas-splitfx sets several default environment variables for commands to
+use in targets:
+
+* INFILE - this matches the "infile" directive in the YAML file
+* TRIMFX - essential, this supplys the necessary sox(1) trim effect to
+  each track.
+* COMMENTS - expands to --comment-file=PATH for sox(1)
+* OUTFMT - sox(1) arguments for the output format (e.g. "-ts32 -c2 -r44100"
+* SUFFIX - the suffix of the output format without "." (e.g. "flac", "ogg")
+* TRACKNUMBER - the track number, useful for comments and filenames
+* RATEFX - rate effect and arguments for sox(1) resampling
+* DITHERFX - dither effect and arguments for sox(1) dithering
+
+# TARGETS
+
+The default targets will split audio and avoid applying any effects.
+They are named after common audio formats supported by sox(1):
+
+* flac
+* ogg
+* mp3
+* sox
+
+If not specified, "flac" is the default target.
+
+Additional targets supported by default.
+
+* flac-cdda - this encodes the audio to "flac" format while being
+  easily decompressible to a format suitable for being burned to audio CD.
+
+* opusenc - encodes to 16-bit, 48000 Hz Opus format using opusenc(1).
+  This uses sox(1) to dither/resample/apply effects as necessary.
+  This target exists as sox (as of v14.4.1) does not currently have
+  native opus encoding support.
+
+Custom targets may easily be defined to apply effects and gain.  For
+example, the following "flac24" target raises the volume of the left
+channel by 9.5dB and the right one by 8.5dB to compensate for channel
+imbalance in a live concert recording from the audience:
+
+    targets:
+      flac24:
+        command: sox -M
+          "|sox $INFILE -c1 -p $TRIMFX remix 1v1 vol +9.5dB"
+          "|sox $INFILE -c1 -p $TRIMFX remix 2v1 vol +8.5dB"
+          $COMMENTS $OUTFMT
+          bandYYYY-MM-DD.FOO.t0"$TRACKNUMBER.$SUFFIX"
+          $RATEFX $DITHERFX stats
+        format:
+          type: flac
+          bits: 24
+          rate: 48000
+
+For reference, the "opusenc" default target is implemented as follows:
+
+    targets:
+      opusenc:
+        command: sox "$INFILE" $COMMENTS $OUTFMT -
+           $TRIMFX $RATEFX $DITHERFX | opusenc --music
+           --raw-bits $BITS_PER_SAMPLE
+           $OPUSENC_BITRATE --raw-rate $RATE --raw-chan $CHANNELS
+           --raw-endianness $ENDIAN_OPUSENC
+           $OPUSENC_COMMENTS - $TRACKNUMBER.opus
+        format:
+          bits: 16
+          rate: 48000
+          type: s16
+          channels: 2
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
+
+# SEE ALSO
+
+sox(1), ecasound(1), flac(1), opusenc(1)

data/Documentation/dtas-tl.txt

@@ -0,0 +1,77 @@
+% dtas-tl(1) dtas user manual
+
+# NAME
+
+dtas-tl - tracklist manipulation for dtas-player (development)
+
+# SYNOPSYS
+
+dtas-tl [COMMANDS]
+
+# DESCRIPTION
+
+dtas-tl provides utility functions for manipulating the tracklist of the
+dtas-player (not the queue, the tracklist is separate from the queue).
+It is mainly intended as a development tool and will likely go away in
+the future or have its functionality merged into another tool (or MPRIS
+client).
+
+# COMMANDS
+
+* addhead - add multiple tracks to the beginning of the tracklist
+* addtail - add multiple tracks to the end of the tracklist
+* current - display the current track, "NONE" if not playing
+* current-id - display the TRACKID of the current track
+  "NONE" if not playing
+* cat - display a newline-delimited list of TRACK_ID=PATH output
+* clear - remove all tracks from the tracklist
+* 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.
+* reto REGEXP [POS] - play first track with path matching REGEXP immediately,
+optionally seek to POS.  POS should be a timestamp in HH:MM:SS.FRAC format.
+* next - play the next track in the tracklist
+* previous - play the previous track in the tracklist
+* repeat 1 - repeat the current track
+* repeat false - disable repeat
+* repeat true - enable repeat of the whole tracklist
+
+See dtas-player_protocol(7) for a detailed description of the protocol.
+
+# EXAMPLES
+
+display the current tracklist
+
+        $ dtas-tl cat
+
+to add an an entire directory of FLAC files
+
+        $ dtas-tl addtail /path/to/directory/*.flac
+
+to skip forward in the tracklist
+
+        $ dtas-tl next
+
+to skip backwards in the tracklist
+
+        $ dtas-tl previous
+
+# ENVIRONMENT
+
+DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
+This defaults to ~/.dtas/player.sock
+
+# CONTACT
+
+All feedback welcome via plain-text mail to <dtas-all@nongnu.org>\
+Mailing list archives available at <ftp://lists.gnu.org/dtas-all/>\
+No subscription is necessary to post to the mailing list.
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
+
+# SEE ALSO
+
+dtas-player(1), dtas-player_protocol(7), dtas-ctl(1)

data/GIT-VERSION-GEN

@@ -3,7 +3,7 @@
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 CONSTANT = "DTAS::VERSION"
 RVF = "lib/dtas/version.rb"
-DEF_VER = "v0.3.0"
+DEF_VER = "v0.4.0"
 vn = DEF_VER
 
 # First see if there is a version file (included in release tarballs),
@@ -27,4 +27,5 @@ cur_ruby_version = File.read(RVF) rescue nil
 if new_ruby_version != cur_ruby_version
   File.open(RVF, "w") { |fp| fp.write(new_ruby_version) }
 end
+File.chmod(0644, RVF)
 puts vn if $0 == __FILE__

data/GNUmakefile

@@ -13,7 +13,7 @@ test_units := $(wildcard test/test_*.rb)
 test: test-unit
 test-unit: $(test_units)
 $(test_units):
-	$(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS)
+	$(RUBY) -w -I $(lib) $@ $(RUBY_TEST_OPTS)
 
 check-warnings:
 	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \

data/README

@@ -11,6 +11,7 @@ Primary executables available are:
 
 * dtas-player - gapless music player (or pipeline/process manager :P)
 * dtas-cueedit - embedded cuesheet editor (FLAC-only for now)
+* dtas-splitfx - split audio and apply effects to all tracks
 
 The centerpiece is dtas-player, a gapless music player designed to aid
 in writing scripts for sox/ecasound use.  Unlike monolithic music
@@ -38,6 +39,7 @@ Users of dtas-player will also be interested in the following scripts:
 * dtas-sinkedit - edit sinks (playback targets) for dtas-player
 * dtas-sourceedit - edit source (decoder process parameters) for dtas-player
 * dtas-xdelay - alternative sink for dtas-player
+* dtas-tl - command-line helpers for tracklist functionality in dtas-player
 
 All scripts have some documentation in the Documentation/ directory or
 manpages distributed with the gem.  Documentation is also available on
@@ -50,7 +52,6 @@ Familiarity with the Ruby programming language is absolutely NOT required.
 Coming:
 
 * MPRIS/MPRIS 2.0 bridge for partial dtas-player control
-* tracklist support in dtas-player (maybe?)
 * whatever command-line tools come to mind...
 * better error handling, many bugfixes, etc...
 * better documentation

data/Rakefile

@@ -110,6 +110,13 @@ task tarball: "pkg/#{base}" do
   end
 end
 
+task "pkg/#{base}" => :fix_perms
+
+task :fix_perms do
+  sh "git ls-tree -r HEAD | awk '/^100644 / {print $NF}' | xargs chmod 644"
+  sh "git ls-tree -r HEAD | awk '/^100755 / {print $NF}' | xargs chmod 755"
+end
+
 task dist: [ :tarball, :package ] do
   Dir.chdir("pkg") do
     %w(dtas-linux dtas-mpris).each do |gem|

data/bin/dtas-console

@@ -39,6 +39,8 @@ tfmt = update_tfmt(prec_step[prec_nr])
 events = []
 interval = 1.0 / 10 ** prec_nr
 
+pause = nil
+
 def show_events(lineno, screen, events)
   Curses.setpos(lineno += 1, 0)
   Curses.clrtoeol
@@ -132,7 +134,7 @@ begin
     else
       Curses.setpos(lineno += 1, 0)
       Curses.clrtoeol
-      Curses.addstr(cur['paused'] ? 'paused' : 'idle')
+      Curses.addstr(cur['paused'] ? "paused #{pause}" : 'idle')
       Curses.setpos(lineno += 1, 0)
       Curses.clrtoeol
     end
@@ -153,6 +155,14 @@ begin
         Curses.clear
       when w
         event = w.res_wait
+        case event
+        when "pause"
+          if current
+            pause = current['infile'] || current['command']
+          end
+        when %r{\Afile }
+          pause = nil
+        end
         events << "#{Time.now.strftime(tfmt)} #{event}"
         # something happened, refresh current
         # we could be more intelligent here, maybe, but too much work.

data/bin/dtas-splitfx

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+require 'yaml'
+require 'optparse'
+require 'dtas/splitfx'
+usage = "#$0 [-n|--dry-run][-j [JOBS]][-s|--silent] SPLITFX_FILE.yml [TARGET]"
+overrides = {} # FIXME: not tested
+opts = { jobs: 1 }
+jobs = 1
+OptionParser.new('', 24, '  ') do |op|
+  op.banner = usage
+  op.on('-n', '--dry-run') { opts[:dryrun] = true }
+  op.on('-j', '--jobs [JOBS]', Integer) { |val| opts[:jobs] = val }
+  op.on('-s', '--quiet', '--silent') { |val| opts[:silent] = true }
+  op.parse!(ARGV)
+end
+
+args = []
+ARGV.each do |arg|
+  case arg
+  when %r{\A(\w+)=(.*)\z}
+    key, val = $1, $2
+    # only one that makes sense is infile=another_file
+    overrides[key] = YAML.load(val)
+  when %r{\A(\w+)\.(\w+)=(.*)\z}
+    # comments.ARTIST='blah'
+    top, key, val = $1, $2, $3
+    hsh = overrides[top] ||= {}
+    hsh[key] = val
+  else
+    args << arg
+  end
+end
+
+file = args.shift or abort usage
+target = args.shift || "flac"
+splitfx = DTAS::SplitFX.new
+splitfx.import(YAML.load(File.read(file)), overrides)
+splitfx.run(target, opts)