multimedia_paradise 1.1.344 → 1.2.2

data/lib/multimedia_paradise/audio/lyrics_fetcher.rb

@@ -2,14 +2,14 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === MultimediaParadise::LyricsFetcher
+# === MultimediaParadise::Audio::LyricsFetcher
 #
 # This class will fetch the lyrics file, then group the lyrics into
 # subsections, then return a proper match if it can.
 #
 # Usage example:
 #
-#   _ = MultimediaParadise::LyricsFetcher.new
+#   _ = MultimediaParadise::Audio::LyricsFetcher.new
 #   _.search_for 'Luca' #
 #
 # =========================================================================== #
@@ -19,7 +19,9 @@ require 'multimedia_paradise/base/base.rb'
 
 module MultimediaParadise
 
-class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::LyricsFetcher
+module Audio
+
+class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::Audio::LyricsFetcher
 
   # ========================================================================= #
   # === SEARCH_TERM
@@ -60,6 +62,9 @@ class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::LyricsF
       i = i.join(' ').strip
     end
     case i
+    # ======================================================================= #
+    # === nil
+    # ======================================================================= #
     when nil, :default
       i = SEARCH_TERM
     end
@@ -77,11 +82,11 @@ class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::LyricsF
   # === show_help                                                  (help tag)
   # ========================================================================= #
   def show_help
-    opnn; e 'These options are available:'
+    opne 'These options are available:'
     e
-    opnn; e '  --file?            # Feedback the full path to the .yml '\
-            'file in question'
-    opnn; e '  --available_titles # Feedback the available titles'
+    opne '  --file?            # Feedback the full path to the .yml '\
+         'file in question'
+    opne '  --available_titles # Feedback the available titles'
     e
   end
 
@@ -162,25 +167,13 @@ class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::LyricsF
       entry.downcase.include? i.downcase
     }
     if possible_matches.empty?
-      opnn; e 'Did not find that particular key.'
+      opne 'Did not find that particular key.'
     else
       @hash[:text] = _[possible_matches.first]
       report(@hash[:text])
     end
   end
 
-  # ========================================================================= #
-  # === report
-  # ========================================================================= #
-  def report(this = @hash[:text])
-    # ======================================================================= #
-    # Ok, we found it, so display it next:
-    # ======================================================================= #
-    cliner colour: :konsole_slateblue
-    e this
-    cliner colour: :konsole_slateblue
-  end
-
   # ========================================================================= #
   # === show_file_path
   # ========================================================================= #
@@ -221,6 +214,18 @@ class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::LyricsF
     end
   end
 
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(this = @hash[:text])
+    # ======================================================================= #
+    # Ok, we found it, so display it next:
+    # ======================================================================= #
+    cliner colour: :konsole_slateblue
+    e this
+    cliner colour: :konsole_slateblue
+  end
+
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #
@@ -230,9 +235,9 @@ class LyricsFetcher < MultimediaParadise::Base # === MultimediaParadise::LyricsF
     fetch_subsections_from_dataset
   end
 
-end; end
+end; end; end
 
 if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::LyricsFetcher.new(ARGV)
+  MultimediaParadise::Audio::LyricsFetcher.new(ARGV)
 end # lyrics
     # lyrics Michel Telo

data/lib/multimedia_paradise/audio/merge_audio_files.rb

@@ -2,7 +2,7 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === MultimediaParadise::MergeAudioFiles
+# === MultimediaParadise::Audio::MergeAudioFiles
 #
 # This class can be used to merge together several audio files.
 #
@@ -13,7 +13,7 @@
 #
 # Usage example:
 #
-#   MultimediaParadise::MergeAudioFiles.new(ARGV)
+#   MultimediaParadise::Audio::MergeAudioFiles.new(ARGV)
 #
 # =========================================================================== #
 # require 'multimedia_paradise/audio/merge_audio_files.rb'
@@ -22,7 +22,9 @@ require 'multimedia_paradise/audio/base.rb'
 
 module MultimediaParadise
 
-class MergeAudioFiles < ::MultimediaParadise::AudioBase # === MultimediaParadise::MergeAudioFiles
+module Audio
+
+class MergeAudioFiles < ::MultimediaParadise::AudioBase # === MultimediaParadise::Audio::MergeAudioFiles
 
   require 'multimedia_paradise/multimedia/merge_multimedia.rb'
 
@@ -76,10 +78,10 @@ class MergeAudioFiles < ::MultimediaParadise::AudioBase # === MultimediaParadise
     if _.empty?
       _ = Dir['**/**'].select {|entry| is_an_audio_file?(entry) }
       unless _.empty?
-        opnn; e 'No specific argument was provided. We will thus '+steelblue('scan for')
-        opnn; e steelblue('all audio files in this directory and all subdirectories')+
-                ' to it'
-        opnn; e 'and then merge these together into a new file.'
+        opne 'No specific argument was provided. We will thus '+steelblue('scan for')
+        opne steelblue('all audio files in this directory and all subdirectories')+
+             ' to it'
+        opne 'and then merge these together into a new file.'
       end
     end
     add(_)
@@ -95,20 +97,25 @@ class MergeAudioFiles < ::MultimediaParadise::AudioBase # === MultimediaParadise
     )
     output_file = result.output_file?
     if File.exist? output_file
-      opnn; e "Merged into the file #{sfile(output_file)}."
+      opne "#{rev}Merged into the file #{sfile(output_file)}#{rev}."
     end
   end
 
   # ========================================================================= #
-  # === MultimediaParadise::MergeAudioFiles[]
+  # === MultimediaParadise::Audio::MergeAudioFiles[]
   # ========================================================================= #
-  def self.[](i = '')
+  def self.[](i = ARGV)
     new(i)
   end
 
 end; end
 
+def self.merge_audio_files(i = ARGV)
+end
+
+end
+
 if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::MergeAudioFiles.new(ARGV)
+  MultimediaParadise::Audio::MergeAudioFiles.new(ARGV)
 end # mergeaudiofiles
     # mergeaudiofiles a.mp3 b.mp3 c.mp3

data/lib/multimedia_paradise/audio/modify_year_of_audio_file.rb

@@ -12,6 +12,7 @@
 #
 # =========================================================================== #
 # require 'multimedia_paradise/audio/modify_year_of_audio_file.rb'
+# MultimediaParadise.modify_year_of_audio_file
 # =========================================================================== #
 require 'multimedia_paradise/audio/base.rb'
 
@@ -31,6 +32,9 @@ class ModifyYearOfAudioFile < ::MultimediaParadise::AudioBase # === MultimediaPa
     reset
     set_commandline_arguments(i)
     case run_already
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
     when :dont_run_yet,
          :do_not_run_yet
       run_already = false
@@ -47,28 +51,32 @@ class ModifyYearOfAudioFile < ::MultimediaParadise::AudioBase # === MultimediaPa
   end
 
   # ========================================================================= #
-  # === check_commandline
+  # === check_the_commandline
   # ========================================================================= #
-  def check_commandline
-    if @commandline_arguments.empty?
-      opnn; e 'Please provide to what year you want to set this.'
+  def check_the_commandline(
+      i = commandline_arguments?
+    )
+    if i.empty?
+      opne "#{rev}Please provide the year that should be used for the file."
       e
-      e 'Example:'
+      e 'Usage examples for this:'
       e
       e '  --year 2005'
+      e '  modifyyear foobar.mp3 --year 2005'
+      e '  modifyyear /home/x/songs/VincentDeMoor_EternityForever.mp3 2000'
       e
     else
       determine_the_year
       modify_the_year
     end
-  end
+  end; alias check_commandline check_the_commandline # === check_commandline 
 
   # ========================================================================= #
   # === determine_the_year
   # ========================================================================= #
   def determine_the_year
     set_year(
-      @commandline_arguments[1]
+      commandline_arguments?[1]
     )
   end
 
@@ -76,10 +84,13 @@ class ModifyYearOfAudioFile < ::MultimediaParadise::AudioBase # === MultimediaPa
   # === modify_the_year
   # ========================================================================= #
   def modify_the_year
-    name_of_the_file = @commandline_arguments.first
+    name_of_the_file = first?
     if File.exist? name_of_the_file
+      # ===================================================================== #
+      # mid3v2 is part of "mutagen".
+      # ===================================================================== #
       _ = "mid3v2 --year=#{year?} #{name_of_the_file}"
-      opnn; e "Now modifying the file `#{sfile(name_of_the_file)}`."
+      opne "#{rev}Now modifying the file `#{sfile(name_of_the_file)}#{rev}`."
       esystem _
     else
       opnn; no_file_exists_at(name_of_the_file)
@@ -105,7 +116,7 @@ class ModifyYearOfAudioFile < ::MultimediaParadise::AudioBase # === MultimediaPa
   # === run                                                         (run tag)
   # ========================================================================= #
   def run
-    check_commandline
+    check_the_commandline
   end
 
   # ========================================================================= #
@@ -133,4 +144,5 @@ end
 
 if __FILE__ == $PROGRAM_NAME
   MultimediaParadise::Audio::ModifyYearOfAudioFile.new(ARGV)
-end # modify_year_of_audio_file /Depot/j/foobar.mp3 2012
+end # modifyyear /Depot/j/foobar.mp3 2012
+    # modifyyear /home/x/songs/VincentDeMoor_EternityForever.mp3 2000

data/lib/multimedia_paradise/audio/n_audio_songs.rb

@@ -13,6 +13,7 @@
 #
 # =========================================================================== #
 # require 'multimedia_paradise/audio/n_audio_songs.rb'
+# MultimediaParadise::Audio::NAudioSongs.new(ARGV)
 # =========================================================================== #
 require 'multimedia_paradise/audio/base.rb'
 
@@ -153,8 +154,8 @@ class NAudioSongs < ::MultimediaParadise::AudioBase # === MultimediaParadise::Au
   # === notify_the_user_what_will_be_done
   # ========================================================================= #
   def notify_the_user_what_will_be_done
-    opnn; e "Now storing into #{sfile(STORE_HERE)} that there are"
-    opnn; e sfancy(n_songs_available)+' songs available.'
+    opne "#{rev}Now storing into #{sfile(STORE_HERE)} #{rev}that there are"
+    opne "#{sfancy(n_songs_available)}#{rev} songs available."
   end
 
   # ========================================================================= #

data/lib/multimedia_paradise/audio/play_all_audio_files.rb

@@ -2,18 +2,23 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === MultimediaParadise::PlayAllAudioFiles
+# === MultimediaParadise::Audio::PlayAllAudioFiles
 #
 # Use this class to play all audio files from the target directory.
 #
 # The target directory, in this context, defaults to the current
 # working directory by default.
 # =========================================================================== #
+# require 'multimedia_paradise/audio/play_all_audio_files.rb'
+# MultimediaParadise.play_all_audio_files(ARGV)
+# =========================================================================== #
 require 'multimedia_paradise/audio/base.rb'
 
 module MultimediaParadise
 
-class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
+module Audio
+
+class PlayAllAudioFiles < ::MultimediaParadise::AudioBase # === MultimediaParadise::Audio::PlayAllAudioFiles
 
   # ========================================================================= #
   # === IGNORE_FILES_THAT_HAVE_THE_SUBSTRING_DONE
@@ -27,7 +32,7 @@ class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
   # audio files from.s
   # ========================================================================= #
   def initialize(
-      from_this_directory = Dir.pwd,
+      from_this_directory = return_pwd,
       run_already         = true
     )
     reset
@@ -47,17 +52,26 @@ class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
     # ======================================================================= #
     @audio_files = nil
     # ======================================================================= #
-    # === @use_colours
+    # === :use_colours
     # ======================================================================= #
-    @use_colours = true
+    set_use_colours
   end
 
   # ========================================================================= #
   # === set_this_directory
   # ========================================================================= #
-  def set_this_directory(i = ARGV)
+  def set_this_directory(
+      i = :default
+    )
     i = i.first if i.is_a? Array
-    i = Dir.pwd if i.nil?
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default,
+         nil
+      i = return_pwd
+    end
     i << '/' unless i.end_with? '/'
     @this_directory = i
   end
@@ -65,8 +79,10 @@ class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
   # ========================================================================= #
   # === obtain_all_audio_files
   # ========================================================================= #
-  def obtain_all_audio_files
-    @audio_files = Dir['*'].select {|file|
+  def obtain_all_audio_files(
+      from_this_directory = '*'
+    )
+    @audio_files = Dir[from_this_directory].select {|file|
       is_audio_file?(file)
     }
     if IGNORE_FILES_THAT_HAVE_THE_SUBSTRING_DONE # Ignore files with the "DONE_" substring.
@@ -84,11 +100,11 @@ class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
   end
 
   # ========================================================================= #
-  # === play_this_audio_file(file)
+  # === play_this_audio_file
   # ========================================================================= #
-  def play_this_audio_file(file)
-    use_this_command = 'mplayer '+file
-    cliner { e orange(use_this_command) }
+  def play_this_audio_file(this_file)
+    use_this_command = "#{use_which_audio_player?} #{this_file}"
+    cliner { e olivedrab(use_this_command) }
     system use_this_command
   end
 
@@ -107,7 +123,7 @@ class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
   end
 
   # ========================================================================= #
-  # === run
+  # === run                                                         (run tag)
   # ========================================================================= #
   def run
     obtain_all_audio_files
@@ -117,6 +133,15 @@ class PlayAllAudioFiles < ::MultimediaParadise::AudioBase
 
 end; end
 
+# =========================================================================== #
+# === MultimediaParadise.play_all_audio_files
+# =========================================================================== #
+def self.play_all_audio_files(i = ARGV)
+  MultimediaParadise::Audio::PlayAllAudioFiles.new(i)
+end
+
+end
+
 if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::PlayAllAudioFiles.new(ARGV)  
-end # play_all_audio_files
+  MultimediaParadise::Audio::PlayAllAudioFiles.new(ARGV)  
+end # playallaudiofiles