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. Note that you can use VA-API over
  33    DRM instead of X11, to use a non-Intel GPU for rendering but still use
  34    Quick Sync (by giving e.g. “--va-display /dev/dri/renderD128”).
  35
  36  - Two or more Blackmagic USB3 cards, either HDMI or SDI. These are driven
  37    through the “bmusb” driver embedded in bmusb/, using libusb-1.0.
  38    Note that you will want a recent Linux kernel to avoid LPM (link power
  39    management) and bandwidth allocation issues with USB3.
  40
  41  - Movit, my GPU-based video filter library (https://movit.sesse.net).
  42    You will need at least version 1.3.0.
  43
  44  - Qt 5.5 or newer for the GUI.
  45
  46  - libmicrohttpd for the embedded web server.
  47
  48  - ffmpeg for muxing, and for encoding audio.
  49
  50  - Working OpenGL; Movit works with almost any modern OpenGL implementation.
  51    Nageru has been tested with Intel on Mesa 10.x and 11.x (you probably want
  52    11.x), and with NVIDIA's proprietary drivers. AMD's proprietary drivers
  53    (fglrx) are known not to work due to driver bugs; I am in contact with
  54    AMD to try to get this resolved.
  55
  56  - libzita-resampler, for resampling sound sources so that they are in sync
  57    between sources, and also for oversampling for the peak meter.
  58
  59  - Lua, for driving the theme engine.
  60
  61
  62 If on Debian stretch or something similar, you can install everything you need
  63 with:
  64
  65   git submodule update --init
  66   apt install qtbase5-dev qt5-default pkg-config libmicrohttpd-dev \
  67     libusb-1.0-0-dev liblua5.2-dev libzita-resampler-dev libva-dev \
  68     libavcodec-dev libavformat-dev libswscale-dev libmovit-dev \
  69     libegl1-mesa-dev libasound2-dev
  70
  71
  72 The patches/ directory contains some patches for upstream software that help
  73 Nageru performance and/or stability. They are all meant for upstream, but
  74 probably will not be in by the time Nageru is released. All except the bmusb
  75 patch are taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my work
  76 email, unlike Nageru itself and bmusb), and under the same license as the
  77 projects they patch.
  78
  79 To start it, just hook up your equipment, type “make” and then “./nageru”.
  80 It is strongly recommended to have the rights to run at real-time priority;
  81 it will make the USB3 threads do so, which will make them a lot more stable.
  82 (A reasonable hack for testing is probably just to run it as root using sudo,
  83 although you might not want to do that in production.) Note also that if you
  84 are running a desktop compositor, it will steal significant amounts of GPU
  85 performance. The same goes for PulseAudio.
  86
  87 Nageru will open a HTTP server at port 9095, where you can extract a live
  88 H264+PCM signal in QuickTime mux (e.g. http://127.0.0.1:9095/stream.mov).
  89 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
  90 users, but you can easily send it around in your internal network and then
  91 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
  92 be saved live to local disk.
  93
  94
  95 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
  96 to throw or cast. (I also later learned that it could mean to face defeat or
  97 give up, but that's not the intended meaning.)
  98
  99
 100 Nageru's home page is at https://nageru.sesse.net/, where you can also find
 101 contact information and link to the latest version.
 102
 103
 104 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
 105 Intel's copyright license at h264encode.h.
 106
 107
 108 Nageru is Copyright (C) 2015 Steinar H. Gunderson <steinar+nageru@gunderson.no>.
 109 Portions Copyright (C) 2003 Rune Holm.
 110 Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
 111 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
 112 Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
 113 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 114
 115
 116 This program is free software: you can redistribute it and/or modify
 117 it under the terms of the GNU General Public License as published by
 118 the Free Software Foundation, either version 3 of the License, or
 119 (at your option) any later version.
 120
 121 This program is distributed in the hope that it will be useful,
 122 but WITHOUT ANY WARRANTY; without even the implied warranty of
 123 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 124 GNU General Public License for more details.
 125
 126 You should have received a copy of the GNU General Public License
 127 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 128
 129
 130 Portions of h264encode.h and h264encode.cpp:
 131
 132 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 133
 134 Permission is hereby granted, free of charge, to any person obtaining a
 135 copy of this software and associated documentation files (the
 136 "Software"), to deal in the Software without restriction, including
 137 without limitation the rights to use, copy, modify, merge, publish,
 138 distribute, sub license, and/or sell copies of the Software, and to
 139 permit persons to whom the Software is furnished to do so, subject to
 140 the following conditions:
 141
 142 The above copyright notice and this permission notice (including the
 143 next paragraph) shall be included in all copies or substantial portions
 144 of the Software.
 145
 146 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 147 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 148 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 149 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
 150 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 151 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 152 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 153
 154
 155 All files in decklink/:
 156
 157 Copyright (c) 2009 Blackmagic Design
 158 Copyright (c) 2015 Blackmagic Design
 159
 160 Permission is hereby granted, free of charge, to any person or organization
 161 obtaining a copy of the software and accompanying documentation covered by
 162 this license (the "Software") to use, reproduce, display, distribute,
 163 execute, and transmit the Software, and to prepare derivative works of the
 164 Software, and to permit third-parties to whom the Software is furnished to
 165 do so, all subject to the following:
 166
 167 The copyright notices in the Software and this entire statement, including
 168 the above license grant, this restriction and the following disclaimer,
 169 must be included in all copies of the Software, in whole or in part, and
 170 all derivative works of the Software, unless such copies or derivative
 171 works are solely in the form of machine-executable object code generated by
 172 a source language processor.
 173
 174 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 175 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 176 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 177 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 178 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 179 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 180 DEALINGS IN THE SOFTWARE.