lctr_mp3 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a05711ba481ec51af625f84b6b14cc13847ed5ee
+  data.tar.gz: 63f80a2d9d298894e1e484996a1770a4ead91627
+SHA512:
+  metadata.gz: 0818a79535cd47cacbd62c876ab950141a9cc461ff1bf21ab22eaae285d2caa37ae1f7a74e2f0b73b87ac7ff6c1090a26c4231f075a23e7022f81a96d948799d
+  data.tar.gz: 877fcbd87fcd69ad99453d3d0453c1cb290f007850ad482b2604cf3eaefbc4fe3e1ba6fb13f50b0303357ecae2cb7f865d4062c325240e377814f46a1e5a9005

data/Gemfile

@@ -0,0 +1,3 @@
+gem 'rspec'
+gem 'rake'
+source 'https://rubygems.org'

data/Rakefile.rb

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default =>:spec

data/lib/id3_frame_ids.rb

@@ -0,0 +1,3 @@
+	#Frame IDs for the mp3 program.
+
+	FRAMES = {TIT2: "song_title", TALB: "album_title", TLEN: "song_length", TPE1: "artist", TYER: "year", TRCK:  "track", TIME:  "time"}

data/lib/lctr_mp3.rb

@@ -0,0 +1,130 @@
+#mp3 id3 tag reader
+
+require_relative '../lib/id3_frame_ids.rb'
+
+#  This class represents the data held in an ID3 tag attached to an .mp3 music file.  It is intended to be a container
+#  for the fields that are listed in attr_accessor and included in the file "id_frame_ids.rb" that should be held in the
+#  same directory.  Upon calling the class with the name of an .mp3 file, the initialize method should pull all of the 
+#  required data into the instance.  This data can later be modified and exported to a tag.
+#
+#  This currently works only for ID3 tags version 2.3.
+#
+#  ID3 technical information taken from http://id3.org/id3v2.3.0.
+#
+#  Author:: Neil Woodward
+#  License::  MIT
+#
+class ID3
+
+	attr_accessor :mp3_file, :song_title, :album_title, :artist, :track, :year, :song_length, :version, :flags, :path, :time
+
+#  This will read in all of the tag data when the instance is initialized.
+	def initialize(file)
+		@file = file
+		header = get_tag_header 
+		tag_size = parse_header(header)
+		tag = get_tag(tag_size)
+		get_frames(tag)
+		set_file
+		set_flag(header[5])
+	end
+
+#  This reads the first 10 bytes of the tag, which contain the metadata of the tag.
+	def get_tag_header
+		header = Array.new
+		File.open(@file, "r") do |f|
+			f.each_byte.with_index do |ch, index|
+				case index
+				when 0..4
+			    header << ch.chr
+			  when 5
+			  	header << ch.to_s(2)[0..2]
+			  when 6..9
+			  	if ch > 128
+			  		raise "Header error:  reported tag size too large"
+			  	end
+			  	header << ch.to_s(2).rjust(7,"0")
+			  end
+			  return header if index > 10
+			end
+		end
+
+	end
+
+#  This will read the tag into memory and assign to the "tag" variable for later scraping.
+	def get_tag(size)
+		tag = ""
+		File.open(@file, "r") do |f|
+			f.each_byte.with_index do |ch,index|
+				tag << ch
+	
+			  return tag if index > size
+		  end
+		end
+	end
+
+#  This is the method that will parse the ID3 header, making sure that it is actually a good ID3 header.
+  def parse_header(header)
+  	check_ID3(header)
+  	check_ver(header)
+  	return tag_size(header[6..9])
+	end
+
+#  This method verifies the header is indeed an ID3 header.
+	def check_ID3(header)
+		unless header[0..2].join == "ID3"
+			raise "No ID3 tag on the file"
+		end
+	end
+
+#  This method ensures that we have the correct ID3 version.
+	def check_ver(header)
+		if header[3..4].join(' ') == "\x03 \x00"
+			@version = "2.3"
+		else
+			raise "Incorrect ID3 version - require v2.3"
+		end
+	end
+
+#  This method converts the size bytes in the header into a decimal number representation of the header size.
+  def tag_size(header6_9)
+  	header6_9.join.to_i(2)
+  end
+
+#  This method is used to search the tag for the desired frame tags, and identify the frame locations and sizes.
+  def get_frames(tag)
+    FRAMES.keys.each do |type|
+
+      if loc = (/#{type}/ =~ tag)
+        fr_size_arr = tag[loc+4,4].bytes
+        fr_size_str=""
+
+        fr_size_arr.each do |ch|
+        	fr_size_str<<ch.to_s(2).rjust(8,"0")
+        end
+
+        fr_size = fr_size_str.to_i(2)
+        frm = tag[loc+10,fr_size].gsub(/\u0000/,"")
+
+        eval("self.#{FRAMES[type]} = frm")
+
+     	else
+    		eval("self.#{FRAMES[type]} = nil")
+    	end
+
+    end
+
+  end
+
+#  Used to set the file name.
+  def set_file
+  	@path = File.dirname(@file)
+  	@mp3_file = File.basename(@file)
+  end
+
+#  Used to set the flag bits.
+  def set_flag(flags)
+  	@flags = flags
+  end
+
+end

data/spec/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/spec/lctr_mp3_spec.rb

@@ -0,0 +1,56 @@
+#
+#mp3 ID3 tag decoding code.
+#
+#N. Woodward, 18 Feb 2014
+
+#require $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require_relative '../lib/lctr_mp3.rb'
+
+describe ID3 do
+
+  before (:each) do
+    @id3 = ID3.new('./test_mp3_tag.mp3')
+  end
+	
+  it "should correctly identify the Artist" do
+  	@id3.artist.should eq "Adele"
+  end
+
+  it "should correctly identify the album"  do
+  	@id3.album_title.should eq "21"
+  end
+
+  it "should correctly idenfity the song" do
+  	@id3.song_title.should eq "Rumour Has It"
+  end
+
+  it "should correctly idenfity the track number" do
+  	@id3.track.should eq "2/11"
+  end
+
+  it "should correctly idenfity the file name of the song" do
+  	@id3.mp3_file.should eq "test_mp3_tag.mp3"
+  end
+
+  it "should correctly identify the path to the file" do
+  	@id3.path.should eq "."
+  end
+
+  it "should correctly identify the year of the song" do
+  	@id3.year.should eq "2011"
+  end
+
+  it "should correctly identify the length of the song" do
+  	@id3.time.should eq nil #didn't have that value set on this song
+  end
+
+  it "should correctly identify the ID3 flags" do
+  	@id3.flags.should eq "111"  #this value set in tag with hex editor
+  end
+
+  it "should correctly identify the ID3 tag version" do
+  	@id3.version.should eq "2.3"
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: lctr_mp3
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Neil Woodward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies: []
+description: A set of tools to manage .mp3 files, starting with reading ID3 tags.
+email: drlctr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile.rb
+- lib/id3_frame_ids.rb
+- lib/lctr_mp3.rb
+- spec/.rspec
+- spec/lctr_mp3_spec.rb
+homepage: http://rubygems.org/gems/lctr_mp3_gem
+licenses:
+- MIT license (MIT)
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: mp3 / id3 management tools
+test_files: []