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

   1 Introduction
   2 ============
   3
   4 Nageru is a live video mixer, based around the standard M/E workflow.
   5
   6 Features:
   7
   8  * High performance on modest hardware (720p60 with two input streams
   9    on my Thinkpad X240 [1]_); almost all pixel processing is done on the GPU.
  10
  11  * High output quality; Lanczos3 scaling, subpixel precision everywhere,
  12    white balance adjustment, mix of 16- and 32-bit floating point
  13    for intermediate calculations, dithered output, optional 10-bit input
  14    and output support.
  15
  16  * Proper sound support: Syncing of multiple unrelated sources through
  17    high-quality resampling, multichannel mixing with separate effects
  18    per-bus, cue out for headphones, dynamic range compression,
  19    three-band graphical EQ (pluss a fixed low-cut), level meters conforming
  20    to EBU R128, automation via MIDI controllers.
  21
  22  * Theme engine encapsulating the design demands of each individual
  23    event; Lua code is responsible for setting up the pixel processing
  24    pipelines, running transitions etc., so that the visual look is
  25    consistent between operators.
  26
  27  * Comprehensive monitoring through Prometheus metrics.
  28
  29 .. [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
  30        to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
  31        4400 (ie., without the extra L4 cache from Iris Pro), single-channel DDR3 RAM
  32        (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU).
  33
  34 .. _compile:
  35
  36 Compiling
  37 ---------
  38
  39 The preferred way of getting Nageru is usually from your Linux distribution
  40 of choice, but you can of course also compile it yourself (which will also
  41 usually give you a newer version). It currently need:
  42
  43  - Movit, my GPU-based video filter library (https://movit.sesse.net).
  44    You will need at least version 1.5.2.
  45
  46  - Qt 5.5 or newer for the GUI.
  47
  48  - QCustomPlot for the histogram display in the frame analyzer.
  49
  50  - libmicrohttpd for the embedded web server.
  51
  52  - x264 for encoding high-quality video suitable for streaming to end users.
  53
  54  - FFmpeg for muxing, and for encoding audio. You will need at least
  55    version 4.0.
  56
  57  - Working OpenGL; Movit works with almost any modern OpenGL implementation.
  58    Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due
  59    to critical stability bugfixes), and with NVIDIA's proprietary drivers.
  60    The status of AMD's proprietary drivers is currently unknown.
  61
  62  - libzita-resampler, for resampling sound sources so that they are in sync
  63    between sources, and also for oversampling for the peak meter.
  64
  65  - LuaJIT, for driving the theme engine. You will need at least version 2.1.
  66
  67  - SQLite, for storing Futatabi state.
  68
  69  - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not
  70    available.
  71
  72  - Zita-resampler, for adjusting audio to be in sync with video.
  73
  74  - Protocol Buffers (protobuf), for storing various forms of settings and
  75    state.
  76
  77  - Meson, for building.
  78
  79  - Optional: CEF (Chromium Embedded Framework), for :doc:`HTML graphics <html>`.
  80    If you build without CEF, the HTMLInput class will not be available from
  81    the theme. You can get binary downloads of CEF from
  82
  83      http://opensource.spotify.com/cefbuilds/index.html
  84
  85    Simply download the right build for your platform (the “minimal” build
  86    is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
  87    on the meson command line (substituting X with the real version as required).
  88
  89
  90 If on Debian buster or something similar, you can install everything you need
  91 with:
  92
  93   apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
  94     pkg-config libmicrohttpd-dev libusb-1.0-0-dev libluajit-5.1-dev \
  95     libzita-resampler-dev libva-dev libavcodec-dev libavformat-dev \
  96     libswscale-dev libavresample-dev libmovit-dev libegl1-mesa-dev \
  97     libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \
  98     libprotobuf-dev libsqlite3-dev meson libjpeg-dev
  99
 100
 101 Exceptions as of December 2018:
 102
 103   - Debian does not carry CEF (but it is optional). You can get experimental
 104     (and not security-supported) CEF Debian packages built for unstable at
 105     http://storage.sesse.net/cef/, and then configure Nageru with
 106
 107      meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true
 108
 109
 110 The patches/ directory contains a patch that helps zita-resampler performance.
 111 It is meant for upstream, but was not in at the time Nageru was released.
 112 It is taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my ex-work
 113 email), and under the same license as zita-resampler itself.
 114
 115 Nageru uses Meson to build. For a default build, type
 116
 117   meson obj && cd obj && ninja
 118
 119 To start it, just hook up your equipment, and then type “./nageru”.
 120
 121