]> git.sesse.net Git - nageru-docs/blobdiff - intro.rst
projects / nageru-docs / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Document the return value of choose() and how it is useful.
[nageru-docs] / intro.rst
diff --git a/intro.rst b/intro.rst
index 331682ba9760ecf8c087083de19fbff3487bac04..8ed78ee4e2ea7d04e8fa5197ae2ebb330d5524d3 100644 (file)
--- a/intro.rst
+++ b/intro.rst
@@ -51,8 +51,8 @@ usually give you a newer version). It currently need:
 
  - x264 for encoding high-quality video suitable for streaming to end users.
 
 
  - 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 4.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
 
  - 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
@@ -62,22 +62,32 @@ usually give you a newer version). It currently need:
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
 
  - 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.
+ - SQLite, for storing Futatabi state.
 
 
- - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
+ - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not
+   available.
+
+ - Zita-resampler, for adjusting audio to be in sync with video.
+
+ - Protocol Buffers (protobuf), for storing various forms of settings and
+   state.
+
+ - Meson, for building.
+
+ - Optional: CEF (Chromium Embedded Framework), for :doc:`HTML graphics <html>`.
    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
    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=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
-   on the make command line (substituting X with the real version as required).
+   is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
+   on the meson command line (substituting X with the real version as required).
 
 
 
 
-If on Debian stretch or something similar, you can install everything you need
+If on Debian buster or something similar, you can install everything you need
 with:
 
   apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
 with:
 
   apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
@@ -85,15 +95,16 @@ 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 \
     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
 
 
-Exceptions as of February 2018:
 
 
-  - You will need Movit from unstable; stretch only has 1.4.0.
+Exceptions as of December 2018:
 
 
-  - 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.
 
 
 The patches/ directory contains a patch that helps zita-resampler performance.
@@ -101,4 +112,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 <sesse@google.com> (ie., my ex-work
 email), and under the same license as zita-resampler itself.
 
 It is taken to be by Steinar H. Gunderson <sesse@google.com> (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 uses Meson to build. For a default build, type
+
+  meson obj && cd obj && ninja
+
+To start it, just hook up your equipment, and then type “./nageru”.
+
+
Unnamed repository; edit this file 'description' to name the repository.