timestamp_maker 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '045783f7b5b5a84f233d29cabecbd024978ba089878c094e4c8f3f8750f884dc'
-  data.tar.gz: b2225e7ff4eca4da0e87593e4ad7ab704c87d4e5a75c46c86fc191ed083b5e69
+  metadata.gz: e7f96f255213ceac42648b8ad1317b745d64062f6ad116fd8365d64408077101
+  data.tar.gz: 6c4c191ee701c7ffbf539b9665df9b3064608f50cf7eee06cffede24f46aa7a4
 SHA512:
-  metadata.gz: 9af1f4d12c9f92f6b08678966c4ff4f722706f2b9f633aaa739154399380090c28cff6d6fa3d8c126d5989e9b986c0e94c67c4aeae52d92b73976a6afe380f37
-  data.tar.gz: b015042b64a96b483db3c2f16e3f5f236b33150cbddced62c845703ce644ad76b88dba3d87167ed264192b5e6d520211e37fcb1f379ca1ee088e9db89af58c8d
+  metadata.gz: 0f4e5a1e7f61304642cc758d82a4ec2a95af43a4f10fda93cb1f813468a1f6a6a321da5606acca79ad8724ca9ed79af162b8bedf82b3d9c0cae51ffd59a111de
+  data.tar.gz: 02712023f7dcd89f9083b95074ddde9770c6b73083e314d380bc71dd5020896a650ef509f79ff7183821f5ca18193805c2c1e9cc5a8cd65624ff5796bbe74214

data/bin/timestamp

@@ -16,7 +16,8 @@ options = {
   coordinate_origin: 'top-left',
   x: 32,
   y: 32,
-  font_padding: 8
+  font_padding: 8,
+  require: []
 }
 
 option_parser = OptionParser.new do |parser|
@@ -69,6 +70,10 @@ option_parser = OptionParser.new do |parser|
   parser.on('--font-padding NUM', Integer, 'Defaults to 8.') do |value|
     options[:font_padding] = value
   end
+
+  parser.on('-r LIB', '--require LIB', Array, 'Comma-separated Ruby libs') do |value|
+    options[:require] = value
+  end
 end
 option_parser.parse!
 
@@ -80,7 +85,8 @@ end
 input = ARGV.shift
 output = ARGV.shift
 
-TimestampMaker.add_timestamp(
+options[:require].each { |i| require i }
+TimestampMaker.instance.add_timestamp(
   input,
   output,
   format: options[:format],

data/lib/timestamp_maker.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'marcel'
 require 'pathname'
-require 'timestamp_maker/video_timestamper'
-require 'timestamp_maker/mime_recognizer'
-require 'timestamp_maker/image_timestamper'
+require 'timestamp_maker/handlers/image_magick'
+require 'timestamp_maker/handlers/ffmpeg'
+require 'timestamp_maker/mime_recognizers/marcel'
+require 'timestamp_maker/time_zone_lookupers/wheretz'
 require 'tzinfo'
 
-module TimestampMaker
+class TimestampMaker
   COORDINATE_ORIGINS = %w[
     top-left
     top-right
@@ -15,55 +15,69 @@ module TimestampMaker
     bottom-right
   ].freeze
 
-  @mime_recognizer = MimeRecognizer
-  @image_timestamper = ImageTimestamper
-  @video_timestamper = VideoTimestamper
+  attr_accessor :mime_recognizer, :handlers
 
-  class << self
-    attr_reader :mime_recognizer, :image_timestamper, :video_timestamper
+  singleton_class.attr_writer :instance
+  def self.instance
+    @instance ||= new
+  end
 
-    def add_timestamp(
-      input_path, output_path,
-      format: '%Y-%m-%d %H:%M:%S',
-      time: nil,
-      font_size: 32,
-      font_family: 'Sans',
-      font_color: 'white',
-      background_color: '#000000B3',
-      time_zone: nil,
-      coordinate_origin: 'top-left',
-      x: 32,
-      y: 32,
-      font_padding: 8
-    )
-      mime_type = mime_recognizer.recognize(input_path)
-      processor =
-        case mime_type.split('/').first
-        when 'image' then image_timestamper
-        when 'video' then video_timestamper
-        else raise "Unsupported MIME type: ##{mime_type}"
-        end
-      time = processor.creation_time(input_path) if time.nil?
-      raise ArgumentError unless time.is_a?(Time)
+  def initialize(
+    mime_recognizer: MimeRecognizers::Marcel.new,
+    handlers: [
+      Handlers::ImageMagick.new(
+        time_zone_lookuper: TimeZoneLookupers::Wheretz.new
+      ),
+      Handlers::Ffmpeg.new(
+        time_zone_lookuper: TimeZoneLookupers::Wheretz.new
+      )
+    ]
+  )
+    @mime_recognizer = mime_recognizer
+    @handlers = handlers
+  end
 
-      time.localtime(TZInfo::Timezone.get(time_zone)) unless time_zone.nil?
+  def add_timestamp(
+    input_path, output_path,
+    format: '%Y-%m-%d %H:%M:%S',
+    time: nil,
+    font_size: 32,
+    font_family: 'Sans',
+    font_color: 'white',
+    background_color: '#000000B3',
+    time_zone: nil,
+    coordinate_origin: 'top-left',
+    x: 32,
+    y: 32,
+    font_padding: 8
+  )
+    mime_type = mime_recognizer.recognize(input_path)
+    handler = handlers.find { |i| i.accept?(mime_type) }
+    raise "Unsupported MIME type: ##{mime_type}" if handler.nil?
 
-      unless COORDINATE_ORIGINS.include?(coordinate_origin)
-        raise ArgumentError, "coordinate origin should be one of #{COORDINATE_ORIGINS.join(',')}"
-      end
+    time = handler.creation_time(input_path) if time.nil?
+    raise ArgumentError unless time.is_a?(Time)
 
-      processor.add_timestamp(
-        input_path, output_path, time,
-        format: format,
-        font_size: font_size,
-        font_family: font_family,
-        font_color: font_color,
-        background_color: background_color,
-        coordinate_origin: coordinate_origin,
-        x: x,
-        y: y,
-        font_padding: font_padding
+    time.localtime(TZInfo::Timezone.get(time_zone)) unless time_zone.nil?
+
+    unless COORDINATE_ORIGINS.include?(coordinate_origin)
+      raise(
+        ArgumentError,
+        "coordinate origin should be one of #{COORDINATE_ORIGINS.join(',')}"
       )
     end
+
+    handler.add_timestamp(
+      input_path, output_path, time,
+      format: format,
+      font_size: font_size,
+      font_family: font_family,
+      font_color: font_color,
+      background_color: background_color,
+      coordinate_origin: coordinate_origin,
+      x: x,
+      y: y,
+      font_padding: font_padding
+    )
   end
 end

data/lib/timestamp_maker/{video_timestamper.rb → handlers/ffmpeg.rb}

@@ -6,9 +6,20 @@ require 'open3'
 require 'English'
 require 'tzinfo'
 
-module TimestampMaker
-  module VideoTimestamper
-    class << self
+class TimestampMaker
+  module Handlers
+    class Ffmpeg
+
+      attr_accessor :time_zone_lookuper
+
+      def initialize(time_zone_lookuper:)
+        @time_zone_lookuper = time_zone_lookuper
+      end
+
+      def accept?(mime_type)
+        mime_type.start_with?('video/')
+      end
+
       def add_timestamp(
         input_path,
         output_path,
@@ -45,13 +56,14 @@ module TimestampMaker
         ]
 
         tz = tz_env_string(time)
-        raise "Command failed with exit #{$CHILD_STATUS.exitstatus}: #{command.first}" unless system({ 'TZ' => tz }, *command)
+        raise "Command failed with exit #{$CHILD_STATUS.exitstatus}: #{command.first}" unless system({ 'TZ' => tz },
+                                                                                                     *command)
       end
 
       def creation_time(input_path)
         command = %W[
           ffprobe -v warning -print_format json
-          -show_entries format_tags=creation_time,com.apple.quicktime.creationdate
+          -show_entries format_tags=creation_time,com.apple.quicktime.creationdate,location
           #{input_path}
         ]
         stdout_string, status = Open3.capture2(*command)
@@ -61,11 +73,29 @@ module TimestampMaker
         iso8601_string = parsed['format']['tags']['com.apple.quicktime.creationdate'] || parsed['format']['tags']['creation_time']
         raise 'Cannot find creation time' if iso8601_string.nil?
 
-        Time.iso8601(iso8601_string)
+        time = Time.iso8601(iso8601_string)
+
+        iso6709_string = parsed['format']['tags']['location']
+        if iso6709_string && (time_zone = retrieve_time_zone_from_iso6709(iso6709_string))
+          begin
+            return TZInfo::Timezone.get(time_zone).to_local(time)
+          rescue TZInfo::InvalidTimezoneIdentifier
+            warn "Can not find time zone: #{time_zone}"
+          end
+        end
+
+        time
       end
 
       private
 
+      def retrieve_time_zone_from_iso6709(string)
+        data = string.match(/([+-]\d*\.?\d*)([+-]\d*\.?\d*)/)
+        latitude = data[1].to_f
+        longitude = data[2].to_f
+        time_zone_lookuper.lookup(latitude: latitude, longitude: longitude)
+      end
+
       def tz_env_string(time)
         return time.zone.name if time.zone.is_a? TZInfo::Timezone
 

data/lib/timestamp_maker/handlers/image_magick.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'time'
+require 'English'
+require 'tzinfo'
+
+class TimestampMaker
+  module Handlers
+    class ImageMagick
+      GRAVITY_MAP = {
+        'top-left' => 'NorthWest',
+        'top-right' => 'NorthEast',
+        'bottom-left' => 'SouthWest',
+        'bottom-right' => 'SouthEast'
+      }.freeze
+
+      attr_accessor :time_zone_lookuper
+
+      def initialize(time_zone_lookuper:)
+        @time_zone_lookuper = time_zone_lookuper
+      end
+
+      def accept?(mime_type)
+        mime_type.start_with?('image/')
+      end
+
+      def add_timestamp(
+        input_path,
+        output_path,
+        time,
+        format:,
+        font_size:,
+        font_family:,
+        font_color:,
+        background_color:,
+        coordinate_origin:,
+        x:,
+        y:,
+        font_padding:
+      )
+        time_string = time.strftime(format)
+        command = %W[
+          convert #{input_path}
+          (
+          -background #{background_color}
+          -fill #{font_color}
+          -family #{font_family}
+          -pointsize #{font_size}
+          -gravity NorthWest
+          -splice #{font_padding}x#{font_padding}
+          -gravity SouthEast
+          -splice #{font_padding}x#{font_padding}
+          label:#{time_string}
+          )
+          -gravity #{GRAVITY_MAP[coordinate_origin]}
+          -geometry +#{x}+#{y}
+          -composite #{output_path}
+        ]
+        raise "Command failed with exit #{$CHILD_STATUS.exitstatus}: #{command.first}" unless system(*command)
+      end
+
+      def creation_time(input_path)
+        command = %W[
+          identify -format %[exif:DateTime*]%[exif:OffsetTime*]%[exif:GPSLatitude*]%[exif:GPSLongitude*] #{input_path}
+        ]
+
+        stdout_string, status = Open3.capture2(*command)
+        raise unless status.success?
+
+        parsed = Hash[stdout_string.split("\n").map! { |i| i[5..-1].split('=') }]
+
+        time_string = parsed['DateTimeOriginal'] || parsed['DateTimeDigitized'] || parsed['DateTime']
+        raise 'Cannot find creation time' if time_string.nil?
+
+        time_arguments = time_string.split(/[: ]/).map(&:to_i)
+
+        if (time_zone = retrieve_time_zone_by_coordinate(parsed))
+          begin
+            return TZInfo::Timezone.get(time_zone).local_time(*time_arguments)
+          rescue TZInfo::InvalidTimezoneIdentifier
+            warn "Can not find time zone: #{time_zone}"
+          end
+        end
+
+        time_offset_string = parsed['OffsetTimeOriginal'] || parsed['OffsetTimeDigitized'] || parsed['OffsetTime']
+        raise 'Can not find time offset' if time_offset_string.nil?
+
+        Time.new(*time_arguments, time_offset_string)
+      end
+
+      private
+
+      def parse_coordinate_number(string)
+        degree, minute, second = string.split(', ').map! { |i| Rational(i) }
+        (degree + minute / 60 + second / 3600).to_f
+      end
+
+      def retrieve_time_zone_by_coordinate(exif)
+        unless exif['GPSLatitude'] && exif['GPSLatitudeRef'] && exif['GPSLongitude'] && exif['GPSLongitudeRef']
+          return nil
+        end
+
+        latitude = parse_coordinate_number(exif['GPSLatitude'])
+        latitude = -latitude if exif['GPSLatitudeRef'] == 'S'
+        longitude = parse_coordinate_number(exif['GPSLongitude'])
+        longitude = -longitude if exif['GPSLongitudeRef'] == 'W'
+
+        time_zone_lookuper.lookup(latitude: latitude, longitude: longitude)
+      end
+    end
+  end
+end

data/lib/timestamp_maker/mime_recognizers/marcel.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'marcel'
+
+class TimestampMaker
+  module MimeRecognizers
+    class Marcel
+      def recognize(path)
+        ::Marcel::MimeType.for(Pathname.new(path))
+      end
+    end
+  end
+end

data/lib/timestamp_maker/time_zone_lookupers/geo_name.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+class TimestampMaker
+  module TimeZoneLookupers
+    ENDPOINT = URI.parse('http://api.geonames.org/timezoneJSON')
+
+    class GeoName
+      attr_accessor :username
+
+      def initialize(username:)
+        @username = username
+      end
+
+      def lookup(latitude:, longitude:)
+        query = URI.encode_www_form(
+          [['lat', latitude], ['lng', longitude], ['username', username]]
+        )
+        response = Net::HTTP.get_response(URI.parse("#{ENDPOINT}?#{query}"))
+        raise "Got HTTP status code: #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+
+        parsed = JSON.parse(response.body)
+        parsed['timezoneId']
+      end
+    end
+  end
+end

data/lib/timestamp_maker/time_zone_lookupers/mock.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class TimestampMaker
+  module TimeZoneLookupers
+    class Mock
+      def initialize(time_zone)
+        @time_zone = time_zone
+      end
+
+      def lookup(*)
+        @time_zone
+      end
+    end
+  end
+end

data/lib/timestamp_maker/time_zone_lookupers/wheretz.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'wheretz'
+require 'json' # wheretz forgets to require json
+
+class TimestampMaker
+  module TimeZoneLookupers
+    class Wheretz
+      def lookup(latitude:, longitude:)
+        case result = WhereTZ.lookup(latitude, longitude)
+        when String then result
+        when Array then result.first
+        else raise 'Something went wrong with WhereTZ'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timestamp_maker
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Weihang Jian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: wheretz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -76,9 +90,12 @@ extra_rdoc_files: []
 files:
 - bin/timestamp
 - lib/timestamp_maker.rb
-- lib/timestamp_maker/image_timestamper.rb
-- lib/timestamp_maker/mime_recognizer.rb
-- lib/timestamp_maker/video_timestamper.rb
+- lib/timestamp_maker/handlers/ffmpeg.rb
+- lib/timestamp_maker/handlers/image_magick.rb
+- lib/timestamp_maker/mime_recognizers/marcel.rb
+- lib/timestamp_maker/time_zone_lookupers/geo_name.rb
+- lib/timestamp_maker/time_zone_lookupers/mock.rb
+- lib/timestamp_maker/time_zone_lookupers/wheretz.rb
 homepage: https://github.com/tonytonyjan/timestamp_maker
 licenses:
 - MIT

data/lib/timestamp_maker/image_timestamper.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-require 'time'
-require 'English'
-
-module TimestampMaker
-  module ImageTimestamper
-    GRAVITY_MAP = {
-      'top-left' => 'NorthWest',
-      'top-right' => 'NorthEast',
-      'bottom-left' => 'SouthWest',
-      'bottom-right' => 'SouthEast'
-    }.freeze
-
-    def self.add_timestamp(
-      input_path,
-      output_path,
-      time,
-      format:,
-      font_size:,
-      font_family:,
-      font_color:,
-      background_color:,
-      coordinate_origin:,
-      x:,
-      y:,
-      font_padding:
-    )
-      time_string = time.strftime(format)
-      command = %W[
-        convert #{input_path}
-        (
-        -background #{background_color}
-        -fill #{font_color}
-        -family #{font_family}
-        -pointsize #{font_size}
-        -gravity NorthWest
-        -splice #{font_padding}x#{font_padding}
-        -gravity SouthEast
-        -splice #{font_padding}x#{font_padding}
-        label:#{time_string}
-        )
-        -gravity #{GRAVITY_MAP[coordinate_origin]}
-        -geometry +#{x}+#{y}
-        -composite #{output_path}
-      ]
-      raise "Command failed with exit #{$CHILD_STATUS.exitstatus}: #{command.first}" unless system(*command)
-    end
-
-    def self.creation_time(input_path)
-      command = %W[
-        identify -format %[exif:DateTime*]%[exif:OffsetTime*] #{input_path}
-      ]
-
-      stdout_string, status = Open3.capture2(*command)
-      raise unless status.success?
-
-      parsed = Hash[stdout_string.split("\n").map! { |i| i[5..-1].split('=') }]
-
-      time_string = parsed['DateTimeOriginal'] || parsed['DateTimeDigitized'] || parsed['DateTime']
-      raise 'Cannot find creation time' if time_string.nil?
-
-      time_offset_string = parsed['OffsetTimeOriginal'] || parsed['OffsetTimeDigitized'] || parsed['OffsetTime'] || 'Z'
-
-      Time.strptime("#{time_string} #{time_offset_string}", '%Y:%m:%d %H:%M:%S %Z')
-    end
-  end
-end

data/lib/timestamp_maker/mime_recognizer.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module TimestampMaker
-  module MimeRecognizer
-    def self.recognize(path)
-      Marcel::MimeType.for(Pathname.new(path))
-    end
-  end
-end