gem 'subtitle'

require 'subtitle'

### Two Ways of Initialisation

Option - 1
You can use below method of initialisation in case you intend to use only transformation functionality.

subtitle = Subtitle.new(caption_file_path)

Option - 2
In case you need to use Subtitle Gem for detecting / translating subtitle, then use below way of initialisation

subtitle = Subtitle.new(caption_file_path, options)

end
where options is a hash with following keys at the minimal
<access_key_id>             : AWS Key
<secret_access_key>         : AWS Secret
<profile>[Optional]         : AWS Profile (If this is provided key and secret is not required)
<force_detect>[Optional]    : By default false. If this is true then, even if the caption file declares the language
                              we will try to infer the language. If it's false, the declared language would be returned. Is applicable only when subtile format encapsulates the language information.
<dest_lang>                 : ISO 639-2 2 Letter language code to which a caption needs to be tranlated to 
<src_lang>                  : Applicable in case if the input caption can hold cues for multiple languages, in which case the content with the matching language is picked. If not provided language will be auto detected
<outfile>                   : The destination directory in case of transform and is optional file path for language translation
<types>                     : Comma seperated strings that indicates the types to which the input caption file needs to be transformed into. For example, dfxp,ttml,srt

require 'subtitle'

subtitle = Subtitle.new(caption_file_path, options)
subtitle.detect_language

# By default, for TTML and DFXP files if the div contains the lang then the same would be returned
# However, you can override this behavior using force_detect option

require 'subtitle'

subtitle = Subtitle.new(caption_file_path, options)

Refer to Detect Language section above for what can be passed in options

Option 1

subtitle.translate(<dest_lang>, <src_lang>, <outfile>)

Option 2

subtitle.translate(<dest_lang>, <src_lang>)

# Creates file following the convention `caption_file_path`_`dest_lang`

Option 3

subtitle.translate(<dest_lang>)

# Detects the source langauge and creates the out file using convention `caption_file_path`_`dest_lang`

<dest_lang>   : Provide translate Language code (ISO639 2 Letter Code)
<src_lang>    : Provide  source Language code (ISO639 2 Letter Code). If not supplied, the source language will be auto detected.
<outfile>     : Destination for translated closed caption file.

require 'subtitle'

subtitle = Subtitle.new(caption_file_path)
 
# in case the <cc_file> is supplied with subtitle type SRT and the file name does not hold extension.

subtitle.type
 
Returned values
* srt
* dfxp
* vtt
* scc
 
# Returns `nil` in case does not match any type.

require 'subtitle'

subtitle = Subtitle.new(caption_file_path)

subtitle.transform(types_to_convert, options, target_lang, src_lang)

<types_to_convert>  : An array that can hold any of the following values (dfxp, ttml, srt, vtt, scc)
<src_lang>          : can be nil or can specify the lang code in case of ttml / dfxp to extract only that section of the caption for transformation
<dest_lang>         : on the fly translation to this language
<options>           : Destination directory where the output files shall be placed

get install subtitle

# Help options
$subtitle -h 
Subtitle Utility for lingual detection, translation from one language to another & transform from one format to another
  -k, --access-key-id=<s>        AWS Key
  -s, --secret-access-key=<s>    AWS Secret
  -p, --profile=<s>              AWS Profile
  -i, --cc-file=<s>              Closed caption File
  -d, --dest-lang=<s>            Language code to translate
  -l, --src-lang=<s>             Source language
  -f, --outfile=<s>              Destination file / directory
  -w, --force-detect             Will try to infer the language even if language is provided. By default false if not provided
  -t, --types=<s>                comma seperated lowercase formats to convert to. valid values are srt, scc, vtt, ttml and dfxp
  -h, --help                     Show this message

# Detect Language for the given subtitle file
$subtitle detectlang -k <AWS Key> -s <AWS Secret> -i <CC File Path>

# Translate given subtitle file to French, without mentioning the source language
$subtitle translate -k <AWS Key> -s <AWS Secret> -i <CC File Path> -d fr -f <out file>

# Translate given subtitle file to French, with mention of source language
$subtitle translate -k <AWS Key> -s <AWS Secret> -i <CC File Path> -d fr -l en -f <out file>
 
#Transform SRT input file to SCC and VTT
$subtitle transform -i <CC File Path> -t scc,vtt -f <Out Directory> 

In case you business case needs translate and then transform, you can use translate and followed by transform