multimedia_paradise 1.1.344 → 1.2.2

data/lib/multimedia_paradise/audio/waveform/class.rb

@@ -1,341 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'multimedia_paradise/audio/waveform/class.rb'
-# =========================================================================== #
-require 'multimedia_paradise/audio/waveform/constants.rb'
-require 'multimedia_paradise/audio/waveform/log.rb'
-require 'multimedia_paradise/base/base.rb'
-
-module MultimediaParadise
-
-class Waveform < Base # === MultimediaParadise::Waveform
-
-  begin
-    require 'ruby-audio'
-  rescue LoadError; end
-
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-  begin
-    require 'oily_png'
-  rescue LoadError
-    begin
-      require 'chunky_png'
-    rescue LoadError
-      # ===================================================================== #
-      # If we are on my home system, report that chunky_png is missing.
-      # ===================================================================== #
-      if ENV['IS_ROEBE'].to_s == '1'
-        opn(namespace: NAMESPACE)
-        puts 'chunky_png is missing - please install it.'
-      end
-    end
-  end
-
-  # ========================================================================= #
-  # Scope these under Waveform so you can catch the ones generated by
-  # just this class.
-  # ========================================================================= #
-  class RuntimeError  < ::RuntimeError;  end
-  class ArgumentError < ::ArgumentError; end
-
-  # ========================================================================= #
-  # === MultimediaParadise::Waveform.generate                  (generate tag)
-  #
-  # This method will generate a waveform image.
-  #
-  # The first argument will be the input-filename of the .wav file in
-  # question.
-  #
-  # The second argument shall be the output name of the newly generated
-  # filename.
-  #
-  # The third argument shall be the options.
-  #
-  # Available options, all of which are optional, are these here:
-  #
-  #   :method => The method used to read sample frames, available methods
-  #     are peak and rms. peak is probably what you're used to seeing, it
-  #     uses the maximum amplitude per sample to generate the waveform, so
-  #     the waveform looks more dynamic. RMS gives a more fluid waveform
-  #     and probably more accurately reflects what you hear, but isn't as
-  #     pronounced (typically).
-  #
-  #     Can be :rms or :peak
-  #
-  #     Default is :peak.
-  #
-  #   :width => The width (in pixels) of the final waveform image.
-  #
-  #     Default is 1800.
-  #
-  #   :height => The height (in pixels) of the final waveform image.
-  #
-  #     Default is 280.
-  #
-  #   :background_color => Hex code of the background color of the
-  #     generated waveform image.
-  #     Default is #666666 (gray).
-  #
-  #   :color => Hex code of the color to draw the waveform, or can pass
-  #     :transparent to render the waveform transparent (use w/ a solid
-  #     color background to achieve a "cutout" effect).
-  #     Default is #00ccff (cyan-ish).
-  #
-  #   :force => Force generation of waveform, overwriting WAV or PNG file.
-  # 
-  #   :logger => IOStream to log progress to.
-  #
-  # Usage examples:
-  #
-  #   x = MultimediaParadise::Waveform.generate('foo.wav')
-  #   x = MultimediaParadise::Waveform.generate('foo.wav', 'BOTY.png')
-  #   x = MultimediaParadise::Waveform.generate('Kickstart My Heart.wav', "Kickstart My Heart.png")
-  #   x = MultimediaParadise::Waveform.generate('Kickstart My Heart.wav', "Kickstart My Heart.png", :method => :rms)
-  #   x = MultimediaParadise::Waveform.generate('Kickstart My Heart.wav', "Kickstart My Heart.png", :color => "#ff00ff", :logger => $stdout)
-  #
-  # ========================================================================= #
-  def self.generate(
-      source,
-      filename = :guess_from_given_source,
-      options  = {}
-    )
-    options = DEFAULT_OPTIONS.merge(options)
-    case filename
-    when :guess_from_given_source, :default # Replace.
-      filename = source.gsub(/\.wav$/,'')+'.png'
-    end
-    raise ArgumentError.new(
-      'No source audio filename given, must be an existing sound file.'
-    ) unless source
-    raise ArgumentError.new(
-      'No destination filename given for waveform.'
-    ) unless filename
-    raise RuntimeError.new(
-      "Source audio file '#{source}' not found."
-    ) unless File.exist?(source)
-    raise RuntimeError.new(
-      "Destination file #{filename} exists. Use --force if you want to automatically remove it."
-    ) if File.exist?(filename) && !options[:force] === true
-
-    if source.end_with? '.mp3' # User did input a .mp3 file.
-      # ===================================================================== #
-      # === Tap into the toplevel-method MultimediaParadise.mp3_to_wav next
-      # ===================================================================== #
-      source = MultimediaParadise.mp3_to_wav(source)
-    end
-
-    # ======================================================================= #
-    # === Start the logger classer
-    # ======================================================================= #
-    @log = Log.new(options[:logger])
-    @log.start!
-    # ======================================================================= #
-    # Frames gives the amplitudes for each channel, for our waveform we're
-    # saying the "visual" amplitude is the average of the amplitude across
-    # all the channels. This might be a little weird w/ the "peak" method
-    # if the frames are very wide (i.e. the image width is very small) --
-    # I *think* the larger the frames are, the more "peaky" the waveform
-    # should get, perhaps to the point of inaccurately reflecting the
-    # actual sound.
-    # ======================================================================= #
-    samples = frames(source, options[:width], options[:method]).map { |frame|
-      frame.inject(0.0) { |sum, peak| sum + peak } / frame.size
-    }
-
-    @log.timed("\nDrawing...") {
-      # ===================================================================== #
-      # Don't remove the file even if force is true until we're sure
-      # the source was readable.
-      # ===================================================================== #
-      if File.exist?(filename) && options[:force] === true
-        @log.out("Output file #{filename} encountered. Removing.")
-        File.delete(filename)
-      end
-      image = draw(samples, options)
-      image.save(filename)
-    }
-    @log.done!("Generated waveform '#{filename}'")      
-  end
-
-  # ========================================================================= #
-  # === Wavelength.draw
-  #
-  # Draws the given samples using the given options.
-  #
-  # Will return a ChunkyPNG::Image.
-  # ========================================================================= #
-  def self.draw(samples, options)
-    image = ChunkyPNG::Image.new(options[:width], options[:height],
-      options[:background_color] == :transparent ? ChunkyPNG::Color::TRANSPARENT : options[:background_color]
-    )
-
-    case options[:color]
-    # ======================================================================= #
-    # === :transparent
-    # ======================================================================= #
-    when :transparent
-      color = transparent = ChunkyPNG::Color.from_hex(
-        # =================================================================== #
-        # Have to do this little bit because it's possible the color we were
-        # intending to use a transparency mask *is* the background color,
-        # and then we would end up wiping out the whole image.
-        # =================================================================== #
-        options[:background_color].downcase == TRANSPARENCY_MASK ? TRANSPARENCY_ALTERNATE : TRANSPARENCY_MASK
-      )
-    else # Delegate towards class ChunkyPNG next.
-      color = ChunkyPNG::Color.from_hex(options[:color])
-    end
-
-    # ======================================================================= #
-    # Calling "zero" the middle of the waveform, like there's positive
-    # and negative amplitude
-    # ======================================================================= #
-    zero = options[:height] / 2.0
-
-    samples.each_with_index { |sample, x|
-      # ===================================================================== #
-      # Half the amplitude goes above zero, half below
-      # ===================================================================== #
-      amplitude = sample * options[:height].to_f / 2.0
-      # ===================================================================== #
-      # If you give ChunkyPNG floats for pixel positions all sorts of
-      # things go haywire.
-      # ===================================================================== #
-      image.line(x, (zero - amplitude).round, x, (zero + amplitude).round, color)
-    }
-
-    # ======================================================================= #
-    # Simple transparency masking, it just loops over every pixel and
-    # makes ones which match the transparency mask color completely clear.
-    # ======================================================================= #
-    if transparent
-      (0..image.width - 1).each { |x|
-        (0..image.height - 1).each { |y|
-          image[x, y] = ChunkyPNG::Color.rgba(0, 0, 0, 0) if image[x, y] == transparent
-        }
-      }
-    end
-    image
-  end
-
-  # ========================================================================= #
-  # === source?
-  # ========================================================================= #
-  def source?
-    @source
-  end; alias source source? # === source
-
-  class << self
-
-    private
-
-    # ======================================================================= #
-    # === Wavelength.frames
-    #    
-    # Returns a sampling of frames from the given RubyAudio::Sound using the
-    # given method the sample size is determined by the given pixel width --
-    # we want one sample frame per horizontal pixel.
-    # ======================================================================= #
-    def frames(source, width, method = :peak)
-      unless %i( peak rms ).include?(method)
-        raise ArgumentError.new("Unknown sampling method #{method}")
-      end 
-
-      frames = []
-
-      RubyAudio::Sound.open(source) { |audio|
-        frames_per_sample = (audio.info.frames.to_f / width.to_f).to_i
-        sample = RubyAudio::Buffer.new("float", frames_per_sample, audio.info.channels)
-        @log.timed("Sampling #{frames_per_sample} frames per sample: ") {
-          while(audio.read(sample)) > 0
-            frames << send(method, sample, audio.info.channels)
-            @log.out('.')
-          end
-        }
-      }
-      frames # Return the found frames here.
-    rescue RubyAudio::Error => e
-      raise e unless e.message == 'File contains data in an unknown format.'
-      raise Waveform::RuntimeError.new(
-        "Source audio file #{source} could not be read by RubyAudio "\
-        "library -- Hint: non-WAV files are no longer supported, convert "\
-        "to WAV first using something like ffmpeg (RubyAudio: #{e.message})"
-      )
-    end
-
-    # ======================================================================= #
-    # === Wavelength.peak
-    #
-    # Returns an array of the peak of each channel for the given collection
-    # of frames -- the peak is individual to the channel, and the returned
-    # collection of peaks are not (necessarily) from the same frame(s).
-    # ======================================================================= #
-    def peak(frames, channels = 1)
-      peak_frame = []
-      (0..channels-1).each { |channel|
-        peak_frame << channel_peak(frames, channel)
-      }
-      peak_frame
-    end
-
-    # ======================================================================= #
-    # === Wavelength.rms
-    #
-    # Returns an array of rms values for the given frameset where each
-    # rms value is the rms value for that channel.
-    # ======================================================================= #
-    def rms(frames, channels = 1)
-      rms_frame = []
-      (0..channels-1).each { |channel|
-        rms_frame << channel_rms(frames, channel)
-      }
-      rms_frame
-    end
-
-    # ======================================================================= #
-    # === Wavelength.channel_peak
-    #
-    # Returns the peak voltage reached on the given channel in the given
-    # collection of frames.
-    # 
-    # TODO:
-    #
-    # Could lose some resolution and only sample every other frame, would
-    # likely still generate the same waveform as the waveform is so
-    # comparitively low resolution to the original input (in most cases),
-    # and would increase the analyzation speed (maybe).
-    # ======================================================================= #
-    def channel_peak(frames, channel = 0)
-      peak = 0.0
-      frames.each { |frame|
-        next if frame.nil?
-        frame = Array(frame)
-        peak = frame[channel].abs if frame[channel].abs > peak
-      }
-      peak
-    end
-
-    # ======================================================================= #
-    # === Wavelength.channel_rms
-    #
-    # Returns the rms value across the given collection of frames
-    # for the given channel.
-    # ======================================================================= #
-    def channel_rms(frames, channel = 0)
-      Math.sqrt(frames.inject(0.0){ |sum, frame|
-        sum += (frame ? Array(frame)[channel] ** 2 : 0) } / frames.size
-      )
-    end
-  end
-
-end; end
-
-if __FILE__ == $PROGRAM_NAME
-  MultimediaParadise::Waveform.generate(ARGV.first)
-end

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

@@ -1,38 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'multimedia_paradise/audio/waveform/constants.rb'
-# =========================================================================== #
-module MultimediaParadise
-
-class Waveform < ::MultimediaParadise::Base # === MultimediaParadise::Waveform
-
-  # ========================================================================= #
-  # === MultimediaParadise::Waveform::DEFAULT_OPTIONS
-  #
-  # Specify some default options to use for class Waveform.
-  # ========================================================================= #
-  DEFAULT_OPTIONS = {
-    :method           => :peak,
-    :width            => 1800,
-    :height           =>  280,
-    :background_color => '#666666',
-    :color            => '#00ccff',
-    :force            => false,
-    :logger           => nil
-  }
-
-  # ========================================================================= #
-  # === MultimediaParadise::Waveform::TRANSPARENCY_MASK
-  # ========================================================================= #
-  TRANSPARENCY_MASK = '#00ff00'
-
-  # ========================================================================= #
-  # === MultimediaParadise::Waveform::TRANSPARENCY_ALTERNATE
-  #
-  # In case the mask is the background color!
-  # ========================================================================= #
-  TRANSPARENCY_ALTERNATE = '#ffff00'
-
-end; end

data/lib/multimedia_paradise/audio/waveform/log.rb

@@ -1,101 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === MultimediaParadise::Waveform::Log
-#
-# The purpose of this class is to log and provide benchmarks.
-#
-# This may be important for lengthy batch operations.
-# 
-# There may be other, better benchmark classes, but it is fairly trivial
-# code - not mandatory to google for better solutions.
-# =========================================================================== #
-# require 'multimedia_paradise/audio/waveform/log.rb'
-# =========================================================================== #
-module MultimediaParadise
-
-class Waveform < ::MultimediaParadise::Base
-
-class Log # === MultimediaParadise::Waveform::Log
-
-  attr_accessor :io
-
-  # ========================================================================= #
-  # === initialize
-  # ========================================================================= #
-  def initialize(io = $stdout)
-    @io = io
-  end
-
-  # ========================================================================= #
-  # === out
-  #
-  # Prints the given message to the log.
-  # ========================================================================= #
-  def out(i)
-    io.print(i) if io
-  end
-
-  # ========================================================================= #
-  # === done!
-  #
-  # Prints the given message to the log followed by the most recent
-  # benchmark (note that it calls .end! which will stop the benchmark)
-  # ========================================================================= #
-  def done!(message = '')
-    out "#{message} (#{self.end!}s)\n"
-  end
-
-  # ========================================================================= #
-  # === start!
-  #
-  # Starts a new benchmark clock and returns the index of the new clock.
-  # 
-  # If .start! is called again before .end! then the time returned will
-  # be the elapsed time from the next call to start!, and calling .end!
-  # again will return the time from *this* call to start! (that is, the
-  # clocks are LIFO).
-  # ========================================================================= #
-  def start!
-    (@benchmarks ||= []) << Time.now
-    @current = @benchmarks.size - 1
-  end
-
-  # ========================================================================= #
-  # === end!
-  #
-  # Returns the elapsed time from the most recently started benchmark clock
-  # and ends the benchmark, so that a subsequent call to .end! will return
-  # the elapsed time from the previously started benchmark clock.
-  # ========================================================================= #
-  def end!
-    elapsed = (Time.now - @benchmarks[@current])
-    @current -= 1
-    elapsed
-  end
-
-  # ========================================================================= #
-  # === time?
-  #
-  # Returns the elapsed time from the benchmark clock w/ the given index
-  # (as returned from when .start! was called).
-  # ========================================================================= #
-  def time?(index)
-    Time.now - @benchmarks[index]
-  end
-
-  # ========================================================================= #
-  # === timed
-  #
-  # Benchmarks the given block, printing out the given message first
-  # (if given).
-  # ========================================================================= #
-  def timed(message = nil, &block)
-    start!
-    out(message) if message
-    yield
-    done!
-  end
-
-end; end; end

data/lib/multimedia_paradise/base/constants.rb

@@ -1,19 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'multimedia_paradise/base/constants.rb'
-# =========================================================================== #
-module MultimediaParadise
-
-class Base # === MultimediaParadise::Base
-
-  require 'multimedia_paradise/constants/my_video_directory.rb'
-  require 'multimedia_paradise/constants/directory_constants.rb'
-
-  # ========================================================================= #
-  # === N
-  # ========================================================================= #
-  N = "\n"
-
-end; end

data/lib/multimedia_paradise/base/encoding.rb

@@ -1,31 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# Encoding-related code should be stored in this file here.
-# =========================================================================== #
-module MultimediaParadise
-
-class Base
-
-  require 'multimedia_paradise/constants/encodings.rb'
-
-  # ========================================================================= #
-  # === ensure_main_encoding
-  #
-  # This method can ensure that a String has the proper encoding that
-  # we will use for the MultimediaParadise project.
-  # ========================================================================= #
-  def ensure_main_encoding(
-      i, use_this_encoding = USE_THIS_ENCODING
-    )
-    if i.is_a? String
-      unless i.encoding.to_s.include? use_this_encoding
-        i = i.dup if i.frozen?
-        i = i.force_encoding(use_this_encoding)
-      end
-    end
-    i
-  end
-
-end; end