id3tag 0.0.0 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmYzYTExMDI2NWEzZjk2N2RhMTE3OTlmMDE0MTI1ZDY2MDRkM2Q0Mg==
+  data.tar.gz: !binary |-
+    YTNmZTcwZGQzMTM3ZWEwNmE1NzJmMmQzYWFhMzI5MDQ0ZmFlN2NlYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OWEwOTQ5MzU4MDU3YWJjYzcyOTVhM2M5NDhlYzcxZDc2ZTNjMTViYmJjM2Zh
+    OTNlNWEyYzQzODcyOTY3ZGNiMDIzN2MyZGM2MjM2ZjQ1MDMxMDU0MWI5NDcw
+    NmNmZDM2NmUzZTJhNDE0OWVjZTcyNzYzMWFiMDFiZjQ2YTQ0ODQ=
+  data.tar.gz: !binary |-
+    ZTdkZDA0ZTdjOTMwNjE0OWE5Mzg1NGExMDQ4N2FkYTFlYWY0ZmY5OTg4NjFj
+    MDdmYWY0YzMxZjI4Njc5YWFjMWQzNmI2MmFiMDg5YTA3YTY0ZjljMWNjMGNl
+    OGI5OGYyOGY4ZDRiMzU0Y2ZmMTkxY2NhZjIyYmE3YWRmOWEyOTc=

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -1,14 +1,14 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1.5"
+  gem "debugger", :require => false, :platforms => :mri
+end
+
+group :development, :test do
   gem "jeweler", "~> 1.8.4"
-  gem "simplecov"
+  gem "rake"
+  gem "rdoc", "~> 3.12"
+  gem "rspec", "~> 2.13.0"
+  gem "simplecov", :require => false
+  gem 'coveralls', :require => false
 end

data/Gemfile.lock

@@ -1,37 +1,59 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    colorize (0.5.8)
+    columnize (0.3.6)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    debugger (1.5.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.0)
+    diff-lcs (1.2.2)
     git (1.2.5)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.5)
-    multi_json (1.5.0)
+    json (1.7.7)
+    json (1.7.7-java)
+    mime-types (1.23)
+    multi_json (1.6.1)
     rake (10.0.3)
-    rdoc (3.12)
+    rdoc (3.12.2)
       json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    thor (0.18.1)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.5)
+  coveralls
+  debugger
   jeweler (~> 1.8.4)
+  rake
   rdoc (~> 3.12)
-  rspec (~> 2.8.0)
+  rspec (~> 2.13.0)
   simplecov

data/README.md

@@ -0,0 +1,73 @@
+# ID3Tag
+Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards
+
+## Install
+
+Make sure you are using ruby 1.9.2 or greater
+
+Install ID3Tag at the command prompt:
+```
+gem install id3tag
+```
+
+Or add the gem to your Gemfile:
+```
+gem 'id3tag'
+```
+
+## How to use
+
+Require the libary and read basic metadata:
+```ruby
+require "id3tag"
+
+mp3_file = File.open('/path/to/your/favorite_song.mp3')
+tag = ID3Tag.read(mp3_file)
+puts "#{tag.artist} - #{tag.title}"
+```
+`ID3Tag::Tag` class provides easy accessors to frames like `artist`, `title`, `album`, `year`, `comments`, `track_nr`, `genre` but you can read any frame by using `get_frame` or `get_frame_content`.
+
+```ruby
+mp3s = Dir.entries("/some/dir").select { |filename| filename =~ /\.mp3/i }
+
+mp3s.each do |file|
+  ID3Tag.read(File.open(file)) do |tag|
+    puts file
+    puts tag.artist
+    puts tag.title
+    puts tag.album
+    puts tag.year
+    puts tag.comments
+    puts tag.track_nr
+    puts tag.genre
+    puts "---"
+    puts tag.get_frame_content(:TIT2)
+  end
+end
+```
+You can inspect tag by calling `frame_ids` to see available frame ids or `frames` to return all frames
+
+## Features
+
+* Can read v1.x, v2.2.x, v2.3.x, v2.4.x tags
+* Supports UTF-8, UTF-16, UTF-16BE and ISO8859-1 encoding
+
+
+## Contributing to id3tag
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Code Status
+[![Code Climate](https://codeclimate.com/github/krists/id3tag.png)](https://codeclimate.com/github/krists/id3tag) [![Build Status](https://travis-ci.org/krists/id3tag.png?branch=master)](https://travis-ci.org/krists/id3tag) [![Coverage Status](https://coveralls.io/repos/krists/id3tag/badge.png?branch=master)](https://coveralls.io/r/krists/id3tag)
+
+## Copyright
+
+Copyright (c) 2013 Krists Ozols. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -17,10 +17,11 @@ Jeweler::Tasks.new do |gem|
   gem.name = "id3tag"
   gem.homepage = "http://github.com/krists/id3tag"
   gem.license = "MIT"
-  gem.summary = %Q{Native Ruby ID3 tag reader/writer.}
-  gem.description = %Q{Native Ruby ID3 tag reader/writer.}
+  gem.summary = %Q{Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards}
+  gem.description = %Q{Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards}
   gem.email = "krists@iesals.lv"
   gem.authors = ["Krists Ozols"]
+  gem.required_ruby_version = '>= 1.9.2'
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/id3tag.gemspec

@@ -5,59 +5,115 @@
 
 Gem::Specification.new do |s|
   s.name = "id3tag"
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Krists Ozols"]
-  s.date = "2012-12-25"
-  s.description = "Native Ruby ID3 tag reader/writer."
+  s.date = "2013-05-01"
+  s.description = "Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards"
   s.email = "krists@iesals.lv"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "id3tag.gemspec",
     "lib/id3tag.rb",
-    "spec/id3tag_spec.rb",
-    "spec/spec_helper.rb"
+    "lib/id3tag/audio_file.rb",
+    "lib/id3tag/frame_id_advisor.rb",
+    "lib/id3tag/frames/util/genre_names.rb",
+    "lib/id3tag/frames/v1/comments_frame.rb",
+    "lib/id3tag/frames/v1/genre_frame.rb",
+    "lib/id3tag/frames/v1/text_frame.rb",
+    "lib/id3tag/frames/v1/track_nr_frame.rb",
+    "lib/id3tag/frames/v2/basic_frame.rb",
+    "lib/id3tag/frames/v2/comments_frame.rb",
+    "lib/id3tag/frames/v2/frame_fabricator.rb",
+    "lib/id3tag/frames/v2/genre_frame.rb",
+    "lib/id3tag/frames/v2/genre_frame/genre_parser.rb",
+    "lib/id3tag/frames/v2/genre_frame/genre_parser_24.rb",
+    "lib/id3tag/frames/v2/genre_frame/genre_parser_pre_24.rb",
+    "lib/id3tag/frames/v2/text_frame.rb",
+    "lib/id3tag/frames/v2/unique_file_id_frame.rb",
+    "lib/id3tag/id3_v1_frame_parser.rb",
+    "lib/id3tag/id3_v2_frame_parser.rb",
+    "lib/id3tag/id3_v2_tag_header.rb",
+    "lib/id3tag/number_util.rb",
+    "lib/id3tag/string_util.rb",
+    "lib/id3tag/synchsafe_integer.rb",
+    "lib/id3tag/tag.rb",
+    "spec/fixtures/id3v1_and_v2.mp3",
+    "spec/fixtures/id3v1_with_track_nr.mp3",
+    "spec/fixtures/id3v1_without_track_nr.mp3",
+    "spec/fixtures/id3v2.mp3",
+    "spec/lib/id3tag/audio_file_spec.rb",
+    "spec/lib/id3tag/frames/util/genre_name_by_id_finder_spec.rb",
+    "spec/lib/id3tag/frames/v1/comments_frame_spec.rb",
+    "spec/lib/id3tag/frames/v1/genre_frame_spec.rb",
+    "spec/lib/id3tag/frames/v1/text_frame_spec.rb",
+    "spec/lib/id3tag/frames/v1/track_nr_frame_spec.rb",
+    "spec/lib/id3tag/frames/v2/basic_frame_spec.rb",
+    "spec/lib/id3tag/frames/v2/comments_frame_spec.rb",
+    "spec/lib/id3tag/frames/v2/genre_frame/genre_parser_24_spec.rb",
+    "spec/lib/id3tag/frames/v2/genre_frame/genre_parser_pre_24_spec.rb",
+    "spec/lib/id3tag/frames/v2/genre_frame_spec.rb",
+    "spec/lib/id3tag/frames/v2/text_frame_spec.rb",
+    "spec/lib/id3tag/frames/v2/unique_file_id_frame_spec.rb",
+    "spec/lib/id3tag/id3_v1_frame_parser_spec.rb",
+    "spec/lib/id3tag/id3_v2_frame_parser_spec.rb",
+    "spec/lib/id3tag/id3_v2_tag_header_spec.rb",
+    "spec/lib/id3tag/id3tag_spec.rb",
+    "spec/lib/id3tag/number_util_spec.rb",
+    "spec/lib/id3tag/string_util_spec.rb",
+    "spec/lib/id3tag/synchsafe_integer_spec.rb",
+    "spec/lib/id3tag/tag_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/mp3_fixtures.rb"
   ]
   s.homepage = "http://github.com/krists/id3tag"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "Native Ruby ID3 tag reader/writer."
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+  s.rubygems_version = "2.0.3"
+  s.summary = "Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.5"])
+      s.add_development_dependency(%q<debugger>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.13.0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<coveralls>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.5"])
+      s.add_dependency(%q<debugger>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rspec>, ["~> 2.13.0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<coveralls>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.5"])
+    s.add_dependency(%q<debugger>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rspec>, ["~> 2.13.0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<coveralls>, [">= 0"])
   end
 end
 

data/lib/id3tag.rb

@@ -0,0 +1,34 @@
+require "set"
+require "stringio"
+
+require "id3tag/synchsafe_integer"
+require "id3tag/audio_file"
+require "id3tag/id3_v2_tag_header"
+require "id3tag/number_util"
+require "id3tag/string_util"
+require "id3tag/id3_v1_frame_parser"
+require "id3tag/id3_v2_frame_parser"
+require "id3tag/frame_id_advisor"
+require "id3tag/tag"
+require "id3tag/frames/util/genre_names"
+require "id3tag/frames/v1/text_frame"
+require "id3tag/frames/v1/genre_frame"
+require "id3tag/frames/v1/comments_frame"
+require "id3tag/frames/v1/track_nr_frame"
+require "id3tag/frames/v2/basic_frame"
+require "id3tag/frames/v2/text_frame"
+require "id3tag/frames/v2/unique_file_id_frame"
+require "id3tag/frames/v2/comments_frame"
+require "id3tag/frames/v2/genre_frame"
+require "id3tag/frames/v2/genre_frame/genre_parser"
+require "id3tag/frames/v2/genre_frame/genre_parser_pre_24"
+require "id3tag/frames/v2/genre_frame/genre_parser_24"
+require "id3tag/frames/v2/frame_fabricator"
+
+module ID3Tag
+  def self.read(source, version = nil)
+    tag = Tag.read(source, version)
+    yield tag if block_given?
+    tag
+  end
+end

data/lib/id3tag/audio_file.rb

@@ -0,0 +1,90 @@
+module ID3Tag
+  class AudioFile
+    ID3V1_TAG_SIZE = 128
+    ID3V2_TAG_HEADER_SIZE = 10
+    IDV1_TAG_IDENTIFIER = "TAG"
+    IDV2_TAG_IDENTIFIER = "ID3"
+
+    def initialize(file)
+      @file = file
+    end
+
+    def v1_tag_present?
+      @file.seek(-ID3V1_TAG_SIZE, IO::SEEK_END)
+      @file.read(3) == IDV1_TAG_IDENTIFIER
+    end
+
+    def v2_tag_present?
+      @file.rewind
+      @file.read(3) == IDV2_TAG_IDENTIFIER
+    end
+
+    def v1_tag_body
+      @file.seek(-ID3V1_TAG_SIZE + IDV1_TAG_IDENTIFIER.size, IO::SEEK_END)
+      @file.read
+    end
+
+    def v2_tag_body
+      @file.seek(v2_tag_frame_and_padding_position)
+      @file.read(v2_tag_frame_and_padding_size)
+    end
+
+    def v2_tag_version
+      v2_tag_header.version_number
+    end
+
+    def v2_tag_major_version_number
+      v2_tag_header.major_version_number
+    end
+
+    def v2_tag_minor_version_number
+      v2_tag_header.minor_version_number
+    end
+
+    def greatest_tag_version
+      if v2_tag_present?
+        2
+      elsif v1_tag_present?
+        1
+      else
+        nil
+      end
+    end
+
+    private
+
+    def v2_tag_frame_and_padding_position
+      ID3V2_TAG_HEADER_SIZE + v2_extended_header_size
+    end
+
+    def v2_tag_frame_and_padding_size
+      v2_tag_header.tag_size - v2_extended_header_size
+    end
+
+    def v2_extended_header_size
+      @v2_extended_header_size ||= get_v2_extended_header_size
+    end
+
+    def get_v2_extended_header_size
+      if v2_tag_header.extended_header?
+        SynchsafeInteger.decode(NumberUtil.convert_string_to_32bit_integer(v2_extended_header_size_bytes))
+      else
+        0
+      end
+    end
+
+    def v2_extended_header_size_bytes
+      @file.seek(ID3V2_TAG_HEADER_SIZE)
+      @file.read(4)
+    end
+
+    def v2_tag_header
+      @v2_tag_header ||= get_v2_tag_header
+    end
+
+    def get_v2_tag_header
+      @file.rewind
+      ID3v2TagHeader.new(@file.read(ID3V2_TAG_HEADER_SIZE))
+    end
+  end
+end