got_mp3 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c34d1db35e8baadaaf24b2fa70f3598a64ec38ddd47095188a82eae76e063573
-  data.tar.gz: 86bb8da65ce447a7bbd168b068cc9b992b551b0db201eac8a3e2949fdc1d5dba
+  metadata.gz: a109d9369982eb251b2439256a7ab8ecb0494f8b693efeb869ed6e29329d23e4
+  data.tar.gz: 960ba30e1ab1178b77280f9f6068248cb82616040caa2fca2880dcccc78c1af0
 SHA512:
-  metadata.gz: 5c666482d88a53d4e608316cbbbe83dd8b7b2c1fed9d725f666fdbf0c32c4e20ff809e5a2a51f72f87cf63659dc94f3f1bf5420b823bbebb0638b7e95781bcfe
-  data.tar.gz: f6508835a0db94da8febc2d301ed40ab8b490caf17caf74af73c46418e0ffddb80142a3c24f8a82ca157a355bec0fa792cb6b813af9ae8dcf3c66ac350c702d4
+  metadata.gz: 8777628c7ec8d16460fe3ff59199b98bf34bf10494ffdb22afd432cb1f7110591bd48370998f4bc4757f9564d3b4a190ec03537e03d2f9c7cecd01b0ddafe744
+  data.tar.gz: 7c9b29dc4e6e889644c2cfef6464fcb09fb34ead8101670a7f08942344132994099444a144b5ee5a24e9f76d1c176f595837845accd9a6ef8efb1ff269994e80

data/lib/got_mp3.rb

@@ -4,11 +4,15 @@
 
 require 'dxlite'
 require 'ostruct'
-require "mp3info"
+require 'mp3info'
+require 'ogginfo'
+require 'playlist_creator'
 
 
 class GotMP3
 
+  attr_accessor :dir
+
   def initialize(dir: '.', debug: false)
     @dir, @debug = dir, debug
   end
@@ -44,7 +48,58 @@ class GotMP3
 
   end
 
-  # copy all MP3 directories through the category file-directory stucture
+  # Adds an XSPF playlist file to each file directory containing MP3s
+  #
+  def add_playlist(dir: @dir)
+
+    # .new('/home/james/Music2/Christmas)
+    #mp3s = Dir[File.join(@dir, '*.mp3')].sort_by {|x| File.mtime(x)}.reverse
+    a = Dir.glob(File.join(dir, '*')).select {|f| File.directory? f}
+
+    tracks = []
+
+    a.each do |dir|
+
+      tracks += add_playlist(dir: dir)
+
+      each_media_track(dir) do |media, trackno, filepath|
+
+        info = case File.extname(filepath)
+        when '.mp3'
+          mp3info(media)
+        when '.ogg'
+          ogginfo(media)
+        end
+
+        h = {
+          title: info[:title],
+          location: File.join(File.basename(dir), File.basename(filepath)),
+          album: info[:album]
+        }
+
+        tracks << h
+
+      end
+
+    end
+
+
+
+    pc = PlaylistCreator.new()
+
+    tracks.each do |x|
+      pc.add title: x[:title], location: x[:location], album: x[:album]
+    end
+
+    File.write File.join(dir,'playlist.xspf'), pc.to_xspf
+
+    return tracks
+
+  end
+
+  # Copies all MP3 directories through the category file-directory stucture.
+  # To accomplish this, it need a reference (source) directory containing the
+  # .txt for each album.
   #
   def compile(source_directory: '', target_directory: '')
 
@@ -72,6 +127,8 @@ class GotMP3
 
   end
 
+  # copy the .txt file from each mp3 directory into a central file directory
+  #
   def consolidate_txt(target_directory: '')
 
     raise 'target_directory cannot be empty' if target_directory.empty?
@@ -90,19 +147,19 @@ class GotMP3
 
   end
 
-  def each_mp3_file(directory='.', &blk)
+  def each_media_file(directory=@dir, &blk)
 
-    puts 'each_mp3 - directory: ' + directory.inspect if @debug
-    found = Dir[File.join(directory, "*.mp3")].sort_by { |x| File.mtime(x) }
-    puts 'each_mp3 - found: ' + found.inspect if @debug
+    puts 'each_media_file - directory: ' + directory.inspect if @debug
+    found = Dir[File.join(directory, "*.{mp3,ogg}")].sort_by { |x| File.mtime(x) }
+    puts 'each_nedia_file - found: ' + found.inspect if @debug
 
-    found.reverse.each.with_index do |mp3_filepath, i|
+    found.each.with_index do |media_filepath, i|
 
-      puts 'each_mp3 - mp3_filepath: ' + mp3_filepath.inspect if @debug
+      puts 'each_medi... - media_filepath: ' + media_filepath.inspect if @debug
 
-      next unless File.exists? mp3_filepath
+      next unless File.exists? media_filepath
 
-      blk.call(mp3_filepath, i )
+      blk.call(media_filepath, i )
 
     end
 
@@ -136,7 +193,7 @@ class GotMP3
   #
   def rename()
 
-    each_mp3_file do |mp3_filepath|
+    each_media_file do |mp3_filepath|
 
       mp3_directory = File.dirname(mp3_filepath)
       mp3_filename = File.basename(mp3_filepath)
@@ -148,11 +205,28 @@ class GotMP3
 
   end
 
+  # sort MP3 or OGG by track number in the filename
+  #
+  def sort_by_tracknum!()
+
+    each_media_file do |filepath|
+
+      directory = File.dirname(filepath)
+      a = Dir[File.join(directory, '*.{mp3,ogg}')]
+      a.sort_by {|x| x[/^\d+/]}.each {|file| FileUtils.touch file}
+
+    end
+
+  end
+
+  # write either a track listing into the media filepath, either in
+  # plain text or XML format.
+  #
   def write_titles(format: 'txt')
 
     puts 'inside write_titles()' if @debug
 
-    find_by_ext('.mp3').each do |directory, _ |
+    find_by_ext('.{mp3,ogg}').each do |directory, _ |
 
       puts 'write_titles() - directory: ' + directory.inspect if @debug
       txt_filename = Dir[File.join(directory, '*.txt')].first
@@ -161,17 +235,17 @@ class GotMP3
 
       tracks = []
 
-      each_mp3_track(directory) do |mp3, trackno, mp3_filepath|
+      each_media_track(directory) do |media, trackno, media_filepath|
 
-        tracks << OpenStruct.new({
-          title: mp3.tag.title.sub(/^\d+\. */,''),
-          artist: mp3.tag.artist,
-          album: mp3.tag.album,
-          album_artist: mp3.tag2['TPE2'] || mp3.tag.artist,
-          disc: mp3.tag2['TPOS'] || 1,
-          tracknum: mp3.tag.tracknum,
-          filename: File.basename(mp3_filepath)
-        })
+        info = case File.extname(media_filepath)
+        when '.mp3'
+          mp3info(media)
+        when '.ogg'
+          ogginfo(media)
+        end
+
+        info[:filename] = File.basename(media_filepath)
+        tracks << OpenStruct.new(info)
 
       end
 
@@ -180,11 +254,12 @@ class GotMP3
       heading = tracks[0].album_artist + ' - ' + tracks[0].album
 
       s = "# %s\n\n" % [heading]
-      h = tracks.group_by(&:disc)
 
 
       if format.to_sym == :txt then
 
+        h = tracks.group_by(&:disc)
+
         body = if h.length == 1 then
 
           list(tracks)
@@ -207,13 +282,16 @@ class GotMP3
         dx = DxLite.new('album[album_artist, album]/track(tracknum, title, ' +
                                                  'artist, disc, album_artist)')
 
-        h.each {|_,x| puts x.inspect } if @debug
-        h.each {|_,x| x.each {|track| dx.create(track.to_h) } }
+        #h.each {|_,x| puts x.inspect } if @debug
+        #h.each {|_,x| x.each {|track| dx.create(track.to_h) } }
+        tracks.each {|track| dx.create(track.to_h) }
 
         dx.album_artist = dx.all[0].album_artist
         dx.album = dx.all[0].album
         dx.save File.join(directory, 'playlist.dx')
 
+        yield(directory) if block_given?
+
       end
 
     end
@@ -231,7 +309,7 @@ class GotMP3
     image_file = File.new(File.join(directory, img_filename),'rb')
     img = image_file.read
 
-    each_mp3_track(directory) do |mp3, _, _|
+    each_media_track(directory) do |mp3, _, _|
 
       mp3.tag2.remove_pictures
       mp3.tag2.add_picture img
@@ -240,14 +318,16 @@ class GotMP3
 
   end
 
+  # Modifies the MP3s' tags using the track titles in the .txt file
+  #
   def add_tracktitles(directory, txt_filename)
 
     txt_file = File.join(directory, txt_filename)
     track_titles = File.read(txt_file).lines[1..-1].map(&:strip)
 
-    each_mp3_track(directory) do |mp3, trackno, _|
+    each_media_track(directory) do |media, trackno, _|
 
-      mp3.tag.title = track_titles[trackno-1]
+      media.tag.title = track_titles[trackno-1]
 
     end
   end
@@ -285,11 +365,16 @@ class GotMP3
 
   end
 
-  def each_mp3_track(directory, &blk)
+  def each_media_track(directory, &blk)
 
-    each_mp3_file(directory) do |mp3_filepath, i|
+    each_media_file(directory) do |filepath, i|
 
-      Mp3Info.open(mp3_filepath) {|mp3|  blk.call(mp3, i+1, mp3_filepath) }
+      case File.extname(filepath)
+      when '.mp3'
+        Mp3Info.open(filepath) {|mp3|  blk.call(mp3, i+1, filepath) }
+      when '.ogg'
+        OggInfo.open(filepath) {|ogg|  blk.call(ogg, i+1, filepath) }
+      end
 
     end
 
@@ -309,6 +394,8 @@ class GotMP3
     end
   end
 
+  # used by public method *write_titles* to list the tracks in plain text
+  #
   def list(tracks)
 
     a = if tracks.map(&:artist).uniq.length < 2 then
@@ -321,6 +408,33 @@ class GotMP3
 
   end
 
+  def mp3info(mp3)
+    {
+      title: mp3.tag.title.sub(/^\d+\. */,''),
+      artist: mp3.tag.artist,
+      album: mp3.tag.album,
+      album_artist: mp3.tag2['TPE2'] || mp3.tag.artist,
+      disc: mp3.tag2['TPOS'] || 1,
+      tracknum: mp3.tag.tracknum,
+    }
+  end
+
+  def ogginfo(ogg)
+
+    # options
+    # ["title", "artist", "tracknumber", "tracktotal", "album", "albumartist",
+    #  "genre", "discid", "musicbrainz_discid"]
+
+    {
+      title: ogg.tag.title.sub(/^\d+\. */,''),
+      artist: ogg.tag.artist,
+      album: ogg.tag.album,
+      album_artist: ogg.tag.albumartist || ogg.tag.artist,
+      disc: ogg.tag.discid || 1,
+      tracknum: ogg.tag.tracknumber,
+    }
+  end
+
 end
 
 class Titles

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: got_mp3
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   RFrZsrDO1Cwk4v03qCUvuZ8H/nCojYYJGMrJE1JhBBJNJXCAULivh/zlOYcDhG69
   uPtZOD7YKrG45OftX8aNxlNv
   -----END CERTIFICATE-----
-date: 2021-11-27 00:00:00.000000000 Z
+date: 2021-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dxlite
@@ -77,6 +77,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.10
+- !ruby/object:Gem::Dependency
+  name: ruby-ogginfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: playlist_creator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: 
 email: digital.robertson@gmail.com
 executables: []