rdavid/transcode

// Settings:
:toc: macro
:!toc-title:
// URLs:
:url-cv: http://cv.rabkin.co.il
:url-license: https://github.com/rdavid/transcode/blob/master/LICENSE
:url-melton: http://donmelton.com
:url-video: https://github.com/donmelton/video_transcoding
:url-vale: https://vale.sh
:url-yamllint: https://github.com/adrienverge/yamllint

= Transcode

image:https://ci.appveyor.com/api/projects/status/yqxb43ltxrjj776a?svg=true[build,link=https://ci.appveyor.com/project/rdavid/transcode]
image:https://github.com/rdavid/transcode/actions/workflows/lint.yml/badge.svg[linters,link=https://github.com/rdavid/transcode/actions/workflows/lint.yml]
image:https://github.com/rdavid/transcode/actions/workflows/ruby.yml/badge.svg[ruby,link=https://github.com/rdavid/transcode/actions/workflows/ruby.yml]
image:https://badge.fury.io/rb/transcode.svg[gem version,link=https://badge.fury.io/rb/transcode]
image:https://api.codeclimate.com/v1/badges/5e21a1c1f8a3923584e3/maintainability[maintainability,link=https://codeclimate.com/github/rdavid/transcode/maintainability]
image:https://hitsofcode.com/github/rdavid/transcode?branch=master&label=hits%20of%20code[hits of code,link=https://hitsofcode.com/view/github/rdavid/transcode]
image:https://img.shields.io/github/license/rdavid/transcode?color=blue&labelColor=gray&logo=freebsd&logoColor=lightgray&style=flat[license,link=https://github.com/rdavid/transcode/blob/master/LICENSE]

toc::[]

== About

Transcode is a tool designed for transcoding multiple video files.
It builds upon {url-melton}[Don Melton's] Video Transcoding and applies
this technique to each video file within a directory.

== Installation

The tool is designed to work on macOS, GNU/Linux, Windows, Unix-like OS.
It is packaged as a Gem and require Ruby version 2.6 or later.
See "`https://www.ruby-lang.org/en/documentation/installation/[Installing Ruby]`"
if you don't have the proper version on your platform.

Use this command to install:

[,sh]
----
gem install transcode
----

== Updating

Use this command to update the package:

[,sh]
----
gem update transcode
----

== Requirements

See Video Transcoding's https://github.com/donmelton/video_transcoding/blob/master/README.md?ts=2#requirements[requirements].

== Usage

[,sh]
----
transcode [options]
  -a, --act      Real encoding.
  -s, --sca      Scans files at the directory.
  -m, --mp3      Converts files to mp3.
  -d, --dir dir  Directory to transcode.
  -i, --tit tit  Specific title by number.
  -o, --out out  Directory to output.
  -u, --aud aud  Audio stream numbers.
  -t, --sub sub  Subtitle stream numbers.
  -w, --wid wid  Width of the table.
  -v, --version  Shows version.
----

== Example

[,sh]
----
transcode \
  --aud 1,3,1 \
  --dir [source] \
  --out [destination] \
  --sub 2,1,3
----

It converts three files from source with certain audio and subtitle streams.
Inspect first with `--sca` option to see audio and subtitle streams.

== License

`transcode` is copyright {url-cv}[David Rabkin] and available under a
{url-license}[Zero-Clause BSD license].