1 Nageru is a live video mixer, based around the standard M/E workflow.
2 Futatabi is a multicamera slow motion video server (currently undocumented).
7 - High performance on modest hardware (720p60 with two input streams
8 on my Thinkpad X240[1]); almost all pixel processing is done on the GPU.
10 - High output quality; Lanczos3 scaling, subpixel precision everywhere,
11 white balance adjustment, mix of 16- and 32-bit floating point
12 for intermediate calculations, dithered output, optional 10-bit input
15 - Proper sound support: Syncing of multiple unrelated sources through
16 high-quality resampling, multichannel mixing with separate effects
17 per-bus, cue out for headphones, dynamic range compression,
18 three-band graphical EQ (pluss a fixed low-cut), level meters conforming
19 to EBU R128, automation via MIDI controllers.
21 - Theme engine encapsulating the design demands of each individual
22 event; Lua code is responsible for setting up the pixel processing
23 pipelines, running transitions etc., so that the visual look is
24 consistent between operators.
26 - HTML rendering (through Chromium Embedded Framework), for high-quality
27 and flexible overlay or other graphics.
29 - Comprehensive monitoring through Prometheus metrics.
31 [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
32 to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
33 4400 (ie., without the extra L4 cache from Iris Pro), single-channel DDR3 RAM
34 (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU).
37 Nageru currently needs:
39 - An Intel processor with Intel Quick Sync, or otherwise some hardware
40 H.264 encoder exposed through VA-API. Note that you can use VA-API over
41 DRM instead of X11, to use a non-Intel GPU for rendering but still use
42 Quick Sync (Nageru does this automatically for you if needed).
44 - Two or more Blackmagic USB3 or PCI cards, either HDMI or SDI.
45 The PCI cards need Blackmagic's own drivers installed. The USB3 cards
46 are driven through the “bmusb” driver, using libusb-1.0. If you want
47 zerocopy USB, you need libusb 1.0.21 or newer, as well as a recent
48 kernel (4.6.0 or newer). Zerocopy USB helps not only for performance,
49 but also for stability. You need at least version 0.7.3.
51 - Movit, my GPU-based video filter library (https://movit.sesse.net).
52 You will need at least version 1.5.2.
54 - Qt 5.5 or newer for the GUI.
56 - QCustomPlot for the histogram display in the frame analyzer.
58 - libmicrohttpd for the embedded web server.
60 - x264 for encoding high-quality video suitable for streaming to end users.
62 - FFmpeg for muxing, and for encoding audio. You will need at least
65 - Working OpenGL; Movit works with almost any modern OpenGL implementation.
66 Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due
67 to critical stability bugfixes), and with NVIDIA's proprietary drivers.
68 The status of AMD's proprietary drivers is currently unknown.
70 - libzita-resampler, for resampling sound sources so that they are in sync
71 between sources, and also for oversampling for the peak meter.
73 - LuaJIT, for driving the theme engine. You will need at least version 2.1.
75 - SQLite, for storing Futatabi state.
77 - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not
80 - Zita-resampler, for adjusting audio to be in sync with video.
82 - Protocol Buffers (protobuf), for storing various forms of settings and
85 - Meson, for building.
87 - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
88 If you build without CEF, the HTMLInput class will not be available from
89 the theme. You can get binary downloads of CEF from
91 http://opensource.spotify.com/cefbuilds/index.html
93 Simply download the right build for your platform (the “minimal” build
94 is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
95 on the meson command line (substituting X with the real version as required).
98 If on Debian buster or something similar, you can install everything you need
101 apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
102 pkg-config libmicrohttpd-dev libusb-1.0-0-dev libluajit-5.1-dev \
103 libzita-resampler-dev libva-dev libavcodec-dev libavformat-dev \
104 libswscale-dev libavresample-dev libmovit-dev libegl1-mesa-dev \
105 libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \
106 libprotobuf-dev libsqlite3-dev meson libjpeg-dev
108 Exceptions as of December 2018:
110 - Debian does not carry CEF (but it is optional). You can get experimental
111 (and not security-supported) CEF Debian packages built for unstable at
112 http://storage.sesse.net/cef/, and then configure Nageru with
114 meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true
116 The patches/ directory contains a patch that helps zita-resampler performance.
117 It is meant for upstream, but was not in at the time Nageru was released.
118 It is taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my ex-work
119 email), and under the same license as zita-resampler itself.
121 Nageru uses Meson to build. For a default build, type
123 meson obj && cd obj && ninja
125 To start it, just hook up your equipment, and then type “./nageru”.
127 It is strongly recommended to have the rights to run at real-time priority;
128 it will make the USB3 threads do so, which will make them a lot more stable.
129 (A reasonable hack for testing is probably just to run it as root using sudo,
130 although you might not want to do that in production.) Note also that if you
131 are running a desktop compositor, it will steal significant amounts of GPU
132 performance. The same goes for PulseAudio.
134 Nageru will open a HTTP server at port 9095, where you can extract a live
135 H264+PCM signal in nut mux (e.g. http://127.0.0.1:9095/stream.nut).
136 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
137 users, but you can easily send it around in your internal network and then
138 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
139 be saved live to local disk.
141 If you have a fast CPU (typically a quadcore desktop; most laptops will spend
142 most of their CPU on running Nageru itself), you can use x264 for the outgoing
143 stream instead of Quick Sync; it is much better quality for the same bitrate,
144 and also has proper bitrate controls. Simply add --http-x264-video on the
145 command line. (You may also need to add something like "--x264-preset veryfast",
146 since the default "medium" preset might be too CPU-intensive, but YMMV.)
147 The stream saved to disk will still be the Quick Sync-encoded stream, as it is
148 typically higher bitrate and thus also higher quality. Note that if you add
149 ".metacube" at the end of the URL (e.g. "http://127.0.0.1:9095/stream.ts.metacube"),
150 you will get a stream suitable for streaming through the Cubemap video reflector
151 (cubemap.sesse.net). A typical example would be:
153 ./nageru --http-x264-video --x264-preset veryfast --x264-tune film \
154 --http-mux mp4 --http-audio-codec libfdk_aac --http-audio-bitrate 128
156 If you are comfortable with using all your remaining CPU power on the machine
157 for x264, try --x264-speedcontrol, which will try to adjust the preset
158 dynamically for maximum quality, at the expense of somewhat higher delay.
160 See --help for more information on options in general.
162 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
163 to throw or cast. (I also later learned that it could mean to face defeat or
164 give up, but that's not the intended meaning.)
167 Nageru's home page is at https://nageru.sesse.net/, where you can also find
168 contact information, full documentation and link to the latest version.
171 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
172 Intel's copyright license at quicksync_encoder.h.
175 Nageru is Copyright (C) 2015 Steinar H. Gunderson <steinar+nageru@gunderson.no>.
176 Portions Copyright (C) 2003 Rune Holm.
177 Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
178 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
179 Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
180 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
181 Portions Copyright (C) 2019 Yngve Molnes.
184 This program is free software: you can redistribute it and/or modify
185 it under the terms of the GNU General Public License as published by
186 the Free Software Foundation, either version 3 of the License, or
187 (at your option) any later version.
189 This program is distributed in the hope that it will be useful,
190 but WITHOUT ANY WARRANTY; without even the implied warranty of
191 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
192 GNU General Public License for more details.
194 You should have received a copy of the GNU General Public License
195 along with this program. If not, see <http://www.gnu.org/licenses/>.
198 Portions of quicksync_encoder.h and quicksync_encoder.cpp:
200 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
202 Permission is hereby granted, free of charge, to any person obtaining a
203 copy of this software and associated documentation files (the
204 "Software"), to deal in the Software without restriction, including
205 without limitation the rights to use, copy, modify, merge, publish,
206 distribute, sub license, and/or sell copies of the Software, and to
207 permit persons to whom the Software is furnished to do so, subject to
208 the following conditions:
210 The above copyright notice and this permission notice (including the
211 next paragraph) shall be included in all copies or substantial portions
214 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
215 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
216 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
217 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
218 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
219 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
220 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
223 All files in decklink/:
225 Copyright (c) 2009 Blackmagic Design
226 Copyright (c) 2015 Blackmagic Design
228 Permission is hereby granted, free of charge, to any person or organization
229 obtaining a copy of the software and accompanying documentation covered by
230 this license (the "Software") to use, reproduce, display, distribute,
231 execute, and transmit the Software, and to prepare derivative works of the
232 Software, and to permit third-parties to whom the Software is furnished to
233 do so, all subject to the following:
235 The copyright notices in the Software and this entire statement, including
236 the above license grant, this restriction and the following disclaimer,
237 must be included in all copies of the Software, in whole or in part, and
238 all derivative works of the Software, unless such copies or derivative
239 works are solely in the form of machine-executable object code generated by
240 a source language processor.
242 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
243 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
244 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
245 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
246 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
247 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
248 DEALINGS IN THE SOFTWARE.