diff --git a/doc/ks-mp3-album.md b/doc/ks-mp3-album.md new file mode 100644 index 0000000..048aaac --- /dev/null +++ b/doc/ks-mp3-album.md @@ -0,0 +1,54 @@ +ks-mp3-album - Convert folder album to MP3 Audio Format. +======================================================== + +### Sintax: + + * `$ ks-mp3-album ` + +### Default configuration: + + * The script `ks-mp3-album` use by default the following configuration: + + * `- 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"` + +### Example of use: + + * An example of use would be the following: + + * `$ ks-mp3-album /data/albums/matrix-soundtrack` + + * Executing the command, the folder will be analized and you can see the following wizard: + + * `* Scanning /home/q3aql/.torrent/Conv/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` + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-mp3.md b/doc/ks-mp3.md new file mode 100644 index 0000000..42e12e7 --- /dev/null +++ b/doc/ks-mp3.md @@ -0,0 +1,59 @@ +ks-mp3 - Convert video/audio file(s) to MP3 (Audio) Format. +=========================================================== + +### Sintax: + + * `$ ks-mp3 ` + +### Default configuration: + + * The script `ks-mp3` use by default the following configuration: + + * `- 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"` + +### Example of use: + + * An example of use would be the following: + + * `$ 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: + + * `* 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 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 + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-oga-album.md b/doc/ks-oga-album.md new file mode 100644 index 0000000..446bf0a --- /dev/null +++ b/doc/ks-oga-album.md @@ -0,0 +1,54 @@ +ks-oga-album - Convert folder album to OGA (OGG Audio) Format. +============================================================== + +### Sintax: + + * `$ ks-oga-album ` + +### Default configuration: + + * The script `ks-oga-album` use by default the following configuration: + + * `- 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"` + +### Example of use: + + * An example of use would be the following: + + * `$ ks-oga-album /data/albums/matrix-soundtrack` + + * Executing the command, the folder will be analized and you can see the following wizard: + + * `* Scanning /home/q3aql/.torrent/Conv/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` + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-oga.md b/doc/ks-oga.md new file mode 100644 index 0000000..833e098 --- /dev/null +++ b/doc/ks-oga.md @@ -0,0 +1,59 @@ +ks-oga - Convert video/audio file(s) to OGA (OGG Audio) Format. +=============================================================== + +### Sintax: + + * `$ ks-oga ` + +### Default configuration: + + * The script `ks-oga` use by default the following configuration: + + * `- 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"` + +### Example of use: + + * An example of use would be the following: + + * `$ 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` + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file