vtt2ass 0.2.1 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13c0f4e714b058d076bddda1685ba4007429a2c9c0dc065073926bee9dd2dad
-  data.tar.gz: acbfd744b30cd214f174ec4fe991a6983cb206b89a65956115be803cf005b22c
+  metadata.gz: 9fe71574454d7bf315cb1de1c25ceb478e98fa0676f30e55a4e97b9522edfca9
+  data.tar.gz: d6380d5ee7e0f9e3341636cc266c43daea659724de180ee854811d243efd6348
 SHA512:
-  metadata.gz: 99c2d00e1d03c7e8ae463266ea500ad0ebf10f0b7eeae972b4d2776887a1a0936f5707633832c26fc6bc66fdd13e0bd53ff73200c2f5ae128517266a29d46a31
-  data.tar.gz: 17d541540f391fe95e5aeea3d0795ee36b5856f1cc6d69de4bcf6ac59b7a647e1cc3509e57b291a80c0a753b058a01d291944e435a9dd917358a99c5f69ed574
+  metadata.gz: a4a0ce576c898b8a69467dbfc92481017ebb1d467377c7772ca52b05d72aebe14cd1ea2ac84ef3ad2898cb00defd4bde7104372de7e49a1aece6ab5072d1f7ec
+  data.tar.gz: 72c4f381475ad497ee697bbedc5d8c54864c4192a780ea7da32a9ebe5752a0b3c4b3f5463aa6486682e7baaa65dafed9ae7fe9439e8b45506e40407a4d60cd88

data/.gitignore

@@ -1,6 +1,9 @@
 # Lock file
 Gemfile.lock
 
+# gems
+/*.gem
+
 # Temporary files for yard documentation
 .yardoc/
 

data/.gitlab-ci.yml

@@ -14,18 +14,16 @@ test:
 build:
   stage: build
   only:
-    - master
+    - develop
   artifacts:
     untracked: true
   script:
-    - mkdir build
-    - gem build vtt2ass.gemspec -o "build/release.gem"
+    - gem build vtt2ass.gemspec
 
 deploy:
   stage: deploy
   only:
     - master
-  dependencies: 
-    - build
   script:
-    - gem push build/release.gem -k rubygems_b54a36e70dba06b9a9c7268807eb2bbb896cdba924c67289
+    - gem install dpl --pre
+    - dpl rubygems --api_key $K8S_SECRET_RUBYGEMS_API_KEY

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'os'
+gem 'htmlentities'
 gem 'yard'
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"

data/README.md

@@ -1,5 +1,7 @@
 # VTT to ASS
 
+[![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.
 
 ## Requirements
@@ -36,7 +38,15 @@ $ vtt2ass -h
 Usage: vtt2ass [options]
 
 Specific options:
-    -i, --input DIRECTORY            Specify a custom input directory (default: './input')
-    -o, --output DIRECTORY           Specify a custom output directory (default: './output')
-    -s, --font-size SIZE             Specify a font size for the subtitles (default: 72)
+    -i, --input PATH                 Specify a custom input file or directory (default: './')
+    -o, --output PATH                Specify a custom output directory (default: './')
+    -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
 ```
+
+# Donate
+
+If you want to support me, consider buying me a coffee.
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Y8Y136P0E)

data/lib/vtt2ass.rb

@@ -17,14 +17,17 @@ module Vtt2ass
             opts.banner = "Usage: vtt2ass [options]"
             opts.separator ""
             opts.separator "Specific options:"
-            opts.on("-i", "--input DIRECTORY", "Specify a custom input directory (default: './input')") 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 DIRECTORY", "Specify a custom output directory (default: './output')") 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("-s", "--font-size SIZE", Integer, "Specify a font size for the subtitles (default: 72)") do |size|
-                options[:font_size] = 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 |font_size|
+                options[:font_size] = font_size
             end
             opts.on("-v", "--version", "Show version") do
                 puts Vtt2ass::VERSION

data/lib/vtt2ass/ASSFile.rb

@@ -1,20 +1,19 @@
+# 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(ass_styles, ass_subs, width, height)
+    def initialize(title, width, height)
         @width = width
         @height = height
         @header = [
             '[Script Info]',
-            'Title: DKB Team',
+            "Title: #{title}",
             'ScriptType: v4.00+',
             'Collisions: Normal',
             'PlayDepth: 0',
@@ -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,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
 
     ##

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
@@ -10,54 +13,18 @@ class ASSStyle
     # * Requires +params+, a string of VTT styling as input.
     # * Requires a video +width+ as input.
     # * Requires a video +height+ as input. 
-    def initialize(style_name, params, font_size, width, height)
+    def initialize(style_name, params, font_family, font_size, width, height)
         @width = width
         @height = height
+        @font_family = font_family
         @font_size = font_size
         @style_name = style_name
-        assignParams(params)
+        @s_params = ASSStyleParams.new(params, width, height)
     end
 
-    ##
-    # This method converts the string of VTT styling in values used for ASS styling.
-    #
-    # * Requires +params+, a string of VTT styling as input.
-    def assignParams(params)
-        @alignment = "2"
-        @left_margin = "10"
-        @right_margin = "10"
-        @vertical_margin = "50"
-
-        if params.include? "align:middle line:7%" then
-            @style_name = "MainTop"
-            @vertical_margin = "30"
-            @alignment = "8"
-        else
-            param_count = 0
-            (params.split(' ').map { |p| p.split(':') }).each do |p|
-                case p[0]
-                when "position"
-                    @left_margin = (@width * ((p[1].gsub(/%/, '').to_f - 7) / 100)).to_i.to_s
-                when "align"
-                    case p[1]
-                    when "left"
-                        @alignment = 1
-                    when "middle"
-                        @alignment = 2
-                    when "right"
-                        @alignment = 3
-                    end
-                when "line"
-                    @vertical_margin = (@height - (@height * ((p[1].gsub(/%/, '').to_f + 7) / 100))).to_i.to_s
-                end
-                param_count += 1
-            end
-        end
-    end
-    
     ##
     # This method assigns the object values to an ASS style line and outputs it.
     def to_s
-        return "Style: #{@style_name},Open Sans Semibold,#{@font_size},&H00FFFFFF,&H000000FF,&H00020713,&H00000000,-1,0,0,0,100,100,0,0,1,2.0,2.0,#{@alignment},#{@left_margin},#{@right_margin},#{@vertical_margin},1"
+        return "Style: #{@style_name},#{@font_family},#{@font_size},&H00FFFFFF,&H000000FF,&H00020713,&H00000000,-1,0,0,0,100,100,0,0,1,2.0,2.0,#{@s_params.alignment},#{@s_params.horizontal_margin},0,#{@s_params.vertical_margin},1"
     end
 end

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

@@ -1,11 +1,8 @@
 # Imports
 require 'os'
-require 'fileutils'
 
 # Relative imports
-require_relative 'VTTSubtitle'
-require_relative 'ASSSubtitle'
-require_relative 'ASSStyle'
+require_relative 'VTTFile'
 require_relative 'ASSFile'
 
 ##
@@ -16,11 +13,12 @@ class Application
     # Creates a new Application instance.
     # It receives +options+ that can define the input and output directories.
     def initialize(options)
-        @input_dir = options[:input] ? options[:input]: "./input"
-        @output_dir = options[:output] ? options[:output]: "./output"
+        @input = options[:input] ? options[:input].gsub('\\', '/') : "./"
+        @output = options[:output] ? options[:output].gsub('\\', '/') : "./"
         @width = 1920
         @height = 1080
-        @font_size = options[:font_size] ? options[:font_size] : 72
+        @font_family = options[:font_family] ? options[:font_family] : 'Open Sans Semibold'
+        @font_size = options[:font_size] ? options[:font_size] : 52
     end
 
     ##
@@ -28,55 +26,22 @@ class Application
     # It sends the file_paths of VTT files in the input directory to convertFileToASS method
     # and outputs the resulting ASS format to a new file.
     def start
-        Dir["#{@input_dir}/*.vtt"].each do |file_path|
-            file_name = File.basename(file_path).gsub('.vtt', '.ass')
-            FileUtils.mkdir_p @output_dir
-            File.open("#{@output_dir}/" + file_name, 'w') do |line|
-                line.print "\ufeff"
-                line.puts convertFileToASS(file_path)
+        if File.directory?(@input) then
+            Dir["#{@input}/*.vtt"].each do |file_path|
+                vtt_to_ass(file_path).writeToFile(File.basename(file_path).gsub('.vtt', '.ass'))
             end
+        elsif File.file?(@input) then
+            vtt_to_ass(@input).writeToFile(@output + File.basename(@input).gsub('.vtt', '.ass'))
+        else
+            puts 'Error: input file or directory does not exist.'
         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.linux? ? "\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_size, @width, @height))
-            end
-        end
-        return ASSFile.new(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.1"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vtt2ass
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.7
 platform: ruby
 authors:
 - Louis-Philippe Fortin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-03-20 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