Document unsynchronized HDMI/SDI output.

[nageru-docs] / futatabi.rst

diff --git a/futatabi.rst b/futatabi.rst
index 28b0954fd08ad8bf2775a36cfb6aee6e75c747b3..a16d3922fb35224cd86f54435908677e9d2ad8ae 100644 (file)
--- a/futatabi.rst
+++ b/futatabi.rst
@@ -25,8 +25,7 @@ by Kroeger et al, together with about half of the algorithm from
 optical flow), although this may change in the future.
 
 Since Futatabi is part of the Nageru source distribution, its version number
-mirrors Nageru. Thus, the first version of Futatabi is version 1.8.0,
-which is the Nageru version when it was first introduced.
+mirrors Nageru.
 
 
 System requirements
@@ -56,7 +55,7 @@ input or output. Assuming you have a recent version of Nageru (typically one
 that comes with Futatabi), it is capable of sending all of its cameras as one
 video stream (see :ref:`futatabiformat`), so you can start Futatabi with
 
-  ./futatabi http://nageru-server.example.org/multicam.mp4
+  ./futatabi http://nageru-server.example.org:9095/multicam.mp4
 
 If you do not have a running Nageru installation, see :ref:`sampledata`.
 
@@ -189,6 +188,27 @@ out, but it doesn't hurt to give a warning up-front. The producer might also
 be able to request replays of specific events, or ask you to save something
 for later if they can't show it right now (e.g. a foul situation that wasn't called).
 
+Audio support
+'''''''''''''
+
+Futatabi has limited audio support. It is recorded and saved for all inputs,
+and played back when showing a replay, but only when the replay speed is at
+100%, or very close to it. (At other speeds, you will get silence.)
+Furthermore, there is no local audio output; the Futatabi operator will not
+hear any audio, unless they use a video player into the Futatabi stream locally
+(with associated delay). All of this may change in the future.
+
+
+White balance
+'''''''''''''
+
+Futatabi integrates with Nageru for white balance;
+the white balance set in Nageru will be recorded, and properly applied on
+playback (including fades). Note that this assumes you are using the built-in
+white balance adjustment, not adding WhiteBalanceEffect manually
+to the scene; see :ref:`white-balance` for an example.
+
+
 Replay workflows
 ----------------
 
@@ -220,8 +240,7 @@ command line using *--cue-in-point-padding* and *--cue-out-point-padding*, or se
 cue in point padding to e.g. two seconds, the cue-in point will automatically be set
 two seconds ago when you cue-in, and similarly, if you set cue out point padding,
 the cue-out point will be set two seconds
-into the future when you cue-out. (Cue-in and cue-out point padding were one
-joint setting before Futatabi 1.8.3.)
+into the future when you cue-out.
 
 
 Instant clips
@@ -229,7 +248,7 @@ Instant clips
 
 Like the previous section explained how you generally would know the *start*
 of an interesting event (at least if discarding most of the candidates),
-you would be even more sure about the *end* of one. Thus, you can simply wait
+you would be even more sure about the *end* of one. Thus, you can wait
 until something interesting has happened, and then click cue-in immediately
 followed by cue-out. This will give you a clip of near zero length, ending
 at the right point. Then, edit this clip to set the starting point as needed,
@@ -256,9 +275,9 @@ they will certainly be watchable.
 
 There are two files:
 
- * `Trøndisk 2018, semifinal only (MJPEG, 77 GB) <https://storage.sesse.net/trondisk2018-semifinal-multicam-mjpeg.mkv>`_:
-   One of the semifinals, in MJPEG format (about 30 minutes). This can be downloaded
-   and then fed directly to Nageru as if it were a real camera stream
+ * `Trøndisk 2018, final only (MJPEG, 126 GB) <https://storage.sesse.net/trondisk2018-final-multicam-mjpeg.mkv>`_:
+   The final match, in MJPEG format (about 73 minutes). This can be downloaded
+   and then fed directly to Futatabi as if it were a real camera stream
    (remember the --slow-down-input option).
  * `Trøndisk 2018, entire tournament (H.264, 74 GB) <https://storage.sesse.net/trondisk2018-multicam-h264.mp4>`_:
    The entire first part of the tournament,
@@ -312,10 +331,14 @@ In particular:
     the actual RGB color space; Nageru assumes it is Rec. 709, like for capture
     cards, but the differences between 601 and 709 here are small. sRGB gamma
     is assumed throughout, like in JFIF.)
+  * The white balance (gray point) is stored in a minimal EXIF header,
+    and echoed back for original and interpolated frames. (During fades, Futatabi
+    applies white balance itself, and does not require gray point adjustment
+    from the client.)
 
 Many players may also be confused by the fact that the resolution can change
 from frame to frame; this is because for original (uninterpolated) frames,
-Futatabi will simply output the received JPEG frame directly to the output
+Futatabi will output the received JPEG frame directly to the output
 stream, which can be a different resolution from the interpolated frames.
 
 Also, even though Futatabi exists to make a fixed-framerate stream out of