X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=6b76d650afeb3d1e88d3a05d8bc3e82501e48191;hb=726e2b853e3b2f080a981546480eb8291b57f458;hp=747588a3d1118ad5dc2cec0b7655fe4e083471c8;hpb=adaeecd2ab8f1da45169861b7af22a0c7af066be;p=nageru diff --git a/README b/README index 747588a..6b76d65 100644 --- a/README +++ b/README @@ -26,20 +26,20 @@ to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU). -Nageru is in alpha stage. It currently needs: +Nageru is in beta stage. It currently needs: - An Intel processor with Intel Quick Sync, or otherwise some hardware - H.264 encoder exposed through VA-API. + H.264 encoder exposed through VA-API. Note that you can use VA-API over + DRM instead of X11, to use a non-Intel GPU for rendering but still use + Quick Sync (by giving e.g. “--va-display /dev/dri/renderD128”). - - Two Blackmagic USB3 cards, either HDMI or SDI. Note that on some machines, - you may have to run a Linux kernel with power saving compiled out to avoid - LPM (link power management) and bandwidth allocation issues with USB3. - These are driven through the “bmusb“ driver embedded in bmusb/, using - libusb-1.0. + - Two or more Blackmagic USB3 cards, either HDMI or SDI. These are driven + through the “bmusb” driver embedded in bmusb/, using libusb-1.0. + Note that you will want a recent Linux kernel to avoid LPM (link power + management) and bandwidth allocation issues with USB3. - - Movit, my GPU-based video filter library (http://movit.sesse.net). - Newer is almost certainly better; Nageru's needs tends to drive new - features in Movit. + - Movit, my GPU-based video filter library (https://movit.sesse.net). + You will need at least version 1.3.0. - Qt 5.5 or newer for the GUI. @@ -47,9 +47,11 @@ Nageru is in alpha stage. It currently needs: - ffmpeg for muxing, and for encoding audio. - - Working OpenGL; Movit works with almost any modern OpenGL implementation, - but Nageru has been tested with Mesa 10.x and 11.x only (you probably want - 11.x). + - Working OpenGL; Movit works with almost any modern OpenGL implementation. + Nageru has been tested with Intel on Mesa 10.x and 11.x (you probably want + 11.x), and with NVIDIA's proprietary drivers. AMD's proprietary drivers + (fglrx) are known not to work due to driver bugs; I am in contact with + AMD to try to get this resolved. - libzita-resampler, for resampling sound sources so that they are in sync between sources, and also for oversampling for the peak meter. @@ -57,6 +59,16 @@ Nageru is in alpha stage. It currently needs: - Lua, for driving the theme engine. +If on Debian stretch or something similar, you can install everything you need +with: + + git submodule update --init + apt install qtbase5-dev qt5-default pkg-config libmicrohttpd-dev \ + libusb-1.0-0-dev liblua5.2-dev libzita-resampler-dev libva-dev \ + libavcodec-dev libavformat-dev libswscale-dev libmovit-dev \ + libegl1-mesa-dev libasound2-dev + + The patches/ directory contains some patches for upstream software that help Nageru performance and/or stability. They are all meant for upstream, but probably will not be in by the time Nageru is released. All except the bmusb @@ -64,7 +76,7 @@ patch are taken to be by Steinar H. Gunderson (ie., my work email, unlike Nageru itself and bmusb), and under the same license as the projects they patch. -To start it, just hook up your requipment, type “make” and then “./nageru”. +To start it, just hook up your equipment, type “make” and then “./nageru”. It is strongly recommended to have the rights to run at real-time priority; it will make the USB3 threads do so, which will make them a lot more stable. (A reasonable hack for testing is probably just to run it as root using sudo, @@ -85,11 +97,15 @@ to throw or cast. (I also later learned that it could mean to face defeat or give up, but that's not the intended meaning.) +Nageru's home page is at https://nageru.sesse.net/, where you can also find +contact information and link to the latest version. + + Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see Intel's copyright license at h264encode.h. -Nageru is Copyright (C) 2015 Steinar H. Gunderson . +Nageru is Copyright (C) 2015 Steinar H. Gunderson . Portions Copyright (C) 2003 Rune Holm. Portions Copyright (C) 2010-2015 Fons Adriaensen . Portions Copyright (C) 2012-2015 Fons Adriaensen .