multimedia_paradise 1.1.344 → 1.2.2

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

@@ -0,0 +1,197 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::GUI::UniversalWidgets::Playlist
+#
+# Usage example:
+#
+#   MultimediaParadise::GUI::UniversalWidgets::Playlist.new(ARGV)
+#
+# =========================================================================== #
+# require 'multimedia_paradise/gui/universal_widgets/playlist/playlist.rb'
+# =========================================================================== #
+require 'multimedia_paradise/base/base.rb'
+
+module MultimediaParadise
+
+module GUI
+
+module UniversalWidgets
+
+class Playlist < ::MultimediaParadise::Base # === MultimediaParadise::GUI::UniversalWidgets::Playlist
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'multimedia_paradise/gui/shared_code/playlist/playlist_module.rb'
+  include ::MultimediaParadise::GUI::Gtk::PlaylistModule
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Playlist'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '100% or minimum 1820px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '88% or minimum 1540px'
+
+  # ========================================================================= #
+  # === 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, "#{FONT_FAMILY_TO_USE} #{FONT_SIZE}"
+    )
+    if use_gtk3?
+      handle_CSS_rules
+    end
+    infer_the_size_automatically
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules                                            (CSS tag)
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    more_CSS_then_apply_it '
+
+'
+  end
+  
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    0
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    "#{FONT_FAMILY_TO_USE} #{SMALLER_FONT_SIZE}"
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === do_all_startup_related_actions
+  # ========================================================================= #
+  def do_all_startup_related_actions
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_vbox = return_the_default_scrolled_window
+
+    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.set_size_request(width?, height?)
+    window.show_all
+    window.top_left
+    do_all_startup_related_actions
+    run_main
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::Playlist.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::MultimediaParadise::GUI::Gtk::Playlist.new(i)
+    r = ::Gtk.run
+    r << _
+    _.set_parent_widget(r) # Must come before we enable the key-combinations.
+    r.enable_context_menu_on_button_click_events
+    r.signal_connect(:delete_event) { |_widget| ::Gtk.main_quit }
+    _.maximize_button?.set_new_parent(r)
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    r.modify_background(:normal, :azure)
+    r.maximize
+    r.top_left_then_run
+  end; self.instance_eval { alias start_gui_application run } # === Roebe::GUI::Gtk::Playlist.start_gui_application
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::Playlist[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise::GUI::UniversalWidgets::Playlist.new(ARGV)
+end # gtklyrics

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

@@ -27,7 +27,7 @@ class Radio < ::MultimediaParadise::Base # === MultimediaParadise::GUI::Universa
   require 'gtk_paradise/widgets/gtk3/maximize_button/maximize_button.rb'
   require 'gtk_paradise/widgets/gtk3/mini_clock/mini_clock.rb'
   require 'multimedia_paradise/project/project.rb'
-  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/constants/constants.rb'
   require 'multimedia_paradise/version/version.rb'
   require 'multimedia_paradise/toplevel_methods/is_on_roebe.rb'
   require 'multimedia_paradise/toplevel_methods/radio.rb'

data/lib/multimedia_paradise/gui/{gtk2 → universal_widgets}/simple_play_widget/README.md

@@ -9,4 +9,4 @@ MultimediaParadise, and realizing that it may be simpler and
 better to just abstract the underlying play-functionality.
 
 Once that is done it can be re-used for both the internet-radio-specific
-parts, as well as for playing local audio/video files (through mpv).
+parts, as well as for playing local audio/video files (through mpv).

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

@@ -0,0 +1,404 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::GUI::UniversalWidgets::SimplePlayWidget
+#
+# Usage example:
+#
+#   MultimediaParadise::GUI::UniversalWidgets::SimplePlayWidget.new(ARGV)
+#
+# =========================================================================== #
+# require 'multimedia_paradise/gui/universal_widgets/simple_play_widget/simple_play_widget.rb'
+# =========================================================================== #
+require 'multimedia_paradise/base/base.rb'
+
+module MultimediaParadise
+
+module GUI
+
+module UniversalWidgets
+
+class SimplePlayWidget < ::MultimediaParadise::Base # === MultimediaParadise::GUI::UniversalWidgets::SimplePlayWidget
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'multimedia_paradise/constants/constants.rb'
+  require 'multimedia_paradise/toplevel_methods/is_audio_file_is_video_file_is_image_file_is_multimedia_file.rb'
+
+  require 'multimedia_paradise/gui/gui_base.rb'
+  include MultimediaParadise::GUI
+
+  begin
+    require 'multimedia_paradise/gui/gtk3/widget_increase_or_decrease_audio/widget_increase_or_decrease_audio.rb'
+  rescue LoadError; end
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Simple Play Widget'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '95% or minimum 850px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '80% or minimum 500px'
+
+  # ========================================================================= #
+  # === FONT_SIZE
+  # ========================================================================= #
+  FONT_SIZE = 18
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = "Liberation serif #{FONT_SIZE}"
+
+  # ========================================================================= #
+  # === LARGER_FONT
+  # ========================================================================= #
+  LARGER_FONT = "Liberation serif #{FONT_SIZE+6}"
+
+  # ========================================================================= #
+  # === SLIGHTLY_SMALLER_FONT
+  # ========================================================================= #
+  SLIGHTLY_SMALLER_FONT = "Liberation serif #{FONT_SIZE-2}"
+
+  # ========================================================================= #
+  # === SMALLEST_FONT
+  # ========================================================================= #
+  SMALLEST_FONT = "Liberation serif #{FONT_SIZE-4}"
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @array_buttons
+    # ======================================================================= #
+    @array_buttons = []
+    # ======================================================================= #
+    # === @array_threads
+    # ======================================================================= #
+    @array_threads = []
+    # ======================================================================= #
+    # === @array_pids
+    # ======================================================================= #
+    @array_pids = []
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = []
+    # ======================================================================= #
+    # === @font_size_to_use
+    # ======================================================================= #
+    @font_size_to_use = 20
+    # ======================================================================= #
+    # === @use_this_colour_for_the_tooltip
+    # ======================================================================= #
+    @use_this_colour_for_the_tooltip = :lightblue 
+  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
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    4
+  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
+
+  # ========================================================================= #
+  # === play_this_song_via_mpv
+  # ========================================================================= #
+  def play_this_song_via_mpv(this_song)
+    e
+    e "Next playing #{::Colours.steelblue(this_song)} via mpv."
+    e
+    @array_threads << Thread.new {
+      pid = Process.spawn("mpv #{this_song}")
+      @array_pids << pid
+    }
+  end
+
+  # ========================================================================= #
+  # === return_widget_increase_or_decrease_audio
+  # ========================================================================= #
+  def return_widget_increase_or_decrease_audio
+    ::MultimediaParadise.widget_increase_or_decrease_audio
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_vbox = create_vbox
+
+    # ======================================================================= #
+    # Add the vbox onto a scroll-window widget:
+    # ======================================================================= #
+    @scrolled_window = create_scrolled_window(@main_vbox) { :automatic_scrollbars }
+    @dataset.each_with_index {|entry, index| index += 1
+      padded_index = index.to_s.rjust(3, ' ')
+      name_of_the_song = File.basename(entry).
+                         sub(/#{File.extname(entry)}$/,'').
+                         tr('_',' ')
+      button1 = bold_button(
+        label: name_of_the_song
+      )
+      # ===================================================================== #
+      # add a tooltip next. This will have bold markup, in colour.
+      # ===================================================================== #
+      button1.tooltip_markup = ""\
+        "<span weight=\"bold\">#{padded_index}</span> "\
+        "#{name_of_the_song} 🎵️\n  → "\
+        "<span weight=\"bold\" foreground=\"#{@use_this_colour_for_the_tooltip}\">#{entry}</span>"
+      button1.lightgreen
+      # ===================================================================== #
+      # Next, add code so that the button for the radio-station can
+      # play the audio stream.
+      # ===================================================================== #
+      button1.on_clicked {
+        do_perform_the_default_actions(button, index)
+      }
+      @array_buttons << button1
+
+      index_button = create_button(padded_index)
+      index_button.make_bold
+      index_button.on_clicked {
+        do_perform_the_default_actions(button, index)
+      }
+      index_button.limegreen
+      @array_buttons << index_button
+      mini_hbox = create_hbox
+      mini_hbox.minimal(index_button)
+      mini_hbox.maximal(button)
+      @main_vbox.minimal(mini_hbox, 1)
+    }
+    hbox_center_aligned = hbox
+    hbox_center_aligned.set_border_width(1)
+    hbox_center_aligned.maximal(
+      return_widget_increase_or_decrease_audio
+    )
+    center_aligned_box = create_alignment(0.5, 0.5, 0.5, 0.5)
+    center_aligned_box.add(hbox_center_aligned)
+    _ = draggable_hpane(
+      @scrolled_window,
+      center_aligned_box
+    )
+    n_percent_to_use = 50.0
+    use_this_vertical_position = ( (height?.to_i * n_percent_to_use) / 100.0 ).to_i
+    _.position = use_this_vertical_position
+    outer_vbox.maximal(_, 0)
+
+    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
+    populate_the_dataset_with_this_array
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton
+  # ========================================================================= #
+  def create_the_skeleton
+    @main_vbox = create_vbox
+  end
+
+  # ========================================================================= #
+  # === do_perform_the_default_actions
+  # ========================================================================= #
+  def do_perform_the_default_actions(button, index = 0)
+    this_song = @dataset[index - 1]
+    play_this_song_via_mpv(this_song)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::SimplePlayWidget.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::MultimediaParadise::GUI::Gtk::SimplePlayWidget.new(i)
+    r = ::Gtk.run
+    _.set_parent_widget(r) # Must come before we enable the key-combinations.
+    r << _
+    r.automatic_size_then_automatic_title
+    # ======================================================================= #
+    # 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.enable_simple_exit
+    r.set_background :white
+    r.maximize
+    r.top_left_then_run
+  end; self.instance_eval { alias start_gui_application run } # === MultimediaParadise::GUI::Gtk::SimplePlayWidget.start_gui_application
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::UniversalWidgets::SimplePlayWidget[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === MultimediaParadise.simple_play_widget
+#
+# This method can be used if you simply want to return the widget, to
+# then embed it into another ruby-gtk application.
+# =========================================================================== #
+def self.simple_play_widget
+  ::MultimediaParadise::GUI::Gtk::SimplePlayWidget.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise::GUI::UniversalWidgets::SimplePlayWidget.new(ARGV)
+end # guishell

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

@@ -44,16 +44,13 @@ class TagMp3Files < ::MultimediaParadise::Base # === MultimediaParadise::GUI::Un
   require 'universal_widgets/base_module/base_module.rb'
   include ::UniversalWidgets::BaseModule
 
-  require 'multimedia_paradise/constants/file_constants.rb'
-  require 'multimedia_paradise/constants/directory_constants.rb'
-  require 'multimedia_paradise/constants/encodings.rb'
-  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/constants/constants.rb'
   require 'multimedia_paradise/audio/audio_tag_reader/audio_tag_reader.rb'
   require 'multimedia_paradise/audio/file_duration/file_duration.rb'
   require 'multimedia_paradise/gui/shared_code/information_about_a_mp3_file/information_about_a_mp3_file_module.rb'
   require 'multimedia_paradise/gui/gtk3/information_about_a_mp3_file/information_about_a_mp3_file.rb'
-  require 'multimedia_paradise/toplevel_methods/is_audio_file.rb'
-  require 'multimedia_paradise/toplevel_methods/misc.rb'
+  require 'multimedia_paradise/toplevel_methods/is_audio_file_is_video_file_is_image_file_is_multimedia_file.rb'
+  require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
   include MultimediaParadise::GUI::InformationAboutAMp3FileModule