X-Git-Url: https://git.sesse.net/?p=nageru;a=blobdiff_plain;f=README;h=ed86214d27d329ecddeb4c8f8c5c3107e1a062e2;hp=ecf5140029921e777145674a1cf5d47065e3f161;hb=1e71f1ad456d64082a1a56bbc79fe0216e5fb5e3;hpb=e9b870a8a0205a4450e097e0cec0ce70acdd7b71 diff --git a/README b/README index ecf5140..ed86214 100644 --- a/README +++ b/README @@ -1,8 +1,8 @@ Nageru is a live video mixer, based around the standard M/E workflow. -Futatabi is a multicamera slow motion video server (currently undocumented). +Futatabi is a multicamera slow motion video server. -Features: +Nageru features: - High performance on modest hardware (720p60 with two input streams on my Thinkpad X240[1]); almost all pixel processing is done on the GPU. @@ -46,7 +46,7 @@ Nageru currently needs: are driven through the “bmusb” driver, using libusb-1.0. If you want zerocopy USB, you need libusb 1.0.21 or newer, as well as a recent kernel (4.6.0 or newer). Zerocopy USB helps not only for performance, - but also for stability. You need at least version 0.7.3. + but also for stability. You need at least version 0.7.4. - Movit, my GPU-based video filter library (https://movit.sesse.net). You will need at least version 1.5.2. @@ -72,8 +72,6 @@ Nageru currently needs: - LuaJIT, for driving the theme engine. You will need at least version 2.1. - - SQLite, for storing Futatabi state. - - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not available. @@ -95,6 +93,14 @@ Nageru currently needs: on the meson command line (substituting X with the real version as required). +Futatabi also needs: + + - A fast GPU with OpenGL 4.5 support (GTX 1080 or similar recommended for + best quality at HD resolutions, although 950 should work). + + - SQLite, for storing state. + + If on Debian buster or something similar, you can install everything you need with: @@ -103,7 +109,7 @@ with: libzita-resampler-dev libva-dev libavcodec-dev libavformat-dev \ libswscale-dev libavresample-dev libmovit-dev libegl1-mesa-dev \ libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \ - libprotobuf-dev libsqlite3-dev meson + libprotobuf-dev libsqlite3-dev meson libjpeg-dev Exceptions as of December 2018: @@ -118,11 +124,13 @@ It is meant for upstream, but was not in at the time Nageru was released. It is taken to be by Steinar H. Gunderson (ie., my ex-work email), and under the same license as zita-resampler itself. -Nageru uses Meson to build. For a default build, type +Nageru and Futatabi use Meson to build. For a default build (building both), +type meson obj && cd obj && ninja -To start it, just hook up your equipment, and then type “./nageru”. +To start Nageru, just hook up your equipment, and then type “./nageru”. +For Futatabi documentation, please see https://nageru.sesse.net/doc/. 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. @@ -163,6 +171,9 @@ The name “Nageru” is a play on the Japanese verb 投げる (nageru), which m 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.) +The name “Futatabi” comes from the Japanese adverb 再び (futatabi), which means +“again” or “for the second time”. + Nageru's home page is at https://nageru.sesse.net/, where you can also find contact information, full documentation and link to the latest version. @@ -178,6 +189,7 @@ Portions Copyright (C) 2010-2015 Fons Adriaensen . Portions Copyright (C) 2012-2015 Fons Adriaensen . Portions Copyright (C) 2008-2015 Fons Adriaensen . Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved. +Portions Copyright (C) 2019 Yngve Molnes. This program is free software: you can redistribute it and/or modify