subconv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28cd6dd4e5675ee424b07b6ad013fb694e9145b8
+  data.tar.gz: b81878db9e8705adf103bd0ecd40466e54512f77
+SHA512:
+  metadata.gz: a7ac077fc7d2691d74141d49e99051b0679202ac40625f8150846c0f625db85614e636a866db1916b465290143dae41549dd4b98f4712bffd4e11e2c6a7b4995
+  data.tar.gz: 646035c2eaaa3e9726621f552fdd44c0b27b56733f6a7dd70c4677e21fd72893e2748177727e027a6ab5719d9a8afc5ca0da0926f9d278922ed501431e034080

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+/nbproject/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - '**/bin/**/*'
+    - '**/db/schema.rb'
+    - '**/config/**/*'
+    - '**/lib/tasks/*.rake'
+
+# Use only ascii symbols in identifiers.
+AsciiComments:
+  Enabled: false
+
+# Document classes and non-namespace modules.
+Documentation:
+  Enabled: false
+
+# Limit lines to 79 characters.
+LineLength:
+  Enabled: false
+
+BlockDelimiters:
+  EnforcedStyle: semantic
+
+MethodLength:
+  Max: 30
+
+# Checks for proper usage of fail and raise.
+#SignalException:
+#  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+# Avoid the use of attr. Use attr_reader and attr_accessor instead.
+Attr:
+  Enabled: false
+
+UnusedBlockArgument:
+  AutoCorrect: false
+
+UnusedMethodArgument:
+  AutoCorrect: false
+
+CyclomaticComplexity:
+  Max: 30
+
+# https://github.com/bbatsov/ruby-style-guide/issues/395
+RaiseArgs:
+  Enabled: false
+
+AbcSize:
+  Max: 20
+
+TrivialAccessors:
+  AllowPredicates: true
+
+AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+IndentArray:
+  EnforcedStyle: consistent
+
+SignalException:
+  EnforcedStyle: semantic
+
+#MultilineMethodCallIndentation:
+#  EnforcedStyle: indented
+#
+#MultilineOperationIndentation:
+#  EnforcedStyle: indented
+#
+#AlignParameters:
+#  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.3.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Philipp Kerling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+[![Gem Version](https://badge.fury.io/rb/subconv.svg)](http://badge.fury.io/rb/subconv)
+[![Dependency Status](https://gemnasium.com/pkerling/subconv.svg)](https://gemnasium.com/pkerling/subconv)
+[![Build Status](https://travis-ci.org/pkerling/subconv.svg?branch=master)](https://travis-ci.org/pkerling/subconv)
+[![Coverage Status](https://coveralls.io/repos/github/pkerling/subconv/badge.svg?branch=master)](https://coveralls.io/github/pkerling/subconv?branch=master)
+[![Inline docs](http://inch-ci.org/github/pkerling/subconv.svg?branch=master)](http://inch-ci.org/github/pkerling/subconv)
+
+subconv - Ruby SCC (EIA-608) to WebVTT subtitle converter
+=========================================================
+
+This Ruby Gem provides conversion of subtitle files in the .scc (Scenarist Closed
+Captions) format to the more modern WebVTT format that can be used in browsers
+with HTML5 videos.
+
+The processing is modeled after [this paper by the W3C](https://dvcs.w3.org/hg/text-tracks/raw-file/default/608toVTT/608toVTT.html).
+
+Installation
+------------
+	gem install subconv
+
+Usage
+-----
+	$ subconv --help
+	Usage: subconv [options] SCC-FILE
+	    -o, --out-file FILENAME          Write output to specified file instead of stdout
+	    -f, --fps FPS                    Assume given video fps for timecode calculation (default: 29.97)
+	    -c, --no-color                   Remove all color information from output
+	    -F, --no-flash                   Remove all flash (blinking) information from output
+	    -s, --simple-positions           Convert to simple top/bottom center-aligned captions
+	    -h, --help                       Show this help message and quit.
+
+The API can also be used programmatically, the `bin/subconv` file is just an
+example for this.
+
+Supported features
+------------------
+* EIA-608 parsing and conversion to WebVTT
+  * Pop-on captions
+  * Full positioning
+  * All special characters defined in the standard
+  * All colors
+  * Italics
+  * Underline
+  * Flash
+* Optional removal of certain features during the conversion
+  * Color
+  * Flash
+  * Conversion of fine position information to just top/bottom center
+
+Note that with all features removed, most browsers can display the captions as-is,
+but for the colors etc. to work you will need to include a stylesheet that defines
+appropriate styles. The one used in the W3C report is packaged here in `dist/eia608.css`.
+Even then, browsers currently do not correctly support numerous settings yet. Infamously,
+Firefox can not apply classes/styles inside cues at all.
+
+Unsupported features
+--------------------
+* Roll-up captions
+* Paint-on captions
+* EIA-708

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new do |task|
+  task.options = ['--fail-level', 'warning']
+end
+
+task default: [:spec, :rubocop]

data/bin/subconv

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+require 'subconv'
+require 'optparse'
+
+# Parse options
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: subconv [options] SCC-FILE'
+  opts.on('-o', '--out-file FILENAME', 'Write output to specified file instead of stdout') do |filename|
+    options[:out_file] = filename
+  end
+  opts.on('-f', '--fps FPS', 'Assume given video fps for timecode calculation (default: 29.97)') do |fps|
+    options[:fps] = fps
+  end
+  opts.on('-c', '--no-color', 'Remove all color information from output') do
+    options[:no_color] = true
+  end
+  opts.on('-F', '--no-flash', 'Remove all flash (blinking) information from output') do
+    options[:no_flash] = true
+  end
+  opts.on('-s', '--simple-positions', 'Convert to simple top/bottom center-aligned captions') do
+    options[:simple_positions] = true
+  end
+  opts.on_tail('-h', '--help', 'Show this help message and quit.') do
+    puts opts.help
+    exit
+  end
+end.parse!
+options[:in_file] = ARGV.pop
+raise 'No SCC file given to process' unless options[:in_file]
+options[:fps] = 29.97 if options[:fps].nil?
+
+# Do conversion
+reader = Subconv::Scc::Reader.new
+File.open(options[:in_file], File::RDONLY) do |file|
+  reader.read(file, options[:fps].to_f)
+end
+captions = Subconv::Scc::Transformer.new.transform reader.captions
+filter_options = {}
+filter_options[:remove_color] = true if options[:no_color]
+filter_options[:remove_flash] = true if options[:no_flash]
+if options[:simple_positions]
+  filter_options[:merge_by_position] = true
+  filter_options[:xy_position_to_top_or_bottom] = true
+end
+Subconv::CaptionFilter.new(filter_options).process! captions
+writer = Subconv::WebVtt::Writer.new trim_line_whitespace: true
+
+# Write result
+if options[:out_file]
+  File.open(options[:out_file], File::WRONLY | File::TRUNC | File::CREAT) do |file|
+    writer.write(file, captions)
+  end
+else
+  writer.write(STDOUT, captions)
+end
+
+STDERR.write("#{captions.length} captions written\n")

data/dist/eia608.css

@@ -0,0 +1,106 @@
+/* default values */
+::cue {
+  line-height: 5.33vh;
+  font-size: 4.1vh;
+  font-family: monospace;
+  font-style: normal;
+  font-weight: normal;
+  background-color: black;
+  color: white;
+}
+/* special cue parts */
+::cue(c.transparent) {
+  color: transparent;
+}
+/* need to set this before changing color, otherwise the color is lost */
+::cue(c.semi-transparent) {
+  color: rgba(0, 0, 0, 0.5);
+}
+/* need to set this before changing color, otherwise the color is lost */
+::cue(c.opaque) {
+  color: rgba(0, 0, 0, 1);
+}
+::cue(c.blink) {
+  text-decoration: blink;
+}
+::cue(c.white) {
+  color: white;
+}
+::cue(c.red) {
+  color: red;
+}
+::cue(c.green) {
+  color: lime;
+}
+::cue(c.blue) {
+  color: blue;
+}
+::cue(c.cyan) {
+  color: cyan;
+}
+::cue(c.yellow) {
+  color: yellow;
+}
+::cue(c.magenta) {
+  color: magenta;
+}
+::cue(c.bg_transparent) {
+  background-color: transparent;
+}
+/* need to set this before changing color, otherwise the color is lost */
+::cue(c.bg_semi-transparent) {
+  background-color: rgba(0, 0, 0, 0.5);
+}
+/* need to set this before changing color, otherwise the color is lost */
+::cue(c.bg_opaque) {
+  background-color: rgba(0, 0, 0, 1);
+}
+::cue(c.bg_white) {
+  background-color: white;
+}
+::cue(c.bg_green) {
+  background-color: lime;
+}
+::cue(c.bg_blue) {
+  background-color: blue;
+}
+::cue(c.bg_cyan) {
+  background-color: cyan;
+}
+::cue(c.bg_red) {
+  background-color: red;
+}
+::cue(c.bg_yellow) {
+  background-color: yellow;
+}
+::cue(c.bg_magenta) {
+  background-color: magenta;
+}
+::cue(c.bg_black) {
+  background-color: black;
+}
+/* Examples of combined colors */
+::cue(c.bg_white.bg_semi-transparent) {
+  background-color: rgba(255, 255, 255, 0.5);
+}
+::cue(c.bg_green.bg_semi-transparent) {
+  background-color: rgba(0, 256, 0, 0.5);
+}
+::cue(c.bg_blue.bg_semi-transparent) {
+  background-color: rgba(0, 0, 255, 0.5);
+}
+::cue(c.bg_cyan.bg_semi-transparent) {
+  background-color: rgba(0, 255, 255, 0.5);
+}
+::cue(c.bg_red.bg_semi-transparent) {
+  background-color: rgba(255, 0, 0, 0.5);
+}
+::cue(c.bg_yellow.bg_semi-transparent) {
+  background-color: rgba(255, 255, 0, 0.5);
+}
+::cue(c.bg_magenta.bg_semi-transparent) {
+  background-color: rgba(255, 0, 255, 0.5);
+}
+::cue(c.bg_black.bg_semi-transparent) {
+  background-color: rgba(0, 0, 0, 0.5);
+}

data/lib/subconv.rb

@@ -0,0 +1,5 @@
+require 'subconv/version'
+require 'subconv/scc/reader'
+require 'subconv/scc/transformer'
+require 'subconv/webvtt/writer'
+require 'subconv/caption_filter'

data/lib/subconv/caption.rb

@@ -0,0 +1,106 @@
+module Subconv
+  # Two-dimensional screen position relative (both x and y position between 0 and 1) to the screen size
+  class Position
+    def initialize(x, y)
+      self.x = x
+      self.y = y
+    end
+
+    def ==(other)
+      # Ignore small differences in the position
+      self.class == other.class && (@x - other.x).abs < 0.01 && (@y - other.y).abs < 0.01
+    end
+
+    attr_reader :x, :y
+
+    # Force x position to be a float between 0 and 1
+    def x=(x)
+      x = x.to_f
+      fail RangeError, 'X position not between 0 and 1' unless x.between?(0.0, 1.0)
+      @x = x
+    end
+
+    # Force y position to be a float between 0 and 1
+    def y=(y)
+      y = y.to_f
+      fail RangeError, 'Y position not between 0 and 1' unless y.between?(0.0, 1.0)
+      @y = y
+    end
+  end
+
+  # Base class for all nodes
+  class CaptionNode; end
+
+  # Node that contains text
+  class TextNode < CaptionNode
+    def initialize(text)
+      @text = text
+    end
+
+    def ==(other)
+      self.class == other.class && @text == other.text
+    end
+
+    attr_accessor :text
+  end
+
+  # Node that contains other nodes
+  class ContainerNode < CaptionNode
+    def initialize(children = [])
+      self.children = children
+    end
+
+    def ==(other)
+      self.class == other.class && @children == other.children
+    end
+
+    attr_reader :children
+
+    def children=(children)
+      fail 'Children must be an array' unless children.class == Array
+      @children = children
+    end
+  end
+
+  # Special node used as root element for all content
+  class RootNode < ContainerNode; end
+
+  # Italics style node
+  class ItalicsNode < ContainerNode; end
+  # Underline style node
+  class UnderlineNode < ContainerNode; end
+  # Flash style node
+  class FlashNode < ContainerNode; end
+  # Color style node
+  class ColorNode < ContainerNode
+    # Color should be given as symbol, e.g. :white, :red, :blue, ...
+    def initialize(color, children = [])
+      super children
+      @color = color
+    end
+
+    def ==(other)
+      super(other) && @color == other.color
+    end
+
+    attr_accessor :color
+  end
+
+  # Caption displayed on the screen at a specific position for a given amount of time
+  class Caption
+    def initialize(params)
+      # :start, :middle or :end
+      @align = params[:align]
+      @timespan = params[:timespan]
+      # Position instance, :top or :bottom
+      @position = params[:position]
+      @content = params[:content]
+    end
+
+    def ==(other)
+      self.class == other.class && @timespan == other.timespan && @position == other.position && @content == other.content
+    end
+
+    attr_accessor :timespan, :position, :align, :content
+  end
+end