multimedia_paradise 1.1.344 → 1.2.2

data/lib/multimedia_paradise/audio/file_duration/file_duration.rb

@@ -19,6 +19,7 @@
 #
 # =========================================================================== #
 # require 'multimedia_paradise/audio/file_duration/file_duration.rb'
+# MultimediaParadise.file_duration_of
 # MultimediaParadise.duration? '/home/x/songs/WetWetWet_Loveisallaround.mp3'
 # =========================================================================== #
 require 'multimedia_paradise/audio/base.rb'
@@ -27,16 +28,49 @@ module MultimediaParadise
 
 class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::FileDuration
 
-  require 'multimedia_paradise/audio/file_duration/constants.rb'
-
   begin
     require 'hours_to_seconds'
   rescue LoadError; end
 
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === AUDIO_DIR
+  # ========================================================================= #
+  AUDIO_DIR = SONG_DIR
+
+  # ========================================================================= #
+  # === DEFAULT_SONG
+  #
+  # We can use this song here to test this class.
+  # ========================================================================= #
+  DEFAULT_SONG = "#{AUDIO_DIR}AlexGaudino_DestinationUnkown.mp3"
+
+  # ========================================================================= #
+  # === FILE_NAME
+  # ========================================================================= #
+  FILE_NAME = File.basename(__FILE__)+': '
+
+  # ========================================================================= #
+  # === DEFAULT_REPORT_ALREADY
+  #
+  # If this constant is set to true then we will automatically report
+  # information on the commandline to the user.
+  # ========================================================================= #
+  DEFAULT_REPORT_ALREADY = true
+
+  # ========================================================================= #
+  # === MAIN_REGEX
+  # ========================================================================= #
+  MAIN_REGEX = /Duration: (\d\d:\d\d:\d\d.\d\d)/
+
   # ========================================================================= #
   # === USE_THIS_REGEX
   # ========================================================================= #
-  USE_THIS_REGEX = /Duration: (\d\d:\d\d:\d\d.\d\d),/ # See: https://rubular.com/r/oTAPhuNYFTNB2w
+  USE_THIS_REGEX = /Duration: (\d\d:\d\d:\d\d.\d\d),/ # See: https://rubular.com/r/rD44DWZ6idNDK2
 
   # ========================================================================= #
   # === initialize
@@ -106,7 +140,41 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
     # ======================================================================= #
     # === @internal_hash
     # ======================================================================= #
-    @internal_hash = {}
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @use_colours
+    #
+    # Since as of May 2020 this class will make use of colours again.
+    # ======================================================================= #
+    set_use_colours
+    # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    set_be_verbose
+    # ======================================================================= #
+    # === :show_the_ffmpeg_command
+    # ======================================================================= #
+    @internal_hash[:show_the_ffmpeg_command] = false
+  end
+
+  # ========================================================================= #
+  # === do_show_the_ffmpeg_command
+  # ========================================================================= #
+  def do_show_the_ffmpeg_command
+    @internal_hash[:show_the_ffmpeg_command] = true
+  end
+
+  # ========================================================================= #
+  # === show_the_ffmpeg_command?
+  # ========================================================================= #
+  def show_the_ffmpeg_command?
+    @internal_hash[:show_the_ffmpeg_command]
+  end
+
+  # ========================================================================= #
+  # === reset_the_internal_variables
+  # ========================================================================= #
+  def reset_the_internal_variables
     # ======================================================================= #
     # === :work_on_this_file
     # ======================================================================= #
@@ -122,26 +190,16 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
     # ======================================================================= #
     @internal_hash[:may_we_exit] = true
     # ======================================================================= #
-    # === @total_duration
-    # ======================================================================= #
-    @total_duration = 0
-    # ======================================================================= #
-    # === @use_colours
-    #
-    # Since as of May 2020 this class will make use of colours again.
-    # ======================================================================= #
-    set_use_colours
-    # ======================================================================= #
-    # === :be_verbose
+    # === :total_duration
     # ======================================================================= #
-    set_be_verbose
+    @internal_hash[:total_duration] = 0
   end
 
   # ========================================================================= #
   # === total_duration?
   # ========================================================================= #
   def total_duration?
-    @total_duration
+    @internal_hash[:total_duration]
   end
 
   # ========================================================================= #
@@ -188,13 +246,6 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
     @internal_hash[:mpeg_layer]
   end
 
-  # ========================================================================= #
-  # === reset_the_internal_hash
-  # ========================================================================= #
-  def reset_the_internal_hash
-    @internal_hash.clear
-  end
-
   # ========================================================================= #
   # === determine_the_file_duration_via_ffmpeg
   #
@@ -227,7 +278,7 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
       i = '"'+i+'"'
     end
     cmd = "ffmpeg -i #{i} #{ERROR_LINE}"
-    if be_verbose
+    if be_verbose and show_the_ffmpeg_command?
       e "#{rev}The following command will be run next:"
       e
       e ::Colours.slateblue("  #{cmd}")
@@ -304,10 +355,11 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
   # ========================================================================= #
   def report_duration(
       this_file  = main_file?,
-      report_how = :verbose
+      report_how = :verbose,
+      be_verbose = be_verbose?
     ) # Can be :verbose or :compact
     length = length?
-    if be_verbose?
+    if be_verbose
       case report_how
       when :verbose
         result = rev+
@@ -319,7 +371,7 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
         if length.to_f > 60
           result = result.dup
           n_minutes = ( length.to_f / 60.0 ).round(1)
-          result << ' ('+sfancy(n_minutes.to_s+' minutes')+')'
+          result << "#{rev} (#{sfancy(n_minutes.to_s+' minutes')}#{rev})"
         end
         opne result
       else
@@ -368,7 +420,7 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
   # === reset_the_total_duration
   # ========================================================================= #
   def reset_the_total_duration
-    @total_duration = 0
+    @internal_hash[:total_duration] = 0
   end
 
   # ========================================================================= #
@@ -483,11 +535,11 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
       reset_the_total_duration # Reset it, just in case.
       _.each {|this_file|
         check_if_this_file_exists(this_file)
-        reset_the_internal_hash
+        reset_the_internal_variables
         set_work_on_this_file(this_file) # Update the main "pointer" here.
         do_analyse_this_file(this_file)
         report_duration(this_file)
-        @total_duration += duration? if duration?
+        @internal_hash[:total_duration] += duration? if duration?
       }
       report_the_total_duration
     end
@@ -541,60 +593,62 @@ class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::F
 
 end
 
-  # ========================================================================= #
-  # === MultimediaParadise.report_duration_of
-  #
-  # This module-method will report in a compact way.
-  #
-  # Usage example:
-  #
-  #   MultimediaParadise.report_duration_of('/Depot/Audio/foobar.mp3')
-  #
-  # ========================================================================= #
-  def self.report_duration_of(this_file)
-    if this_file.is_a? Array
-      this_file.each {|entry| report_duration_of(entry) }
-    else
-      _ = MultimediaParadise::FileDuration.new(this_file)
-      _.report_duration(:compact)
-    end
+# =========================================================================== #
+# === MultimediaParadise.report_duration_of
+#
+# This module-method will report in a verbose manner way.
+#
+# Usage example:
+#
+#   MultimediaParadise.report_duration_of('/Depot/Audio/foobar.mp3')
+#
+# =========================================================================== #
+def self.report_duration_of(this_file)
+  if this_file.is_a? Array
+    this_file.each {|entry| report_duration_of(entry) }
+  else
+    _ = MultimediaParadise::FileDuration.new(this_file)
+    _.do_show_the_ffmpeg_command
+    _.report_duration(:compact)
   end
+end
 
-  # ========================================================================= #
-  # === MultimediaParadise.return_duration_of_this_file
-  # ========================================================================= #
-  def self.return_duration_of_this_file(i)
-    return ::MultimediaParadise::FileDuration.return_duration_of_this_file(i)
-  end; self.instance_eval { alias duration?        return_duration_of_this_file } # === MultimediaParadise.duration?
-       self.instance_eval { alias length_of?       return_duration_of_this_file } # === MultimediaParadise.length_of?
-       self.instance_eval { alias file_duration_of return_duration_of_this_file } # === MultimediaParadise.file_duration_of
+# =========================================================================== #
+# === MultimediaParadise.return_duration_of_this_file
+# =========================================================================== #
+def self.return_duration_of_this_file(i)
+  return ::MultimediaParadise::FileDuration.return_duration_of_this_file(i)
+end; self.instance_eval { alias duration?        return_duration_of_this_file } # === MultimediaParadise.duration?
+     self.instance_eval { alias length_of?       return_duration_of_this_file } # === MultimediaParadise.length_of?
+     self.instance_eval { alias file_duration_of return_duration_of_this_file } # === MultimediaParadise.file_duration_of
 
-  # ========================================================================= #
-  # === MultimediaParadise.file_duration_of
-  #
-  # This method will return, as number, the file duration of e. g. an
-  # audio file. Other than that it is silent, so it will not output
-  # anything on the commandline.
-  #
-  # Usage example:
-  #
-  #   require 'multimedia_paradise/multimedia/file_duration.rb'
-  #
-  #   MultimediaParadise.duration? '/home/x/songs/WetWetWet_Loveisallaround.mp3'
-  #   MultimediaParadise.length_of?('/home/x/songs/Veracocha_CarteBlancha.mp3')
-  #
-  # ========================================================================= #
-  def self.file_duration_of(i)
-    duration = ::MultimediaParadise::FileDuration.new(i) {
-      :be_quiet_and_we_may_not_exit
-    }.duration?
-    return duration
-  end
+# =========================================================================== #
+# === MultimediaParadise.file_duration_of
+#
+# This method will return, as number, the file duration of e. g. an
+# audio file. Other than that it is silent, so it will not output
+# anything on the commandline.
+#
+# Usage example:
+#
+#   require 'multimedia_paradise/multimedia/file_duration.rb'
+#
+#   MultimediaParadise.duration? '/home/x/songs/WetWetWet_Loveisallaround.mp3'
+#   MultimediaParadise.length_of?('/home/x/songs/Veracocha_CarteBlancha.mp3')
+#
+# =========================================================================== #
+def self.file_duration_of(i)
+  duration = ::MultimediaParadise::FileDuration.new(i) {
+    :be_quiet_and_we_may_not_exit
+  }.duration?
+  return duration
+end
 
 end
 
 if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::FileDuration.new(ARGV)
+  alias e puts
+  MultimediaParadise.file_duration_of(ARGV)
   #_.report_duration # By default we will report in n seconds.
   # puts MultimediaParadise::FileDuration.new(ARGV[0]).duration
 end # duration /Depot/Test/073_Inception.avi
@@ -602,5 +656,5 @@ end # duration /Depot/Test/073_Inception.avi
     # duration /Depot/Downloads/Beethoven_Symphony7.flv.mp3
     # duration "/Downloads/Married.With.Children.Season.5(UKB-RG-BINGOWINGZ)/S05E10.avi"
     # duration bloodsport.avi
-    # duration /Depot/Audio/WolfgangAmbros_ZwicktsMi.mp3
-    # duration /Depot/j/foobar.mp3
+    # duration /Depot/j/foobar.mp3
+    # duration /home/x/songs/HansZimmer_LastSamurai_RoebeMix.mp3

data/lib/multimedia_paradise/audio/genres/boogie.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class Boogie < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,7 +19,7 @@ class Boogie < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(BOOGIE_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 

data/lib/multimedia_paradise/audio/genres/concerts.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class Concerts < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,7 +19,7 @@ class Concerts < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(CONCERTS_SONGS_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 

data/lib/multimedia_paradise/audio/genres/constants.rb

@@ -13,7 +13,7 @@ module Genres # === MultimediaParadise::Genres
   # ========================================================================= #
   # === GENRE_DIR
   # ========================================================================= #
-  GENRE_DIR = "#{::MultimediaParadise.project_yaml_dir?}genres/"
+  GENRE_DIR = "#{MultimediaParadise.project_yaml_dir?}genres/"
 
   # ========================================================================= #
   # === TRANCE_FILE

data/lib/multimedia_paradise/audio/genres/eurodance.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class Eurodance < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,7 +19,7 @@ class Eurodance < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(EURODANCE_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 

data/lib/multimedia_paradise/audio/genres/genre.rb

@@ -53,11 +53,6 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
   # ========================================================================= # 
   DEFAULT_FILE = MultimediaParadise::Genres::EURODANCE_FILE
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -82,8 +77,7 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
     # === @dataset
     # ======================================================================= #
     @dataset = nil
-    set_commandline_arguments
-    set_namespace
+    infer_the_namespace
   end
 
   # ========================================================================= #
@@ -118,22 +112,6 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
     e sfile(@yaml_file)
   end
 
-  # ========================================================================= #
-  # === set_commandline_arguments
-  # ========================================================================= #
-  def set_commandline_arguments(i = DEFAULT_FILE)
-    i = [i] unless i.is_a? Array
-    i = [DEFAULT_FILE] if i.compact.empty?
-    @commandline_arguments = i
-  end
-
-  # ========================================================================= #
-  # === set_namespace
-  # ========================================================================= #
-  def set_namespace(i = NAMESPACE)
-    @namespace = i
-  end
-
   # ========================================================================= #
   # === open_playlist_in_your_editor
   #
@@ -160,13 +138,24 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
     rescue ArgumentError # This clause happens when syck raises an error.
       @dataset = File.read(_)
     rescue Exception => error
-      opnn; e 'An error happened on line '+__LINE__.to_s+'.'
+      opne 'An error happened on line '+__LINE__.to_s+'.'
       pp error
       pp error.class
     end
     sanitize_yaml_dataset # Must sanitize it.
   end
 
+  # ========================================================================= #
+  # === files?
+  #
+  # This method will return all remote files, aka URLs, in particular to
+  # youtube files. The user can then create a playlist from this or
+  # batch-download these files.
+  # ========================================================================= #
+  def files?
+    dataset?.values.map {|entry| entry[1] }
+  end
+
   # ========================================================================= #
   # === sanitize_yaml_dataset
   # ========================================================================= #
@@ -346,7 +335,7 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
     # ======================================================================= #
     _ = use_this_dataset # We assume that this will always be a Hash.
     n_entries = _.keys.size
-    opnn; e simp(n_entries.to_s)+' entries were registered in the yaml file.'
+    opne simp(n_entries.to_s)+' entries were registered in the yaml file.'
     e
     _.each_pair.with_index {|inner_hash, index|
       key, _array = *inner_hash
@@ -439,12 +428,19 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
     @dataset
   end; alias full_dataset? dataset? # === full_dataset?
 
+  # ========================================================================= #
+  # === set_dataset
+  # ========================================================================= #
+  def set_dataset(i)
+    @dataset = i
+  end
+
   # ========================================================================= #
   # === return_all_remote_urls
   # ========================================================================= #
   def return_all_remote_urls
-    dataset = @dataset
-    dataset = dataset.map {|key, inner_array|
+    dataset = dataset?
+    dataset.map! {|key, inner_array|
       inner_array[1] # This is the URL.
     }
     return dataset
@@ -497,7 +493,7 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
       _ = dataset
       key = _.keys.first
       name_of_the_group = _[key][0]
-      opnn; e
+      opne
       e '  Now downloading the song '+dodgerblue(name_of_the_song)+
         ' (Group: '+simp(name_of_the_group)+') from the URL '+sfancy(url)
       name_of_the_song = key.to_s.delete('!')
@@ -524,8 +520,8 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
       _ = name_of_the_group.tr(' ','_')+'-'+name_of_the_song.tr(' ','_')+
           '_Year_'+release_year+extension_name
       mv(new_file_name, _)
-      opnn; e 'The file name now is `'+sfile(_)+'`, in the '\
-              'directory `'+sdir(store_here)+'`.'
+      opne rev+'The file name now is `'+sfile(_)+rev+'`, in the '\
+           'directory `'+sdir(store_here)+rev+'`.'
     } 
   end; alias download_remote_file download_remote_files # === download_remote_file
 
@@ -533,7 +529,9 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
   # === download_file_at_number
   #
   # Invocation example:
+  #
   #   eurodance 62
+  #
   # ========================================================================= #
   def download_file_at_number(i)
     i = i.to_i
@@ -671,7 +669,7 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
     # ======================================================================= #
     into = self.class.inspect.to_s.split(':').last.downcase
     into = log_dir?+into+'.html'
-    opnn; e "Now storing into the file `#{sfile(into)}`."
+    opne "#{rev}Now storing into the file `#{sfile(into)}#{rev}`."
     write_what_into(_, into)
   end
 
@@ -685,12 +683,17 @@ class Genre < ::MultimediaParadise::Base # === MultimediaParadise::Eurodance
   # ========================================================================= #
   # === MultimediaParadise::Genre[]
   # ========================================================================= #
-  def self.[](i = '')
+  def self.[](i = ARGV)
     new(i)
   end
 
 end; end
 
 if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::Genre.new(ARGV)
+  alias e puts
+  genre = MultimediaParadise::Genre.new(ARGV)
+  e 'Debugging output:'
+  e
+  pp genre
+  e
 end # genre

data/lib/multimedia_paradise/audio/genres/hip_hop.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class HipHop < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,7 +19,7 @@ class HipHop < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(HIP_HOP_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 

data/lib/multimedia_paradise/audio/genres/italian_songs.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class ItalianSongs < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,7 +19,7 @@ class ItalianSongs < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(ITALIAN_SONGS_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 

data/lib/multimedia_paradise/audio/genres/the_1980s.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class The1980s < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,7 +19,7 @@ class The1980s < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(THE_1980s_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 

data/lib/multimedia_paradise/audio/genres/trance.rb

@@ -10,11 +10,6 @@ module MultimediaParadise
 
 class Trance < ::MultimediaParadise::Genre
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
@@ -24,12 +19,14 @@ class Trance < ::MultimediaParadise::Genre
     )
     super(i, run_already)
     set_yaml_file(TRANCE_FILE)
-    set_namespace(NAMESPACE)
+    infer_the_namespace
     run
   end
 
 end; end
 
 if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::Trance.new(ARGV)
+  alias e puts
+  trance = MultimediaParadise::Trance.new(ARGV)
+  e; trance.files?.each {|entry| e "  #{entry}" }; e
 end # trance