From c35d7d322feb8917d242195c5f33c999b61954d4 Mon Sep 17 00:00:00 2001 From: q3aql Date: Fri, 10 Mar 2023 00:22:58 +0100 Subject: [PATCH] Add documentation for ks-av1/ks-av1s --- doc/ks-av1.md | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ks-av1s.md | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 194 insertions(+) create mode 100644 doc/ks-av1.md create mode 100644 doc/ks-av1s.md diff --git a/doc/ks-av1.md b/doc/ks-av1.md new file mode 100644 index 0000000..20696af --- /dev/null +++ b/doc/ks-av1.md @@ -0,0 +1,97 @@ +ks-av1 - Convert video file to compact and efficient AV1 Codec. +=============================================================== + +### Syntax: + +```shell +$ ks-av1 +``` + +### Default configuration: + + * The script `ks-av1` use by default the following configuration: + + ```shell + - Resolution: 1280x534 + - Video codec: libsvtav1 + - Bitrate video: 2000k + - Audio codec: libvorbis (stereo) + - Bitrate audio: 160k + - Default Audio: spa + - Default Subtitle: spa (forced) + - Container: webm + ```` + + * If you want to change the settings, you need to edit the `~/.ks-tools/ks-av1` file and change the following variables: + + ```shell + rel_size="1280x534" + vcodec="libsvtav1" + b_vcodec="2000k" + acodec="libvorbis" + b_acodec="160k" + default_lang_audio="spa" + default_lang_subt="spa" + v_ext="webm" + ```` + + * RECOMMENDED: You can use the [ks-conf](https://gitlab.com/q3aql/ks-tools/blob/main/doc/ks-conf.md) tool to edit the configuration. + +### Example of use: + + * An example of use would be the following: + + ```shell + $ ks-av1 /data/movies/Example.mkv /data/converted/Example + ```` + + * Executing the command, the file will be analyzed and a wizard will be shown to select the tracks, choose the settings and define the metadata: + + ```shell + * Information of Example.mkv: + + + Video Tracks: + Stream #0:0: Video: h264 (High) + + + Audio Tracks: + Stream #0:1(spa): Audio: ac3 + Stream #0:2(eng): Audio: ac3 + + + Subtitle Tracks: + Stream #0:3(spa): Subtitle: subrip (default) (forced) + Stream #0:4(spa): Subtitle: hdmv_pgs_subtitle + Stream #0:5(spa): Subtitle: subrip (forced) + Stream #0:6(eng): Subtitle: subrip + + * (Default: 0:0) Type the number of video track: + * (Default: 0:1) Type the number of audio track: + * (Default: n) Do you want include subtitles? (y/n): y + * (Default: 0:3) Type the number of subtitle track: 0:5 + * (Default: 1280x534) Type the resolution: + * (Default: n) Do you want apply '-max_muxing_queue_size 9999' patch? (y/n): n + + * METADATA configuration: + + * (Default: Example) Type name of title: + * (Default: 2021) Type the year: 2016 + * (Default: Unknown) Type the genre: Thriller + + * COMMANDS THAT WILL BE EXECUTED: + + # Extract subtitles from file Example.mkv + ffmpeg -i "Example.mkv" -map 0:5 "Example.srt" + + # Convert the file 'Example.mkv' to MP4 + ffmpeg -i "Example.mkv" -fps_mode cfr -af aresample=async=1 -map 0:0 -map 0:1 + -vf subtitles="Example.srt" -s 1280x534 -c:v libsvtav1 -profile:v main -b:v 2000k + -c:a libvorbis -b:a 160k -ac 2 -clev 3dB -slev -6dB -metadata title="Example (2016)" + -metadata date="2016" -metadata genre="Thriller" -metadata:s:v:0 title="Example (2016)" + -metadata:s:a:0 title="aac Stereo Audio (256k)" "Example.webm" + + * (Default: y) Do you want run the conversion? (y/n): n + ```` + +### Back to README.md + +* [Go back](../README.md) + diff --git a/doc/ks-av1s.md b/doc/ks-av1s.md new file mode 100644 index 0000000..74da28a --- /dev/null +++ b/doc/ks-av1s.md @@ -0,0 +1,97 @@ +ks-av1s - Convert video file to compact and efficient AV1 Codec (Series). +========================================================================= + +### Syntax: + +```shell +$ ks-av1s +``` + +### Default configuration: + + * The script `ks-av1s` use by default the following configuration: + + ```shell + - Resolution: 720x480 + - Video codec: libsvtav1 + - Bitrate video: 850k + - Audio codec: libvorbis (stereo) + - Bitrate audio: 128k + - Default Audio: spa + - Default Subtitle: spa (forced) + - Container: webm + ```` + + * If you want to change the settings, you need to edit the `~/.ks-tools/ks-av1s` file and change the following variables: + + ```shell + rel_size="720x480" + vcodec="libsvtav1" + b_vcodec="850k" + acodec="libvorbis" + b_acodec="128k" + default_lang_audio="spa" + default_lang_subt="spa" + v_ext="webm" + ```` + + * RECOMMENDED: You can use the [ks-conf](https://gitlab.com/q3aql/ks-tools/blob/main/doc/ks-conf.md) tool to edit the configuration. + +### Example of use: + + * An example of use would be the following: + + ```shell + $ ks-av1s /data/movies/Example.mkv /data/converted/Example + ```` + + * Executing the command, the file will be analyzed and a wizard will be shown to select the tracks, choose the settings and define the metadata: + + ```shell + * Information of Example.mkv: + + + Video Tracks: + Stream #0:0: Video: h264 (High) + + + Audio Tracks: + Stream #0:1(spa): Audio: ac3 + Stream #0:2(eng): Audio: ac3 + + + Subtitle Tracks: + Stream #0:3(spa): Subtitle: subrip (default) (forced) + Stream #0:4(spa): Subtitle: hdmv_pgs_subtitle + Stream #0:5(spa): Subtitle: subrip (forced) + Stream #0:6(eng): Subtitle: subrip + + * (Default: 0:0) Type the number of video track: + * (Default: 0:1) Type the number of audio track: + * (Default: n) Do you want include subtitles? (y/n): y + * (Default: 0:3) Type the number of subtitle track: 0:5 + * (Default: 720x480) Type the resolution: + * (Default: n) Do you want apply '-max_muxing_queue_size 9999' patch? (y/n): n + + * METADATA configuration: + + * (Default: Example) Type name of title: + * (Default: 2021) Type the year: 2016 + * (Default: Unknown) Type the genre: Thriller + + * COMMANDS THAT WILL BE EXECUTED: + + # Extract subtitles from file Example.mkv + ffmpeg -i "Example.mkv" -map 0:5 "Example.srt" + + # Convert the file 'Example.mkv' to MP4 + ffmpeg -i "Example.mkv" -fps_mode cfr -af aresample=async=1 -map 0:0 -map 0:1 + -vf subtitles="Example.srt" -s 720x480 -c:v libsvtav1 -profile:v main -b:v 850k + -c:a libvorbis -b:a 128k -ac 2 -clev 3dB -slev -6dB -metadata title="Example" + -metadata date="2016" -metadata genre="Thriller" -metadata:s:v:0 title="Example" + -metadata:s:a:0 title="aac Stereo Audio (128k)" "Example.webm" + + * (Default: y) Do you want run the conversion? (y/n): n + ```` + +### Back to README.md + +* [Go back](../README.md) +