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 (those marked with * are still in progress or not started yet):
   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, mixing (*), cue out for headphones,
  15    dynamic range compression, fixed EQ, level meters conforming to EBU R128.
  16
  17  - Theme engine encapsulating the design demands of each individual
  18    event; Lua code is responsible for setting up the pixel processing
  19    pipelines, running transitions etc., so that the visual look is
  20    consistent between operators.
  21
  22 [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
  23 to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
  24 4400 (ie., without the extra L4 cache from Iris Pro), single-channel DDR3 RAM
  25 (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU).
  26
  27
  28 Nageru is in alpha stage. It currently needs:
  29
  30  - An Intel processor with Intel Quick Sync, or otherwise some hardware
  31    H.264 encoder exposed through VA-API.
  32
  33  - Two Blackmagic USB3 cards, either HDMI or SDI. Note that on some machines,
  34    you may have to run a Linux kernel with power saving compiled out to avoid
  35    LPM (link power management) and bandwidth allocation issues with USB3.
  36    These are driven through the “bmusb“ driver embedded in bmusb/, using
  37    libusb-1.0.
  38
  39  - Movit, my GPU-based video filter library (http://movit.sesse.net).
  40    Newer is almost certainly better; Nageru's needs tends to drive new
  41    features in Movit.
  42
  43  - Qt 5.5 or newer for the GUI.
  44
  45  - libmicrohttpd for the embedded web server.
  46
  47  - ffmpeg for muxing, and for encoding audio.
  48
  49  - Working OpenGL; Movit works with almost any modern OpenGL implementation,
  50    but Nageru has been tested with Mesa 10.x and 11.x only (you probably want
  51    11.x).
  52
  53  - libzita-resampler, for resampling sound sources so that they are in sync
  54    between sources, and also for oversampling for the peak meter.
  55
  56  - Lua, for driving the theme engine.
  57
  58
  59 The patches/ directory contains some patches for upstream software that help
  60 Nageru performance and/or stability. They are all meant for upstream, but
  61 probably will not be in by the time Nageru is released. All except the bmusb
  62 patch are taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my work
  63 email, unlike Nageru itself and bmusb), and under the same license as the
  64 projects they patch.
  65
  66 To start it, just hook up your requipment, type “make” and then “./nageru”.
  67 It is strongly recommended to have the rights to run at real-time priority;
  68 it will make the USB3 threads do so, which will make them a lot more stable.
  69 (A reasonable hack for testing is probably just to run it as root using sudo,
  70 although you might not want to do that in production.) Note also that if you
  71 are running a desktop compositor, it will steal significant amounts of GPU
  72 performance. The same goes for PulseAudio.
  73
  74 Nageru will open a HTTP server at port 9095, where you can extract a live
  75 H264+PCM signal in QuickTime mux (e.g. http://127.0.0.1:9095/stream.mov).
  76 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
  77 users, but you can easily send it around in your internal network and then
  78 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
  79 be saved live to local disk.
  80
  81
  82 The name “Nageru” is a play on the Japanese verb 投げる (nageru), which means
  83 to throw or cast. (I also later learned that it could mean to face defeat or
  84 give up, but that's not the intended meaning.)
  85
  86
  87 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
  88 Intel's copyright license at h264encode.h.
  89
  90
  91 Nageru is Copyright (C) 2015 Steinar H. Gunderson <sgunderson@bigfoot.com>.
  92 Portions Copyright (C) 2003 Rune Holm.
  93 Portions Copyright (C) 2010-2011 Fons Adriaensen <fons@linuxaudio.org>.
  94 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
  95 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
  96
  97
  98 This program is free software: you can redistribute it and/or modify
  99 it under the terms of the GNU General Public License as published by
 100 the Free Software Foundation, either version 3 of the License, or
 101 (at your option) any later version.
 102
 103 This program is distributed in the hope that it will be useful,
 104 but WITHOUT ANY WARRANTY; without even the implied warranty of
 105 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 106 GNU General Public License for more details.
 107
 108 You should have received a copy of the GNU General Public License
 109 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 110
 111
 112 Portions of h264encode.h and h264encode.cpp:
 113
 114 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 115
 116 Permission is hereby granted, free of charge, to any person obtaining a
 117 copy of this software and associated documentation files (the
 118 "Software"), to deal in the Software without restriction, including
 119 without limitation the rights to use, copy, modify, merge, publish,
 120 distribute, sub license, and/or sell copies of the Software, and to
 121 permit persons to whom the Software is furnished to do so, subject to
 122 the following conditions:
 123
 124 The above copyright notice and this permission notice (including the
 125 next paragraph) shall be included in all copies or substantial portions
 126 of the Software.
 127
 128 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 129 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 130 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 131 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
 132 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 133 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 134 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.