Add zmq buffer options to config file

1 files changed, 33 insertions, 12 deletions

diff --git a/doc/example.mux b/doc/example.mux
index 1dbec7d..26a231c 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -97,10 +97,6 @@ subchannels {
         type audio
         ; example file input
         inputfile "funk.mp2"
-        ; example zmq input:
-        ; accept connections to port 9001 from any interface
-        ; use toolame-dab as encoder
-        ;inputfile "tcp://*:9001"
         nonblock false
         bitrate 128
         id 10
@@ -119,24 +115,49 @@ subchannels {
         ; example file input
         ;inputfile "rick.dabp"
         ; example zmq input:
-        ; accept connections to port 9000 from any interface
-        ; use fdk-aac-dabplus-zmq as encoder
+        ; Accepts connections to port 9000 from any interface.
+        ; Use fdk-aac-dabplus as encoder
         inputfile "tcp://*:9000"
-        nonblock false
         bitrate 96
         id 1
         protection 1
+
+        ; ZMQ specific options, mandatory:
+
+        ; Maximum size of input buffer, in AAC frames (24ms)
+        ; when this buffer size is reached, some frames will be
+        ; discarded to get the size again below this value.
+        ; As the present implementation discards entire AAC superframes,
+        ; (5 frames = 120ms) the effect will clearly be audible.
+        zmq-buffer 40
+
+        ; At startup or after an underrun, the buffer is filled to this
+        ; amount of AAC frames before streaming starts.
+        zmq-prebuffering 20
+
+        ; In an ideal scenario, where the input rate exactly corresponds
+        ; to the rate at which the frames are consumed by dabmux, you
+        ; see the buffer level staying around the zmq-prebuffering value.
+        ; Network latency jitter can make it temporarily go lower or higher.
+        ; Encoder clock drift will make the buffer either slowly fill or
+        ; empty, which will create intermittent glitches.
     }
 
     sub-ri2 {
-        type dabplus
-        ; for dabplus types, you can use the ZeroMQ input (if compiled in)
-        ; with the following configuration:
-        inputfile "tcp://localhost:9000"
-        nonblock false
+        type audio
+        ; for audio types, you can use the ZeroMQ input (if compiled in)
+        ; with the following configuration in combination with
+        ; toolame-dab
+        ;
+        ; Support for toolame-dab is not as good as with fdk-aac-dabplus
+        inputfile "tcp://*:9001"
         bitrate 96
         id 1
         protection 1
+
+        ; The options are the same as for dabplus
+        zmq-buffer 40
+        zmq-prebuffering 20
     }
 }