Documentation for convert tools

This commit is contained in:
q3aql 2021-03-07 20:10:48 +01:00
parent 13760df938
commit 7ab1aea83e
11 changed files with 457 additions and 5 deletions

View File

@ -1,7 +1,7 @@
ks-avi-wrapper - Wrapper for ks-avi to create graphical interfaces.
===================================================================
### TRACKS/CONFIG DETECT::
### TRACKS/CONFIG DETECT:
* `$ ks-avi-wrapper --show-info <video_file>`
* `$ ks-avi-wrapper --show-video-default <video_file>`

82
doc/ks-avi.md Normal file
View File

@ -0,0 +1,82 @@
ks-avi - Convert video file(s) to compact and efficient AVI.
============================================================
### Sintax:
* `$ ks-avi </absolute/path/video.mkv> </path/prefix_name>`
### Default configuration:
* The script `ks-avi` use by default the following configuration:
* `- Resolution: 720x480`
* `- Video codec: libxvid`
* `- Bitrate video: 3000k`
* `- Audio codec: libmp3lame (stereo)`
* `- Bitrate audio: 192k`
* `- Default Audio: spa`
* `- Default Subtitle: spa (forced)`
* `- Container: avi`
* If you want to change the settings, you need to edit the `ks-avi` file and change the following variables:
* `# Basic parameters`
* `rel_size="720x480"`
* `vcodec="libxvid"`
* `b_vcodec="3000k"`
* `acodec="libmp3lame"`
* `b_acodec="192k"`
* `default_lang_audio="spa"`
* `default_lang_subt="spa"`
* `v_ext="avi"`
### Example of use:
* An example of use would be the following:
* `$ ks-avi /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:
* `* 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 AVI`
* ` ffmpeg -i "Example.mkv" -map 0:0 -map 0:1 -vf subtitles="Example.srt" -s 720x480 -c:v libxvid -b:v 3000k -c:a libmp3lame -b:a 192k -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="libmp3lame Stereo Audio (192k)" "Example.avi"`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

View File

@ -1,7 +1,7 @@
ks-mp4-wrapper - Wrapper for ks-mp4 to create graphical interfaces.
===================================================================
### TRACKS/CONFIG DETECT::
### TRACKS/CONFIG DETECT:
* `$ ks-mp4-wrapper --show-info <video_file>`
* `$ ks-mp4-wrapper --show-video-default <video_file>`

View File

@ -0,0 +1,86 @@
ks-mp4 - Convert video file(s) to compact and efficient MP4.
============================================================
### Sintax:
* `$ ks-mp4 </absolute/path/video.mkv> </path/prefix_name>`
### Default configuration:
* The script `ks-mp4` use by default the following configuration:
* `- Resolution: 1280x534`
* `- Video codec: libx264`
* `- Bitrate video: 2400k`
* `- Preset: medium`
* `- Audio codec: aac (stereo)`
* `- Bitrate audio: 256k`
* `- Default Audio: spa`
* `- Default Subtitle: spa (forced)`
* `- Container: mp4`
* If you want to change the settings, you need to edit the `ks-mp4` file and change the following variables:
* `# Basic parameters`
* `rel_size="1280x534"`
* `vcodec="libx264"`
* `b_vcodec="2400k"`
* `# Presets: ultrafast, superfast, veryfast, faster,`
* `# fast, medium (default), slow, slower, veryslow`
* `v_preset="medium"`
* `acodec="aac"`
* `b_acodec="256k"`
* `default_lang_audio="spa"`
* `default_lang_subt="spa"`
* `v_ext="mp4"`
### Example of use:
* An example of use would be the following:
* `$ ks-mp4 /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:
* `* 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" -vsync 1 -async 1 -map 0:0 -map 0:1 -vf subtitles="..srt" -s 1280x534 -c:v libx264 -profile:v high -b:v 2400k -preset medium -c:a aac -b:a 256k -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.mp4"`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

View File

@ -1,7 +1,7 @@
ks-mp4k-wrapper - Wrapper for ks-mp4k to create graphical interfaces.
=====================================================================
### TRACKS/CONFIG DETECT::
### TRACKS/CONFIG DETECT:
* `$ ks-mp4k-wrapper --show-info <video_file>`
* `$ ks-mp4k-wrapper --show-video-default <video_file>`

86
doc/ks-mp4k.md Normal file
View File

@ -0,0 +1,86 @@
ks-mp4k - Convert video file(s) to compact and efficient MP4 (4K).
=================================================================
### Sintax:
* `$ ks-mp4k </absolute/path/video.mkv> </path/prefix_name>`
### Default configuration:
* The script `ks-mp4k` use by default the following configuration:
* `- Resolution: 3840x2160`
* `- Video codec: libx264`
* `- Bitrate video: 6000k`
* `- Preset: medium`
* `- Audio codec: aac (stereo)`
* `- Bitrate audio: 320k`
* `- Default Audio: spa`
* `- Default Subtitle: spa (forced)`
* `- Container: mp4`
* If you want to change the settings, you need to edit the `ks-mp4k` file and change the following variables:
* `# Basic parameters`
* `rel_size="3840x2160"`
* `vcodec="libx264"`
* `b_vcodec="6000k"`
* `# Presets: ultrafast, superfast, veryfast, faster,`
* `# fast, medium (default), slow, slower, veryslow`
* `v_preset="medium"`
* `acodec="aac"`
* `b_acodec="320k"`
* `default_lang_audio="spa"`
* `default_lang_subt="spa"`
* `v_ext="mp4"`
### Example of use:
* An example of use would be the following:
* `$ ks-mp4k /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:
* `* 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: 3840x2160) 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" -vsync 1 -async 1 -map 0:0 -map 0:1 -vf subtitles="..srt" -s 3840x2160 -c:v libx264 -profile:v high -b:v 6000k -preset medium -c:a aac -b:a 320k -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 (320k)" "Example.mp4"`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

47
doc/ks-mp4s-folder.md Normal file
View File

@ -0,0 +1,47 @@
ks-mp4s-folder - Convert videos from folder to MP4 format (Series).
===================================================================
### Sintax:
* `$ ks-mp4s-folder </path/folder> [subs]`
### Examples:
* Convert without subtitles:
* `$ ks-mp4s-folder /data/Westworld`
* Convert with subtitles:
* `$ ks-mp4s-folder /data/Daredevil subs`
* When executing the command you will see the following wizard:
* `* Scanning /data/Westworld`
* `+ Video file(s) in .mkv found!`
* `.`
* `* Files to convert (/data/Westworld):`
* ` + Westworl-1x01.mkv (without subtitles)`
* ` + Westworl-1x02.mkv (without subtitles)`
* ` + Westworl-1x03.mkv (without subtitles)`
* ` + Westworl-1x04.mkv (without subtitles)`
* ` + Westworl-1x05.mkv (without subtitles)`
* ` + Westworl-1x06.mkv (without subtitles)`
* ` + Westworl-1x07.mkv (without subtitles)`
* ` + Westworl-1x08.mkv (without subtitles)`
* ` + Westworl-1x09.mkv (without subtitles)`
* ` + Westworl-1x10.mkv (without subtitles)`
* `.`
* `* The output folder will be '/data/Westworldto-mp4'`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
### Notes:
* The option `subs` apply detection & rendering the forced subtitles.
* You must not use spaces in folders and video files.
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

View File

@ -1,7 +1,7 @@
ks-mp4s-wrapper - Wrapper for ks-mp4s to create graphical interfaces.
===================================================================
### TRACKS/CONFIG DETECT::
### TRACKS/CONFIG DETECT:
* `$ ks-mp4s-wrapper --show-info <video_file>`
* `$ ks-mp4s-wrapper --show-video-default <video_file>`

86
doc/ks-mp4s.md Normal file
View File

@ -0,0 +1,86 @@
ks-mp4s - Convert video file(s) to compact and efficient MP4 (Series).
=====================================================================
### Sintax:
* `$ ks-mp4s </absolute/path/video.mkv> </path/prefix_name>`
### Default configuration:
* The script `ks-mp4s` use by default the following configuration:
* `- Resolution: 720x480`
* `- Video codec: libx264`
* `- Bitrate video: 950k`
* `- Preset: medium`
* `- Audio codec: aac (stereo)`
* `- Bitrate audio: 128k`
* `- Default Audio: spa`
* `- Default Subtitle: spa (forced)`
* `- Container: mp4`
* If you want to change the settings, you need to edit the `ks-mp4s` file and change the following variables:
* `# Basic parameters`
* `rel_size="720x480"`
* `vcodec="libx264"`
* `b_vcodec="950k"`
* `# Presets: ultrafast, superfast, veryfast, faster,`
* `# fast, medium (default), slow, slower, veryslow`
* `v_preset="medium"`
* `acodec="aac"`
* `b_acodec="128k"`
* `default_lang_audio="spa"`
* `default_lang_subt="spa"`
* `v_ext="mp4"`
### Example of use:
* An example of use would be the following:
* `$ ks-mp4s /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:
* `* 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" -vsync 1 -async 1 -map 0:0 -map 0:1 -vf subtitles="..srt" -s 720x480 -c:v libx264 -profile:v high -b:v 950k -preset medium -c:a aac -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.mp4"`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

View File

@ -1,7 +1,7 @@
ks-vob-wrapper - Wrapper for ks-vob to create graphical interfaces.
===================================================================
### TRACKS/CONFIG DETECT::
### TRACKS/CONFIG DETECT:
* `$ ks-vob-wrapper --show-info <video_file>`
* `$ ks-vob-wrapper --show-video-default <video_file>`

65
doc/ks-vob.md Normal file
View File

@ -0,0 +1,65 @@
ks-vob - Convert video file(s) to compact and efficient VOB.
============================================================
### Sintax:
* `$ ks-vob </absolute/path/video.mkv> </path/prefix_name>`
### Default configuration:
* The script `ks-vob` use by default the following configuration:
* `- Resolution: 720x480`
* `- Video codec: mpeg2video`
* `- Bitrate video: 3500k`
* `- Audio codec: libtwolame (stereo)`
* `- Bitrate audio: 192k`
* `- Default Audio: spa`
* `- Split: 30 minutes`
* `- Container: vob`
* If you want to change the settings, you need to edit the `ks-vob` file and change the following variables:
* `# Basic parameters`
* `rel_size="720x480"`
* `vcodec="mpeg2video"`
* `b_vcodec="3500k"`
* `acodec="libtwolame"`
* `b_acodec="192k"`
* `default_lang_audio="spa"`
* `v_ext="avi"`
### Example of use:
* An example of use would be the following:
* `$ ks-vob /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 and choose the settings:
* `* 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`
* `.`
* `* (Default: 0:0) Type the number of video track: `
* `* (Default: 0:1) Type the number of audio track: `
* `* (Default: 720x480) Type the resolution: `
* `* (Default: n) Do you want apply '-max_muxing_queue_size 9999' patch? (y/n): n`
* `.`
* `* CONFIGURATION THAT WILL BE APPLIED:`
* `.`
* ` + Source file: Example.mkv`
* ` + Destination: Example/VTS_01_*`
* ` + Parameters: -map 0:0 -map 0:1 -s 720x480 -c:v mpeg2video -b:v 3500k -c:a libtwolame -b:a 192k -ac 2 -clev 3dB -slev -6dB`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)