timestamp_maker 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01abd157048ff7bdbf8fee5cd139f8e238c48dc82850202aa4f9c7748d7bf8da
-  data.tar.gz: 7c94cd8a48aab112d17a48f97112cb5594fd517415518202e0dc6074e1b707a0
+  metadata.gz: ed37875d238df5bcc9566649a2767aff49522b6baab2f2c5bb07f4a788e38f5b
+  data.tar.gz: 14647536fd8c17f34a02e9b7d4542e8c154561fcea3c569a18613fa174338ecf
 SHA512:
-  metadata.gz: 48cf23b7cb6c1526825316f148875a7554371e7e3c2ca5716a3e33b7585277789a7d698d4b0811eb60c59d445af742e16b43a3c454d68365f372f428db245f0a
-  data.tar.gz: 9b1d3b546e5a0ac019efb0f46fa2763b40614e0efb406b38e5430d96fbb8540d99b92d7f34fcafe86f19e34fd91b70319ea7240ad9b1c9ee88d1f55c1c021c8b
+  metadata.gz: e8289f87c08d1f3b81f7f8835cf02a68e197cba768425f962a3d16e8b2fcb8567cb6cb675aa1e4e5ed762dfe077509cb74fb18b3394bf32952d2ed7e1c0e5c32
+  data.tar.gz: 063ccdfd4dbe3a585238b44e20a6728aff9faef849499efeb303b47154488f347644e934bb78eb1b177fd53ea43372c27bc6780ab29de4fe4e34dff0b08aceab

data/bin/timestamp

@@ -3,9 +3,72 @@
 
 require 'timestamp_maker'
 require 'optparse'
+require 'optparse/time'
 
-option_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: #{__FILE__} INPUT_FILE_PATH OUTPUT_FILE_PATH"
+options = {
+  format: '%Y-%m-%d %H:%M:%S',
+  time: nil,
+  time_zone: nil,
+  font_size: 32,
+  font_family: 'Sans',
+  font_color: 'white',
+  background_color: '#000000B3',
+  coordinate_origin: 'top-left',
+  x: 32,
+  y: 32,
+  font_padding: 8
+}
+
+option_parser = OptionParser.new do |parser|
+  parser.banner = "Usage: #{__FILE__} [options] INPUT_FILE_PATH OUTPUT_FILE_PATH"
+
+  parser.on('-f FORMAT', '--format FORMAT', 'strftime() format string, defaults to "%Y-%m-%d %H:%M:%S".') do |value|
+    options[:format] = value
+  end
+
+  parser.on(
+    '-t TIME',
+    '--time TIME', Time,
+    'ISO 8601 or RFC 2616 string. By default, retrieves from file\'s metadata'
+  ) do |value|
+    options[:time] = value
+  end
+
+  parser.on('--font-size NUMBER', Integer, 'Defaults to 32.') do |value|
+    options[:font_size] = value
+  end
+
+  parser.on('--font-family FONT_FAMILY', 'Defaults to "Sans"') do |value|
+    options[:font_family] = value
+  end
+
+  parser.on('--font-color COLOR', '"#RRGGBB[AA]" or color name, Defaults to "white"') do |value|
+    options[:font_color] = value
+  end
+
+  parser.on('--background-color COLOR', '"#RRGGBB[AA]" or color name, Defaults to "#000000B3"') do |value|
+    options[:background_color] = value
+  end
+
+  parser.on('--time-zone TIME_ZONE', 'IANA time zone. By default, retrieves from media file\'s metadata') do |value|
+    options[:time_zone] = value
+  end
+
+  parser.on('--coordinate-origin ORIGIN', 'Should be "[top|bottom]-[left|right]". Defaults to "top-left"') do |value|
+    options[:coordinate_origin] = value
+  end
+
+  parser.on('-x X', Integer, 'coordinate x. Defaults to 32.') do |value|
+    options[:x] = value
+  end
+
+  parser.on('-y Y', Integer, 'coordinate y, Defaults to 32.') do |value|
+    options[:y] = value
+  end
+
+  parser.on('--font-padding NUM', Integer, 'Defaults to 8.') do |value|
+    options[:font_padding] = value
+  end
 end
 option_parser.parse!
 
@@ -17,4 +80,18 @@ end
 input = ARGV.shift
 output = ARGV.shift
 
-TimestampMaker.add_timestamp(input, output)
+TimestampMaker.add_timestamp(
+  input,
+  output,
+  format: options[:format],
+  time: options[:time],
+  time_zone: options[:time_zone],
+  font_size: options[:font_size],
+  font_family: options[:font_family],
+  font_color: options[:font_color],
+  background_color: options[:background_color],
+  coordinate_origin: options[:coordinate_origin],
+  x: options[:x],
+  y: options[:y],
+  font_padding: options[:font_padding]
+)

data/lib/timestamp_maker.rb

@@ -5,8 +5,16 @@ require 'pathname'
 require 'timestamp_maker/video_timestamper'
 require 'timestamp_maker/mime_recognizer'
 require 'timestamp_maker/image_timestamper'
+require 'tzinfo'
 
 module TimestampMaker
+  COORDINATE_ORIGINS = %w[
+    top-left
+    top-right
+    bottom-left
+    bottom-right
+  ].freeze
+
   @mime_recognizer = MimeRecognizer
   @image_timestamper = ImageTimestamper
   @video_timestamper = VideoTimestamper
@@ -14,7 +22,20 @@ module TimestampMaker
   class << self
     attr_reader :mime_recognizer, :image_timestamper, :video_timestamper
 
-    def add_timestamp(input_path, output_path)
+    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
@@ -22,7 +43,27 @@ module TimestampMaker
         when 'video' then video_timestamper
         else raise "Unsupported MIME type: ##{mime_type}"
         end
-      processor.add_timestamp(input_path, output_path)
+      time = processor.creation_time(input_path) if time.nil?
+      raise ArgumentError unless time.is_a?(Time)
+
+      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
+
+      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
+      )
     end
   end
 end

data/lib/timestamp_maker/image_timestamper.rb

@@ -5,22 +5,44 @@ require 'time'
 
 module TimestampMaker
   module ImageTimestamper
-    def self.add_timestamp(input_path, output_path)
-      time_string = creation_time(input_path).iso8601
+    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[
         magick convert #{input_path}
         (
-        -background rgba(0,0,0,0.7)
-        -fill white
-        -font Roboto
-        -pointsize 32
+        -background #{background_color}
+        -fill #{font_color}
+        -family #{font_family}
+        -pointsize #{font_size}
         -gravity NorthWest
-        -splice 1x1
+        -splice #{font_padding}x#{font_padding}
         -gravity SouthEast
-        -splice 1x1
+        -splice #{font_padding}x#{font_padding}
         label:#{time_string}
         )
-        -gravity NorthWest -geometry +32+32 -composite #{output_path}
+        -gravity #{GRAVITY_MAP[coordinate_origin]}
+        -geometry +#{x}+#{y}
+        -composite #{output_path}
       ]
       system(*command, exception: true)
     end

data/lib/timestamp_maker/video_timestamper.rb

@@ -3,45 +3,105 @@
 require 'json'
 require 'time'
 require 'open3'
-require 'shellwords'
 
 module TimestampMaker
   module VideoTimestamper
-    def self.add_timestamp(input_path, output_path)
-      creation_timestamp = creation_time(input_path).to_i
-      drawtext = %W[
-        x=32
-        y=32
-        font=Roboto
-        fontsize=32
-        fontcolor=white
-        box=1
-        boxcolor=black@0.7
-        boxborderw=8
-        text=%{pts\\\\:localtime\\\\:#{creation_timestamp}}
-      ].join(':')
-
-      command = %W[
-        ffmpeg -y -v warning -i #{input_path} -map_metadata 0
-        -vf drawtext=#{drawtext}
-        #{output_path}
-      ]
-
-      system(*command, exception: true)
-    end
+    class << self
+      def add_timestamp(
+        input_path,
+        output_path,
+        time,
+        format:,
+        font_size:,
+        font_family:,
+        font_color:,
+        background_color:,
+        coordinate_origin:,
+        x:,
+        y:,
+        font_padding:
+      )
+        creation_timestamp = time.to_i
+        text = "%{pts:localtime:#{creation_timestamp}:#{escape_text_expansion_argument(format)}}"
+        drawtext = "#{coord_map(coordinate_origin, x, y)}:" << %W[
+          font=#{escape_filter_description_value(font_family)}
+          fontsize=#{font_size}
+          fontcolor=#{font_color}
+          box=1
+          boxcolor=#{background_color}
+          boxborderw=#{font_padding}
+          text=#{escape_filter_description_value(text)}
+        ].join(':')
+
+        command = %W[
+          ffmpeg -y
+          -v warning
+          -i #{input_path}
+          -map_metadata 0
+          -vf drawtext=#{escape_filter_description(drawtext)}
+          #{output_path}
+        ]
+
+        tz =
+          case time.zone
+          when TZInfo::Timezone then time.zone.name
+          when String
+            begin
+              TZInfo::Timezone.get(time.zone).name
+            rescue TZInfo::InvalidTimezoneIdentifier
+              time.strftime('%::z').then do |string|
+                sign =
+                  case string[0]
+                  when '+' then '-'
+                  when '-' then '+'
+                  else raise "Cannot parse time zone: #{string}"
+                  end
+                "#{sign}#{string[1..]}"
+              end
+            end
+          else raise TypeError
+          end
+        system({ 'TZ' => tz }, *command, exception: true)
+      end
+
+      def creation_time(input_path)
+        command = %W[
+          ffprobe -v warning -print_format json
+          -show_entries format_tags=creation_time,com.apple.quicktime.creationdate
+          #{input_path}
+        ]
+        stdout_string, status = Open3.capture2(*command)
+        raise unless status.success?
+
+        parsed = JSON.parse(stdout_string)
+        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)
+      end
+
+      private
+
+      def coord_map(coordinate_origin, x, y)
+        case coordinate_origin
+        when 'top-left' then "x=#{x}:y=#{y}"
+        when 'top-right' then "x=w-tw-#{x}:y=#{y}"
+        when 'bottom-left' then "x=#{x}:y=h-th-#{y}"
+        when 'bottom-right' then "x=w-tw-#{x}:y=h-th-#{y}"
+        end
+      end
 
-    def self.creation_time(input_path)
-      command = %W[
-        ffprobe -v warning -print_format json -show_entries format_tags=creation_time #{Shellwords.escape(input_path)}
-      ]
-      stdout_string, status = Open3.capture2(*command)
-      raise unless status.success?
+      def escape_text_expansion_argument(string)
+        string.gsub(/[:{}]/, '\\\\\\&')
+      end
 
-      parsed = JSON.parse(stdout_string)
-      iso8601_string = parsed['format']['tags']['creation_time']
-      raise 'Cannot find creation time' if iso8601_string.nil?
+      def escape_filter_description_value(string)
+        string.gsub(/[:\\']/, '\\\\\\&')
+      end
 
-      Time.iso8601(iso8601_string)
+      def escape_filter_description(string)
+        string.gsub(/[\\'\[\],;]/, '\\\\\\&')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timestamp_maker
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Weihang Jian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: timestamp_maker is a command-line tool that adds timestamp to images
-  and videos.
+description: timestamp_maker is a command-line tool that adds timestamp on assets/videos
+  based on their creation time.
 email: tonytonyjan@gmail.com
 executables:
 - timestamp
@@ -88,6 +102,6 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: timestamp_maker is a command-line tool that adds timestamp to images and
-  videos.
+summary: timestamp_maker is a command-line tool that adds timestamp on assets/videos
+  based on their creation time.
 test_files: []