vtt2ass 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3959903aff7b00e3544a9656edf9a17f9508445db041d28518549926cca7a09
-  data.tar.gz: 51359298d3ff0ed985ce10f48b18c5f2b84eec19b267e0781cd2b6ef12320e22
+  metadata.gz: 3a864637934d7b15e7f459c532cd5f521e21e3445e0408cea0a0a7b3c966f550
+  data.tar.gz: 5a58b036d877c8529accd0ccc21fe5568d0bdbd686d994ba119ebc894c906e3b
 SHA512:
-  metadata.gz: ae929a40df7f483e8bd76cc43920177d299756cfe9774fc850f0e7a66b877d74c40314d2d8647cabf6ba5b2c7e0743533ce9236873d28c86203a76c74c9628d8
-  data.tar.gz: 1a280a2a76c87e2678c6275b65c1226779799e61abd8b2909816897e5e44b18a649d0c0f364ae97249044593656120e823edf80f06836703963840321449d088
+  metadata.gz: e46d22748e6e8b64ec2d0486ce42cce993bcdb00b88be35db80c234bbcdf0ddad0b869e35f2b880a30a451b0a81ce99f48dfb5d671cfa40ad284b4eece17f1d3
+  data.tar.gz: 3bbe4b767f309e820d4c44bf8c351090cbe0810219069970c4ac131e50453eeb7b593e9f4793987a69dc9596ab8d6f35815d2d9bbc6785afe755551bcec7c49d

data/README.md

@@ -2,35 +2,54 @@
 
 [![Gem Version](https://badge.fury.io/rb/vtt2ass.svg)](https://badge.fury.io/rb/vtt2ass)
 
-This is a simple application to convert VTT files to ASS subtitles.
+## Description
+
+This is a simple CLI (Command Line Interface) application to convert VTT files to ASS subtitles.
+
+This application is originally based on the `vttconvert` module of [anidl/hidive-downloader-nx](https://github.com/anidl/hidive-downloader-nx) repository. The [maxwbot/maxwhidive](https://github.com/maxwbot/maxwhidive) repository was also used as inspiration for handling the positionning of subs.
+
+Those two tools were missing features and didn't work well on a lot of more complex subtitles files. For that reason, I wrote a new tool that can handle everything.
+
+### Features
+
+- Convert simple VTT files
+- Convert complex VTT files with positioning
+- Convert Hidive VTT files with CSS styling
+- Convert subtitles in batches by specifying the input directory
+- Handles subtitles made for lower resolution video
+- Can add offset to subtitle lines
+- Can output result to the CLI
+- Can output to the specifed directory
+- Can change the base font size
+- Can specify a custom font family for non-styled lines
+- Can add a title to the converted files
 
 ## Requirements
+
 - ruby 2.7.2 or newer
 
-It might work with older versions of ruby, but it hasn't been tested
+Development is currently done on ruby 3.0+, but the Gitlab runner for builds works with ruby version 2.7.2. Older versions of ruby may be compatible, but they won't be tested.
 
 ## Installation
 
 To install:
 ```bash
-gem install vtt2ass
-```
-
-# Build
-
-```bash
-gem build vtt2ass.gemspec
+$ gem install vtt2ass
 ```
 
 ## Usage
 
+- Empty arguments lists the available commands
 ```bash
 $ vtt2ass
 Commands:
   vtt2ass convert INPUT   # Run the VTT to ASS conversion for the specified file(s)
   vtt2ass help [COMMAND]  # Describe available commands or one specific command
   vtt2ass version         # Show version
+```
 
+- Help command shows available options of the specified command
+```bash
 $ vtt2ass help convert
 Usage:
   vtt2ass convert INPUT
@@ -50,7 +69,44 @@ Options:
 Run the VTT to ASS conversion for the specified file(s)
 ```
 
-# Donate
+- Convert command
+```bash
+$ vtt2ass convert ./path/to/input/ -o ./path/to/output/ -l 50 -q
+```
+
+- Version command shows the application version
+```bash
+$ vtt2ass version
+0.3.3
+```
+
+## Contributing
+
+Contributions are welcome. Create an *Issue* on Gitlab and link it with a *Pull Request* of the changes made. The changes needs to pass the ruby tests.
+
+```
+$ rake test
+```
+
+## Build
+
+To build a gem file for local installation:
+```bash
+$ git clone https://gitlab.com/dkb-weeblets/vtt2ass.git
+$ cd vtt2ass/
+$ gem build vtt2ass.gemspec
+```
+
+To install the gem file:
+```bash
+$ gem install ./vtt2ass-0.3.3.gem
+```
+
+## License
+
+Licensed under the **MIT** Licence. For more information read the `LICENSE.txt` file.
+
+## Donate
 
 If you want to support me, consider buying me a coffee.
 

data/lib/vtt2ass/application.rb

@@ -45,7 +45,7 @@ class Application
     def convert(input_path)
         ass_file = vtt_to_ass(input_path)
         if (not @output.nil?) then
-            ass_file.writeToFile(@output + '/' + File.basename(input_path).gsub('.vtt', '.ass'))
+            ass_file.write_to_file(@output + '/' + File.basename(input_path).gsub('.vtt', '.ass'))
         end
         puts ass_file.to_s unless @quiet
     end
@@ -70,7 +70,7 @@ class Application
             @height,
             css_file
         )
-        ass_file.convertVTTtoASS(vtt_file, @font_family, @font_size, @line_offset)
+        ass_file.convert_vtt_to_ass(vtt_file, @font_family, @font_size, @line_offset)
         return ass_file
     end
 

data/lib/vtt2ass/ass_file.rb

@@ -45,7 +45,7 @@ class ASSFile
     # This method receives a VTTFile object and font arguments creates new ASSLine with the params of 
     # each VTTLine. All those ASSLine are stored in an array. It also creates an array of ASSStyle that
     # will be used in the ASS style list.
-    def convertVTTtoASS(vtt_file, font_family, font_size, line_offset = 0)
+    def convert_vtt_to_ass(vtt_file, font_family, font_size, line_offset = 0)
         fs = font_size
         vtt_file.lines.each do |line|
             font_color = '&H00FFFFFF'
@@ -95,7 +95,7 @@ class ASSFile
 
     ##
     # This method writes the content of the ASSFile object into a file path that is provided.
-    def writeToFile(file_path)
+    def write_to_file(file_path)
         File.open(file_path, 'w') do |line|
             line.print "\ufeff"
             line.puts self.to_s

data/lib/vtt2ass/ass_line.rb

@@ -14,9 +14,9 @@ class ASSLine
     # * Requires +text+, a VTT formatted string as input.
     def initialize(style, time_start, time_end, text)
         @style = style
-        @time_start = convertTime(time_start)
-        @time_end = convertTime(time_end)
-        @text = convertToAssText(text)
+        @time_start = convert_time(time_start)
+        @time_end = convert_time(time_end)
+        @text = convert_to_ass_text(text)
     end
 
     ##
@@ -29,7 +29,7 @@ class ASSLine
     # This method replaces characters and tags to ASS compatible characters and tags.
     #
     # * Requires +text+, a string of VTT formated text as input.  
-    def convertToAssText(text)
+    def convert_to_ass_text(text)
         decoder = HTMLEntities.new()
         text = text
             .gsub(/\r/, '')
@@ -52,16 +52,16 @@ class ASSLine
     # This method validates the time format and sends the matching time to be converted
     #
     # * Requires +str+, a VTT formatted time string.
-    def convertTime(time)
+    def convert_time(time)
         mTime = time.match(/([\d:]*)\.?(\d*)/)
-        return toSubsTime(mTime[0])
+        return to_subs_time(mTime[0])
     end
     
     ##
     # This method converts time from VTT format to the ASS format.
     #
     # * Requires +str+, a VTT formatted time string.
-    def toSubsTime(str)
+    def to_subs_time(str)
         n = []
         x = str.split(/[:.]/).map { |x| x.to_i }
         
@@ -72,12 +72,12 @@ class ASSLine
         sx = x[0]*60*60 + x[1]*60 + x[2] + x[3].to_f
         sx = ("%.2f" % sx).split('.')
     
-        n.unshift(padTimeNum('.', sx[1], msLen))
+        n.unshift(pad_time_num('.', sx[1], msLen))
         sx = sx[0].to_f
     
-        n.unshift(padTimeNum(':', (sx % 60).to_i, 2))
-        n.unshift(padTimeNum(':', (sx / 60).floor % 60, 2))
-        n.unshift(padTimeNum('',  (sx / 3600).floor % 60, hLen))
+        n.unshift(pad_time_num(':', (sx % 60).to_i, 2))
+        n.unshift(pad_time_num(':', (sx / 60).floor % 60, 2))
+        n.unshift(pad_time_num('',  (sx / 3600).floor % 60, hLen))
     
         return n.join('')
     end
@@ -88,7 +88,7 @@ class ASSLine
     # * Requires +sep+, a string separator.
     # * Requires +input+, an integer.
     # * Requires +pad+, an integer for the number of digits to be padded. 
-    def padTimeNum(sep, input, pad)
+    def pad_time_num(sep, input, pad)
         return sep + (input.to_s).rjust(pad, '0')
     end
 end

data/lib/vtt2ass/ass_style_params.rb

@@ -19,15 +19,15 @@ class ASSStyleParams
                 @align = p[1].chomp
             end
         end
-        createAlignment()
-        createHorizontalMargin(width)
-        createVerticalMargin(height)
+        create_alignment()
+        create_horizontal_margin(width)
+        create_vertical_margin(height)
     end
 
     ##
     # This method decides the alignement value in a 9 position grid based of the
     # values in cue settings "align" and "line".
-    def createAlignment()
+    def create_alignment()
         if (defined?(@line) and not defined?(@position)) then
             if (defined?(@align)) then
                 case @align
@@ -60,7 +60,7 @@ class ASSStyleParams
     ##
     # This method calculates the horizontal margin in px between the alignement position and
     # and the content displayed by using the "position" cue setting.
-    def createHorizontalMargin(width)
+    def create_horizontal_margin(width)
         steps = (width / 100).to_i
         if defined?(@position) then
             @horizontal_margin = @position * steps
@@ -72,7 +72,7 @@ class ASSStyleParams
     ##
     # This method calculates the vertical margin in px between the alignement position and
     # and the content displayed by using the "line" cue setting.
-    def createVerticalMargin(height)
+    def create_vertical_margin(height)
         steps = (height / 100).to_i
         if defined?(@line) then
             if (@alignment == 1) then

data/lib/vtt2ass/version.rb

@@ -4,5 +4,5 @@ module Vtt2ass
   ##
   # This is the version of the application.
   # This needs to be changed for each gem release.
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/lib/vtt2ass/vtt_file.rb

@@ -42,7 +42,7 @@ class VTTFile
 
     ##
     # This method writes the content of the VTTFile object into a file path that is provided.
-    def writeToFile(file_path)
+    def write_to_file(file_path)
         File.open(file_path, 'w') do |line|
             line.print "\ufeff"
             line.puts self.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vtt2ass
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Louis-Philippe Fortin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities