ed86214d27d329ecddeb4c8f8c5c3107e1a062e2
[nageru] / README
1 Nageru is a live video mixer, based around the standard M/E workflow.
2 Futatabi is a multicamera slow motion video server.
3
4
5 Nageru features:
6
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.
9
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
13    and output support.
14
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.
20
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.
25
26  - HTML rendering (through Chromium Embedded Framework), for high-quality
27    and flexible overlay or other graphics.
28
29  - Comprehensive monitoring through Prometheus metrics.
30
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).
35
36
37 Nageru currently needs:
38
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).
43
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.4.
50
51  - Movit, my GPU-based video filter library (https://movit.sesse.net).
52    You will need at least version 1.5.2.
53
54  - Qt 5.5 or newer for the GUI.
55
56  - QCustomPlot for the histogram display in the frame analyzer.
57
58  - libmicrohttpd for the embedded web server.
59
60  - x264 for encoding high-quality video suitable for streaming to end users.
61
62  - FFmpeg for muxing, and for encoding audio. You will need at least
63    version 4.0.
64
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.
69
70  - libzita-resampler, for resampling sound sources so that they are in sync
71    between sources, and also for oversampling for the peak meter.
72
73  - LuaJIT, for driving the theme engine. You will need at least version 2.1.
74
75  - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not
76    available.
77
78  - Zita-resampler, for adjusting audio to be in sync with video.
79
80  - Protocol Buffers (protobuf), for storing various forms of settings and
81    state.
82
83  - Meson, for building.
84
85  - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
86    If you build without CEF, the HTMLInput class will not be available from
87    the theme. You can get binary downloads of CEF from
88
89      http://opensource.spotify.com/cefbuilds/index.html
90
91    Simply download the right build for your platform (the “minimal” build
92    is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
93    on the meson command line (substituting X with the real version as required).
94
95
96 Futatabi also needs:
97
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).
100
101  - SQLite, for storing state.
102
103
104 If on Debian buster or something similar, you can install everything you need
105 with:
106
107   apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
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
113
114 Exceptions as of December 2018:
115
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
119
120      meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true
121
122 The patches/ directory contains a patch that helps zita-resampler performance.
123 It is meant for upstream, but was not in at the time Nageru was released.
124 It is taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my ex-work
125 email), and under the same license as zita-resampler itself.
126
127 Nageru and Futatabi use Meson to build. For a default build (building both),
128 type
129
130   meson obj && cd obj && ninja
131
132 To start Nageru, just hook up your equipment, and then type “./nageru”.
133 For Futatabi documentation, please see https://nageru.sesse.net/doc/.
134
135 It is strongly recommended to have the rights to run at real-time priority;
136 it will make the USB3 threads do so, which will make them a lot more stable.
137 (A reasonable hack for testing is probably just to run it as root using sudo,
138 although you might not want to do that in production.) Note also that if you
139 are running a desktop compositor, it will steal significant amounts of GPU
140 performance. The same goes for PulseAudio.
141
142 Nageru will open a HTTP server at port 9095, where you can extract a live
143 H264+PCM signal in nut mux (e.g. http://127.0.0.1:9095/stream.nut).
144 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
145 users, but you can easily send it around in your internal network and then
146 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
147 be saved live to local disk.
148
149 If you have a fast CPU (typically a quadcore desktop; most laptops will spend
150 most of their CPU on running Nageru itself), you can use x264 for the outgoing
151 stream instead of Quick Sync; it is much better quality for the same bitrate,
152 and also has proper bitrate controls. Simply add --http-x264-video on the
153 command line. (You may also need to add something like "--x264-preset veryfast",
154 since the default "medium" preset might be too CPU-intensive, but YMMV.)
155 The stream saved to disk will still be the Quick Sync-encoded stream, as it is
156 typically higher bitrate and thus also higher quality. Note that if you add
157 ".metacube" at the end of the URL (e.g. "http://127.0.0.1:9095/stream.ts.metacube"),
158 you will get a stream suitable for streaming through the Cubemap video reflector
159 (cubemap.sesse.net). A typical example would be:
160
161   ./nageru --http-x264-video --x264-preset veryfast --x264-tune film \
162       --http-mux mp4 --http-audio-codec libfdk_aac --http-audio-bitrate 128
163
164 If you are comfortable with using all your remaining CPU power on the machine
165 for x264, try --x264-speedcontrol, which will try to adjust the preset
166 dynamically for maximum quality, at the expense of somewhat higher delay.
167
168 See --help for more information on options in general.
169
170 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
171 to throw or cast. (I also later learned that it could mean to face defeat or
172 give up, but that's not the intended meaning.)
173
174 The name “Futatabi” comes from the Japanese adverb 再び (futatabi), which means
175 “again” or “for the second time”.
176
177
178 Nageru's home page is at https://nageru.sesse.net/, where you can also find
179 contact information, full documentation and link to the latest version.
180
181
182 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
183 Intel's copyright license at quicksync_encoder.h.
184
185
186 Nageru is Copyright (C) 2015 Steinar H. Gunderson <steinar+nageru@gunderson.no>.
187 Portions Copyright (C) 2003 Rune Holm.
188 Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
189 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
190 Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
191 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
192 Portions Copyright (C) 2019 Yngve Molnes.
193
194
195 This program is free software: you can redistribute it and/or modify
196 it under the terms of the GNU General Public License as published by
197 the Free Software Foundation, either version 3 of the License, or
198 (at your option) any later version.
199
200 This program is distributed in the hope that it will be useful,
201 but WITHOUT ANY WARRANTY; without even the implied warranty of
202 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
203 GNU General Public License for more details.
204
205 You should have received a copy of the GNU General Public License
206 along with this program.  If not, see <http://www.gnu.org/licenses/>.
207
208
209 Portions of quicksync_encoder.h and quicksync_encoder.cpp:
210
211 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
212
213 Permission is hereby granted, free of charge, to any person obtaining a
214 copy of this software and associated documentation files (the
215 "Software"), to deal in the Software without restriction, including
216 without limitation the rights to use, copy, modify, merge, publish,
217 distribute, sub license, and/or sell copies of the Software, and to
218 permit persons to whom the Software is furnished to do so, subject to
219 the following conditions:
220
221 The above copyright notice and this permission notice (including the
222 next paragraph) shall be included in all copies or substantial portions
223 of the Software.
224
225 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
226 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
227 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
228 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
229 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
230 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
231 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
232
233
234 All files in decklink/:
235
236 Copyright (c) 2009 Blackmagic Design
237 Copyright (c) 2015 Blackmagic Design
238
239 Permission is hereby granted, free of charge, to any person or organization
240 obtaining a copy of the software and accompanying documentation covered by
241 this license (the "Software") to use, reproduce, display, distribute,
242 execute, and transmit the Software, and to prepare derivative works of the
243 Software, and to permit third-parties to whom the Software is furnished to
244 do so, all subject to the following:
245
246 The copyright notices in the Software and this entire statement, including
247 the above license grant, this restriction and the following disclaimer,
248 must be included in all copies of the Software, in whole or in part, and
249 all derivative works of the Software, unless such copies or derivative
250 works are solely in the form of machine-executable object code generated by
251 a source language processor.
252
253 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
254 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
255 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
256 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
257 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
258 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
259 DEALINGS IN THE SOFTWARE.