about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/dtas-player.txt29
-rw-r--r--Documentation/dtas-player_sink_examples.txt19
-rw-r--r--Documentation/troubleshooting.txt18
3 files changed, 34 insertions, 32 deletions
diff --git a/Documentation/dtas-player.txt b/Documentation/dtas-player.txt
index 0ec52c3..303bc90 100644
--- a/Documentation/dtas-player.txt
+++ b/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
 
@@ -112,4 +113,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)
diff --git a/Documentation/dtas-player_sink_examples.txt b/Documentation/dtas-player_sink_examples.txt
index cb85aa8..0aceb89 100644
--- a/Documentation/dtas-player_sink_examples.txt
+++ b/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,6 +46,21 @@ 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.
+
 # COPYRIGHT
 
 Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.\
diff --git a/Documentation/troubleshooting.txt b/Documentation/troubleshooting.txt
deleted file mode 100644
index 60fb68f..0000000
--- a/Documentation/troubleshooting.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-dtas-player troubleshooting guide
----------------------------------
-
-dtas-player is heavily dependent on external commands such as sox(1)/play(1)
-and ecasound(1).
-
-* problem: audio playback does not start
-
-  Since dtas-player just runs the play(1) command, the first step is to
-  ensure play(1) works without dtas-player.
-
-  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>