dtas 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e9e5176fd82702d4703c039551671370972414c
-  data.tar.gz: 0a750d4c6b91e37f2abce38b09e89a01cfd3cc7c
+  metadata.gz: 5583678ac4bac1a9255750144a74b243f6344f47
+  data.tar.gz: 7635bf1345477bc6ff1ca269be15f79090de639c
 SHA512:
-  metadata.gz: b3d5105bf83ec844c6f26c039b463e9f15440301bf775b085a37b5d3ef30f1cd17752b50fbcd5f31089d072a60c885170d6889519f25893f8373e3ca98b6df04
-  data.tar.gz: c3f9423b2ba17cb6625896c66cbdaa53ec974cd032b33e263d6bd4c3a7f0ecfaa1aab8fcecd1b684e58f5f7bcf3051d2dd371637f841feb50660986e83aef571
+  metadata.gz: 15424a207857ad4b102b109c02890db06337a3772ea071230bd6e40fee9da4d64e2c5c1666ba95878d8015b9021f31629a76c38585a37648e60d02cc42a4127d
+  data.tar.gz: bfec766d9470d8d0a09f3b7b8d2db33f748de0086d5362923c9aaf773e6cb8dcc773438ec0949ec5fc3c12eb3ac808fc471faae7931994fd29e64fbfba9fd665

data/Documentation/dtas-console.txt

@@ -51,6 +51,12 @@ dtas-console will also increase contention with the sound card,
 negatively affecting audio quality even if CPU utilization is not
 a problem.
 
+# 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.\

data/Documentation/dtas-ctl.txt

@@ -58,6 +58,12 @@ of $SOXFMT (see dtas-player_protocol(7)).
 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.\

data/Documentation/dtas-cueedit.txt

@@ -19,6 +19,12 @@ Use with the metaflac(1) is required.
 
 VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset.
 
+# 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.\

data/Documentation/dtas-enq.txt

@@ -24,6 +24,12 @@ newly enqueued files in the order given.
 DTAS_PLAYER_SOCK - the path to the dtas-player listen 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.\

data/Documentation/dtas-msinkctl.txt

@@ -40,6 +40,12 @@ Remove SINK3 from the active set
 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.\

data/Documentation/dtas-player.txt

@@ -53,10 +53,13 @@ created and playing the audio.
 
 # TROUBLESHOOTING
 
+## Audio playback does not start
+
 The most common problem with dtas-player is the play(1) command
-(distributed with SoX) not using the correct audio device.  Ensuring the
-play(1) command works with dtas-player is important.  See the play(1)
-documentation for details.
+(distributed with SoX) not using the correct audio device/driver.
+Ensuring the play(1) command works with dtas-player is important.
+Consult SoX documentation and mailing lists for getting play(1) to work,
+first.
 
 Once you find the correct AUDIODEV/AUDIODRIVER environment variables,
 you may set them via dtas-ctl(1):
@@ -65,20 +68,18 @@ To play audio on my favorite USB DAC directly to ALSA, I use:
 
     $ dtas-ctl sink ed default env.AUDIODEV=hw:DAC env.AUDIODRIVER=alsa
 
-# ADVANCED EXAMPLES
-
-To configure a dumper sink (in addition to the "default" sink).  Note
-the use of $SOXFMT, this will be automatically expanded to match the
-internal format of the player.  The internal format of the player is
-described in dtas-player_protocol(7).
+## Seeking/playing audio from large video containers (e.g. VOB) fails
 
-    $ dtas-ctl sink ed dumper command='sox $SOXFMT - /tmp/dump.sox'
+This is a problem with large VOBs.  We recommend breaking up the
+VOB into smaller files or using avconv(1) or ffmpeg(1) to extract
+the desired audio stream.
 
-Non-"default" sinks are not active by default, but may be made active.
+      avconv -analyzeduration 2G -probesize 2G \
+        -i input.vob -vn -sn -c:a copy -map 0:$STREAM_NR output.ext
 
-    $ dtas-ctl sink ed dumper active=true
+# ADVANCED EXAMPLES
 
-Changing it again to "active=false" will deactivate the sink.
+See dtas_player-sink_examples(7) for more sink examples.
 
 # ENVIRONMENT
 
@@ -104,6 +105,12 @@ exist in the source file:
 ~/.dtas/player_state.yml is a human-readable YAML file used to preserve
 state across restarts of dtas-player.
 
+# 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.\
@@ -112,4 +119,4 @@ License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
 # SEE ALSO
 
 dtas-player_protocol(7), dtas-ctl(1), dtas-enq(1), dtas-sourceedit(1),
-dtas-sinkedit(1), sox(1), play(1), screen(1), tmux(1)
+dtas-sinkedit(1), sox(1), play(1), avconv(1), ffmpeg(1), screen(1), tmux(1)

data/Documentation/dtas-player_effects.txt

@@ -44,6 +44,12 @@ They are applied in the order described.
   - dither
   - remix (static channel mappings)
 
+# 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.\

data/Documentation/dtas-player_protocol.txt

@@ -203,10 +203,24 @@ Commands here should be alphabetized according to `LC_ALL=C sort'
         1. input type (flac/opus/mp3/etc)
         2. transport protocol (local FS/http/ftp/sftp/etc)
 
+* state dump [FILENAME]
+  Immediately dump the state of the player.  If a FILENAME is specified,
+  the state is written to that file.  Otherwise, the default state file
+  (configured via DTAS_PLAYER_STATE environment variable, defaulting
+  to ~/.dtas/player_state.yml) is written to.  This does not use fsync(2),
+  users requiring fsync should open(2) that file and fsync(2) it
+  themselves if necessary.
+
 * 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.
 
+# 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.\

data/Documentation/dtas-player_sink_examples.txt

@@ -11,6 +11,8 @@ dtas-sinkedit SINKNAME
 
 # EXAMPLES
 
+## Streaming Ogg-Vorbis to Icecast
+
 To use oggfwd(1) and Icecast, the following sink works.
 Warning: the following example will likely expose your Icecast source
 password to any local users on the system.
@@ -20,6 +22,8 @@ password to any local users on the system.
     name: oggfwd
     command: sox $SOXFMT - -t ogg - | oggfwd $HOST $PORT $PASS /dtas.ogg
 
+## Stream to a remote host via ssh
+
 Alternatively, if you have play(1) installed on any remote host and
 a slow connection using Ogg-Vorbis:
 
@@ -42,10 +46,36 @@ the above Ogg-Vorbis example.
     name: ssh-remote
     command: ssh $HOST env AUDIODEV=... play -q $SOXFMT -
 
+## Dump audio to a file during playback
+
+To configure a dumper sink (in addition to the "default" sink).  Note
+the use of $SOXFMT, this will be automatically expanded to match the
+internal format of the player.  The internal format of the player is
+described in dtas-player_protocol(7).
+
+    $ dtas-ctl sink ed dumper command='sox $SOXFMT - /tmp/dump.sox'
+
+Non-"default" sinks are not active by default, but may be made active.
+
+    $ dtas-ctl sink ed dumper active=true
+
+Changing it again to "active=false" will deactivate the sink.
+
+## Apply a short delay to low frequencies to improve time-alignment
+
+See dtas-xdelay(1).
+
+# 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-ctl(1), dtas-sinkedit(1), dtas-xdelay(1),
 sox(1), play(1), oggfwd(1), ssh(1), ssh_config(5), env(1)

data/Documentation/dtas-sinkedit.txt

@@ -36,6 +36,12 @@ VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset.
 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.\

data/Documentation/dtas-sourceedit.txt

@@ -12,7 +12,10 @@ dtas-sourceedit {sox | av | ff}
 # DESCRIPTION
 
 dtas-sourceedit spawns an editor to allow editing of a source as a YAML file.
-See dtas-player_protocol(7) for details on SOURCEARGS.
+See dtas-player_protocol(7) for details on SOURCEARGS.  If standard input is
+a pipe or file, it is parsed as YAML and fed to the dtas-player(1) instance
+non-interactively.  This is useful for loading various profiles from the
+filesystem.
 
 # EXAMPLES
 
@@ -20,6 +23,11 @@ Invoking dtas-sourceedit will spawn your favorite text editor on "sox":
 
 	$ dtas-sourceedit sox
 
+To load an existing YAML profile for sox.  saved.yml could be the output
+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
@@ -35,6 +43,12 @@ VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset.
 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.\

data/Documentation/dtas-xdelay.txt

@@ -40,17 +40,30 @@ To set this via dtas-player to delay the high frequencies by 20ms.
 
 # ENVIRONMENT
 
-SOXFMT - this environment is automatically set if used as a dtas-player
-sink
+SOXFMT, CHANNELS - these environment variables are automatically set if
+used as a dtas-player sink
 
 DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
 This defaults to ~/.dtas/player.sock
 
+AUDIODEV, AUDIODRIVER - these influence the device/driver used by play(1)
+Consult play(1) for details.
+
+SOX_OPTS - this influences options passed to sox(1) or play(1)
+Consult sox(1) for details.
+
 # NOTES
 
-The author of this knows little about signal processing and is just
-parroting things he's learned on the sox documentation and mailing list.
-Corrections greatly appreciated (email Eric Wong e@80x24.org)
+The author of this (Eric Wong) knows little about signal processing and
+is just parroting things he's learned on the sox documentation and
+mailing list.  Corrections to the <dtas-all@nongnu.org> mailing list are
+greatly appreciated.
+
+# 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
 
@@ -59,4 +72,4 @@ 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), sox(1)
+dtas-player(1), dtas-player_protocol(7), dtas-ctl(1), sox(1), play(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.2.0"
+DEF_VER = "v0.3.0"
 vn = DEF_VER
 
 # First see if there is a version file (included in release tarballs),

data/GNUmakefile

@@ -1,7 +1,23 @@
 # Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 all::
-include pkg.mk
+
+RUBY = ruby
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+	@./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
+lib := lib
+
+all:: test
+test_units := $(wildcard test/test_*.rb)
+test: test-unit
+test-unit: $(test_units)
+$(test_units):
+	$(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS)
+
+check-warnings:
+	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
+	  do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || :
 
 check: test
 coverage: export COVERAGE=1
@@ -9,3 +25,6 @@ coverage:
 	> coverage.dump
 	$(MAKE) check
 	$(RUBY) ./test/covshow.rb
+
+.PHONY: all .FORCE-GIT-VERSION-FILE test $(test_units)
+.PHONY: check-warnings

data/HACKING

@@ -11,6 +11,15 @@ serialization (dtas-player)
 * we avoid serializing default values to make the state file shorter and
   more suitable for human viewing and editing.
 
+# CONTACT
+
+We use git(7) and develop dtas on a public mailing list like git
+developers do.  Please send patches via git-send-email(1) to the public
+mailing list at <dtas-all@nongnu.org>.  Pull requests should be
+formatted using git-request-pull(1).\
+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.\

data/INSTALL

@@ -13,38 +13,38 @@ mp3gain is required if you use ReplayGain with MP3s
 If you only intend to use dtas-cueedit, you will need metaflac(1) from
 the FLAC package.
 
-Debian users can install sox, mp3gain, and flac dependencies easily:
+Debian 7 users can install dependencies easily:
 
-  apt-get install sox libsox-fmt-all mp3gain flac
+    sudo apt-get install sox libsox-fmt-all mp3gain flac ruby-dev
 
 # installing dtas RubyGem on GNU/Linux (Linux kernel 2.6.32+)
 
 Be sure to have Ruby development headers and a working C compiler.
 This will pull in the io_splice and sleepy_penguin RubyGems for minor
 speedups.  If you cannot be bothered to have a development
-environment, just use "gem install dtas"
+environment, just use "gem install dtas".
 
-        gem install dtas-linux
+    sudo gem install dtas-linux
 
 This should pull in the "io_splice" and "sleepy_penguin" RubyGems
 
 For future upgrades of dtas (upgrades to dtas-linux will be infrequent)
 
-        gem update dtas
+    sudo gem update dtas
 
 # installing the dtas RubyGem on non-GNU/Linux or old GNU/Linux systems
 
-        gem install dtas
+    sudo gem install dtas
 
 # installing dtas via tarball and setup.rb
 
 Grab the latest tarball from our HTTP site:
 
-        http://dtas.80x24.org/2013/dtas-0.1.I.tar.gz
+    http://dtas.80x24.org/2013/dtas-0.3.0.tar.gz
 
-        $ tar zxvf dtas-0.1.I.tar.gz
-        $ cd dtas-0.1.I
-        $ ruby setup.rb
+    $ tar zxvf dtas-0.3.0.tar.gz
+    $ cd dtas-0.3.0
+    $ sudo ruby setup.rb
 
 GNU/Linux users may optionally install "io_splice" and
 "sleepy_penguin" packages:
@@ -52,6 +52,13 @@ GNU/Linux users may optionally install "io_splice" and
     * io_splice - http://bogomips.org/ruby_io_splice/
     * sleepy_penguin - http://bogomips.org/sleepy_penguin/
 
+# CONTACT
+
+Please do not hesitate to send plain-text mail to <dtas-all@nongnu.org>
+regarding installation and to share your notes/experiences.
+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.\