multimedia_paradise 1.1.344 → 1.2.2

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

@@ -0,0 +1,589 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::GUI::UniversalWidgets::MultimediaConverter
+#
+# This class contains a "multimedia_convert", aka just a thin wrapper over
+# ffmpeg.
+#
+# Features that it should have:
+#
+#   - convert between .mp3, .wav, .ogg and so forth.
+#   - allow conversions between .avi and .mpg and so forth.
+#   - scrolling should be possible in the entry area, so we can select
+#     different audio files.
+#
+# Usage example:
+#
+#   MultimediaParadise::GUI::UniversalWidgets::MultimediaConverter.new(ARGV)
+#
+# =========================================================================== #
+# require 'multimedia_paradise/gui/universal_widgets/multimedia_converter/multimedia_converter.rb'
+# =========================================================================== #
+require 'multimedia_paradise/base/base.rb'
+
+module MultimediaParadise
+
+module GUI
+
+module UniversalWidgets
+
+class MultimediaConverter < ::MultimediaParadise::Base # === MultimediaParadise::GUI::UniversalWidgets::MultimediaConverter
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'multimedia_paradise/gui/gui_base.rb'
+  include MultimediaParadise::GUI
+
+  # ========================================================================= #
+  # === ARRAY_FILTER_THESE_FILES
+  # ========================================================================= #
+  ARRAY_FILTER_THESE_FILES = %w(
+    *.ogg
+    *.mp3
+    *.wav
+    *.flac
+  )
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '95% or minimum 850px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '80% or minimum 500px'
+
+  # ========================================================================= #
+  # === MultimediaConverter.width?
+  # ========================================================================= #
+  def self.width?
+    WIDTH
+  end
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Multimedia Converter'
+
+  # ========================================================================= #
+  # === FONT_SIZE
+  # ========================================================================= #
+  FONT_SIZE = 18
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = "Liberation serif #{FONT_SIZE}"
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # You can pass an argument as optional file name, as the very first
+  # argument to this method (via an Array).
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    determine_the_GUI_to_be_used(commandline_arguments) # This must come first, even before reset().
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    set_selected_file(commandline_arguments.first)
+    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
+    # ======================================================================= #
+    # === @counter_position
+    # ======================================================================= #
+    @counter_position = 0
+    # ======================================================================= #
+    # === @save_file_to_this_directory
+    #
+    # The next variable keeps track into which directory we will save
+    # the converted files.
+    # ======================================================================= #
+    @save_file_to_this_directory = return_pwd
+    if is_on_roebe? and File.directory?('/home/Temp')
+      @save_file_to_this_directory = '/home/Temp/'
+    end
+  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
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === smallest_font?
+  # ========================================================================= #
+  def smallest_font?
+    SMALLEST_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 '
+
+'
+  end
+
+  # ========================================================================= #
+  # === update
+  #
+  # Update certain components of the widget. 
+  # ========================================================================= #
+  def update
+    @entry_save_where_to.set_text(@save_file_to_this_directory.to_s)
+  end
+
+  # ========================================================================= #
+  # === sync_selected_file_to_the_corresponding_entry
+  # ========================================================================= #
+  def sync_selected_file_to_the_corresponding_entry
+    @entry_base_file.set_text(@selected_file.to_s)
+  end
+
+  # ========================================================================= #
+  # === favicon?
+  # ========================================================================= #
+  def favicon?
+    '/home/x/programming/ruby/src/multimedia_paradise/lib/multimedia_paradise/images/'\
+    'MULTIMEDIA.jpg'
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    10
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === large_font_in_use?
+  #
+  # This is like the main font, but a bit larger.
+  # ========================================================================= #
+  def large_font_in_use?
+    LARGER_FONT
+  end
+
+  # ========================================================================= #
+  # === main_font?
+  # ========================================================================= #
+  def main_font?
+    USE_THIS_FONT
+  end; alias normal_font? main_font? # === normal_font?
+
+  # ========================================================================= #
+  # === slightly_smaller_font?
+  # ========================================================================= #
+  def slightly_smaller_font?
+    SLIGHTLY_SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === create_the_statusbar
+  # ========================================================================= #
+  def create_the_statusbar
+    @status_bar = create_statusbar { :with_resize_grip }
+    @status_bar_context_id = @status_bar.get_context_id('Conversion Information') 
+  end
+
+  # ========================================================================= #
+  # === get_rid_of_mp3
+  # ========================================================================= #
+  def get_rid_of_mp3
+    return @selected_file.gsub(/\.mp3/,'')
+  end
+
+  # ========================================================================= #
+  # === get_audio_file_listing
+  # ========================================================================= #
+  def get_audio_file_listing(
+      i = return_pwd
+    )
+    @array_audio_files = Dir["#{i}*"].select {|entry|
+      File.file?(entry)
+    }
+  end
+
+  # ========================================================================= #
+  # === create_combo_boxes
+  # ========================================================================= #
+  def create_combo_boxes
+    @combo_box_convert_to_this_audio_type = create_combo_box(true)
+    %w( wav mp3 ogg ).each {|val| 
+      @combo_box_convert_to_this_audio_type.append_text(val) 
+    }
+    @combo_box_convert_to_this_audio_type.active = 0
+  end
+
+  # ========================================================================= #
+  # === do_convert_multimedia_file
+  #
+  # This is the unified method to convert a multimedia file from
+  # one format to another one.
+  # ========================================================================= #
+  def do_convert_multimedia_file
+    if @selected_file.to_s.empty?
+      statusbar_message(
+        'Please input a valid (existing) file, on the top-left most entry.'
+      )
+      return
+    end
+    format_type = @combo_box_convert_to_this_audio_type.active_text
+    case format_type
+    # === mp3
+    when 'mp3'
+      application_to_use = 'lame --decode '
+    # === ogg
+    when 'ogg'
+      application_to_use = 'ffmpeg -i '
+    # === wav
+    when 'wav'
+      application_to_use = 'lame --decode '
+    else
+      application_to_use = '' # empty fall back...
+    end
+    e ::Colours.sfancy(
+      'Now converting '+@selected_file
+    )
+    cmd = application_to_use.dup
+    cmd << "#{@selected_file} "
+    cmd << @entry_save_where_to.text
+    cmd << get_rid_of_mp3_and_other_dirs+'.'
+    cmd << format_type
+    esystem(cmd)
+    # ======================================================================= #
+    # After the system-command has been run, we may modify the statusbar, to
+    # keep track of changes. This will only be done if the converted file
+    # actually exists.
+    # ======================================================================= #
+    converted_file = @entry_save_where_to.text+
+                     File.basename(@selected_file)
+    if File.exist?(converted_file)
+      add_statusbar_message(
+        "The file #{@selected_file} has been "\
+        "converted. New location should be: #{converted_file}"
+      )
+    end
+  end
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    e i
+    system_command(i)
+  end
+
+  # ========================================================================= #
+  # === system_command
+  #
+  # Wrapper to run a system-command
+  # ========================================================================= #
+  def system_command(cmd)
+    if cmd.include? ' '
+      # Find out if the program exists.
+      first_command = cmd.split(' ').first
+      result = `#{first_command} 2>&1`
+      if result.empty? # if empty we assume sox was not installed.
+        _ = 'The program `'+first_command+'` was not found. Is it installed?'
+        e _
+        add_to_statusbar(_)
+      else
+        system cmd
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === get_rid_of_mp3_and_other_dirs
+  #
+  # we get rid of .mp3 in our name, and any pathname.
+  # ========================================================================= #
+  def get_rid_of_mp3_and_other_dirs
+    tmp = get_rid_of_mp3
+    tmp = Pathname.new(tmp).basename.to_s
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons
+  # ========================================================================= #
+  def create_the_buttons
+    @button_quit = button('_Quit')
+    @button_convert = button('_Convert')
+    @button_convert.on_clicked { |widget|
+      do_convert_multimedia_file
+    }
+    @button_convert.hint =
+      ' <b>Click</b> this button in order to <b>convert the '\
+      'audio-file to another format</b>. '
+    @button_file_chooser = button('_Open File')
+    @button_file_chooser.on_clicked { |widget|
+      @file_chooser_dialog = ::Gtk::FileChooserDialog.new(
+        'Open MultimediaFile',
+        ::Gtk::Window.new,
+        ::Gtk::FileChooser::ACTION_OPEN,
+        nil,
+        [ ::Gtk::Stock::CANCEL, ::Gtk::Dialog::RESPONSE_CANCEL ],
+        [ ::Gtk::Stock::OPEN,   ::Gtk::Dialog::RESPONSE_ACCEPT ]
+      )
+      @file_chooser_dialog.current_folder = return_pwd
+      if ENV.has_key? 'MY_SONGS'
+        @file_chooser_dialog.add_shortcut_folder(ENV['MY_SONGS'])
+      end
+
+      @file_filter_audio_files = create_file_filter
+      @file_filter_audio_files.name = 'Audio Files'
+      ARRAY_FILTER_THESE_FILES.each { |entry|
+        @file_filter_audio_files.add_pattern(entry)
+      }
+            
+      @file_chooser_dialog.add_filter(@file_filter_audio_files)
+      if File.directory? @save_file_to_this_directory
+        _ = @save_file_to_this_directory
+        if is_on_roebe?
+          _ = '/Depot/j/'
+        end
+        @file_chooser_dialog.cd_to(_)
+      end
+
+      case @file_chooser_dialog.run
+      when ::Gtk::Dialog::RESPONSE_ACCEPT
+        @entry_base_file.set_text(@file_chooser_dialog.filename)
+        @selected_file = @file_chooser_dialog.filename
+        add_to_statusbar(@selected_file)
+      else
+        puts 'No file selected.'
+      end
+      @file_chooser_dialog.destroy
+    }
+  end
+
+  # ========================================================================= #
+  # === add_statusbar_message
+  #
+  # This method will add to the status-bar queue.
+  # ========================================================================= #
+  def add_statusbar_message(
+      this_msg = 'Start'
+    )
+    @status_bar.push(@status_bar_context_id, this_msg) # Add message
+  end; alias add_to_statusbar  add_statusbar_message # === add_to_statusbar
+       alias statusbar_message add_statusbar_message # === statusbar_message
+
+  # ========================================================================= #
+  # === set_selected_file
+  # ========================================================================= #
+  def set_selected_file(i)
+    if i.is_a? Array
+      i = i.first
+    end
+    @selected_file = i
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton                                    (skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_buttons
+    create_the_entries
+    create_combo_boxes
+    create_the_statusbar
+  end
+
+  # ========================================================================= #
+  # === create_the_entries
+  # ========================================================================= #
+  def create_the_entries
+    @entry_base_file = create_entry
+    @entry_base_file.signal_connect(:event) { |widget, event|
+      _ = event.event_type
+      case _.name
+      when 'GDK_BUTTON_PRESS'
+        @button_file_chooser.signal_emit(:clicked)
+      when 'GDK_SCROLL'
+        case event.direction
+        # === scroll-up event
+        when Gdk::EventScroll::UP
+          get_audio_file_listing
+          @counter_position += 1
+          pp @counter_position
+          pp @array_audio_files[@counter_position]
+        # === scroll-down event
+        when Gdk::EventScroll::DOWN
+          get_audio_file_listing
+          @counter_position -= 1
+          pp @counter_position
+          pp @array_audio_files[@counter_position]
+        end
+      else
+      end
+    }  
+    @entry_save_where_to = create_entry
+    update
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_vbox = create_vbox
+
+    label = modify_bold_label('Convert to the following format:','slateblue')
+    label.the_text_appears_on_the_left_side
+    hbox = create_hbox(
+             @entry_base_file, 
+             vbox(label, @combo_box_convert_to_this_audio_type)
+           )
+    outer_vbox.minimal(hbox)
+    hbox2 = create_hbox
+    hbox2.minimal(
+      modify_bold_label('Save file to this directory:'),
+      0
+    )
+    hbox2.maximal(
+      @entry_save_where_to, 0
+    )
+    outer_vbox.minimal(hbox2)
+    outer_vbox.add(@button_convert)
+    outer_vbox.add(
+      hbox(@button_file_chooser, @button_quit)
+    )
+    outer_vbox.minimal(
+      @status_bar, 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
+    window.set_size(width?, height?)
+    do_all_startup_related_actions
+    handle_CSS_rules if use_gtk3?
+    run_main
+  end
+
+  # ========================================================================= #
+  # === do_all_startup_related_actions
+  # ========================================================================= #
+  def do_all_startup_related_actions
+    sync_selected_file_to_the_corresponding_entry
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::MultimediaConverter.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::MultimediaParadise::GUI::Gtk::MultimediaConverter.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_simple_exit
+    r.set_background :white
+    boat_cursor = :boat
+    r.window.set_cursor(Gdk::Cursor.new(boat_cursor))
+    r.maximize
+    # ======================================================================= #
+    # Next we will add several alt+key shortcuts.
+    # ======================================================================= #
+    r.shortcuts {[
+      [1, 'click_on_button_number(0)', :alt],
+      [2, 'click_on_button_number(1)', :alt],
+      [3, 'click_on_button_number(2)', :alt],
+      [4, 'click_on_button_number(3)', :alt],
+      [5, 'click_on_button_number(4)', :alt],
+      [6, 'click_on_button_number(5)', :alt],
+      [7, 'click_on_button_number(6)', :alt],
+      [8, 'click_on_button_number(7)', :alt],
+      [9, 'click_on_button_number(8)', :alt]
+    ]}
+    r.top_left_then_run
+  end; self.instance_eval { alias start_gui_application run } # === MultimediaParadise::GUI::Gtk::MultimediaConverter.start_gui_application
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::MultimediaConverter[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise::GUI::UniversalWidgets::MultimediaConverter.new(ARGV)
+end # guishell