RubyGems - vtt2ass - Versions diffs - 0.2.1 - Mend

vtt2ass 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

checksums.yaml +7 -0
data/.gitignore +9 -0
data/.gitlab-ci.yml +31 -0
data/Gemfile +9 -0
data/LICENSE.txt +21 -0
data/README.md +42 -0
data/Rakefile +10 -0
data/bin/run +4 -0
data/bin/setup +8 -0
data/doc/ASSFile.html +338 -0
data/doc/ASSStyle.html +510 -0
data/doc/ASSSubtitle.html +1012 -0
data/doc/Application.html +487 -0
data/doc/VTTSubtitle.html +700 -0
data/doc/Vtt2ass.html +253 -0
data/doc/Vtt2ass/Error.html +124 -0
data/doc/_index.html +155 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +497 -0
data/doc/file.README.html +91 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +91 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +283 -0
data/doc/top-level-namespace.html +112 -0
data/exe/vtt2ass +4 -0
data/lib/vtt2ass.rb +40 -0
data/lib/vtt2ass/ASSFile.rb +43 -0
data/lib/vtt2ass/ASSStyle.rb +63 -0
data/lib/vtt2ass/ASSSubtitle.rb +92 -0
data/lib/vtt2ass/Application.rb +82 -0
data/lib/vtt2ass/VTTSubtitle.rb +40 -0
data/lib/vtt2ass/version.rb +3 -0
data/vtt2ass.gemspec +27 -0
metadata +85 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.26
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Vtt2ass.html" title="Vtt2ass (module)">Vtt2ass</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="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>
+</p>
+</div>
+      <div id="footer">
+  Generated on Thu Jan 14 00:31:16 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-2.7.2).
+</div>
+    </div>
+  </body>
+</html>

data/exe/vtt2ass ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'vtt2ass'
+Vtt2ass::main

data/lib/vtt2ass.rb ADDED

@@ -0,0 +1,40 @@
+# Imports
+require 'optparse'
+# Relative imports
+require_relative 'vtt2ass/version'
+require_relative 'vtt2ass/Application'
+module Vtt2ass
+    ##
+    # This function creates a new application instance and starts the process.
+    #
+    # It also defines the arguments that can be provided from the CLI.
+    def main
+        options = {}
+        OptionParser.new do |opts|
+            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
+            end
+            opts.on("-o", "--output DIRECTORY", "Specify a custom output directory (default: './output')") do |dir|
+                options[:output] = dir
+            end
+            opts.on("-s", "--font-size SIZE", Integer, "Specify a font size for the subtitles (default: 72)") do |size|
+                options[:font_size] = size
+            end
+            opts.on("-v", "--version", "Show version") do
+                puts Vtt2ass::VERSION
+                exit
+            end
+        end.parse!
+        app = Application.new(options)
+        app.start
+    end
+    module_function :main
+end

data/lib/vtt2ass/ASSFile.rb ADDED

@@ -0,0 +1,43 @@
+##
+# This class defines the ASS File that will be created from the conversion.
+class ASSFile
+    ##
+    # 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)
+        @width = width
+        @height = height
+        @header = [
+            '[Script Info]',
+            'Title: DKB Team',
+            'ScriptType: v4.00+',
+            'Collisions: Normal',
+            'PlayDepth: 0',
+            "PlayResX: #{@width}",
+            "PlayResY: #{@height}",
+            'WrapStyle: 0',
+            'ScaledBorderAndShadow: yes',
+            '',
+            '[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
+    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
+    end
+end

data/lib/vtt2ass/ASSStyle.rb ADDED

@@ -0,0 +1,63 @@
+##
+# This class defines an ASS style that can be applied on a subtitle line.
+class ASSStyle
+    attr_reader :style_name
+    ##
+    # This method creates and instance of an ASSStyle.
+    #
+    # * Requires +style_name+, a string name for the style as input.
+    # * 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)
+        @width = width
+        @height = height
+        @font_size = font_size
+        @style_name = style_name
+        assignParams(params)
+    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"
+    end
+end

data/lib/vtt2ass/ASSSubtitle.rb ADDED

@@ -0,0 +1,92 @@
+##
+# This class defines an ASS subtile line.
+class ASSSubtitle
+    attr_reader :style, :time_start, :time_end, :params, :text
+    ##
+    # This method creates an instance of an ASSSubtitle.
+    #
+    # * 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)
+        @style = style
+        @time_start = convertTime(time_start)
+        @time_end = convertTime(time_end)
+        @params = params
+        @text = convertToAssText(text)
+    end
+    ##
+    # This method assigns the object values and outputs an ASS dialogue line.
+    def to_s
+        return "Dialogue: 0,#{@time_start},#{@time_end},#{@style},,0,0,0,,#{@text}"
+    end
+    ##
+    # 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)
+        text = text
+            .gsub(/\r/, '')
+            .gsub(/\n/, '\\N')
+            .gsub(/\\n/, '\\N')
+            .gsub(/\\N +/, '\\N')
+            .gsub(/ +\\N/, '\\N')
+            .gsub(/(\\N)+/, '\\N')
+            .gsub(/<b[^>]*>([^<]*)<\/b>/) { |s| "{\\b1}#{$1}{\\b0}" }
+            .gsub(/<i[^>]*>([^<]*)<\/i>/) { |s| "{\\i1}#{$1}{\\i0}" }
+            .gsub(/<u[^>]*>([^<]*)<\/u>/) { |s| "{\\u1}#{$1}{\\u0}" }
+            .gsub(/<c[^>]*>([^<]*)<\/c>/) { |s| $1 }
+            .gsub(/<[^>]>/, '')
+            .gsub(/\\N$/, '')
+            .gsub(/ +$/, '')
+        return text
+    end
+    ##
+    # This method validates the time format and sends the matching time to be converted
+    #
+    # * Requires +str+, a VTT formatted time string.
+    def convertTime(time)
+        mTime = time.match(/([\d:]*)\.?(\d*)/)
+        return toSubsTime(mTime[0])
+    end
+    ##
+    # This method converts time from VTT format to the ASS format.
+    #
+    # * Requires +str+, a VTT formatted time string.
+    def toSubsTime(str)
+        n = []
+        x = str.split(/[:.]/).map { |x| x.to_i }
+        msLen = 2
+        hLen = 1
+        x[3] = '0.' + (x[3].to_s).rjust(3, '0')
+        sx = x[0]*60*60 + x[1]*60 + x[2] + x[3].to_f
+        sx = ("%.2f" % sx).split('.')
+        n.unshift(padTimeNum('.', 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))
+        return n.join('')
+    end
+    ##
+    # The method pads text so that time numbers are a fixed number of digit.
+    #
+    # * 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)
+        return sep + (input.to_s).rjust(pad, '0')
+    end
+end

data/lib/vtt2ass/Application.rb ADDED

@@ -0,0 +1,82 @@
+# Imports
+require 'os'
+require 'fileutils'
+# Relative imports
+require_relative 'VTTSubtitle'
+require_relative 'ASSSubtitle'
+require_relative 'ASSStyle'
+require_relative 'ASSFile'
+##
+# Main application class that manages all the operations.
+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"
+        @width = 1920
+        @height = 1080
+        @font_size = options[:font_size] ? options[:font_size] : 72
+    end
+    ##
+    # This method starts the application process.
+    # 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)
+            end
+        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
+    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/VTTSubtitle.rb ADDED

@@ -0,0 +1,40 @@
+##
+# This class defines a VTT subtile line.
+class VTTSubtitle
+    attr_reader :style, :time_start, :time_end, :params, :text
+    ##
+    # This method creates an instance of an VTTSubtitle.
+    #
+    # * Requires +paragraph+, a VTT formatted string as input.
+    def initialize(paragraph)
+        lines = paragraph.split("\n")
+        rx = /^([\d:.]*) --> ([\d:.]*)\s?(.*?)\s*$/
+        @style = "Main"
+        @text, @time_start, @time_end, @params = ""
+        count = 0
+        lines.each do |line|
+            m = line.match(rx)
+            if not m and count == 0 then
+                @style = line
+            elsif m then
+                @time_start = m[1]
+                @time_end = m[2]
+                @params = m[3]
+                if @params.include? "align:middle line:7%" then
+                    @style = "MainTop"
+                end
+            else
+                @text += line + "\n"
+            end
+            count += 1;
+        end
+    end
+    ##
+    # This method assigns the object values and outputs a VTT dialogue line.
+    def to_s
+        return "#{@style} \n#{@time_start} --> #{@time_end} #{@params}\n#{@text}"
+    end
+end