mediaplug2-ruby 0.0.4 → 0.0.5

data/lib/mediaplug/mediaplug_url.rb

@@ -41,8 +41,8 @@ class MediaPlugURL
       argument = argument.split("x") if argument.is_a?(String)
       action << "width=#{argument[0]} height=#{argument[1]}"
     when Hash
-      argument.keys.each{ |k| argument[k.to_s] = argument[k] }
-      action << "#{"width=#{argument["width"]}" if argument["width"]}#{" height=#{argument["height"]}" if argument["height"]}"
+      argument.keys.each{ |k| argument[k.to_sym] = argument[k] }
+      action << "#{"width=#{argument[:width]}" if argument[:width]}#{" height=#{argument[:height]}" if argument[:height]}"
     end
     
     action << " format=#{@format}"
@@ -51,10 +51,10 @@ class MediaPlugURL
     self
   end
   
-  # <b>Image Only:</b> Crop an image based on the input provided. Since
-  # MediaPlug can crop according to gravity setting, default is center.
-  # the arguments you
-  # provide will determine which kind of cropping is employed.
+  # <b>Image Only:</b> Crop an image based on the input provided. 
+  # Gravity setting applies to Image only, default is center.
+  # In Video Cropping, the cropping offset is default to [(original_width - crop_width)/2, (original_height - crop_height)/2] if no offset values are specified.
+  # the arguments you provide will determine which kind of cropping is employed.
   #
   # Cropping:
   #
@@ -65,33 +65,34 @@ class MediaPlugURL
 
   # Options:
   #
-  # - <tt>:gravity</tt>: The position of crop. May be any of NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast. Default is center.
+  # - <tt>:gravity</tt>: *Image Only* The position of crop. May be any of NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast. Default is center.
   # - <tt>:x-offset</tt>: x coordinate offset of the top-left corner related to center position set by the gravity parameter. 
   # - <tt>:y-offset</tt>: y coordinate offset of the top-left corner related to center position set by the gravity parameter. 
   #  
   #
   def crop(string_or_hash_or_array)
     argument = string_or_hash_or_array
-    raise MediaPlug::InvalidAction, "Only images may be cropped." unless image?
-    action = "crop "
+    raise MediaPlug::InvalidAction, "Only images or videos may be cropped." unless image? || video?
+    action = image? ? "crop " : "video_crop "
     
     case argument
     when String, Array
-      argument = argument.split("x") if argument.is_a?(String)
-      action << "gravity=center width=#{argument[0]} height=#{argument[1]}"
+      argument = argument.split("x") if argument.is_a?(String)      
+      action << "gravity=center " if image?
+      action << "width=#{argument[0]} height=#{argument[1]} "
     when Hash
-      argument.keys.each{|k| argument[k.to_s] = argument.delete(k)}
-      action << "gravity=#{argument['gravity']} " if argument['gravity']
-      action << "x-offset=#{argument['x-offset']} " if argument['x-offset']
-      action << "y-offset=#{argument['y-offset']} " if argument['y-offset']
-      if argument["width"] && argument["height"]
-        action << " width=#{argument["width"]} height=#{argument["height"]}"
+      argument.keys.each{|k| argument[k.to_sym] = argument.delete(k)}
+      action << "gravity=#{argument[:gravity]} " if argument[:gravity] && image?
+      action << "x-offset=#{argument[:x_offset]} " if argument[:x_offset]
+      action << "y-offset=#{argument[:y_offset]} " if argument[:y_offset]
+      if argument[:width] && argument[:height]
+        action << "width=#{argument[:width]} height=#{argument[:height]} "
       else
         raise MediaPlug::InvalidAction, "Could not understand the options given to the crop command."
       end
     end
     
-    action << " format=#{@format}"
+    action << "format=#{@format}"
     @actions << action
     self
   end
@@ -136,10 +137,15 @@ class MediaPlugURL
   #   image = mp.image('http://some.url/')
   #   image.flip(:both)
   def flip(direction)
-    raise MediaPlug::InvalidAction, "Only images may be flipped." unless image?
+    raise MediaPlug::InvalidAction, "Only images or video may be flipped." unless image? || video?
     argument = direction
     argument = FLIP_MAP[argument.to_s] if FLIP_MAP.key?(argument.to_s)
+    if image?
     "flip #{argument} format=#{@format}"
+    else
+    "video_flip #{argument} format=#{@format}"
+    end
+    self
   end
   # <b>Image Only:</b> Create SWIRLING effect on the image by the given number of amplitude and wavelength.
   #
@@ -169,11 +175,12 @@ class MediaPlugURL
   def polaroid(options={})
     raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
     action = "polaroid "    
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}
 
     action << "angle=#{options[:angle]} " if options[:angle]
     action << "caption=#{options[:caption]} " if options[:caption]
     
-    action << " format=#{@format}"
+    action << "format=#{@format}"
     @actions << action
     self
   end     
@@ -187,7 +194,7 @@ class MediaPlugURL
     raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
     action = "water_reflection "    
 
-    action << " format=#{@format}"
+    action << "format=#{@format}"
     @actions << action
     self
   end   
@@ -204,9 +211,10 @@ class MediaPlugURL
   def filter(filter_type, options={})
     raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
     action = "filter "  
-    action << "filter_type=#{filter_type} "      
+    action << "filter_type=#{filter_type} "   
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}       
     action << "level=#{options[:level]} " if options[:level]
-    action << " format=#{@format}"
+    action << "format=#{@format}"
     @actions << action
     self
   end     
@@ -242,22 +250,33 @@ class MediaPlugURL
     @actions << action
     self
   end 
-  # <b>Image Only:</b> Watermark an image with text or with another image.
+  # <b>Image Only:</b> Watermark an image with text or with another image
   # The +watermark_type+ may be +:image+ or +:text+.
   # 
   # Options:
   #
   # - <tt>:gravity</tt>: The position of the watermark. May be any of NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast. Default is center.
   # - <tt>:alpha</tt>: value from 0.0 to 1.0 indicating the opacity of the watermark. Default is 0.6.
+  # - <tt>:x_offset</tt>: x coordinate offset of the top-left corner related to center position set by the gravity parameter. 
+  # - <tt>:y_offset</tt>: y coordinate offset of the top-left corner related to center position set by the gravity parameter. 
   # 
   # Text-Only Options
   #
   # - <tt>:weight</tt>: the weight of the text font, maybe All,Bold,Bolder,Lighter,Normal. Default is Normal.
   # - <tt>:style</tt>: The style of the text font, maybe Any, Italic, Normal, Oblique
   # - <tt>:font_size</tt>: Integer, pixel size of the font to use on the watermark.
+  # - <tt>:font_type</tt>: Font type, possible values are:
+          # AvantGarde-Book, AvantGarde-BookOblique, AvantGarde-Demi, AvantGarde-DemiOblique, Bookman-Demi, Bookman-DemiItalic, Bookman-Light, Bookman-LightItalic
+          # Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Narrow, Helvetica-Narrow-Bold
+          # Helvetica-Narrow-BoldOblique, Helvetica-Narrow-Oblique, Helvetica-Oblique, Palatino-Bold, Palatino-BoldItalic, Palatino-Italic, Palatino-Roman
+          # Symbol, Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, Century-Schoolbook-Bold, Century-Schoolbook-Bold-Italic, Century-Schoolbook-Italic
+          # Century-Schoolbook-Roman, DejaVu-Sans-Bold, DejaVu-Sans-Book, DejaVu-Sans-Mono-Bold, DejaVu-Sans-Mono-Book, DejaVu-Serif-Bold, DejaVu-Serif-Book
+          # Dingbats-Regular, URW-Chancery-Medium-Italic 
+          
   def watermark(watermark_type, text_or_url, options = {})
     raise MediaPlug::InvalidAction, "Only images may be watermarked." unless image?
     action = "watermark "
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}
     
     case watermark_type
     when :image
@@ -267,24 +286,49 @@ class MediaPlugURL
       action << "style=#{options[:style]} " if options[:style]
       action << "weight=#{options[:weight]} " if options[:weight]
       action << "text-font-size=#{options[:font_size]} " if options[:font_size]
+      action << "font-type=#{options[:font_type]} " if options[:font_type]
     else
       raise MediaPlug::InvalidAction, "The watermark_type must be :image or :text"
     end
     
     action << "gravity=#{options[:gravity]} " if options[:gravity]
     action << "alpha=#{options[:alpha]} " if options[:alpha]
+    action << "x-offset=#{argument[:x_offset]} " if argument[:x_offset]
+    action << "y-offset=#{argument[:y_offset]} " if argument[:y_offset]
+    
     action << "format=#{@format}"
     
     @actions << action
     self
   end
+  # <b>Image Only:</b> Apply detection filters to the Image.
+  # - <tt>:detection_type</tt>: can be Face, Background, or Edge.
+  # Face detection automatically detect faces in the image using Computer Vision Algorithm, 
+  # and draws retangular around the detected area. 
+  # Edge detection detects edges in the image.
+  # background removal automatically create transparent background using AI algorithm.
+ 
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.detection('Face') #apply face detection on the Image
   
+  def detection(detection_type, options = {})
+    raise MediaPlug::InvalidAction, "Only images may be detected." unless image?
+    action = "detection "
+    
+    action << "type=#{detection_type} "
+    action << "format=#{@format}"
+    
+    @actions << action
+    self    
+  end
   # Converts the source into the specified format, with the options provided
   # (options vary based on media type).
   #
   # Allowable Formats:
   #
-  # - <b>Video:</b> flv, ipod, psp, 3gpp
+  # - <b>Video:</b> flv, mp4, mov, ipod, psp, 3gpp
   # - <b>Audio:</b> mp3
   # - <b>Image:</b> jpg, png, gif
   #
@@ -299,6 +343,8 @@ class MediaPlugURL
   # - <tt>:bitrate</tt>: The bitrate in which to encode (e.g. "64k")
   # - <tt>:samplerate</tt>: The sample rate with which to encode (e.g. 128)
   def convert(new_format, options = {})
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}
+    
   	if image?
   		action = "rotate 0 format=#{new_format}"
   	elsif audio?
@@ -322,6 +368,8 @@ class MediaPlugURL
   # - <tt>:height</tt>: The height of thumbnail image
   def thumbnail(seek, options={})
     raise MediaPlug::InvalidAction, "Only videos may be thumbnailed." unless video?
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}
+    
     action = "thumbnail seek=#{seek}"
     action << " width=#{options[:width]}" if options[:width]
     action << " height=#{options[:height]}" if options[:height]
@@ -338,6 +386,8 @@ class MediaPlugURL
   # - <tt>:height</tt>: The height of thumbnail image
   def preview(framestep, options={})
     raise MediaPlug::InvalidAction, "Only videos may be previewed." unless video?
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}
+    
     action = "preview framestep=#{framestep}"
     action << " width=#{options[:width]}" if options[:width]
     action << " height=#{options[:height]}" if options[:height]
@@ -345,6 +395,58 @@ class MediaPlugURL
     @actions << action
     self
   end  
+  # <b>Video Only:</b> Add text water mark to a video
+  # Video Watermark Options:
+  #
+  # - <tt>:font_size</tt>: Integer, pixel size of the font to use on the watermark.
+  # - <tt>:font_type</tt>: Font type, possible values are:
+          # AvantGarde-Book, AvantGarde-BookOblique, AvantGarde-Demi, AvantGarde-DemiOblique, Bookman-Demi, Bookman-DemiItalic, Bookman-Light, Bookman-LightItalic
+          # Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Narrow, Helvetica-Narrow-Bold
+          # Helvetica-Narrow-BoldOblique, Helvetica-Narrow-Oblique, Helvetica-Oblique, Palatino-Bold, Palatino-BoldItalic, Palatino-Italic, Palatino-Roman
+          # Symbol, Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, Century-Schoolbook-Bold, Century-Schoolbook-Bold-Italic, Century-Schoolbook-Italic
+          # Century-Schoolbook-Roman, DejaVu-Sans-Bold, DejaVu-Sans-Book, DejaVu-Sans-Mono-Bold, DejaVu-Sans-Mono-Book, DejaVu-Serif-Bold, DejaVu-Serif-Book
+          # Dingbats-Regular, URW-Chancery-Medium-Italic
+  # - <tt>:x_offset</tt>: integer, x-offset, x coordiante for the location of the top left corner of text watermark
+  # - <tt>:y_offset</tt>: integer, y-offset, y coordiante for the location of the top left corner of text watermark
+  # - <tt>:font_color</tt>: The color to be used for drawing fonts. Either a string (e.g. "red") or in 0xRRGGBB[AA] format (e.g. "0xff000033"), possibly followed by an alpha specifier (red@0.2 red withe alpah = 0.2). 
+  #      The default value of fontcolor is "0x80acbc44". 
+  # - <tt>:bg_color</tt>: The color to be used for drawing box around text. Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format (e.g. "0xff00ff"), possibly followed by an alpha specifier (red@0.2 red withe alpah = 0.2).
+  #      If no value is specified, no box will be drawn around the text.  
+           
+  def video_watermark(text, options={})
+    raise MediaPlug::InvalidAction, "Only videos may be video watermarked." unless video?
+    options.keys.each{|k| options[k.to_sym] = options.delete(k)}
+    
+    action = "video_watermark text=#{text}"
+    action << " text-font-size=#{options[:font_size]}" if options[:font_size]
+    action << " x-offset=#{argument[:x_offset]} " if argument[:x_offset]
+    action << " y-offset=#{argument[:y_offset]} " if argument[:y_offset]
+    action << " font-color=#{options[:font_color]}" if options[:font_color]
+    action << " bg-color=#{options[:bg_color]}" if options[:bg_color]
+    action << " format=#{@format}"
+    
+    @actions << action
+    self
+  end  
+
+  # <b>Video and Audio Only:</b> Clip the video or audio to any duration and starts at the specified time.
+  # Video Preview Options:
+  #
+  # Framestep is duration in seconds of per frame capture 
+  # - <tt>:width</tt>: The width of thumbnail image
+  # - <tt>:height</tt>: The height of thumbnail image  
+  def clipping(start_at, duration, options={})
+    raise MediaPlug::InvalidAction, "Only audio or video may be clipped." unless video? or audio?
+    
+    action = video? ? "video_clipping " : "audio_clipping "
+    
+    action << " start=#{start_at}" if start_at
+    action << " duration=#{duration}" if duration
+    action << " format=#{@format}"
+    
+    @actions << action
+    self    
+  end
   # Causes the resultant URL to be recached. Should not be called
   # each time.
   def recache!

metadata

@@ -2,7 +2,7 @@
 name: mediaplug2-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-18 00:00:00 -05:00
+date: 2011-08-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency