morandi.rb in morandi-0.99.4

- old
+ new
@@ -3,40 +3,48 @@
 require 'morandi/version'
 require 'morandi_native'
 
 require 'morandi/cairo_ext'
 require 'morandi/pixbuf_ext'
+require 'morandi/errors'
 require 'morandi/image_processor'
-require 'morandi/image_operation'
 require 'morandi/redeye'
 require 'morandi/crop_utils'
 
 # Morandi namespace should contain all the functionality of the gem
 module Morandi
   module_function
 
-  # The main entry point for the libray
+  # The main entry point for the library
   #
-  # @param in_file [String|GdkPixbuf::Pixbuf] source image
-  # @param settings [Hash]
-  # @param out_file [String] target location for image
-  # @param local_options [Hash]
-  #
-  # Settings Key | Values | Description
-  # -------------|--------|---------------
-  # brighten     | Integer -20..20 | Change image brightness
-  # gamma        | Float  | Gamma correct image
-  # contrast     | Integer -20..20  | Change image contrast
-  # sharpen      | Integer -5..5  | Sharpen / Blur (negative value)
-  # redeye       | Array[[Integer,Integer],...]  | Apply redeye correction at point
-  # angle        | Integer 0,90,180,270  | Rotate image
-  # crop         | Array[Integer,Integer,Integer,Integer] | Crop image
-  # fx           | String greyscale,sepia,bluetone | Apply colour filters
-  # border-style  | String square,retro | Set border style
-  # background-style  | String retro,black,white | Set border colour
-  # quality       | String '1'..'100' | Set JPG compression value, defaults to 97%
-  def process(file_in, options, file_out, local_options = {})
-    pro = ImageProcessor.new(file_in, options, local_options)
+  # @param source [String|GdkPixbuf::Pixbuf] source image
+  # @param [Hash] options The options describing expected processing to perform
+  # @option options [Integer] 'brighten' Change image brightness (-20..20)
+  # @option options [Float] 'gamma' Gamma correct image
+  # @option options [Integer] 'contrast' Change image contrast (-20..20)
+  # @option options [Integer] 'sharpen' Sharpen (1..5) / Blur (-1..-5)
+  # @option options [Array[[Integer,Integer],...]] 'redeye' Apply redeye correction at point
+  # @option options [Integer] 'angle' Rotate image clockwise by multiple of 90 (0, 90, 180, 270)
+  # @option options [Array[Integer,Integer,Integer,Integer]] 'crop' Crop image (x, y, width, height)
+  # @option options [String] 'fx' Apply colour filters ('greyscale', 'sepia', 'bluetone')
+  # @option options [String] 'border-style' Set border style ('square', 'retro')
+  # @option options [String] 'background-style' Set border colour ('retro', 'black', 'white', 'dominant')
+  # @option options [Integer] 'quality' (97) Set JPG compression value (1 to 100)
+  # @option options [Integer] 'output.max' Downscales the image to fit within the square of given size before
+  #                                        processing to limit the required resources
+  # @option options [Integer] 'output.width' Sets desired width of resulting image
+  # @option options [Integer] 'output.height' Sets desired height of resulting image
+  # @option options [TrueClass|FalseClass] 'image.auto-crop' (true) If the output dimensions are set and this is true,
+  #                                                                image is cropped automatically to the desired
+  #                                                                dimensions.
+  # @option options [TrueClass|FalseClass] 'output.limit' (false) If the output dimensions are defined and this is true,
+  #                                                              the output image is scaled down to fit within square of
+  #                                                              size of the longer edge (ignoring shorter dimension!)
+  # @param target_path [String] target location for image
+  # @param local_options [Hash] Hash of options other than desired transformations
+  # @option local_options [String] 'path.icc' A path to store the input after converting to sRGB colour space
+  def process(source, options, target_path, local_options = {})
+    pro = ImageProcessor.new(source, options, local_options)
     pro.result
-    pro.write_to_jpeg(file_out)
+    pro.write_to_jpeg(target_path)
   end
 end