vtt2ass 0.2.4 → 0.2.10

data/doc/top-level-namespace.html

@@ -86,7 +86,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ASSFile.html" title="ASSFile (class)">ASSFile</a></span>, <span class='object_link'><a href="ASSStyle.html" title="ASSStyle (class)">ASSStyle</a></span>, <span class='object_link'><a href="ASSSubtitle.html" title="ASSSubtitle (class)">ASSSubtitle</a></span>, <span class='object_link'><a href="Application.html" title="Application (class)">Application</a></span>, <span class='object_link'><a href="VTTSubtitle.html" title="VTTSubtitle (class)">VTTSubtitle</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ASSFile.html" title="ASSFile (class)">ASSFile</a></span>, <span class='object_link'><a href="ASSLine.html" title="ASSLine (class)">ASSLine</a></span>, <span class='object_link'><a href="ASSStyle.html" title="ASSStyle (class)">ASSStyle</a></span>, <span class='object_link'><a href="ASSStyleParams.html" title="ASSStyleParams (class)">ASSStyleParams</a></span>, <span class='object_link'><a href="Application.html" title="Application (class)">Application</a></span>, <span class='object_link'><a href="VTTFile.html" title="VTTFile (class)">VTTFile</a></span>, <span class='object_link'><a href="VTTLine.html" title="VTTLine (class)">VTTLine</a></span>
     
   
 </p>
@@ -102,9 +102,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 14 00:31:16 2021 by
+  Generated on Tue Mar 23 21:07:02 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.2).
+  0.9.26 (ruby-3.0.0).
 </div>
 
     </div>

data/lib/vtt2ass.rb

@@ -17,17 +17,20 @@ 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("-t", "--title TITLE", String, "Specify a title for you file. If the input is a directory, all files will share the same title.") do |title|
+                options[:title] = title
             end
             opts.on("-v", "--version", "Show version") do
                 puts Vtt2ass::VERSION

data/lib/vtt2ass/ASSFile.rb

@@ -1,15 +1,16 @@
+# 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)
+    # Creates a new ASSFile instance and assigns the default values of instance variables.
+    def initialize(title, width, height)
         @width = width
         @height = height
         @header = [
@@ -26,18 +27,47 @@ 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
+
+    ##
+    # 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)
+        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
+
+    ##
+    # This method writes the content of the ASSFile object into a file path that is provided.
+    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,21 @@
+require 'htmlentities'
+
 ##
 # 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
 
@@ -29,6 +30,7 @@ class ASSSubtitle
     #
     # * Requires +text+, a string of VTT formated text as input.  
     def convertToAssText(text)
+        decoder = HTMLEntities.new()
         text = text
             .gsub(/\r/, '')
             .gsub(/\n/, '\\N')
@@ -43,7 +45,7 @@ class ASSSubtitle
             .gsub(/<[^>]>/, '')
             .gsub(/\\N$/, '')
             .gsub(/ +$/, '')
-        return text
+        return decoder.decode(text)
     end
 
     ##
@@ -81,7 +83,7 @@ class ASSSubtitle
     end
     
     ##
-    # The method pads text so that time numbers are a fixed number of digit.
+    # This method pads text so that time numbers are a fixed number of digit.
     #
     # * Requires +sep+, a string separator.
     # * Requires +input+, an integer.

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,87 @@
+##
+# This class defines the ASS style parameters from VTT cue settings.
+class ASSStyleParams
+    attr_reader :horizontal_margin, :vertical_margin, :alignment, :align
+
+    ##
+    # Creates an instance of ASSStyleParams
+    # It takes VTT style arguments and assign them to their respectful instance variable.
+    # It calls methods to create ASS values from the VTT cue settings.
+    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
+
+    ##
+    # This method decides the alignement value in a 9 position grid based of the
+    # values in cue settings "align" and "line".
+    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
+
+    ##
+    # 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)
+        steps = (width / 100).to_i
+        if defined?(@position) then
+            @horizontal_margin = @position * steps
+        else
+            @horizontal_margin = 0
+        end
+    end
+
+    ##
+    # 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)
+        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'
 
 ##
@@ -15,12 +13,15 @@ class Application
     # Creates a new Application instance.
     # It receives +options+ that can define the input and output directories.
     def initialize(options)
-        @input = options[:input] ? options[:input].gsub('\\', '/') : "./"
-        @output = options[:output] ? options[:output].gsub('\\', '/') : "./"
+        @input = options[:input] ? options[:input].gsub('\\', '/').delete_suffix('/') : "."
+        @output = options[:output] ? options[:output].gsub('\\', '/').delete_suffix('/') : "."
         @width = 1920
         @height = 1080
         @font_family = options[:font_family] ? options[:font_family] : 'Open Sans Semibold'
         @font_size = options[:font_size] ? options[:font_size] : 52
+        if options[:title] then
+            @title = options[:title]
+        end
     end
 
     ##
@@ -30,62 +31,27 @@ 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(@output + '/' + File.basename(file_path).gsub('.vtt', '.ass'))
             end
         elsif File.file?(@input) then
-            writeFile(@input)
+            vtt_to_ass(@input).writeToFile(@output + '/' + 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
+    # This method creates a new VTTFile object from the file path provided and convert its content
+    # inside a new ASSFile object.
+    def vtt_to_ass(file_path)
+        vtt_file = VTTFile.new(file_path)
+        ass_file = ASSFile.new(
+            (defined?(@title) ? @title : 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