q3aql/ks-tools
q3aql/ks-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update all doc

Browse Source
This commit is contained in:
q3aql 2021-04-18 00:21:59 +02:00
parent b4edbae0ae
commit f0e53425b1
21 changed files with 1004 additions and 710 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/ks-avi-wrapper.md
View File

@ -3,33 +3,43 @@ ks-avi-wrapper - Wrapper for ks-avi to create graphical interfaces.
### TRACKS/CONFIG DETECT:
* `$ ks-avi-wrapper --show-info <video_file>`
* `$ ks-avi-wrapper --show-video-default <video_file>`
* `$ ks-avi-wrapper --show-audio-default <video_file>`
* `$ ks-avi-wrapper --show-subtitle-default <video_file>`
* `$ ks-avi-wrapper --show-resolution-default`
```shell
$ ks-avi-wrapper --show-info <video_file>
$ ks-avi-wrapper --show-video-default <video_file>
$ ks-avi-wrapper --show-audio-default <video_file>
$ ks-avi-wrapper --show-subtitle-default <video_file>
$ ks-avi-wrapper --show-resolution-default
````
### METADATA DETECT:
* `$ ks-avi-wrapper --show-name-title-default <video_file>`
* `$ ks-avi-wrapper --show-year-default`
* `$ ks-avi-wrapper --show-genre-default`
```shell
$ ks-avi-wrapper --show-name-title-default <video_file>
$ ks-avi-wrapper --show-year-default
$ ks-avi-wrapper --show-genre-default
```
### CONVERT:
* `$ ks-avi-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
* `$ ks-avi-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
```shell
$ ks-avi-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]
$ ks-avi-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]
```
### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
* `$ ks-avi-wrapper --conv </path/video_file> </path/output_prefix>`
* `$ ks-avi-wrapper --conv-with-sub </path/video_file> </path/output_prefix>`
```shell
$ ks-avi-wrapper --conv </path/video_file> </path/output_prefix>
$ ks-avi-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
```
### EXAMPLES:
* `$ ks-avi-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy"`
* `$ ks-avi-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"`
* `$ ks-avi-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy" patch`
```shell
$ ks-avi-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy"
$ ks-avi-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"
$ ks-avi-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy" patch
```
### Notes:
@ -39,4 +49,4 @@ ks-avi-wrapper - Wrapper for ks-avi to create graphical interfaces.
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

139
doc/ks-avi.md
View File

@ -3,82 +3,97 @@ ks-avi - Convert video file(s) to compact and efficient AVI.
### Syntax:
* `$ ks-avi </absolute/path/video.mkv> </path/prefix_name>`
```shell
$ 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`
* `- Preset: slow`
* `- Audio codec: libmp3lame (stereo)`
* `- Bitrate audio: 192k`
* `- Default Audio: spa`
* `- Default Subtitle: spa (forced)`
* `- Container: avi`
```shell
- Resolution: 720x480
- Video codec: libxvid
- Bitrate video: 3000k
- Preset: slow
- 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"`
* `# Presets: ultrafast, superfast, veryfast, faster,`
* `# fast, medium (default), slow, slower, veryslow`
* `v_preset="slow"`
* `acodec="libmp3lame"`
* `b_acodec="192k"`
* `default_lang_audio="spa"`
* `default_lang_subt="spa"`
* `v_ext="avi"`
```shell
# Basic parameters
rel_size="720x480"
vcodec="libxvid"
b_vcodec="3000k"
# Presets: ultrafast, superfast, veryfast, faster,
# fast, medium (default), slow, slower, veryslow
v_preset="slow"
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`
```shell
$ 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 -preset slow -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`
```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 AVI
ffmpeg -i "Example.mkv" -vsync 1 -async 1 -map 0:0 -map 0:1
-vf subtitles="Example.srt" -s 720x480 -c:v libxvid -b:v 3000k
-preset slow -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

124
doc/ks-crop.md
View File

@ -3,52 +3,66 @@ ks-crop - Crop or change aspect ratio of a video.
### Syntax:
* `$ ks-crop -16:9-crop <video-file> --> Crop from 4:3/IMAX to 16:9 (1.77:1)`
* `$ ks-crop -4:3-crop <video-file> --> Crop from 16:9 to 4:3 (1.33:1)`
* `$ ks-crop -5:4-crop <video-file> --> Crop from 16:9 to 5:4 (1.25:1)`
* `$ ks-crop -imax-crop <video-file> --> Crop from 16:9 to IMAX (1.43:1)`
* `.`
* `$ ks-crop -16:9-aspect <video-file> --> Change aspect to 16:9 (stretched)`
* `$ ks-crop -4:3-aspect <video-file> --> Change aspect to 4:3 (stretched)`
* `$ ks-crop -5:4-aspect <video-file> --> Change aspect to 5:4 (stretched)`
```shell
$ ks-crop -16:9-crop <video-file> --> Crop from 4:3/IMAX to 16:9 (1.77:1)
$ ks-crop -4:3-crop <video-file> --> Crop from 16:9 to 4:3 (1.33:1)
$ ks-crop -5:4-crop <video-file> --> Crop from 16:9 to 5:4 (1.25:1)
$ ks-crop -imax-crop <video-file> --> Crop from 16:9 to IMAX (1.43:1)
$ ks-crop -16:9-aspect <video-file> --> Change aspect to 16:9 (stretched)
$ ks-crop -4:3-aspect <video-file> --> Change aspect to 4:3 (stretched)
$ ks-crop -5:4-aspect <video-file> --> Change aspect to 5:4 (stretched)
```
### Default configuration:
* The script `ks-crop` use by default the following configuration:
* `- Video codec: libx264`
* `- Bitrate video: 5000k`
* `- Preset: medium`
* `- Audio codec: copy`
* `- Default Audio: spa`
* `- Container: mkv`
```shell
- Video codec: libx264
- Bitrate video: 5000k
- Preset: medium
- Audio codec: copy
- Default Audio: spa
- Container: mkv
````
* If you want to change the settings, you need to edit the `ks-crop` file and change the following variables:
* `v_preset="medium"`
* `vcodec="libx264"`
* `b_vcodec="5000k"`
* `acodec="copy"`
* `v_ext="mkv"`
* `default_lang_audio="spa"`
```shell
v_preset="medium"
vcodec="libx264"
b_vcodec="5000k"
acodec="copy"
v_ext="mkv"
default_lang_audio="spa"
````
### Examples (Crop):
* Crop from 4:3/IMAX to 16:9 (1.77:1):
* `$ ks-crop -16:9-crop /data/movies/Example.mkv`
```shell
$ ks-crop -16:9-crop /data/movies/Example.mkv
````
* Crop from 16:9 to 4:3 (1.33:1):
* `$ ks-crop -4:3-crop /data/movies/Example.mkv`
```shell
$ ks-crop -4:3-crop /data/movies/Example.mkv
````
* Crop from 16:9 to 5:4 (1.25:1):
* `$ ks-crop -5:4-crop /data/movies/Example.mkv`
```shell
$ ks-crop -5:4-crop /data/movies/Example.mkv
````
* Crop from 16:9 to IMAX (1.43:1):
* `$ ks-crop -imax-crop /data/movies/Example.mkv`
```shell
$ ks-crop -imax-crop /data/movies/Example.mkv
````
_Note: Output file name will be `Example-crop.mkv`._
@ -56,15 +70,21 @@ _Note: Output file name will be `Example-crop.mkv`._
* Change aspect to 16:9 (stretched):
* `$ ks-crop -16:9-aspect /data/movies/Example.mkv`
```shell
$ ks-crop -16:9-aspect /data/movies/Example.mkv
````
* Change aspect to 4:3 (stretched):
* `$ ks-crop -4:3-aspect /data/movies/Example.mkv`
```shell
$ ks-crop -4:3-aspect /data/movies/Example.mkv
````
* Change aspect to 5:4 (stretched):
* `$ ks-crop -5:4-aspect /data/movies/Example.mkv`
```shell
$ ks-crop -5:4-aspect /data/movies/Example.mkv
````
_Note: Output file name will be `Example-aspect.mkv`_
@ -72,27 +92,31 @@ _Note: Output file name will be `Example-aspect.mkv`_
* After executing one of the mentioned commands, a wizard will be displayed to choose the video/audio tracks and define some parameters:
* `* Information of Example.mkv:`
* `.`
* `+ Video Tracks:`
* `Stream #0:0(eng): Video: h264 (High)`
* `.`
* `+ Audio Tracks:`
* `Stream #0:1(spa): Audio: dts (DTS)`
* `Stream #0:2(spa): Audio: ac3`
* `Stream #0:3(eng): Audio: ac3`
* `.`
* `* (Default: 0:0) Type the number of video track: `
* `* (Default: 0:1) Type the number of audio track: `
* `* (Default: 5000k) Type the bitrate (libx264): `
* `* (Default: n) Do you want apply '-max_muxing_queue_size 9999' patch? (y/n): n`
* `.`
* `* COMMAND THAT WILL BE EXECUTED:`
* `.`
* `# Crop 'Example.mkv' from 16:9 to 4:3 (1.33:1)`
* `ffmpeg -i Example.mkv -vsync 1 -async 1 -map 0:0 -map 0:1 -filter:v "crop=ih/3*4:ih" -s 1920x1440 -c:v libx264 -profile:v high -b:v 5000k -preset medium -c:a copy Example-crop.mkv`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
```shell
* Information of Example.mkv:
+ Video Tracks:
Stream #0:0(eng): Video: h264 (High)
+ Audio Tracks:
Stream #0:1(spa): Audio: dts (DTS)
Stream #0:2(spa): Audio: ac3
Stream #0:3(eng): Audio: ac3
* (Default: 0:0) Type the number of video track:
* (Default: 0:1) Type the number of audio track:
* (Default: 5000k) Type the bitrate (libx264):
* (Default: n) Do you want apply '-max_muxing_queue_size 9999' patch? (y/n): n
* COMMAND THAT WILL BE EXECUTED:
# Crop 'Example.mkv' from 16:9 to 4:3 (1.33:1)
ffmpeg -i Example.mkv -vsync 1 -async 1 -map 0:0 -map 0:1
-filter:v "crop=ih/3*4:ih" -s 1920x1440 -c:v libx264 -profile:v high
-b:v 5000k -preset medium -c:a copy Example-crop.mkv
* (Default: y) Do you want run the conversion? (y/n): n
````
### Back to README.md

88
doc/ks-mix.md
View File

@ -3,39 +3,51 @@ ks-mix - Extract video/audio and mix video/audio files.
### Syntax:
* `$ ks-mix -evid <video-file> --> Extract video track`
* `$ ks-mix -ev25 <video-file> --> Extract video track to 25 fps (H264/5 & MPEG4)`
* `$ ks-mix -evpf <video-file> --> Extract video track & set fps (H264/5 & MPEG4)`
* `$ ks-mix -eaud <video-file> --> Extract audio track`
* `$ ks-mix -esub <video-file> --> Extract subtitle track (only for subrip/srt)`
* `$ ks-mix -evti <video-file> --> Extract video from a specific hour/minute/second`
* `$ ks-mix -eati <video-file> --> Extract video from a specific hour/minute/second`
* `$ ks-mix -evat <video-file> --> Extract video + audio from specific time`
* `$ ks-mix -chec <video-file> --> Analyze tracks of video file`
* `$ ks-mix -mixf --> Mix video and audio file`
* `$ ks-mix -mixs --> Mix video, audio and subtitle file`
```shell
$ ks-mix -evid <video-file> --> Extract video track
$ ks-mix -ev25 <video-file> --> Extract video track to 25 fps (H264/5 & MPEG4)
$ ks-mix -evpf <video-file> --> Extract video track & set fps (H264/5 & MPEG4)
$ ks-mix -eaud <video-file> --> Extract audio track
$ ks-mix -esub <video-file> --> Extract subtitle track (only for subrip/srt)
$ ks-mix -evti <video-file> --> Extract video from a specific hour/minute/second
$ ks-mix -eati <video-file> --> Extract video from a specific hour/minute/second
$ ks-mix -evat <video-file> --> Extract video + audio from specific time
$ ks-mix -chec <video-file> --> Analyze tracks of video file
$ ks-mix -mixf --> Mix video and audio file
$ ks-mix -mixs --> Mix video, audio and subtitle file
```
### Examples (Extract video/audio):
* Extract video from video file:
* `$ ks-mix -evid /data/movies/Example.mkv`
```shell
$ ks-mix -evid /data/movies/Example.mkv
````
* Extract audio from video file:
* `$ ks-mix -eaud /data/movies/Example.avi`
```shell
$ ks-mix -eaud /data/movies/Example.avi
````
* Extract subtitles from video file:
* `$ ks-mix -esub /data/movies/Example.mkv`
```shell
$ ks-mix -esub /data/movies/Example.mkv
````
* Extract video from video file and change FPS to 25:
* `$ ks-mix -ev25 /data/movies/Example.mkv`
```shell
$ ks-mix -ev25 /data/movies/Example.mkv
````
* Extract video from video file and change to custom FPS:
* `$ ks-mix -evpf /data/movies/Example.mkv`
```shell
$ ks-mix -evpf /data/movies/Example.mkv
````
_Note: Extracted video will be named `video.mkv` and extracted audio will be named `audio.mka`_
@ -43,15 +55,21 @@ _Note: Extracted video will be named `video.mkv` and extracted audio will be nam
* Extract video from a specific hour/minute/second:
* `$ ks-mix -evti /data/movies/Example.mkv`
```shell
$ ks-mix -evti /data/movies/Example.mkv
````
* Extract audio from a specific hour/minute/second:
* `$ ks-mix -eati /data/movies/Example.avi`
```shell
$ ks-mix -eati /data/movies/Example.avi
````
* Extract video + audio from a hour/minute/second:
* `$ ks-mix -evat /data/movies/Example.mkv`
```shell
$ ks-mix -evat /data/movies/Example.mkv
````
_Note: After executing the command, an assistant will ask us from what hour, minute and second we want to cut the video. We can cut it to the end or the specified time._
@ -59,25 +77,31 @@ _Note: After executing the command, an assistant will ask us from what hour, min
* If you have extracted video and audio from different files, when you run the `ks-mix` command you will see the following:
* `+ Video file: /current/dir/video.mkv (FOUND)`
* `+ Audio file: /current/dir/audio.mka (FOUND)`
* `+ Subs file: /current/dir/subs.srt (NOT FOUND)`
```shell
+ Video file: /current/dir/video.mkv (FOUND)
+ Audio file: /current/dir/audio.mka (FOUND)
+ Subs file: /current/dir/subs.srt (NOT FOUND)
````
* Next, run the following command to merge the video and audio:
* `$ ks-mix -mixf`
```shell
$ ks-mix -mixf
````
* Finally, you will see a wizard that will allow you to crop seconds of video or audio to synchronize them:
```shell
* [Default: 0] Set the seconds to cut in the video (0-59): 3
* [Default: 0] Set the seconds to cut in the audio (0-59): 1
* [Default: n] Finish the mix when one of the two (video or audio) finishes first? (y/n): y
* `* [Default: 0] Set the seconds to cut in the video (0-59): 3`
* `* [Default: 0] Set the seconds to cut in the audio (0-59): 1`
* `* [Default: n] Finish the mix when one of the two (video or audio) finishes first? (y/n): y`
* `.`
* `* Starting mix of:`
* ` - Video: /home/q3aql/.torrent/Conv/video.mkv`
* ` - Audio: /home/q3aql/.torrent/Conv/audio.mka`
* `.`
* ` Output file: /home/q3aql/.torrent/Conv/output.mkv`
* Starting mix of:`
- Video: /home/q3aql/.torrent/Conv/video.mkv
- Audio: /home/q3aql/.torrent/Conv/audio.mka
Output file: /home/q3aql/.torrent/Conv/output.mkv
````
### Back to README.md

68
doc/ks-mp3-album.md
View File

@ -3,50 +3,60 @@ ks-mp3-album - Convert folder album to MP3 Audio Format.
### Syntax:
* `$ ks-mp3-album </absolute/path/album>`
```shell
$ ks-mp3-album </absolute/path/album>
```
### Default configuration:
* The script `ks-mp3-album` use by default the following configuration:
* `- Audio codec: libmp3lame`
* `- Bitrate audio: 128k`
* `- Container: oga`
```shell
- Audio codec: libmp3lame
- Bitrate audio: 128k
- Container: oga
````
* If you want to change the settings, you need to edit the `ks-mp3-album` file and change the following variables:
* `# Basic parameters`
* `acodec="libmp3lame"`
* `b_acodec="128k"`
* `v_ext="mp3"`
* `default_lang_audio="spa"`
```shell
# Basic parameters
acodec="libmp3lame"
b_acodec="128k"
v_ext="mp3"
default_lang_audio="spa"
````
### Example of use:
* An example of use would be the following:
* `$ ks-mp3-album /data/albums/matrix-soundtrack`
```shell
$ ks-mp3-album /data/albums/matrix-soundtrack
````
* Executing the command, the folder will be analized and you can see the following wizard:
```shell
* Scanning /data/albums/matrix-soundtrack
+ Video file(s) in .mp4 found!
* `* Scanning /data/albums/matrix-soundtrack`
* `+ Video file(s) in .mp4 found!`
* `.`
* `* Common METADATA configuration:`
* `.`
* `* (Default: Album-Disc) Type name of album: Matrix Soundtrack`
* `* (Default: 2021) Type the year of album: 1999`
* `* (Default: Pop) Type the genre of album: Original Motion Picture Soundtrack`
* `.`
* `* List of files:`
* `.`
* ` + track01.mp4`
* ` + track02.mp4`
* ` + track03.mp4`
* `.`
* `* The output folder will be '/home/q3aql/.torrent/Conv/matrix-soundtrack/to-mp3'`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): y`
* Common METADATA configuration:
* (Default: Album-Disc) Type name of album: Matrix Soundtrack
* (Default: 2021) Type the year of album: 1999
* (Default: Pop) Type the genre of album: Original Motion Picture Soundtrack
* List of files:
+ track01.mp4
+ track02.mp4
+ track03.mp4
* The output folder will be '/data/albums/matrix-soundtrack/to-mp3'
* (Default: y) Do you want run the conversion? (y/n): y
````
### Back to README.md

79
doc/ks-mp3.md
View File

@ -3,55 +3,68 @@ ks-mp3 - Convert video/audio file(s) to MP3 (Audio) Format.
### Syntax:
* `$ ks-mp3 </absolute/path/song.ogg> </path/prefix_name>`
```shell
$ ks-mp3 </absolute/path/song.ogg> </path/prefix_name>
```
### Default configuration:
* The script `ks-mp3` use by default the following configuration:
* `- Audio codec: libmp3lame`
* `- Bitrate audio: 128k`
* `- Container: mp3`
```shell
- Audio codec: libmp3lame
- Bitrate audio: 128k
- Container: mp3
````
* If you want to change the settings, you need to edit the `ks-mp3` file and change the following variables:
* `# Basic parameters`
* `acodec="libmp3lame"`
* `b_acodec="128k"`
* `v_ext="mp3"`
* `default_lang_audio="spa"`
```shell
# Basic parameters
acodec="libmp3lame"
b_acodec="128k"
v_ext="mp3"
default_lang_audio="spa"
````
### Example of use:
* An example of use would be the following:
* `$ ks-mp3 /data/video/Example.mkv /data/audio/Example`
```shell
$ ks-mp3 /data/video/Example.mkv /data/audio/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:
* `* Information of Example.mkv:`
* `.`
* `+ Audio Tracks:`
* ` Stream #0:1(spa): Audio: ac3`
* ` Stream #0:2(eng): Audio: ac3`
* `.`
* `* (Default: 0:1) Type the number of audio track: `
* `.`
* `* METADATA configuration:`
* `.`
* `* (Default: Example) Type name of title: My song`
* `* (Default: Album-Disc) Type name of album: My personal album`
* `* (Default: 01) Type number of track: 2`
* `* (Default: Artist) Type name of artist: q3aql`
* `* (Default: 2021) Type the year: 2016`
* `* (Default: Pop) Type the genre: Rap`
* `.`
* `* COMMANDS THAT WILL BE EXECUTED:`
* `.`
* ` # Convert the file 'Example.mkv' to MP3 Audio`
* ` ffmpeg -i "Example.mkv" -map 0:1 -c:a libmp3lame -b:a 128k -metadata title="My song" -metadata date="2016" -metadata genre="Rap" -metadata album="My personal album" -metadata artist="q3aql" -metadata track="2" "Example.mp3"`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
+ Audio Tracks:
Stream #0:1(spa): Audio: ac3
Stream #0:2(eng): Audio: ac3
* (Default: 0:1) Type the number of audio track:
* METADATA configuration:
* (Default: Example) Type name of title: My song
* (Default: Album-Disc) Type name of album: My personal album
* (Default: 01) Type number of track: 2
* (Default: Artist) Type name of artist: q3aql
* (Default: 2021) Type the year: 2016
* (Default: Pop) Type the genre: Rap
* COMMANDS THAT WILL BE EXECUTED:
# Convert the file 'Example.mkv' to MP3 Audio
ffmpeg -i "Example.mkv" -map 0:1 -c:a libmp3lame -b:a 128k
-metadata title="My song" -metadata date="2016" -metadata genre="Rap"
-metadata album="My personal album" -metadata artist="q3aql"
-metadata track="2" "Example.mp3"
* (Default: y) Do you want run the conversion? (y/n): n
````
### Back to README.md

42
doc/ks-mp4-wrapper.md
View File

@ -3,33 +3,43 @@ ks-mp4-wrapper - Wrapper for ks-mp4 to create graphical interfaces.
### TRACKS/CONFIG DETECT:
* `$ ks-mp4-wrapper --show-info <video_file>`
* `$ ks-mp4-wrapper --show-video-default <video_file>`
* `$ ks-mp4-wrapper --show-audio-default <video_file>`
* `$ ks-mp4-wrapper --show-subtitle-default <video_file>`
* `$ ks-mp4-wrapper --show-resolution-default`
```shell
$ ks-mp4-wrapper --show-info <video_file>
$ ks-mp4-wrapper --show-video-default <video_file>
$ ks-mp4-wrapper --show-audio-default <video_file>
$ ks-mp4-wrapper --show-subtitle-default <video_file>
$ ks-mp4-wrapper --show-resolution-default
```
### METADATA DETECT:
* `$ ks-mp4-wrapper --show-name-title-default <video_file>`
* `$ ks-mp4-wrapper --show-year-default`
* `$ ks-mp4-wrapper --show-genre-default`
```shell
$ ks-mp4-wrapper --show-name-title-default <video_file>
$ ks-mp4-wrapper --show-year-default
$ ks-mp4-wrapper --show-genre-default
```
### CONVERT:
* `$ ks-mp4-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
* `$ ks-mp4-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
```shell
$ ks-mp4-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]
$ ks-mp4-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]
```
### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
* `$ ks-mp4-wrapper --conv </path/video_file> </path/output_prefix>`
* `$ ks-mp4-wrapper --conv-with-sub </path/video_file> </path/output_prefix>`
```shell
$ ks-mp4-wrapper --conv </path/video_file> </path/output_prefix>
$ ks-mp4-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
```
### EXAMPLES:
* `$ ks-mp4-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x534 "My video" 2018 "Comedy"`
* `$ ks-mp4-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"`
* `$ ks-mp4-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x720 "My video" 2018 "Comedy" patch`
```shell
$ ks-mp4-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x534 "My video" 2018 "Comedy"
$ ks-mp4-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"
$ ks-mp4-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x720 "My video" 2018 "Comedy" patch
```
### Notes:
@ -39,4 +49,4 @@ ks-mp4-wrapper - Wrapper for ks-mp4 to create graphical interfaces.
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

139
doc/ks-mp4.md
View File

@ -3,82 +3,97 @@ ks-mp4 - Convert video file(s) to compact and efficient MP4.
### Syntax:
* `$ ks-mp4 </absolute/path/video.mkv> </path/prefix_name>`
```shell
$ 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`
```shell
- 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"`
```shell
# 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`
```shell
$ 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:
```shell
* Information of Example.mkv:
+ Video Tracks:
Stream #0:0: Video: h264 (High)
* `* 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`
+ 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="Example.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

42
doc/ks-mp4k-wrapper.md
View File

@ -3,33 +3,43 @@ ks-mp4k-wrapper - Wrapper for ks-mp4k to create graphical interfaces.
### TRACKS/CONFIG DETECT:
* `$ ks-mp4k-wrapper --show-info <video_file>`
* `$ ks-mp4k-wrapper --show-video-default <video_file>`
* `$ ks-mp4k-wrapper --show-audio-default <video_file>`
* `$ ks-mp4k-wrapper --show-subtitle-default <video_file>`
* `$ ks-mp4k-wrapper --show-resolution-default`
```shell
$ ks-mp4k-wrapper --show-info <video_file>
$ ks-mp4k-wrapper --show-video-default <video_file>
$ ks-mp4k-wrapper --show-audio-default <video_file>
$ ks-mp4k-wrapper --show-subtitle-default <video_file>
$ ks-mp4k-wrapper --show-resolution-default
```
### METADATA DETECT:
* `$ ks-mp4k-wrapper --show-name-title-default <video_file>`
* `$ ks-mp4k-wrapper --show-year-default`
* `$ ks-mp4k-wrapper --show-genre-default`
```shell
$ ks-mp4k-wrapper --show-name-title-default <video_file>
$ ks-mp4k-wrapper --show-year-default
$ ks-mp4k-wrapper --show-genre-default
```
### CONVERT:
* `$ ks-mp4k-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
* `$ ks-mp4k-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
```shell
$ ks-mp4k-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]
$ ks-mp4k-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]
```
### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
* `$ ks-mp4k-wrapper --conv </path/video_file> </path/output_prefix>`
* `$ ks-mp4k-wrapper --conv-with-sub </path/video_file> </path/output_prefix>`
```shell
$ ks-mp4k-wrapper --conv </path/video_file> </path/output_prefix>
$ ks-mp4k-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
```
### EXAMPLES:
* `$ ks-mp4k-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 3840x2160 "My video" 2018 "Comedy"`
* `$ ks-mp4k-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"`
* `$ ks-mp4k-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 3840x2160 "My video" 2018 "Comedy" patch`
```shell
$ ks-mp4k-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 3840x2160 "My video" 2018 "Comedy"
$ ks-mp4k-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"
$ ks-mp4k-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 3840x2160 "My video" 2018 "Comedy" patch
```
### Notes:
@ -39,4 +49,4 @@ ks-mp4k-wrapper - Wrapper for ks-mp4k to create graphical interfaces.
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

137
doc/ks-mp4k.md
View File

@ -3,82 +3,97 @@ ks-mp4k - Convert video file(s) to compact and efficient MP4 (4K).
### Syntax:
* `$ ks-mp4k </absolute/path/video.mkv> </path/prefix_name>`
```shell
$ 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`
```shell
- 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"`
```shell
# 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`
```shell
$ 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`
```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: 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="Example.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

50
doc/ks-mp4s-folder.md
View File

@ -3,38 +3,46 @@ ks-mp4s-folder - Convert videos from folder to MP4 format (Series).
### Syntax:
* `$ ks-mp4s-folder </path/folder> [subs]`
```shell
$ ks-mp4s-folder </path/folder> [subs]
```
### Examples:
* Convert without subtitles:
* `$ ks-mp4s-folder /data/Westworld`
```shell
$ ks-mp4s-folder /data/Westworld
````
* Convert with subtitles:
* `$ ks-mp4s-folder /data/Daredevil subs`
```shell
$ ks-mp4s-folder /data/Daredevil subs
````
* When executing the command you will see the following wizard:
```shell
* Scanning /data/Westworld
+ Video file(s) in .mkv found!
* `* 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`
* 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/Westworld/to-mp4'
* (Default: y) Do you want run the conversion? (y/n): n
````
### Notes:

42
doc/ks-mp4s-wrapper.md
View File

@ -3,33 +3,43 @@ ks-mp4s-wrapper - Wrapper for ks-mp4s to create graphical interfaces.
### TRACKS/CONFIG DETECT:
* `$ ks-mp4s-wrapper --show-info <video_file>`
* `$ ks-mp4s-wrapper --show-video-default <video_file>`
* `$ ks-mp4s-wrapper --show-audio-default <video_file>`
* `$ ks-mp4s-wrapper --show-subtitle-default <video_file>`
* `$ ks-mp4s-wrapper --show-resolution-default`
```shell
$ ks-mp4s-wrapper --show-info <video_file>
$ ks-mp4s-wrapper --show-video-default <video_file>
$ ks-mp4s-wrapper --show-audio-default <video_file>
$ ks-mp4s-wrapper --show-subtitle-default <video_file>
$ ks-mp4s-wrapper --show-resolution-default
```
### METADATA DETECT:
* `$ ks-mp4s-wrapper --show-name-title-default <video_file>`
* `$ ks-mp4s-wrapper --show-year-default`
* `$ ks-mp4s-wrapper --show-genre-default`
```shell
$ ks-mp4s-wrapper --show-name-title-default <video_file>
$ ks-mp4s-wrapper --show-year-default
$ ks-mp4s-wrapper --show-genre-default
```
### CONVERT:
* `$ ks-mp4s-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
* `$ ks-mp4s-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]`
```shell
$ ks-mp4s-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]
$ ks-mp4s-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]
```
### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
* `$ ks-mp4s-wrapper --conv </path/video_file> </path/output_prefix>`
* `$ ks-mp4s-wrapper --conv-with-sub </path/video_file> </path/output_prefix>`
```shell
$ ks-mp4s-wrapper --conv </path/video_file> </path/output_prefix>
$ ks-mp4s-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
```
### EXAMPLES:
* `$ ks-mp4s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy"`
* `$ ks-mp4s-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"`
* `$ ks-mp4s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy" patch`
```shell
$ ks-mp4s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy"
$ ks-mp4s-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"
$ ks-mp4s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy" patch
```
### Notes:
@ -39,4 +49,4 @@ ks-mp4s-wrapper - Wrapper for ks-mp4s to create graphical interfaces.
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

137
doc/ks-mp4s.md
View File

@ -3,82 +3,97 @@ ks-mp4s - Convert video file(s) to compact and efficient MP4 (Series).
### Syntax:
* `$ ks-mp4s </absolute/path/video.mkv> </path/prefix_name>`
```shell
$ 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`
```shell
- 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"`
```shell
# 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`
```shell
$ 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`
```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" -vsync 1 -async 1 -map 0:0 -map 0:1
-vf subtitles="Example.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

66
doc/ks-oga-album.md
View File

@ -3,50 +3,60 @@ ks-oga-album - Convert folder album to OGA (OGG Audio) Format.
### Syntax:
* `$ ks-oga-album </absolute/path/album>`
```shell
$ ks-oga-album </absolute/path/album>
```
### Default configuration:
* The script `ks-oga-album` use by default the following configuration:
* `- Audio codec: libvorbis`
* `- Bitrate audio: 130k`
* `- Container: oga`
```shell
- Audio codec: libvorbis
- Bitrate audio: 130k
- Container: oga
````
* If you want to change the settings, you need to edit the `ks-oga-album` file and change the following variables:
* `# Basic parameters`
* `acodec="libvorbis"`
* `b_acodec="130k"`
* `v_ext="oga"`
* `default_lang_audio="spa"`
```shell
# Basic parameters`
acodec="libvorbis"`
b_acodec="130k"`
v_ext="oga"`
default_lang_audio="spa"`
````
### Example of use:
* An example of use would be the following:
* `$ ks-oga-album /data/albums/matrix-soundtrack`
```shell
$ ks-oga-album /data/albums/matrix-soundtrack
````
* Executing the command, the folder will be analized and you can see the following wizard:
```shell
* Scanning /data/albums/matrix-soundtrack
+ Video file(s) in .mp4 found!
* `* Scanning /data/albums/matrix-soundtrack`
* `+ Video file(s) in .mp4 found!`
* `.`
* `* Common METADATA configuration:`
* `.`
* `* (Default: Album-Disc) Type name of album: Matrix Soundtrack`
* `* (Default: 2021) Type the year of album: 1999`
* `* (Default: Pop) Type the genre of album: Original Motion Picture Soundtrack`
* `.`
* `* List of files:`
* `.`
* ` + track01.mp4`
* ` + track02.mp4`
* ` + track03.mp4`
* `.`
* `* The output folder will be '/home/q3aql/.torrent/Conv/matrix-soundtrack/to-oga'`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): y`
* Common METADATA configuration:
* (Default: Album-Disc) Type name of album: Matrix Soundtrack
* (Default: 2021) Type the year of album: 1999
* (Default: Pop) Type the genre of album: Original Motion Picture Soundtrack
* List of files:
+ track01.mp4
+ track02.mp4
+ track03.mp4
* The output folder will be '/data/albums/matrix-soundtrack/to-oga'
* (Default: y) Do you want run the conversion? (y/n): y
````
### Back to README.md

81
doc/ks-oga.md
View File

@ -3,55 +3,68 @@ ks-oga - Convert video/audio file(s) to OGA (OGG Audio) Format.
### Syntax:
* `$ ks-oga </absolute/path/song.mp3> </path/prefix_name>`
```shell
$ ks-oga </absolute/path/song.mp3> </path/prefix_name>
```
### Default configuration:
* The script `ks-oga` use by default the following configuration:
* `- Audio codec: libvorbis`
* `- Bitrate audio: 130k`
* `- Container: oga`
```shell
- Audio codec: libvorbis
- Bitrate audio: 130k
- Container: oga
````
* If you want to change the settings, you need to edit the `ks-oga` file and change the following variables:
* `# Basic parameters`
* `acodec="libvorbis"`
* `b_acodec="130k"`
* `v_ext="oga"`
* `default_lang_audio="spa"`
```shell
# Basic parameters
acodec="libvorbis"
b_acodec="130k"
v_ext="oga"
default_lang_audio="spa"
````
### Example of use:
* An example of use would be the following:
* `$ ks-oga /data/video/Example.mkv /data/audio/Example`
```shell
$ ks-oga /data/video/Example.mkv /data/audio/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:`
* `.`
* `+ Audio Tracks:`
* ` Stream #0:1(spa): Audio: ac3`
* ` Stream #0:2(eng): Audio: ac3`
* `.`
* `* (Default: 0:1) Type the number of audio track: `
* `.`
* `* METADATA configuration:`
* `.`
* `* (Default: Example) Type name of title: My song`
* `* (Default: Album-Disc) Type name of album: My personal album`
* `* (Default: 01) Type number of track: 2`
* `* (Default: Artist) Type name of artist: q3aql`
* `* (Default: 2021) Type the year: 2016`
* `* (Default: Pop) Type the genre: Rap`
* `.`
* `* COMMANDS THAT WILL BE EXECUTED:`
* `.`
* ` # Convert the file 'Example.mkv' to OGG Audio`
* ` ffmpeg -i "Example.mkv" -map 0:1 -c:a libvorbis -b:a 130k -metadata title="My song" -metadata date="2016" -metadata genre="Rap" -metadata album="My personal album" -metadata artist="q3aql" -metadata track="2" "Example.oga"`
* `.`
* `* (Default: y) Do you want run the conversion? (y/n): n`
```shell
* Information of Example.mkv:
+ Audio Tracks:
Stream #0:1(spa): Audio: ac3
Stream #0:2(eng): Audio: ac3
* (Default: 0:1) Type the number of audio track:
* METADATA configuration:
* (Default: Example) Type name of title: My song
* (Default: Album-Disc) Type name of album: My personal album
* (Default: 01) Type number of track: 2
* (Default: Artist) Type name of artist: q3aql
* (Default: 2021) Type the year: 2016
* (Default: Pop) Type the genre: Rap
* COMMANDS THAT WILL BE EXECUTED:
# Convert the file 'Example.mkv' to OGG Audio
ffmpeg -i "Example.mkv" -map 0:1 -c:a libvorbis -b:a 130k
-metadata title="My song" -metadata date="2016"
-metadata genre="Rap" -metadata album="My personal album"
-metadata artist="q3aql" -metadata track="2" "Example.oga"
* (Default: y) Do you want run the conversion? (y/n): n
````
### Back to README.md

80
doc/ks-upa.md
View File

@ -3,26 +3,32 @@ ks-upa - Upload audio file(s) to server with rsync+ssh.
### Syntax:
* `$ ks-upa -i - Start upload`
* `$ ks-upa -r - Remove configuration`
* `$ ks-upa -c - Show configuration`
* `$ ks-upa -e - Edit configuration`
* `$ ks-upa -v - Show version`
* `$ ks-upa -h - Show help`
```shell
$ ks-upa -i - Start upload
$ ks-upa -r - Remove configuration
$ ks-upa -c - Show configuration
$ ks-upa -e - Edit configuration
$ ks-upa -v - Show version
$ ks-upa -h - Show help
```
### Initialize audio file(s) upload:
* For initialize audio file(s) upload only run the following command:
* `$ ks-upa -i`
```shell
$ ks-upa -i
````
* The first time you run the command, you will be asked for the necessary connection information:
* `Enter the server user: anonymous`
* `Enter the server key: 1234567`
* `Enter the server URL: mypersonaldomain.es`
* `Enter the path on the server: /home/anonymous`
* `Enter the local path to scan: /home/local/videos`
```shell
* Enter the server user: anonymous
* Enter the server key: 1234567
* Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos
````
* Once the connection data has been entered, the local directory will be scanned to detect the audios and upload them to the server directory.
@ -30,45 +36,57 @@ ks-upa - Upload audio file(s) to server with rsync+ssh.
* If you want to clear the connection settings, you just need to run the following command:
* `$ ks-upa -r`
```shell
$ ks-upa -r
````
### Show configuration:
* You can check the configuration with the following command:
* `$ ks-upa -c`
```shell
$ ks-upa -c
````
* When consulting the configuration, we will see something like this:
* `Server User: anonymous`
* `Server Password: 1234567`
* `URL (or IP) Server: mypersonaldomain.es`
* `Destination Path (Server): /home/anonymous`
* `Scan Path (Local): /home/local/videos`
```shell
* Server User: anonymous
* Server Password: 1234567
* URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos
````
### Edit configuration:
* To edit any section of the configuration, the following command would be executed:
* `$ ks-upa -e`
```shell
$ ks-upa -e
````
* After its execution, we will see a menu like the following one to be able to edit the desired section:
```shell
1 - Edit User (anonymous)
2 - Edit Password (1234567)
3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos)
* `1 - Edit User (anonymous)`
* `2 - Edit Password (1234567)`
* `3 - Edit Server (mypersonaldomain.es)`
* `4 - Edit Dest. Path (/home/anonymous)`
* `5 - Edit Local Path (/home/local/videos)`
* `.`
* `6 - Exit`
* `.`
* `Choose an option:`
6 - Exit
* Choose an option:
````
### Show version:
* You can check the version with the command:
* `$ ks-upa -v`
```shell
$ ks-upa -v
````
### Back to README.md

80
doc/ks-upf.md
View File

@ -3,26 +3,32 @@ ks-upf - Upload common file(s) to server with rsync+ssh.
### Syntax:
* `$ ks-upf -i - Start upload`
* `$ ks-upf -r - Remove configuration`
* `$ ks-upf -c - Show configuration`
* `$ ks-upf -e - Edit configuration`
* `$ ks-upf -v - Show version`
* `$ ks-upf -h - Show help`
```shell
$ ks-upf -i - Start upload
$ ks-upf -r - Remove configuration
$ ks-upf -c - Show configuration
$ ks-upf -e - Edit configuration
$ ks-upf -v - Show version
$ ks-upf -h - Show help
```
### Initialize common file(s) upload:
* For initialize file(s) upload only un the following command:
* `$ ks-upf -i`
```shell
$ ks-upf -i
````
* The first time you run the command, you will be asked for the necessary connection information:
* `Enter the server user: anonymous`
* `Enter the server key: 1234567`
* `Enter the server URL: mypersonaldomain.es`
* `Enter the path on the server: /home/anonymous`
* `Enter the local path to scan: /home/local/videos`
```shell
* Enter the server user: anonymous
* Enter the server key: 1234567
* Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos
````
* Once the connection data has been entered, the local directory will be scanned to detect file(s) and upload them to the server directory.
@ -30,45 +36,57 @@ ks-upf - Upload common file(s) to server with rsync+ssh.
* If you want to clear the connection settings, you just need to run the following command:
* `$ ks-upf -r`
```shell
$ ks-upf -r
````
### Show configuration:
* You can check the configuration with the following command:
* `$ ks-upf -c`
```shell
$ ks-upf -c
````
* When consulting the configuration, we will see something like this:
* `Server User: anonymous`
* `Server Password: 1234567`
* `URL (or IP) Server: mypersonaldomain.es`
* `Destination Path (Server): /home/anonymous`
* `Scan Path (Local): /home/local/videos`
```shell
* Server User: anonymous
* Server Password: 1234567
* URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos
````
### Edit configuration:
* To edit any section of the configuration, the following command would be executed:
* `$ ks-upf -e`
```shell
$ ks-upf -e
````
* After its execution, we will see a menu like the following one to be able to edit the desired section:
* `1 - Edit User (anonymous)`
* `2 - Edit Password (1234567)`
* `3 - Edit Server (mypersonaldomain.es)`
* `4 - Edit Dest. Path (/home/anonymous)`
* `5 - Edit Local Path (/home/local/videos)`
* `.`
* `6 - Exit`
* `.`
* `Choose an option:`
```shell
1 - Edit User (anonymous)
2 - Edit Password (1234567)
3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos)
6 - Exit
* Choose an option:
````
### Show version:
* You can check the version with the command:
* `$ ks-upf -v`
```shell
$ ks-upf -v
````
### Back to README.md

78
doc/ks-upr.md
View File

@ -3,26 +3,32 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh.
### Syntax:
* `$ ks-upr -i - Start upload`
* `$ ks-upr -r - Remove configuration`
* `$ ks-upr -c - Show configuration`
* `$ ks-upr -e - Edit configuration`
* `$ ks-upr -v - Show version`
* `$ ks-upr -h - Show help`
```shell
$ ks-upr -i - Start upload
$ ks-upr -r - Remove configuration
$ ks-upr -c - Show configuration
$ ks-upr -e - Edit configuration
$ ks-upr -v - Show version
$ ks-upr -h - Show help
```
### Initialize common file(s) upload:
* For initialize recursively upload only un the following command:
* `$ ks-upr -i`
```shell
$ ks-upr -i
````
* The first time you run the command, you will be asked for the necessary connection information:
* `Enter the server user: anonymous`
* `Enter the server key: 1234567`
* `Enter the server URL: mypersonaldomain.es`
* `Enter the path on the server: /home/anonymous`
* `Enter the local path to scan: /home/local/videos`
```shell
* Enter the server user: anonymous
* Enter the server key: 1234567
* Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos
````
* Once the connection data has been entered, the local directory will be scanned to upload recursively them to the server directory.
@ -30,45 +36,57 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh.
* If you want to clear the connection settings, you just need to run the following command:
* `$ ks-upr -r`
```shell
$ ks-upr -r
````
### Show configuration:
* You can check the configuration with the following command:
* `$ ks-upr -c`
```shell
$ ks-upr -c
````
* When consulting the configuration, we will see something like this:
* `Server User: anonymous`
* `Server Password: 1234567`
* `URL (or IP) Server: mypersonaldomain.es`
* `Destination Path (Server): /home/anonymous`
* `Scan Path (Local): /home/local/videos`
```shell
* Server User: anonymous
* Server Password: 1234567
* URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos
````
### Edit configuration:
* To edit any section of the configuration, the following command would be executed:
* `$ ks-upr -e`
```shell
$ ks-upr -e
````
* After its execution, we will see a menu like the following one to be able to edit the desired section:
* `1 - Edit User (anonymous)`
* `2 - Edit Password (1234567)`
* `3 - Edit Server (mypersonaldomain.es)`
* `4 - Edit Dest. Path (/home/anonymous)`
* `5 - Edit Local Path (/home/local/videos)`
* `.`
* `6 - Exit`
* `.`
* `Choose an option:`
```shell
1 - Edit User (anonymous)
2 - Edit Password (1234567)
3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos)
6 - Exit
* Choose an option:
````
### Show version:
* You can check the version with the command:
* `$ ks-upr -v`
```shell
$ ks-upr -v
````
### Back to README.md

78
doc/ks-upv.md
View File

@ -3,26 +3,32 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh.
### Syntax:
* `$ ks-upv -i - Start upload`
* `$ ks-upv -r - Remove configuration`
* `$ ks-upv -c - Show configuration`
* `$ ks-upv -e - Edit configuration`
* `$ ks-upv -v - Show version`
* `$ ks-upv -h - Show help`
```shell
$ ks-upv -i - Start upload
$ ks-upv -r - Remove configuration
$ ks-upv -c - Show configuration
$ ks-upv -e - Edit configuration
$ ks-upv -v - Show version
$ ks-upv -h - Show help
```
### Initialize video file(s) upload:
* For initialize video file(s) upload only un the following command:
* `$ ks-upv -i`
```shell
$ ks-upv -i
````
* The first time you run the command, you will be asked for the necessary connection information:
* `Enter the server user: anonymous`
* `Enter the server key: 1234567`
* `Enter the server URL: mypersonaldomain.es`
* `Enter the path on the server: /home/anonymous`
* `Enter the local path to scan: /home/local/videos`
```shell
* Enter the server user: anonymous
* Enter the server key: 1234567
* Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos
````
* Once the connection data has been entered, the local directory will be scanned to detect the videos and upload them to the server directory.
@ -30,45 +36,57 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh.
* If you want to clear the connection settings, you just need to run the following command:
* `$ ks-upv -r`
```shell
$ ks-upv -r
````
### Show configuration:
* You can check the configuration with the following command:
* `$ ks-upv -c`
```shell
$ ks-upv -c
````
* When consulting the configuration, we will see something like this:
* `Server User: anonymous`
* `Server Password: 1234567`
* `URL (or IP) Server: mypersonaldomain.es`
* `Destination Path (Server): /home/anonymous`
* `Scan Path (Local): /home/local/videos`
```shell
* Server User: anonymous
* Server Password: 1234567
* URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos
````
### Edit configuration:
* To edit any section of the configuration, the following command would be executed:
* `$ ks-upv -e`
```shell
$ ks-upv -e
````
* After its execution, we will see a menu like the following one to be able to edit the desired section:
* `1 - Edit User (anonymous)`
* `2 - Edit Password (1234567)`
* `3 - Edit Server (mypersonaldomain.es)`
* `4 - Edit Dest. Path (/home/anonymous)`
* `5 - Edit Local Path (/home/local/videos)`
* `.`
* `6 - Exit`
* `.`
* `Choose an option:`
```shell
1 - Edit User (anonymous)
2 - Edit Password (1234567)
3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos)
6 - Exit
* Choose an option:
````
### Show version:
* You can check the version with the command:
* `$ ks-upv -v`
```shell
$ ks-upv -v
````
### Back to README.md

32
doc/ks-vob-wrapper.md
View File

@ -3,28 +3,38 @@ ks-vob-wrapper - Wrapper for ks-vob to create graphical interfaces.
### TRACKS/CONFIG DETECT:
* `$ ks-vob-wrapper --show-info <video_file>`
* `$ ks-vob-wrapper --show-video-default <video_file>`
* `$ ks-vob-wrapper --show-audio-default <video_file>`
* `$ ks-vob-wrapper --show-resolution-default`
```shell
$ ks-vob-wrapper --show-info <video_file>
$ ks-vob-wrapper --show-video-default <video_file>
$ ks-vob-wrapper --show-audio-default <video_file>
$ ks-vob-wrapper --show-resolution-default
```
### CONVERT:
* `$ ks-vob-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> [patch]`
```shell
$ ks-vob-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> [patch]
```
### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
* `$ ks-vob-wrapper --conv </path/video_file> </path/output_prefix>`
```shell
$ ks-vob-wrapper --conv </path/video_file> </path/output_prefix>
```
### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
* `$ ks-vob-wrapper --conv </path/video_file> </path/output_prefix>`
* `$ ks-vob-wrapper --conv-with-sub </path/video_file> </path/output_prefix>`
```shell
$ ks-vob-wrapper --conv </path/video_file> </path/output_prefix>
$ ks-vob-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
```
### EXAMPLES:
* `$ ks-vob-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480`
* `$ ks-vob-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x576 patch`
```shell
$ ks-vob-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480
$ ks-vob-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x576 patch
```
### Notes:
@ -34,4 +44,4 @@ ks-vob-wrapper - Wrapper for ks-vob to create graphical interfaces.
### Back to README.md
* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md)

88
doc/ks-vob.md
View File

@ -3,61 +3,71 @@ ks-vob - Convert video file(s) to compact and efficient VOB.
### Syntax:
* `$ ks-vob </absolute/path/video.mkv> </path/prefix_name>`
```shell
$ 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`
```shell
- 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"`
```shell
# 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`
```shell
$ 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:
```shell
* Information of Example.mkv:
* `* 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`
+ 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