multimedia_paradise 1.1.344 → 1.2.2

data/lib/multimedia_paradise/constants/constants.rb

@@ -7,17 +7,507 @@
 # =========================================================================== #
 # require 'multimedia_paradise/constants/constants.rb'
 # =========================================================================== #
-require 'multimedia_paradise/project/project.rb'
-require 'multimedia_paradise/version/version.rb'
-# =========================================================================== #
-# Next load the other files related to constants of the MultimediaParadise
-# project.
-# =========================================================================== # 
-require 'multimedia_paradise/constants/conversions.rb'
-require 'multimedia_paradise/constants/encodings.rb'
-require 'multimedia_paradise/constants/file_constants.rb'
-require 'multimedia_paradise/constants/namespace.rb'
-require 'multimedia_paradise/constants/newline.rb'
-require 'multimedia_paradise/constants/misc.rb'
-require 'multimedia_paradise/constants/video_filetypes.rb'
-require 'multimedia_paradise/constants/directory_constants.rb'
+module MultimediaParadise
+
+  require 'multimedia_paradise/project/project.rb'
+  require 'multimedia_paradise/version/version.rb'
+  require 'multimedia_paradise/constants/web_constants.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === FILE_AUDIO_FORMATS
+  #
+  # This constant has the file path towards the file called audio_formats.yml
+  # ========================================================================= #
+  FILE_AUDIO_FORMATS =
+    "#{MultimediaParadise.project_yaml_dir?}audio_formats/audio_formats.yml"
+
+  # ========================================================================= #
+  # === MultimediaParadise::AUDIO_FORMATS
+  #
+  # The file can usually be found here:
+  #
+  #   bl $MULTIMEDIA_PARADISE/yaml/audio_formats.yml
+  #
+  # ========================================================================= #
+  if File.exist? FILE_AUDIO_FORMATS
+    AUDIO_FORMATS = File.readlines(FILE_AUDIO_FORMATS).select {|entry|
+      entry.start_with? '- .'
+    }.map {|entry|
+      entry.gsub!(/^- /,'') # Get rid of leading '-' characters.
+      entry = entry[0, entry.index('#')].strip if entry.include? '#'
+      entry.delete('.').strip
+    }
+  else
+    puts 'No file exists at '+FILE_AUDIO_FORMATS+'.'
+    AUDIO_FORMATS = []
+  end
+
+  # ========================================================================= #
+  # === UTF_ENCODING
+  # ========================================================================= #
+  UTF_ENCODING = 'UTF-8'
+
+  # ========================================================================= #
+  # === ISO_ENCODING
+  # ========================================================================= #
+  ISO_ENCODING = 'ISO-8859-1'
+
+  # ========================================================================= #
+  # === USE_THIS_ENCODING
+  #
+  # We default to the UTF-8 Encoding.
+  # ========================================================================= #
+  USE_THIS_ENCODING = UTF_ENCODING
+
+  # ========================================================================= #
+  # === HOME_DIRECTORY_OF_USER_X
+  # ========================================================================= #
+  HOME_DIRECTORY_OF_USER_X = '/home/x/'
+
+  # ========================================================================= #
+  # === DEPOT_VIDEO
+  #
+  # This constant specifies where the local videos ought to be kept.
+  #
+  # An environment flag, called MULTIMEDIA_PARADISE_DEPOT_VIDEO, can
+  # overrule this setting, if it has been set.
+  # ========================================================================= #
+  if ENV['MULTIMEDIA_PARADISE_DEPOT_VIDEO']
+    DEPOT_VIDEO = ENV['MULTIMEDIA_PARADISE_DEPOT_VIDEO'].dup
+  else
+    DEPOT_VIDEO = "#{HOME_DIRECTORY_OF_USER_X}video/" # === DEPOT_VIDEO
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.home_x_video?
+  # ========================================================================= #
+  def self.home_x_video?
+    DEPOT_VIDEO
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::REALVIDS_DIRECTORY
+  #
+  # This may yield a String such as:
+  #
+  #   "/home/x/video/Realvids/"
+  #
+  # ========================================================================= #
+  REALVIDS_DIRECTORY = "#{DEPOT_VIDEO}realvids/"
+            REALVIDS = REALVIDS_DIRECTORY # === REALVIDS
+
+  # ========================================================================= #
+  # === MultimediaParadise.realvids_directory?
+  #
+  # This method is only really useful on my home setup. It will yield
+  # a String such as:
+  #
+  #   "/home/x/video/Realvids/"
+  #
+  # Ideally this method should be  used rather than the above constant.
+  # ========================================================================= #
+  def self.realvids_directory?
+    REALVIDS_DIRECTORY
+  end; self.instance_eval { alias realvid_directory?     realvids_directory? } # === MultimediaParadise.realvid_directory?
+       self.instance_eval { alias directory_to_realvids  realvids_directory? } # === MultimediaParadise.directory_to_realvids
+       self.instance_eval { alias directory_to_realvids? realvids_directory? } # === MultimediaParadise.directory_to_realvids?
+
+  # ========================================================================= #
+  # === CARTOONS_DIRECTORY
+  #
+  # This constant is mildly deprecated. Prefer to use the method
+  # MultimediaParadise.cartoons_directory? instead.
+  # ========================================================================= #
+  CARTOONS_DIRECTORY = "#{DEPOT_VIDEO}cartoons/"
+
+  # ========================================================================= #
+  # === MultimediaParadise.cartoons_directory?
+  # ========================================================================= #
+  def self.cartoons_directory?
+    CARTOONS_DIRECTORY
+  end; self.instance_eval { alias cartoon_directory? cartoons_directory? } # === MultimediaParadise.cartoon_directory?
+
+  # ========================================================================= #
+  # === MY_DATA_DIR
+  # ========================================================================= #
+  MY_DATA_DIR = "#{ENV['MY_DATA']}/" # Needs to have a trailing /, since it is assumed to be a directory.
+
+  # ========================================================================= #
+  # === MultimediaParadise::ARRAY_VIDEO_FILETYPES
+  #
+  # Define which filetypes we will consider to be video-formats.
+  #
+  # Store without '.' character.
+  # ========================================================================= #
+  ARRAY_VIDEO_FILETYPES = %w(
+    avi
+    flv
+    m4v
+    mkv
+    mp4
+    mpg
+    ogm
+    vob
+  )
+
+  # ========================================================================= #
+  # === MULTIMEDIA_PARADISE_DOC_DIR
+  # ========================================================================= #
+  MULTIMEDIA_PARADISE_DOC_DIR = "#{project_base_dir?}doc/"
+
+  # ========================================================================= #
+  # === MY_AUDIO_DIR
+  #
+  # This constant is really only useful on my home system.
+  #
+  # It would point to a target such as "/home/x/DATA/AUDIO/".
+  # ========================================================================= #
+  MY_AUDIO_DIR = "#{MY_DATA_DIR}AUDIO/"
+
+  # ========================================================================= #
+  # === DIRECTORY_TO_THE_LOCAL_SONGS
+  #
+  # This constant will refer to the local directory that contains
+  # the songs on my home setup.
+  # ========================================================================= #
+  if ENV['MULTIMEDIA_PARADISE_DEPOT_AUDIO']
+    DIRECTORY_TO_THE_LOCAL_SONGS = rds("#{ENV['MULTIMEDIA_PARADISE_DEPOT_AUDIO']}/")
+  else # else simply hardcode it.
+    DIRECTORY_TO_THE_LOCAL_SONGS = "#{HOME_DIRECTORY_OF_USER_X}songs/"
+  end; SONG_DIR        = DIRECTORY_TO_THE_LOCAL_SONGS # === SONG_DIR
+       AUDIO_DIRECTORY = DIRECTORY_TO_THE_LOCAL_SONGS # === AUDIO_DIRECTORY
+
+  # ========================================================================= #
+  # === MultimediaParadise.local_audio_directory?
+  #
+  # On my home system this will yield a string such as "/home/x/songs/".
+  # ========================================================================= #
+  def self.directory_to_the_local_songs?
+    DIRECTORY_TO_THE_LOCAL_SONGS
+  end; self.instance_eval { alias local_audio_directory? directory_to_the_local_songs? } # === MultimediaParadise.local_audio_directory? 
+
+  # ========================================================================= #
+  # === HOME
+  #
+  # Determine the HOME directory of the user at hand.
+  #
+  # USER_HOME_DIR is an alias to it.
+  # ========================================================================= #
+  if ENV['HOME'].nil? # In this case we will set a default.
+    if ENV['IS_ON_GOBOLINUX'].to_s == '1'
+      HOME = '/Users/root/'
+    else
+      HOME = '/root/'
+    end
+  else # Else this is the default entry point.
+    HOME = "#{ENV['HOME']}/"
+  end
+    USER_HOME_DIR  = HOME # === USER_HOME_DIR And add some "aliases" to the constant above ^^^.
+    HOME_DIRECTORY = HOME # === HOME_DIRECTORY See above ^^^.
+    HOME_DIR       = HOME # === HOME_DIR See above ^^^.
+
+  # =========================================================================== #
+  # === CONFIGURATION_DIRECTORY
+  # =========================================================================== #
+  CONFIGURATION_DIRECTORY = "#{project_base_directory?}configuration/"
+
+  # ========================================================================= #
+  # === AUDIO_CHANNELS
+  #
+  # Most of the following constants come from the LAME documentation
+  # ========================================================================= #
+  AUDIO_CHANNELS = {
+    :auto     => 'a',
+    :joint    => 'j',
+    :mid_side => 'f',
+    :mono     => 'm',
+    :stereo   => 's',
+  }
+
+  # ========================================================================= #
+  # === MP3_BITRATES
+  # ========================================================================= #
+  MP3_BITRATES = [
+    32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320
+  ]
+
+  # ========================================================================= #
+  # === SAMPLE_RATES
+  # ========================================================================= #
+  SAMPLE_RATES = [
+    8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48
+  ]
+
+  # ========================================================================= #
+  # === ENCODING_QUALITY
+  # ========================================================================= #
+  ENCODING_QUALITY = (0..9) # An Array from 0 to 9.
+
+  # ========================================================================= #
+  # === VBR_QUALITY
+  # ========================================================================= #
+  VBR_QUALITY      = (0..6)
+
+  # ========================================================================= #
+  # === DEFAULT_VIDEO_BITRATE
+  # ========================================================================= #
+  DEFAULT_VIDEO_BITRATE = 100_000
+
+  # ========================================================================= #
+  # === REPLAY_GAIN
+  # ========================================================================= #
+  REPLAY_GAIN  = { 
+    :accurate    => '--replaygain-accurate',
+    :clip_detect => '--clipdetect',
+    :default     => nil,
+    :fast        => '--replaygain-fast',                  
+    :none        => '--noreplaygain'
+  }
+
+  # ========================================================================= #
+  # === MultimediaParadise::TRY_TO_USE_UNICODE_SYMBOLS
+  #
+  # If the following constant is set to true then we will try to make use
+  # of unicode symbols, when applicable. This may aid in the process of
+  # displaying some multimedia icons on the commandline, for example.
+  # ========================================================================= #
+  TRY_TO_USE_UNICODE_SYMBOLS = true
+
+  # ========================================================================= #
+  # === MultimediaParadise::YOUR_EDITOR
+  # ========================================================================= #
+  YOUR_EDITOR = ENV['EDITOR'].to_s
+
+  # ========================================================================= #
+  # === MultimediaParadise::TRY_TO_RENAME_THE_KDE_KONSOLE_TAB
+  #
+  # If true then we assume that we use the KDE konsole and that we can
+  # also rename a konsole-tab title.
+  # ========================================================================= #
+  TRY_TO_RENAME_THE_KDE_KONSOLE_TAB = true
+
+  # ========================================================================= #
+  # === ARRAY_HELP_OPTIONS                                         (help tag)
+  #
+  # We will commonly respond to these help options here.
+  # ========================================================================= #
+  ARRAY_HELP_OPTIONS = %w(
+    HELP HEL help hel he h h? ? --help
+  )
+
+  # ========================================================================= #
+  # === FILE_IMAGE_FORMATS
+  #
+  # This constant has the file path towards the file called audio_formats.yml
+  # ========================================================================= #
+  FILE_IMAGE_FORMATS =
+    "#{MultimediaParadise.project_yaml_dir?}image_formats.yml"
+
+  # ========================================================================= #
+  # === MultimediaParadise::IMAGE_FORMATS
+  #
+  # The file can usually be found here:
+  #   bl $MULTIMEDIA_PARADISE/yaml/image_formats.yml
+  # ========================================================================= #
+  IMAGE_FORMATS = File.readlines(FILE_IMAGE_FORMATS).select {|entry|
+    entry.start_with? '- .'
+  }.map {|entry|
+    entry.gsub!(/^- /,'') # Get rid of leading '-' characters.
+    entry = entry[0, entry.index('#')].strip if entry.include? '#'
+    entry.delete('.').strip
+  } if File.exist? FILE_IMAGE_FORMATS
+
+  # ========================================================================= #
+  # === MultimediaParadise::ARRAY_MULTIMEDIA_FILETYPES
+  #
+  # Build an array that holds all multimedia filetypes. This is a merger
+  # between the video-filetypes and the audio-formats.
+  # ========================================================================= #
+  ARRAY_MULTIMEDIA_FILETYPES = ARRAY_VIDEO_FILETYPES+AUDIO_FORMATS # Assemble these two together.
+    ARRAY_MULTIMEDIA_FILES = ARRAY_MULTIMEDIA_FILETYPES # === ARRAY_MULTIMEDIA_FILES
+
+  # ========================================================================= #
+  # === FILE_MUSIC_GENRES
+  # ========================================================================= #
+  FILE_MUSIC_GENRES =
+    "#{MultimediaParadise.project_yaml_dir?}music_genres.yml"
+
+  # ========================================================================= #
+  # === FILE_LYRICS
+  # ========================================================================= #
+  FILE_LYRICS =
+    "#{MultimediaParadise.project_yaml_dir?}lyrics.yml"
+
+  # ========================================================================= #
+  # === MultimediaParadise.file_lyrics
+  # ========================================================================= #
+  def self.file_lyrics
+    FILE_LYRICS
+  end
+
+  # ========================================================================= #
+  # === FILE_RADIO_IMAGE
+  #
+  # Denote where the image for the radio can be found.
+  # ========================================================================= #
+  FILE_RADIO_IMAGE =
+    "#{::MultimediaParadise.project_base_dir?}images/radio_image.png"
+
+  # ========================================================================= #
+  # === FILE_USE_THIS_VIDEO_PLAYER
+  #
+  # bl $MULTIMEDIA_PARADISE/yaml/use_this_video_player.yml
+  # ========================================================================= #
+  FILE_USE_THIS_VIDEO_PLAYER =
+    "#{MultimediaParadise.project_yaml_dir?}use_this_video_player.yml"
+
+  # ========================================================================= #
+  # === FILE_USAGE_EXAMPLES
+  # ========================================================================= #
+  FILE_USAGE_EXAMPLES =
+    "#{MULTIMEDIA_PARADISE_DOC_DIR}USAGE_EXAMPLES.md"
+
+  # ========================================================================= #
+  # === MultimediaParadise::MY_VIDEO_DIRECTORY
+  #
+  # This is typically on my system, where I keep video-related content.
+  # ========================================================================= #
+  if ENV['MY_VIDEO']
+    MY_VIDEO_DIRECTORY = "#{ENV['MY_VIDEO']}/"
+  else
+    MY_VIDEO_DIRECTORY = "#{HOME_DIRECTORY_OF_USER_X}video/"
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.home_x?
+  # ========================================================================= #
+  def self.home_x?
+    HOME_DIRECTORY_OF_USER_X
+  end; self.instance_eval { alias home_x home_x? } # === MultimediaParadise.home_x
+
+  # ========================================================================= #
+  # === MultimediaParadise::DIRECTORY_DATA_VIDEO
+  #
+  # This constant is always hardcoded.
+  # ========================================================================= #
+  DIRECTORY_DATA_VIDEO =
+    "#{HOME_DIRECTORY_OF_USER_X}DATA/video/"
+
+  # ========================================================================= #
+  # === FILE_SONG_TAGS
+  #
+  # On my home system this will expand towards this path:
+  #
+  #   /usr/lib/ruby/site_ruby/3.2.0/multimedia_paradise/yaml/song_tags.yml
+  #
+  # ========================================================================= #
+  FILE_SONG_TAGS =
+    "#{project_yaml_directory?}song_tags.yml"
+
+  # ========================================================================= #
+  # === LYRICS_YAML_FILE
+  # ========================================================================= #
+  LYRICS_YAML_FILE =
+    "#{project_yaml_directory?}/lyrics/lyrics.yml"
+
+  # ========================================================================= #
+  # === FILE_RADIO_STATIONS
+  #
+  # If an ENVIRONMENT variable called MULTIMEDIA_PARADISE_RADIO_STATIONS
+  # has been set then this will be favoured.
+  #
+  # Commandline invocation:
+  #
+  #   mparadise --file-radio-stations
+  #
+  # ========================================================================= #
+  if ENV.has_key? 'MULTIMEDIA_PARADISE_RADIO_STATIONS'
+    FILE_RADIO_STATIONS = ENV['MULTIMEDIA_PARADISE_RADIO_STATIONS']
+  else
+    # ======================================================================= #
+    # This clause is the default on my home system - and for most
+    # users too, I assume.
+    # ======================================================================= #
+    FILE_RADIO_STATIONS =
+      "#{MultimediaParadise.project_yaml_dir?}radio/radio_stations.yml"
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.file_radio_stations
+  # ========================================================================= #
+  def self.file_radio_stations
+    FILE_RADIO_STATIONS
+  end
+
+  # ========================================================================= #
+  # === FILE_VIDEO_COLLECTION
+  #
+  # Use this constant to define your video collection.
+  #
+  # On my home system this will be:
+  #
+  #   /home/x/DATA/VIDEO/yaml/video_collection.yml
+  #
+  # ========================================================================= #
+  FILE_VIDEO_COLLECTION = "#{project_yaml_directory?}video_collection/video_collection.yml"
+    VIDEO_COLLECTION = FILE_VIDEO_COLLECTION # === VIDEO_COLLECTION
+
+  # ========================================================================= #
+  # === FILE_PLAYLIST
+  # ========================================================================= #
+  FILE_PLAYLIST =
+    "#{project_yaml_directory?}playlist/playlist.yml"
+
+  # ========================================================================= #
+  # === MultimediaParadise.file_video_collection?
+  #
+  # Easier toplevel-method to find out where the file storing all local
+  # videos is kept at.
+  #
+  # The file path returned by this method would typically be at:
+  #
+  #   /home/x/data/video/yaml/video_collection.yml
+  #
+  # ========================================================================= #
+  def self.file_video_collection?
+    FILE_VIDEO_COLLECTION
+  end; self.instance_eval { alias file_video_collection                            file_video_collection? } # === MultimediaParadise.file_video_collection
+       self.instance_eval { alias yaml_file?                                       file_video_collection? } # === MultimediaParadise.yaml_file?
+       self.instance_eval { alias video_collection?                                file_video_collection? } # === MultimediaParadise.video_collection?
+       self.instance_eval { alias location_of_yaml_file_with_registered_videofiles file_video_collection? } # === MultimediaParadise.location_of_yaml_file_with_registered_videofiles
+
+  # ========================================================================= #
+  # === MultimediaParadise.file_tv_channels
+  #
+  # This method will return a String such as:
+  #
+  #   "/usr/lib/ruby/site_ruby/3.0.0/multimedia_paradise/yaml/tv_channels/tv_channels.yml"
+  #
+  # ========================================================================= #
+  def self.file_tv_channels
+    "#{project_yaml_directory?}tv_channels/tv_channels.yml"
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.file_tales_from_the_crypt
+  # ========================================================================= #
+  def self.file_tales_from_the_crypt
+    "#{project_yaml_dir?}tales_from_the_crypt/tales_from_the_crypt.yml"
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp MultimediaParadise::FILE_AUDIO_FORMATS
+  # pp MultimediaParadise::FILE_RADIO_STATIONS  
+end

data/lib/multimedia_paradise/constants/web_constants.rb

@@ -2,14 +2,12 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === MultimediaParadise::WebConstants
-# =========================================================================== #
 # require 'multimedia_paradise/constants/web_constants.rb'
 # include MultimediaParadise::WebConstants
 # =========================================================================== #
 module MultimediaParadise
 
-module WebConstants
+module WebConstants # === MultimediaParadise::WebConstants
 
   # ========================================================================= #
   # === DIV_CLASS
@@ -147,4 +145,4 @@ p.default {
   BORD_TURQUOISE = 'border: 1px solid turquoise;'
   MY_FILE = 'Soundtrack_HansZimmer_BackdraftTheme.mp3'
 
-end; end
+end; end # end of MultimediaParadise::WebConstants

data/lib/multimedia_paradise/gui/gui_base.rb

@@ -5,7 +5,7 @@
 # require 'multimedia_paradise/gui/gui_base.rb'
 # include MultimediaParadise::GUI
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb'
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
 module MultimediaParadise
 
@@ -49,7 +49,7 @@ module GUI
     ::Gtk::Settings.default.gtk_font_name = i
   end
 
-  require 'multimedia_paradise/toplevel_methods/is_audio_file.rb'
+  require 'multimedia_paradise/toplevel_methods/is_audio_file_is_video_file_is_image_file_is_multimedia_file.rb'
   # ========================================================================= #
   # === populate_the_dataset_with_this_array
   #

data/lib/multimedia_paradise/gui/libui/lyrics/lyrics.rb

@@ -16,7 +16,7 @@ module Libui
 class Lyrics # === MultimediaParadise::GUI::Libui::Lyrics
 
   require 'libui_paradise/autoinclude'
-  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/constants/constants.rb'
 
   begin
     require 'colours'

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

@@ -16,7 +16,7 @@ module Libui
 class SimplePlayWidget # === MultimediaParadise::GUI::Libui::SimplePlayWidget
 
   require 'libui_paradise/autoinclude'
-  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/constants/constants.rb'
 
   require 'multimedia_paradise/gui/gui_base.rb'
   include MultimediaParadise::GUI

data/lib/multimedia_paradise/gui/libui/video_player/video_player.rb

@@ -13,7 +13,7 @@ module Libui
 class VideoPlayer # === MultimediaParadise::GUI::Libui::VideoPlayer
 
   require 'libui_paradise/autoinclude'
-  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/constants/constants.rb'
   require 'multimedia_paradise/toplevel_methods/return_random_video_file_from_the_video_collection.rb'
 
   begin

data/lib/multimedia_paradise/gui/libui/youtube_channels/youtube_channels.rb

@@ -13,7 +13,7 @@ module Libui
 class YoutubeChannels # === MultimediaParadise::GUI::Libui::YoutubeChannels
 
   require 'libui_paradise/autoinclude'
-  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/constants/constants.rb'
 
   begin
     require 'colours'