multimedia_paradise 1.1.314

data/lib/multimedia_paradise/audio/audio_player/misc.rb

@@ -0,0 +1,718 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/audio/audio_player/misc.rb'
+# =========================================================================== #
+module MultimediaParadise
+
+class AudioPlayer < AudioBase # === MultimediaParadise::AudioPlayer
+
+  begin
+    require 'x/tools/mrxvt_options.rb'
+  rescue LoadError; end
+
+  begin
+    require 'roebe/classes/kde/kde_konsole/kde_konsole.rb'
+  rescue LoadError; end
+
+  require 'multimedia_paradise/requires/require_file_duration.rb'
+  # ========================================================================= #
+  # === obtain_file_duration_from_this_file(i)
+  # ========================================================================= #
+  def obtain_file_duration_from_this_file(i)
+    MultimediaParadise::FileDuration[i]
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    register_sigint { :pretty }
+    reset
+    if i
+      i = set_commandline_options_and_return_the_other_options(i)
+      menu(i)
+    end
+    case run_already
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
+    when :dont_run_yet,
+         :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === determine_which_audio_player_to_use
+  #
+  # This method will determine which audio play is to be used, for playing
+  # the audio files. Currently the two primary ones that I use are mplayer
+  # and mpv. Note that the environment variable MAIN_AUDIO_PLAYER can
+  # overrule this completely, if set.
+  # ========================================================================= #
+  def determine_which_audio_player_to_use(
+      i                                        = MAIN_AUDIO_PLAYER_TO_USE,
+      overrule_if_environment_variable_was_set = true
+    )
+    case overrule_if_environment_variable_was_set
+    # ======================================================================= #
+    # === :ignore_environment_variable
+    # ======================================================================= #
+    when :ignore_environment_variable
+      overrule_if_environment_variable_was_set = false
+    end
+    case i
+    # ======================================================================= #
+    # === sox
+    # ======================================================================= #
+    when 'sox',
+         :sox
+      i = 'play' # The binary from sox is actually called "play", hence this line.
+    end
+    if overrule_if_environment_variable_was_set
+      if ENV.has_key? 'MAIN_AUDIO_PLAYER'
+        i = ENV['MAIN_AUDIO_PLAYER'].to_s.dup
+      end
+    end
+    @audio_player_to_use = i.to_s # Which audio player to use.
+  end
+
+  # ========================================================================= #
+  # === report_which_audio_player_to_use
+  # ========================================================================= #
+  def report_which_audio_player_to_use
+    opnn; e 'The audio player '+sfancy(@audio_player_to_use)+
+            ' will be used.'
+  end
+
+  # ========================================================================= #
+  # === show_startup_message
+  #
+  # Display a fancy startup message.
+  # ========================================================================= #
+  def show_startup_message
+    e N+main_colour?+' => Starting Audio Player '+
+      simp(use_which_audio_player?)+main_colour?+' ('+
+      sfancy('Default delay: ')+delay?+mcol?+').'+N
+  end
+
+  # ========================================================================= #
+  # === set_commandline_options_and_return_the_other_options
+  # ========================================================================= #
+  def set_commandline_options_and_return_the_other_options(i)
+    unless i.is_a? Symbol
+      if i.respond_to?(:any?) and i.any? {|line|
+          line.start_with? '--'
+        }
+        @commandline_options = i.select {|inner_line|
+          inner_line.start_with? '--'
+        }
+        menu(@commandline_options)
+        # ===================================================================== #
+        # And finally, remove these entries that were found.
+        # ===================================================================== #
+        i.reject! {|entry|
+          entry.start_with? '--'
+        }
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === populate_hash_songs_played
+  #
+  # Fills up our hash with available data for the first time.
+  # Basically right now, only manipulates @hash_songs_played
+  # ========================================================================= #
+  def populate_hash_songs_played
+    playlist?.each { |song|
+      song = File.basename(song)
+      @hash_songs_played[song] = 0
+    }
+  end
+
+  # ========================================================================= #
+  # === set_delay
+  #
+  # This sets the default delay, when playing the audio songs in
+  # a loop.
+  # ========================================================================= #
+  def set_delay(i = DEFAULT_DELAY_PLAYING_SONGS)
+    @delay = i
+  end
+
+  # ========================================================================= #
+  # === get_file_size
+  # ========================================================================= #
+  def get_file_size(
+      of_this_file = the_songs_played_will_be_stored_where?
+    )
+    size = 0
+    size = File.size(of_this_file) if File.exist?(of_this_file)
+    size
+  end
+
+  # ========================================================================= #
+  # === set_shall_we_exit
+  # ========================================================================= #
+  def set_shall_we_exit(i = true)
+    @shall_we_exit = i
+  end
+
+  # ========================================================================= #
+  # === show_available_genres
+  # ========================================================================= #
+  def show_available_genres
+    opnn; e 'The available genres are:'
+    pp @available_genres
+  end
+
+  # ========================================================================= #
+  # === shall_we_exit?
+  # ========================================================================= #
+  def shall_we_exit?
+    @shall_we_exit
+  end
+
+  # ========================================================================= #
+  # === show_last_file_played
+  #
+  # This method will show the last song played.
+  # ========================================================================= #
+  def show_last_file_played(
+      _ = the_songs_played_will_be_stored_where?
+    )
+    if File.exist? _
+      e 'The last song played was:'
+      efancy('  '+File.readlines(_)[-1])
+      exit_program
+    else
+      ewarn 'But the file '+sfile(_)+RED+' does not exist.'
+    end
+  end
+
+  # ========================================================================= #
+  # === the_songs_played_will_be_stored_where?
+  # ========================================================================= #
+  def the_songs_played_will_be_stored_where?
+    FULL_LOCATION_FOR_LAST_SONG_PLAYED
+  end
+
+  # ========================================================================= #
+  # === add_random_song
+  #
+  # This will add exactly one random song.
+  # ========================================================================= #
+  def add_random_song
+    add_song(return_random_song)
+  end
+
+  # ========================================================================= #
+  # === shuffle_the_playlist
+  # ========================================================================= #
+  def shuffle_the_playlist
+    playlist?.shuffle!
+  end; alias shuffle shuffle_the_playlist # shuffle
+
+  # ========================================================================= #
+  # === do_play_in_a_loop
+  # ========================================================================= #
+  def do_play_in_a_loop
+    @play_in_a_loop = true
+  end
+      
+  # ========================================================================= #
+  # === try_to_play_playlist
+  # ========================================================================= #
+  def try_to_play_playlist
+    begin
+      require 'x/AUD/playlist.rb'
+      add(Playlist.playlist?)
+      shuffle
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === show_the_playlist
+  # ========================================================================= #
+  def show_the_playlist
+    opnn; e 'The playlist is:'
+    pp playlist?
+  end; alias show_songs show_the_playlist # === show_songs
+
+  # ========================================================================= #
+  # === main_colour?
+  # ========================================================================= #
+  def main_colour?
+    @main_colour
+  end; alias mcol? main_colour? # mcol?
+
+  # ========================================================================= #
+  # === return_all_songs
+  #
+  # By default, we will shuffle.
+  # ========================================================================= #
+  def return_all_songs
+    return AVAILABLE_SONGS.shuffle
+  end; alias all_songs                 return_all_songs # === all_songs
+       alias get_all_songs             return_all_songs # === get_all_songs
+       alias determine_available_songs return_all_songs # === determine_available_songs
+       alias all_songs?                return_all_songs # === all_songs?
+
+  # ========================================================================= #
+  # === return_random_song
+  #
+  # This method will return one random song.
+  # ========================================================================= #
+  def return_random_song
+    return_all_songs.first
+  end; alias fetch_random_song return_random_song
+       alias get_random_song   return_random_song
+
+  # ========================================================================= #
+  # === reset_playlist
+  # ========================================================================= #
+  def reset_playlist
+    @array_play_these_songs = [] # Keep all files that we wish to play in this Array.
+  end; alias clear_playlist reset_playlist
+
+  # ========================================================================= #
+  # === audio_dir?
+  # ========================================================================= #
+  def audio_dir?
+    AUDIO_DIR
+  end
+
+  # ========================================================================= #
+  # === register_this_song
+  #
+  # This method should be invoked whenever you want to play a new song.
+  #
+  # We will only keep the filename, not the full location.
+  # ========================================================================= #
+  def register_this_song(this_song)
+    if @hash_songs_played
+      this_song = File.basename(this_song)
+      if @hash_songs_played.has_key? this_song
+        @hash_songs_played[this_song] = @hash_songs_played[this_song] + 1
+      else
+        @hash_songs_played[this_song] = 1 # Initialize at 1 then.
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === add_all_songs
+  # ========================================================================= #
+  def add_all_songs
+    add(all_songs?)
+  end
+
+  # ========================================================================= #
+  # === refresh_playlist
+  #
+  # First clears the playlist, then adds all available songs.
+  # ========================================================================= #    
+  def refresh_playlist
+    clear_playlist
+    add_all_songs
+  end
+
+  # ========================================================================= #
+  # === perform_cleanup
+  #
+  # We get rid of @ivars which are not too useful.
+  # ========================================================================= #
+  def perform_cleanup
+    remove_instance_variable :@available_genres
+  end
+
+  # ========================================================================= #
+  # === check_whether_the_song_directory_is_empty
+  # ========================================================================= #
+  def check_whether_the_song_directory_is_empty
+    if return_all_songs.empty?
+      opnn; e 'No songs found in `'+sdir(audio_dir?)+'`.'
+      opnn; e 'Perhaps you forgot to copy some songs first?'
+      exit_program(:force_exit)
+    end
+  end
+
+  # ========================================================================= #
+  # === exit_program
+  #
+  # This method can be used to exit this program.
+  # ========================================================================= #
+  def exit_program(
+      shall_we_exit = shall_we_exit?,
+      be_verbose    = true,
+      &block
+    )
+     
+    case shall_we_exit
+    # ======================================================================= #
+    # === :force_exit
+    # ======================================================================= #
+    when :force_exit
+      shall_we_exit = true
+    # ======================================================================= #
+    # === :force_exit_but_be_quiet
+    # ======================================================================= #
+    when :force_exit_but_be_quiet
+      shall_we_exit = true
+      be_verbose = false
+    end
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet
+        be_verbose = false
+      end
+    end
+    if shall_we_exit
+      @mrxvt.set_title('') if @mrxvt
+      if be_verbose
+        efancy 'Leaving ...'
+        efancy 'Hopefully you had fun and found class'\
+               'MultimediaParadise::AudioPlayer useful. Bye!'
+      end
+      consider_resetting_kde_konsole_tab
+      exit
+    else
+      e "Won't exit as we are not allowed to exit."
+    end
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @array_play_these_songs
+  end; alias play_these_songs input? # === play_thse_songs
+       alias playlist?        input? # === playlist?
+
+  # ========================================================================= #
+  # === sanitize_songs
+  # ========================================================================= #
+  def sanitize_songs
+    playlist?.flatten! # Always flatten it afterwards.
+  end
+
+  # ========================================================================= #
+  # === add_song                                                    (add tag)
+  #
+  # This method will add the particular song to the playlist.
+  #
+  # It will check whether it is an multimedia-file prior to adding it,
+  # though.
+  # ========================================================================= #
+  def add_song(
+      i = nil
+    )
+    unless i.nil?
+      [i].flatten.compact.each {|this_song|
+        if is_a_multimedia_file?(this_song)
+          @array_play_these_songs << this_song
+        end
+      }
+      sanitize_songs
+    end
+  end; alias add                       add_song # === add
+       alias add_to_playlist           add_song # === add_to_playlist
+       alias add_this_song_to_playlist add_song # === add_this_song_to_playlist
+       alias add_this_song             add_song # === add_this_song
+       alias add_songs                 add_song # === add_songs
+
+  # ========================================================================= #
+  # === register_sigint
+  #
+  # Will act upon SIGINT recieved, and properly shut down.
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') {
+      consider_resetting_kde_konsole_tab
+      exit_program(true)
+    }
+  end
+
+  # ========================================================================= #
+  # === consider_resetting_kde_konsole_tab
+  #
+  # This method can be used to re-set the KDE konsole tab name.
+  # ========================================================================= #
+  def consider_resetting_kde_konsole_tab(
+      use_this_as_the_new_title = '.'
+    )
+    do_rename_konsole(
+      use_this_as_the_new_title, RENAME_KDE_KONSOLE_TAB
+    )
+  end
+
+  # ========================================================================= #
+  # === try_to_find_genre_song
+  #
+  # This tries to find a (random) genre song.
+  # ========================================================================= #
+  def try_to_find_genre_song(i)
+    upcased = i.to_s.upcase
+    if @available_genres.grep(/#{upcased}/)
+      matches = PLAYLIST_CONSTANTS.select {|entry| entry =~ /#{upcased}/ }[0]
+      if matches.nil? # Then try without playlist
+        these_songs = Dir[audio_dir?+'*'+i+'*']
+      end
+      these_songs = PlaylistProfile.module_eval(matches.to_s).map {|entry|
+        audio_dir?+entry
+      } if matches
+      add_song(these_songs.shuffle)
+    end if @available_genres
+  end
+
+  # ========================================================================= #
+  # === pause                                                     (pause tag)
+  #
+  # Pause for n_seconds (the first input to this method).
+  #
+  # This method will NOT seet a new, random song - for this,
+  # you need to use another method.
+  # ========================================================================= #
+  def pause(
+      n_seconds = delay?
+    )
+    n_seconds = n_seconds.to_f # Always keep it as a float here.
+    cliner
+    e "#{true_rev}We will pause for #{sfancy(n_seconds)} seconds."
+    cliner_with_time_stamp
+    e 'The next song will be: '+sfancy(
+         playlist?[@n_songs_played]
+       )
+    cliner
+    sleep(n_seconds)
+  end
+
+  # ========================================================================= #
+  # === play_this_song                                             (play tag)
+  #
+  # This is the actual method that will play the song.
+  #
+  # We will also append the filename last played.
+  # ========================================================================= #
+  def play_this_song(
+      i, be_verbose = true
+    )
+    if be_verbose 
+      e; opnn; e 'The next song we will play via '+
+                  simp(audio_player_to_use?)+' is:'
+      e "#{N}   #{sfancy(i)}#{N}#{N}"
+    end
+    # ======================================================================= #
+    # Next, act on .mp3 files.
+    # ======================================================================= #
+    if File.extname(i) == '.mp3'
+      begin
+        @file_duration_in_seconds = obtain_file_duration_from_this_file(i)
+        if be_verbose
+          e 'The length of this song is: '+
+            sfancy("#{@file_duration_in_seconds.to_i} seconds")+'.'
+        end
+      rescue Exception => error
+        e error
+      end
+    end
+    e "  #{sfile(i)}" if be_verbose
+    consider_renaming_the_kde_konsole_tab(i)
+    _ = audio_player?.dup
+    _ << ' -ao oss' if @use_oss_for_audio_player
+    _ << ' '+i.dup
+    # ======================================================================= #
+    # Register which song was played. We do this before we actually play
+    # the song.
+    # ======================================================================= #
+    register_which_song_will_be_played_next(i)
+    esystem _
+    @n_songs_played += 1
+  end
+
+  # ========================================================================= #
+  # === do_rename_konsole
+  # ========================================================================= #
+  def do_rename_konsole(
+      i = '.', *optional_arguments_that_are_irrelevant
+    )
+    if Object.const_defined? :Roebe
+      Roebe.rename_konsole(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === store_data_about_this_song_into_a_local_file
+  # ========================================================================= #
+  def store_data_about_this_song_into_a_local_file(
+      this_song
+    )
+    into = THE_LOG_FILE_IS_STORED_HERE
+    what = "song name: #{this_song.ljust(30)}, "\
+           "played on #{dd_mm_yyyy}, #{hh_mm_ss}\n"
+    dirname = File.dirname(into)
+    mkdir(dirname) unless File.directory? dirname
+    append_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === show_the_log_file_if_it_exists
+  #
+  # Invocation example:
+  #
+  #   rsong --log?
+  #
+  # ========================================================================= #
+  def show_the_log_file_if_it_exists(
+      log_file = THE_LOG_FILE_IS_STORED_HERE
+    )
+    if File.exist? log_file
+      opnn; e 'Displaying the content of the file at'
+      opnn; e '`'+sfile(log_file)+'`:'
+      dataset = File.readlines(log_file).map {|entry| entry.rstrip } 
+      e
+      e mediumpurple(
+          dataset.map {|entry| "  #{entry}" }.join("\n")
+        )
+    else
+      opnn; e 'No file exists at '+sfile(log_file)+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === audio_player_to_use?
+  # ========================================================================= #
+  def audio_player_to_use?
+    @audio_player_to_use
+  end; alias audio_player?           audio_player_to_use? # === audio_player?
+       alias use_which_audio_player? audio_player_to_use? # === use_which_audio_player?
+
+  # ========================================================================= #
+  # === delay?
+  # ========================================================================= #
+  def delay?
+    @delay.to_s
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # Show help here, then exit.
+  # ========================================================================= #
+  def show_help(
+      optional_shall_we_exit = false
+    )
+    cliner
+    opnn; e 'Showing the available help options next:'
+    e
+    colourized_comment '  - OPEN        # open this file in the editor'
+    colourized_comment '  - loop        # play in an eternal loop'
+    colourized_comment '  - rand        # play one random song'
+    colourized_comment '  - once        # play all songs once, then quit'
+    colourized_comment '  - last?       # show the last song played'
+    colourized_comment '  - player?     # show which multimedia-player we will use'
+    colourized_comment '  - log?        # show the log file of last-songs-played (if this file exists)'
+    colourized_comment '  - last-songs? # show the last songs that '\
+                       'were played, in a time-sorted manner'
+    e
+    cliner
+    exit_program(true, false) if optional_shall_we_exit == :then_exit
+  end
+
+  # ========================================================================= #
+  # === play_the_playlist
+  # ========================================================================= #
+  def play_the_playlist
+    if @play_in_a_loop # We wish to play in a never-ending loop.
+      counter = 0
+      loop {
+        playlist?.each {|song|
+          play_this_song(song)
+          pause unless @n_songs_played == playlist?.size
+          counter += 1
+          break if counter > @play_max_n_songs
+        }
+        refresh_playlist
+      }
+    else
+      playlist?.each {|song|
+        play_this_song(song)
+        pause unless @n_songs_played == playlist?.size
+      } # Afterwards, we will have exited.
+    end
+  end
+
+  # ========================================================================= #
+  # === register_which_song_was_last_played
+  #
+  # This method will also check if the file that is being played is too
+  # big. If it is, we will remove the log-file.
+  # ========================================================================= #
+  def register_which_song_was_last_played(
+      this_song,
+      store_where_to = the_songs_played_will_be_stored_where?
+    )
+    $stdout.flush # Unsure why we wish to do this.
+    FileUtils.touch(store_where_to) unless File.exist?(store_where_to)
+    if get_file_size(store_where_to) > MAXIMUM_ALLOWED_FILE_SIZE
+      remove_file(store_where_to)
+    end
+    unless store_where_to.include? '/'
+      store_where_to = HOME_DIRECTORY+store_where_to
+    end # store_where_to now defaults to: /root/LAST_SONG_PLAYED
+    append_what_into(this_song+N, store_where_to)
+    register_this_song(this_song)
+    # ======================================================================= #
+    # Since as of September 2021 this class will also try to store into
+    # a log file, if possible.
+    # ======================================================================= #
+    store_data_about_this_song_into_a_local_file(this_song)
+  end; alias register_which_song_will_be_played_next register_which_song_was_last_played # === register_which_song_will_be_played_next
+
+  # ========================================================================= #
+  # === show_the_last_songs_that_were_played
+  #
+  # The songs played will be stored in a .md file.
+  #
+  # Invocation example:
+  #
+  #   rsong --last-songs?
+  #
+  # ========================================================================= #
+  def show_the_last_songs_that_were_played
+    _ = the_songs_played_will_be_stored_where?
+    if File.exist? _
+      dataset = File.readlines(_)
+      dataset.each {|this_song| e steelblue(this_song.strip) }
+    else
+      e 'No file exists at '+sfile(_)+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    populate_hash_songs_played
+    show_startup_message
+    check_whether_the_song_directory_is_empty
+    play_the_playlist
+    perform_cleanup
+  end
+
+end; end