playlist 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3afe56ad81f3b8f00d9132b64f654b14c60c977
-  data.tar.gz: 0d7fd4cf379196ecbac561a8471d8011bb7d3682
+  metadata.gz: e0abdf1a10cd890a9d446a6617ed5bf12856dba0
+  data.tar.gz: 0719e57569fed6a8798e58db21eb50dd6c7dfc34
 SHA512:
-  metadata.gz: 28a5a2a72c16ffd5f19fbd97adf9317bcdb026f7e537623cafdb160ef88f1ee08cd427dc7b00bf6a81b3aa0d38f235f75febb6137479d15a75a3bc4372c2f938
-  data.tar.gz: 1f5c2c2abd8874c200005a2b2a9e70a126683dc0a7d9890166a3c67b59ca0e5e7c50701619438450339d3fd0b9ad1cfa786b2b185fa1591e0e6ea791639941b0
+  metadata.gz: 44aa5aff176b61c1ad739765882e4c7a7dde57f828a9f4eee95bf19112362d8bcb4b55fe24145e0b435e48f56746ff6bba83086bf810862ffe584f253821cbdc
+  data.tar.gz: e71116d7a8906db2cea15f117a4de683945e47b7fb285a36c8043635491c94979653be85adb0b90e4fd947d7fe6626baf4823fd128e32a58414a22ee78836c6b

data/README.md

@@ -9,7 +9,6 @@ It supports parsing and generating playlists in the following formats:
 * M3U
 * XSPF
 * A simple human readable format
-* SciSys dira XML
 
 ## Installation
 

data/lib/playlist.rb

@@ -14,6 +14,11 @@ class Playlist
   # @return [String]
   attr_accessor :annotation
 
+  # A URI (or filename) to the location of the media
+  # Use this if the playlist is a single file
+  # @return [String]
+  attr_accessor :media_location
+
   # A URL to get more inforamtion about this playlist
   # @return [String]
   attr_accessor :info_url
@@ -22,6 +27,11 @@ class Playlist
   # @return [String]
   attr_accessor :license
 
+  # Get a hash of identifier for this playlist
+  # Identifiers can either be Strings or URIs
+  # @return [Hash] an hash of identifiers
+  attr_reader :identifiers
+
   # Get the array that contains the list of track for this playlist
   # @return [Array<Track>] an array of tracks in the playlist
   attr_reader :tracks
@@ -51,6 +61,17 @@ class Playlist
     @tracks.map(&:duration).compact.inject(:+)
   end
 
+  # Calculate the start track times based on the duration.
+  # This method will only overwrite the start times, if not set
+  def calculate_start_times
+    time = tracks.first.start_time || 0
+    tracks.each do |track|
+      break if track.duration.nil?
+      time = (track.start_time ||= time)
+      time += track.duration
+    end
+  end
+
   autoload :Contributor, 'playlist/contributor'
   autoload :Track, 'playlist/track'
   autoload :Format, 'playlist/format'

data/lib/playlist/contributor.rb

@@ -6,6 +6,11 @@ class Playlist::Contributor
   # @return [String]
   attr_accessor :name
 
+  # Get a hash of identifier for this Contributor
+  # Identifiers can either be Strings or URIs
+  # @return [Hash] an hash of identifiers
+  attr_reader :identifiers
+
   # The role of the contribrition to the track
   #
   # Recommended values for role:
@@ -18,6 +23,7 @@ class Playlist::Contributor
 
   # Create a new Contributor
   def initialize(attr = nil)
+    @identifiers = {}
     if attr.is_a?(Hash)
       attr.each_pair do |key, value|
         send("#{key}=", value)

data/lib/playlist/format.rb

@@ -1,6 +1,6 @@
 # Base module for the various playlist formats
 module Playlist::Format
-  autoload :Dira, 'playlist/format/dira'
+  autoload :Cue, 'playlist/format/cue'
   autoload :M3U, 'playlist/format/m3u'
   autoload :SimpleText, 'playlist/format/simple_text'
   autoload :XSPF, 'playlist/format/xspf'

data/lib/playlist/format/cue.rb

@@ -0,0 +1,117 @@
+# Module to parse and generate Cue Sheet file format
+module Playlist::Format::Cue
+  class << self
+    # Parse a Cue Sheet file into a [Playlist]
+    # @param input any object that responds to #each_line
+    #        (either a String or a IO object)
+    # @return [Playlist] a new Playlist object
+    def parse(input)
+      Playlist.new do |playlist|
+        track = nil
+        input.each_line do |line|
+          if line =~ /^\s*REM\s/
+            next
+          elsif line =~ /^\s*TRACK (\d+) AUDIO/
+            track = Playlist::Track.new(
+              :track_number => Regexp.last_match(1).to_i
+            )
+            playlist.add_track(track)
+          elsif !track.nil?
+            parse_track_line(track, line.strip)
+          else
+            parse_playlist_line(playlist, line.strip)
+          end
+        end
+      end
+    end
+
+    # Generate a Cue Sheet from a Playlist
+    # @param playlist [Playlist] the playlist
+    # @return [String] the playlist in Cue Sheet format
+    def generate(playlist)
+      text = ''
+      playlist.calculate_start_times
+      text += generate_line(0, 'TITLE', playlist.title)
+      text += generate_line(
+        0, 'FILE', format_filename(playlist.media_location), false
+      )
+      playlist.tracks.each_with_index do |track, index|
+        text += generate_track(track, index + 1)
+      end
+      text
+    end
+
+    protected
+
+    def parse_track_line(track, line)
+      if line =~ /^\s*TITLE \"?(.+?)\"?$/
+        track.title = Regexp.last_match(1)
+      elsif line =~ /^\s*PERFORMER \"?(.+?)\"?$/
+        track.performer = Regexp.last_match(1)
+      elsif line =~ /^\s*ISRC \"?(\w+?)\"?$/
+        track.isrc = Regexp.last_match(1)
+      elsif line =~ /^\s*INDEX /
+        track.start_time = parse_time(line)
+      else
+        warn "Unknown command: #{line}"
+      end
+    end
+
+    def parse_playlist_line(playlist, line)
+      if line =~ /^\s*TITLE \"?(.+?)\"?$/
+        playlist.title = Regexp.last_match(1)
+      elsif line =~ /^\s*FILE \"?(.+?)\" (\w+)?$/
+        playlist.media_location = Regexp.last_match(1)
+      end
+    end
+
+    def generate_track(track, track_num)
+      text = ''
+      text += generate_line(1, 'TRACK', format('%2.2d AUDIO', track_num), false)
+      text += generate_line(2, 'TITLE', track.title)
+      text += generate_line(2, 'PERFORMER', track.performer)
+      text += generate_line(2, 'ISRC', track.isrc)
+      text += generate_line(2, 'INDEX 01', format_time(track.start_time), false)
+      text
+    end
+
+    def generate_line(depth, name, value, escape = true)
+      if value.nil?
+        ''
+      else
+        space = '  ' * depth
+        if escape
+          escaped = value.tr('"', "'")
+          "#{space}#{name} \"#{escaped}\"\n"
+        else
+          "#{space}#{name} #{value}\n"
+        end
+      end
+    end
+
+    def parse_time(timestamp)
+      if timestamp =~ /INDEX (\d+) (\d+):(\d+):(\d+)/
+        if Regexp.last_match(1).to_i == 1
+          mins = Regexp.last_match(2).to_f
+          secs = Regexp.last_match(3).to_f
+          frames = Regexp.last_match(4).to_f
+          (mins * 60) + secs + (frames / 75)
+        end
+      end
+    end
+
+    def format_time(duration)
+      duration = 0 if duration.nil?
+      mins = (duration / 60).floor
+      secs = (duration % 60).floor
+      frames = ((duration - duration.floor) * 75).round
+      format('%2.2d:%2.2d:%2.2d', mins, secs, frames)
+    end
+
+    def format_filename(location)
+      filename = File.basename(location)
+      fmt = File.extname(filename)[1..-1].upcase
+      "\"#{filename}\" #{fmt}"
+    end
+  end
+end

data/lib/playlist/track.rb

@@ -11,6 +11,11 @@ class Playlist::Track
   # @return [String]
   attr_accessor :album
 
+  # The catalogue number of the album that the track came from
+  # Also known as the UPC/EAN code
+  # @return [String]
+  attr_accessor :catalogue_number
+
   # The number of the track on the album it came from
   # @return [Integer]
   attr_accessor :track_number
@@ -37,6 +42,11 @@ class Playlist::Track
   # @return [Integer, Float]
   attr_reader :duration
 
+  # Get a hash of identifier for this Track
+  # Identifiers can either be Strings or URIs
+  # @return [Hash] an hash of identifiers
+  attr_reader :identifiers
+
   # Get the array of the contributors to this Track
   # @return [Array<Contributor>] an array of tracks in the playlist
   attr_reader :contributors
@@ -45,6 +55,7 @@ class Playlist::Track
   # @param attr [Hash] a hash of attibute values to set
   def initialize(attr = {})
     @contributors = []
+    @identifiers = {}
     attr.each_pair do |key, value|
       send("#{key}=", value)
     end
@@ -52,6 +63,18 @@ class Playlist::Track
     yield(self) if block_given?
   end
 
+  # Get the International Standard Recording Code for this track
+  # @return [String] the ISRC for the track
+  def isrc
+    @identifiers[:isrc]
+  end
+
+  # Set the International Standard Recording Code for this track
+  # @param isrc [String] the ISRC for the track
+  def isrc=(isrc)
+    @identifiers[:isrc] = isrc
+  end
+
   # Get a concatinated list of contributors names with no role
   # @return [String]
   def creator
@@ -81,6 +104,32 @@ class Playlist::Track
   end
   alias artist= performer=
 
+  # Get a conactinated list of composers for this track
+  # @return [String] the name of the composer or nil
+  def composer
+    contributor_names(:composer)
+  end
+
+  # Set the name of the composer for the track
+  # Removes any existing composers
+  # @param name [String] the name the composer
+  def composer=(name)
+    replace_contributor(:composer, name)
+  end
+
+  # Get a conactinated list of arrangers for this track
+  # @return [String] the name of the arranger or nil
+  def arranger
+    contributor_names(:arranger)
+  end
+
+  # Set the name of the arranger for the track
+  # Removes any existing arrangers
+  # @param name [String] the name the arranger
+  def arranger=(name)
+    replace_contributor(:arranger, name)
+  end
+
   # Set the duration of the track
   # If the duration is 0 or -1, then the duration is set to nil
   # @param seconds [Numeric] the duration of the track in seconds

data/lib/playlist/version.rb

@@ -1,4 +1,4 @@
 class Playlist
   # The version number of the Playlist Ruby gem
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playlist
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicholas Humfrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -140,7 +140,7 @@ files:
 - lib/playlist/contributor.rb
 - lib/playlist/ext/content_at.rb
 - lib/playlist/format.rb
-- lib/playlist/format/dira.rb
+- lib/playlist/format/cue.rb
 - lib/playlist/format/m3u.rb
 - lib/playlist/format/simple_text.rb
 - lib/playlist/format/xspf.rb

data/lib/playlist/format/dira.rb

@@ -1,57 +0,0 @@
-require 'nokogiri'
-
-unless Nokogiri::XML::Node.respond_to?(:content_at)
-  require 'playlist/ext/content_at.rb'
-end
-
-# Module to parse Scisys dira XML genealogy files
-module Playlist::Format::Dira
-  class << self
-    # Parse a Dira XML document into a new Playlist object
-    # @param input [String, IO] the source of the Dira XML
-    # @return [Playlist] a new Playlist object
-    def parse(input)
-      Playlist.new do |playlist|
-        doc = Nokogiri::XML(input)
-        playlist.title = doc.content_at(
-          '//TAKE/GENERIC/GENE_MULTIMEDIA_TITLE'
-        ) || doc.content_at(
-          '//TAKE/GENERIC/GENE_TITLE'
-        )
-        doc.xpath('//TAKE/GENEALOGY/GENEALOGY_ITEM').each do |item|
-          playlist.tracks << parse_genealogy_item(item)
-        end
-      end
-    end
-
-    protected
-
-    # Parse a single Genealogy Item from a Dira XML document
-    def parse_genealogy_item(doc)
-      Playlist::Track.new do |track|
-        track.title = doc.content_at('./CLIP/CLIP_INFO/GENE_TITLE')
-        track.album = doc.content_at('./CLIP/CLIP_INFO/GENE_ALBUM')
-        track.track_number = doc.content_at('./CLIP/CLIP_INFO/GENE_TRACK')
-        track.side = doc.content_at('./CLIP/CLIP_INFO/GENE_SIDE')
-        track.record_label = doc.content_at('./CLIP/CLIP_INFO/GENE_LABEL')
-        track.publisher = doc.content_at('./CLIP/CLIP_INFO/GENE_PUBLISHER')
-        if (duration = doc.content_at('./GENY_CLIP_LENGTH'))
-          track.duration = duration.to_f / 1000
-        end
-        doc.xpath('./CLIP/CLIP_PERSONS/PERSON').each do |person|
-          track.contributors << parse_person(person)
-        end
-      end
-    end
-
-    # Parse a single Person from a dira XML document
-    def parse_person(doc)
-      Playlist::Contributor.new do |c|
-        c.name = doc.content_at('PERSON_NAME')
-        if doc.content_at('PMAP_FUNC') =~ /^PERSON_FUNC\$(.+)\#(.*)$/
-          c.role = Regexp.last_match(1).downcase.to_sym
-        end
-      end
-    end
-  end
-end