subtitle_it 0.7.7 → 1.5.0

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Marcos Piccinini, Warlley Rezende, Marcin (tiraeth) Chwedziak
+Copyright (c) 2008 Marcos Piccinini, Giovanni Rapagnani, Warlley Rezende
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -1,4 +1,9 @@
-= Subtitle It
+      __                                            __
+    /    )          /          ,        /           /
+----\--------------/__--_/_------_/_---/----__-----/---_/_-
+     \     /   /  /   ) /    /   /    /   /___)   /    /
+_(____/___(___(__(___/_(_ __/___(_ __/___(___ _ _/_ __(_ __
+
 
 Ruby tool to download, create, convert and fix subtitles.
 
@@ -6,22 +11,9 @@ Ruby tool to download, create, convert and fix subtitles.
 == FEATURES:
 
 * To and from: SRT, SUB, XML(TT), YML, MPL2, RSB and ASS.
-* Download from opensubtitles.org
+* Automatic Download from opensubtitles.org
 * Fixes delays. (SrtResync)
-
-
-== TODO:
-
-* Support styles
 * Compatibility with "sube" (http://github.com/vic/sube)
-* Fix delays
-* Convert 1 to 2 CD`s and versa-vice
-* ASS Format (Yes, for the funny of it...)
-
-
-== REQUIREMENTS:
-
-* hpricot
 
 
 == SYNOPSIS:
@@ -35,10 +27,10 @@ Convert a srt to sub:
 
 Add a delay of 1 minute:
   subtitle_it -d 60 in.srt
- 
+
 Create a template
-  subtitle_it unexistent.file 
-  
+  subtitle_it unexistent.file
+
 
 == INSTALL:
 
@@ -51,9 +43,11 @@ Create a template
 It`s just a easy way, proof of concept to edit subtitles. Here is what it looks like:
 
 00:32 => 00:33 == Nice police work! | Thank you!
-MM:SS => N == TEXT | NEWLINE
+00:35 => 3 == Nice job!
+
+MM:SS => MM:SS or N == TEXT | NEWLINE
 
-Create a template to check it out. 
+Create a template to check it out.
 
 
 == DEV:
@@ -61,10 +55,10 @@ Create a template to check it out.
 To run tests:
 
   rake spec or autotest
-  
+
 Documentation => doc
 Subtitle examples => spec/fixtures
-  
+
 
 == SUBTITLE EDITORS:
 
@@ -75,11 +69,24 @@ Jubler: http://www.jubler.org/
 Aegisub: http://www.malakith.net/aegiwiki/Main_Page
 
 
+== THANKS
+
+* Johanlunds - Opensubtitle.org code (to be used as a gem soon).
+* Marcin (tiraeth) Chwedziak - Sub format first implementation.
+
+
+== TODO:
+
+Please visit:
+
+* http://github.com/nofxx/subtitle_it
+
+
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2008 Marcos Piccinini, Johanlunds, Warlley Rezende
+Copyright (c) 2008 Marcos Piccinini, Giovanni Rapagnani, Warlley Rezende
 
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -99,4 +106,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,4 +1,21 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "subtitle_it"
+    gem.summary = "Download, edit and create subtitles."
+    gem.description = "Download, edit and create subtitles. Supports various formats."
+    gem.email = "x@nofxx.com"
+    gem.homepage = "http://github.com/nofxx/subtitle_it"
+    gem.authors = ["Marcos Piccinini"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :build

data/VERSION

@@ -0,0 +1 @@
+1.5.0

data/bin/subtitle_it

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 #  SubtitleIt
 #
-#  Created on 2008-9-4.
-#  Copyright (c) 2008. All rights reserved.
+#  Created on 2008-09-04.
+#  Copyleft (c) 2008. MIT License.
 #
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 begin
   require 'rubygems'
 rescue LoadError
@@ -28,28 +29,33 @@ SubtitleIt - Download, convert and create subtitles.
 
 Usage: #{File.basename($0)} [options] movie or file_in [file_out]
 
-Options are:
-
 BANNER
-  opts.separator ""
-  
-  opts.on("-l", "--language=LANGUAGE", String,
-          "Language to search subtitles for, try it empty to see the supported ones.") { |OPTIONS[:lang]| }
+
+  opts.separator " Options are:"
+
+  opts.on("-l", "--language [LANGUAGE]", String,
+          "Language to search subtitles for, try it empty to see the supported ones.") do |ol|
+    if ol.nil?
+      puts Subdown.subtitle_languages
+      exit
+    end
+    OPTIONS[:lang] = ol
+  end
 
   opts.on("-c", "--convert=FORMAT", String,
-          "Format to convert to") { |OPTIONS[:format]| }
-          
+          "Format to convert to") { |of| OPTIONS[:format] = of }
+
   opts.on("-d", "--delay=DELAY", Float,
-          "Delay to add/remove") { |OPTIONS[:delay]| }
-          
-  opts.on("-f", "--force", "Force overwrite") { OPTIONS[:force] = true }          
-          
+          "Delay to add/remove") { |od| OPTIONS[:delay] = od }
+
+  opts.on("-f", "--force", "Force overwrite") { OPTIONS[:force] = true }
+
   opts.on("-h", "--help",
-          "Show this help message.") { puts opts; exit }          
-          
+          "Show this help message.") { puts opts; exit }
+
   opts.on("-v", "--version",
-          "Show program version") {   puts "SubtitleIt v#{SubtitleIt::VERSION::STRING}"; exit }          
-          
+          "Show program version") {   puts "SubtitleIt v#{SubtitleIt::VERSION::STRING}"; exit }
+
   opts.parse!(ARGV)
 
   if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
@@ -58,9 +64,8 @@ BANNER
 end
 
 if ARGV.empty?
-  puts parser.banner
+  puts parser
   exit
 else
   SubtitleIt::Bin.run! ARGV, OPTIONS[:lang], OPTIONS[:format], OPTIONS[:force], OPTIONS[:delay]
 end
-

data/lib/subtitle_it/formats/ass.rb

@@ -1,7 +1,7 @@
 # SubtitleIt
 #  ASS - http://en.wikipedia.org/wiki/SubStation_Alpha
 #  http://www.malakith.net/aegiwiki/ASS
-#
+#TODO ass!
 module Formats    
   def parse_ass
 

data/lib/subtitle_it/formats/mpl.rb

@@ -9,10 +9,10 @@ module Formats
   include PlatformEndLine
   def parse_mpl
     @raw.to_a.inject([]) do |i,l|
-		      line_data = l.scan(/^\[([0-9]{1,})\]\[([0-9]{1,})\](.+)$/)
-		      line_data = line_data.at 0
-		      time_on, time_off, text = line_data
-		      time_on, time_off = [time_on.to_i, time_off.to_i].map { |t| t.to_i * 1000 }	    
+      line_data = l.scan(/^\[([0-9]{1,})\]\[([0-9]{1,})\](.+)$/)
+      line_data = line_data.at 0
+      time_on, time_off, text = line_data
+      time_on, time_off = [time_on.to_i, time_off.to_i].map { |t| t.to_i * 1000 }	    
       i << Subline.new(time_on, time_off, text.chomp)
     end
   end

data/lib/subtitle_it/formats/rsb.rb

@@ -12,26 +12,26 @@ module Formats
   include PlatformEndLine
   def parse_rsb
     inn = @raw.to_a
-    @title = inn.delete_at(0).split(':')[1] 
-    @authors = inn.delete_at(0).split(':')[1] 
-    @version = inn.delete_at(0).split(':')[1] 
+    @title = inn.delete_at(0).split(':')[1]
+    @authors = inn.delete_at(0).split(':')[1]
+    @version = inn.delete_at(0).split(':')[1]
     inn.inject([]) do |final,line|
       time_on,time_off = line.split('=>').map { |t| t.strip }
-      text = line.split('==')[1].strip
-      final << Subline.new(time_on, time_off, text)
+      text = line.split('==')[1] #.strip
+      final << Subline.new(time_on, time_off, text ? text.strip : nil)
     end
   end
-  
+
   def to_rsb
     endl = endline( @raw )
     out = ["- title: #{@title}", "- authors: #{@authors}", "- version: #{@version}"]
     @lines.each do |l|
       out << "%s => %s == %s" % [l.time_on.to_s, l.time_off.to_s, l.text]
-    end      
+    end
     return out.join( endl ) + endl
     #out = "- title: #{@title}\n- authors: #{@authors}\n- version: #{@version}\n"
     #out << @lines.inject([]) do |i,l|
     #  i << "%s => %s == %s" % [l.time_on.to_s, l.time_off.to_s, l.text]
-    #end.join("\n")      
-  end    
+    #end.join("\n")
+  end
 end

data/lib/subtitle_it/formats/sub.rb

@@ -13,37 +13,38 @@
 #
 # Where N is ms / framerate / 1000 (ms -> s)
 #
-# parts of the code from 'simplesubtitler' from Marcin (tiraeth) Chwedziak 
+# parts of the code from 'simplesubtitler' from Marcin (tiraeth) Chwedziak
 #
 module Formats
   include PlatformEndLine
   #between our formats, what changes can be reduced to a value
   def ratio
-   1      
+   1
   end
-	 
+
   def parse_sub
-    @raw.to_a.inject([]) do |i,l|
-		      line_data = l.scan(/^\{([0-9]{1,})\}\{([0-9]{1,})\}(.+)$/)
-		      line_data = line_data.at 0
-		      time_on, time_off, text = line_data
-		      time_on, time_off = [time_on.to_i, time_off.to_i].map do |t| 
-			(t.to_i / @fps * 1000 / ratio).to_i 
-		      end	    
-      i << Subline.new(time_on, time_off, text.chomp)
+    # FIXME: 1.8 and 1.9 way of working
+    @raw.send(@raw.respond_to?(:lines) ? :lines : :to_a).reduce([]) do |i,l|
+      line_data = l.scan(/^\{([0-9]{1,})\}\{([0-9]{1,})\}(.+)$/)
+      line_data = line_data.at 0
+      time_on, time_off, text = line_data
+      time_on, time_off = [time_on.to_i, time_off.to_i].map do |t|
+        (t.to_i / @fps * 1000 / ratio).to_i
+      end
+      i << Subline.new(time_on, time_off, text ? text.chomp : nil)
     end
   end
-      
+
   def to_sub
     endl = endline( @raw )
     line_ary = []
-    @lines.each do |l| 
+    @lines.each do |l|
       line_ary << "{%d}{%d}%s" % [parse_time(l.time_on), parse_time(l.time_off), l.text]
     end
     return line_ary.join( endl ) + endl
   end
-  
+
   def parse_time(n)
     n.to_i / 1000 * @fps * ratio
   end
-end 
+end

data/lib/subtitle_it/formats/xml.rb

@@ -20,9 +20,9 @@
 #  </body>
 #</tt>
 require 'hpricot'
-module Formats    
+module Formats
   include PlatformEndLine
-  
+
   def parse_xml
     final = []
     doc = Hpricot.XML(@raw)
@@ -33,7 +33,7 @@ module Formats
     end
     return final
   end
-  
+
   def xml_lines
     endl = endline( @raw )
     line_ary = []
@@ -43,12 +43,12 @@ module Formats
     end
     return line_ary.join( endl )
   end
-      
+
   def to_xml
     endl = endline( @raw )
     out = <<XML
 <?xml version="1.0" encoding="UTF-8"?>
-<tt xml:lang="en" xmlns="http://www.w3.org/2006/04/ttaf1"  xmlns:tts="http://www.w3.org/2006/04/ttaf1#styling">
+<tt xml:lang="en" xmlns="http://www.w3.org/2006/10/ttaf1"  xmlns:tts="http://www.w3.org/2006/10/ttaf1#styling">
   <head>
     <styling>#{@style + endl if @style}
     </styling>

data/lib/subtitle_it/languages.rb

@@ -1,36 +1,40 @@
 module SubtitleIt
-  #TODO: create a lang class?
-  # now I`m more lost.... opensubtitle uses a 3 chars like
+  #  opensubtitle uses a 3 chars like
   # Por => Portuguese
   # Cze => Czech ....
+  #
+  # LANGUAGE /  HUMAN NAME /  OPENSUBTITLE CODE
+  #
+  # Need to rewrite "Portuguese" => [:pt, :por, :whatever]
   LANGS = {
     :aa =>  'Afar',
     :ab =>  'Abkhazian',
     :af =>  'Afrikaans',
     :ak =>  'Akan',
+    :ay =>  'Assyrian',
     :sq =>  'Albanian',
     :am =>  'Amharic',
     :ar =>  'Arabic',
-    :pb =>  'Brazilian Portuguese',
+    :br =>  ['Brazilian', 'por'],
     :hy =>  'Armenian',
     :bs =>  'Bosnian',
     :bg =>  'Bulgarian',
     :ca =>  'Catalan',
-    :zh =>  'Chinese',
     :cs =>  'Czech',
     :da =>  'Danish',
     :nl =>  'Dutch',
+    :en =>  ['English','eng'],
     :et =>  'Estonian',
-    :fr =>  'French',
+    :fr =>  ['French', 'fra'],
     :de =>  'German',
-    :gl =>  'Galician',	
+    :gl =>  'Galician',
     :el =>  'Greek',
     :he =>  'Hebrew',
     :hi =>  'Hindi',
     :hr =>  'Croatian',
     :hu =>  'Hungarian',
     :is =>  'Icelandic',
-    :id =>  'Indonesian',	
+    :id =>  'Indonesian',
     :it =>  'Italian',
     :ja =>  'Japanese',
     :kk =>  'Kazakh',
@@ -54,7 +58,7 @@ module SubtitleIt
     :uk =>  'Ukrainian',
     :vi =>  'Vietnamese',
     :ro =>  'Romanian',
-    :pb =>  'Brazilian',
-    :ay =>  'Assyrian'      
+    :zh =>  'Chinese'
   }
-end
+
+end

data/lib/subtitle_it/movie.rb

@@ -9,7 +9,6 @@ module SubtitleIt
 
     def initialize(filename)
       @filename = filename
-      @haxx = nil
       @info = {}
     end
 
@@ -18,7 +17,7 @@ module SubtitleIt
     end
 
     def size
-      File.size(@filename)
+      @size ||= File.size(@filename)
     end
   end
 end

data/lib/subtitle_it/subdown.rb

@@ -5,12 +5,14 @@ require 'stringio'
 
 require 'subtitle_it/version'
 require 'subtitle_it/subtitle'
+require 'subtitle_it/languages'
 
 module SubtitleIt
   class Subdown
-    HOST = "http://www.opensubtitles.org/xml-rpc"
+    HOST = "http://api.opensubtitles.org/xml-rpc"
     HOST_DEV = "http://dev.opensubtitles.org/xml-rpc"
 
+   # USER_AGENT = "SubDownloader #{SubtitleIt::VERSION::STRING}"
     USER_AGENT = "SubtitleIt #{SubtitleIt::VERSION::STRING}"
 
     NO_TOKEN = %w(ServerInfo LogIn)
@@ -38,11 +40,12 @@ module SubtitleIt
       call('ServerInfo')
     end
 
-    def search_subtitles(movie, lang='')
-      lang ||= ""
-      puts la
+    def search_subtitles(movie, lang_id=nil)
+      lang_name, lang_code = LANGS[lang_id.to_sym] if lang_id
+      print "Searching for "
+      puts lang_id ? lang_name + "..." : "all languages."
       args = {
-        'sublanguageid' => lang,
+        'sublanguageid' => lang_name,
         'moviehash'     => movie.haxx,
         'moviebytesize' => movie.size
       }
@@ -57,7 +60,7 @@ module SubtitleIt
 
     def download_subtitle(sub)
       result = call('DownloadSubtitles', [sub.osdb_id])
-      sub.data = self.class.decode_and_unzip(result['data'][0]['data'])     
+      sub.data = self.class.decode_and_unzip(result['data'][0]['data'])
     end
 
     def upload_subtitle(movie, subs)
@@ -68,40 +71,56 @@ module SubtitleIt
       movie.info = result['data'][movie.haxx] # TODO: Handle if no result for movie
     end
 
-    def subtitle_languages
-      LANGS.map { |l| l[0].to_s }
-      # TODO.. get the correct codes
+    def self.subtitle_languages
+      LANGS.map do |k, v|
+        "#{k} -> #{v}"
+      end.join("\n")
     end
+#
+#    def Subdown.opsub_id( language )   # Get the Opensubtitle.org language id from the language string (e.g. 'French' returns 'fra' )
+#      ary = LANGS.find do |sym_lang|
+#        sym_lang if sym_lang[1].downcase == language.downcase
+#      end
+#      OPSUB_LANGS[ ary[0] ]
+#    end
+
+#    def Subdown.subtitle_languages
+#      lang_ary = []
+#      OPSUB_LANGS.each_key do |key|
+#        lang_ary.push( LANGS[key] )
+#      end
+#      lang_ary.sort.inject( "" ) { |str, lang| str << lang + " " }
+#    end
 
     private
 
-      def call(method, *args)
-        unless NO_TOKEN.include? method
-          raise 'Need to be logged in for this.' unless logged_in?
-          args = [@token, *args]
-        end
+    def call(method, *args)
+      unless NO_TOKEN.include? method
+        raise 'Need to be logged in for this.' unless logged_in?
+        args = [@token, *args]
+      end
 
-        result = @client.call(method, *args)
+      result = @client.call(method, *args)
 #        $LOG.debug "Client#call #{method}, #{args.inspect}: #{result.inspect}"
-        
-        if !self.class.result_status_ok?(result)
-          raise XMLRPC::FaultException.new(result['status'].to_i, result['status'][4..-1]) # 'status' of the form 'XXX Message'
-        end
-        
-        result
-      end
-      
-      # Returns true if status is OK (ie. in range 200-299) or don't exists.
-      def self.result_status_ok?(result)
-        !result.key?('status') || (200...300) === result['status'].to_i
-      end
 
-      def prevent_session_expiration
-        call('NoOperation')
+      unless self.class.result_status_ok?(result)
+        raise XMLRPC::FaultException.new(result['status'].to_i, result['status'][4..-1]) # 'status' of the form 'XXX Message'
       end
 
-      def self.decode_and_unzip(data)
-        Zlib::GzipReader.new(StringIO.new(XMLRPC::Base64.decode(data))).read
-      end
+      result
+    end
+
+    # Returns true if status is OK (ie. in range 200-299) or don't exists.
+    def self.result_status_ok?(result)
+      !result.key?('status') || (200...300) === result['status'].to_i
+    end
+
+    def prevent_session_expiration
+      call('NoOperation')
+    end
+
+    def self.decode_and_unzip(data)
+      Zlib::GzipReader.new(StringIO.new(XMLRPC::Base64.decode(data))).read
+    end
   end
-end
+end

data/lib/subtitle_it/subtime.rb

@@ -3,39 +3,43 @@
 module SubtitleIt
   class Subtime
     attr_accessor :hrs, :min, :sec, :ms
-        
-    def initialize(data) 
-      raise if data == nil          
+
+    def initialize(data)
+      raise if data == nil
       parse_data(data)
     end
-        
+
     # parses string like '00:00:00,000' or single number as ms.
     def parse_data(data)
       case data
-      when Numeric 
-        @sec, @ms = data.divmod(1000)
+      when Numeric
+        @sec, @ms  = data.divmod(1000)
         @min, @sec = @sec.divmod(60)
         @hrs, @min = @min.divmod(60)
-      when String 
+      when String
         time, float = data.split(/\.|\,/)
         time = time.split(/:/).map { |s| s.to_i }
         @ms =  (("0.%d" % float.to_i).to_f * 1000).to_i if float
         @sec, @min, @hrs = time.reverse
       else raise "Format unknown."
-      end 
+      end
       #FIXME: dunno what to do about this.. nil = problems with to_i
       @hrs ||= 0; @min ||= 0; @sec ||= 0;  @ms ||= 0
     end
 
     # to_s(separator) => to_s(",") => 00:00:00,000
-    def to_s(sep='.'); "%02d:%02d:%02d#{sep}%03d" % [@hrs, @min, @sec,  @ms];    end
-    
+    def to_s(sep='.')
+      "%02d:%02d:%02d#{sep}%03d" % [@hrs, @min, @sec,  @ms]
+    end
+
     # return time as a total in ms
-    def to_i;  ( @hrs * 3600 + @min * 60 + @sec ) * 1000 + @ms;    end
-    
-    def +(other);   Subtime.new(self.to_i + other.to_i);    end    
-    def -(other);   Subtime.new(self.to_i - other.to_i);    end    
+    def to_i
+      ( @hrs * 3600 + @min * 60 + @sec ) * 1000 + @ms
+    end
+
+    def +(other);   Subtime.new(self.to_i + other.to_i);    end
+    def -(other);   Subtime.new(self.to_i - other.to_i);    end
     def <=>(other);      self.to_i <=> other.to_i;    end
     include Comparable
   end
-end
+end

data/lib/subtitle_it/version.rb

@@ -1,8 +1,8 @@
 module SubtitleIt
   module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 7
-    TINY  = 7
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/subtitle_it.rb

@@ -20,3 +20,12 @@ class Numeric
     self / ( 10 ** Math::log10(self).to_i)
   end
 end
+
+if RUBY_PLATFORM >= "1.9"
+  class String
+    def to_a
+      self.lines.to_a
+    end
+  end
+end
+

data/spec/fixtures/pseudo.rsb

@@ -1,6 +1,6 @@
 - title: sincity
-- authors: 
+- authors:
 - version: 1.1
 00:05:26.500 => 00:05:28.500 == worth killing for...
 00:06:00.400 => 00:06:03.400 == worth dying for...
-00:07:00.300 => 00:07:03.300 == worth going to the hell for...
+00:07:00.300 => 00:07:03.300 == worth going to the hell for...