multimedia_paradise 1.1.344 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc44691dd90b89864ce353452215da3ac4034244491cb47a5b441de836a5d3c6
-  data.tar.gz: 5c1f4851f1b195aa814b78e17ffd28f89b0a830ede7646ce2af3d906d08e0e2d
+  metadata.gz: 6872c8021118d9913e3d8d54e81b2c6e940acce8efc2857ca6d2a3ce8ea53b63
+  data.tar.gz: 8adcb3bbe62e2eb1605abdc99b5e3d3078651406081b7d12dbf6ecef12c2a5d7
 SHA512:
-  metadata.gz: ae707cbb19785afc3f16c818e8f070b7e6b33ccf8fc98165e8f0a0a9fb7cfb4a11d92eda3facc2384d41b614eac6d0542d2b85d8e7fb6a112aed342d16112cf3
-  data.tar.gz: 46bdb8a965870397909fc9f796303a10462cda7ba2103fb57ddfa3c2fe4ec8767411b402dc16165f550f83d1607426ecceeccbcb48792d976194c734d0b881c8
+  metadata.gz: 51ef44359d59087bdf90bee09e0beca8d9cbbf090cc103371ca8d1058a42775a6c06ab53888a7ae1e214989022a0c2bc7b8c8f37ba5a7b1aa403467b74d7a5de
+  data.tar.gz: cd69f50a114f330180ec7589e57132316c46297d2dbda42e2a947c4752dcebbbab57286b7f50e0d3bdf93c73f0dd39e634f6d7ed97f485eac04cec4135f5be12

data/README.md

@@ -2,85 +2,89 @@
 [![forthebadge](https://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
 [![Gem Version](https://badge.fury.io/rb/multimedia_paradise.svg)](https://badge.fury.io/rb/multimedia_paradise)
 
-This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">23.01.2024</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">07:25:13</span> o'clock.
+This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">07.03.2024</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">22:08:18</span> o'clock.
 
 # MultimediaParadise - a toolset project for audio and video related data
 
 <img src="https://i.imgur.com/Qh4Fve1.png" style="margin: 1em; margin-left: 2.5em">
 
-The **multimedia paradise** project bundles together code that can be
-used for "multimedia data" - in particular for **audio** and **video** files.
-
-Most of the functionality found within the **multimedia paradise**
-projects depends on <b>ffmpeg</b>, but in principle the code in the
-main module called **MultimediaParadise** should work with other
-toolkits as well, if a toolkit supports certain actions (such as
-<b>sox</b>). As is often the case, support for other toolkits depends
-on time investment - and time availability - of the main author of
-this project, but in principle support for other toolkits can be
-added as-is, at any moment in time. It is just that **ffmpeg** is
-really good, so other toolkits will have a hard time competing
-against it.
-
-For multimedia-related purposes, **ffmpeg** is a really excellent
-project. Thus, the MultimediaParadise gem will focus on **ffmpeg**
+The <b>multimedia paradise</b> project bundles together code that can be
+used for "multimedia data" - in particular for <b>audio</b> and <b>video</b>
+files.
+
+Most of the functionality found within the <b>multimedia paradise</b>
+projects depends on the external project called <b>ffmpeg</b>. However had,
+in principle the code in the toplevel-module called <b>MultimediaParadise</b>
+should also work with other toolkits as well, provided that said toolkit
+supports certain actions - such as <b>sox</b> does.
+
+As is often the case, support for other toolkits depends on time investment
+though - and time availability - of the main author of this project. Nonetheless,
+whenever possible, support for other toolkits will be added as-is. It is 
+just that <b>ffmpeg</b> is really an excellent project, so other toolkits
+will have a hard time competing against <b>ffmpeg</b>.
+
+For multimedia-related purposes, <b>ffmpeg</b> can be recommended. Thus,
+the MultimediaParadise gem will also focus primarily on <b>ffmpeg</b>
 by default.
 
-You can obtain a copy of ffmpeg from the following URL:
+A copy of ffmpeg can be obtained from the following URL:
 
 https://www.ffmpeg.org/download.html
 
 ## Installation of the MultimediaParadise project
 
-There are several ways how to install this project, including using
-oldschool **setup.rb** - but I recommend the following way, for
-simplicity, on any modern system:
+There are several ways how to install the multimedia_paradise project. Personally
+I still use the oldschool way via <b>setup.rb</b>, but the more modern, and 
+recommend way, to install this gem goes via <b>gem install</b>, specifically:
 
     gem install multimedia_paradise --user-install
 
-The reason as to why I recommend the **--user-install** option is to be
-used is because the various files under the **bin/** subdirectory that
+The reason as to why it is recommended to use the <b>--user-install</b> option
+is because the various files under the <b>bin/</b> subdirectory that
 are part of this gem will be made available in your home directory
 (under e. g. ~/.gem/ruby/2.5.0/bin or whatever your local ruby
 version is). That way you can easily add that directory to $PATH
 or not, and make use of these files if you want to - and if not,
 just ignore the bin/ subdirectory of this gem altogether.
 
-You can find out the paths used by **gem** via:
+You can find out the paths used by <b>gem</b> by issuing the following
+command:
 
     gem environment
 
-Note that even if you can not find such a bin/ subdirectory on your
-system, these files are distributed within the **multimedia_paradise**
+Note that even if you can not find such a <b>bin/</b> subdirectory on your
+system, these files are distributed within the <b>multimedia_paradise</b>
 gem itself as such, so just extract the gem, then copy the bin/ files
-to wherever you want to. There is more than one way to do
-things! If you still have a hard time doing so, you can use a 
-toplevel method that will copy all bin/ files into the current
-working directory. So, for instance, create a directory at:
+to wherever you want to. There is more than one way to do things!
+
+If you still have a hard time doing so, you can use a toplevel method that
+will copy all bin/ files into the current working directory. So, for
+instance, create a directory at the following location:
 
     mkdir /tmp/multimedia_paradise # just an example
 
-Then start **irb** and issue:
+Then start <b>irb</b> and issue:
 
     require 'multimedia_paradise'
     MultimediaParadise.copy_bin_directory
 
-This will create a directory called **bin/** and then proceed
-to copy all bin/ files into that directory. This is just a
-convenience workaround if --user-dir does not work on your
-system, for whatever the reason. (Note that this assumes
-that these bin/ entries are in your HOME directory under
-bin/ which may not always be the case; I have no idea why
-this does not work anymore. It used to work in the past.
+This will create a directory called <b>bin/</b> and then proceed
+to copy all bin/ files that are distributed via the multimedia_paradise
+gem into that directory. This is just a convenience workaround if
+--user-dir does not work on your system, for whatever the reason.
+(Note that this assumes that these bin/ entries are in your HOME
+directory under bin/ which may not always be the case; I have no idea
+why this does not work anymore. It used to work in the past.
 Ask the rubygems maintainers what they broke over the
 years if this does not work for you. :P But, even in that
 case, you can just download the .gem file from rubygems.org
 and extract it on your own, and then you will 100% have
 the bin/ hierarchy there.)
 
-It is recommended to install **ffmpeg** and have it made
-available on your system - ffmpeg really is a great project,
-and the multimedia_paradise gem taps into the functionality
+It is also recommended to install <b>ffmpeg</b> and have it made
+available on the given computer system at hand - ffmpeg really is
+a great project, and the multimedia_paradise gem taps into the functionality
 made available by ffmpeg. In many ways the multimedia_paradise
 gem is a convenient wrapper over **some** of ffmpeg's 
 functionality.
@@ -95,11 +99,11 @@ not necessarily a professional-grade software suite.
 ## Removing the audio from a local video file
 
 Let us begin with a fairly simply use case here: say that you 
-want to **remove the audio from a local video file**.
+want to <b>remove the audio from a local video file</b>.
 
 So if you have such a use case that requires of you to
 **remove audio from a local video file**, use the
-following **API**:
+following <b>API</b>:
 
     require 'multimedia_paradise/audio/remove_audio.rb'
     MultimediaParadise.remove_audio(path_to_the_file_goes_in_here)
@@ -1627,7 +1631,7 @@ So, how to use class <b>MultimediaParadise::CreateM3uPlaylist</b>?
 
 The input to class <b>MultimediaParadise::CreateM3uPlaylist</b>
 should ideally be a **yaml file** describing your songs (at the
-least **the path to these songs**), but you could also use the **API**
+least **the path to these songs**), but you could also use the <b>API</b>
 from within Ruby, naturally and thus use a **ruby array** directly
 that is to be passed to the class; just pass this Array to
 **.new()**.
@@ -1919,14 +1923,14 @@ Usage example if you want to do only one image per second:
 
     MultimediaParadise.video_to_images("foobar.mp4", :default, 1)
 
-See the file **multimedia_paradise/toplevel_methods/conversion.rb**
+See the file <b>multimedia_paradise/toplevel_methods/conversions.rb</b>
 for more information about that functionality - it is made possible
 thanks to ffmpeg.
 
 ## Radio stations and a graphical user interface to it (GUI)
 
-Since as of **October 2018**, the **MultimediaParadise** project comes
-with a small **yaml file** called **radio_stations.yml**.
+Since as of <b>October 2018</b>, the **MultimediaParadise** project comes
+with a small **yaml file** called <b>radio_stations.yml</b>.
 
     x = YAML.load_file('radio_stations.yml')
 
@@ -2022,6 +2026,38 @@ It now looks like this:
 Not sure if this was an actual improvement, but for now it'll stay
 that way.
 
+## MultimediaParadise.action()
+
+The toplevel-method <b>MultimediaParadise.action()</b> was added
+during the March 2024 rewrite of the multimedia_paradise gem.
+
+The basic idea behind actions, implemented via the aforementioned
+method, is to bundle all activities that may seem useful to most
+users in a centralized manner.
+
+So, for instance: say that you wish to extract the audio from
+a given video file, via ffmpeg. The file at hand will be called
+<b>foobar.mp4</b>.
+
+You can generalize this via actions like in this way:
+
+    MultimediaParadise.action(:extract_audio, 'foobar.mp4')
+
+That's it!
+
+Of course the simpler method called
+<b>MultimediaParadise.action()</b> is also available, but
+the main benefit of MultimediaParadise.action() is that you
+do not have to require any specific file. You can ignore
+the file paths there, and just think in terms of
+actionable components. This is especially useful when we
+use MultimediaParadise in a GUI. It will simplify a lot
+of the GUI code past this point, which is why this is
+a win-win situation for the multimedia_paradise gem. I
+will eventually add java-swing components as well, thus
+allowing users to make use of the multimedia_paradise
+gem on windows as well. 
+
 ## Converting a .mp4 or .avi file to an animated .gif
 
 You can use the following API to convert a video to an
@@ -2603,7 +2639,7 @@ automatically create a thumbnail from a video file.
 
 Usage example:
 
-    require 'multimedia_paradise/toplevel_methods/misc.rb' # ← This file includes the code shown below.
+    require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb' # ← This file includes the code shown below.
     this_file = '/Depot/j/foobar.mp4'
 
     MultimediaParadise.automatically_create_a_thumbnail_for_this_video()
@@ -2647,11 +2683,12 @@ by ffmpeg <b>does</b> work.
 
 ## Learning to play the piano
 
-Since a few months I am (again) learning to play the piano, although
-I use a Yamaha keyboard rather than a piano.
+Since early <b>2024</b> I am (again) learning to play the piano, although
+I use a <b>Yamaha keyboard</b> rather than a piano.
 
-This subsection here will collect various snippets that may relate
-to playing songs. This is very random though.
+This subsection here will collect various snippets that may relate to
+playing songs, including how to practice properly. This is very random,
+though, as it will change as I learn new things.
 
 Phantom of the Opera:
 
@@ -2692,29 +2729,14 @@ gem owner eventually:
 see
 https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
 
-Mandatory 2FA will eventually be extended to all rubygems.org developers and
-maintainers. As I can not use 2FA, for reasons I will skip explaining here,
-this means that my projects will eventually be removed, as I no longer
-have any control over my projects hosted on rubygems.org (because I
-can not use 2FA).
-
-At that point, I no longer have any control what is done to my projects
-since whoever is controlling the gems ecosystem took away our control
-here. I am not sure at which point ruby became corporate-controlled -
-that was not the case several years ago, so something has
-changed.
-
-Ruby also only allows 2FA users to participate on the issue tracker these
-days:
-
-  https://bugs.ruby-lang.org/issues/18800
-
-But this has been reverted some months ago, so it is no longer applicable.
-Suffice to say that I do not think that we should only be allowed to
-interact on the world wide web when some 'authority' authenticated us,
-such as via mandatory 2FA, so I hope this won't come back again.
-
-Fighting spam is a noble goal, but when it also means you lock out
-real human people then this is definitely NOT a good situation
-to be had.
+However had, that has been reverted again, so I decided to shorten
+this paragraph. Mandatory 2FA may exclude users who do not have a 
+smartphone device or other means to 'identify'. I do not feel it is
+a fair assumption by others to be made that non-identified people may
+not contribute code, which is why I reject it. Mandatory 2FA would mean
+an end to all my projects on rubygems.org, so let's hope it will never
+happen. (Keep in mind that I refer to mandatory 2FA; I have no qualms
+for people who use 2FA on their own, but this carrot-and-stick strategy
+by those who control the rubygems infrastructure is a very bad one to
+pursue.
 

data/bin/audio_player

@@ -4,7 +4,7 @@
 # =========================================================================== #
 require 'multimedia_paradise/requires/require_the_audio_player.rb'
 
-_ = MultimediaParadise::AudioPlayer.new(ARGV, :dont_run_yet)
+_ = MultimediaParadise.audio_player(ARGV, :dont_run_yet)
 
 if ARGV.first
   _.try_to_find_genre_song(ARGV.first) # To test this, try: rsong genre GOOD_BDANCE_SONGS

data/bin/extract_images_from_this_video_file

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb'
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
 MultimediaParadise.extract_images_from_this_video_file(ARGV)

data/bin/loop_this_video

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb'
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
 MultimediaParadise.loop_this_video(ARGV,  10)

data/bin/merge_avi_files

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/merge_multimedia_file.rb'
+require 'multimedia_paradise/toplevel_methods/merge.rb'
 
 MultimediaParadise.merge_avi_files(ARGV)

data/bin/merge_mp3

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/conversions/conversions.rb'
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
 
 MultimediaParadise.merge_mp3(:default, ARGV)

data/bin/mp3_to_opus

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/conversions/conversions.rb'
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
 
 MultimediaParadise.mp3_to_opus(ARGV)

data/bin/mpg_to_mp4

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb'
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
 MultimediaParadise.mpg_to_mp4(ARGV)

data/bin/multimedia_paradise

@@ -2,7 +2,7 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/commandline/menu.rb'
+require 'multimedia_paradise/commandline/commandline.rb'
 
 MultimediaParadise.set_array_commandline_arguments(ARGV)
 

data/bin/to_aiff

@@ -2,9 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise'
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
 
-_ = ARGV.first
-MultimediaParadise.esystem(
-  "ffmpeg -i #{_} -f aiff -ab 128000 -ar 44100 #{_}.aif"
-)
+MultimediaParadise.to_mp4(ARGV.first)

data/bin/to_flac

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
+
+MultimediaParadise.to_flac(ARGV)

data/bin/to_mp3

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'multimedia_paradise/audio/to_mp3.rb'
+
+MultimediaParadise.to_mp3(ARGV)
+

data/bin/to_mp4

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/to_mp4.rb'
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
 
 MultimediaParadise.to_mp4(ARGV)

data/bin/to_ogg

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
+
+MultimediaParadise.to_ogg(ARGV)

data/bin/verbose_analyse_this_mp3_file_for_id3_tags

@@ -4,6 +4,6 @@
 # =========================================================================== #
 # verbose_analyse_this_mp3_file_for_id3_tags
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb'
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
 MultimediaParadise.verbose_analyse_this_mp3_file_for_id3_tags(ARGV)

data/bin/video_codec

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb'
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb'
 
 puts MultimediaParadise.return_video_codec_of_this_file(ARGV)

data/bin/video_thumbnail

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/toplevel_methods/misc.rb' # ← This file includes the code shown below.
+require 'multimedia_paradise/toplevel_methods/toplevel_methods.rb' # ← This file includes the code shown below.
 
 MultimediaParadise.thumbnail(ARGV) 

data/bin/video_to_images

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'multimedia_paradise/conversions/conversions.rb'
+require 'multimedia_paradise/toplevel_methods/conversions.rb'
 
 MultimediaParadise.video_to_images(ARGV)