vtt2ass 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84bd1994e916924d34b397b785492675e5403fb9d3c9863c9c2bf0d7aabfc7d8
-  data.tar.gz: 300b7640c078c7e180be5504dae5f7c41c0742c274bae5427476c6ff6495fbce
+  metadata.gz: 1014d192c3fa05ac8c39f15c2e06ca27d203d7a0cb6d2cb7500acf1a27df80b3
+  data.tar.gz: e455ca13c6b27784801c1e3e1091e0df1eca05c6f8547c5a9c4b0cc0c5dccdee
 SHA512:
-  metadata.gz: 3a6bf3fc3b1e18102d07561585db6d4ed8f5f2f816693ee407b0dd63d31a969f513be8ffb091407bb0724f2eb4009da8a98163d0c2e577ba47970498b3eab579
-  data.tar.gz: 85e7b794c2b6f7b251657bf0842216bc519bfedadd6fb8d775d3bae579944da97c8b8c62fb9f68c0d4659771b3b0db50675e39e36da86cbd926b3e0ce9e18c3a
+  metadata.gz: 0f4aa749a1f35195a847bc2a0abefaad1d5b644e4987f2cd8742d575125171fea84aa0cc618c9da488ba9f94a277f0208be910b0641554cb438546622cc285f9
+  data.tar.gz: 0f846550b79f10d0a933d29fd04cc6371248059f5a38a63d2540f707b601c72a9b682e195a3eac15bdd93168cb2d1c90e5c3e0ece8598bfdf4b749905f868455

data/README.md

@@ -40,7 +40,7 @@ Usage: vtt2ass [options]
 Specific options:
     -i, --input PATH                 Specify a custom input file or directory (default: './')
     -o, --output PATH                Specify a custom output directory (default: './')
-    -f, --font-family SIZE           Specify a font family for the subtitles (default: 'Open Sans Semibold')
+    -f, --font-family FONT           Specify a font family for the subtitles (default: 'Open Sans Semibold')
     -s, --font-size SIZE             Specify a font size for the subtitles (default: 52)
     -v, --version                    Show version
 ```

data/lib/vtt2ass.rb

@@ -17,17 +17,17 @@ module Vtt2ass
             opts.banner = "Usage: vtt2ass [options]"
             opts.separator ""
             opts.separator "Specific options:"
-            opts.on("-i", "--input PATH", "Specify a custom input file or directory (default: './')") do |dir|
-                options[:input] = dir
+            opts.on("-i", "--input PATH", "Specify a custom input file or directory (default: './')") do |file_path|
+                options[:input] = file_path
             end
-            opts.on("-o", "--output PATH", "Specify a custom output directory (default: './')") do |dir|
-                options[:output] = dir
+            opts.on("-o", "--output PATH", "Specify a custom output directory (default: './')") do |file_path|
+                options[:output] = file_path
             end
-            opts.on("-f", "--font-family SIZE", String, "Specify a font family for the subtitles (default: 'Open Sans Semibold')") do |size|
-                options[:font_family] = size
+            opts.on("-f", "--font-family FONT", String, "Specify a font family for the subtitles (default: 'Open Sans Semibold')") do |font_family|
+                options[:font_family] = font_family
             end
-            opts.on("-s", "--font-size SIZE", Integer, "Specify a font size for the subtitles (default: 52)") do |size|
-                options[:font_size] = size
+            opts.on("-s", "--font-size SIZE", Integer, "Specify a font size for the subtitles (default: 52)") do |font_size|
+                options[:font_size] = font_size
             end
             opts.on("-v", "--version", "Show version") do
                 puts Vtt2ass::VERSION

data/lib/vtt2ass/ASSFile.rb

@@ -1,15 +1,14 @@
+# Relative imports
+require_relative 'ASSLine'
+require_relative 'ASSStyle'
+
 ##
-# This class defines the ASS File that will be created from the conversion.
+# This class defines an ASS subtitle file.
 class ASSFile
+    attr_reader :title, :width, :height
+    attr_accessor :ass_styles, :ass_lines
 
-    ##
-    # This method creates an instance of the ASSFile.
-    #
-    # * Requires +ass_styles+, a list of ASSStyle as input.
-    # * Requires +ass_subs+, a list of ASSSubtitles as input.
-    # * Requires a video +width+ as input.
-    # * Requires a video +height+ as input.
-    def initialize(title, ass_styles, ass_subs, width, height)
+    def initialize(title, width, height)
         @width = width
         @height = height
         @header = [
@@ -26,18 +25,41 @@ class ASSFile
             '[V4+ Styles]',
             'Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding'
         ]
-        @ass_styles = ass_styles
         @events = [
             '',
             '[Events]',
             'Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text'
         ]
-        @ass_subs = ass_subs
+        @ass_styles = []
+        @ass_lines = []
+    end
+
+    def convertVTTtoASS(vtt_file, font_family, font_size)
+        vtt_file.lines.each do |line|
+            @ass_lines.push(ASSLine.new(line.style, line.time_start, line.time_end, line.text))
+            style_exists = false
+            @ass_styles.each do |style|
+                if (style.style_name == line.style) then
+                    style_exists = true
+                    break
+                end
+            end
+            if not style_exists then
+                @ass_styles.push(ASSStyle.new(line.style, line.params, font_family, font_size, @width, @height))
+            end
+        end
+    end
+
+    def writeToFile(file_path)
+        File.open(file_path, 'w') do |line|
+            line.print "\ufeff"
+            line.puts self.to_s
+        end
     end
 
     ##
     # This method concatenates the object data in the right order for a string output.
     def to_s
-        return @header + @ass_styles + @events + @ass_subs
+        return @header + @ass_styles + @events + @ass_lines
     end
 end

data/lib/vtt2ass/{ASSSubtitle.rb → ASSLine.rb}

@@ -1,20 +1,19 @@
 ##
 # This class defines an ASS subtile line.
-class ASSSubtitle
-    attr_reader :style, :time_start, :time_end, :params, :text
+class ASSLine
+    attr_reader :style, :time_start, :time_end, :text
     
     ##
-    # This method creates an instance of an ASSSubtitle.
+    # This method creates an instance of an ASSLine.
     #
     # * Requires a +style+ name as input.
     # * Requires +time_start+, a VTT formatted timestamp as input.
     # * Requires +time_start+, a VTT formatted timestamp as input.
     # * Requires +text+, a VTT formatted string as input.
-    def initialize(style, time_start, time_end, params, text)
+    def initialize(style, time_start, time_end, text)
         @style = style
         @time_start = convertTime(time_start)
         @time_end = convertTime(time_end)
-        @params = params
         @text = convertToAssText(text)
     end
 

data/lib/vtt2ass/ASSStyle.rb

@@ -1,3 +1,6 @@
+# Relative imports
+require_relative 'ASSStyleParams'
+
 ##
 # This class defines an ASS style that can be applied on a subtitle line.
 class ASSStyle
@@ -16,72 +19,9 @@ class ASSStyle
         @font_family = font_family
         @font_size = font_size
         @style_name = style_name
-        @s_params = StyleParams.new(params, width, height)
+        @s_params = ASSStyleParams.new(params, width, height)
     end
 
-    class StyleParams
-        attr_reader :horizontal_margin, :vertical_margin, :alignment
-        def initialize(params, width, height)
-            (params.split(' ').map { |p| p.split(':') }).each do |p|
-                case p[0]
-                when 'position'
-                    @position = p[1].gsub(/%/, '').to_i
-                when 'line'
-                    @line = p[1].gsub(/%/, '').to_i
-                    @line = @line == -1 ? 100 : @line;
-                when 'alignment'
-                    @align = p[1]
-                end
-            end
-            createAlignment
-            createHorizontalMargin(width)
-            createVerticalMargin(height)
-        end
-        def createAlignment
-            if (defined?(@line) and not defined?(@position)) then
-                if (defined?(@align)) then
-                    case @align
-                    when 'left'
-                    when 'start'
-                        @alignment = @line >= 50 ? 1 : 7
-                    when 'right'
-                    when 'end'
-                        @alignment = @line >= 50 ? 3 : 9
-                    when 'center'
-                    when 'middle'
-                        @alignment = @line >= 50 ? 2 : 8
-                    end
-                else
-                    @alignment = @line >= 50 ? 2 : 8 # If position is higher than 50% align to bottom center, else align to top center
-                end
-            elsif (defined?(@line) and defined?(@position)) then
-                @alignment = 1
-            else
-                @alignment = 2
-            end
-        end
-        def createHorizontalMargin(width)
-            steps = (width / 100).to_i
-            if defined?(@position) then
-                @horizontal_margin = @position * steps
-            else
-                @horizontal_margin = 0
-            end
-        end
-        def createVerticalMargin(height)
-            steps = (height / 100).to_i
-            if defined?(@line) then
-                if (@alignment == 1) then
-                    @vertical_margin = (100 - @line) * steps
-                else
-                    @vertical_margin = @line >= 50 ? (100 - @line) * steps : @line * steps
-                end
-            else
-                @vertical_margin = 50
-            end
-        end
-    end
-    
     ##
     # This method assigns the object values to an ASS style line and outputs it.
     def to_s

data/lib/vtt2ass/ASSStyleParams.rb

@@ -0,0 +1,74 @@
+##
+# This class defines the ASS style parameters from VTT cue settings.
+class ASSStyleParams
+    attr_reader :horizontal_margin, :vertical_margin, :alignment, :align
+
+    def initialize(params, width, height)
+        (params.split(' ').map { |p| p.split(':') }).each do |p|
+            case p[0]
+            when 'position'
+                @position = p[1].gsub(/%/, '').to_i
+            when 'line'
+                @line = p[1].gsub(/%/, '').to_i
+                @line = @line == -1 ? 100 : @line;
+            when 'align'
+                @align = p[1].chomp
+            end
+        end
+        createAlignment()
+        createHorizontalMargin(width)
+        createVerticalMargin(height)
+    end
+
+    def createAlignment()
+        if (defined?(@line) and not defined?(@position)) then
+            if (defined?(@align)) then
+                case @align
+                when 'left', 'start'
+                    @alignment = @line >= 50 ? 1 : 7
+                when 'right', 'end'
+                    @alignment = @line >= 50 ? 3 : 9
+                when 'center', 'middle'
+                    @alignment = @line >= 50 ? 2 : 8
+                end
+            else
+                @alignment = @line >= 50 ? 2 : 8 # If position is higher than 50% align to bottom center, else align to top center
+            end
+        elsif (defined?(@line) and defined?(@position)) then
+            @alignment = 1
+        else
+            case @align
+            when 'left', 'start'
+                @alignment = 1
+            when 'right', 'end'
+                @alignment = 3
+            when 'center', 'middle'
+                @alignment = 2
+            else
+                @alignment = 2
+            end
+        end
+    end
+
+    def createHorizontalMargin(width)
+        steps = (width / 100).to_i
+        if defined?(@position) then
+            @horizontal_margin = @position * steps
+        else
+            @horizontal_margin = 0
+        end
+    end
+
+    def createVerticalMargin(height)
+        steps = (height / 100).to_i
+        if defined?(@line) then
+            if (@alignment == 1) then
+                @vertical_margin = (100 - @line) * steps
+            else
+                @vertical_margin = @line >= 50 ? (100 - @line) * steps : @line * steps
+            end
+        else
+            @vertical_margin = 50
+        end
+    end
+end

data/lib/vtt2ass/Application.rb

@@ -2,9 +2,7 @@
 require 'os'
 
 # Relative imports
-require_relative 'VTTSubtitle'
-require_relative 'ASSSubtitle'
-require_relative 'ASSStyle'
+require_relative 'VTTFile'
 require_relative 'ASSFile'
 
 ##
@@ -30,62 +28,20 @@ class Application
     def start
         if File.directory?(@input) then
             Dir["#{@input}/*.vtt"].each do |file_path|
-                writeFile(file_path)
+                vtt_to_ass(file_path).writeToFile(File.basename(file_path).gsub('.vtt', '.ass'))
             end
         elsif File.file?(@input) then
-            writeFile(@input)
+            vtt_to_ass(@input).writeToFile(File.basename(@input).gsub('.vtt', '.ass'))
         else
             puts 'Error: input file or directory does not exist.'
         end
     end
 
-    def writeFile(file_path)
-        file_name = File.basename(file_path).gsub('.vtt', '.ass')
-        File.open("#{@output}/" + file_name, 'w') do |line|
-            line.print "\ufeff"
-            line.puts convertFileToASS(file_path)
-        end
-    end
-
-    ##
-    # This method reads the VTT file and sends back a list of paragraphs.
-    # It requires a +file_path+ as input.
-    # It outputs a list named list_paragraph.
-    def readVTTFile(file_path)
-        list_parapraph = []
-        separator = OS.posix? ? "\r\n\r\n": "\n\n"
-        File.foreach(file_path, separator) do |paragraph|
-            paragraph = paragraph.rstrip.gsub(/\r\n/, "\n")
-            if not paragraph.eql? "" then
-                list_parapraph.push(VTTSubtitle.new(paragraph))
-            end
-        end
-        list_parapraph.shift
-        return list_parapraph
+    def vtt_to_ass(file_path)
+        vtt_file = VTTFile.new(file_path)
+        ass_file = ASSFile.new(File.basename(file_path).gsub('.vtt', ''), @width, @height)
+        ass_file.convertVTTtoASS(vtt_file, @font_family, @font_size)
+        return ass_file
     end
 
-    ##
-    # This method gets the list of paragraphs from the VTT file and creates lists of ASSSubtitle and ASSStyles objects from them.
-    # Those lists are given a new ASSFile object to generate the file content.
-    # It requires a +file_path+ as input.
-    # It outputs an ASSFile object.
-    def convertFileToASS(file_path)
-        vtt_subs = readVTTFile(file_path)
-        ass_subs = []
-        ass_styles = []
-        vtt_subs.each do |sub|
-            ass_subs.push(ASSSubtitle.new(sub.style, sub.time_start, sub.time_end, sub.params, sub.text))
-            style_exists = false
-            ass_styles.each do |style|
-                if (style.style_name == sub.style) then
-                    style_exists = true
-                    break
-                end
-            end
-            if not style_exists then
-                ass_styles.push(ASSStyle.new(sub.style, sub.params, @font_family, @font_size, @width, @height))
-            end
-        end
-        return ASSFile.new(File.basename(file_path).gsub('.vtt', ''), ass_styles, ass_subs, @width, @height).to_s
-    end
 end

data/lib/vtt2ass/VTTFile.rb

@@ -0,0 +1,36 @@
+# Imports
+require 'os'
+
+# Relative imports
+require_relative 'VTTLine'
+
+##
+# This class defines a VTT subtile file.
+class VTTFile
+    attr_accessor :lines
+
+    def initialize(file_path)
+        @title = File.basename(file_path).gsub('.vtt', '')
+        @lines = []
+        separator = OS.posix? ? "\r\n\r\n": "\n\n"
+        File.foreach(file_path, separator) do |paragraph|
+            paragraph = paragraph.rstrip.gsub(/\r\n/, "\n")
+            if not paragraph.eql? "" then
+                @lines.push(VTTLine.new(paragraph))
+            end
+        end
+        @lines.shift
+    end
+
+    def writeToFile(file_path)
+        File.open(file_path, 'w') do |line|
+            line.print "\ufeff"
+            line.puts self.to_s
+        end
+    end
+
+    def to_s
+        return "WEBVTT\n\n\n" + @lines 
+    end
+
+end

data/lib/vtt2ass/{VTTSubtitle.rb → VTTLine.rb}

@@ -1,10 +1,10 @@
 ##
 # This class defines a VTT subtile line.
-class VTTSubtitle
+class VTTLine
     attr_reader :style, :time_start, :time_end, :params, :text
 
     ##
-    # This method creates an instance of an VTTSubtitle.
+    # This method creates an instance of an VTTLine.
     #
     # * Requires +paragraph+, a VTT formatted string as input.
     def initialize(paragraph)

data/lib/vtt2ass/version.rb

@@ -1,3 +1,3 @@
 module Vtt2ass
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vtt2ass
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Louis-Philippe Fortin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -50,10 +50,12 @@ files:
 - exe/vtt2ass
 - lib/vtt2ass.rb
 - lib/vtt2ass/ASSFile.rb
+- lib/vtt2ass/ASSLine.rb
 - lib/vtt2ass/ASSStyle.rb
-- lib/vtt2ass/ASSSubtitle.rb
+- lib/vtt2ass/ASSStyleParams.rb
 - lib/vtt2ass/Application.rb
-- lib/vtt2ass/VTTSubtitle.rb
+- lib/vtt2ass/VTTFile.rb
+- lib/vtt2ass/VTTLine.rb
 - lib/vtt2ass/version.rb
 - vtt2ass.gemspec
 homepage: https://gitlab.com/dkb-weeblets/vtt2ass