Class: SRT

Inherits:
Object
  • Object
show all
Includes:
AllFather, CommonUtils
Defined in:
lib/srt.rb

Overview

Library to handle SRT Files

Uses the translator available to do the necessary language operations as defined by the AllFather

Constant Summary collapse

SUPPORTED_TRANSFORMATIONS = 
[TYPE_SCC, TYPE_VTT, TYPE_TTML, TYPE_DFXP]

Constants included from CommonUtils

CommonUtils::CREDITS, CommonUtils::SCC_DEFAULT_FRAME_RATE

Constants included from AllFather

AllFather::TYPE_DFXP, AllFather::TYPE_SCC, AllFather::TYPE_SRT, AllFather::TYPE_TTML, AllFather::TYPE_VTT, AllFather::VALID_FILES

Instance Method Summary collapse

Methods included from CommonUtils

#create_file, #extension_from_type, #new_cue, #scc_encode, #time_details, #write_cue

Methods included from AllFather

#callsign

Constructor Details

#initialize(cc_file) ⇒ SRT

Returns a new instance of SRT.



19
20
21
22
 
# File 'lib/srt.rb', line 19

def initialize(cc_file)
  @cc_file = cc_file
  raise "Invalid SRT file provided" unless is_valid?
end

Instance Method Details

#infer_languages ⇒ Object 



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/srt.rb', line 76

def infer_languages
  lang = nil
  begin
    sample_text = get_text(@cc_file, 100)
    lang = @translator.infer_language(sample_text)
  rescue StandardError => e
    puts "Error while detecting the language due to #{e.message}"
  end
  [lang]
end

#is_valid? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
27
28
29
30
 
# File 'lib/srt.rb', line 24

def is_valid?
  # Do any SRT specific validations here
  if @cc_file =~ /^.*\.(srt)$/
    return true
  end
  return false
end

#set_translator(translator) ⇒ Object 



32
33
34
35
 
# File 'lib/srt.rb', line 32

def set_translator(translator)
  super(translator)
  @translator = translator
end

#supported_transformations ⇒ Object 



87
88
89
 
# File 'lib/srt.rb', line 87

def supported_transformations
  return SUPPORTED_TRANSFORMATIONS
end

#transform_to(types, src_lang, target_lang, output_dir) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/srt.rb', line 91

def transform_to(types, src_lang, target_lang, output_dir)
  # Let's start off with some validations
  super(types, src_lang, target_lang, output_dir)

  # Suffix output dir with File seperator
  output_dir = "#{output_dir}#{File::Separator}" unless output_dir.end_with?(File::Separator)

  translate = false
  if target_lang && !target_lang.empty?
    translate = true
    if @translator.nil?
      raise StandardError.new("Cannot infer language as engine options are not provided")
    end
  end
  
  # Prepare the output files for each type
  file_map = {}
  types.each do |type|
    output_file = File.basename(@cc_file, File.extname(@cc_file))
    output_file << "_#{target_lang}" if translate
    output_file << extension_from_type(type)
    out_file = "#{output_dir}#{output_file}"
    if create_file(TYPE_SRT, type, out_file, target_lang)
      file_map[type] = out_file
    else
      raise StandardError.new("Failed to create output file for type #{type}")
    end
  end

  # Read the file and prepare the cue model
  cue_info = nil
  ccfile = File.open(@cc_file, 'r:UTF-8', &:read)
  message = ""
  ccfile.each_line do | line |
    # p line
    next if line.strip.empty?
    time_points = line.scan(/^((\d\d:)\d\d:\d\d[,.]\d\d\d.*)-->.*((\d\d:)\d\d:\d\d[,.]\d\d\d)/)
    if time_points.empty?
      # This is not a time point
      seq = line.strip
      if seq.to_i > 0
        cue_info.message = translated_msg(translate, message, src_lang, target_lang) unless message.empty?
        write_cue(cue_info, file_map) if cue_info
        cue_info = CueInfo.new(TYPE_SRT)
        cue_info.sequence = seq
        # Reset the message
        message = ""
      else
        # This is not a sequence number nor it's timepoints
        # Grab the details until we find next cue point
        message << line
      end
    else
      # This is a cue point. Fetch timestamps
      cue_info.start = time_points[0][0]
      cue_info.end = time_points[0][2]
      start_units = time_details(cue_info.start, TYPE_SRT)
      end_units = time_details(cue_info.end, TYPE_SRT)
      cue_info.start_time_units = start_units
      cue_info.end_time_units = end_units
    end
  end
  cue_info.message = translated_msg(translate, message, src_lang, target_lang) unless message.empty?
  write_cue(cue_info, file_map, true)
end

#translate(src_lang, dest_lang, out_file) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/srt.rb', line 37

def translate(src_lang, dest_lang, out_file)
  super(src_lang, dest_lang, out_file)
  begin
    ccfile = File.open(@cc_file, 'r:UTF-8', &:read)
    outfile = File.open(out_file, "w")
    text_collection = false
    text_sample = ""
    ccfile.each_line do | line |
      if line =~ /^(\d\d:)\d\d:\d\d[,.]\d\d\d.*-->.*(\d\d:)\d\d:\d\d[,.]\d\d\d/
        text_collection = true
        outfile.puts line
      elsif line.strip.empty? && !text_sample.empty?
        json_text = JSON.parse(text_sample) rescue nil
        if json_text.nil?
          trans_resp = @translator.translate(text_sample, src_lang, dest_lang)
          outfile.puts trans_resp
        else
          outfile.puts text_sample
        end
        outfile.puts
        text_sample = ""
        text_collection = false
      elsif text_collection
        text_sample << line
      else
        outfile.puts line
      end
    end

    if !text_sample.empty?
      trans_resp = @translator.translate(text_sample, src_lang, dest_lang)
      outfile.puts trans_resp
      outfile.puts
    end
  ensure
    outfile.close
  end
end