multimedia_paradise 1.1.314

data/lib/multimedia_paradise/gui/gtk3/radio/misc.rb

@@ -0,0 +1,487 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/gui/gtk3/radio/misc.rb'
+# =========================================================================== #
+require 'gtk_paradise/require_gtk3'
+
+module MultimediaParadise
+
+module GUI
+
+module Gtk
+
+class Radio < ::Gtk::Box # === MultimediaParadise::GUI::Gtk::Radio
+
+  # ========================================================================= #
+  # === do_kill_the_mpv_process
+  #
+  # This method will simply kill the passed PID - use with care.
+  # ========================================================================= #
+  def do_kill_the_mpv_process(
+      use_this_pid = @pid
+    )
+    if use_this_pid
+      if is_on_roebe?
+        e "Now killing the pid: #{::Colours.steelblue(use_this_pid.to_s)}\n\n"
+      end
+      begin
+        case use_this_pid
+        when Process.pid # Protect against self-killing here.
+          e 'Can not kill the PID of this process.'
+        else
+          Process.kill('HUP', use_this_pid)
+        end
+      rescue Exception => error
+        if is_on_roebe?
+          e 'An error happened in Process.kill() '\
+            'at line '+__LINE__.to_s+', in the method '+__method__.to_s
+        end
+        pp error
+      end
+    end
+  end; alias do_stop_playing_the_current_song do_kill_the_mpv_process # === do_stop_playing_the_current_song
+       alias kill_this_process                do_kill_the_mpv_process # === kill_this_process
+       alias kill_this_pid                    do_kill_the_mpv_process # === kill_this_pid
+
+  # ========================================================================= #
+  # === do_all_the_actions_associated_when_the_button_stop_playback_was_clicked
+  #
+  # This method bundles together the actions that are associated with
+  # the user clicking on the "stop playback" button.
+  # ========================================================================= #
+  def do_all_the_actions_associated_when_the_button_stop_playback_was_clicked
+    do_stop_playing_the_current_song
+    @button_stop_playback.grey_out # Reset it again.
+    @label_displaying_the_radio_station.set_text ''
+    set_status_bar_message(:clear)
+  end
+
+  # ========================================================================= #
+  # === set_url_to_use
+  # ========================================================================= #
+  def set_url_to_use(url)
+    @entry_stream.set_text(url.to_s)
+  end
+
+  # ========================================================================= #
+  # === save_the_stream_into_which_file?
+  # ========================================================================= #
+  def save_the_stream_into_which_file?
+    @entry_save_into_this_file.text?
+  end
+
+  # ========================================================================= #
+  # === radio_stations?
+  # ========================================================================= #
+  def radio_stations?
+    MultimediaParadise.radio_stations?
+  end
+
+  # ========================================================================= #
+  # === do_grey_out_all_buttons_except_for_the_stop_playback_button
+  #
+  # This method used to be called when a new button has been clicked
+  # for playing a radio-stream. It was disabled as of May 2022,
+  # though, as it is better to NOT grey out the buttons.
+  # ========================================================================= #
+  def do_grey_out_all_buttons_except_for_the_stop_playback_button
+    these_buttons_are_to_be_greyed_out = 
+      return_all_buttons_except_for_the_stop_playback_button
+    these_buttons_are_to_be_greyed_out.each {|button|
+      button.grey_out
+    }
+  end; alias disable_all_main_buttons do_grey_out_all_buttons_except_for_the_stop_playback_button # === disable_all_main_buttons
+
+  # ========================================================================= #
+  # === set_status_bar_message
+  # ========================================================================= #
+  def set_status_bar_message(i = '')
+    case i
+    when :clear
+      i = ''
+    end
+    @entry_status_bar.set_text(i)
+  end
+
+  # ========================================================================= #
+  # === make_the_stop_playback_button_clickable_again
+  # ========================================================================= #
+  def make_the_stop_playback_button_clickable_again
+    @button_stop_playback.grey_in
+  end
+
+  # ========================================================================= #
+  # === click_on_button_number
+  #
+  # This method can be used to click on any button programmatically.
+  # ========================================================================= #
+  def click_on_button_number(
+      number = 0
+    )
+    # ======================================================================= #
+    # We modify the given number. This is necessary because we first add
+    # an index-button to the playlist, hence the *2 modifier below.
+    # ======================================================================= #
+    number = number.to_i
+    _ = return_all_buttons_except_for_the_stop_playback_button
+    _[number].signal_emit(:clicked)
+  end; alias click_on_this_button_by_number click_on_button_number # === click_on_this_button_by_number
+
+
+  # ========================================================================= #
+  # === do_show_all_URLs
+  # ========================================================================= #
+  def do_show_all_URLs(
+      radio_stations = radio_stations?
+    )
+    # ======================================================================= #
+    # First, create a widget.
+    # ======================================================================= #
+    vbox = gtk_vbox
+    vbox.set_border_width(20)
+    # ======================================================================= #
+    # Second, show them on the commandline.
+    # ======================================================================= #
+    radio_stations.values.map {|hash| hash['url'] }.each {|remote_URL|
+      e remote_URL
+      text = left_aligned_text(
+        '<a href="remote_URL">'+remote_URL+'</a>'
+      )
+      text.do_markify
+      vbox.minimal(
+        text, 2
+      )
+    }
+    scrolled_window = scrolled_window(vbox) { :always }
+    scrolled_window.set_border_width(20)
+    scrolled_window.width_height(800, 900)
+    scrolled_window.bblack2
+    return_popover(
+      'Remote URLs.',
+      @menu_bar,
+      5,
+      scrolled_window
+    ).popup
+  end
+
+  # ========================================================================= #
+  # === change_directory_on_roebe_systems_unless_in_depot_subdirectory
+  #
+  # This is mostly a "safeguard" on my home system, so I don't spam
+  # random .mp3 files all over the filesystem.
+  # ========================================================================= #
+  def change_directory_on_roebe_systems_unless_in_depot_subdirectory(
+      use_this_directory = '/Depot/j/'
+    )
+    if is_on_roebe? and !return_pwd.include?('/Depot/')
+      Dir.chdir(use_this_directory) if File.directory? use_this_directory
+    end
+  end
+
+  # ========================================================================= #
+  # === button_stop_playback?
+  # ========================================================================= #
+  def button_stop_playback?
+    @button_stop_playback
+  end
+
+  # ========================================================================= #
+  # === handle_CSS                                                  (css tag)
+  # ========================================================================= #
+  def handle_CSS
+    use_gtk_paradise_project_css_file
+    more_CSS_then_apply_it '
+
+button {
+  background-image: none;
+  color: blue;
+  background-color: yellow;
+}
+
+button:hover {
+  transition: 1000ms linear;
+  background-color: darkblue;
+}
+
+'
+  end
+
+  # ========================================================================= #
+  # === create_the_stop_playback_button                            (stop tag)
+  #
+  # The "stop playback" button is situated closer towards the bottom of
+  # the main widget, right above the two buttons that can be used to
+  # modify the audio volume on a linux system.
+  # ========================================================================= #
+  def create_the_stop_playback_button
+    # ======================================================================= #
+    # Create the "stop playback" button next.
+    # ======================================================================= #
+    @button_stop_playback = bold_button('Stop playback')
+    @button_stop_playback.bblack2
+    @button_stop_playback.grey_out
+    @button_stop_playback.background_colour = :lightblue
+    @button_stop_playback.paleturquoise
+    # ======================================================================= #
+    # Add a tooltip next.
+    # ======================================================================= #
+    @button_stop_playback.hint =
+      "Click this button to stop the current song that is "\
+      "played (if a song is currently playing that is).\n\n"\
+      "If no radio-station is used then the button is "\
+      "not functional yet.\n\n"\
+      "Otherwise, clicking on the button will also re-enable "\
+      "clicking on the actionable play-from-a-stream buttons."
+    @button_stop_playback.on_clicked {
+      do_all_the_actions_associated_when_the_button_stop_playback_was_clicked
+    }
+  end
+
+  # ========================================================================= #
+  # === set_parent
+  # ========================================================================= #
+  def set_parent(i)
+    if i.is_a? Array
+      i = first
+    end
+    @parent = i
+  end
+
+  # ========================================================================= #
+  # === create_the_top_bar
+  # ========================================================================= #
+  def create_the_top_bar
+    @hbox_on_top = gtk_hbox
+    @hbox_on_top.maximal(@menu_bar)
+    @maximize_button = ::Gtk::MaximizeButton.new(main_window?)
+    @maximize_button.can_focus = false
+    @maximize_button.no_relief
+    @hbox_on_top.minimal(
+      @maximize_button, 2
+    )
+    the_quit_button = image_application_exit
+    the_quit_button.hint = 'This button will exit the application.'
+    the_quit_button.can_focus = false
+    event_box_for_the_quit_button = gtk_event_box(the_quit_button)
+    event_box_for_the_quit_button.on_clicked {
+      exit_the_application
+    }
+    @hbox_on_top.minimal(
+      event_box_for_the_quit_button, 2
+    )
+    # ======================================================================= #
+    # Add the small clock on the top-right:
+    # ======================================================================= #
+    mini_clock = ::Gtk::MiniClock.widget { :make_bold }
+    @hbox_on_top.minimal(
+      mini_clock
+    )
+  end
+
+  # ========================================================================= #
+  # === open_this_url_via_the_browser
+  # ========================================================================= #
+  def open_this_url_via_the_browser(url)
+    unless Object.const_defined? :Open
+      begin
+        require 'open'
+      rescue LoadError; end
+    end
+    e ::Colours.steelblue(url)
+    Open.in_browser(url)
+  end
+
+  # ========================================================================= #
+  # === do_show_more_info_about_this_widget
+  # ========================================================================= #
+  def do_show_more_info_about_this_widget
+    about_dialog = gtk_about_dialog
+    author = ['Robert A. Heiler']
+    about_dialog.artists = author
+    about_dialog.authors = author
+    about_dialog.comments =
+      "\nThis widget can be used to listen to radio streams. \n\n"\
+      "The mpv player will be used for this functionality. The "\
+      "radio stations are kept in the .yml file, at "\
+      "radio_stations.yml."
+    about_dialog.copyright = 'Copyright (C) 2021+ Robert A. Heiler'
+    about_dialog.documenters = ['Robert A. Heiler']
+    about_dialog.license = 'Please see the homepage on rubygems '\
+      'for the licence of this gem called multimedia_paradise.'
+    about_dialog.name = 'Gtk::Radio'
+    about_dialog.program_name = 'gtk-radio'
+    about_dialog.translator_credits = "Robert A. Heiler\n"
+    about_dialog.version = "Version: #{::MultimediaParadise::VERSION}"
+    about_dialog.website = HOMEPAGE_OF_THIS_PROJECT
+    about_dialog.website_label = 'MultimediaParadise Homepage'
+    about_dialog.logo = pixbuf_from_file(::MultimediaParadise::FILE_RADIO_IMAGE)
+    about_dialog.run
+    # about_dialog.destroy
+  end
+
+  # ========================================================================= #
+  # === create_labels
+  # ========================================================================= #
+  def create_labels
+    @label_displaying_the_radio_station = gtk_label
+  end
+
+  # ========================================================================= #
+  # === return_all_buttons_except_for_the_stop_playback_button
+  # ========================================================================= #
+  def return_all_buttons_except_for_the_stop_playback_button
+    return_all_buttons.reject {|button| button == button_stop_playback? }
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    "#{FONT_FAMILY_TO_USE} #{SMALLER_FONT_SIZE}"
+  end
+
+  # ========================================================================= #
+  # === return_the_label_where_the_stream_is_saved_locally
+  # ========================================================================= #
+  def return_the_label_where_the_stream_is_saved_locally
+    @label_save_the_stream_into_this_file = bold_label(
+      'Save the stream into this file:'
+    )
+    @label_save_the_stream_into_this_file.hint = 
+      'This will denote <b>into</b> which file the stream is to be '\
+      'stored, e. g. <b>a local path</b> for a <b>.mp3 file</b>. '\
+      'Take note that this will <b>overwrite</b> the old file, '\
+      'should such a file exist.'
+    @label_save_the_stream_into_this_file.set_font(smaller_font?)
+    return @label_save_the_stream_into_this_file
+  end
+
+  # ========================================================================= #
+  # === return_the_label_containing_the_main_entry_for_the_streams
+  # ========================================================================= #
+  def return_the_label_containing_the_main_entry_for_the_streams
+    _ = bold_text('Use this stream:', 8)
+    _.left_align
+    _.set_font(smaller_font?)
+    return _
+  end
+
+  # ========================================================================= #
+  # === return_the_entry_where_the_stream_is_saved_locally
+  # ========================================================================= #
+  def return_the_entry_where_the_stream_is_saved_locally
+    @entry_save_into_this_file = gtk_entry
+    if ::Gtk.is_on_roebe?
+      @entry_save_into_this_file.set_text(
+        return_capture_into_the_default_file
+      )
+    end
+    @entry_save_into_this_file.yellow_background
+    @entry_save_into_this_file.pad2px
+    @entry_save_into_this_file.bblack1
+    @entry_save_into_this_file.center
+    @entry_save_into_this_file.set_font(smaller_font?)
+    return @entry_save_into_this_file
+  end
+
+  # ========================================================================= #
+  # === return_capture_into_the_default_file
+  #
+  # This method has one side-effect: we will cd into the base directory.
+  # ========================================================================= #
+  def return_capture_into_the_default_file(
+      use_this_directory_as_the_base_directory = return_pwd
+    )
+    if is_on_roebe?
+      change_directory_on_roebe_systems_unless_in_depot_subdirectory
+      use_this_directory_as_the_base_directory = return_pwd
+    end
+    return use_this_directory_as_the_base_directory.squeeze('/')+'captured_stream_'+
+           Time.now.strftime('%d.%m.%Y')+
+           '.mp3'
+  end
+
+  # ========================================================================= #
+  # === return_lower_part
+  # ========================================================================= #
+  def return_lower_part
+    outer_vbox = vbox
+    _ = hbox(increase_decrease_volume)
+    outer_vbox.minimal(hbox(button_stop_playback?).hcenter)
+    outer_vbox.minimal(gtk_hsep)
+    outer_vbox.minimal(_)
+    outer_vbox.hcenter
+    return outer_vbox
+  end
+
+  # ========================================================================= #
+  # === return_widget_containing_the_grid_and_the_various_entries
+  # ========================================================================= #
+  def return_widget_containing_the_grid_and_the_various_entries
+    vbox_mini2 = vbox
+    # ======================================================================= #
+    # Next we will add the main @grid. The grid will contain the widget
+    # widget that shows where the stream is stored locally.
+    # ======================================================================= #
+    # ======================================================================= #
+    # Add the widget for increasing and decreasing the audio next:
+    # ======================================================================= #
+    vbox_mini2.maximal(@label_displaying_the_radio_station)
+    vbox_mini2.maximal(@entry_status_bar)
+    vbox_mini2.minimal(@grid,                 4)
+    vbox_mini2.minimal(gtk_horizontal_spacer, 3)
+    vbox_mini2.minimal(@status_bar)
+    return vbox_mini2
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    super()
+    change_directory_on_roebe_systems_unless_in_depot_subdirectory
+    run_in_the_background
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::Gtk::Radio[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::GUI::Gtk::Radio.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/app/app.rb'
+    _ = new(i)
+    r = ::Gtk.run
+    r << _
+    _.maximize_button?.set_new_parent(r)
+    r.enable_context_menu_on_button_click_events
+    r.signal_connect(:delete_event) { |_widget| Gtk.main_quit }
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    # ======================================================================= #
+    # Next we will add several alt+key shortcuts.
+    # ======================================================================= #
+    r.shortcuts {[
+      [1, 'click_on_button_number(1)',  :alt],
+      [2, 'click_on_button_number(3)',  :alt],
+      [3, 'click_on_button_number(5)',  :alt],
+      [4, 'click_on_button_number(7)',  :alt],
+      [5, 'click_on_button_number(9)',  :alt],
+      [6, 'click_on_button_number(11)', :alt],
+      [7, 'click_on_button_number(13)', :alt],
+      [8, 'click_on_button_number(15)', :alt],
+      [9, 'click_on_button_number(17)', :alt]
+    ]}
+    r.top_left_then_run
+  end
+
+end; end; end; end