multimedia_paradise 1.1.314

data/doc/Readme_for_the_cut_audio_component.md

@@ -0,0 +1,168 @@
+# The Cut Audio functionality
+====
+
+## Overview
+
+This component of the multimedia_project is called cut_audio.
+
+It uses ffmpeg to cut audio files in a convenient way.
+
+In the past it was an external project, but it was eventually
+merged into the multimedia_project.
+
+Version 1.0.3 added 'open' functionality so that we can edit the
+.rb file in question directly. Also, providing an end position
+is now optional. If omitted, we will simply default to the max
+length of the file in question.
+
+Version 1.0.6 added 'chop_off' syntax - we can now chop off from
+the end of the audio file.
+
+## Usage of the Cut Audio Project
+
+After installation, you can use the executable
+
+    cut_audio
+
+So, find yourself some audio file to work with, let's call it
+**foo.mp3** for the purpose of this file.
+
+Then you can do the following, by providing the path to this
+file in question:
+
+    cut_audio foo.mp3
+
+This will put you into the interactive mode. You can also use it
+in a non-interactive way, from within other ruby files of course.
+
+Now, in the interactive variant, you can issue the help command
+if you want to:
+
+    help
+
+This will give an overview of how to use the interactive part
+of CutAudio.
+
+You can then **cut** on this .mp3 file.
+
+In order to do so, you have to first define **start** and
+**end** positions. These define the interval between where
+the cutting will be done.
+
+For instance, to **define a start position at 3.2 seconds**,
+you can issue this:
+
+    s3.2
+
+or
+
+    s 3.2
+
+The "s" here is short for "start".
+
+Then, you must define an end point, let's say at position 8.5:
+
+    e8.5
+
+or
+
+    e 8.5
+
+Obviously, the **e** is short for "end".
+
+Since September 2014, the leading 's' and the leading 'e' became
+optional - so you can simply input a start number, then an end
+number. This of course requires of you to set sane start and
+end values - "1,5" is ok, "4,3" is not logical.
+
+You can continue defining more start and end points until you are
+finished. Then, when you have defined these start and end points,
+you can cut the segment.
+
+Cutting means that we will actually cut out the part that we wish
+to keep.
+
+So in the above context, we wish to keep position starting from
+3.2 up until position 8.5.
+
+Now you are ready to do the cutting, so issue:
+
+    cut
+
+We call these timespans ***setpoints***.
+
+You can of course define several **setpoints** - the command "cut" will
+take care of producing several individual audio files from this, using
+ffmpeg.
+
+You can merge different audio files together, in particular these 
+different setpoints (if you have more than one setpoint of course),
+by issuing:
+
+    merge
+
+You can delete the individual files again if you want to, by 
+issuing:
+
+    delete
+
+To quit, simply do "q" or "quit" or just hit Control-C.
+
+cut_audio is supposed to cut audio files using ffmpeg. In other words,
+you currently need to have ffmpeg available - the bin/ffmpeg file 
+from the commandline. (We could in principle use another audio-layer,
+but ffmpeg is very good - if you know of something else that should
+be supported, let me know.)
+
+The name of the cut_audio script is, unsurprisingly, called:
+
+    bin/cut_audio
+
+It will reside in the multimedia_paradise directory.
+
+That means that on a default ruby install, on a *nix system, it
+should be available at:
+    
+    /usr/bin/cut_audio
+
+And provided that /usr/bin is part of your $PATH variable, it
+can then be simply invoked via:
+
+    cut_audio
+    cut_audio FILENAME_HERE
+    cut_audio test.mp3
+
+This will open an interactive menu. Type "help" to get the 
+help output. You need to define start and end values for 
+where to cut that file manually.
+    
+Start has a leading "s" and end has a leading "e".
+    
+For instance:
+    
+    s5
+    e8
+
+Means: start at 5 seconds, end at 8 seconds.
+
+Milliseconds are also possible:
+
+    s5.33
+    e8.11
+    
+Means to start cutting at 5.33 second mark, and end 
+at 8.11 second mark.
+
+The original file will not be modified - instead, a new
+file will be created.
+
+In the interactive menu, you can also issue "mpl" or "play"
+or "mplayer" to play the audio file. This may help you to
+decide where to start cutting.
+
+Also note that you can define multiple setpoints. So you
+can type s5, s11, s99 and also e8, e88, e123. This would
+create 3 audio files. These files can also be merged 
+if you want to, by issuing "merge".
+
+Thank you and have fun.

data/doc/todo/todo_for_the_multimedia_paradise_project.md

@@ -0,0 +1,111 @@
+--------------------------------------------------------------------------------
+(1) in the sinatra-api of multimedia paradise, add
+     add video/random_simpsons
+
+also add various conversions, such as
+
+to_mp4/FILE_PATH_HERE
+^^^ this works now, but it has to be better documented, linked in
+    from the index, as well as an entry point at /to_mp4 shown.
+--------------------------------------------------------------------------------
+(2) enhance the sinatra stuff for MultimediaParadise:
+
+    In particular we need to be able to do:
+
+      (a) show how many videos are available locally, in total [IMPLEMENTED]
+      (b) be: able to view all registered videos files         [IMPLEMENTED]
+      (c) links (also to IMDB) ^^^ done above                  [IMPLEMENTED]
+
+      (d) metadata there + <- show the metadata too, codec stuff and so
+          forth via the web-interface
+      ALSO
+      (e) be able to convert stuff ... eaudio and stuff ... hmm
+          and some overview page... what does this mean
+      (f) play a video by embedding the video tag.
+          ok this one.^^^
+      (g) also make sure play/ works. 
+
+And document this properly in the README.gen file.
+
+--------------------------------------------------------------------------------
+(1) Add support for:
+
+    → Uncompressed audio formats, such as AIFF, AU or raw
+       header-less PCM
+
+ esystem "ffmpeg -i file.wav -f aiff -ab 128000 -ar 44100 file.aif"
+
+to_aiff now exists but we must test it still.
+
+I tested it but we  may have to test it more thoroughly first.
+
+  → Formats with lossless compression, such as FLAC, Monkey's
+     Audio (filename extension .ape), TTA, ATRAC Advanced
+     Lossless, ALAC (filename extension .m4a), MPEG-4 SLS,
+     MPEG-4 ALS, MPEG-4 DST, Windows Media Audio Lossless
+     (WMA Lossless), and Shorten (SHN).
+  → Formats with lossy compression, such as Opus, Vorbis,
+     Musepack, AAC, ATRAC and Windows Media Audio Lossy (WMA
+     lossy).
+     Opus has what format? Opus conversion now works.
+
+  ^^^ look to get these formats back.
+--------------------------------------------------------------------------------
+(2) Include and connect this into the GTK stuff
+  
+    Das ganze soll langsam zu einer richtigen "MULTIMEDIA STATION"
+    werden. Und auch den GUI dazu anschaun für Verbesserungen.
+
+  Todos:
+    phed>  format conversion is one thing, but a batch 
+           wav→tagged  ogg,mp3,flac - tool would be nice
+    shevy> batch wav tagged ... tool?
+    phed>  convert a list of wav files (an album) to 
+           a fully releasable zip/zips would be fun.
+--------------------------------------------------------------------------------
+(3) a downloader for random audio tracks. What does this even mean?
+    
+--------------------------------------------------------------------------------
+(4) llogan> perhaps you should use the concat demuxer
+            instead of the concat protocol
+
+--------------------------------------------------------------------------------
+(7) continue with porting OLD_video.rb
+--------------------------------------------------------------------------------
+(8) continue libui-id-tagger.
+     also  find out whether the id-tagger works on windows
+     if so or not (it does not right now), document this
+     on the README.gen of multimediaparaidse.
+     The compiling does not work. :(
+--------------------------------------------------------------------------------
+(9) make sure that for all lib-ui-based variants we have aliases.
+     that way we can call them directly on windows via cmd.exe
+-------------------------------------------------------------------------------
+(10) all gtk3 apps should have libui counterparts.
+-------------------------------------------------------------------------------
+(11) in multimedia player
+in java/
+  build a commandline player
+a simple one.
+
+somehow this breaks after a few seconds so somehow it dies
+off...
+-------------------------------------------------------------------------------
+(12) Add a "play-this-video-file.cgi" and sinatra app.
+
+    The UI should be simple, start with sinatra. The view-videos
+    URL aka /view
+    should work. and
+    then add:
+
+      play/134
+
+    ^^^ this should work as well. and allow query-based too.
+    once sinatra works, try to make it work via the .cgi page
+    but well... replace the / with _ perhaps to make ti work.
+    hmmm... yeah. well.
+    first we must add support for play/134 in sinatra.
+    Ok this works now ... we have to enable this via .cgi
+    too. This in order to complete the old functionality
+    that used to exist here at one point in time.
+--------------------------------------------------------------------------------

data/lib/multimedia_paradise/audio/audio_player/audio_player.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::AudioPlayer
+#
+# This is an "audio player".
+#
+# In other words - it plays audio files.
+#
+# For this to work, it distinguishes between different playmodes as will
+# be explained here.
+#
+# - If the argument given is an existing audio file, we will play it, then
+#   exit.
+#
+# - If we pass an array of files, we will store this array in our playlist
+#   and play all of them before we will then exit.
+#
+# - If we omit any argument then we will default to a neverending 'loop'.
+#   This also is the case when we pass 'loop' or nil as argument. Note
+#   that the loop is not unlimited; it will honour a threshold determined
+#   by an instance variable.
+#
+# - If we pass 'once', then we will play all audio files, and
+#   then exit.
+#
+# - If we pass 'one' or 'rand' as argument, we will play one
+#   random song, only ONCE, and then quit.
+#
+# - If we pass 'one_song', then we will play only this song.
+#
+# - If we pass in a number such as '3' then we will assume
+#   that the user wants to play exactly 3 files.
+#
+# Usage example:
+#
+#   MultimediaParadise::AudioPlayer.new(ARGV)
+#
+# =========================================================================== #
+# require 'multimedia_paradise/audio/audio_player.rb'
+# =========================================================================== #
+require 'multimedia_paradise/audio/base.rb'
+require 'multimedia_paradise/audio/audio_player/constants.rb'
+require 'multimedia_paradise/audio/audio_player/menu.rb'
+require 'multimedia_paradise/audio/audio_player/misc.rb'
+require 'multimedia_paradise/audio/audio_player/reset.rb'
+require 'multimedia_paradise/audio/audio_player/tab.rb'
+
+module MultimediaParadise
+
+class AudioPlayer < AudioBase # === MultimediaParadise::AudioPlayer
+
+  require 'multimedia_paradise/multimedia/play_from_this_list.rb'
+
+end
+
+  # ========================================================================= #
+  # === MultimediaParadise.audio_player
+  #
+  # We also want to use a simpler module-method for the audio player.
+  # ========================================================================= #
+  def self.audio_player(options = nil)
+    MultimediaParadise::AudioPlayer.new(options)
+  end; self.instance_eval { alias audio_play audio_player } # === MultimediaParadise.audio_play
+       self.instance_eval { alias play       audio_player } # === MultimediaParadise.play
+       self.instance_eval { alias []         audio_player } # === MultimediaParadise[]
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = MultimediaParadise::AudioPlayer.new(ARGV, :dont_run_yet)
+  if ARGV[1]
+    _.try_to_find_genre_song(ARGV[1]) # To test this, try: rsong genre GOOD_BDANCE_SONGS
+  end
+  _.run
+end # rsong power
+    #
+    # If you do this:
+    #   rsong ELE
+    # We load all ELE songs in our playlist
+    #   rsong playlist
+    # Will play our playlist.

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

@@ -0,0 +1,136 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'multimedia_paradise/audio/audio_player/constants.rb'
+# =========================================================================== #
+require 'multimedia_paradise/audio/base.rb'
+
+module MultimediaParadise
+
+class AudioPlayer < AudioBase # === MultimediaParadise::AudioPlayer
+
+  require 'multimedia_paradise/project/project.rb'
+
+  begin
+    require 'x/audio/playlist_profile.rb' # PlaylistProfile is declared here.
+  rescue LoadError; end # bl $RUBY_AUD/playlist_profile.rb
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === MY_SONGS
+  # ========================================================================= #
+  MY_SONGS = AUDIO_DIRECTORY
+    AUDIO_DIR = MY_SONGS # === AUDIO_DIR
+
+  # ========================================================================= #
+  # === RENAME_KDE_KONSOLE_TAB
+  # ========================================================================= #
+  RENAME_KDE_KONSOLE_TAB = true
+
+  # ========================================================================= #
+  # === DEFAULT_DELAY_PLAYING_SONGS
+  #
+  # The following constant is used for determining the audio delay between
+  # two songs.
+  #
+  # A value of 0.0 would mean no delay, aka "instant play", logically. 
+  # ========================================================================= #
+  DEFAULT_DELAY_PLAYING_SONGS = 1.8
+
+  # ========================================================================= #
+  # === MAIN_AUDIO_PLAYER_TO_USE
+  #
+  # The entry of this constant will become the instance variable
+  # @audio_player_to_use.
+  #
+  # As of May 2015 we can dynamically set this.
+  # ========================================================================= #
+  _ = "#{::MultimediaParadise.project_yaml_dir?}video/video.yml"
+  if File.exist? _
+    _ = YAML.load_file(_)
+    if _.has_key? 'MAIN_VIDEO_PLAYER'
+      MAIN_AUDIO_PLAYER_TO_USE = _['MAIN_VIDEO_PLAYER']
+    end
+  else # We default to mpv since as of 2021.
+    MAIN_AUDIO_PLAYER_TO_USE = 'mpv' # mplayer'
+  end
+
+  # ========================================================================= #
+  # === LAST_SONG_PLAYED
+  # ========================================================================= #
+  LAST_SONG_PLAYED = 'LAST_SONG_PLAYED.md'
+
+  # ========================================================================= #
+  # === USE_OSS_FOR_AUDIO_PLAYER
+  # ========================================================================= #
+  USE_OSS_FOR_AUDIO_PLAYER = false
+
+  # ========================================================================= #
+  # === FULL_LOCATION_FOR_LAST_SONG_PLAYED
+  # ========================================================================= #
+  FULL_LOCATION_FOR_LAST_SONG_PLAYED = HOME+LAST_SONG_PLAYED # Specify the path to our file here.
+
+  # ========================================================================= #
+  # === MAXIMUM_ALLOWED_FILE_SIZE
+  # ========================================================================= # 
+  MAXIMUM_ALLOWED_FILE_SIZE = 1_350_000 # Shall not become larger than that, else we remove the file "last song played".
+
+  # ========================================================================= #
+  # === DEFAULT_PLAYMODE
+  # ========================================================================= #
+  DEFAULT_PLAYMODE = 'once'
+
+  # ========================================================================= #
+  # === NAME_OF_AUDIO_PLAYER
+  # ========================================================================= #
+  NAME_OF_AUDIO_PLAYER = 'AudioPlayer' # The name of the audio player.
+
+  # ========================================================================= #
+  # === PLAY_MAX_N_SONGS
+  # ========================================================================= #
+  PLAY_MAX_N_SONGS = 1250 # We won't play more than n songs.
+
+  # ========================================================================= #
+  # === USE_FAVOURITE_PLAYLIST
+  # ========================================================================= #
+  USE_FAVOURITE_PLAYLIST = false # If true we play only songs from this list
+
+  # ========================================================================= #
+  # === AVAILABLE_SONGS
+  #
+  # Obtain all available songs - and shuffle them a bit.
+  # ========================================================================= #
+  AVAILABLE_SONGS = Dir["#{MY_SONGS}*"].shuffle
+
+  # ========================================================================= #
+  # === SHALL_WE_DEBUG
+  # ========================================================================= #
+  SHALL_WE_DEBUG = false # If true we output debug info
+
+  # ========================================================================= #
+  # === PLAYLIST_CONSTANTS
+  #
+  # Whether we have the PlaylistProfile defined or not. If we have, we will
+  # make use of it.
+  # ========================================================================= #
+  if Object.const_defined? :PlaylistProfile
+    PLAYLIST_CONSTANTS = PlaylistProfile.constants
+  end
+
+  # ========================================================================= #
+  # === THE_LOG_FILE_IS_STORED_HERE
+  # ========================================================================= #
+  THE_LOG_FILE_IS_STORED_HERE =
+    "#{MultimediaParadise.log_dir?}"\
+    "log_file_for_played_songs_via_the_audio_player.md"
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  pp MultimediaParadise::AudioPlayer
+end

data/lib/multimedia_paradise/audio/audio_player/menu.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module MultimediaParadise
+
+class AudioPlayer < AudioBase
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(i)
+    if i.is_a? Array
+      if i.empty?
+        i = 'loop'
+      else
+        i = i.join(' ').strip
+      end
+    end
+    i = i.to_s.strip
+    if i =~ /^\d+$/ # If input consists of only numbers.
+      opnn; e 'We will next play '+simp(i.to_s)+' songs.'
+      i.to_i.times { add_random_song }
+    # ======================================================================= #
+    # === 11:22:33
+    #
+    # Handle time-formats next.
+    # ======================================================================= #
+    elsif i =~ /^\d{1,2}:\d{1,2}:\d{1,2}$/ # If input consists of only numbers and ':'.
+      # ===================================================================== #
+      # User did input a time format such as "11:22:33". We will assume this
+      # to mean to enter idle mode, and then play the songs via a loop.
+      # ===================================================================== #
+      begin
+        require 'roebe/classes/at.rb'
+        Roebe::At.new(i)
+        do_play_in_a_loop # We play in a loop in this case.
+      rescue LoadError
+        e 'The file roebe/classes/at.rb is not available.'
+      end
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === help
+      #
+      # This entry point can be used to show the help section.
+      # ===================================================================== #
+      when *ARRAY_HELP_OPTIONS
+        show_help :then_exit
+      # ===================================================================== #
+      # === rsong --last-songs?
+      # ===================================================================== #
+      when /^-?-?last(-|_)?songs\??$/i
+        show_the_last_songs_that_were_played
+        exit_program { :be_quiet }
+      # ===================================================================== #
+      # === --use-sox
+      # ===================================================================== #
+      when /^-?-?use(-|_)?sox/
+        determine_which_audio_player_to_use(
+          :sox, :ignore_environment_variable
+        )
+      # ===================================================================== #
+      # === --use-mplayer
+      # ===================================================================== #
+      when /^-?-?use(-|_)?mplayer/
+        determine_which_audio_player_to_use(
+          :mplayer, :ignore_environment_variable
+        )
+      # ===================================================================== #
+      # === rsong --log?
+      # ===================================================================== #
+      when /^-?-?log\??$/i
+        show_the_log_file_if_it_exists
+        exit_program(:force_exit_but_be_quiet)
+      # ===================================================================== #
+      # === OPEN
+      # ===================================================================== #
+      when /^-?-?OPEN$/i
+        esystem "bluefish #{__FILE__}"
+        exit_program(:force_exit)
+      # ===================================================================== #
+      # === rsong --player?
+      # ===================================================================== #
+      when /^-?-?player\??$/
+        report_which_audio_player_to_use
+        exit_program { :be_quiet }
+      # ===================================================================== #
+      # === random
+      # ===================================================================== #
+      when 'random',
+           'return_random_song',
+           'rand',
+           'one' # Only add one song.
+        add_random_song
+      # ===================================================================== #
+      # === chill
+      # ===================================================================== #
+      when 'list','chill','1'
+        if Object.const_defined? :PlaylistProfile
+          these_songs = PlaylistProfile::GOOD_CHILL_SONGS.map {|entry|
+            audio_dir?+entry
+          }
+          add(these_songs.shuffle)
+        end
+      # ===================================================================== #
+      # === playlist
+      # ===================================================================== #
+      when /playlist\??/i
+        try_to_play_playlist
+      # ===================================================================== #
+      # === last?
+      # ===================================================================== #
+      when 'last?'
+        show_last_file_played
+      # ===================================================================== #
+      # === once
+      # ===================================================================== #
+      when 'once','noloop','default','all', # This means we play every song exactly once, then quit.
+           '','true','false',
+           'all_songs',
+           'play_all_songs'
+        opnn; e 'We will play all available Audio files once.'
+        add_all_songs
+      # ===================================================================== #
+      # === dance
+      # ===================================================================== #
+      when 'dance','bdance','breakdance' # Im Moment hardcoded auf bdance
+        these_songs = PlaylistProfile::GOOD_BDANCE_SONGS.shuffle.map {|entry|
+          audio_dir?+entry
+        }
+        add(these_songs.shuffle)
+      # ===================================================================== #
+      # === loop
+      # ===================================================================== #
+      when 'loop','l','nil'
+        # Notify the user what we are doing next.
+        opnn; e "#{main_colour?}Playing in a neverending #{sfancy('loop')}"\
+                "#{main_colour?} next:"
+        do_play_in_a_loop
+      # ===================================================================== #
+      # === genre
+      # ===================================================================== #
+      when 'genre','GENRES','genres','GENRE'
+        unless ARGV[1]
+          show_available_genres
+          exit_program(:force_exit)
+        end
+      else # else tag
+        # =================================================================== #
+        # Grab all entries from the current directory that can match to the
+        # input.
+        # =================================================================== #
+        entries = Dir['*'+i+'*']
+        unless entries.empty?
+          add_songs(entries)
+        else
+          try_to_find_genre_song(i)
+        end
+      end
+    end
+  end; alias check_against_menu menu # === check_against_menu
+
+end; end