gme 0.0.10-x86-linux → 0.0.12-x86-linux

data/README.rdoc

@@ -1,6 +1,25 @@
 = GME: Game Music Emulator for Ruby
 
-This gem allows the use of the gme library (http://code.google.com/p/game-music-emu/)
+This gem allows the use of the gme library (http://code.google.com/p/game-music-emu)
 by Blargg (http://www.fly.net/~ant/libs/audio.html) in Ruby programs.
 
 At the moment, it implements just the basic functionality, and it's not suitable for production.
+
+== Example usage:
+
+This gem only outputs raw pcm data, and doesn't include options for handling multi track files.
+
+   require 'gme'
+   
+   song = GME::Emulator.open('/path/to/file.ext', options = {}) # opens a music file and sets up an GME::Emulator object
+   # configuration options:
+   # :sample_rate   - specifies the output sample rate
+   # :buffer_length - specifies the internal buffer length to be used
+
+   puts song.info                     # prints the information about the first track
+
+   song.play_to_file(file)            # plays the first track of the song to a file
+
+   song.start_track(track_number)     # starts the specified track (0 by default)
+   song.get_samples                   # gets a number of samples
+   

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.12

data/ext/gme/gme.c

@@ -18,10 +18,16 @@ void Init_gme_ext()
     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")));
+
+    // for debugging
+    rb_funcall(cEmulator, rb_intern("attr_reader"), 1, ID2SYM(rb_intern("internal_buffer")));
+    rb_funcall(cEmulator, rb_intern("attr_reader"), 1, ID2SYM(rb_intern("internal_buffer_length")));
+    // ---
+
     /* rb_define_alloc_func(cEmulator, gme_alloc); */
     rb_define_singleton_method(cEmulator, "open", gme_ruby_open, -1);
     rb_define_method(cEmulator, "close", gme_ruby_close, 0);
     rb_define_method(cEmulator, "start_track", gme_ruby_start_track, -1);
-    rb_define_method(cEmulator, "get_samples", gme_ruby_get_samples, 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);
 }

data/ext/gme/gme_funcs.c

@@ -21,18 +21,48 @@ VALUE gme_ruby_open(int argc, VALUE* argv, VALUE self)
     int         track = 0; // uses track 0 for getting info (FIXME)
     gme_info_t* info;
 
+    // internal buffer
+    short* buffer;
+    int    buffer_length;
+
+    // options hash
+    VALUE options;
+
     // use the first (mandatory) argument, as path to file
     VALUE string = StringValue(argv[0]);
     c_path = RSTRING_PTR(string);
 
-    // use the second argument, if present, as sample rate
-    if(argc >= 2) {
-        c_sample_rate = FIX2INT(argv[1]);
+    // use the second argument, if present, as the options hash
+    VALUE temp;
+    if(argc >= 2){
+        temp = rb_check_convert_type(argv[1], T_HASH, "Hash", "to_hash");
+        if(!NIL_P(temp)) options = temp;
+        else options = rb_hash_new();
     }
     else {
+        options = rb_hash_new();
+    }
+
+    // set sample rate
+    VALUE sample_rate = rb_hash_aref(options, ID2SYM(rb_intern("sample_rate")));
+    if(!NIL_P(sample_rate)) {
+        c_sample_rate = FIX2INT(sample_rate);
+    }
+    else {
+        // default value
         c_sample_rate = 44100;
     }
 
+    // set buffer length
+    VALUE buffer_len = rb_hash_aref(options, ID2SYM(rb_intern("buffer_length")));
+    if(!NIL_P(buffer_len)) {
+        buffer_length = FIX2INT(buffer_len);
+    }
+    else {
+        // default value
+        buffer_length = 2048;
+    }
+
     // opens the specified file
     handle_error(gme_open_file(c_path, &emulator, c_sample_rate), eInvalidFile);
     // and gets the info on the track
@@ -41,6 +71,12 @@ VALUE gme_ruby_open(int argc, VALUE* argv, VALUE self)
     // creates a new instance of GME::Emulator, as a wrapper around Music_Emu
     VALUE new_instance = Data_Wrap_Struct(cEmulator, 0, gme_ruby_emu_free, emulator);
 
+    // allocates memory for the internal buffer
+    buffer = ALLOC_N(short, buffer_length);
+    // and saves a reference for later use (hack?)
+    rb_iv_set(new_instance, "@internal_buffer", LONG2NUM((long)buffer));
+    rb_iv_set(new_instance, "@internal_buffer_length", INT2NUM(buffer_length));
+
     // Fills the info hash
     VALUE info_hash = rb_hash_new();
     rb_hash_aset(info_hash, ID2SYM(rb_intern("play_length")), INT2FIX(info->play_length));
@@ -105,26 +141,24 @@ VALUE gme_ruby_start_track(int argc, VALUE* argv, VALUE self)
  * FIXME: This function allocates a buffer each time it is called.
  *        Maybe we should use a one-time allocated buffer.  
  */
-VALUE gme_ruby_get_samples(VALUE self, VALUE samples)
+VALUE gme_ruby_get_samples(VALUE self)
 {
-    int        buffer_size = FIX2INT(samples); // buffer size equal to number of samples
     Music_Emu* emulator;
     int        c_samples;
     short*     c_buffer;
+    int        c_buffer_len;
 
     Data_Get_Struct(self, Music_Emu, emulator);
 
-    // allocates memory for a buffer
-    c_buffer = (short*) malloc(buffer_size * sizeof(short));
+    // recovers a pointer to the internal buffer
+    c_buffer = (short*) NUM2LONG(rb_iv_get(self, "@internal_buffer"));
+    c_buffer_len = NUM2INT(rb_iv_get(self, "@internal_buffer_length"));
 
     // plays the file, returning the specified number of samples
-    handle_error(gme_play(emulator, buffer_size, c_buffer), eGenericException);
+    handle_error(gme_play(emulator, c_buffer_len, c_buffer), eGenericException);
 
     // creates a ruby string, containing the buffer content (generated samples)
-    VALUE ruby_string = rb_str_new((const char*)c_buffer, buffer_size * sizeof(short));
-
-    // releases the allocated memory
-    free(c_buffer);
+    VALUE ruby_string = rb_str_new((const char*)c_buffer, c_buffer_len * sizeof(short));
 
     // returns the played samples
     return ruby_string;

data/ext/gme/gme_funcs.h

@@ -7,7 +7,7 @@
 VALUE gme_ruby_open(int argc, VALUE* argv, VALUE self);
 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 samples);
+VALUE gme_ruby_get_samples(VALUE self);
 VALUE gme_ruby_play_to_file(VALUE self, VALUE file);
 
 #endif

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 12
+  version: 0.0.12
 platform: x86-linux
 authors: 
 - "Carlos Beltr\xC3\xA1n-Recabarren"