X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=intro.rst;h=131ab9d6e088c689125e050043e08d0803654b36;hb=HEAD;hp=331682ba9760ecf8c087083de19fbff3487bac04;hpb=ebc1f8d4cd9128b057f385ae46fd15bdfa5c26ed;p=nageru-docs diff --git a/intro.rst b/intro.rst index 331682b..131ab9d 100644 --- a/intro.rst +++ b/intro.rst @@ -45,55 +45,81 @@ usually give you a newer version). It currently need: - Qt 5.5 or newer for the GUI. - - QCustomPlot for the histogram display in the frame analyzer. + - QCustomPlot for the histogram display in the frame analyzer + (no longer needed from Nageru 2.2.0). - libmicrohttpd for the embedded web server. - x264 for encoding high-quality video suitable for streaming to end users. - - ffmpeg for muxing, and for encoding audio. You will need at least - version 3.1. + - FFmpeg for muxing, and for encoding audio. You will need at least + version 5.0. - Working OpenGL; Movit works with almost any modern OpenGL implementation. - Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due - to critical stability bugfixes), and with NVIDIA's proprietary drivers. + Nageru has been tested with Intel on Mesa), and with NVIDIA's proprietary drivers. The status of AMD's proprietary drivers is currently unknown. - libzita-resampler, for resampling sound sources so that they are in sync between sources, and also for oversampling for the peak meter. - - LuaJIT, for driving the theme engine. + - LuaJIT, for driving the theme engine. You will need at least version 2.1. - - libpci, for printing friendly PCI device names in an error message. + - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not + available. - - Optional: CEF (Chromium Embedded Framework), for HTML graphics. + - Protocol Buffers (protobuf), for storing various forms of settings and + state. + + - Meson, for building. + + - Optional: CEF (Chromium Embedded Framework), for :doc:`HTML graphics `. If you build without CEF, the HTMLInput class will not be available from the theme. You can get binary downloads of CEF from http://opensource.spotify.com/cefbuilds/index.html - Simply download the right build for your platform (the “minimal” build - is fine) and add CEF_DIR=/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64 - on the make command line (substituting X with the real version as required). + Download the right build for your platform (the “minimal” build + is fine) and add -Dcef_dir=/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64 + on the meson command line (substituting X with the real version as required). + + - Optional: libsrt, for SRT inputs (by default, Nageru will listen on + port 9710, although you can change this port on the command line, + turn it off with --srt-port -1, or turn it off live in the UI). + SRT can also be used for output in addition to listening for HTTP + (see --srt-destination). If you build with libsrt, make sure it is not + linked to OpenSSL, for license reasons. + + - Optional: SVT-AV1, for encoding high-quality video suitable for streaming to + end users (higher quality than using x264, but not nearly as mature). + You will need at least version 1.5.0. + + +:doc:`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). -If on Debian stretch or something similar, you can install everything you need + - SQLite, for storing state. + +If on Debian bullseye or something similar, you can install everything you need with: - apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \ + + apt install qtbase5-dev libqt5opengl5-dev qt5-default \ pkg-config libmicrohttpd-dev libusb-1.0-0-dev libluajit-5.1-dev \ 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 libpci-dev + libprotobuf-dev libsqlite3-dev meson libjpeg-dev libsrt-gnutls-dev -Exceptions as of February 2018: - - You will need Movit from unstable; stretch only has 1.4.0. +Exceptions as of September 2023: - - You will need bmusb from unstable; stretch only has 0.5.4. + - Debian does not carry CEF (but it is optional). You can get experimental + (and not security-supported) CEF Debian packages built for unstable at + http://storage.sesse.net/cef/, and then configure Nageru with - - Debian does not carry CEF (but it is optional). + meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true The patches/ directory contains a patch that helps zita-resampler performance. @@ -101,4 +127,10 @@ 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. -To start it, just hook up your equipment, type “make” and then “./nageru”. +Nageru and Futatabi use Meson to build. For a default build, type + + meson obj && cd obj && ninja + +To start it, hook up your equipment, and then type “./nageru”. + +