Add a section about the new frame analyzer.

[nageru-docs] / gettingstarted.rst

diff --git a/gettingstarted.rst b/gettingstarted.rst
index 68edc81605f53f7e8ab53412c9d72514cf6100d4..c6ce91d5941cab74c550b1f9470703a63faf05de 100644 (file)
--- a/gettingstarted.rst
+++ b/gettingstarted.rst
@@ -123,6 +123,8 @@ The video menu contains the following elements:
     You can achieve the same effect as this option by sending
     SIGHUP to the Nageru process.
 
     You can achieve the same effect as this option by sending
     SIGHUP to the Nageru process.
 

+  * **Open frame analyzer:** See :doc:`analyzer` for more information.
+

   * **Change x264 bitrate:** See :doc:`streaming` for more information.
 
   * **HDMI/SDI output device, HDMI/SDI output resolution:** See :doc:`hdmisdi`
   * **Change x264 bitrate:** See :doc:`streaming` for more information.
 
   * **HDMI/SDI output device, HDMI/SDI output resolution:** See :doc:`hdmisdi`


@@ -172,6 +174,16 @@ The options presented are as follows:
    cards that can handle it in hardware), but a simple option (“Scan”)
    is available to try all modes in turn until a signal is received.
 
    cards that can handle it in hardware), but a simple option (“Scan”)
    is available to try all modes in turn until a signal is received.
 

+ * **Input interpretation:** Choose how the Y'CbCr values in the input signal
+   are to be interpreted. *Auto* will choose whatever is correct (as per the
+   appropriate standards) for the current video mode, but occasionally,
+   devices will get this wrong, and you will need to change this setting
+   to get correct colors. You can use the *--input-ycbcr-interpretation=*
+   command-line option to achieve the same effect.
+
+   See :doc:`analyzer` for figuring out if you need to change this.
+   If unsure, leave it unchanged.
+

  * **Use as audio source:** See the :doc:`audio <audio>` page for more
    information. For simple audio only; unavailable in multichannel mode.
 
  * **Use as audio source:** See the :doc:`audio <audio>` page for more
    information. For simple audio only; unavailable in multichannel mode.