1 Nageru is a live video mixer, based around the standard M/E workflow.
2 Futatabi is a multicamera slow motion video server.
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 - Some sort of video capture cards; typically two or more Blackmagic USB3
40 or PCI cards, either HDMI or SDI (V4L2 is not generally supported).
41 The PCI cards need Blackmagic's own drivers installed. The USB3 cards
42 are driven through the “bmusb” driver, using libusb-1.0.
44 - Movit, my GPU-based video filter library (https://movit.sesse.net).
45 You will need at least version 1.5.2.
47 - Qt 5.5 or newer for the GUI.
49 - libmicrohttpd for the embedded web server.
51 - x264 for encoding high-quality video suitable for streaming to end users.
53 - FFmpeg for muxing, and for encoding audio. You will need at least
56 - Working OpenGL; Movit works with almost any modern OpenGL implementation.
57 Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due
58 to critical stability bugfixes), and with NVIDIA's proprietary drivers.
59 The status of AMD's proprietary drivers is currently unknown.
61 - libzita-resampler, for resampling sound sources so that they are in sync
62 between sources, and also for oversampling for the peak meter.
64 - LuaJIT, for driving the theme engine. You will need at least version 2.1.
66 - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not
69 - Protocol Buffers (protobuf), for storing various forms of settings and
72 - Meson, for building.
74 - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
75 If you build without CEF, the HTMLInput class will not be available from
76 the theme. You can get binary downloads of CEF from
78 http://opensource.spotify.com/cefbuilds/index.html
80 Simply download the right build for your platform (the “minimal” build
81 is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
82 on the meson command line (substituting X with the real version as required).
84 - Optional: libsrt, for SRT inputs (by default, Nageru will listen on
85 port 9710, although you can change this port on the command line,
86 turn it off with --srt-port -1, or turn it off live in the UI).
87 SRT can also be used for output in addition to listening for HTTP
88 (see --srt-destination). If you build with libsrt, make sure it is not
89 linked to OpenSSL, for license reasons.
91 - Optional: SVT-AV1, for encoding high-quality video suitable for streaming to
92 end users (higher quality than using x264, but not nearly as mature).
93 You will need at least version 1.5.0.
98 - A fast GPU with OpenGL 4.5 support (GTX 1080 or similar recommended for
99 best quality at HD resolutions, although 950 should work).
101 - SQLite, for storing state.
104 If on Debian bullseye or something similar, you can install everything you need
107 apt install qtbase5-dev libqt5opengl5-dev qt5-default \
108 pkg-config libmicrohttpd-dev libusb-1.0-0-dev libluajit-5.1-dev \
109 libzita-resampler-dev libva-dev libavcodec-dev libavformat-dev \
110 libswscale-dev libavresample-dev libmovit-dev libegl1-mesa-dev \
111 libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \
112 libprotobuf-dev libsqlite3-dev meson libjpeg-dev libsrt-gnutls-dev
114 Exceptions as of July 2022:
116 - Debian does not carry CEF (but it is optional). You can get experimental
117 (and not security-supported) CEF Debian packages built for unstable at
118 http://storage.sesse.net/cef/, and then configure Nageru with
120 meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true
122 - Debian's SVT-AV1 is too old, so you will need to compile it yourself
123 if you wish to use it for streaming.
126 The patches/ directory contains a patch that helps zita-resampler performance.
127 It is meant for upstream, but was not in at the time Nageru was released.
128 It is taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my ex-work
129 email), and under the same license as zita-resampler itself.
131 Nageru and Futatabi use Meson to build. For a default build (building both),
134 meson obj && cd obj && ninja
136 To start Nageru, just hook up your equipment, and then type “./nageru”.
137 For Futatabi documentation, please see https://nageru.sesse.net/doc/.
139 It is strongly recommended to have the rights to run at real-time priority;
140 it will make the USB3 threads do so, which will make them a lot more stable.
141 (A reasonable hack for testing is probably just to run it as root using sudo,
142 although you might not want to do that in production.) Note also that if you
143 are running a desktop compositor, it will steal significant amounts of GPU
144 performance. The same goes for PulseAudio.
146 Nageru will open a HTTP server at port 9095, where you can extract a live
147 H264+PCM signal in nut mux (e.g. http://127.0.0.1:9095/stream.nut).
148 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
149 users, but you can easily send it around in your internal network and then
150 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
151 be saved live to local disk.
153 If you have a fast CPU (typically a quadcore desktop; most laptops will spend
154 most of their CPU on running Nageru itself), you can use x264 for the outgoing
155 stream instead of Quick Sync; it is much better quality for the same bitrate,
156 and also has proper bitrate controls. Simply add --http-x264-video on the
157 command line. (You may also need to add something like "--x264-preset veryfast",
158 since the default "medium" preset might be too CPU-intensive, but YMMV.)
159 The stream saved to disk will still be the Quick Sync-encoded stream, as it is
160 typically higher bitrate and thus also higher quality. Note that if you add
161 ".metacube" at the end of the URL (e.g. "http://127.0.0.1:9095/stream.ts.metacube"),
162 you will get a stream suitable for streaming through the Cubemap video reflector
163 (cubemap.sesse.net). A typical example would be:
165 ./nageru --http-x264-video --x264-preset veryfast --x264-tune film \
166 --http-mux mp4 --http-audio-codec libfdk_aac --http-audio-bitrate 128
168 If you are comfortable with using all your remaining CPU power on the machine
169 for x264, try --x264-speedcontrol, which will try to adjust the preset
170 dynamically for maximum quality, at the expense of somewhat higher delay.
172 See --help for more information on options in general.
174 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
175 to throw or cast. (I also later learned that it could mean to face defeat or
176 give up, but that's not the intended meaning.)
178 The name “Futatabi” comes from the Japanese adverb 再び (futatabi), which means
179 “again” or “for the second time”.
182 Nageru's home page is at https://nageru.sesse.net/, where you can also find
183 contact information, full documentation and link to the latest version.
186 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
187 Intel's copyright license at quicksync_encoder.h.
190 Nageru is Copyright (C) 2015 Steinar H. Gunderson <steinar+nageru@gunderson.no>.
191 Portions Copyright (C) 2003 Rune Holm.
192 Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
193 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
194 Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
195 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
196 Portions Copyright (C) 2019 Yngve Molnes.
199 This program is free software: you can redistribute it and/or modify
200 it under the terms of the GNU General Public License as published by
201 the Free Software Foundation, either version 3 of the License, or
202 (at your option) any later version.
204 This program is distributed in the hope that it will be useful,
205 but WITHOUT ANY WARRANTY; without even the implied warranty of
206 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
207 GNU General Public License for more details.
209 You should have received a copy of the GNU General Public License
210 along with this program. If not, see <http://www.gnu.org/licenses/>.
213 Portions of quicksync_encoder.h and quicksync_encoder.cpp:
215 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
217 Permission is hereby granted, free of charge, to any person obtaining a
218 copy of this software and associated documentation files (the
219 "Software"), to deal in the Software without restriction, including
220 without limitation the rights to use, copy, modify, merge, publish,
221 distribute, sub license, and/or sell copies of the Software, and to
222 permit persons to whom the Software is furnished to do so, subject to
223 the following conditions:
225 The above copyright notice and this permission notice (including the
226 next paragraph) shall be included in all copies or substantial portions
229 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
230 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
231 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
232 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
233 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
234 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
235 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
238 All files in decklink/:
240 Copyright (c) 2009 Blackmagic Design
241 Copyright (c) 2015 Blackmagic Design
243 Permission is hereby granted, free of charge, to any person or organization
244 obtaining a copy of the software and accompanying documentation covered by
245 this license (the "Software") to use, reproduce, display, distribute,
246 execute, and transmit the Software, and to prepare derivative works of the
247 Software, and to permit third-parties to whom the Software is furnished to
248 do so, all subject to the following:
250 The copyright notices in the Software and this entire statement, including
251 the above license grant, this restriction and the following disclaimer,
252 must be included in all copies of the Software, in whole or in part, and
253 all derivative works of the Software, unless such copies or derivative
254 works are solely in the form of machine-executable object code generated by
255 a source language processor.
257 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
258 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
259 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
260 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
261 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
262 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
263 DEALINGS IN THE SOFTWARE.