webvtt-editor 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a84565214ad4ba7a5590c566ea9263ae0f2f4654
+  data.tar.gz: 1c33fa1abcb621a6b90c03611ab3120fd7560c9d
+SHA512:
+  metadata.gz: 81b27a20feaafecbb80aa8f2d0c5322ebfc988a7475f35d5d7dff63ac1c3fb4db74e58809e434b927a713808ad1c925cdf7e9bf9529663d7a0495a80509ea5e8
+  data.tar.gz: 32c86e880bfc64a021b25df62350abfdb0d565e14ab09bfebed1b89960ae7af5af769957ce50993762001090d62b9186567bb3007e3223301cdfcd2f535cc4fe

data/README.md

@@ -0,0 +1,39 @@
+# webvtt-editor
+Target
+=========================
+>作为rails第三方插件实现在线编辑webvtt字幕文件
+
+Usage
+---------------------------------------------
+* 将文件夹放在rails的app目录下
+* 引入插件
+ ```
+ gem "webvtt-editor"  
+ ```
+ 
+* 加载文件
+
+ ```
+ webvtt = WebVTT.read("filepath")
+ ``` 
+ 
+* 插入字幕
+
+ ```
+ webvtt.insert(start_time,end_time,subtitles)
+ ``` 
+ 
+* 删除字幕
+ ```
+ webvtt.delete(start_time,end_time)
+ ```
+ 
+* 字幕信息
+
+ ```
+ webvtt.cues do |cue|
+   cue.start
+   cue.end
+   cue.text
+ end
+ ```  

data/lib/vtt/cue.rb

@@ -0,0 +1,85 @@
+"""
+@author:   smalt(jjs1233@163.com)
+
+cue.rb
+~~~~~~~~~~~~~~~~
+"""
+module WebVTT
+	class Cue
+	    attr_accessor :identifier, :start, :end, :style, :text
+
+	    def initialize(cue = nil)
+	      @content = cue
+	      @style = {}
+	    end
+
+	    #读取内容
+	    def self.parse(cue)	    	
+	      cue = Cue.new(cue)
+	      cue.parse
+	      return cue
+	    end
+
+	    #把文字内容写入
+	    def to_webvtt
+	      res = ""
+	      if @identifier
+	        res << "#{@identifier}\n"
+	      end
+	      res << "#{@content}".strip 
+	      res
+	    end
+
+	    #时间戳转换成秒
+	    def self.timestamp_in_sec(timestamp)
+	      mres = timestamp.match(/([0-9]{2}):([0-9]{2}):([0-9]{2}\.[0-9]{3})/)
+	      sec = mres[3].to_f # 秒
+	      sec += mres[2].to_f * 60 #分
+	      sec += mres[1].to_f * 60 * 60 #小时
+	      return sec
+	    end
+
+	    #开始时间转换成fixnum类型
+	    def start_in_sec
+	      @start.to_f
+	    end
+
+	    #结束时间转换成fixnum类型
+	    def end_in_sec
+	      @end.to_f
+	    end
+
+	    #持续时间
+	    def length
+	      @end.to_f - @start.to_f
+	    end
+
+	   #时间添加
+	    def offset_by( offset_secs )
+	      @start += offset_secs
+	      @end   += offset_secs
+	    end
+
+	    #切割文字内容 把文字内容二次加工
+	    def parse
+	      lines = @content.split("\n").map(&:strip)
+	      return if lines[0] =~ /NOTE/
+
+	      if !lines[0].include?("-->")
+	        @identifier = lines[0]
+	        lines.shift
+	      end
+
+	      if lines.empty?
+	        return
+	      end
+
+	      if lines[0].match(/(([0-9]{2}:)?[0-9]{2}:[0-9]{2}\.[0-9]{3}) -+> (([0-9]{2}:)?[0-9]{2}:[0-9]{2}\.[0-9]{3})(.*)/)
+	        @start = Timestamp.new $1
+	        @end = Timestamp.new $3
+	        @style = Hash[$5.strip.split(" ").map{|s| s.split(":").map(&:strip) }]
+	      end
+	      @text = lines[1..-1].join("\n")
+	    end
+	  end
+end

data/lib/vtt/smalt.rb

@@ -0,0 +1,127 @@
+"""
+@author:   smalt(jjs1233@163.com)
+
+smalt.rb
+~~~~~~~~~~~~~~~~
+"""
+module WebVTT
+	class Smalt
+		attr_reader :header, :path, :filename,:cues,:new,:old
+	    	attr_accessor :cue_parsed
+		def initialize(f)
+			@file = File.new(f,'a+')
+			@path = f	
+	      		@filename = File.basename(@path)
+		  	parse
+		end
+
+		#初始化 读取文件信息 把文件内容写入cue 文件地址写入path 文件名写入filename
+		def parse
+			content = File.read(@path)
+	      		if content.nil? ||content.empty? 
+	      			@output =  "WEBVTT"
+	      			file_puts
+	      		end
+		      @content = File.read(@path).gsub("\r\n", "\n")
+		      @content.gsub!("\uFEFF", '')
+		      cues = @content.split("\n\n")
+		      @header = cues.shift
+		      header_lines = @header.split("\n").map(&:strip)
+		      @header.gsub!("\n","")
+		      if (header_lines[0] =~ /^WEBVTT/).nil?
+		        raise MalformedFile, "Not a valid WebVTT file"
+		      end
+
+		      @cues = []
+		      cues.each do |cue|
+		        cue_parsed = Cue.parse(cue.strip)
+		        if !cue_parsed.text.nil?
+		          @cues << cue_parsed
+		        end
+		      end
+	    	end
+
+	    	#删除字幕
+		def delete(*args)
+			if @cues.reject! do |cue|
+					cue.start.to_f == args[0] && cue.end.to_f == args[1]
+				end
+			else
+				raise ArgumentError.new("This time does not exist or The arguments you give wrong")
+			end
+			save
+		end
+
+		#插入字幕
+		def insert(*args)
+			@start = args[0]
+			@end = args[1]
+			if time_check.empty?
+				@new = Cue.parse([time_fix,args[-1]].join("\n").strip)
+				i = -1
+				begin
+					i += 1
+				end while !@cues[i].nil?&&@new.start.to_f > @cues[i].start.to_f 
+				modify(i)
+				save
+			else
+				raise ArgumentError.new("The arguments you give wrong or This period of time in the file already exists")
+			end
+		end
+
+		#文件输出 写入内容后输出文件
+	    	def save(output=nil)
+	      		output ||= @path.gsub(".srt", ".vtt")
+	      		File.open(output, "w") do |f|
+	        		f.write(to_webvtt)
+	      		end
+	      		return output
+	    	end
+
+	    	#整合把cue内容转换成文件需要的内容
+	    	def to_webvtt
+	     	 	[@header, @cues.map(&:to_webvtt)].flatten.join("\n\n") << "\n"
+	    	end
+
+	    	#结束时间
+	    	def total_length
+	      		@cues.last.end_in_sec
+	    	end
+
+	    	#字幕持续时间
+	   	def actual_total_length
+	      		@cues.last.end_in_sec - @cues.first.start_in_sec
+	    	end
+
+		#把时间经行加工 混合
+		def time_fix
+			@time = [@start,@end].map do |time|
+				Timestamp.new(time).to_hms
+			end
+			@time.join(" --> ")
+		end
+
+		#判断时间格式是否正确
+		def time_check
+			if @end.to_f > @start.to_f 
+				@cues.reject do|cue| 
+					(cue.end.to_f >@start.to_f && cue.start.to_f > @end.to_f ) ||(cue.end.to_f < @start.to_f && cue.start.to_f < @end.to_f )
+				end
+			else
+				raise ArgumentError.new("The arguments you give wrong or End time must be greater than the Start")
+			end
+		end
+
+		#文件内容保存
+		def file_puts
+			@file.puts(@output)
+			@file.close
+		end
+
+		#把新字幕写入cue
+		def modify(a,b = 0)
+			@cues[a,b] = @new
+		end
+
+	end
+end

data/lib/vtt/timestamp.rb

@@ -0,0 +1,76 @@
+"""
+@author:   smalt(jjs1233@163.com)
+
+timestamp.rb
+~~~~~~~~~~~~~~~~
+"""
+module WebVTT
+	class Timestamp
+	    #时间戳转换成秒
+	    def self.parse_seconds( timestamp )
+	      if mres = timestamp.match(/\A([0-9]{2}):([0-9]{2}):([0-9]{2}\.[0-9]{3})\z/)
+	        sec = mres[3].to_f 
+	        sec += mres[2].to_f * 60 
+	        sec += mres[1].to_f * 60 * 60 
+	      elsif mres = timestamp.match(/\A([0-9]{2}):([0-9]{2}\.[0-9]{3})\z/)
+	        sec = mres[2].to_f 
+	        sec += mres[1].to_f * 60
+	      else
+	        raise ArgumentError.new("Invalid WebVTT timestamp format: #{timestamp.inspect}")
+	      end
+	      return sec
+	    end
+
+	    def initialize( time )
+	      if time.to_s =~ /^\d+([.]\d*)?$/
+	        @timestamp = time
+	      elsif time.is_a? String
+	        @timestamp = Timestamp.parse_seconds( time )
+	      else
+	        raise ArgumentError.new("time not Fixnum nor a string")
+	      end
+	    end
+
+	    #输出类型转换城string
+	    def to_s
+	      @timestamp.to_s
+	    end
+
+	    #小时分秒转换
+	    def to_hms
+	      hms_start
+	      @hms = @round.reduce( [ @timestamp ] ) { |m,o|m.unshift(m.shift.divmod(o)).flatten }
+	      @hms << (@timestamp.divmod(1).last * 1000).round
+	      hms_result
+	    end
+
+	    #小时判断
+	    def hms_start
+	    	if @timestamp > 3600
+			@round = Array.new 2,60
+		else
+			@round = Array.new 1,60
+		end
+	    end
+
+	    #小时结果输出
+	    def hms_result
+	    	if @timestamp > 3600
+			 sprintf("%02d:%02d:%02d.%03d", *@hms)
+		else
+			 sprintf("%02d:%02d.%03d", *@hms)
+		end
+	    end
+
+	    #秒类型转换fixnum
+	    def to_f
+	      @timestamp.to_f
+	    end
+
+	    #秒向前滚动
+	    def +(other)
+	      Timestamp.new self.to_f + other.to_f
+	    end
+
+	end
+end

data/lib/vtt/vtt.rb

@@ -0,0 +1,22 @@
+"""
+@author:   smalt(jjs1233@163.com)
+
+vtt.rb
+~~~~~~~~~~~~~~~~
+"""
+module WebVTT
+	#读取文件
+	def self.read(f)
+		if is_vtt? f
+			Smalt.new(f)
+		else
+			raise MalformedFile, "Not a valid VTT file"
+		end
+	end
+
+	#判断文件是否是vtt文件
+	def self.is_vtt?(path)
+		return path[/\.[^\.]+$/] == ".vtt"
+	end
+
+end

data/lib/webvtt-editor.rb

@@ -0,0 +1,17 @@
+"""
+@author:   smalt(jjs1233@163.com)
+
+webvtt.rb
+~~~~~~~~~~~~~~~~
+"""
+# encoding: UTF-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+if defined?(Encoding)
+  Encoding.default_internal = Encoding.default_external = "UTF-8"
+end
+
+
+require "vtt/vtt"
+require "vtt/cue"
+require "vtt/timestamp"
+require "vtt/smalt"	

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: webvtt-editor
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Smalt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies: []
+description: A webvtt file edit gem
+email: jjs1233@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/vtt/cue.rb
+- lib/vtt/smalt.rb
+- lib/vtt/timestamp.rb
+- lib/vtt/vtt.rb
+- lib/webvtt-editor.rb
+homepage: https://github.com/jjs1233/webvtt-editor
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: webvtt-editor
+test_files: []