git.sesse.net Git - nageru-docs/blob - gettingstarted.rst

   1 Getting started
   2 ===============
   3
   4 Welcome to Nageru! For simple use, you can jump right in and make yourself
   5 comfortable (at least if you have the :doc:`hardware requirements <hardware>`
   6 in place), but if you prefer a gentler introduction, this is the place.
   7
   8
   9 Introduction to the M/E workflow
  10 --------------------------------
  11
  12 Nageru, like most hardware video mixers, is based on the **mixer/effects**
  13 workflow, or just M/E for short. (Don't ask why “mixer” or “effects”;
  14 the name is confusing and mostly historical.)
  15
  16 The basic idea of M/E is that you have two main displays, *preview* and *live*.
  17 Every time you want to change what's shown to the viewer, you first bring it
  18 up on the preview display, verify that it indeed contains something you'd like
  19 to show to your viewers, and only then start a transition to move the preview
  20 display onto the live display (which mirrors exactly what the viewers see).
  21 After the transition is done, the preview and live displays switch, allowing
  22 the operator to either switch back or to pull a new source onto the preview
  23 display.
  24
  25 In Nageru, the available transitions at any time are governed by the
  26 :doc:`theme </theme>`. However, generally a simple cut (moving immediately
  27 from live to preview) will nearly always be an option. Other effects include
  28 fades and zooms, but availability will depend on what sources are involved in the
  29 transition.
  30
  31
  32 A brief tour of the Nageru UI
  33 -----------------------------
  34
  35 The basic Nageru UI with the default theme looks like this:
  36
  37 .. image:: images/basic-ui.png
  38
  39 First a word about user input: Nageru can be controlled by the mouse or
  40 keyboard, but most operators will prefer using both hands on the keyboard.
  41 Like on a real mixing console, you use your left hand to select sources for
  42 preview (using the 1–9 keys) and the right hand to choose a transition
  43 (using J, K or L). In addition, audio can be controlled using a MIDI controller
  44 if you want to; see the :doc:`audio <audio>` page for more information.
  45
  46 Channels
  47 ''''''''
  48
  49 The preview and live displays are the most important part of the UI,
  50 and thus take up the bulk of the space. As you can see, we have only
  51 one (rather boring) input connected, and it is live. The other input is
  52 disconnected and thus shows only a test color. These correspond to pressing
  53 the 1 and 2 keys on the keyboard to activate preview, respectively—or you can
  54 left-click on them do achieve the same effect. (Right-clicking will bring up
  55 :ref:`the video card context menu <context-menu>`; see below.)
  56
  57 Similarly, we have a side-by-side view; it is composed of a big image of
  58 input 1 and a smaller one of input 2. (If you are unhappy which is which,
  59 you can switch the two inputs; again, see below.)
  60
  61 Finally, we have a static image. The one included with Nageru is rather
  62 bland and generic, but it works as a generic pause image when you don't
  63 really want anything on the screen.
  64
  65 Transitions
  66 '''''''''''
  67
  68 Whenever you have a different channel pulled up on the preview from
  69 on the live display, you will see that the three buttons in the middle
  70 offer you various **transitions**. Selecting any of them (either by
  71 the displayed hotkey, or using the mouse) will *swap* the preview and
  72 live inputs, effectively making the preview live. If you use “cut”,
  73 this will happen nearly instantly; the two other options, zoom
  74 (only available with the side-by-side view) and fade (*not* available
  75 with the side-by-side view) take some time, as you can see in the live view.
  76
  77 A good operator knows to use the right transition at the right time,
  78 so that the end result does not distract from the actual message
  79 of the video. In particular, too frequent switching between sources
  80 will probably be perceived as disturbing.
  81
  82
  83 The audio strip
  84 '''''''''''''''
  85
  86 The look of the audio strip will vary significantly with what audio
  87 mode you are in; the default is the simple mode, but multichannel
  88 is much more powerful. Both modes, as well as the level meters on
  89 the right, are explained in detail in the section about :doc:`audio <audio>`.
  90
  91
  92 The menu bar
  93 ''''''''''''
  94
  95 The menu bar does not contain a lot of interesting information,
  96 but it does have a few elements that are useful for configuration.
  97 The video menu contains the following elements:
  98
  99   * **Begin new video segment:** Nageru is constantly recording
 100     your stream to disk in a near-lossless H.264 stream
 101     (you cannot turn it off, because experience shows you'd probably
 102     forget to turn it back on again in time for actual use);
 103     see :doc:`streaming` for more information. This option allows
 104     you to end the current file and begin a new one—the two files
 105     can be spliced back later for a 100% seamless result if you wish,
 106     so this is a lossless operation. It is typically useful
 107     to do this right before and after the event itself starts,
 108     so as to facilitate easier editing later.
 109
 110     You can achieve the same effect as this option by sending
 111     SIGHUP to the Nageru process.
 112
 113   * **Change x264 bitrate:** See :doc:`streaming` for more information.
 114
 115   * **Exit:** Exits Nageru, obviously.
 116
 117 The audio menu is explained in the section on :doc:`audio <audio>`.
 118
 119 Finally, the menu bar also hosts the disk space meter. This shows
 120 how much disk you have left before Nageru will error out and die;
 121 it also tries to estimate how much real time this corresponds to,
 122 based on the last 30 seconds of recording.
 123
 124
 125 .. _context-menu:
 126
 127 The video card context menu
 128 '''''''''''''''''''''''''''
 129
 130 If you right-click on a channel that corresponds to a video input
 131 (ie., not the side-by-side view or static image), a simple context menu
 132 pops up:
 133
 134 .. image:: images/context-menu.png
 135
 136 The options presented are as follows:
 137
 138  * **Input source:** Connect this video input to a different physical card,
 139    taking effect immediately. The theme supports only two inputs
 140    at a time (you can :doc:`write your own <theme>` that support many
 141    more if you wish), but if you start Nageru with a higher value
 142    for the “--num-cards” option (aka -c), you can choose any of the
 143    available ones here. This option is also useful if you want to
 144    switch the two cards, since input 1 is bigger in side-by-side mode.
 145    (See also the “--map-signal” option, aka -m.)
 146
 147  * **Video input:** If a card supports multiple kinds of inputs
 148    (e.g. has both HDMI and analog inputs), you can select which one here.
 149
 150  * **Audio input:** Similar, just for audio. “Embedded” means
 151    an audio stream that is included in the HDMI or SDI signal.
 152
 153  * **Input mode:** Choose the video input mode to use. Note that the USB
 154    cards autodetect the mode, and you cannot override it even if you wanted to.
 155    For PCI cards, autodetection is not supported (even for the select few
 156    cards that can handle it in hardware), but a simple option (“Scan”)
 157    is available to try all modes in turn until a signal is received.
 158
 159  * **Use as audio source:** See the :doc:`audio <audio>` page for more
 160    information. For simple audio only; unavailable in multichannel mode.
 161
 162  * **Use as master clock:** The output stream needs exactly one stream
 163    as master clock. The frame rate and clocked will be locked exactly
 164    to it, so use the most important input here. A signal that keeps getting
 165    unplugged and replugged might not be the best candidate, although the
 166    PCI cards have fallback internal clocking when the signal is lost
 167    (the USB cards fall back to a strange mode of about 30.13 Hz).