mb-discid 0.0.1

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2007, Philipp Wolfer
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the RBrainz project nor the names of the
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,23 @@
+= MB-DiscID - Ruby bindings for MusicBrainz libdiscid
+
+== About
+MB-DiscID provides Ruby bindings for the MusicBrainz DiscID library libdsicid.
+It allows you to calculate MusicBrainz DiscIDs from audio CDs which you can use
+to find the release entry for your CD in the MusicBrainz database. 
+
+== Installation
+Before installing rdiscid make sure you have libdiscid installed. See
+http://musicbrainz.org/doc/libdiscid for more information on how to do this.
+
+=== Install with gem
+ gem install mb-discid
+ 
+=== Installing from source
+ rake install
+
+== Usage
+See the files in the examples directory for usage information.
+
+== License
+Copyright (c) 2007, Philipp Wolfer
+Licensing information can be found in the file LICENSE.

data/Rakefile

@@ -0,0 +1,103 @@
+# $Id$
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+ 
+# Rakefile for RDiscID
+
+require 'rubygems'
+require 'rake/gempackagetask'
+
+task :default do
+  puts "Please see 'rake --tasks' for an overview of the available tasks."
+end
+
+# Packaging tasks: -------------------------------------------------------
+
+PKG_NAME     = 'mb-discid'
+PKG_VERSION  = '0.0.1'
+PKG_SUMMARY  = 'Ruby bindings for libdiscid.'
+PKG_AUTHOR   = 'Philipp Wolfer'
+PKG_EMAIL    = 'phw@rubyforge.org'
+PKG_HOMEPAGE = 'http://rbrainz.rubyforge.org'
+PKG_DESCRIPTION = <<EOF
+    Ruby bindings for libdiscid. See http://musicbrainz.org/doc/libdiscid
+    for more information on libdiscid and MusicBrainz.
+EOF
+PKG_FILES = FileList[
+  'Rakefile', 'LICENSE', 'README',
+  'examples/**/*',
+  'ext/**/*.{c,rb}'
+]
+
+spec = Gem::Specification.new do |spec|
+  spec.platform = Gem::Platform::RUBY
+  spec.name = PKG_NAME
+  spec.version = PKG_VERSION
+  spec.summary = PKG_SUMMARY
+  spec.requirements << 'libdiscid (http://musicbrainz.org/doc/libdiscid)'
+  spec.require_path = 'lib'
+  spec.autorequire = spec.name
+  spec.files = PKG_FILES
+  spec.extensions << 'ext/extconf.rb'
+  spec.description = PKG_DESCRIPTION
+  spec.author = PKG_AUTHOR
+  spec.email = PKG_EMAIL
+  spec.homepage = PKG_HOMEPAGE
+  spec.rubyforge_project = 'rbrainz'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_gz= true
+end
+
+# Build tasks: -----------------------------------------------------------
+
+desc 'Build all the extensions'
+task :build do
+  extconf_args = ''
+
+  unless ENV['DISCID_DIR'].nil?
+    extconf_args = "--with-discid-dir=#{ENV['DISCID_DIR']}"
+  end
+
+  cd 'ext' do
+    unless system("ruby extconf.rb #{extconf_args}")
+      STDERR.puts "ERROR: could not configure extension!\n" +
+                  "\n#{INFO_NOTE}\n"
+      break
+    end
+
+    unless system('make')
+      STDERR.puts 'ERROR: could not build extension!'
+      break
+    end
+  end
+end
+
+desc 'Install (and build) extensions'
+task :install => [:build] do
+  cd 'ext' do
+    unless system('make install')
+      STDERR.puts 'ERROR: could not install extension!'
+      break
+    end
+  end
+end
+
+desc 'Remove extension products'
+task :clobber_build do
+  FileList['ext/**/*'].each do |file|
+    unless FileList['ext/**/*.{c,rb}'].include?(file)
+      rm_r file if File.exists?(file)
+    end
+  end
+end
+
+desc 'Force a rebuild of the extension files'
+task :rebuild => [:clobber_build, :build]
+
+desc 'Remove all files created during the build process'
+task :clobber => [:clobber_build, :clobber_package]
+

data/examples/discid.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'DiscID'
+
+# Read the device name from the command line or use the default.
+device = $*[0] ? $*[0] : MusicBrainz::DiscID.default_device
+
+disc = MusicBrainz::DiscID.new
+disc.read(device)
+
+print <<EOF
+DiscID     : #{disc.id}
+Submit via : #{disc.submission_url}
+FreeDB ID  : #{disc.freedb_id}
+First track: #{disc.first_track_num}
+Last track : #{disc.last_track_num}
+Sectors    : #{disc.sectors}
+EOF
+
+track = disc.first_track_num
+disc.tracks do |offset, length|
+  puts "Track #{track}: Offset #{offset}, Length #{length}"
+  track += 1
+end

data/ext/discid.c

@@ -0,0 +1,245 @@
+/*---------------------------------------------------------------------------
+ $Id: discid.c 55 2007-06-01 19:18:12Z phw $
+ Copyright (c) 2007, Philipp Wolfer
+ All rights reserved.
+ See LICENSE for permissions.
+
+ Ruby bindings for libdiscid. See http://musicbrainz.org/doc/libdiscid
+ for more information on libdiscid and MusicBrainz.
+---------------------------------------------------------------------------*/
+
+#include "ruby.h"
+#include "discid/discid.h"
+
+/**
+ * The MusicBrainz module.
+ */
+static VALUE mMusicBrainz;
+
+/**
+ * The DiscID class.
+ */
+static VALUE cDiscID;
+
+/**
+ * Returns the DiscID as a string.
+ * 
+ * Returns nil if no ID was yet read.
+ */
+static VALUE mb_discid_id(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	return rb_str_new2(discid_get_id(disc));
+}
+
+/**
+ * Returns a submission URL for the DiscID as a string.
+ * 
+ * Returns nil if no ID was yet read.
+ */
+static VALUE mb_discid_submission_url(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	return rb_str_new2(discid_get_submission_url(disc));
+}
+
+/**
+ * Return a FreeDB DiscID as a string.
+ * 
+ * Returns nil if no ID was yet read.
+ */
+static VALUE mb_discid_freedb_id(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	return rb_str_new2(discid_get_freedb_id(disc));
+}
+
+/**
+ * Return the number of the first track on this disc.
+ * 
+ * Returns nil if no ID was yet read.
+ */
+static VALUE mb_discid_first_track_num(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	return INT2FIX(discid_get_first_track_num(disc));
+}
+
+/**
+ * Return the number of the last track on this disc.
+ * 
+ * Returns nil if no ID was yet read.
+ */
+static VALUE mb_discid_last_track_num(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	return INT2FIX(discid_get_last_track_num(disc));
+}
+
+/**
+ * Return the length of the disc in sectors.
+ * 
+ * Returns nil if no ID was yet read.
+ */
+static VALUE mb_discid_sectors(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	return INT2FIX(discid_get_sectors(disc));
+}
+
+/**
+ * Returns an array of [offset, length] tuples for each track.
+ * 
+ * If a block is given this method returns nil and instead iterates over the
+ * block calling the block with two arguments |offset, length|.
+ *
+ * Returns always nil if no ID was yet read. The block won't be called in
+ * this case.
+ */
+static VALUE mb_discid_tracks(VALUE self)
+{
+	if (rb_iv_get(self, "@read") == Qfalse)
+		return Qnil;
+	
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	VALUE result = rb_ary_new(); // Array of all [offset, length] tuples
+	VALUE tuple; // Array to store one [offset, length] tuple.
+	int track = discid_get_first_track_num(disc); // Track number
+	while (track <= discid_get_last_track_num(disc))
+	{
+		tuple = rb_ary_new3(2,
+			INT2FIX(discid_get_track_offset(disc, track)),
+			INT2FIX(discid_get_track_length(disc, track)) );
+		
+	   	if (rb_block_given_p())
+			rb_yield(tuple);
+		else
+			rb_ary_push(result, tuple);
+			
+		track++;
+	}
+	
+	if (rb_block_given_p())
+		return Qnil;
+	else
+		return result;
+}
+
+/**
+ * Read the disc ID from the given device.
+ * 
+ * If no device is given the default device of the platform will be used.
+ */
+static VALUE mb_discid_read(int argc, VALUE *argv, VALUE self)
+{
+	DiscId *disc;
+	Data_Get_Struct(self, DiscId, disc);
+	
+	VALUE device = Qnil; // The device string as a Ruby string.
+	char* cdevice;       // The device string as a C string.
+	
+	// Check the number of arguments
+	if (argc > 1)
+		rb_raise(rb_eArgError, "wrong number of arguments (%d for 1)", argc);
+	// Convert the given device to a T_STRING
+	else if (argc > 0)	
+		device = rb_funcall(argv[0], rb_intern("to_s"), 0, 0);
+	
+	// Use the default device if none was given.
+	if (argc < 1 || RSTRING(device)->len == 0)
+		cdevice = discid_get_default_device();
+	else
+		cdevice = STR2CSTR(device);
+	
+	// Read the discid
+	if (discid_read(disc, cdevice) == 0)
+		rb_raise(rb_eException, discid_get_error_msg(disc));
+	else // Remember that we already read the ID.
+		rb_iv_set(self, "@read", Qtrue);
+	
+	return Qnil;
+}
+
+/**
+ * Construct a new DiscID object.
+ * 
+ * As an optional argument the name of the device to read the ID from
+ * may be given. If you don't specify a device here you can later read
+ * the ID with the read method.
+ */
+VALUE mb_discid_new(int argc, VALUE *argv, VALUE class)
+{
+	DiscId *disc = discid_new();
+	VALUE tdata = Data_Wrap_Struct(class, 0, discid_free, disc);
+	rb_obj_call_init(tdata, 0, 0);
+	rb_iv_set(tdata, "@read", Qfalse);
+	
+	// Check the number of arguments
+	if (argc > 1)
+		rb_raise(rb_eArgError, "wrong number of arguments (%d for 1)", argc);
+	// If a device was given try to read the disc id from this device.
+	else if (argc > 0)
+		rb_funcall(tdata, rb_intern("read"), 1, argv[0]);
+	
+	return tdata;
+}
+
+/**
+ * Returns a device string for the default device for this platform.
+ */
+VALUE mb_discid_default_device(VALUE class)
+{
+	return rb_str_new2(discid_get_default_device());
+}
+
+/**
+ * Initialize the DiscID class and make it available in Ruby.
+ */
+void Init_DiscID() {
+	mMusicBrainz = rb_define_module("MusicBrainz");
+  	cDiscID = rb_define_class_under(mMusicBrainz, "DiscID", rb_cObject);
+	rb_define_singleton_method(cDiscID, "new", mb_discid_new, -1);
+	rb_define_singleton_method(cDiscID, "default_device",
+	                           mb_discid_default_device, 0);
+	
+  	rb_define_method(cDiscID, "read", mb_discid_read, -1);
+  	rb_define_method(cDiscID, "id", mb_discid_id, 0);
+  	rb_define_method(cDiscID, "submission_url", mb_discid_submission_url, 0);
+  	rb_define_method(cDiscID, "freedb_id", mb_discid_freedb_id, 0);
+  	rb_define_method(cDiscID, "first_track_num", mb_discid_first_track_num, 0);
+  	rb_define_method(cDiscID, "last_track_num", mb_discid_last_track_num, 0);
+  	rb_define_method(cDiscID, "sectors", mb_discid_sectors, 0);
+  	rb_define_method(cDiscID, "tracks", mb_discid_tracks, 0);
+}

data/ext/extconf.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'mkmf'
+
+if have_library('discid', 'discid_new')
+  create_makefile('DiscID')
+else
+  'discid library not found.'
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: mb-discid
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-06-01 00:00:00 +02:00
+summary: Ruby bindings for libdiscid.
+require_paths: 
+- lib
+email: phw@rubyforge.org
+homepage: http://rbrainz.rubyforge.org
+rubyforge_project: rbrainz
+description: Ruby bindings for libdiscid. See http://musicbrainz.org/doc/libdiscid for more information on libdiscid and MusicBrainz.
+autorequire: mb-discid
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Philipp Wolfer
+files: 
+- Rakefile
+- LICENSE
+- README
+- examples/discid.rb
+- ext/discid.c
+- ext/extconf.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: 
+- ext/extconf.rb
+requirements: 
+- libdiscid (http://musicbrainz.org/doc/libdiscid)
+dependencies: []
+