dtas 0.1.I → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1f118957182ff09d25d1da7f0ae4fda9c867e21
-  data.tar.gz: a42b9ef9d642cd13bb32a24cf2571a315acb8842
+  metadata.gz: 8e9e5176fd82702d4703c039551671370972414c
+  data.tar.gz: 0a750d4c6b91e37f2abce38b09e89a01cfd3cc7c
 SHA512:
-  metadata.gz: 2becf89b867d7183a554c00eed34cf1a8a5f468b051173e072894072b3711fb4c5df40cb2d551c7bf07501fe55e82ac2a3922f93a286ab889fb7cdb853c78974
-  data.tar.gz: 6898c1eb14d91ea620f306abec3620c42258ec3d964d40fdd382ec74590cc81b955012047dd8748d88989b9e62a25de3d35f71c175a0ae7985f9aeb084c084ee
+  metadata.gz: b3d5105bf83ec844c6f26c039b463e9f15440301bf775b085a37b5d3ef30f1cd17752b50fbcd5f31089d072a60c885170d6889519f25893f8373e3ca98b6df04
+  data.tar.gz: c3f9423b2ba17cb6625896c66cbdaa53ec974cd032b33e263d6bd4c3a7f0ecfaa1aab8fcecd1b684e58f5f7bcf3051d2dd371637f841feb50660986e83aef571

data/.gitignore

@@ -1,3 +1,5 @@
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 /Manifest.txt
 /NEWS
 /pkg

data/Documentation/.gitignore

@@ -1,3 +1,5 @@
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 *.1
 *.5
 *.7

data/Documentation/GNUmakefile

@@ -1,33 +1,37 @@
+# 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::
 
+INSTALL = install
 PANDOC = pandoc
 PANDOC_OPTS = -f markdown --email-obfuscation=none
 pandoc = $(PANDOC) $(PANDOC_OPTS)
 
-ones =
-ones += dtas-console
-ones += dtas-ctl
-ones += dtas-enq
-ones += dtas-msinkctl
-ones += dtas-player
-ones += dtas-xdelay
-ones += dtas-sinkedit
-ones += dtas-sourceedit
+m1 =
+m1 += dtas-console
+m1 += dtas-ctl
+m1 += dtas-enq
+m1 += dtas-msinkctl
+m1 += dtas-player
+m1 += dtas-xdelay
+m1 += dtas-sinkedit
+m1 += dtas-sourceedit
+
+m7 =
+m7 += dtas-player_protocol
+m7 += dtas-player_sink_examples
 
-man1 := $(addsuffix .1, $(ones))
-man7 := $(addsuffix .7,dtas-player_protocol)
+man1 := $(addsuffix .1, $(m1))
+man7 := $(addsuffix .7, $(m7))
 
 all:: man
 
 man: $(man1) $(man7)
 
-prefix?=$(HOME)
-mandir?=$(prefix)/share/man
-man1dir=$(mandir)/man1
-man5dir=$(mandir)/man5
-man7dir=$(mandir)/man7
-
-INSTALL = install
+prefix ?= $(HOME)
+mandir ?= $(prefix)/share/man
+man1dir = $(mandir)/man1
+man7dir = $(mandir)/man7
 
 gem-man: man
 	$(INSTALL) -d -m 755 ../man

data/Documentation/dtas-console.txt

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

data/Documentation/dtas-ctl.txt

@@ -58,6 +58,11 @@ of $SOXFMT (see dtas-player_protocol(7)).
 DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
 This defaults to ~/.dtas/player.sock
 
+# 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-enq(1), dtas-sinkedit(1),

data/Documentation/dtas-cueedit.txt

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

data/Documentation/dtas-enq.txt

@@ -24,6 +24,11 @@ newly enqueued files in the order given.
 DTAS_PLAYER_SOCK - the path to the dtas-player listen socket.
 This defaults to ~/.dtas/player.sock
 
+# 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-ctl(1)

data/Documentation/dtas-msinkctl.txt

@@ -40,6 +40,11 @@ Remove SINK3 from the active set
 DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
 This defaults to ~/.dtas/player.sock
 
+# 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), dtas-sinkedit(1)

data/Documentation/dtas-player.txt

@@ -104,6 +104,11 @@ exist in the source file:
 ~/.dtas/player_state.yml is a human-readable YAML file used to preserve
 state across restarts of dtas-player.
 
+# 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_protocol(7), dtas-ctl(1), dtas-enq(1), dtas-sourceedit(1),

data/Documentation/dtas-player_effects.txt

@@ -43,3 +43,8 @@ They are applied in the order described.
   - rate
   - dither
   - remix (static channel mappings)
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>

data/Documentation/dtas-player_protocol.txt

@@ -7,6 +7,25 @@ dtas-player_protocol - protocol for controling dtas-player
 
 # DESCRIPTION
 
+NOTE - NOTE - NOTE - NOTE - NOTE - NOTE - NOTE - NOTE
+
+I'm considering a heavy revamp of this protocol.  The "OK" responses for
+a lot of commands may not be necessary since this is Unix sockets and
+not TCP, and I may move away from a request-response model and towards
+an entirely listen/notification model.  I have little experience in
+non-TCP-based application protocols, so this is an area of
+experimentation for me.
+
+This must stay over Unix sockets because filesystem permissions are
+needed to enforce code execution permissions.  dtas-player is really a
+shell in disguise, after all.
+
+Protocol feedback greatly appreciated email me at
+
+normalperson@yhbt.net
+
+*********************************************************
+
 This gives a specification of the dtas-player protocol over a local Unix
 SOCK_SEQPACKET socket.  The dtas-player protocol should NOT be
 considered stable at this point and compatibility will break.
@@ -51,6 +70,8 @@ For little-endian machines, $ECAFMT defaults to: -fs32_le,2,44100
 
 # COMMANDS
 
+Commands here should be alphabetized according to `LC_ALL=C sort'
+
 * cd - change the current working directory of the player
 
 * clear - clear current queue (current track/command continues running)
@@ -168,7 +189,7 @@ For little-endian machines, $ECAFMT defaults to: -fs32_le,2,44100
     + nonblock=BOOLEAN - drop audio data to avoid holding back other sinks
     + pipe_size=UNSIGNED - set the size of the pipe for the sink (Linux-only)
 
-* source SOURCENAME cat - dump the current source command and env in YAML
+* source cat SOURCENAME - dump the current source command and env in YAML
 
 * source ed SOURCENAME SOURCEARGS - edit the source parameters.
   This changes here will immediately restart the source process.
@@ -177,7 +198,16 @@ For little-endian machines, $ECAFMT defaults to: -fs32_le,2,44100
     + env.ENVNAME=ENVVALUE - set ENVNAME to ENVVALUE for the source process
     + env#ENVNAME - unset ENVNAME in the source process (only)
     + tryorder=INTEGER - lower values are tried first
+    PENDING: tryorder here is wrong and may be removed or changed.
+    We need to account for at least two variables input file:
+        1. input type (flac/opus/mp3/etc)
+        2. transport protocol (local FS/http/ftp/sftp/etc)
 
 * 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.
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>

data/Documentation/dtas-player_sink_examples.txt

@@ -0,0 +1,51 @@
+% dtas-player_sink_examples(7) dtas user manual
+
+# NAME
+
+dtas-player_sink_examples - sink examples for dtas-player
+
+# SYNOPSIS
+
+dtas-ctl sink ed SINKNAME command='...'
+dtas-sinkedit SINKNAME
+
+# EXAMPLES
+
+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.
+
+    # set HOST/PORT/PASS via env or directly in the command
+    ---
+    name: oggfwd
+    command: sox $SOXFMT - -t ogg - | oggfwd $HOST $PORT $PASS /dtas.ogg
+
+Alternatively, if you have play(1) installed on any remote host and
+a slow connection using Ogg-Vorbis:
+
+    # Long lines in YAML can be broken up and the subsequent lines
+    # indented with by spaces
+    ---
+    name: ssh-remote
+    command: sox $SOXFMT - -t ogg - |
+      ssh $HOST env AUDIODEV=... play -q -t ogg -
+
+    # Note the use of env(1), as the "env" parameter for the sink may not be
+    # passed via ssh to the remote $HOST depending on the ssh_config(5)
+    # configuration.
+
+If you have a fast connection, there is no need to encode using
+Ogg-Vorbis.  Alternatively, you may also use "flac" instead of "ogg" in
+the above Ogg-Vorbis example.
+
+    ---
+    name: ssh-remote
+    command: ssh $HOST env AUDIODEV=... play -q $SOXFMT -
+
+# 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), play(1), oggfwd(1), ssh(1), ssh_config(5), env(1)

data/Documentation/dtas-sinkedit.txt

@@ -36,6 +36,11 @@ 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
 
+# 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/Documentation/dtas-sourceedit.txt

@@ -35,6 +35,11 @@ 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
 
+# 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/Documentation/dtas-xdelay.txt

@@ -52,6 +52,11 @@ 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)
 
+# 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), sox(1)

data/Documentation/troubleshooting.txt

@@ -11,3 +11,8 @@ and ecasound(1).
 
   Consult SoX documentation and mailing lists for getting play(1) to work,
   first.
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>

data/GIT-VERSION-GEN

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
-# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net>
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
 CONSTANT = "DTAS::VERSION"
 RVF = "lib/dtas/version.rb"
-DEF_VER = "v0.1.I"
+DEF_VER = "v0.2.0"
 vn = DEF_VER
 
 # First see if there is a version file (included in release tarballs),

data/GNUmakefile

@@ -1,3 +1,5 @@
+# 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
 

data/HACKING

@@ -10,3 +10,8 @@ serialization (dtas-player)
 
 * we avoid serializing default values to make the state file shorter and
   more suitable for human viewing and editing.
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>

data/INSTALL

@@ -17,37 +17,42 @@ Debian users can install sox, mp3gain, and flac dependencies easily:
 
   apt-get install sox libsox-fmt-all mp3gain flac
 
-= installing dtas RubyGem on GNU/Linux (Linux kernel 2.6.32+)
+# 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"
+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"
 
-    gem install dtas-linux
+        gem install dtas-linux
 
-  This should pull in the "io_splice" and "sleepy_penguin" RubyGems
+This should pull in the "io_splice" and "sleepy_penguin" RubyGems
 
-  For future upgrades of dtas (upgrades to dtas-linux will be infrequent)
+For future upgrades of dtas (upgrades to dtas-linux will be infrequent)
 
-    gem update dtas
+        gem update dtas
 
-= installing the dtas RubyGem on non-GNU/Linux or old GNU/Linux systems
+# installing the dtas RubyGem on non-GNU/Linux or old GNU/Linux systems
 
-  gem install dtas
+        gem install dtas
 
-= installing dtas via tarball and setup.rb
+# installing dtas via tarball and setup.rb
 
-  Grab the latest tarball from our HTTP site:
+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.1.I.tar.gz
 
-  $ tar zxvf dtas-0.1.I.tar.gz
-  $ cd dtas-0.1.I
-  $ ruby setup.rb
+        $ tar zxvf dtas-0.1.I.tar.gz
+        $ cd dtas-0.1.I
+        $ ruby setup.rb
 
-  GNU/Linux users may optionally install "io_splice" and
-  "sleepy_penguin" packages:
+GNU/Linux users may optionally install "io_splice" and
+"sleepy_penguin" packages:
 
-  io_splice - http://bogomips.org/ruby_io_splice/
-  sleepy_penguin - http://bogomips.org/sleepy_penguin/
+    * io_splice - http://bogomips.org/ruby_io_splice/
+    * sleepy_penguin - http://bogomips.org/sleepy_penguin/
+
+# COPYRIGHT
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>

data/README

@@ -1,4 +1,4 @@
-= dtas - duct tape audio suite for *nix
+# dtas - duct tape audio suite for *nix
 
 Free Software command-line tools for audio playback, mastering, and
 whatever else related to audio.  dtas follows the worse-is-better
@@ -55,7 +55,7 @@ Coming:
 * better error handling, many bugfixes, etc...
 * better documentation
 
-== Source code
+## Source code
 
   git clone git://80x24.org/dtas
 
@@ -66,16 +66,16 @@ with git(7)) and send them via email.
 
 See http://www.git-scm.com/ for more information on git.
 
-== Contact
+## Contact
 
 Feedback (results, bug reports, patches, pull-requests) via plain-text
 email is very much appreciated.
 
-Please send plain-text email to Eric Wong <normalperson@yhbt.net>,
+Please send plain-text email to Eric Wong <normalperson@yhbt.net>.
 HTML will not be read.  dtas is for GUI-phobes, by GUI-phobes.
 Public mailing list coming soon.
 
-== License
+## Copyright
 
 dtas is copyrighted Free Software by all contributors, see logs
 in revision control for names and email addresses of all of them.