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 alpha 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 Blackmagic USB3 cards, either HDMI or SDI. Note that on some machines,
  35    you may have to run a Linux kernel with power saving compiled out to avoid
  36    LPM (link power management) and bandwidth allocation issues with USB3.
  37    These are driven through the “bmusb“ driver embedded in bmusb/, using
  38    libusb-1.0.
  39
  40  - Movit, my GPU-based video filter library (http://movit.sesse.net).
  41    Newer is almost certainly better; Nageru's needs tends to drive new
  42    features in Movit.
  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    but Nageru has been tested with Mesa 10.x and 11.x only (you probably want
  52    11.x).
  53
  54  - libzita-resampler, for resampling sound sources so that they are in sync
  55    between sources, and also for oversampling for the peak meter.
  56
  57  - Lua, for driving the theme engine.
  58
  59
  60 The patches/ directory contains some patches for upstream software that help
  61 Nageru performance and/or stability. They are all meant for upstream, but
  62 probably will not be in by the time Nageru is released. All except the bmusb
  63 patch are taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my work
  64 email, unlike Nageru itself and bmusb), and under the same license as the
  65 projects they patch.
  66
  67 To start it, just hook up your requipment, type “make” and then “./nageru”.
  68 It is strongly recommended to have the rights to run at real-time priority;
  69 it will make the USB3 threads do so, which will make them a lot more stable.
  70 (A reasonable hack for testing is probably just to run it as root using sudo,
  71 although you might not want to do that in production.) Note also that if you
  72 are running a desktop compositor, it will steal significant amounts of GPU
  73 performance. The same goes for PulseAudio.
  74
  75 Nageru will open a HTTP server at port 9095, where you can extract a live
  76 H264+PCM signal in QuickTime mux (e.g. http://127.0.0.1:9095/stream.mov).
  77 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
  78 users, but you can easily send it around in your internal network and then
  79 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
  80 be saved live to local disk.
  81
  82
  83 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
  84 to throw or cast. (I also later learned that it could mean to face defeat or
  85 give up, but that's not the intended meaning.)
  86
  87
  88 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
  89 Intel's copyright license at h264encode.h.
  90
  91
  92 Nageru is Copyright (C) 2015 Steinar H. Gunderson <sgunderson@bigfoot.com>.
  93 Portions Copyright (C) 2003 Rune Holm.
  94 Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
  95 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
  96 Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
  97 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
  98
  99
 100 This program is free software: you can redistribute it and/or modify
 101 it under the terms of the GNU General Public License as published by
 102 the Free Software Foundation, either version 3 of the License, or
 103 (at your option) any later version.
 104
 105 This program is distributed in the hope that it will be useful,
 106 but WITHOUT ANY WARRANTY; without even the implied warranty of
 107 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 108 GNU General Public License for more details.
 109
 110 You should have received a copy of the GNU General Public License
 111 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 112
 113
 114 Portions of h264encode.h and h264encode.cpp:
 115
 116 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 117
 118 Permission is hereby granted, free of charge, to any person obtaining a
 119 copy of this software and associated documentation files (the
 120 "Software"), to deal in the Software without restriction, including
 121 without limitation the rights to use, copy, modify, merge, publish,
 122 distribute, sub license, and/or sell copies of the Software, and to
 123 permit persons to whom the Software is furnished to do so, subject to
 124 the following conditions:
 125
 126 The above copyright notice and this permission notice (including the
 127 next paragraph) shall be included in all copies or substantial portions
 128 of the Software.
 129
 130 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 131 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 132 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 133 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
 134 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 135 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 136 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.