multimedia_paradise 1.1.344

data/lib/multimedia_paradise/toplevel_methods/opn.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/toplevel_methods/opn.rb'
+# =========================================================================== #
+require 'multimedia_paradise/constants/namespace.rb'
+
+module MultimediaParadise
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === MultimediaParadise.opnn
+  # ========================================================================= #
+  def self.opnn(
+      i = { namespace: NAMESPACE }, &block
+    )
+    Opn.opn(i, &block) if Object.const_defined? :Opn
+  end; self.instance_eval { alias opn opnn } # === MultimediaParadise.opn
+
+end

data/lib/multimedia_paradise/toplevel_methods/output_directory.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/toplevel_methods/output_directory.rb'
+# =========================================================================== #
+module MultimediaParadise
+
+  require 'multimedia_paradise/toplevel_methods/is_on_roebe.rb'
+
+  # ========================================================================= #
+  # === @output_directory
+  # ========================================================================= #
+  @output_directory = nil # Initially nil. If non-nil we will use it.
+
+  # ========================================================================= #
+  # === MultimediaParadise.set_output_directory
+  # ========================================================================= #
+  def self.set_output_directory(
+      i = :default
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      i = '/home/x/Temp/multimedia_paradise/'
+    # ======================================================================= #
+    # === :old_default
+    #
+    # This entry point is for the /Depot/ directory specifically.
+    # ======================================================================= #
+    when :old_default
+      i = '/Depot/x/Temp/multimedia_paradise/'
+    end
+    i << '/' unless i.end_with? '/' # Ensure a trailing '/' directory.
+    @output_directory = i
+  end
+
+  # ========================================================================= #
+  # Initialize it at once with the default value.
+  #
+  # This will default to /Depot/x/Temp/MultimediaProject/ usually.
+  # ========================================================================= #
+  set_output_directory if @output_directory.nil?
+
+  # ========================================================================= #
+  # === MultimediaParadise.output_directory?
+  #
+  # Query method over the class-instance variable called @output_directory.
+  #
+  # We ensured through the setter that this will always end via a trailing
+  # '/' token.
+  # ========================================================================= #
+  def self.output_directory?
+    @output_directory
+  end; self.instance_eval { alias store_in_this_directory output_directory? } # === MultimediaParadise.store_in_this_directory
+       self.instance_eval { alias log_directory?          output_directory? } # === MultimediaParadise.log_directory?
+       self.instance_eval { alias log_dir?                output_directory? } # === MultimediaParadise.log_dir?
+
+end

data/lib/multimedia_paradise/toplevel_methods/player_in_use.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/toplevel_methods/player_in_use.rb'
+# =========================================================================== #
+module MultimediaParadise
+
+  require 'multimedia_paradise/toplevel_methods/is_on_roebe.rb'
+
+  # ========================================================================= #
+  # === @player_in_use
+  #
+  # This toplevel instance variable denotes which video-player we will
+  # use for the MultimediaParadise project.
+  # ========================================================================= #
+  @player_in_use = nil
+
+  # ========================================================================= #
+  # === WHICH_VIDEO_PLAYER_TO_USE
+  #
+  # This constant determines which video player to use. An environment
+  # variable can overrule this, called USE_THIS_VIDEO_PLAYER.
+  #
+  # Since as of December 2018 this should no longer be the primary
+  # means to set the multimedia-player in use for the project -
+  # instead, make use of MultimediaParadise.set_player_in_use().
+  # ========================================================================= #
+  if ENV.has_key? 'USE_THIS_VIDEO_PLAYER'
+    WHICH_VIDEO_PLAYER_TO_USE = "#{ENV['USE_THIS_VIDEO_PLAYER']}"
+  else
+    WHICH_VIDEO_PLAYER_TO_USE = 'mplayer' # DATA.read
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.player_in_use?
+  #
+  # Query which audio/video player is in use for this project.
+  # ========================================================================= #
+  def self.player_in_use?
+    @player_in_use
+  end; self.instance_eval { alias which_video_player_to_use?   player_in_use? } # === MultimediaParadise.which_video_player_to_use?
+       self.instance_eval { alias use_this_player              player_in_use? } # === MultimediaParadise.use_this_player
+       self.instance_eval { alias use_which_multimedia_player? player_in_use? } # === MultimediaParadise.use_which_multimedia_player?
+       self.instance_eval { alias use_this_multimedia_player?  player_in_use? } # === MultimediaParadise.use_this_multimedia_player?
+       self.instance_eval { alias player?                      player_in_use? } # === MultimediaParadise.player?
+       self.instance_eval { alias video_player?                player_in_use? } # === MultimediaParadise.video_player?
+       self.instance_eval { alias use_which_video_player?      player_in_use? } # === MultimediaParadise.use_which_video_player?
+
+  # ========================================================================= #
+  # === MultimediaParadise.set_player_in_use
+  # ========================================================================= #
+  def self.set_player_in_use(
+      i = :default
+    )
+    i = i.to_s.dup.strip # Make sure we have a String past this point.
+    case i
+    when 'default',''
+      # ====================================================================== #
+      # Determine the default video-player in use for the MultimediaParadise
+      # project. A constant keeps track of this value. Since as of June
+      # 2020 a .yml file exists, and it will be used if it is available
+      # AND if we are on a roebe system..
+      # ====================================================================== #
+      if File.exist?(FILE_USE_THIS_VIDEO_PLAYER) and is_on_roebe?
+        i = YAML.load_file(FILE_USE_THIS_VIDEO_PLAYER)
+      else
+        i = WHICH_VIDEO_PLAYER_TO_USE
+      end
+    end
+    @player_in_use = i
+  end; self.instance_eval { alias set_use_this_multimedia_player set_player_in_use } # === MultimediaParadise.set_use_this_multimedia_player
+
+  # ========================================================================= #
+  # And call it at once with the default, to have a proper state for the
+  # variable.
+  # ========================================================================= #
+  set_player_in_use
+
+end

data/lib/multimedia_paradise/toplevel_methods/query_the_audio_codec_of_this_file.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'multimedia_paradise/ffmpeg/ffmpeg.rb'
+
+module MultimediaParadise
+
+  # ========================================================================= #
+  # === MultimediaParadise.query_the_audio_codec_of_this_file
+  #
+  # See the method MultimediaParadise.ffmpeg_query_the_audio_codec_of_this_file
+  # for a description of this method.
+  # ========================================================================= #
+  def self.query_the_audio_codec_of_this_file(i)
+    ffmpeg_query_the_audio_codec_of_this_file(i)
+  end; self.instance_eval { alias audio_codec?          query_the_audio_codec_of_this_file } # === MultimediaParadise.audio_codec?
+       self.instance_eval { alias query_the_audio_codec query_the_audio_codec_of_this_file } # === MultimediaParadise.query_the_audio_codec
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts MultimediaParadise.query_the_audio_codec_of_this_file(ARGV)
+end # query_the_audio_codec_of_this_file /Depot/j/foobar.mp3

data/lib/multimedia_paradise/toplevel_methods/radio.rb

@@ -0,0 +1,381 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Internet-radio related code will reside in this file here.
+# =========================================================================== #
+# require 'multimedia_paradise/toplevel_methods/radio.rb'
+# MultimediaParadise.register_title_of_this_audio_file
+# MultimediaParadise.title_of_the_audio_file?
+# =========================================================================== #
+module MultimediaParadise
+
+  require 'multimedia_paradise/constants/constants.rb'
+  require 'multimedia_paradise/constants/encodings.rb'
+  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/colours/colours.rb'
+  require 'multimedia_paradise/toplevel_methods/e.rb'
+  require 'multimedia_paradise/toplevel_methods/esystem.rb'
+  require 'multimedia_paradise/toplevel_methods/player_in_use.rb'
+
+  begin
+    require 'roebe/toplevel_methods/unicode/popular_unicode_symbols.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === @title_of_the_audio_file
+  # ========================================================================= #
+  @title_of_the_audio_file = nil
+
+  # ========================================================================= #
+  # === MultimediaParadise.try_to_find_a_match_for_a_similar_radio_station
+  #
+  # This method will attempt to find a matching URL from the given input.
+  # ========================================================================= #
+  def self.try_to_find_a_match_for_a_similar_radio_station(i)
+    i = i.to_s.downcase.delete(' ')
+    all_radio_stations = MultimediaParadise.radio_stations?
+    selection = all_radio_stations.select {|name_of_the_radio_station, remote_URL|
+      name_of_the_radio_station.downcase.delete(' ').include? i
+    }
+    return selection
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.play_radio_from_this_url
+  #
+  # This method can be used to play radio from a remote URL.
+  #
+  # It will make use of Process.spawn rather than system(), because
+  # we need to return the PID.
+  #
+  # The second argument to this method, if given, will log the
+  # captured stream into a local file. This depends on mpv mostly,
+  # and is a bit limited, so don't expect too much of that
+  # feature.
+  # ========================================================================= #
+  def self.play_radio_from_this_url(
+      url                    = 'http://www.radioking.com/play/generationhit80',
+      capture_into_this_file = nil,
+      &block
+    )
+    _ = video_player?
+    # ======================================================================= #
+    # === Handle blocks given to this method next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :use_this_player
+        # =================================================================== #
+        if yielded.has_key? :use_this_player
+          _ = yielded.delete(:use_this_player)
+        end
+      end
+    end
+    case _.to_s
+    # ======================================================================= #
+    # === mpv
+    # ======================================================================= #
+    when 'mpv'
+      cmd_to_run = "mpv #{url}".dup
+      if capture_into_this_file
+        cmd_to_run << ' --stream-record="'+capture_into_this_file+'"'
+      end
+      e cmd_to_run
+      # ===================================================================== #
+      # The line below was in use until September 2020; it is kept in the
+      # event that we wish to revert to it.
+      #   pid = Process.spawn(cmd_to_run)
+      # ===================================================================== #
+      io_object = IO.popen(cmd_to_run, 'r+')
+      pid = io_object.pid
+      set_pid(pid) # Keep track of the pid here.
+      io_object.each { |line|
+        if line.start_with? ' icy-title: '
+          register_title_of_this_audio_file(line)
+        end
+        e line
+      }
+      io_object.close
+      return pid
+    # ======================================================================= #
+    # === mplayer
+    # ======================================================================= #
+    when 'mplayer'
+      cmd_to_run = "mplayer #{url}".dup
+      if capture_into_this_file
+        cmd_to_run << ' -dumpstream -dumpfile "'+capture_into_this_file+'"'
+      end
+      e cmd_to_run
+      pid = Process.spawn(cmd_to_run)
+      set_pid(pid) # Keep track of the pid here.
+      return pid
+    else
+      e "No video player that is known (#{_}). The "\
+        "URL would have been: #{sfancy(url)}"
+    end
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.radio_stations?
+  #
+  # The file that is used by this method by default is usually the one
+  # that is distributed via the MultimediaParadise project, called
+  # 'radio/radio_stations.yml'.
+  # ========================================================================= #
+  def self.radio_stations?(i = FILE_RADIO_STATIONS)
+    YAML.load_file(i)
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.show_internet_radio_URLs
+  #
+  # This method will show various URLs to internet-radio. This depends
+  # on prior registration in a yaml file.
+  #
+  # The first argument should provide an existing file to where the
+  # radio stations are registered. By default, MultimediaParadise
+  # will come with a file where some radio URL stations are registered.
+  #
+  # The second argument controls how this dataset is displayed. The
+  # :default style means that we will use a long display format, with
+  # more newlines. This may be easier to read - but there is also a
+  # :compact variant, which will display the radio stations along
+  # with the registered URL in a compact manner, all on the same
+  # line. Do note that :in_a_compact_form is simply an alias
+  # to :compact.
+  #
+  # To invoke this, do:
+  #
+  #   mparadise --radio-compact
+  #   mparadise --rhythmbox
+  #
+  # ========================================================================= #
+  def self.show_internet_radio_URLs(
+      i             = file_radio_stations,
+      display_style = :default
+    )
+    # ======================================================================= #
+    # First, load up the dataset from the given file.
+    # ======================================================================= #
+    dataset = YAML.load_file(i)
+    e
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # This instructions will show the remote URL listing of radio
+      # stations in a more compact version.
+      # ===================================================================== #
+      when :compact,
+           :in_a_compact_form
+        display_style = :compact
+      end
+    end
+    dataset.each_pair {|name_of_the_radio_station_at_hand, value|
+      result = '  '.dup
+      if TRY_TO_USE_UNICODE_SYMBOLS and Object.const_defined?(:Roebe) and
+         Roebe.respond_to?(:wheel_of_dharma)
+        result << COLOURS.darkslateblue(Roebe.wheel_of_dharma+' ')
+      end
+      entry = value['url'] # Define "entry" here.
+      properly_formatted_name_of_the_radio_station_at_hand =
+        COLOURS.royalblue(
+          (name_of_the_radio_station_at_hand+':').ljust(25)
+        )
+      result << properly_formatted_name_of_the_radio_station_at_hand
+      unless display_style == :compact
+        result << "\n"
+      end
+      result << '  '+sfancy("    #{entry}")
+      e result
+    }
+    e
+  end; self.instance_eval { alias show_available_radio_stations show_internet_radio_URLs } # === MultimediaParadise.show_available_radio_stations
+
+  # ========================================================================= #
+  # === MultimediaParadise.set_pid
+  # ========================================================================= #
+  def self.set_pid(i)
+    @pid = i
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.register_title_of_this_audio_file
+  # ========================================================================= #
+  def self.register_title_of_this_audio_file(i)
+    @title_of_the_audio_file = nil # Always reset it here.
+    use_this_regex = /^ icy-title: (.+)\n/
+    if i and i.start_with?(' icy-title: ')
+      i = i.scan(use_this_regex).flatten
+      if i.is_a? Array
+        i = i.first.to_s
+      end
+      @title_of_the_audio_file = i.strip
+    end
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.title_of_the_audio_file?
+  # ========================================================================= #
+  def self.title_of_the_audio_file?
+    @title_of_the_audio_file
+  end
+  
+  # ========================================================================= #
+  # === MultimediaParadise.pid?
+  #
+  # Keep track of the pid through this toplevel variable.
+  # ========================================================================= #
+  def self.pid?
+    @pid
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.play_radio
+  # ========================================================================= #
+  def self.play_radio(
+      remote_url = 'bbc3'
+    )
+    unless remote_url.include? 'http'
+      remote_url = return_radio_station_url_from_this_input(remote_url)
+    end
+    play_radio_from_this_url(remote_url)
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.return_iso_encoding_of
+  # ========================================================================= #
+  def self.return_iso_encoding_of(i)
+    i = i.dup if i.frozen?
+    i.force_encoding(ISO_ENCODING)
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.return_radio_station_url_from_this_input
+  #
+  # This method will try to return a corresponding URL from the given
+  # input at hand.
+  # ========================================================================= #
+  def self.return_radio_station_url_from_this_input(
+      i,
+      use_this_yaml_file = FILE_RADIO_STATIONS
+    )
+    dataset = YAML.load_file(use_this_yaml_file)
+    # ======================================================================= #
+    # This file may contain umlauts. We could convert these into ISO
+    # encoding, but since as of May 2019 we will default to UTF-8
+    # anyway.
+    # ======================================================================= #
+    # dataset.each_pair {|key, value|
+    #   hash[return_iso_encoding_of(key)] = value
+    # }; dataset = hash
+    i = i.to_s.delete('-').downcase
+    i = case i
+    # ======================================================================= #
+    # === oe3
+    # ======================================================================= #
+    when 'oe3','ö3','o3'
+      dataset['Hitradio Ö3']['url']
+    # ======================================================================= #
+    # === fm4
+    # ======================================================================= #
+    when 'fm4'
+      dataset['FM4']['url']
+    # ======================================================================= #
+    # == orf-radio-wien
+    # ======================================================================= #
+    when /^-?-?orf(_|-)?radio(_|-)?wien$/i
+      dataset['ORF Radio Wien']['url']
+    # ======================================================================= #
+    # === energy
+    # ======================================================================= #
+    when 'energy'
+      dataset['Energy 104,2']['url']
+    # ======================================================================= #
+    # === trance
+    # ======================================================================= #
+    when 'trance'
+      dataset['PulsRadio TRANCE']['url']
+    # ======================================================================= #
+    # === germany
+    # ======================================================================= #
+    when 'germany'
+      dataset['Germany Radio']['url']
+    # ======================================================================= #
+    # === bbc1
+    # ======================================================================= #
+    when /^bbc1$/i
+      dataset['BBC Radio 1']['url']
+    # ======================================================================= #
+    # === bbc2
+    # ======================================================================= #
+    when /^bbc2$/i
+      dataset['BBC Radio 2']['url']
+    # ======================================================================= #
+    # === bbc4
+    # ======================================================================= #
+    when /^bbc4/i
+      dataset['BBC Radio 4']['url']
+    # ======================================================================= #
+    # === kronehit
+    # ======================================================================= #
+    when 'kronehit'
+      dataset['Kronehit Dance']['url']
+    # ======================================================================= #
+    # === oe1
+    # ======================================================================= #
+    when 'oe1','ö1'
+      dataset['OE 1']['url']
+    # ======================================================================= #
+    # === radiowien
+    # ======================================================================= #
+    when /^radio(-|_| )?wien$/
+      dataset['ORF Radio Wien']['url']
+    # ======================================================================= #
+    # === Magic FM Germany
+    # ======================================================================= #
+    when /^Magic(-|_| )?FM(-|_| )?Germany$/i
+      dataset['Magic FM Germany']['url']
+    # ======================================================================= #
+    # === bbc3
+    # ======================================================================= #
+    when /^bbc3$/i,
+         /^BBC(-|_| )?Radio(-|_| )?3$/i
+      dataset['BBC Radio 3']['url']
+    else
+      i
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise.display_radio_stations
+  # ========================================================================= #
+  def self.display_radio_stations
+    e sfile(
+        FILE_RADIO_STATIONS
+      )
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  MultimediaParadise.display_radio_stations
+  # e 'The available radio stations are:'
+  # e
+  # pp MultimediaParadise.radio_stations?
+  if ARGV.empty?
+    use_this_radio_station = 'BBC3'
+  else
+    use_this_radio_station = ARGV.first
+  end
+  e
+  e 'Playing some Radio next (for BBC3):'
+  e
+  MultimediaParadise.play_radio(use_this_radio_station)
+  # MultimediaParadise.play_radio_from_this_url 'https://stream.laut.fm/magicfm'
+end # display_radio_stations http://listen.radionomy.com:80/YourTranceRadio

data/lib/multimedia_paradise/toplevel_methods/rds.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module MultimediaParadise
+
+  # ========================================================================= #
+  # === MultimediaParadise.rds
+  #
+  # This method will replace '//' with '/'.
+  # ========================================================================= #
+  def self.rds(i = nil)
+    return '' if i.nil?
+    i.squeeze '/'
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    MultimediaParadise.rds(i)
+  end
+
+end

data/lib/multimedia_paradise/toplevel_methods/return_all_video_files.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/toplevel_methods/return_all_video_files.rb'
+# MultimediaParadise.return_all_video_files
+# =========================================================================== #
+module MultimediaParadise
+
+  require 'yaml'
+  require 'multimedia_paradise/constants/file_constants.rb'
+  require 'multimedia_paradise/toplevel_methods/is_video_file.rb'
+
+  # ========================================================================= #
+  # === MultimediaParadise.available_video_files
+  #
+  # This method will only return all video-files under ther ealvids
+  # directory.
+  # ========================================================================= #
+  def self.available_video_files
+    Dir["#{realvids_directory?}**"].select {|entry| is_a_video_file?(entry) }.sort
+  end; self.instance_eval { alias array_available_realvids_videos available_video_files } # === MultimediaParadise.array_available_realvids_videos
+
+  # ========================================================================= #
+  # === MultimediaParadise.return_all_video_files
+  #
+  # Use this method if you wish to return all video files registered
+  # in the main video_collection yaml file.
+  #
+  # This will return a Hash that has entries similar to this one here:
+  #
+  #   275=>{"title"=>"Shaun Of The Dead", "genre"=>"Comedy", "addition_date"=>"21.12.2009", "language"=>"english"},
+  #
+  # ========================================================================= #
+  def self.return_all_video_files
+    _ = file_video_collection
+    if File.exist? _
+      begin
+        YAML.load_file(_)
+      rescue Psych::SyntaxError => error
+        puts "Psych::SyntaxError for the file #{_} in the method "\
+             "MultimediaParadise.return_all_video_files()"
+        pp error
+      end
+    else
+      {} # Or we will return an empty Hash.
+    end
+  end
+
+  # ========================================================================= #
+  # === return_all_video_files
+  #
+  # Return all video files that are defined in the file
+  # video_collection.yml.
+  # ========================================================================= #
+  def return_all_video_files
+    MultimediaParadise.return_all_video_files # Defined in this file here.
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp MultimediaParadise.return_all_video_files
+end