titlekit 1.0.0

data/spec/simultaneous_subtitles/triple_plus/two.srt

@@ -0,0 +1,11 @@
+1
+00:00:02,000 --> 00:00:10,000
+Somos utilizando seis subtítulos simultáneamente
+
+2
+00:00:12,000 --> 00:00:20,000
+Esto es correcto
+
+3
+00:00:23,000 --> 00:00:31,000
+No son alineado sin embargo

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'titlekit'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/specifications_spec.rb

@@ -0,0 +1,138 @@
+require File.join(File.expand_path(__dir__), 'spec_helper')
+
+shared_examples 'a specification' do
+
+  describe '#new' do
+    it 'creates a new specification' do
+      expect(described_class.new).to be_a_kind_of(described_class)
+    end
+  end
+
+  describe '#encoding' do
+    let(:specification) do
+      described_class.new.encoding('utf-8')
+    end
+
+    it 'returns the specification' do
+      expect(specification).to be_a_kind_of(described_class)
+    end
+
+    it 'returns the set encoding' do
+      expect(specification.encoding).to eq('utf-8')
+    end
+  end
+
+  describe '#file' do
+    let(:specification) do
+      described_class.new.file('the/path.srt')
+    end
+
+    it 'returns the specification' do
+      expect(specification).to be_a_kind_of(described_class)
+    end
+
+    it 'returns the set path' do
+      expect(specification.file).to eq('the/path.srt')
+    end
+  end
+
+  describe '#fps' do
+    let(:specification) do
+      described_class.new.fps(25)
+    end
+
+    it 'returns the specification' do
+      expect(specification).to be_a_kind_of(described_class)
+    end
+
+    it 'returns the set framerate' do
+      expect(specification.fps).to eq(25)
+    end
+  end
+
+  describe '#reference' do
+    context 'specifying a minute' do
+      let(:specification) do
+        described_class.new.reference(:some_point, minutes: 3.5)
+      end
+
+      it 'returns the specification' do
+        expect(specification).to be_a_kind_of(described_class)
+      end
+
+      it 'returns the set named reference for a timecode' do
+        expect(specification.references[:some_point][:timecode]).to eq(210)
+      end
+    end    
+
+    context 'specifying an SRT timecode' do
+      let(:specification) do
+        described_class.new.reference(:some_point, srt_timecode: '00:03:30,000')
+      end
+
+      it 'returns the specification' do
+        expect(specification).to be_a_kind_of(described_class)
+      end
+
+      it 'returns the set named reference for a timecode' do
+        expect(specification.references[:some_point][:timecode]).to eq(210)
+      end
+    end
+
+    context 'specifying an ASS timecode' do
+      let(:specification) do
+        described_class.new.reference(:some_point, ass_timecode: '0:03:30.00')
+      end
+
+      it 'returns the specification' do
+        expect(specification).to be_a_kind_of(described_class)
+      end
+
+      it 'returns the set named reference for a timecode' do
+        expect(specification.references[:some_point][:timecode]).to eq(210)
+      end
+    end
+
+    context 'specifying an SSA timecode' do
+      let(:specification) do
+        described_class.new.reference(:some_point, ssa_timecode: '0:03:30.00')
+      end
+
+      it 'returns the specification' do
+        expect(specification).to be_a_kind_of(described_class)
+      end
+
+      it 'returns the set named reference for a timecode' do
+        expect(specification.references[:some_point][:timecode]).to eq(210)
+      end
+    end       
+  end
+end
+
+describe Titlekit::Specification do
+  it_behaves_like 'a specification'
+end
+
+describe Titlekit::Have do
+  it_behaves_like 'a specification'
+
+  describe '#reference' do
+    context 'specifying a subtitle' do
+      let(:specification) do
+        described_class.new.reference(:some_point, subtitle: 23)
+      end
+
+      it 'returns the specification' do
+        expect(specification).to be_a_kind_of(described_class)
+      end
+
+      it 'returns the set named reference for a subtitle' do
+        expect(specification.references[:some_point][:subtitle]).to eq(23)
+      end
+    end
+  end
+end
+
+describe Titlekit::Want do
+  it_behaves_like 'a specification'
+end

data/spec/srt_spec.rb

@@ -0,0 +1,134 @@
+require File.join(File.expand_path(__dir__), 'spec_helper')
+
+describe Titlekit::SRT do
+
+  describe '.import' do
+
+    context 'with a simple file' do
+      let(:subtitles) do
+        Titlekit::SRT.import(File.read('spec/files/srt/simple.srt'))
+      end
+
+      it 'parses and builds 3 subtitles' do
+        expect(subtitles.length).to eq(3)
+      end
+
+      it 'parses and builds correct ids' do
+        expect(subtitles[0][:id]).to eq(1)
+      end
+
+      it 'parses and builds correct timecodes' do
+        expect(subtitles[1][:start]).to eq(24)
+        expect(subtitles[1][:end]).to eq(37.8)
+      end
+
+      it 'parses and builds correct lines' do
+        expect(subtitles[2][:lines]).to eq("- I ...\n- Enough!!!")
+      end
+    end
+
+    context 'with an authentic file' do
+      let(:subtitles) do
+        Titlekit::SRT.import(File.read('spec/files/srt/authentic.srt'))
+      end
+
+      it 'parses and builds 600 subtitles' do
+        expect(subtitles.length).to eq(600)
+      end
+
+      it 'parses and builds correct ids' do
+        expect(subtitles[599][:id]).to eq(600)
+      end
+
+      it 'parses and builds correct timecodes' do
+        expect(subtitles[299][:start]).to eq(1426.564)
+        expect(subtitles[299][:end]).to eq(1428.759)
+      end
+
+      it 'parses and builds correct lines' do
+        expect(subtitles[0][:lines]).to eq("<i>(male narrator) Previously\r\non Battlestar Galactica.</i>")
+      end
+    end 
+
+    context 'with a file that contains coordinates' do
+      let(:subtitles) do
+        Titlekit::SRT.import(File.read('spec/files/srt/coordinates.srt'))
+      end
+
+      it 'parses and builds 3 subtitles' do
+        expect(subtitles.length).to eq(3)
+      end
+
+      it 'parses and builds correct ids' do
+        expect(subtitles[0][:id]).to eq(1)
+      end
+
+      it 'parses and builds correct timecodes' do
+        expect(subtitles[1][:start]).to eq(16)
+        expect(subtitles[1][:end]).to eq(32)
+      end
+
+      it 'parses and builds correct lines' do
+        expect(subtitles[2][:lines]).to eq("A: Still I'm implementing them; Whatevs.")
+      end
+
+      it 'ignores the display coordinates' do
+        # just fyi
+      end
+    end     
+  end
+
+  describe '.export' do
+    it 'should export valid SRT' do
+      subtitles = [
+        {
+          id: 1,
+          start: 1.5,
+          end: 3.7,
+          lines: 'Eine feine Testung haben sie da!'
+        },
+        {
+          id: 2,
+          start: 1.5,
+          end: 3.7,
+          lines: '¡Sí claro! Pero que lastima que no es 100% español ...'
+        },
+        {
+          id: 3,
+          start: 1.5,
+          end: 3.7,
+          lines: 'Oh yeah ... 寧為太平犬，不做亂世人'
+        }
+      ]
+
+      expected = <<-EXPECTED
+1
+00:00:01,500 --> 00:00:03,700
+Eine feine Testung haben sie da!
+
+2
+00:00:01,500 --> 00:00:03,700
+¡Sí claro! Pero que lastima que no es 100% español ...
+
+3
+00:00:01,500 --> 00:00:03,700
+Oh yeah ... 寧為太平犬，不做亂世人
+
+      EXPECTED
+
+      expect(Titlekit::SRT.export(subtitles)).to eq(expected)
+    end
+  end
+
+  describe '.build_timecode' do
+    it 'builds an SRT timecode from a float timecode value' do
+       expect(Titlekit::SRT.build_timecode(35.9678)).to eq('00:00:35,968')
+    end
+  end
+
+  describe '.parse_timecode' do
+    it 'obtains a float timecode value from an SRT timecode' do
+       expect(Titlekit::SRT.parse_timecode('00:00:35,968')).to eq(35.968)
+    end
+  end    
+end

data/spec/ssa_spec.rb

@@ -0,0 +1,90 @@
+require File.join(File.expand_path(__dir__), 'spec_helper')
+
+describe Titlekit::SSA do
+
+  describe '.import' do
+
+    context 'with a simple file' do
+      let(:subtitles) do
+        Titlekit::SSA.import(File.read('spec/files/ssa/simple.ssa'))
+      end
+
+      it 'parses and builds 3 subtitles' do
+        expect(subtitles.length).to eq(2)
+      end
+
+      it 'parses and builds correct ids' do
+        expect(subtitles[0][:id]).to eq(1)
+      end
+
+      it 'parses and builds correct timecodes' do
+        expect(subtitles[1][:start]).to eq(11.84)
+        expect(subtitles[1][:end]).to eq(14.74)
+      end
+
+      it 'parses and builds correct lines' do
+        expect(subtitles[1][:lines]).to eq("{\\a2}Story Script & Direction - MIYAZAKI Hayao")
+      end
+    end
+  end
+
+  describe '.export' do
+    it 'should export valid SSA' do
+      subtitles = [
+        {
+          start: 1.5,
+          end: 3.7,
+          lines: 'Eine feine Testung haben sie da!'
+        },
+        {
+          id: 2,
+          start: 1.5,
+          end: 3.7,
+          lines: '¡Sí claro! Pero que lastima que no es 100% español ...'
+        },
+        {
+          id: 3,
+          start: 1.5,
+          end: 3.7,
+          lines: 'Oh yeah ... 寧為太平犬，不做亂世人'
+        }
+      ]
+
+      expected = <<-EXPECTED
+[Script Info]
+ScriptType: v4.00
+
+[V4 Styles]
+Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, TertiaryColour, BackColour, Bold, Italic, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, AlphaLevel, Encoding
+Style: Default,Arial,16,16777215,16777215,16777215,-2147483640,0,0,1,3,0,2,70,70,40,0,0
+Style: Middle,Arial,16,16777215,16777215,16777215,-2147483640,0,0,1,3,0,10,70,70,40,0,0
+Style: Top,Arial,16,16777215,16777215,16777215,-2147483640,0,0,1,3,0,6,70,70,40,0,0
+Style: EDF393,Arial,16,9696237,9696237,9696237,-2147483640,0,0,1,3,0,2,70,70,40,0,0
+Style: F5E665,Arial,16,6678261,6678261,6678261,-2147483640,0,0,1,3,0,2,70,70,40,0,0
+Style: FFC472,Arial,16,7521535,7521535,7521535,-2147483640,0,0,1,3,0,2,70,70,40,0,0
+Style: FFA891,Arial,16,9545983,9545983,9545983,-2147483640,0,0,1,3,0,2,70,70,40,0,0
+Style: 89BABE,Arial,16,12499593,12499593,12499593,-2147483640,0,0,1,3,0,2,70,70,40,0,0
+
+[Events]
+Format: Marked, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
+Dialogue: 0,0:00:01.50,0:00:03.70,Default,,0000,0000,0000,,Eine feine Testung haben sie da!
+Dialogue: 0,0:00:01.50,0:00:03.70,Default,,0000,0000,0000,,¡Sí claro! Pero que lastima que no es 100% español ...
+Dialogue: 0,0:00:01.50,0:00:03.70,Default,,0000,0000,0000,,Oh yeah ... 寧為太平犬，不做亂世人
+      EXPECTED
+
+      expect(Titlekit::SSA.export(subtitles)).to eq(expected)
+    end
+  end
+
+  describe '.build_timecode' do
+    it 'builds an SSA timecode from a float timecode value' do
+       expect(Titlekit::SSA.build_timecode(35.9678)).to eq('0:00:35.97')
+    end
+  end
+
+  describe '.parse_timecode' do
+    it 'obtains a float timecode value from an SSA timecode' do
+       expect(Titlekit::SSA.parse_timecode('0:00:35.96')).to eq(35.96)
+    end
+  end    
+end

data/spec/timecode_correction/double_reference/expected.srt

@@ -0,0 +1,13 @@
+1
+00:00:02,400 --> 00:00:09,153
+Commencing shaving the yak.
+
+2
+00:00:32,000 --> 00:00:50,880
+WAT?
+
+3
+00:00:32,000 --> 00:00:50,880
+- I ...
+- Enough!!!
+

data/spec/timecode_correction/double_reference/in.srt

@@ -0,0 +1,12 @@
+1
+00:00:02,364 --> 00:00:07,300
+Commencing shaving the yak.
+
+2
+00:00:24,000 --> 00:00:37,800
+WAT?
+
+3
+00:00:24,000 --> 00:00:37,800
+- I ...
+- Enough!!!

data/spec/timecode_correction/double_reference/out.srt

@@ -0,0 +1,13 @@
+1
+00:00:02,400 --> 00:00:09,153
+Commencing shaving the yak.
+
+2
+00:00:32,000 --> 00:00:50,880
+WAT?
+
+3
+00:00:32,000 --> 00:00:50,880
+- I ...
+- Enough!!!
+

data/spec/timecode_correction/framerate/expected.srt

@@ -0,0 +1,5 @@
+1
+00:00:30,000 --> 00:00:33,600
+If this subtitle represents timecodes for a 25fps movie
+Then it would have to start at 00:00:30,000 in a 30fps movie
+

data/spec/timecode_correction/framerate/in.srt

@@ -0,0 +1,4 @@
+1
+00:00:25,000 --> 00:00:28,000
+If this subtitle represents timecodes for a 25fps movie
+Then it would have to start at 00:00:30,000 in a 30fps movie

data/spec/timecode_correction/framerate/out.srt

@@ -0,0 +1,5 @@
+1
+00:00:30,000 --> 00:00:33,600
+If this subtitle represents timecodes for a 25fps movie
+Then it would have to start at 00:00:30,000 in a 30fps movie
+

data/spec/timecode_correction/framerate_plus_reference/expected.srt

@@ -0,0 +1,13 @@
+1
+00:00:03,500 --> 00:00:08,436
+Commencing shaving the yak.
+
+2
+00:00:25,136 --> 00:00:38,936
+WAT?
+
+3
+00:00:25,136 --> 00:00:38,936
+- I ...
+- Enough!!!
+

data/spec/timecode_correction/framerate_plus_reference/in.srt

@@ -0,0 +1,12 @@
+1
+00:00:02,364 --> 00:00:07,300
+Commencing shaving the yak.
+
+2
+00:00:24,000 --> 00:00:37,800
+WAT?
+
+3
+00:00:24,000 --> 00:00:37,800
+- I ...
+- Enough!!!

data/spec/timecode_correction/framerate_plus_reference/out.srt

@@ -0,0 +1,13 @@
+1
+00:00:03,500 --> 00:00:08,436
+Commencing shaving the yak.
+
+2
+00:00:25,136 --> 00:00:38,936
+WAT?
+
+3
+00:00:25,136 --> 00:00:38,936
+- I ...
+- Enough!!!
+

data/spec/timecode_correction/single_reference/expected.srt

@@ -0,0 +1,13 @@
+1
+00:00:03,864 --> 00:00:08,800
+Commencing shaving the yak.
+
+2
+00:00:25,500 --> 00:00:39,300
+WAT?
+
+3
+00:00:25,500 --> 00:00:39,300
+- I ...
+- Enough!!!
+

data/spec/timecode_correction/single_reference/in.srt

@@ -0,0 +1,12 @@
+1
+00:00:02,364 --> 00:00:07,300
+Commencing shaving the yak.
+
+2
+00:00:24,000 --> 00:00:37,800
+WAT?
+
+3
+00:00:24,000 --> 00:00:37,800
+- I ...
+- Enough!!!

data/spec/timecode_correction/single_reference/out.srt

@@ -0,0 +1,13 @@
+1
+00:00:03,864 --> 00:00:08,800
+Commencing shaving the yak.
+
+2
+00:00:25,500 --> 00:00:39,300
+WAT?
+
+3
+00:00:25,500 --> 00:00:39,300
+- I ...
+- Enough!!!
+

data/spec/timecode_correction/timecode_correction_spec.rb

@@ -0,0 +1,124 @@
+require File.join(File.expand_path(__dir__), '../spec_helper')
+
+describe Titlekit::Job do
+
+  describe 'Timecode correction' do
+
+    context 'Based on differing framerates' do
+      before(:all) do
+        @in = File.join(__dir__, 'framerate', 'in.srt')
+        @out = File.join(__dir__, 'framerate', 'out.srt')
+        @expected = File.join(__dir__, 'framerate', 'expected.srt')
+
+        File.delete(@out) if File.exist?(@out)
+      end
+
+      it 'runs the job' do
+        job = Titlekit::Job.new
+
+        have = job.have
+        have.file(@in)
+        have.fps(25)
+
+        want = job.want
+        want.file(@out)
+        want.fps(30)
+
+        expect(job.run).to be_true
+      end
+
+      it 'delivers the expected output' do
+        expect(FileUtils.compare_file(@out, @expected)).to be_true
+      end      
+    end
+
+    context 'Based on a single reference' do
+      before(:all) do
+        @in = File.join(__dir__, 'single_reference', 'in.srt')
+        @out = File.join(__dir__, 'single_reference', 'out.srt')
+        @expected = File.join(__dir__, 'single_reference', 'expected.srt')
+
+        File.delete(@out) if File.exist?(@out)
+      end
+
+      it 'runs the job' do
+        job = Titlekit::Job.new
+
+        have = job.have
+        have.file(@in)
+        have.reference('first subtitle', seconds: 2)
+
+        want = job.want
+        want.file(@out)
+        want.reference('first subtitle', seconds: 3.5)
+
+        expect(job.run).to be_true
+      end
+
+      it 'delivers the expected output' do
+        expect(FileUtils.compare_file(@out, @expected)).to be_true
+      end       
+    end
+
+    context 'Based on differing framerates plus a reference' do
+      before(:all) do
+        @in = File.join(__dir__, 'framerate_plus_reference', 'in.srt')
+        @out = File.join(__dir__, 'framerate_plus_reference', 'out.srt')
+        @expected = File.join(__dir__, 'framerate_plus_reference', 'expected.srt')
+
+        File.delete(@out) if File.exist?(@out)
+      end
+
+      it 'runs the job' do
+        job = Titlekit::Job.new
+
+        have = job.have
+        have.file(@in)
+        have.fps(25)
+        have.reference('first subtitle', subtitle: 0)
+
+        want = job.want
+        want.file(@out)
+        have.fps(23.976)
+        want.reference('first subtitle', seconds: 3.5)
+
+        expect(job.run).to be_true
+      end
+
+      it 'delivers the expected output' do
+        expect(FileUtils.compare_file(@out, @expected)).to be_true
+      end       
+    end
+
+    context 'Based on two references' do
+      before(:all) do
+        @in = File.join(__dir__, 'double_reference', 'in.srt')
+        @out = File.join(__dir__, 'double_reference', 'out.srt')
+        @expected = File.join(__dir__, 'double_reference', 'expected.srt')
+
+        File.delete(@out) if File.exist?(@out)
+      end
+
+      it 'runs the job' do
+        job = Titlekit::Job.new
+
+        have = job.have
+        have.file(@in)
+        have.reference('first subtitle', seconds: 2.364)
+        have.reference('last subtitle', seconds: 24)
+
+        want = job.want
+        want.file(@out)
+        want.reference('first subtitle', seconds: 2.4)
+        want.reference('last subtitle', seconds: 32)
+
+        expect(job.run).to be_true
+      end
+
+      it 'delivers the expected output' do
+        expect(FileUtils.compare_file(@out, @expected)).to be_true
+      end
+    end
+
+  end
+end

data/spec/transcoding/gb2312-ascii/in.srt

@@ -0,0 +1,12 @@
+1
+00:00:02,364 --> 00:00:07,300
+����̫ƽȮ�������y����
+
+2
+00:00:24,000 --> 00:00:37,800
+����̫ƽȮ�������y����
+
+3
+00:00:34,000 --> 00:00:47,800
+No chinese skills here, just copy and paste :(
+

data/spec/transcoding/iso-8859-1_utf-8/expected.srt

@@ -0,0 +1,12 @@
+1
+00:00:02,364 --> 00:00:07,300
+¿Cifrado con ISO-8859-1?
+
+2
+00:00:24,000 --> 00:00:37,800
+¡Sí claro!
+
+3
+00:00:34,000 --> 00:00:47,800
+Pues ... ¡Vamos a ver!
+

data/spec/transcoding/iso-8859-1_utf-8/in.srt

@@ -0,0 +1,11 @@
+1
+00:00:02,364 --> 00:00:07,300
+�Cifrado con ISO-8859-1?
+
+2
+00:00:24,000 --> 00:00:37,800
+�S� claro!
+
+3
+00:00:34,000 --> 00:00:47,800
+Pues ... �Vamos a ver!