gme 0.0.12-x86-linux → 0.0.13-x86-linux

data/Rakefile

@@ -1,3 +1,5 @@
+require 'rubygems'
+
 begin
   require 'jeweler'
   
@@ -22,3 +24,38 @@ begin
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end
+
+require 'rake'
+require 'spec'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+namespace :gme do 
+  desc "Builds gme_ext and deploys locally on lib/gme_ext.so"
+  task :extbuild do
+    # cd to ext/gme/build
+    # run extconf.rb
+    # run make
+    # cp gme_ext.so to lib/
+    puts ">> Compiling gme_ext.so ..."
+    path = File.expand_path(File.dirname(__FILE__) + '/ext/gme/build')
+    `cd #{path}; ruby ../extconf.rb; make; cp gme_ext.so ../../../lib/gme_ext.so`
+  end
+  
+  desc "Runs clean task in build directory and deletes lib/gme_ext.so"
+  task :extclean do
+    path = File.expand_path(File.dirname(__FILE__) + '/ext/gme/build')
+    `cd #{path}; make clean; rm ../../../lib/gme_ext.so`
+  end
+end
+
+task :spec => "gme:extbuild"
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

data/ext/gme/build/Makefile

@@ -0,0 +1,157 @@
+
+SHELL = /bin/sh
+
+#### Start of system configuration section. ####
+
+srcdir = ..
+topdir = /usr/lib/ruby/1.8/i486-linux
+hdrdir = $(topdir)
+VPATH = $(srcdir):$(topdir):$(hdrdir)
+exec_prefix = $(prefix)
+prefix = $(DESTDIR)/usr
+sharedstatedir = $(prefix)/com
+mandir = $(prefix)/share/man
+psdir = $(docdir)
+oldincludedir = $(DESTDIR)/usr/include
+localedir = $(datarootdir)/locale
+bindir = $(exec_prefix)/bin
+libexecdir = $(prefix)/lib/ruby1.8
+sitedir = $(DESTDIR)/usr/local/lib/site_ruby
+htmldir = $(docdir)
+vendorarchdir = $(vendorlibdir)/$(sitearch)
+includedir = $(prefix)/include
+infodir = $(prefix)/share/info
+vendorlibdir = $(vendordir)/$(ruby_version)
+sysconfdir = $(DESTDIR)/etc
+libdir = $(exec_prefix)/lib
+sbindir = $(exec_prefix)/sbin
+rubylibdir = $(libdir)/ruby/$(ruby_version)
+docdir = $(datarootdir)/doc/$(PACKAGE)
+dvidir = $(docdir)
+vendordir = $(libdir)/ruby/vendor_ruby
+datarootdir = $(prefix)/share
+pdfdir = $(docdir)
+archdir = $(rubylibdir)/$(arch)
+sitearchdir = $(sitelibdir)/$(sitearch)
+datadir = $(datarootdir)
+localstatedir = $(DESTDIR)/var
+sitelibdir = $(sitedir)/$(ruby_version)
+
+CC = gcc
+LIBRUBY = $(LIBRUBY_SO)
+LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static
+
+RUBY_EXTCONF_H = 
+CFLAGS   =  -fPIC -fno-strict-aliasing -g -g -O2  -fPIC $(cflags) 
+INCFLAGS = -I. -I. -I/usr/lib/ruby/1.8/i486-linux -I..
+DEFS     = -D_FILE_OFFSET_BITS=64
+CPPFLAGS =   -D_FILE_OFFSET_BITS=64 
+CXXFLAGS = $(CFLAGS) 
+ldflags  = -L. -Wl,-Bsymbolic-functions -rdynamic -Wl,-export-dynamic
+dldflags = 
+archflag = 
+DLDFLAGS = $(ldflags) $(dldflags) $(archflag)
+LDSHARED = $(CC) -shared
+AR = ar
+EXEEXT = 
+
+RUBY_INSTALL_NAME = ruby1.8
+RUBY_SO_NAME = ruby1.8
+arch = i486-linux
+sitearch = i486-linux
+ruby_version = 1.8
+ruby = /usr/bin/ruby1.8
+RUBY = $(ruby)
+RM = rm -f
+MAKEDIRS = mkdir -p
+INSTALL = /usr/bin/install -c
+INSTALL_PROG = $(INSTALL) -m 0755
+INSTALL_DATA = $(INSTALL) -m 644
+COPY = cp
+
+#### End of system configuration section. ####
+
+preload = 
+
+libpath = . $(libdir)
+LIBPATH =  -L. -L$(libdir)
+DEFFILE = 
+
+CLEANFILES = mkmf.log
+DISTCLEANFILES = 
+
+extout = 
+extout_prefix = 
+target_prefix = 
+LOCAL_LIBS = 
+LIBS = $(LIBRUBYARG_SHARED) -lgme  -lpthread -lrt -ldl -lcrypt -lm   -lc
+SRCS = gme_funcs.c gme.c util.c
+OBJS = gme_funcs.o gme.o util.o
+TARGET = gme_ext
+DLLIB = $(TARGET).so
+EXTSTATIC = 
+STATIC_LIB = 
+
+BINDIR        = $(bindir)
+RUBYCOMMONDIR = $(sitedir)$(target_prefix)
+RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
+RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
+
+TARGET_SO     = $(DLLIB)
+CLEANLIBS     = $(TARGET).so $(TARGET).il? $(TARGET).tds $(TARGET).map
+CLEANOBJS     = *.o *.a *.s[ol] *.pdb *.exp *.bak
+
+all:		$(DLLIB)
+static:		$(STATIC_LIB)
+
+clean:
+		@-$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES)
+
+distclean:	clean
+		@-$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log
+		@-$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
+
+realclean:	distclean
+install: install-so install-rb
+
+install-so: $(RUBYARCHDIR)
+install-so: $(RUBYARCHDIR)/$(DLLIB)
+$(RUBYARCHDIR)/$(DLLIB): $(DLLIB)
+	$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
+install-rb: pre-install-rb install-rb-default
+install-rb-default: pre-install-rb-default
+pre-install-rb: Makefile
+pre-install-rb-default: Makefile
+$(RUBYARCHDIR):
+	$(MAKEDIRS) $@
+
+site-install: site-install-so site-install-rb
+site-install-so: install-so
+site-install-rb: install-rb
+
+.SUFFIXES: .c .m .cc .cxx .cpp .C .o
+
+.cc.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.cxx.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.cpp.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.C.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.c.o:
+	$(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) -c $<
+
+$(DLLIB): $(OBJS) Makefile
+	@-$(RM) $@
+	$(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
+
+
+
+$(OBJS): ruby.h defines.h

data/ext/gme/build/mkmf.log

@@ -0,0 +1,12 @@
+have_library: checking for main() in -lgme... -------------------- yes
+
+"gcc -o conftest -I. -I/usr/lib/ruby/1.8/i486-linux -I..  -D_FILE_OFFSET_BITS=64  -fno-strict-aliasing -g -g -O2  -fPIC   conftest.c  -L. -L/usr/lib -L. -Wl,-Bsymbolic-functions -rdynamic -Wl,-export-dynamic     -lruby1.8-static -lgme  -lpthread -lrt -ldl -lcrypt -lm   -lc"
+checked program was:
+/* begin */
+1: /*top*/
+2: int main() { return 0; }
+3: int t() { void ((*volatile p)()); p = (void ((*)()))main; return 0; }
+/* end */
+
+--------------------
+

data/ext/gme/gme.c

@@ -8,13 +8,17 @@ VALUE cEmulator;
 
 VALUE eGenericException;
 VALUE eInvalidFile;
+VALUE eTrackNotStarted;
 
 void Init_gme_ext()
 {
     mGME = rb_define_module("GME");
+
     rb_require("gme/exceptions");
     eGenericException = rb_define_class_under(mGME, "GenericException", rb_eException);
     eInvalidFile = rb_define_class_under(mGME, "InvalidFile", eGenericException);
+    eTrackNotStarted = rb_define_class_under(mGME, "TrackNotStarted", eGenericException);
+
     cEmulator = rb_define_class_under(mGME, "Emulator", rb_cObject);
     rb_funcall(cEmulator, rb_intern("attr_reader"), 1, ID2SYM(rb_intern("info")));
     rb_funcall(cEmulator, rb_intern("attr_reader"), 1, ID2SYM(rb_intern("track_count")));
@@ -30,4 +34,8 @@ void Init_gme_ext()
     rb_define_method(cEmulator, "start_track", gme_ruby_start_track, -1);
     rb_define_method(cEmulator, "get_samples", gme_ruby_get_samples, 0);
     rb_define_method(cEmulator, "play_to_file", gme_ruby_play_to_file, 1);
+    rb_define_method(cEmulator, "track_started?", gme_ruby_track_started, 0);
+    rb_define_method(cEmulator, "tell", gme_ruby_tell, 0);
+    rb_define_method(cEmulator, "track_ended?", gme_ruby_track_ended, 0);
+    rb_define_method(cEmulator, "ignore_silence", gme_ruby_ignore_silence, 1);
 }

data/ext/gme/gme_funcs.c

@@ -6,6 +6,7 @@
 extern VALUE cEmulator;
 extern VALUE eGenericException;
 extern VALUE eInvalidFile;
+extern VALUE eTrackNotStarted;
 
 void gme_ruby_emu_free(void* pointer);
 
@@ -97,6 +98,9 @@ VALUE gme_ruby_open(int argc, VALUE* argv, VALUE self)
     int track_count = gme_track_count(emulator);
     rb_iv_set(new_instance, "@track_count", INT2FIX(track_count));
 
+    // no track has been started
+    rb_iv_set(new_instance, "@track_started", Qfalse);
+
     // returns the new instance of GME::Emulator
     return new_instance;
 }
@@ -131,15 +135,16 @@ VALUE gme_ruby_start_track(int argc, VALUE* argv, VALUE self)
 
     // starts the track
     handle_error(gme_start_track(emulator, c_track), eGenericException);
+    
+    // a track has been started...
+    rb_iv_set(self, "@track_started", Qtrue);
 
     // returns the track number started
     return INT2FIX(c_track);
 }
 
 /*
- * Plays the specified number of samples
- * FIXME: This function allocates a buffer each time it is called.
- *        Maybe we should use a one-time allocated buffer.  
+ * Plays some samples, and returns them as an array
  */
 VALUE gme_ruby_get_samples(VALUE self)
 {
@@ -148,6 +153,9 @@ VALUE gme_ruby_get_samples(VALUE self)
     short*     c_buffer;
     int        c_buffer_len;
 
+    VALUE track_started = rb_iv_get(self, "@track_started");
+    if(!RTEST(track_started)) rb_raise(eTrackNotStarted, "you must start a track first");
+
     Data_Get_Struct(self, Music_Emu, emulator);
 
     // recovers a pointer to the internal buffer
@@ -176,11 +184,17 @@ VALUE gme_ruby_play_to_file(VALUE self, VALUE file)
     Music_Emu* emulator;
     int        track       = 0;    // plays track 0 (TODO?)
 
+    // throws an exception if the file passed is not valid
+    // FIXME: currently it *requires* an object of class File
+    if(NIL_P(file) || TYPE(file) != T_FILE) {
+        rb_raise(eGenericException, "the file is not valid.");
+    }
+
     // allocates memory for the buffer
     buffer = (short*) malloc(buffer_size * sizeof(short));
 
     Data_Get_Struct(self, Music_Emu, emulator);
-
+    
     // TODO: fix for ruby-1.9 (fptr->stdio_file)
     stdio_file = RFILE(file)->fptr->f;
 
@@ -192,6 +206,9 @@ VALUE gme_ruby_play_to_file(VALUE self, VALUE file)
     // starts track 0
     handle_error(gme_start_track(emulator, track), eGenericException);
 
+    // track 0 has been started
+    rb_iv_set(self, "@track_started", Qtrue);
+
     // gets the play length of the track from the info hash
     VALUE info_hash = rb_iv_get(self, "@info");
     int play_length = FIX2INT(rb_hash_aref(info_hash, ID2SYM(rb_intern("play_length"))));
@@ -209,6 +226,75 @@ VALUE gme_ruby_play_to_file(VALUE self, VALUE file)
     return Qnil;
 }
 
+/*
+ * Returns true if a track has been started
+ * and false in other cases.
+ */
+VALUE gme_ruby_track_started(VALUE self)
+{
+    VALUE track_started = rb_iv_get(self, "@track_started");
+
+    if(RTEST(track_started)) return Qtrue;
+    
+    return Qfalse;
+}
+
+/*
+ * Returns the number of milliseconds played since the start of the track
+ */
+VALUE gme_ruby_tell(VALUE self)
+{
+    Music_Emu* emulator;
+    int milliseconds;
+
+    Data_Get_Struct(self, Music_Emu, emulator);
+
+    // gets number of millisecons played
+    milliseconds = gme_tell(emulator);
+
+    return INT2FIX(milliseconds);
+}
+
+
+/*
+ * Returns true if the track has ended
+ * and false in other cases
+ */
+VALUE gme_ruby_track_ended(VALUE self)
+{
+    Music_Emu* emulator;
+
+    // throws an exception if a track hasn't been started
+    VALUE track_started = gme_ruby_track_started(self);
+    if(!RTEST(track_started)) rb_raise(eTrackNotStarted, "you have to start a track first");
+
+    Data_Get_Struct(self, Music_Emu, emulator);
+
+    // checks if the track has ended
+    int track_ended = gme_track_ended(emulator);
+    if(track_ended) return Qtrue;
+
+    return Qfalse;    
+}
+
+/*
+ * sets whether or not to disable automatic end of track detection
+ * and skipping at the beginning
+ */
+VALUE gme_ruby_ignore_silence(VALUE self, VALUE ignore)
+{
+    Music_Emu* emulator;
+
+    Data_Get_Struct(self, Music_Emu, emulator);
+
+    // if the parameter 'ignore' is true, then ignore the automatic 
+    // handling of silences
+    if(RTEST(ignore)) gme_ignore_silence(emulator, 1);
+    else gme_ignore_silence(emulator, 0);
+
+    return Qnil;
+}
+
 /*
  * free function to the GME::Emulator wrapper for Music_Emu
  */

data/ext/gme/gme_funcs.h

@@ -9,5 +9,9 @@ VALUE gme_ruby_close(VALUE self);
 VALUE gme_ruby_start_track(int argc, VALUE* argv, VALUE self);
 VALUE gme_ruby_get_samples(VALUE self);
 VALUE gme_ruby_play_to_file(VALUE self, VALUE file);
+VALUE gme_ruby_track_started(VALUE self);
+VALUE gme_ruby_tell(VALUE self);
+VALUE gme_ruby_track_ended(VALUE self);
+VALUE gme_ruby_ignore_silence(VALUE self, VALUE ignore);
 
 #endif

data/lib/gme/exceptions.rb

@@ -1,7 +1,13 @@
 module GME
+  # describes a generic exception, related to this gem
   class GenericException < Exception
   end
-  
+
+  # thrown when a path supplied doesn't point to a valid file for the library
   class InvalidFile < GenericException
   end
+
+  # thrown when one tries to play a file without starting a track first
+  class TrackNotStarted < GenericException
+  end
 end

data/spec/emulator_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'digest/sha1'
+
+include GME
+
+describe Emulator, "when first created" do
+  
+  before(:each) do
+    path = File.expand_path(File.dirname(__FILE__) + '/fixtures/sample.spc')
+    @song = Emulator.open(path)
+  end
+  
+  it "should not be nil" do 
+    @song.should_not be_nil
+  end
+  
+  it "should acknowledge 1 track" do 
+    @song.track_count.should == 1
+  end
+
+  it "should respond to the message 'info' and return a non-empty container" do 
+    @song.info.should_not be_empty
+  end
+
+  it "should correctly return the metadata of track 0 in a hash" do 
+    @song.info[:game].should == "Super Castlevania 4"
+    @song.info[:song].should == "Stage Clear"
+    @song.info[:length].should == 4000
+    @song.info[:copyright].should == "1991 Konami"
+    @song.info[:author].should == "Masanori Adachi, Taro Kudou"
+    @song.info[:play_length].should == 4000
+    @song.info[:comment].should == ""
+    @song.info[:dumper].should == "Datschge"
+    @song.info[:system].should == "Super Nintendo"
+    @song.info[:loop_length].should == -1
+  end
+
+  it "should indicate that no track has been started" do 
+    @song.track_started?.should be_false
+  end
+
+  it "should raise an exception when asked if the current track has ended" do 
+    lambda { @song.track_ended? }.should raise_exception(TrackNotStarted) 
+  end
+
+  it "should return 0 when asked for the time played since start" do 
+    @song.tell.should == 0
+  end
+
+  it "should raise and exception if get_samples is called" do 
+    lambda { @song.get_samples }.should raise_exception(TrackNotStarted)
+  end
+
+  context "when play_to_file is called" do
+    
+    context "when given an invalid file" do
+
+      it "should raise an exception if the file argument is nil" do
+        @file = nil
+        lambda { @song.play_to_file(@file) }.should raise_exception(GenericException)
+      end
+
+      it "should raise an exception if the file argument is not of File class" do 
+        @file = StringIO.new
+        lambda { @song.play_to_file(@file) }.should raise_exception(GenericException)
+      end
+      
+    end
+
+    context "when given a valid file" do
+      
+      before(:each) do 
+        @file = File.new("temp.out", "w+")
+      end
+      
+      it "should play track 0 and write the samples to the specified file" do 
+        lambda { @song.play_to_file(@file) }.should_not raise_exception
+        @song.close
+        File.size("temp.out").should == 706560
+        Digest::SHA1.hexdigest(File.read("temp.out")).should == "5a557efdb64cb71baa953b7129663b1503f4a7d9"
+      end
+
+      after(:each) do 
+        @file.close unless @file.closed?
+        File.delete("temp.out") if File.exists?("temp.out")
+      end
+      
+    end
+  end
+
+  context "when starting a track" do
+    
+    it "should start the specified track and return that number when successful" do 
+      @song.start_track(0).should == 0
+    end
+
+    it "should start track 0 when no track number is specified" do 
+      @song.start_track.should == 0
+    end
+
+    it "should raise an exception when the specified track number is invalid" do 
+      lambda { @song.start_track(1) }.should raise_exception(GenericException)
+    end
+  end
+
+  context "when a track has been started" do 
+    before(:each) do 
+      @song.start_track(0)
+    end
+
+    it "should indicate that a track has been started when asked" do 
+      @song.track_started?.should be_true
+    end
+    
+    it "should indicate that the track has not ended" do 
+      @song.track_ended?.should be_false
+    end
+    
+    it "should return 0 as the time played since the start of the track" do 
+      @song.tell.should == 0
+    end
+
+    # TODO: get_samples, open with options, etc.
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/gme.rb") 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 12
-  version: 0.0.12
+  - 13
+  version: 0.0.13
 platform: x86-linux
 authors: 
 - "Carlos Beltr\xC3\xA1n-Recabarren"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-21 00:00:00 -04:00
+date: 2010-04-30 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,12 @@ files:
 - Rakefile
 - VERSION
 - ext/gme/Makefile
+- ext/gme/build/Makefile
+- ext/gme/build/gme.o
+- ext/gme/build/gme_ext.so
+- ext/gme/build/gme_funcs.o
+- ext/gme/build/mkmf.log
+- ext/gme/build/util.o
 - ext/gme/extconf.rb
 - ext/gme/gme.c
 - ext/gme/gme_funcs.c
@@ -41,6 +47,7 @@ files:
 - lib/gme.rb
 - lib/gme/exceptions.rb
 - lib/gme/gme.rb
+- lib/gme_ext.so
 has_rdoc: true
 homepage: http://www.beltran-recabarren.com
 licenses: []
@@ -71,5 +78,6 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: gme for Ruby
-test_files: []
-
+test_files: 
+- spec/emulator_spec.rb
+- spec/spec_helper.rb