iptc 0.0.2 → 0.0.3

data/lib/iptc.rb

@@ -1,3 +1,3 @@
-require 'iptc/jpeg/image'
-require 'iptc/jpeg/markers'
-
+require 'iptc/jpeg/image'
+require 'iptc/jpeg/markers'
+

data/lib/iptc/jpeg/image.rb

@@ -1,100 +1,123 @@
-require 'logger'
-
-require 'iptc/multiple_hash'
-require 'iptc/jpeg/marker_headers'
-
-module IPTC
-  module JPEG
-    class Image
-      attr_reader :values
-      # creates a JPEG image from a file and does a "quick" load (Only the metadata
-      # are loaded, not the whole file).
-      def initialize filename, quick=true
-        @logger = Logger.new(STDOUT)
-        @logger.datetime_format = "%H:%M:%S"
-        @logger.level = $DEBUG?(Logger::DEBUG):(Logger::INFO)
-      
-        @filename = filename
-        @position = 0
-        @content = File.open(@filename).binmode.read
-      
-      
-        if MARKERS[read(2)]!="SOI"
-          raise  NotJPEGFileException.new("Not a JPEG file: #{@filename}")
-        end
-      
-        @markers = Array.new()
-      
-        begin
-      
-          catch(:end_of_metadata) do
-            while true
-              @markers << read_marker
-            end
-          end
-        
-        rescue Exception=>e
-          @logger.info "Exception in file #{@filename}:\n"+e.to_s
-          raise e
-        end
-        # Markers all read
-        # move back
-        seek(-2)
-      
-        # in full mode, read the rest
-        if !quick
-          @data = read_rest
-        end
-      
-        @values = MultipleHash.new
-      
-        @markers.each do |marker|
-          # puts "processing marker: #{marker.inspect}"
-          marker.parse
-          # puts marker.valid?
-          @values.add(marker, marker.values)
-        end
-      end
-    
-      def read(count)
-        @position += count
-        return @content[@position-count...@position]
-      end
-      def seek(count)
-        @position += count
-      end
-    
-      def l message
-        @logger.debug message
-      end
-    
-      # write the image to the disk
-      def write filename
-        f = File.open(filename,"wb+")
-        f.print "\xFF\xD8"
-      
-        @markers.each do |marker|
-          f.print marker.to_binary
-        end
-        f.print @data.to_binary
-        f.close
-      
-      end
-    
-      def read_marker
-        type = read(2)
-        # finished reading all the metadata
-        throw :end_of_metadata if MARKERS[type]=='SOS'
-        size = read(2)
-        data = read(size.unpack('n')[0]-2)
-      
-        return Marker.NewMarker(MARKERS[type], type+size+data, @logger)
-      end
-      def read_rest
-        rest = @content[@position..-1]
-        return Marker.new("BIN",rest)
-      end
-    
-    end
-  end
-end
+require 'logger'
+
+require 'iptc/multiple_hash'
+require 'iptc/jpeg/marker_headers'
+
+module IPTC
+  module JPEG
+    class Image
+      # Array of MultipleHashItem objects
+      attr_reader :values
+
+      # creates a JPEG image from a data blob and does a "quick" load (Only the metadata
+      # are loaded, not the whole file).      
+      def Image.from_blob blob, quick=true
+        return Image.new("Data blob", blob, true)
+      end
+      # creates a JPEG image from a file and does a "quick" load (Only the metadata
+      # are loaded, not the whole file).
+      def Image.from_file filename, quick=true
+        content = nil
+        raise "File #{filename} not found" if !File.exists?(filename)
+        File.open(filename) do |f|
+          f.binmode
+          content = f.read
+        end
+        return Image.new(filename, content, quick)        
+
+      end
+      # Real constructor. Should never be called directly
+      # take a "data name" that is used for error reporting.
+      def initialize data_name, content, quick=true
+        @logger = Logger.new(STDOUT)
+        @logger.datetime_format = "%H:%M:%S"
+        @logger.level = Logger::DEBUG # $DEBUG?(Logger::DEBUG):(Logger::INFO)
+      
+        @data_name = data_name
+        @content = content
+
+        @position = 0
+      
+        if MARKERS[read(2)]!="SOI"
+          raise  NotJPEGFileException.new("Not JPEG data: #{@data_name}")
+        end
+      
+        @markers = Array.new()
+      
+        begin
+      
+          catch(:end_of_metadata) do
+            while true
+              @markers << read_marker
+            end
+          end
+        
+        rescue Exception=>e
+          @logger.info "Exception in data #{@data_name}:\n"+e.to_s
+          raise e
+        end
+        # Markers all read
+        # move back
+        seek(-2)
+      
+        # in full mode, read the rest
+        if !quick
+          @data = read_rest
+        end
+      
+        @values = MultipleHash.new
+      
+        @markers.each do |marker|
+          # puts "processing marker: #{marker.inspect}"
+          marker.parse
+          # puts marker.valid?
+          @values.add(marker, marker.values)
+        end
+      end
+    
+      def read(count)
+        @position += count
+        return @content[@position-count...@position]
+      end
+      def seek(count)
+        @position += count
+      end
+    
+      def l message
+        @logger.debug message
+      end
+    
+      # write the image to the disk
+      def write data_name
+        f = File.open(data_name,"wb+")
+        f.print "\xFF\xD8"
+      
+        @markers.each do |marker|
+          f.print marker.to_binary
+        end
+        f.print @data.to_binary
+        f.close
+      
+      end
+    
+      def read_marker
+        type = read(2)
+        # finished reading all the metadata
+        throw :end_of_metadata if MARKERS[type]=='SOS'
+        size = read(2)
+        data = read(size.unpack('n')[0]-2)
+      
+        return Marker.NewMarker(MARKERS[type], type+size+data, @logger)
+      end
+      def read_rest
+        rest = @content[@position..-1]
+        return Marker.new("BIN",rest)
+      end
+			def to_s
+				"Image #{@data_name}:\n" +
+				@markers.map{ |m| m.to_s  }.join("\n")
+			end
+    
+    end
+  end
+end

data/lib/iptc/jpeg/marker.rb

@@ -14,7 +14,7 @@ module IPTC
           # Inspect the object space in order to find something usable later
           def Marker.NewMarker(type,data, logger)
             marker_class = "#{type}Marker"
-              if JPEG::Markers.constants.include?(marker_class.to_sym)
+              if JPEG::Markers.constants.include?(marker_class.to_s)
                   return JPEG::Markers.const_get(marker_class).new(type, data)
               else
                 if !@@missing.include?(type)

data/lib/iptc/jpeg/marker_headers.rb

@@ -1,67 +1,67 @@
-module IPTC
-  module JPEG
-      MARKERS = {
-          "\xFF\xD8" => 'SOI',
-          "\xFF\xc0" => 'SOF0',
-          "\xFF\xc1" => 'SOF1',
-          "\xFF\xc2" => 'SOF2',
-          "\xFF\xc3" => 'SOF3',
-
-          "\xFF\xc5" => 'SOF5',
-          "\xFF\xc6" => 'SOF6',
-          "\xFF\xc7" => 'SOF7',
-
-          "\xFF\xc8" => 'JPG',
-          "\xFF\xc9" => 'SOF9',
-          "\xFF\xca" => 'SOF10',
-          "\xFF\xcb" => 'SOF11',
-
-          "\xFF\xcd" => 'SOF13',
-          "\xFF\xce" => 'SOF14',
-          "\xFF\xcf" => 'SOF15',
-
-          "\xFF\xc4" => 'DHT',
-
-          "\xFF\xcc" => 'DAC',
-
-          "\xFF\xd0" => 'RST0',
-          "\xFF\xd1" => 'RST1',
-          "\xFF\xd2" => 'RST2',
-          "\xFF\xd3" => 'RST3',
-          "\xFF\xd4" => 'RST4',
-          "\xFF\xd5" => 'RST5',
-          "\xFF\xd6" => 'RST6',
-          "\xFF\xd7" => 'RST7',
-
-          "\xFF\xd8" => 'SOI',
-          "\xFF\xd9" => 'EOI',
-          "\xFF\xda" => 'SOS',
-          "\xFF\xdb" => 'DQT',
-          "\xFF\xdc" => 'DNL',
-          "\xFF\xdd" => 'DRI',
-          "\xFF\xde" => 'DHP',
-          "\xFF\xdf" => 'EXP',
-
-          "\xFF\xe0" => 'APP0',
-          "\xFF\xe1" => 'APP1',
-          "\xFF\xe2" => 'APP2',
-          "\xFF\xe3" => 'APP3',
-          "\xFF\xe4" => 'APP4',
-          "\xFF\xe5" => 'APP5',
-          "\xFF\xe6" => 'APP6',
-          "\xFF\xe7" => 'APP7',
-          "\xFF\xe8" => 'APP8',
-          "\xFF\xe9" => 'APP9',
-          "\xFF\xea" => 'APP10',
-          "\xFF\xeb" => 'APP11',
-          "\xFF\xec" => 'APP12',
-          "\xFF\xed" => 'APP13',
-          "\xFF\xee" => 'APP14',
-          "\xFF\xef" => 'APP15',
-          "\xFF\xf0" => 'JPG0',
-          "\xFF\xfd" => 'JPG13',
-          "\xFF\xfe" => 'COM',
-          "\xFF\x01" => 'TEM'
-      }
-  end
+module IPTC
+  module JPEG
+      MARKERS = {
+          "\xFF\xD8" => 'SOI',
+          "\xFF\xc0" => 'SOF0',
+          "\xFF\xc1" => 'SOF1',
+          "\xFF\xc2" => 'SOF2',
+          "\xFF\xc3" => 'SOF3',
+
+          "\xFF\xc5" => 'SOF5',
+          "\xFF\xc6" => 'SOF6',
+          "\xFF\xc7" => 'SOF7',
+
+          "\xFF\xc8" => 'JPG',
+          "\xFF\xc9" => 'SOF9',
+          "\xFF\xca" => 'SOF10',
+          "\xFF\xcb" => 'SOF11',
+
+          "\xFF\xcd" => 'SOF13',
+          "\xFF\xce" => 'SOF14',
+          "\xFF\xcf" => 'SOF15',
+
+          "\xFF\xc4" => 'DHT',
+
+          "\xFF\xcc" => 'DAC',
+
+          "\xFF\xd0" => 'RST0',
+          "\xFF\xd1" => 'RST1',
+          "\xFF\xd2" => 'RST2',
+          "\xFF\xd3" => 'RST3',
+          "\xFF\xd4" => 'RST4',
+          "\xFF\xd5" => 'RST5',
+          "\xFF\xd6" => 'RST6',
+          "\xFF\xd7" => 'RST7',
+
+          "\xFF\xd8" => 'SOI',
+          "\xFF\xd9" => 'EOI',
+          "\xFF\xda" => 'SOS',
+          "\xFF\xdb" => 'DQT',
+          "\xFF\xdc" => 'DNL',
+          "\xFF\xdd" => 'DRI',
+          "\xFF\xde" => 'DHP',
+          "\xFF\xdf" => 'EXP',
+
+          "\xFF\xe0" => 'APP0',
+          "\xFF\xe1" => 'APP1',
+          "\xFF\xe2" => 'APP2',
+          "\xFF\xe3" => 'APP3',
+          "\xFF\xe4" => 'APP4',
+          "\xFF\xe5" => 'APP5',
+          "\xFF\xe6" => 'APP6',
+          "\xFF\xe7" => 'APP7',
+          "\xFF\xe8" => 'APP8',
+          "\xFF\xe9" => 'APP9',
+          "\xFF\xea" => 'APP10',
+          "\xFF\xeb" => 'APP11',
+          "\xFF\xec" => 'APP12',
+          "\xFF\xed" => 'APP13',
+          "\xFF\xee" => 'APP14',
+          "\xFF\xef" => 'APP15',
+          "\xFF\xf0" => 'JPG0',
+          "\xFF\xfd" => 'JPG13',
+          "\xFF\xfe" => 'COM',
+          "\xFF\x01" => 'TEM'
+      }
+  end
 end

data/lib/iptc/marker_nomenclature.rb

@@ -1,49 +1,49 @@
-require 'singleton'
-require 'iptc/marker'
-
-module IPTC
-  class MarkerNomenclature
-    include Singleton
-    def MarkerNomenclature.markers(id)
-      return MarkerNomenclature.instance.markers(id)
-    end
-    
-    def markers(id)
-      if @markers.has_key?(id)
-        return @markers[id]
-      else
-        return @markers[-1]
-      end
-    end
-    
-    def populate
-      @markers = {}
-      begin
-        fullpath = nil
-        
-        [File.dirname(__FILE__), $:].flatten.each { |path|
-          break if File.exists?(fullpath = File.join(path, "iptc"))
-        }
-        content = File.open(fullpath).read
-      rescue Exception=>e
-        raise "Load failed for \"iptc\" file\nWith $:=#{$:.inspect}\n\n"+e
-      end
-      marker = Struct.new(:iid, :name, :description)
-      
-      m = marker.new
-      m.name = "Unknow marker"
-      m.iid = -1
-      @markers[-1] = m
-              
-      content.each_line do |line|
-          tags = line.split(/\t/)
-          m = marker.new
-          m[:name] = tags[0]
-          m[:description] = tags[1]
-          m[:iid] = tags[2].to_i
-          @markers[m.iid] = m
-      end
-    end
-  end
-  MarkerNomenclature.instance.populate
-end
+require 'singleton'
+require 'iptc/marker'
+require 'iptc/marker_nomenclature_data'
+
+require 'yaml'
+
+module IPTC
+  class MarkerNomenclature
+    include Singleton
+    def MarkerNomenclature.markers(id)
+      return MarkerNomenclature.instance.markers(id)
+    end
+		def markers_count
+			@markers.keys.length
+		end 
+    def markers(id)
+      if @markers.has_key?(id)
+        return @markers[id]
+      else
+        return @markers[-1]
+      end
+    end
+    
+    def populate
+      @markers = {}
+
+      marker = Struct.new(:iid, :name, :description)
+      
+      m = marker.new
+      m.name = "Unknown marker"
+      m.iid = -1
+      @markers[-1] = m
+              
+      NOMENCLATURE.each_line do |line|
+          m = marker.new
+          m[:name], m[:description], m[:iid] = line.split(/\t/)
+          m[:iid] = m[:iid].to_i
+          @markers[m.iid] = m
+      end
+    end
+		def benchmark
+			require 'benchmark'
+			Benchmark.bm(40) do |x|
+				x.report("Populate Markers") { 1000.times do populate(); end }
+			end
+		end
+  end
+end
+IPTC::MarkerNomenclature.instance.populate

data/lib/iptc/marker_nomenclature_data.rb

@@ -0,0 +1,63 @@
+module IPTC
+  class MarkerNomenclature
+    NOMENCLATURE=<<-EOS
+RecordVersion	Version of IIM part 2	0	0x0000	Yes	No	2	2	Iptc.Application2.RecordVersion
+ObjectType	IIM appendix G object type	3	0x0003	No	No	3	67	Iptc.Application2.ObjectType
+ObjectAttribute	IIM appendix G object attribute	4	0x0004	No	Yes	4	68	Iptc.Application2.ObjectAttribute
+ObjectName	Shorthand reference of content	5	0x0005	No	No	0	64	Iptc.Application2.ObjectName
+EditStatus	Content status	7	0x0007	No	No	0	64	Iptc.Application2.EditStatus
+EditorialUpdate	Indicates the type of update	8	0x0008	No	No	2	2	Iptc.Application2.EditorialUpdate
+Urgency	Editorial urgency of content	10	0x000a	No	No	1	1	Iptc.Application2.Urgency
+Subject	Structured definition of the subject	12	0x000c	No	Yes	13	236	Iptc.Application2.Subject
+Category	Identifies the subject	15	0x000f	No	No	0	3	Iptc.Application2.Category
+SuppCategory	Refines the subject	20	0x0014	No	Yes	0	32	Iptc.Application2.SuppCategory
+FixtureId	Identifies content that recurs	22	0x0016	No	No	0	32	Iptc.Application2.FixtureId
+Keywords	Information retrieval words	25	0x0019	No	Yes	0	64	Iptc.Application2.Keywords
+LocationCode	ISO country code for content	26	0x001a	No	Yes	3	3	Iptc.Application2.LocationCode
+LocationName	Full country name for content	27	0x001b	No	Yes	0	64	Iptc.Application2.LocationName
+ReleaseDate	Earliest intended usable date	30	0x001e	No	No	8	8	Iptc.Application2.ReleaseDate
+ReleaseTime	Earliest intended usable time	35	0x0023	No	No	11	11	Iptc.Application2.ReleaseTime
+ExpirationDate	Latest intended usable date	37	0x0025	No	No	8	8	Iptc.Application2.ExpirationDate
+ExpirationTime	Latest intended usable time	38	0x0026	No	No	11	11	Iptc.Application2.ExpirationTime
+SpecialInstructions	Editorial usage instructions	40	0x0028	No	No	0	256	Iptc.Application2.SpecialInstructions
+ActionAdvised	Action provided to previous data	42	0x002a	No	No	2	2	Iptc.Application2.ActionAdvised
+ReferenceService	Service Identifier of a prior envelope	45	0x002d	No	Yes	0	10	Iptc.Application2.ReferenceService
+ReferenceDate	Date of a prior envelope	47	0x002f	No	Yes	8	8	Iptc.Application2.ReferenceDate
+ReferenceNumber	Envelope Number of a prior envelope	50	0x0032	No	Yes	8	8	Iptc.Application2.ReferenceNumber
+DateCreated	Creation date of intellectual content	55	0x0037	No	No	8	8	Iptc.Application2.DateCreated
+TimeCreated	Creation time of intellectual content	60	0x003c	No	No	11	11	Iptc.Application2.TimeCreated
+DigitizationDate	Creation date of digital representation	62	0x003e	No	No	8	8	Iptc.Application2.DigitizationDate
+DigitizationTime	Creation time of digital representation	63	0x003f	No	No	11	11	Iptc.Application2.DigitizationTime
+Program	Content creation program	65	0x0041	No	No	0	32	Iptc.Application2.Program
+ProgramVersion	Content creation program version	70	0x0046	No	No	0	10	Iptc.Application2.ProgramVersion
+ObjectCycle	Morning	75	0x004b	No	No	1	1	Iptc.Application2.ObjectCycle
+Byline	Name of content creator	80	0x0050	No	Yes	0	32	Iptc.Application2.Byline
+BylineTitle	Title of content creator	85	0x0055	No	Yes	0	32	Iptc.Application2.BylineTitle
+City	City of content origin	90	0x005a	No	No	0	32	Iptc.Application2.City
+SubLocation	Location within city	92	0x005c	No	No	0	32	Iptc.Application2.SubLocation
+ProvinceState	Province/State of content origin	95	0x005f	No	No	0	32	Iptc.Application2.ProvinceState
+CountryCode	ISO country code of content origin	100	0x0064	No	No	3	3	Iptc.Application2.CountryCode
+CountryName	Full country name of content origin	101	0x0065	No	No	0	64	Iptc.Application2.CountryName
+TransmissionReference	Location of original transmission	103	0x0067	No	No	0	32	Iptc.Application2.TransmissionReference
+Headline	Content synopsis	105	0x0069	No	No	0	256	Iptc.Application2.Headline
+Credit	Content provider	110	0x006e	No	No	0	32	Iptc.Application2.Credit
+Source	Original owner of content	115	0x0073	No	No	0	32	Iptc.Application2.Source
+Copyright	Necessary copyright notice	116	0x0074	No	No	0	128	Iptc.Application2.Copyright
+Contact	Person or organisation to contact	118	0x0076	No	Yes	0	128	Iptc.Application2.Contact
+Caption	Content description	120	0x0078	No	No	0	2000	Iptc.Application2.Caption
+Writer	Person responsible for caption	122	0x007a	No	Yes	0	32	Iptc.Application2.Writer
+RasterizedCaption	Black and white caption image	125	0x007d	No	No	7360	7360	Iptc.Application2.RasterizedCaption
+ImageType	Color components in an image	130	0x0082	No	No	2	2	Iptc.Application2.ImageType
+ImageOrientation	Indicates the layout of an image	131	0x0083	No	No	1	1	Iptc.Application2.ImageOrientation
+Language	ISO 639:1988 language code	135	0x0087	No	No	2	3	Iptc.Application2.Language
+AudioType	Information about audio content	150	0x0096	No	No	2	2	Iptc.Application2.AudioType
+AudioRate	Sampling rate of audio content	151	0x0097	No	No	6	6	Iptc.Application2.AudioRate
+AudioResolution	Sampling resolution of audio content	152	0x0098	No	No	2	2	Iptc.Application2.AudioResolution
+AudioDuration	Duration of audio content	153	0x0099	No	No	6	6	Iptc.Application2.AudioDuration
+AudioOutcue	Final words or sounds of audio content	154	0x009a	No	No	0	64	Iptc.Application2.AudioOutcue
+PreviewFormat	IIM appendix A file format of preview	200	0x00c8	No	No	2	2	Iptc.Application2.PreviewFormat
+PreviewVersion	File format version of preview	201	0x00c9	No	No	2	2	Iptc.Application2.PreviewVersion
+Preview	Binary preview data	202	0x00ca	No	No	0	256000	Iptc.Application2.Preview
+EOS
+  end
+end

data/lib/iptc/multiple_hash.rb

@@ -3,6 +3,9 @@ module IPTC
 
   # a MultipleHash associate a String key, a Marker Object and a String value
   # this object 
+	
+
+	# This structure is too complicated.
   class MultipleHash
     def initialize()
       @internal = Hash.new
@@ -51,4 +54,4 @@ module IPTC
     end
   end
 
-end
+end

data/lib/iptc/version.rb

@@ -1,3 +1,3 @@
 module IPTC
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: iptc
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Pierre Baillet
@@ -15,13 +16,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 +02:00
+date: 2011-09-23 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Original code from http://raa.ruby-lang.org/project/jpeg-jfif-iptc/, gemified and updated by Jens Kraemer
+description: Original code from http://raa.ruby-lang.org/project/jpeg-jfif-iptc/, gemified and updated by Jens Kraemer, Futher fixes by Pierre Baillet
 email: 
-- jk@jkraemer.net
+- pierre@baillet.name
 executables: []
 
 extensions: []
@@ -35,13 +36,14 @@ files:
 - lib/iptc/jpeg/markers.rb
 - lib/iptc/marker.rb
 - lib/iptc/marker_nomenclature.rb
+- lib/iptc/marker_nomenclature_data.rb
 - lib/iptc/multiple_hash.rb
 - lib/iptc/version.rb
 - lib/iptc.rb
 - LICENSE
 - README.md
 has_rdoc: true
-homepage: http://github.com/jkraemer/ruby-iptc
+homepage: http://github.com/octplane/ruby-iptc
 licenses: []
 
 post_install_message: 
@@ -54,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1405560905508476106
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -63,6 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
@@ -71,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruby-iptc
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Pure ruby IPTC metadata reader