Class: MultimediaParadise::Multimedia::ReadMetaTags

Inherits:
Base
  • Object
show all
Defined in:
lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb

Overview

MultimediaParadise::Multimedia::ReadMetaTags

Constant Summary collapse

N_LJUST =
#

N_LJUST

#
18

Constants inherited from Base

Base::ERROR, Base::ERROR_LINE, Base::NAMESPACE, Base::USE_THIS_NAMESPACE_FOR_THE_COLOURS, Base::USE_THIS_NAMESPACE_FOR_THE_CORE_COLOURS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #cartoons_directory?, #clear_the_internal_hash, #cliner, #cliner_with_time_stamp, #colourized_comment, #copy_file, #crimson, #dataset_from_file_video_collection, #dd_mm_yyyy, #debug?, #default_readlines, #directory_to_realvids?, #do_not_use_opn, #dodgerblue, #does_the_video_player_support_this_commandline?, #e, #ecomment, #ecrimson, #efancy, #enable_debug, #ensure_main_encoding, #ensure_that_the_output_directory_exists, #eparse, #erev, #esystem, #ewarn, #file_video_collection?, #filter_for_audio_files, #filter_for_video_files, #forestgreen, #gold, #grey, #hh_mm_ss, #home_x_video?, #indianred, #infer_the_namespace, #internal_hash?, #is_audio_file?, #is_mkv?, #is_mp3?, #is_mp4?, #is_multimedia_file?, #is_on_roebe?, #is_video_file?, #konsole_colour_peru, #lightblue, #lightgreen, #load_yaml, #local_audio_directory?, #log_dir?, #map_symbol_to_locally_existing_file, #mediumorchid, #mediumpurple, #mediumslateblue, #mkdir, #move_file, #namespace?, #no_file_exists, #no_file_exists_at, #olive, #olivedrab, #opne, #opnecomment, #opnn, #orange, #palegoldenrod, #palegreen, #powderblue, #project_base_directory?, #rds, #register_sigint, #remove_file, #report_pwd, #reset_the_internal_hash, #return_all_video_files, #return_pwd, #return_random_video, #rev, #royalblue, #save_what_into, #sdir, #seagreen, #seconds_to_time_format, #select_only_video_files_from, #set_be_verbose, #set_use_colours, #sfancy, #sfile, #simp, #skyblue, #slateblue, #springgreen, #steelblue, #swarn, #teal, #time_right_now, #to_hh_mm_ss, #tomato, #true_rev, #try_to_rename_kde_konsole_tab, #ucliner, #use_colours?, #use_opn?, #use_which_video_player?, #verbose_truth, #video_collection?, #violet, #yaml_directory?, #yel

Methods included from CommandlineArgumentsModule

#all_input_starts_with_a_number?, #commandline_arguments?, #commandline_arguments_as_a_string, #first_argument?, #first_non_hyphened_commandline_argument?, #set_commandline_arguments

Constructor Details

#initialize(i = nil, run_already = true) ⇒ ReadMetaTags

#

initialize

#


33
34
35
36
37
38
39
40
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 33

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

MultimediaParadise::Multimedia::ReadMetaTags[]

#


151
152
153
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 151

def self.[](i = ARGV)
  new(i)
end

Instance Method Details

#display_the_titleObject

#

display_the_title

#


79
80
81
82
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 79

def display_the_title
  e '  Title: '.ljust(N_LJUST)+
    orange(@title.to_s)
end

#input?Boolean

#

input?

#

Returns:

  • (Boolean)


72
73
74
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 72

def input?
  @input
end

#read_meta_tags_of_this_file(this_file) ⇒ Object

#

read_meta_tags_of_this_file

#


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 87

def read_meta_tags_of_this_file(this_file)
  # ===================================================================== #
  # Load the file if it exists.
  # ===================================================================== #
  if File.exist? this_file
    n_ljust = N_LJUST
    TagLib::FileRef.open(this_file) { |fileref|
      unless fileref.null?
        tag = fileref.tag
        cliner
        set_title(tag.title)
        display_the_title
        e '  Artist: '.ljust(n_ljust)+
          slateblue(tag.artist.to_s)
        e '  Album: '.ljust(n_ljust)+
          lightgreen(tag.album.to_s)
        e '  Year: '.ljust(n_ljust)+
          lightgreen(tag.year.to_s)
        # e '  Track number: '.ljust(n_ljust)+tag.track.to_s
        if tag.genre and !tag.genre.empty?
          e '  Genre: '.ljust(n_ljust)+
            tag.genre.to_s+::Colours.rev
        end
        e '  Comment: '.ljust(n_ljust)+
          crimson(tag.comment.to_s)
        properties = fileref.audio_properties
        e '  Song length: '.ljust(n_ljust)+
          mediumslateblue(properties.length.to_s+' seconds')
        cliner
        e
      end
    }
  else
    opnn; no_file_exists_at(this_file)
  end
end

#resetObject

#

reset (reset tag)

#


45
46
47
48
49
50
51
52
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 45

def reset
  super()
  # ======================================================================= #
  # === @title
  # ======================================================================= #
  @title = nil
  infer_the_namespace
end

#runObject

#

run (run tag)

#


141
142
143
144
145
146
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 141

def run
  try_to_load_the_taglib_library
  @input.each {|this_file|
    read_meta_tags_of_this_file(this_file)
  }
end

#set_input(i = '') ⇒ Object

#

set_input

#


64
65
66
67
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 64

def set_input(i = '')
  i = [i].flatten.compact
  @input = i # Must be an Array.
end

#set_title(i = nil) ⇒ Object

#

set_title

#


57
58
59
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 57

def set_title(i = nil)
  @title = i
end

#try_to_load_the_taglib_libraryObject

#

try_to_load_the_taglib_library

#


127
128
129
130
131
132
133
134
135
136
# File 'lib/multimedia_paradise/multimedia/read_meta_tags/read_meta_tags.rb', line 127

def try_to_load_the_taglib_library
  begin
    require 'taglib' # require 'taglib-ruby'
  rescue LoadError => error
    e 'The taglib-ruby gem is not installed. Consider installing '\
      'it ( gem install taglib ).'
    pp error
    exit
  end
end