multimedia_paradise 1.1.314

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

@@ -0,0 +1,602 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::FileDuration
+#
+# This class can be used to find out the duration of a video or 
+# audio file.
+# 
+# It will store this information in the variable:
+#
+#   @file_duration
+#
+# As of 03.09.2014 ffmpeg will be used for .mp3 files.
+# =========================================================================== #
+# Usage example:
+#
+#   MultimediaParadise::FileDuration[i]
+#
+# =========================================================================== #
+# require 'multimedia_paradise/audio/file_duration/file_duration.rb'
+# MultimediaParadise.duration? '/home/x/songs/WetWetWet_Loveisallaround.mp3'
+# =========================================================================== #
+require 'multimedia_paradise/audio/base.rb'
+require 'multimedia_paradise/audio/file_duration/constants.rb'
+
+module MultimediaParadise
+
+class FileDuration < ::MultimediaParadise::AudioBase # === MultimediaParadise::FileDuration
+
+  begin
+    require 'hours_to_seconds'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === USE_THIS_REGEX
+  # ========================================================================= #
+  USE_THIS_REGEX = /Duration: (\d\d:\d\d:\d\d.\d\d),/ # See: https://rubular.com/r/oTAPhuNYFTNB2w
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The 
+  # The second argument can be :do_not_report_already.
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = DEFAULT_REPORT_ALREADY, # ← This is usually false by default.
+      &block
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_exit
+      # ===================================================================== #
+      when :do_not_exit
+        do_not_exit
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet
+        set_be_quiet
+      # ===================================================================== #
+      # === :be_quiet_and_we_may_not_exit
+      # ===================================================================== #
+      when :be_quiet_and_we_may_not_exit
+        set_be_quiet
+        we_may_not_exit
+      end
+    end
+    # ======================================================================= #
+    # Test whether they are the same.
+    # ======================================================================= #
+    case run_already # case tag
+    # ======================================================================= #
+    # === :do_not_run_yet
+    # ======================================================================= #
+    when :do_not_run_yet
+      run_already = false
+    # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    when :be_verbose
+      set_be_verbose
+    when :do_not_report_already,
+         :do_not_exit
+      do_not_exit
+      run_already = DEFAULT_REPORT_ALREADY
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :work_on_this_file
+    # ======================================================================= #
+    @internal_hash[:work_on_this_file] = nil
+    # ======================================================================= #
+    # === :file_duration
+    #
+    # This variable will contain the duration of the .mp3 file at hand.
+    # ======================================================================= #
+    @internal_hash[:file_duration] = 0
+    # ======================================================================= #
+    # === :may_we_exit
+    # ======================================================================= #
+    @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
+    # ======================================================================= #
+    set_be_verbose
+  end
+
+  # ========================================================================= #
+  # === total_duration?
+  # ========================================================================= #
+  def total_duration?
+    @total_duration
+  end
+
+  # ========================================================================= #
+  # === do_not_exit
+  # ========================================================================= #
+  def do_not_exit
+    @internal_hash[:may_we_exit] = false
+  end; alias we_may_not_exit do_not_exit # === we_may_not_exit
+
+  # ========================================================================= #
+  # === may_we_exit?
+  # ========================================================================= #
+  def may_we_exit?
+    @internal_hash[:may_we_exit]
+  end
+
+  # ========================================================================= #
+  # === set_file_duration
+  #
+  # This must be stored as a float, hence why .to_f is used.
+  # ========================================================================= #
+  def set_file_duration(i)
+    @internal_hash[:file_duration] = i.to_f
+  end
+  
+  # ========================================================================= #
+  # === set_work_on_this_file
+  # ========================================================================= #
+  def set_work_on_this_file(this_file)
+    @internal_hash[:work_on_this_file] = this_file
+  end
+
+  # ========================================================================= #
+  # === work_on_this_file?
+  # ========================================================================= #
+  def work_on_this_file?
+    @internal_hash[:work_on_this_file]
+  end; alias main_file? work_on_this_file? # === main_file?
+
+  # ========================================================================= #
+  # === mpeg_layer?
+  # ========================================================================= #
+  def mpeg_layer?
+    @internal_hash[:mpeg_layer]
+  end
+
+  # ========================================================================= #
+  # === reset_the_internal_hash
+  # ========================================================================= #
+  def reset_the_internal_hash
+    @internal_hash.clear
+  end
+
+  # ========================================================================= #
+  # === determine_the_file_duration_via_ffmpeg
+  #
+  # This method should be able to handle all file extensions, thanks to
+  # ffmpeg - in particular 'mp3','mp4','m4a','m4v','avi','wav','ogg'
+  # and 'flv'
+  #
+  # We must scan for a String such as:
+  #
+  #   "Duration: 00:03:27.31, start: 0.000000, bitrate: 192 kb/s"
+  #
+  # ========================================================================= #
+  def determine_the_file_duration_via_ffmpeg(
+      i,
+      be_verbose = be_verbose?
+    )
+    # ======================================================================= #
+    # Next check for ' ' characters, for the assumed file (stored in `i`).
+    # If ' ' were found then '"' will be used as padding around these
+    # characters.
+    # ======================================================================= #
+    if i.include? ' '
+      i = i.to_s.dup
+      i = '"'+i+'"'
+    end
+    # ======================================================================= #
+    # The next clause handles cases such as: "Kaneda's_Theme"
+    # ======================================================================= #
+    if i.include? "'"  
+      i = '"'+i+'"'
+    end
+    cmd = "ffmpeg -i #{i} #{ERROR_LINE}"
+    if be_verbose
+      e "#{rev}The following command will be run next:"
+      e
+      e ::Colours.slateblue("  #{cmd}")
+      e
+    end
+    result = `#{cmd}`
+    
+    if result.include? 'command not found' # Check here whether we have installed ffmpeg or not.
+      report_that_ffmpeg_was_not_found
+      exit
+    else
+      if result.include? 'command not found' # Check here whether we have installed ffmpeg or not.
+        report_that_ffmpeg_was_not_found
+      else
+        result =~ USE_THIS_REGEX
+        _ = $1.to_s.dup
+        if $1 and _ and !_.empty?
+          # ===================================================================== #
+          # Must convert the format given in _ into seconds next:
+          # ===================================================================== #
+          hours = HoursToSeconds.new(_, :be_silent)
+          result = hours.n_seconds
+          set_file_duration(result)
+          return result
+        else
+          opne rev+'The duration could not be determined.'
+          raise_error if file_duration? == 0 # since as of July 2011.
+          return nil
+        end
+      end
+    end
+  end; alias use_ffmpeg_to_parse_this_mp3_file determine_the_file_duration_via_ffmpeg # === use_ffmpeg_to_parse_this_mp3_file
+
+  # ========================================================================= #
+  # === raise_error
+  # ========================================================================= #
+  def raise_error
+    # raise '@file_duration for '+@file+' is nil.'
+    ewarn 'From '+FILE_NAME+'file_duration for '
+    ewarn '   -> '+files?.first
+    ewarn ' is nil.'
+    e 'Showing the caller() stack:'
+    e
+    pp caller()
+    e
+  end
+
+  # ========================================================================= #
+  # === determine_the_mpeg_layer
+  # ========================================================================= #
+  def determine_the_mpeg_layer(i)
+    result = ::MultimediaParadise.return_the_mpeg_layer_from_this_mp3_file(i)
+    @internal_hash[:mpeg_layer] = result
+  end
+
+  # ========================================================================= #
+  # === report_that_ffmpeg_was_not_found
+  # ========================================================================= #
+  def report_that_ffmpeg_was_not_found
+    e 'It seems as if you have not installed ffmpeg. Please install'
+    e 'it - otherwise this class can not work properly. Thank you.'
+  end
+
+  # ========================================================================= #
+  # === report_duration                                             (run tag)
+  #
+  # We provide two basic ways to output the result in this method:
+  #
+  #   (1) The default way will show the amount of seconds on a new line
+  #   (2) The compact (terse) variant will show everything on one line
+  #
+  # Option (2) was necessary because some other programs also report
+  # everything on the same line.
+  # ========================================================================= #
+  def report_duration(
+      this_file  = main_file?,
+      report_how = :verbose
+    ) # Can be :verbose or :compact
+    length = length?
+    if be_verbose?
+      case report_how
+      when :verbose
+        result = rev+
+                 'The duration of the file `'+
+                 sfile(this_file)+rev+'` is:'+N+
+                 '  '+simp(length)+rev+' seconds.'+rev
+        if length.to_f > 60
+          result = result.dup
+          n_minutes = ( length.to_f / 60.0 ).round(1)
+          result << ' ('+sfancy(n_minutes.to_s+' minutes')+')'
+        end
+        opne result
+      else
+        opne rev+
+             'The duration of the file `'+sfile(this_file.first)+
+             rev+'` is:  '+simp(length.to_s)+rev+' seconds.'+rev
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === report_the_total_duration
+  # ========================================================================= #
+  def report_the_total_duration(
+      i = total_duration?
+    )
+    _ = commandline_arguments?
+    if _.size > 1
+      e
+      e 'The total duration of these '+_.size.to_s+' files is '+
+        steelblue(i.to_s).to_s+' seconds.'
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_exiting
+  # ========================================================================= #
+  def consider_exiting # We exit only if we are allowed to exit.
+    exit(2) if may_we_exit?
+  end
+
+  # ========================================================================= #
+  # === one_percent
+  #
+  # This method gives us back how many seconds one percent are.
+  # ========================================================================= #
+  def one_percent(
+      file_duration = file_duration?
+    )
+    return ( file_duration.to_f / 100.0 )
+  end
+
+  # ========================================================================= #
+  # === reset_the_total_duration
+  # ========================================================================= #
+  def reset_the_total_duration
+    @total_duration = 0
+  end
+
+  # ========================================================================= #
+  # === file_duration?
+  #
+  # This method will return the duration of the multimedia file at hand.
+  # For instance, a local .mp3 file may have a duration of "180 seconds",
+  # in which case this method should return the file_duration stored as
+  # a Float. The setter-method set_file_duration() ensures this.
+  # ========================================================================= #
+  def file_duration?
+    @internal_hash[:file_duration]
+  end; alias length?        file_duration? # === length?
+       alias seconds        file_duration? # === seconds
+       alias n_seconds?     file_duration? # === n_seconds?
+       alias file_duration  file_duration? # === file_duration
+       alias duration?      file_duration? # === duration?
+       alias duration       file_duration? # === duration
+
+  # ========================================================================= #
+  # === duration_as_string?
+  #
+  # This method will always return a String representation. If you
+  # need a Float, you can either use the method called .duration? or
+  # simply convert the String into a Float via .to_f.
+  # ========================================================================= #
+  def duration_as_string?
+    duration?.to_s
+  end; alias duration_as_string duration_as_string? # === duration_as_string
+  
+  # ========================================================================= #
+  # === MultimediaParadise::FileDuration[]
+  #
+  # This is a class method - it works on class FileDuration.
+  #
+  # Usage example:
+  #
+  #   MultimediaParadise::FileDuration["/home/x/songs/Veracocha_CarteBlancha.mp3"]
+  #
+  # ========================================================================= #
+  def self.[](
+      i,
+      run_already = :do_not_report_already,
+      &block
+    )
+    _ = new(i, run_already, &block)
+    return _.length?
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::FileDuration.total_time_of
+  #
+  # This method can be used to quickly return the total duration of
+  # different multimedia files (audio files and video files), in
+  # n seconds. The method expects an Array as input.
+  #
+  # If, for example, you provide three files as input, having the
+  # duration 1 second, 2 seconds and 3 seconds, then this method
+  # here will return a number, being 6 in this example - 6 standing
+  # for 6 seconds, obviously.
+  #
+  # Invocation example:
+  #
+  #   array = %w( /home/x/songs/Zucchero_SenzaUnaDonna.mp3 /home/x/songs/ZombieNation_KernkraftRemix.mp3 )
+  #   MultimediaParadise::FileDuration.total_time_of(array)
+  #
+  # ========================================================================= #
+  def self.total_time_of(i)
+    if i.is_a? Array
+      result = i.dup
+      result.map! {|entry|
+        duration = 0
+        if entry and entry.include?("'")
+          entry = '"'+entry+'"'
+        end
+        if entry and File.exist?(entry)
+          # ================================================================= #
+          # If the file exist then we can query the duration.
+          # ================================================================= #
+          duration = MultimediaParadise::FileDuration.return_duration_of_this_file(entry)
+        end
+        duration.to_f # return the duration here, as a float though.
+      }
+      return result.sum
+    else
+      e 'Please provide an Array as input to this method.'
+    end
+  end
+
+  # ========================================================================= #
+  # === check_if_this_file_exists
+  # ========================================================================= #
+  def check_if_this_file_exists(i)
+    if i.is_a? Array
+      i.each {|entry| check_if_this_file_exists(entry) }
+    else
+      unless File.exist? i
+        e swarn('The file at `')+
+          sfile(i)+
+          swarn('` does not exist.')
+        consider_exiting
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = commandline_arguments?
+    unless _.empty?
+      reset_the_total_duration # Reset it, just in case.
+      _.each {|this_file|
+        check_if_this_file_exists(this_file)
+        reset_the_internal_hash
+        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?
+      }
+      report_the_total_duration
+    end
+  end
+
+  # ========================================================================= #
+  # === do_analyse_this_file
+  # ========================================================================= #
+  def do_analyse_this_file(i)
+    extname = File.extname(i)
+    extname_without_dots = extname.delete('.')
+    case extname_without_dots # case tag
+    # ======================================================================= #
+    # === mp3
+    #
+    # We determine the MPEG layer only for .mp3 files.
+    # ======================================================================= #
+    when 'mp3'
+      determine_the_mpeg_layer(i)
+    else
+      case extname_without_dots
+      when 'mp4',
+           'm4v',
+           'wav',
+           'ogg',
+           'flac',
+           'aac',
+           'mpg'
+        # pass through in this case.
+      else
+        e 'Unhandled file type: '+
+          steelblue(extname)
+        return
+      end
+    end
+    # ======================================================================= #
+    # We will always try to let ffmpeg determine the file's duration.
+    # ======================================================================= #
+    determine_the_file_duration_via_ffmpeg(i)
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::FileDuration.return_duration_of_this_file
+  #
+  # This will simply return the duration, while being silent about it.
+  # ========================================================================= #
+  def self.return_duration_of_this_file(i)
+    new(i) { :be_quiet }.duration?
+  end
+
+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
+  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.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)
+  #_.report_duration # By default we will report in n seconds.
+  # puts MultimediaParadise::FileDuration.new(ARGV[0]).duration
+end # duration /Depot/Test/073_Inception.avi
+    # duration the_most_amazing_break_dance_2011-extreme_trick_hiphop_power_move_2011-SavedHere_19.07.2011.flv
+    # 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

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

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::Boogie
+# =========================================================================== #
+require 'multimedia_paradise/audio/genres/genre.rb'
+
+module MultimediaParadise
+
+class Boogie < ::MultimediaParadise::Genre
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = BOOGIE_FILE,
+      run_already = false
+    )
+    super(i, run_already)
+    set_yaml_file(BOOGIE_FILE)
+    set_namespace(NAMESPACE)
+    run
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise::Boogie.new(ARGV)
+end # boogie

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

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::Concerts
+# =========================================================================== #
+require 'multimedia_paradise/audio/genres/genre.rb'
+
+module MultimediaParadise
+
+class Concerts < ::MultimediaParadise::Genre
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = CONCERTS_SONGS_FILE,
+      run_already = false
+    )
+    super(i, run_already)
+    set_yaml_file(CONCERTS_SONGS_FILE)
+    set_namespace(NAMESPACE)
+    run
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise::Concerts.new(ARGV)
+end # concerts