axon 0.1.1 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 0.2.0 / 2012-??-??
+
+* JRuby Support
+* Add Axon.jpeg_file, Axon.png_file, Axon#jpeg_file, and Axon#png_file
+* Removed #color_model since we can use #components.
+
 === 0.1.1 / 2012-01-06
 
 * Add a .gemtest file. Trying rubygems-test.

data/README.rdoc

@@ -4,12 +4,8 @@ http://github.com/ender672/axon
 
 == DESCRIPTION:
 
-axon reads, manipulates, and writes images.
-
-axon depends only on libjpeg and libpng.
-
-axon never stores an entire image in memory. All images and operations are
-streamed. This keeps memory requirements and latency low.
+Read, manipulate, and write images with an emphasis on speed and a low memory
+profile.
 
 == FEATURES:
 
@@ -20,60 +16,38 @@ streamed. This keeps memory requirements and latency low.
 
 == SYNOPSIS:
 
-  # Short, chained example. Reads a JPEG from io_in and writes scaled png to
-  # io_out.
-  Axon.jpeg(io_in).fit(100, 100).png(io_out)
-
-  # Longer example, reads the JPEG header, looks at properties and header
-  # values, sets decompression options, scales the image, sets compression
-  # options, and writes a JPEG.
-  reader = Axon::JPEG::Reader(io, [:APP2])
-
-  puts reader.width  #=> Integer
-  puts reader.height #=> Integer
-  puts reader[:APP2] #=> Array of Strings
-  reader.scale_denom = 4 # Image will be scaled by 1/4 on read
-
-  fitted = Axon::Fit.new(reader, 100, 100) # Fits image in a 100x100 box
-  JPEG.write(fitted, io, :quality => 88)
-
-== BASIC API:
-
-All image objects are expected to respond to the following methods:
-
-  * Image#height
-    Output height of the image.
-  * Image#width
-    Output width of the image.
-  * Image#color_model
-    Can be :GRAYSCALE or :RGB
-  * Image#components
-    RGB image with alpha has 4 components.
-    RGB image has 3 components.
-    Grayscale image with alpha has 2 components.
-    Grayscale image has 1 component.
-  * Image#gets
-    Returns the next line in the image as a binary ruby string.
-  * Image#lineno
-    The line number of the next line that will be returned, starting at 0.  
-
-A Reader object has the same methods as an Image object, with added methods that
-are specific to the decoding of the image format.
+  # Read a JPEG and write it as a scaled PNG.
+  Axon.jpeg_file("image.jpg") do |image|
+    image.fit(100, 100)
+    image.png_file("image.png")
+  end
 
 == REQUIREMENTS:
 
-IJG JPEG Library Version 6b or later.
-pnglib version 1.2.x or later.
+The JRuby extension uses the Java Image I/O API.
+
+The MRI/Rubinius extension uses:
+
+* IJG JPEG Library Version 6b or later.
+* pnglib version 1.2.x or later.
+
+Installing libjpeg headers (OSX):
+
+  $ brew install libjpeg # requires homebrew (http://mxcl.github.com/homebrew/)
+
+Installing libjpeg and libpng headers (Debian/Ubuntu):
+
+  $ sudo apt-get install libjpeg-dev libpng-dev
 
 == INSTALL:
 
-gem install axon
+  $ gem install axon
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2011
+Copyright (c) 2012
 
 * {Timothy Elliott}[http://holymonkey.com]
 

data/Rakefile

@@ -1,21 +1,36 @@
 require 'rake/clean'
 require 'rake/testtask'
 
+# Java compiling
+def quote_file_list(l)
+  list = FileList.new(l)
+  (list.to_a.map { |f| "'#{f}'" }).join(' ')
+end
+
+file 'lib/axon/axon.jar' => FileList.new('ext/java/axon/*.java') do
+  cd 'ext/java' do
+    sh "javac -g -cp #{Config::CONFIG['prefix']}/lib/jruby.jar #{FileList['axon/*.java']}"
+    sh "jar cf axon/axon.jar #{quote_file_list('axon/*.class')}"
+  end
+
+  FileUtils.mv 'ext/java/axon/axon.jar', 'lib/axon/axon.jar'
+end
+
+# gcc compiling
 file 'ext/axon/Makefile' do
   cd 'ext/axon' do
     ruby "extconf.rb #{ENV['EXTOPTS']}"
   end
 end
 
-file 'ext/axon/axon.so' => FileList.new('ext/axon/Makefile', 'ext/axon/*{.c,.h}') do
+file 'lib/axon/axon.so' => FileList.new('ext/axon/Makefile', 'ext/axon/*{.c,.h}') do
   cd 'ext/axon' do
     sh 'make'
   end
+  
+  FileUtils.mv 'ext/axon/axon.so', 'lib/axon/axon.so'
 end
 
-CLEAN.add('ext/axon/*{.o,.so,.log}', 'ext/axon/Makefile')
-CLOBBER.add('*.gem')
-
 desc 'Clean up Rubinius .rbc files.'
 namespace :clean do
   task :rbc do
@@ -24,12 +39,23 @@ namespace :clean do
 end
 
 Rake::TestTask.new do |t|
-  t.libs += ['test', 'ext']
+  t.libs << 'test'
   t.test_files = FileList['test/test*.rb']
   t.verbose = true
 end
 
-desc 'Compile axon'
-task :compile => 'ext/axon/axon.so'
+CLEAN.add('ext/axon/*{.o,.so,.log}', 'ext/axon/Makefile')
+CLEAN.add('ext/java/axon/*.class', 'ext/java/axon/axon.jar')
+CLEAN.add('lib/axon/axon{.so,.jar}')
+CLOBBER.add('*.gem')
+
+desc 'Build the gem'
+task :gem => "lib/axon/axon.jar" do
+  system "gem build axon.gemspec"
+end
+
+desc 'Compile the extension'
+task :compile => "lib/axon/axon.#{RUBY_PLATFORM =~ /java/ ? 'jar' : 'so'}"
+
 task :test => :compile
 task :default => :test

data/TODO.rdoc

@@ -1,5 +1,10 @@
 = TODO
-  * get everything running on osx and windows
+  * get everything running on windows
+  * get all tests passing on jruby
+  * for jruby, consider adding kind of a back-door method, e.g.
+    gets_as_jruby_bufferedimage that allows internal calls to pass scanlines
+    along natively. Something similar might slightly speed up the C extension
+    as well by eliminating some memory copies.
   * have a setting where decode / encode warnings will result in exceptions
   * add #initialize_copy
   * Check frozen status on setters, etc.

data/ext/axon/jpeg.c

@@ -19,7 +19,7 @@
 #define EXIF_MARKER (JPEG_APP0 + 1)
 
 #define WRITE_BUFSIZE 1024
-#define READ_SIZE 2048
+#define READ_SIZE 1024
 
 static ID id_ISLOW, id_IFAST, id_FLOAT, id_DEFAULT, id_FASTEST;
 static ID id_GRAYSCALE, id_RGB, id_YCbCr, id_CMYK, id_YCCK, id_UNKNOWN;
@@ -45,7 +45,7 @@ struct readerdata {
     struct jpeg_source_mgr mgr;
 
     int header_read;
-    int locked;
+    int decompress_started;
 
     VALUE source_io;
     VALUE buffer;
@@ -156,10 +156,6 @@ empty_output_buffer(j_compress_ptr cinfo)
     str = rb_str_new(dest->buffer, dest->alloc);
 
     write_len = rb_funcall(dest->io, id_write, 1, str);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(write_len))
-	rb_raise(rb_eTypeError, "write returned a symbol.");
-
     write_len_i = (size_t)NUM2INT(write_len);
     dest->total += write_len_i;
     if (write_len_i != dest->alloc)
@@ -181,9 +177,6 @@ term_destination(j_compress_ptr cinfo)
     if (len > 0) {
 	str = rb_str_new(dest->buffer, len);
 	write_len = rb_funcall(dest->io, id_write, 1, str);
-	/* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-	if (SYMBOL_P(write_len))
-	    rb_raise(rb_eTypeError, "write returned a symbol.");
 	write_len_i = (size_t)NUM2INT(write_len);
 	dest->total += write_len_i;
 	if (write_len_i != len)
@@ -238,41 +231,32 @@ write_exif(j_compress_ptr cinfo, char *str, int len)
 static void
 write_configure(j_compress_ptr cinfo, VALUE image_in, VALUE quality)
 {
-    VALUE color_model, width, components, rb_height;
+    VALUE width, components, rb_height;
     int height;
 
     width = rb_funcall(image_in, id_width, 0);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(width))
-	rb_raise(rb_eTypeError, "source image has a symbol for width.");
     cinfo->image_width = NUM2INT(width);
 
     rb_height = rb_funcall(image_in, id_height, 0);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(rb_height))
-	rb_raise(rb_eTypeError, "source image has a symbol for height.");
-
     height = NUM2INT(rb_height);
     if (height < 1)
 	rb_raise(rb_eRuntimeError, "Source image gave an invalid height.");
     cinfo->image_height = height;
 
     components = rb_funcall(image_in, id_components, 0);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(components))
-	rb_raise(rb_eTypeError, "source image has a symbol for components.");
     cinfo->input_components = NUM2INT(components);
-
-    color_model = rb_funcall(image_in, id_color_model, 0);
-    if (SYMBOL_P(color_model))
-	cinfo->in_color_space = id_to_j_color_space(SYM2ID(color_model));
-    else
-	rb_raise(rb_eTypeError, "source image has a non symbol color space");
-
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(quality))
-	rb_raise(rb_eTypeError, "symbol for quality.");
-
+    
+    switch (cinfo->input_components) {
+      case 1:
+	cinfo->in_color_space = JCS_GRAYSCALE;
+	break;
+      case 3:
+	cinfo->in_color_space = JCS_RGB;
+	break;
+      default:
+	rb_raise(rb_eRuntimeError, "source image has the wrong number of components");
+	break;
+    }
 
     jpeg_set_defaults(cinfo);
 
@@ -347,7 +331,7 @@ write_jpeg2(VALUE image_in, VALUE io_out, size_t bufsize, VALUE icc_profile,
     mgr.pub.init_destination = init_destination;
     mgr.pub.empty_output_buffer = empty_output_buffer;
     mgr.pub.term_destination = term_destination;
-    mgr.alloc = 1024;
+    mgr.alloc = bufsize;
     mgr.io = io_out;
     cinfo.dest = (struct jpeg_destination_mgr *)&mgr;
 
@@ -394,10 +378,6 @@ write_jpeg(int argc, VALUE *argv, VALUE self)
 
     if (!NIL_P(options) && TYPE(options) == T_HASH) {
 	rb_bufsize = rb_hash_aref(options, sym_bufsize);
-	/* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-	if (SYMBOL_P(rb_bufsize))
-	    rb_raise(rb_eTypeError, "symbol for bufsize.");
-
 	if (!NIL_P(rb_bufsize)) {
 	    bufsize = NUM2INT(rb_bufsize);
 	    if (bufsize < 1)
@@ -441,8 +421,8 @@ init_jerror(struct jpeg_error_mgr * err)
 static void
 raise_if_locked(struct readerdata *reader)
 {
-    if (reader->locked)
-	rb_raise(rb_eRuntimeError, "Can't modify a locked Reader");
+    if (reader->decompress_started)
+	rb_raise(rb_eRuntimeError, "Can't modify a Reader after decompress started.");
 }
 
 static void
@@ -624,7 +604,6 @@ initialize(int argc, VALUE *argv, VALUE self)
     struct readerdata *reader;
     j_decompress_ptr cinfo;
     VALUE io, markers;
-    int i;
 
     Data_Get_Struct(self, struct readerdata, reader);
     raise_if_locked(reader);
@@ -883,28 +862,6 @@ set_dct_method(VALUE self, VALUE dct_method)
     }
 }
 
-static VALUE
-j_gets2(struct readerdata *reader)
-{
-    struct jpeg_decompress_struct * cinfo;
-    VALUE sl;
-    int width, components, sl_width, ret;
-    JSAMPROW ijg_buffer;
-
-    cinfo = &reader->cinfo;
-
-    width      = cinfo->output_width;
-    components = cinfo->output_components;
-
-    sl_width = width * components;
-
-    sl = rb_str_new(0, sl_width);
-    ijg_buffer = (JSAMPROW)RSTRING_PTR(sl);
-    ret = jpeg_read_scanlines(cinfo, &ijg_buffer, 1);
-
-    return ret == 0 ? Qnil : sl;
-}
-
 /*
  *  call-seq:
  *     gets -> string or nil
@@ -918,20 +875,29 @@ j_gets2(struct readerdata *reader)
 static VALUE
 j_gets(VALUE self)
 {
-    struct jpeg_decompress_struct * cinfo;
     struct readerdata *reader;
+    struct jpeg_decompress_struct *cinfo;
+    VALUE sl;
+    int sl_width, ret;
+    JSAMPROW ijg_buffer;
 
     Data_Get_Struct(self, struct readerdata, reader);
+    cinfo = &reader->cinfo;
 
     if (!reader->header_read)
       read_header(reader, Qnil);
 
-    if (reader->locked == 0) {
-	reader->locked = 1;
-	jpeg_start_decompress(&reader->cinfo);
+    if (!reader->decompress_started) {
+	reader->decompress_started = 1;
+	jpeg_start_decompress(cinfo);
     }
 
-    return j_gets2(reader);
+    sl_width = cinfo->output_width * cinfo->output_components;
+    sl = rb_str_new(0, sl_width);
+    ijg_buffer = (JSAMPROW)RSTRING_PTR(sl);
+
+    ret = jpeg_read_scanlines(cinfo, &ijg_buffer, 1);
+    return ret == 0 ? Qnil : sl;
 }
 
 /*

data/ext/axon/png.c

@@ -1,8 +1,8 @@
 #include <ruby.h>
 #include <png.h>
 
-static ID id_write, id_GRAYSCALE, id_RGB, id_gets, id_width, id_height,
-	  id_color_model, id_components, id_read;
+static ID id_write, id_GRAYSCALE, id_GRAYSCALE_ALPHA, id_RGB, id_RGB_ALPHA,
+	  id_gets, id_width, id_height, id_color_model, id_components, id_read;
 
 struct png_data {
     png_structp png_ptr;
@@ -17,24 +17,39 @@ struct io_write {
 };
 
 static int
-id_to_color_type(ID rb, int components)
+components_to_color_type(int components)
 {
-    if      (rb == id_GRAYSCALE && components == 1) return PNG_COLOR_TYPE_GRAY;
-    else if (rb == id_GRAYSCALE && components == 2) return PNG_COLOR_TYPE_GRAY_ALPHA;
-    else if (rb == id_RGB       && components == 3) return PNG_COLOR_TYPE_RGB;
-    else if (rb == id_RGB       && components == 4) return PNG_COLOR_TYPE_RGB_ALPHA;
+    switch (components) {
+      case 1: return PNG_COLOR_TYPE_GRAY;
+      case 2: return PNG_COLOR_TYPE_GRAY_ALPHA;
+      case 3: return PNG_COLOR_TYPE_RGB;
+      case 4: return PNG_COLOR_TYPE_RGB_ALPHA;
+    }
+    
+    rb_raise(rb_eRuntimeError, "Unrecognized number of components.");
+}
+
+static ID
+png_color_type_to_id(png_byte color_type)
+{
+    switch (color_type) {
+      case PNG_COLOR_TYPE_GRAY:       return id_GRAYSCALE;
+      case PNG_COLOR_TYPE_GRAY_ALPHA: return id_GRAYSCALE_ALPHA;
+      case PNG_COLOR_TYPE_RGB:        return id_RGB;
+      case PNG_COLOR_TYPE_RGB_ALPHA:  return id_RGB_ALPHA;
+    }
 
-    rb_raise(rb_eRuntimeError, "Color Space not recognized.");
+    rb_raise(rb_eRuntimeError, "PNG Color Type not recognized.");
 }
 
 static int
 get_components(png_structp png_ptr, png_infop info_ptr)
 {
     switch (png_get_color_type(png_ptr, info_ptr)) {
-    case PNG_COLOR_TYPE_GRAY:       return 1;
-    case PNG_COLOR_TYPE_GRAY_ALPHA: return 2;
-    case PNG_COLOR_TYPE_RGB:        return 3;
-    case PNG_COLOR_TYPE_RGB_ALPHA:  return 4;
+      case PNG_COLOR_TYPE_GRAY:       return 1;
+      case PNG_COLOR_TYPE_GRAY_ALPHA: return 2;
+      case PNG_COLOR_TYPE_RGB:        return 3;
+      case PNG_COLOR_TYPE_RGB_ALPHA:  return 4;
     }
 
     return 0;
@@ -65,11 +80,6 @@ write_data(png_structp png_ptr, png_bytep data, png_size_t length)
     str = rb_str_new(data, length);
     iw = (struct io_write *)png_get_io_ptr(png_ptr);
     rb_write_len = rb_funcall(iw->io, id_write, 1, str);
-
-    /* Ruby 1.8.7 makes up odd numbers when running NUM2INT on a symbol */
-    if (TYPE(rb_write_len) == T_SYMBOL)
-	rb_raise(rb_eTypeError, "Number Expected, but got Symbol.");
-
     write_len = NUM2INT(rb_write_len);
 
     if ((size_t)write_len != length)
@@ -106,29 +116,14 @@ write_scanline(VALUE scan_line, png_structp png_ptr, png_infop info_ptr)
 static void
 write_configure(VALUE image_in, png_structp png_ptr, png_infop info_ptr)
 {
-    VALUE width, height, color_model, components;
+    VALUE width, height, components;
     int color_type;
 
     width       = rb_funcall(image_in, id_width, 0);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(width))
-	rb_raise(rb_eTypeError, "source image has a symbol for width.");
-
     height      = rb_funcall(image_in, id_height, 0);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(height))
-	rb_raise(rb_eTypeError, "source image has a symbol for height.");
 
     components  = rb_funcall(image_in, id_components, 0);
-    /* in 1.8.7, NUM2INT gives funny numbers for Symbols */
-    if (SYMBOL_P(components))
-	rb_raise(rb_eTypeError, "source image has a symbol for components.");
-
-    color_model = rb_funcall(image_in, id_color_model, 0);
-    if (SYMBOL_P(color_model))
-	color_type = id_to_color_type(SYM2ID(color_model), NUM2INT(components));
-    else
-	rb_raise(rb_eTypeError, "source image has a non symbol color space");
+    color_type = components_to_color_type(NUM2INT(components));
 
     png_set_IHDR(png_ptr, info_ptr, NUM2INT(width), NUM2INT(height), 8,
 		 color_type, PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT,
@@ -221,7 +216,7 @@ raise_if_locked(struct png_data *reader)
 }
 
 static void
-free_png(struct png_data *reader)
+free_reader(struct png_data *reader)
 {
     png_structp png_ptr;
     png_infop info_ptr;
@@ -233,12 +228,7 @@ free_png(struct png_data *reader)
 	png_destroy_read_struct(&png_ptr, &info_ptr, (png_info **)NULL);
     else if (png_ptr)
 	png_destroy_read_struct(&png_ptr, (png_info **)NULL, (png_info **)NULL);
-}
 
-static void
-free_reader(struct png_data *reader)
-{
-    free_png(reader);
     free(reader);
 }
 
@@ -264,7 +254,7 @@ read_data_fn(png_structp png_ptr, png_bytep data, png_size_t length)
 	rb_raise(rb_eRuntimeError, "Read Error. Read %d instead of %d bytes.",
 		 (int)read_len, (int)length);
 
-    memcpy(data, RSTRING_PTR(str), read_len);
+    memcpy(data, RSTRING_PTR(str), length);
 }
 
 static void
@@ -276,12 +266,15 @@ mark(struct png_data *reader)
 	rb_gc_mark(io);
 }
 
-static void
-allocate_png(struct png_data *reader)
+static VALUE
+allocate(VALUE klass)
 {
+    VALUE self;
+    struct png_data *reader;
     png_structp png_ptr;
     png_infop info_ptr;
-
+    
+    self = Data_Make_Struct(klass, struct png_data, mark, free_reader, reader);
     png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, (png_voidp)NULL,
 				     (png_error_ptr)png_error_fn,
 				     (png_error_ptr)png_warning_fn);
@@ -297,16 +290,6 @@ allocate_png(struct png_data *reader)
 
     reader->png_ptr = png_ptr;
     reader->info_ptr = info_ptr;
-}
-
-static VALUE
-allocate(VALUE klass)
-{
-    VALUE self;
-    struct png_data *reader;
-    
-    self = Data_Make_Struct(klass, struct png_data, mark, free_reader, reader);
-    allocate_png(reader);
 
     return self;
 }
@@ -337,6 +320,11 @@ initialize(VALUE self, VALUE io)
     png_set_read_fn(png_ptr, (void *)io, read_data_fn);
     reader->io = io;
     png_read_info(png_ptr, info_ptr);
+    
+    if (png_get_color_type(png_ptr, info_ptr) == PNG_COLOR_TYPE_PALETTE) {
+	png_set_palette_to_rgb(png_ptr);
+	png_read_update_info(png_ptr, info_ptr);
+    }
 
     return self;
 }
@@ -368,19 +356,6 @@ components(VALUE self)
     return INT2FIX(c);
 }
 
-static ID
-png_color_type_to_id(png_byte color_type)
-{
-    switch (color_type) {
-    case PNG_COLOR_TYPE_GRAY:       return id_GRAYSCALE;
-    case PNG_COLOR_TYPE_GRAY_ALPHA: return id_GRAYSCALE;
-    case PNG_COLOR_TYPE_RGB:        return id_RGB;
-    case PNG_COLOR_TYPE_RGB_ALPHA:  return id_RGB;
-    }
-
-    rb_raise(rb_eRuntimeError, "PNG Color Type not recognized.");
-}
-
 /*
  *  call-seq:
  *     reader.color_model -> symbol
@@ -420,7 +395,7 @@ p_gets(VALUE self)
     struct png_data *reader;
     png_structp png_ptr;
     png_infop info_ptr;
-    int width, components, sl_width;
+    png_uint_32 sl_width;
     size_t height;
     VALUE sl;
 
@@ -432,9 +407,7 @@ p_gets(VALUE self)
     if (reader->lineno >= height)
 	return Qnil;
 
-    width = png_get_image_width(png_ptr, info_ptr);
-    components = get_components(png_ptr, info_ptr);
-    sl_width = width * components;
+    sl_width = png_get_rowbytes(png_ptr, info_ptr);
 
     sl = rb_str_new(0, sl_width);
     png_read_row(png_ptr, (png_bytep)RSTRING_PTR(sl), (png_bytep)NULL);
@@ -532,6 +505,8 @@ Init_PNG()
 
     id_GRAYSCALE = rb_intern("GRAYSCALE");
     id_RGB = rb_intern("RGB");
+    id_GRAYSCALE = rb_intern("GRAYSCALE_ALPHA");
+    id_RGB = rb_intern("RGB_ALPHA");
     id_write = rb_intern("write");
     id_read = rb_intern("read");
     id_gets = rb_intern("gets");