multimedia_paradise 1.1.344

data/lib/multimedia_paradise/gui/universal_widgets/change_metadata_widget/change_metadata_widget.rb

@@ -0,0 +1,751 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::GUI::UniversalWidgets::ChangeMetadataWidget
+#
+# This widget can be used to change the metadata of video files, such
+# as .mp4 files specifically.
+#
+# For .mp4 files ffmpeg uses the following metadata tags:
+#
+#   - title
+#   - author
+#   - album_artist
+#   - album
+#   - comment
+#   - composer
+#   - copyright
+#   - description
+#   - episode_id
+#   - genre
+#   - grouping
+#   - lyrics
+#   - network
+#   - show
+#   - synopsis
+#   - track
+#   - year
+
+#
+# Usage example:
+#
+#   MultimediaParadise::GUI::UniversalWidgets::ChangeMetadataWidget.new(ARGV)
+#
+# =========================================================================== #
+# require 'multimedia_paradise/gui/universal_widgets/change_metadata_widget/change_metadata_widget.rb'
+# =========================================================================== #
+require 'multimedia_paradise/base/base.rb'
+
+module MultimediaParadise
+
+module GUI
+
+module UniversalWidgets
+
+class ChangeMetadataWidget < ::MultimediaParadise::Base # === MultimediaParadise::GUI::UniversalWidgets::ChangeMetadataWidget
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'multimedia_paradise/constants/video_filetypes.rb'
+  require 'multimedia_paradise/toplevel_methods/output_directory.rb'
+
+  # ========================================================================= #
+  # === ARRAY_SUPPORTED_VIDEO_FILES
+  #
+  # List all supported video files here in this array.
+  # ========================================================================= #
+  ARRAY_SUPPORTED_VIDEO_FILES = ::MultimediaParadise::ARRAY_VIDEO_FILETYPES
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Change Metadata'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '75% or minimum 1300px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '15% or minimum 250px'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :hack_23
+
+  # ========================================================================= #
+  # === LARGER_FONT
+  # ========================================================================= #
+  LARGER_FONT   = :hack_25
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT  = :hack_20
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    determine_the_GUI_to_be_used(commandline_arguments) # This must come first, even before reset().
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    on_delete_event_quit_the_application
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    reset_the_shared_module # This can come early.
+    reset_the_base_module
+    reset_the_internal_variables
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    infer_the_size_automatically
+    # ======================================================================= #
+    # === @additional_CSS_rules
+    # ======================================================================= #
+    @additional_CSS_rules = ''.dup
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules                                            (CSS tag)
+  #
+  # This is currently only in use if gtk3 is in use.
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    more_CSS_then_apply_it '
+
+'+@additional_CSS_rules
+  end
+
+  # ========================================================================= #
+  # === reset_the_shared_module
+  #
+  # This method can be used for ruby-gtk3 and ruby-libui, among other
+  # toolkits.
+  # ========================================================================= #
+  def reset_the_shared_module
+  end
+
+  # ========================================================================= #
+  # === default_output_file?
+  # ========================================================================= #
+  def default_output_file?
+    @entry_output_file.text?
+  end
+
+  # ========================================================================= #
+  # === set_output_file_to_use
+  # ========================================================================= #
+  def set_output_file_to_use(i)
+    @entry_output_file.set_text(i.to_s)
+  end
+
+  # ========================================================================= #
+  # === read_the_title_and_then_assign_it
+  # ========================================================================= #
+  def read_the_title_and_then_assign_it
+    _ = file?
+    result_from_exiftool = `exiftool #{_}`
+    if result_from_exiftool.include? 'Title'
+      begin
+        splitted = result_from_exiftool.split("\n")
+        current_title = splitted.select {|entry|
+          entry.include? 'Title'
+        }.flatten.first.sub(/Title/,'').strip.delete(':').strip
+        entry_title?.set_text(current_title)
+      rescue ArgumentError => error
+        pp error
+      end 
+    end
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      if i and File.exist?(i)
+        do_analyse_this_file(i)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === do_rename_the_newly_created_file_to_the_original_file
+  # ========================================================================= #
+  def do_rename_the_newly_created_file_to_the_original_file
+    newly_created_file = @entry_output_file.text?
+    original_file      = @entry_input_file.text?
+    unless is_still_spinning?
+      if File.exist? newly_created_file
+        FileUtils.mv(newly_created_file, original_file)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === is_still_spinning?
+  # ========================================================================= #
+  def is_still_spinning?
+    @spinner.is_still_spinning?
+  end
+
+  # ========================================================================= #
+  # === log_dir?
+  # ========================================================================= #
+  def log_dir?
+    MultimediaParadise.log_dir?
+  end
+
+  # ========================================================================= #
+  # === log_this_file_has_been_modified                             (log tag)
+  #
+  # This method will log which file has been modified. Knowing this
+  # information is helpful when we want to copy only those video
+  # files that were modified.
+  #
+  # What information must we save?
+  #
+  # The file name, as well as the time when the file was modified.
+  # ========================================================================= #
+  def log_this_file_has_been_modified(this_file)
+    what = this_file.dup
+    what << ' # '+dd_mm_yyyy?+' '+hh_mm_ss?
+    into = log_dir?+'metadata_of_video_files_that_were_modified.md'
+    if File.exist? into
+      what.prepend(File.read(into))
+    end
+    if is_on_roebe?
+      e "Storing log-information into the file "\
+        "at `#{sfile(into)}`."
+    end
+    write_what_into("#{what}\n", into)
+  end
+
+  # ========================================================================= #
+  # === read_the_comment_and_then_assign_it
+  # ========================================================================= #
+  def read_the_comment_and_then_assign_it
+    _ = file?
+    result_from_exiftool = `exiftool #{_}`
+    begin
+      if result_from_exiftool.include? 'Comment'
+        current_comment = result_from_exiftool.split("\n").select {|entry|
+          entry.include? 'Comment'
+        }.flatten.first.sub(/Comment/,'').strip.delete(':').strip
+        @entry_comment.set_text(current_comment)
+      end
+    rescue ArgumentError => error
+      pp error
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_spinner
+  # ========================================================================= #
+  def create_the_spinner
+    if use_gtk3?
+      @spinner = return_spinner_widget # Create the spinner before the buttons.
+    end
+  end
+
+  # ========================================================================= #
+  # === input_file_name?
+  # ========================================================================= #
+  def input_file_name?
+    @entry_input_file.text?
+  end; alias work_on_which_file? input_file_name? # === work_on_which_file?
+       alias file?               input_file_name? # === file?
+
+  # ========================================================================= #
+  # === create_the_header                                        (header tag)
+  # ========================================================================= #
+  def create_the_header
+    # ======================================================================= #
+    # === @header
+    # ======================================================================= #
+    @header = default_header
+    @header.set_title('Change Metadata')
+    button_open_file = button('Open file')
+    button_open_file.on_clicked {
+      do_open_a_local_file
+    }
+    @header.add_right(button_open_file)
+    icon = gtk_icon('media-playback-start')
+    button_play_the_video = event_box(icon)
+    button_play_the_video.hint = 'Play the video file listed under '\
+      '"Input file to use:".'
+    button_play_the_video.on_clicked {
+      Thread.new {
+        esystem "mpv #{work_on_which_file?}"
+      }
+    }
+    @header.add_left(button_play_the_video)
+  end
+
+  # ========================================================================= #
+  # === return_text1
+  # ========================================================================= #
+  def return_text1
+    text('Input file to use:')
+  end
+
+  # ========================================================================= #
+  # === return_text2
+  # ========================================================================= #
+  def return_text2
+    text('Output file to use:')
+  end
+
+  # ========================================================================= #
+  # === return_text3
+  # ========================================================================= #
+  def return_text3
+    text('Title to use:')
+  end
+
+  # ========================================================================= #
+  # === return_text4
+  # ========================================================================= #
+  def return_text4
+    text('Comment:')
+  end
+
+  # ========================================================================= #
+  # === return_text5
+  # ========================================================================= #
+  def return_text5
+    text('Year:')
+  end
+
+  # ========================================================================= #
+  # === entry2?
+  # ========================================================================= #
+  def entry2?
+    @entry_output_file
+  end
+
+  # ========================================================================= #
+  # === entry_comment?
+  # ========================================================================= #
+  def entry_comment?
+    @entry_comment
+  end
+
+  # ========================================================================= #
+  # === entry_year?
+  # ========================================================================= #
+  def entry_year?
+    @entry_year
+  end; alias entry5? entry_year? # === entry5?
+
+  # ========================================================================= #
+  # === entry_title?
+  # ========================================================================= #
+  def entry_title?
+    @entry_title
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === @button_run_the_sys_command
+    # ======================================================================= #
+    @button_run_the_sys_command = button('_Run')
+    @button_run_the_sys_command.remove_background
+    @button_run_the_sys_command.hint = 'This will run the sys-command.'
+    @button_run_the_sys_command.on_hover(:lightblue)
+    @additional_CSS_rules << @button_run_the_sys_command.rounded_border(
+      '12px',
+      :default,
+      '5px solid royalblue'
+    )
+    @button_run_the_sys_command.css_class('border12')
+
+    @button_run_the_sys_command.on_clicked {
+      work_on_this_file = work_on_which_file?
+      unless File.exist? work_on_this_file
+        popup_this_text_over_that_widget(
+          "The target file at \n\n"\
+          "  <b>#{File.absolute_path(work_on_this_file)}</b>\n"\
+          "\ndoes not exist.",
+          entry_input?
+        )
+      else # else the file exists, so we can continue here.
+        @spinner.start_to_spin if gtk3?
+        @button_run_the_sys_command.is_insensitive
+        # =================================================================== #
+        # The built-up command shall be similar to this:
+        #
+        #   ffmpeg -i foobar.mp4 -metadata title=foobar -codec copy output.mp4
+        #
+        # =================================================================== #
+        cmd_to_run = 'ffmpeg '.dup
+        cmd_to_run << ' -i '+work_on_this_file
+        cmd_to_run << ' -metadata '
+        cmd_to_run << ' title="'+entry_title?.text?+'"'
+        # =================================================================== #
+        # Next add comments
+        # =================================================================== #
+        unless @entry_comment.text?.empty?
+          cmd_to_run << ' -metadata '
+          cmd_to_run << ' comment='+@entry_comment.text?
+        end
+        # =================================================================== #
+        # Next add the year
+        # =================================================================== #
+        unless @entry_year.text?.empty?
+          cmd_to_run << ' -metadata '
+          cmd_to_run << ' year='+@entry_year.text?
+        end
+        cmd_to_run << ' -codec copy'
+        cmd_to_run << ' -y' # To overwrite any existing files at once.
+        cmd_to_run << " #{default_output_file?}"
+        cmd_to_run.squeeze!(' ')
+        Thread.new {
+          esystem(cmd_to_run)
+          @spinner.stop_spinning if gtk3?
+          @button_run_the_sys_command.is_sensitive
+          log_this_file_has_been_modified(work_on_this_file)
+        }
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === entry_input?
+  # ========================================================================= #
+  def entry_input?
+    @entry_input_file
+  end
+
+  # ========================================================================= #
+  # === create_the_grid                                            (grid tag)
+  # ========================================================================= #
+  def create_the_grid
+    # ======================================================================= #
+    # === @grid
+    # ======================================================================= #
+    @grid = default_grid
+  end
+
+  # ========================================================================= #
+  # === return_spinner_widget
+  # ========================================================================= #
+  def return_spinner_widget
+    return new_spinner
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    4
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === do_all_startup_related_actions
+  # ========================================================================= #
+  def do_all_startup_related_actions
+    respond_to_scroll_events_of_the_first_entry
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_vbox = create_vbox
+
+    outer_vbox.minimal(@header)
+    @grid.left_right(return_text1, @entry_input_file)
+    @grid.new_line
+    small_hbox = create_hbox
+    small_hbox.maximal(@entry_output_file)
+    event_box = create_event_box(create_icon('view-refresh'))
+    event_box.hint =
+      "Click on this image to automatically rename the video file to "\
+      "the original name seen above.\n\n"\
+      "This currently does not notify the user that the rename-action "\
+      "has been applied, but it should work just fine nonetheless."
+    event_box.on_clicked {
+      do_rename_the_newly_created_file_to_the_original_file
+    }
+    small_hbox.minimal(event_box)
+    @grid.left_right(return_text2, small_hbox) # Output file to use.
+    @grid.new_line
+    @grid.left_right(return_text3, entry_title?)
+    @grid.new_line
+    @grid.left_right(return_text4, entry_comment?)
+    @grid.new_line
+    @grid.left_right(return_text5, entry_year?)
+    hbox_small = create_hbox
+    hbox_small.minimal(@button_run_the_sys_command, 4)
+    hbox_small.minimal(@spinner,                    4)
+    hbox_small.center_into_the_middle
+    @grid.full_row(hbox_small)
+
+    outer_vbox.minimal(@grid, 2)
+
+    window = create_window_or_runner(nil, width?, height?, title?)
+    window << outer_vbox
+
+    properly_prepare_this_window(window,
+      {
+        title:       title?,
+        font:        font?,
+        width:       width?,
+        height:      height?,
+        padding:     padding?,
+        border_size: border_size?
+      }
+    )
+    window.show_all
+    window.top_left
+    do_all_startup_related_actions
+    menu
+    handle_CSS_rules if use_gtk3?
+    run_main
+  end
+
+  # ========================================================================= #
+  # === do_open_a_local_file                                       (open tag)
+  # ========================================================================= #
+  def do_open_a_local_file
+    new_open_file_dialog {{
+      name_for_the_file_chooser_dialog: :custom_dialog,
+      use_this_as_the_current_folder:   return_pwd,
+      filter_for:                       ARRAY_SUPPORTED_VIDEO_FILES,
+      additional_folders:
+        %w(
+          /Depot/j/
+          /home/x/video/Realvids/
+        )
+    }}
+    _ = main_file?
+    if _ and File.exist?(_)
+      # ===================================================================== #
+      # First, clear the old entries that contain meta-data.
+      # ===================================================================== #
+      clear_the_old_entries
+      # ===================================================================== #
+      # Next proceed by analysing the file.
+      # ===================================================================== #
+      do_analyse_this_file(_)
+      sync_the_output_directory_based_on_this_file(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_entries                           (entries tag, entry tag)
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # === @entry_input_file
+    # ======================================================================= #
+    @entry_input_file = entry('foobar.mp4')
+    @entry_input_file.width_height(600, 30)
+    @entry_input_file.very_light_yellowish_background
+    @entry_input_file.use_this_font = SMALLER_FONT
+    @entry_input_file.enable_scroll_events
+    # ======================================================================= #
+    # === @entry_output_file
+    # ======================================================================= #
+    @entry_output_file = entry(File.absolute_path('output.mp4'))
+    @entry_output_file.width_height(600, 30)
+    @entry_output_file.very_light_yellowish_background
+    @entry_output_file.use_this_font = SMALLER_FONT
+    # ======================================================================= #
+    # === @entry_title
+    # ======================================================================= #
+    @entry_title = entry
+    @entry_title.width_height(600, 30)
+    @entry_title.very_light_yellowish_background
+    @entry_title.use_this_font = SMALLER_FONT
+    # ======================================================================= #
+    # === @entry_comment
+    # ======================================================================= #
+    @entry_comment = entry
+    @entry_comment.width_height(600, 30)
+    @entry_comment.very_light_yellowish_background
+    @entry_comment.use_this_font = SMALLER_FONT
+    # ======================================================================= #
+    # === @entry_year
+    # ======================================================================= #
+    @entry_year = entry
+    @entry_year.width_height(600, 30)
+    @entry_year.very_light_yellowish_background
+    @entry_year.use_this_font = SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === do_analyse_this_file                                       (open tag)
+  # ========================================================================= #
+  def do_analyse_this_file(i)
+    @entry_input_file.set_text(i)
+    read_the_title_and_then_assign_it
+    read_the_comment_and_then_assign_it
+    if is_on_roebe?
+      old_value = @entry_output_file.text?.dup
+      original_filename = File.basename(i).delete_suffix(File.extname(i))
+      old_value.delete_suffix!(File.extname(old_value))
+      old_value.sub!(/output/, '')
+      old_value << "#{original_filename}_output#{File.extname(i)}"
+      @entry_output_file.set_text(old_value)
+      # ===================================================================== #
+      # We may also infer the title if the entry is empty.
+      # ===================================================================== #
+      if entry_title? and entry_title?.empty?
+        new_name = File.basename(input_file_name?).delete_suffix(
+          File.extname(i)
+        )
+        if new_name.include?('_') and (new_name =~ /^\d+/)
+          splitted = new_name.split('_')
+          new_name = splitted[1 .. -1].join('_')
+        end
+        new_name.tr!('_',' ')
+        entry_title?.set_text(new_name)
+      end
+    end
+  end; alias do_open_this_file     do_analyse_this_file # === do_open_this_file
+       alias work_on_this_file_now do_analyse_this_file # === work_on_this_file_now
+
+  # ========================================================================= #
+  # === clear_the_old_entries
+  # ========================================================================= #
+  def clear_the_old_entries
+    @entry_comment.set_text('')
+    @entry_year.set_text('')
+    @entry_title.set_text('')
+  end
+
+  # ========================================================================= #
+  # === sync_the_output_directory_based_on_this_file
+  # ========================================================================= #
+  def sync_the_output_directory_based_on_this_file(_)
+    # ======================================================================= #
+    # Sync the output directory too:
+    # ======================================================================= #
+    base_dir = File.dirname(_)
+
+    new_filename = File.basename(_).dup
+    new_filename.delete_suffix!(File.extname(new_filename))
+    new_filename.sub!(/output/, '')
+    new_filename = "#{new_filename}_output#{File.extname(_)}" # This will be like "004_Cube_output.avi"
+
+    set_output_file_to_use("#{base_dir}/#{new_filename}")
+  end
+
+  # ========================================================================= #
+  # === respond_to_scroll_events_of_the_first_entry
+  # ========================================================================= #
+  def respond_to_scroll_events_of_the_first_entry
+    @entry_input_file.on_scroll_event {|widget, event|
+      # ===================================================================== #
+      # If the user scrolls then a new random file will be selected.
+      # ===================================================================== #
+      base_dir = File.dirname(
+        File.absolute_path(@entry_input_file.text?)
+      )+'/'
+      this_new_file = Dir["#{base_dir}*"].select {|entry|
+        ARRAY_SUPPORTED_VIDEO_FILES.include?(File.extname(entry).delete('.'))
+      }.sample
+      clear_the_old_entries
+      work_on_this_file_now(this_new_file)
+      sync_the_output_directory_based_on_this_file(this_new_file)
+    }
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_buttons
+    create_the_entries
+    create_the_spinner
+    create_the_header
+    create_the_grid
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::ChangeMetadataWidget.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::MultimediaParadise::GUI::Gtk::ChangeMetadataWidget.new(i)
+    r = ::Gtk.run
+    _.set_parent_widget(r) # Must come before we enable the key-combinations.
+    r << _
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    r.set_background :white
+    r.maximize
+    r.top_left_then_run
+  end; self.instance_eval { alias start_gui_application run } # === Roebe::GUI::Gtk::ChangeMetadataWidget.start_gui_application
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::ChangeMetadataWidget[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise::GUI::UniversalWidgets::ChangeMetadataWidget.new(ARGV)
+end # guishell