dmap 0.1.4 → 0.1.5

data/README.rdoc

@@ -21,7 +21,7 @@ We all love examples, so here's an example of how to use this module:
     # You can load from any IO source:
     d = DMAP::Element(open("your_dmap"))
     p d
-    # => <MSRV: [<MINM: "I'm a string!">]>
+    # => <MINM: "I'm a string!">
 
     # Or write out what you want in code:
     d = DMAP::Element.new("msrv",[DMAP::Element.new('minm',"I'm a string!")])
@@ -37,6 +37,21 @@ We all love examples, so here's an example of how to use this module:
 
     p d
     # => <MSRV: [<MINM: "I'm a string!">, <ASDM: Fri Nov 06 11:18:29 +0000 2009>, <ASTM: 123>]>
+    
+    # Ooh! And there's more, if you're parsing a DMAP and it's very large, this
+    # library plays nice and only parses the bits you need so far:
+	d = DMAP::Element(open("your_array-like_dmap"))
+    p d
+    # => <MSRV: Some unparsed DMAP elements>
+	# Calling any method of the array that requires knowledge of its contents
+	# will automagically parse what's required, or you can call it explicitly:
+    d.parse_dmap
+    p d
+    # => <MSRV: [<MINM: "I'm a string!">,<MSRV: Some unparsed DMAP elements>]>
+    # Or, if you'd rather not have to worry you can just tell arrays to parse immediately:
+    DMAP::Array.parse_immediately = true
+    # Just remember you have to do this before you start any parsing in order for it to have an effect
+    
 
 If you want to allow parsing of more tags, you're probably not going to want to go there right now (I'm likely to change the way this works) but if you just specify a new constant in the DMAP module, who's name is the 4-byte code, set it to an array like [:string, 'domain.app.name'].
 

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "dmap"
-    gem.version = "0.1.4"
+    gem.version = "0.1.5"
     gem.summary = %Q{Parses Apple's DMAP strings (4-byte serialization method)}
     gem.description = %Q{Apple uses a system of serialization (I think its called dmap…) where a 4-byte string tells of the information following, both its type and what it represents. Its used in the DAAP (Protocol), QuickTime mov structure and doubtless many other places.}
     gem.email = "jphastings@gmail.com"

data/lib/dmap.rb

@@ -48,6 +48,10 @@ module DMAP
       end
     end
     
+    def is_dmap?
+      true
+    end
+    
     def close_stream
       begin
         @io.close
@@ -126,7 +130,6 @@ module DMAP
   # it later if the contents are requested
   class Array < Array
     attr_reader :unparsed_data
-    attr_accessor :parse_immediately
     @@parse_immediately = false
     
     def self.parse_immediately
@@ -150,7 +153,7 @@ module DMAP
       rescue NoMethodError
         begin
           array_or_io.each do |element|
-            if element.is_a? DMAP::Element
+            if element.is_dmap?
               self.push element
             else
               raise "Thisneeds to be a DMAP::Element. #{element.inspect}"
@@ -278,154 +281,154 @@ module DMAP
     end
   end
   
-  MLIT = [:list,   'dmap.listingitem']
-  ASSL = [:string, 'daap.sortalbumartist']
-  ASBO = [:number, 'daap.songbookmark']
+  #F�CH = [:number, 'dmap.haschildcontainers']
+  ABAL = [:list,   'daap.browsealbumlisting']
+  ABAR = [:list,   'daap.browseartistlisting']
+  ABCP = [:list,   'daap.browsecomposerlisting']
+  ABGN = [:list,   'daap.browsegenrelisting']
+  ABPL = [:number, 'daap.baseplaylist']
+  ABRO = [:list,   'daap.databasebrowse']
+  ADBS = [:list,   'daap.databasesongs']
+  AEAI = [:number, 'com.apple.itunes.itms-artistid']
+  AECI = [:number, 'com.apple.itunes.itms-composerid']
+  AECR = [:string, 'com.apple.itunes.content-rating']
+  AEEN = [:string, 'com.apple.itunes.episode-num-str']
+  AEES = [:number, 'com.apple.itunes.episode-sort']
+  AEFP = [:number, 'com.apple.itunes.req-fplay']
+  AEGD = [:number, 'com.apple.itunes.gapless-enc-dr']
+  AEGE = [:number, 'com.apple.itunes.gapless-enc-del']
+  AEGH = [:number, 'com.apple.itunes.gapless-heur']
+  AEGI = [:number, 'com.apple.itunes.itms-genreid']
+  AEGR = [:number, 'com.apple.itunes.gapless-resy']
   AEGU = [:number, 'com.apple.itunes.gapless-dur']
-  MSRV = [:list,   'dmap.serverinforesponse']
+  AEHD = [:number, 'com.apple.itunes.is-hd-video']
+  AEHV = [:number, 'com.apple.itunes.has-video']
+  AEMK = [:number, 'com.apple.itunes.mediakind']
+  AENN = [:string, 'com.apple.itunes.network-name']
+  AENV = [:number, 'com.apple.itunes.norm-volume']
+  AEPC = [:number, 'com.apple.itunes.is-podcast']
+  AEPI = [:number, 'com.apple.itunes.itms-playlistid']
+  AEPP = [:number, 'com.apple.itunes.is-podcast-playlist']
+  AEPS = [:number, 'com.apple.itunes.special-playlist']
+  AESF = [:number, 'com.apple.itunes.itms-storefrontid']
+  AESG = [:number, 'com.apple.itunes.saved-genius']
+  AESI = [:number, 'com.apple.itunes.itms-songid']
   AESN = [:string, 'com.apple.itunes.series-name']
-  ASDR = [:time,   'daap.songdatereleased']
-  MPER = [:number, 'dmap.persistentid']
-  ASSR = [:number, 'daap.songsamplerate']
-  ASBT = [:number, 'daap.songbeatsperminute']
-  AEGE = [:number, 'com.apple.itunes.gapless-enc-del']
-  MSTO = [:signed, 'dmap.utcoffset']
-  ABAR = [:list,   'daap.browseartistlisting']
-  MCNA = [:string, 'dmap.contentcodesname']
-  ASEQ = [:string, 'daap.songeqpreset']
+  AESP = [:number, 'com.apple.itunes.smart-playlist']
+  AESU = [:number, 'com.apple.itunes.season-num']
+  AESV = [:number, 'com.apple.itunes.music-sharing-version']
   AGRP = [:string, 'daap.songgrouping']
-  MSAU = [:number, 'dmap.authenticationmethod']
-  ASCN = [:string, 'daap.songcontentdescription']
-  AEGR = [:number, 'com.apple.itunes.gapless-resy']
-  ASSZ = [:number, 'daap.songsize']
-  MSTT = [:number, 'dmap.status']
-  MCTC = [:number, 'dmap.containercount']
-  ASGP = [:number, 'daap.songgapless']
+  APLY = [:list,   'daap.databaseplaylists']
+  APRM = [:number, 'daap.playlistrepeatmode']
   APRO = [:version,'daap.protocolversion']
-  ABPL = [:number, 'daap.baseplaylist']
-  MSBR = [:number, 'dmap.supportsbrowse']
-  ASTN = [:number, 'daap.songtracknumber']
-  ASCR = [:number, 'daap.songcontentrating']
-  AEMK = [:number, 'com.apple.itunes.mediakind']
-  MUDL = [:list,   'dmap.deletedidlisting']
+  APSM = [:number, 'daap.playlistshufflemode']
   APSO = [:list,   'daap.playlistsongs']
-  ADBS = [:list,   'daap.databasesongs']
-  MDCL = [:list,   'dmap.dictionary']
-  ASLC = [:string, 'daap.songlongcontentdescription']
-  MSEX = [:number, 'dmap.supportsextensions']
-  ASYR = [:number, 'daap.songyear']
-  ASDA = [:time,   'daap.songdateadded']
-  AEPC = [:number, 'com.apple.itunes.is-podcast']
-  MUTY = [:number, 'dmap.updatetype']
-  MIKD = [:number, 'dmap.itemkind']
-  ASRV = [:signed, 'daap.songrelativevolume']
+  ARIF = [:list,   'daap.resolveinfo']
+  ARSV = [:list,   'daap.resolve']
   ASAA = [:string, 'daap.songalbumartist']
-  AECI = [:number, 'com.apple.itunes.itms-composerid']
-  MSMA = [:number, 'unknown_msma']
-  AEPS = [:number, 'com.apple.itunes.special-playlist']
-  CEJC = [:signed, 'com.apple.itunes.jukebox-client-vote']
-  ASDC = [:number, 'daap.songdisccount']
-  MLCL = [:list,   'dmap.listing']
-  ASSA = [:string, 'daap.sortartist']
+  ASAI = [:number, 'daap.songalbumid']
+  ASAL = [:string, 'daap.songalbum']
   ASAR = [:string, 'daap.songartist']
-  AEES = [:number, 'com.apple.itunes.episode-sort']
-  MSQY = [:number, 'dmap.supportsquery']
-  ASDN = [:number, 'daap.songdiscnumber']
-  AESG = [:number, 'com.apple.itunes.saved-genius']
-  MLOG = [:list,   'dmap.loginresponse']
-  ASSN = [:string, 'daap.sortname']
+  ASBK = [:number, 'daap.bookmarkable']
+  ASBO = [:number, 'daap.songbookmark']
   ASBR = [:number, 'daap.songbitrate']
-  MSTC = [:time,   'dmap.utctime']
-  ASDT = [:string, 'daap.songdescription']
-  AESP = [:number, 'com.apple.itunes.smart-playlist']
-  ABAL = [:list,   'daap.browsealbumlisting']
-  MBCL = [:list,   'dmap.bag']
-  MPRO = [:version,'dmap.protocolversion']
-  ASSS = [:string, 'daap.sortseriesname']
+  ASBT = [:number, 'daap.songbeatsperminute']
   ASCD = [:number, 'daap.songcodectype']
-  AEGH = [:number, 'com.apple.itunes.gapless-heur']
-  APLY = [:list,   'daap.databaseplaylists']
-  ABCP = [:list,   'daap.browsecomposerlisting']
-  MCNM = [:number, 'dmap.contentcodesnumber']
-  ASFM = [:string, 'daap.songformat']
-  MSAL = [:number, 'dmap.supportsautologout']
-  ASTC = [:number, 'daap.songtrackcount']
+  ASCM = [:string, 'daap.songcomment']
+  ASCN = [:string, 'daap.songcontentdescription']
   ASCO = [:number, 'daap.songcompilation']
-  AEHD = [:number, 'com.apple.itunes.is-hd-video']
-  MSUP = [:number, 'dmap.supportsupdate']
-  MCTI = [:number, 'dmap.containeritemid']
-  ASHP = [:number, 'daap.songhasbeenplayed']
-  MSDC = [:number, 'dmap.databasescount']
-  AENN = [:string, 'com.apple.itunes.network-name']
-  ASUL = [:string, 'daap.songdataurl']
+  ASCP = [:string, 'daap.songcomposer']
+  ASCR = [:number, 'daap.songcontentrating']
   ASCS = [:number, 'daap.songcodecsubtype']
-  MUPD = [:list,   'dmap.updateresponse']
+  ASCT = [:string, 'daap.songcategory']
+  ASDA = [:time,   'daap.songdateadded']
+  ASDB = [:number, 'daap.songdisabled']
+  ASDC = [:number, 'daap.songdisccount']
+  ASDK = [:number, 'daap.songdatakind']
+  ASDM = [:time,   'daap.songdatemodified']
+  ASDN = [:number, 'daap.songdiscnumber']
+  ASDP = [:time,   'daap.songdatepurchased']
+  ASDR = [:time,   'daap.songdatereleased']
+  ASDT = [:string, 'daap.songdescription']
+  ASED = [:number, 'daap.songextradata']
+  ASEQ = [:string, 'daap.songeqpreset']
+  ASFM = [:string, 'daap.songformat']
+  ASGN = [:string, 'daap.songgenre']
+  ASGP = [:number, 'daap.songgapless']
+  ASHP = [:number, 'daap.songhasbeenplayed']
+  ASKY = [:string, 'daap.songkeywords']
+  ASLC = [:string, 'daap.songlongcontentdescription']
   ASLS = [:number, 'daap.songlongsize']
-  ARIF = [:list,   'daap.resolveinfo']
-  AEAI = [:number, 'com.apple.itunes.itms-artistid']
-  MEDS = [:number, 'dmap.editcommandssupported']
-  #F�CH = [:number, 'dmap.haschildcontainers']
-  MSIX = [:number, 'dmap.supportsindex']
+  ASPU = [:string, 'daap.songpodcasturl']
+  ASRV = [:signed, 'daap.songrelativevolume']
+  ASSA = [:string, 'daap.sortartist']
+  ASSC = [:string, 'daap.sortcomposer']
+  ASSL = [:string, 'daap.sortalbumartist']
+  ASSN = [:string, 'daap.sortname']
+  ASSP = [:number, 'daap.songstoptime']
+  ASSR = [:number, 'daap.songsamplerate']
+  ASSS = [:string, 'daap.sortseriesname']
+  ASST = [:number, 'daap.songstarttime']
+  ASSU = [:string, 'daap.sortalbum']
+  ASSZ = [:number, 'daap.songsize']
+  ASTC = [:number, 'daap.songtrackcount']
+  ASTM = [:number, 'daap.songtime']
+  ASTN = [:number, 'daap.songtracknumber']
+  ASUL = [:string, 'daap.songdataurl']
+  ASUR = [:number, 'daap.songuserrating']
+  ASYR = [:number, 'daap.songyear']
   ATED = [:number, 'daap.supportsextradata']
-  AEPI = [:number, 'com.apple.itunes.itms-playlistid']
-  MIMC = [:number, 'dmap.itemcount']
-  AECR = [:string, 'com.apple.itunes.content-rating']
-  ASAI = [:number, 'daap.songalbumid']
-  MSML = [:list,   'unknown_msml']
-  ASDK = [:number, 'daap.songdatakind']
-  AESU = [:number, 'com.apple.itunes.season-num']
+  AVDB = [:list,   'daap.serverdatabases']
+  CEJC = [:signed, 'com.apple.itunes.jukebox-client-vote']
   CEJI = [:number, 'com.apple.itunes.jukebox-current']
-  MLID = [:number, 'dmap.sessionid']
-  ASSC = [:string, 'daap.sortcomposer']
-  ASBK = [:number, 'daap.bookmarkable']
-  AEFP = [:number, 'com.apple.itunes.req-fplay']
-  MSRS = [:number, 'dmap.supportsresolve']
+  CEJS = [:signed, 'com.apple.itunes.jukebox-score']
   CEJV = [:number, 'com.apple.itunes.jukebox-vote']
-  ASDP = [:time,   'daap.songdatepurchased']
-  AESI = [:number, 'com.apple.itunes.itms-songid']
-  MPCO = [:number, 'dmap.parentcontainerid']
-  AEGD = [:number, 'com.apple.itunes.gapless-enc-dr']
-  ASSP = [:number, 'daap.songstoptime']
-  MSTM = [:number, 'dmap.timeoutinterval']
+  MBCL = [:list,   'dmap.bag']
   MCCR = [:list,   'dmap.contentcodesresponse']
-  ASED = [:number, 'daap.songextradata']
-  AESV = [:number, 'com.apple.itunes.music-sharing-version']
-  MRCO = [:number, 'dmap.returnedcount']
-  AEGI = [:number, 'com.apple.itunes.itms-genreid']
-  ASST = [:number, 'daap.songstarttime']
-  ASCM = [:string, 'daap.songcomment']
-  MSTS = [:string, 'dmap.statusstring']
-  ASGN = [:string, 'daap.songgenre']
-  APRM = [:number, 'daap.playlistrepeatmode']
-  ABGN = [:list,   'daap.browsegenrelisting']
+  MCNA = [:string, 'dmap.contentcodesname']
+  MCNM = [:number, 'dmap.contentcodesnumber']
   MCON = [:list,   'dmap.container']
-  MSAS = [:number, 'dmap.authenticationschemes']
-  ASTM = [:number, 'daap.songtime']
-  ASCP = [:string, 'daap.songcomposer']
-  AEHV = [:number, 'com.apple.itunes.has-video']
-  MTCO = [:number, 'dmap.specifiedtotalcount']
-  ABRO = [:list,   'daap.databasebrowse']
+  MCTC = [:number, 'dmap.containercount']
+  MCTI = [:number, 'dmap.containeritemid']
   MCTY = [:number, 'dmap.contentcodestype']
-  ASKY = [:string, 'daap.songkeywords']
-  APSM = [:number, 'daap.playlistshufflemode']
-  MSED = [:number, 'unknown_msed']
-  ASCT = [:string, 'daap.songcategory']
-  AENV = [:number, 'com.apple.itunes.norm-volume']
-  ASUR = [:number, 'daap.songuserrating']
-  MUSR = [:number, 'dmap.serverrevision']
+  MDCL = [:list,   'dmap.dictionary']
+  MEDS = [:number, 'dmap.editcommandssupported']
   MIID = [:number, 'dmap.itemid']
-  ASPU = [:string, 'daap.songpodcasturl']
-  ARSV = [:list,   'daap.resolve']
-  MSLR = [:number, 'dmap.loginrequired']
-  AVDB = [:list,   'daap.serverdatabases']
-  ASDB = [:number, 'daap.songdisabled']
-  AEPP = [:number, 'com.apple.itunes.is-podcast-playlist']
+  MIKD = [:number, 'dmap.itemkind']
+  MIMC = [:number, 'dmap.itemcount']
   MINM = [:string, 'dmap.itemname']
-  ASAL = [:string, 'daap.songalbum']
-  AEEN = [:string, 'com.apple.itunes.episode-num-str']
-  ASSU = [:string, 'daap.sortalbum']
+  MLCL = [:list,   'dmap.listing']
+  MLID = [:number, 'dmap.sessionid']
+  MLOG = [:list,   'dmap.loginresponse']
+  MPCO = [:number, 'dmap.parentcontainerid']
+  MPER = [:number, 'dmap.persistentid']
+  MPRO = [:version,'dmap.protocolversion']
+  MRCO = [:number, 'dmap.returnedcount']
+  MSAL = [:number, 'dmap.supportsautologout']
+  MSAS = [:number, 'dmap.authenticationschemes']
+  MSAU = [:number, 'dmap.authenticationmethod']
+  MSBR = [:number, 'dmap.supportsbrowse']
+  MSDC = [:number, 'dmap.databasescount']
+  MSED = [:number, 'unknown_msed']
+  MSEX = [:number, 'dmap.supportsextensions']
+  MSIX = [:number, 'dmap.supportsindex']
+  MSLR = [:number, 'dmap.loginrequired']
+  MSMA = [:number, 'unknown_msma']
+  MSML = [:list,   'unknown_msml']
   MSPI = [:number, 'dmap.supportspersistentids']
-  CEJS = [:signed, 'com.apple.itunes.jukebox-score']
-  ASDM = [:time,   'daap.songdatemodified']
-  AESF = [:number, 'com.apple.itunes.itms-storefrontid']
+  MSQY = [:number, 'dmap.supportsquery']
+  MSRS = [:number, 'dmap.supportsresolve']
+  MSRV = [:list,   'dmap.serverinforesponse']
+  MSTC = [:time,   'dmap.utctime']
+  MSTM = [:number, 'dmap.timeoutinterval']
+  MSTO = [:signed, 'dmap.utcoffset']
+  MSTS = [:string, 'dmap.statusstring']
+  MSTT = [:number, 'dmap.status']
+  MSUP = [:number, 'dmap.supportsupdate']
+  MTCO = [:number, 'dmap.specifiedtotalcount']
+  MUDL = [:list,   'dmap.deletedidlisting']
+  MUPD = [:list,   'dmap.updateresponse']
+  MUSR = [:number, 'dmap.serverrevision']
+  MUTY = [:number, 'dmap.updatetype']
+  MLIT = [:list,   'dmap.listingitem']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dmap
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - JP Hastings-Spital