git.sesse.net Git - nageru/blob - README

   1 Nageru is a live video mixer, based around the standard M/E workflow.
   2
   3
   4 Features:
   5
   6  - High performance on modest hardware (720p60 with two input streams
   7    on my Thinkpad X240[1]); almost all pixel processing is done on the GPU.
   8
   9  - High output quality; Lanczos3 scaling, subpixel precision everywhere,
  10    white balance adjustment, mix of 16- and 32-bit floating point
  11    for intermediate calculations, dithered output.
  12
  13  - Proper sound support: Syncing of multiple unrelated sources through
  14    high-quality resampling, freely selectable input, cue out for headphones,
  15    dynamic range compression, simple EQ (lowpass), level meters conforming
  16    to EBU R128.
  17
  18  - Theme engine encapsulating the design demands of each individual
  19    event; Lua code is responsible for setting up the pixel processing
  20    pipelines, running transitions etc., so that the visual look is
  21    consistent between operators.
  22
  23 [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
  24 to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
  25 4400 (ie., without the extra L4 cache from Iris Pro), single-channel DDR3 RAM
  26 (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU).
  27
  28
  29 Nageru is in beta stage. It currently needs:
  30
  31  - An Intel processor with Intel Quick Sync, or otherwise some hardware
  32    H.264 encoder exposed through VA-API.
  33
  34  - Two or more Blackmagic USB3 cards, either HDMI or SDI. These are driven
  35    through the “bmusb” driver embedded in bmusb/, using libusb-1.0.
  36    Note that you will want a recent Linux kernel to avoid LPM (link power
  37    management) and bandwidth allocation issues with USB3.
  38
  39  - Movit, my GPU-based video filter library (https://movit.sesse.net).
  40    Newer is almost certainly better; Nageru's needs tends to drive new
  41    features in Movit.
  42
  43  - Qt 5.5 or newer for the GUI.
  44
  45  - libmicrohttpd for the embedded web server.
  46
  47  - ffmpeg for muxing, and for encoding audio.
  48
  49  - Working OpenGL; Movit works with almost any modern OpenGL implementation,
  50    but Nageru has been tested with Mesa 10.x and 11.x only (you probably want
  51    11.x).
  52
  53  - libzita-resampler, for resampling sound sources so that they are in sync
  54    between sources, and also for oversampling for the peak meter.
  55
  56  - Lua, for driving the theme engine.
  57
  58
  59 If on Debian stretch or something similar, you can install everything you need
  60 except Movit (which you'll need to compile from git yourself) with:
  61
  62   git submodule update --init
  63   apt build-dep movit
  64   apt install qtbase5-dev qt5-default pkg-config libusb-dev libmicrohttpd-dev \
  65     libusb-1.0-0-dev liblua5.2-dev libzita-resampler-dev libva-dev \
  66     libavcodec-dev libavformat-dev libswscale-dev
  67
  68
  69 The patches/ directory contains some patches for upstream software that help
  70 Nageru performance and/or stability. They are all meant for upstream, but
  71 probably will not be in by the time Nageru is released. All except the bmusb
  72 patch are taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my work
  73 email, unlike Nageru itself and bmusb), and under the same license as the
  74 projects they patch.
  75
  76 To start it, just hook up your equipment, type “make” and then “./nageru”.
  77 It is strongly recommended to have the rights to run at real-time priority;
  78 it will make the USB3 threads do so, which will make them a lot more stable.
  79 (A reasonable hack for testing is probably just to run it as root using sudo,
  80 although you might not want to do that in production.) Note also that if you
  81 are running a desktop compositor, it will steal significant amounts of GPU
  82 performance. The same goes for PulseAudio.
  83
  84 Nageru will open a HTTP server at port 9095, where you can extract a live
  85 H264+PCM signal in QuickTime mux (e.g. http://127.0.0.1:9095/stream.mov).
  86 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
  87 users, but you can easily send it around in your internal network and then
  88 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
  89 be saved live to local disk.
  90
  91
  92 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
  93 to throw or cast. (I also later learned that it could mean to face defeat or
  94 give up, but that's not the intended meaning.)
  95
  96
  97 Nageru's home page is at https://nageru.sesse.net/, where you can also find
  98 contact information and link to the latest version.
  99
 100
 101 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
 102 Intel's copyright license at h264encode.h.
 103
 104
 105 Nageru is Copyright (C) 2015 Steinar H. Gunderson <sgunderson@bigfoot.com>.
 106 Portions Copyright (C) 2003 Rune Holm.
 107 Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
 108 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
 109 Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
 110 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 111
 112
 113 This program is free software: you can redistribute it and/or modify
 114 it under the terms of the GNU General Public License as published by
 115 the Free Software Foundation, either version 3 of the License, or
 116 (at your option) any later version.
 117
 118 This program is distributed in the hope that it will be useful,
 119 but WITHOUT ANY WARRANTY; without even the implied warranty of
 120 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 121 GNU General Public License for more details.
 122
 123 You should have received a copy of the GNU General Public License
 124 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 125
 126
 127 Portions of h264encode.h and h264encode.cpp:
 128
 129 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 130
 131 Permission is hereby granted, free of charge, to any person obtaining a
 132 copy of this software and associated documentation files (the
 133 "Software"), to deal in the Software without restriction, including
 134 without limitation the rights to use, copy, modify, merge, publish,
 135 distribute, sub license, and/or sell copies of the Software, and to
 136 permit persons to whom the Software is furnished to do so, subject to
 137 the following conditions:
 138
 139 The above copyright notice and this permission notice (including the
 140 next paragraph) shall be included in all copies or substantial portions
 141 of the Software.
 142
 143 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 144 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 145 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 146 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
 147 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 148 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 149 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.