From 715b31277492c1ad9332e245c833efc21a1d221f Mon Sep 17 00:00:00 2001 From: 0xboobface <0xboobface@gmail.com> Date: Tue, 9 Apr 2019 18:31:30 +0200 Subject: [PATCH] Add more documentation --- .../src/main/resources/html/docs/Avidemux.md | 9 +++++++ client/src/main/resources/html/docs/FFmpeg.md | 26 +++++++++++++++++++ .../main/resources/html/docs/MKVToolNix.md | 9 +++++++ .../resources/html/docs/PostProcessing.md | 1 + .../html/docs/QuestionsAndAnswers.md | 26 +++++++++++++++++++ 5 files changed, 71 insertions(+) create mode 100644 client/src/main/resources/html/docs/Avidemux.md create mode 100644 client/src/main/resources/html/docs/FFmpeg.md create mode 100644 client/src/main/resources/html/docs/MKVToolNix.md create mode 100644 client/src/main/resources/html/docs/PostProcessing.md create mode 100644 client/src/main/resources/html/docs/QuestionsAndAnswers.md diff --git a/client/src/main/resources/html/docs/Avidemux.md b/client/src/main/resources/html/docs/Avidemux.md new file mode 100644 index 00000000..2385acad --- /dev/null +++ b/client/src/main/resources/html/docs/Avidemux.md @@ -0,0 +1,9 @@ +#### Avidemux +[Avidemux](http://avidemux.sourceforge.net/) is a free video editor designed for simple cutting, filtering and encoding tasks. +It is available for all major platforms. Avidemux can be used to manually remux recordings. + +1. Open the .ts file with Avidemux +2. On the left side select **Copy** for the Video- and Audio-Codec +3. Select your preferred output format, e.g. MP4v2, MKV or AVI +4. Save the video under a different name +5. Enjoy! \ No newline at end of file diff --git a/client/src/main/resources/html/docs/FFmpeg.md b/client/src/main/resources/html/docs/FFmpeg.md new file mode 100644 index 00000000..4758444e --- /dev/null +++ b/client/src/main/resources/html/docs/FFmpeg.md @@ -0,0 +1,26 @@ +#### FFmpeg +[FFmpeg](https://ffmpeg.org) is a multimedia framework, which comes with a very powerful command line tool to process multimedia files. +It is available for all major platforms. FFmpeg can be used to manually and automatically remux recordings. + +##### Installation +* Linux: Use the package manager of your distribution to find and install ffmpeg +* Windows: + 1. Download the latest stable version from the homepage + (You probably want to get the 64-bit statically linked build) + 2. Extract the zip + 3. Add the bin directory to your PATH environment variable + (If you don't know what I'm talking about, do a Youtube search for FFmpeg installation on Windows or something like that) +* macOS: See Windows + +##### Manual remuxing +* Open a terminal (command prompt) and cd into the directory of the recording +* Run FFmpeg: + + `ffmpeg -i AwesomeGirl_-2019-04-04_15-46-19_195.ts -c:v copy -c:a copy AwesomeGirl_-2019-04-04_15-46-19_195.mp4` + + As you can see, the codecs for video and audio are set to copy, which means, that the recording is not reencoded, but just "copied" to + another container format. You could also use mkv or avi for the output file suffix and FFmpeg would create that respective file. Depending + on your hardware specs and the length of the recording, this process probably takes a few seconds up to a couple of minutes. + +##### Automatic remuxing +FFmpeg can also be used to automatically remux recordings. ctbrec provides a [post-processing](/docs/PostProcessing.md) mechanism for this purpose. \ No newline at end of file diff --git a/client/src/main/resources/html/docs/MKVToolNix.md b/client/src/main/resources/html/docs/MKVToolNix.md new file mode 100644 index 00000000..e0be469d --- /dev/null +++ b/client/src/main/resources/html/docs/MKVToolNix.md @@ -0,0 +1,9 @@ +#### MKVToolNix +[MKVToolNix](https://mkvtoolnix.download/) is a collection of tools for the Matroska media container format. +It is available for all major platforms. MKVToolNix can be used to manually remux recordings and convert them +from .ts to .mkv. + +1. Open the .ts file with MKVToolNix GUI +2. Define the output file at the bottom +3. **Start multiplexing** +4. Enjoy! \ No newline at end of file diff --git a/client/src/main/resources/html/docs/PostProcessing.md b/client/src/main/resources/html/docs/PostProcessing.md new file mode 100644 index 00000000..7846af15 --- /dev/null +++ b/client/src/main/resources/html/docs/PostProcessing.md @@ -0,0 +1 @@ +#### Post-Processing \ No newline at end of file diff --git a/client/src/main/resources/html/docs/QuestionsAndAnswers.md b/client/src/main/resources/html/docs/QuestionsAndAnswers.md new file mode 100644 index 00000000..d30cf4f8 --- /dev/null +++ b/client/src/main/resources/html/docs/QuestionsAndAnswers.md @@ -0,0 +1,26 @@ +#### How can I convert the recordings to mp4 / mkv? +To convert the files to another format, you have to remux them. You don't have to reencode them, since the +files (usually, have not seen an exception yet) already contain H.264 video and AAC audio. You can remux the +files manually with tools like [Avidemux](/docs/Avidemux.md), [MKVToolNix](/docs/MKVToolNix.md) or +[FFmpeg](/docs/FFmpeg.md) or use one of the post-processing scripts. + +#### Streams are not getting recorded even though the model is online +- Is "Leave space on device set" and do you have enough space left? +- Is "Maximum resolution" set? In case maximum resolution is set and ctbrec cannot determine the + resolution of a stream, the stream will not be recorded. +- Is "Concurrent Recordings" set and you reached the maximum? + +#### How can I playback the recorded .ts files? +Use one of the following players: +- [mpv](https://mpv.io/installation/) +- [VLC](https://www.videolan.org/vlc/) + +#### How can I playback the server recordings? +Use one of the following players: +- [mpv](https://mpv.io/installation/) +- [VLC](https://www.videolan.org/vlc/) + +If you have direct access to the recordings you can use these players and open the playlist.m3u8. +Otherwise use the ctbrec client. Set the **Record Location** to **Remote** and configure your server. +Under **General** select the **Player** of your choice. Then you can start the playback directly from the +**Recordings** tab.