bulldog 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+== 0.2.0 2010-07-14
+
+ * Remove dimensions and aspect ratio as a storable attributes. Store
+   width and height instead.
+ * Videos return 0 tracks if the file is missing (but still dimensions
+   of 2x2 so thumbnail sizes can be calculated).
+
 == 0.1.1 2010-06-30
 
  * Create output directory when recording frames if necessary.

data/lib/bulldog/attachment/base.rb

@@ -143,13 +143,10 @@ module Bulldog
       end
 
       #
-      # Return the value of the given attribute from an instance
-      # variable set during file examination.
+      # Return the value of the given instance variable, running a
+      # file examination first if necessary.
       #
-      # If not set, runs a file examination first.
-      #
-      def from_examination(name)
-        ivar = :"@#{name}"
+      def from_examination(ivar)
         value = instance_variable_get(ivar) and
           return value
         examine

data/lib/bulldog/attachment/has_dimensions.rb

@@ -10,10 +10,8 @@ module Bulldog
       def self.included(base)
         super
         base.class_eval do
-          storable_attribute :width       , :per_style => true, :memoize => true
-          storable_attribute :height      , :per_style => true, :memoize => true
-          storable_attribute :aspect_ratio, :per_style => true, :memoize => true
-          storable_attribute :dimensions  , :per_style => true, :memoize => true, :cast => true
+          storable_attribute :width , :per_style => true, :memoize => true
+          storable_attribute :height, :per_style => true, :memoize => true
         end
       end
 
@@ -22,8 +20,13 @@ module Bulldog
       #
       # +style_name+ defaults to the attribute's #default_style.
       #
-      def width(style_name)
-        dimensions(style_name)[0]
+      def width(style_name=nil)
+        style_name ||= reflection.default_style
+        if style_name.equal?(:original)
+          from_examination :@original_width
+        else
+          dimensions(style_name).at(0)
+        end
       end
 
       #
@@ -31,8 +34,13 @@ module Bulldog
       #
       # +style_name+ defaults to the attribute's #default_style.
       #
-      def height(style_name)
-        dimensions(style_name)[1]
+      def height(style_name=nil)
+        style_name ||= reflection.default_style
+        if style_name.equal?(:original)
+          from_examination :@original_height
+        else
+          dimensions(style_name).at(1)
+        end
       end
 
       #
@@ -40,55 +48,56 @@ module Bulldog
       #
       # +style_name+ defaults to the attribute's #default_style.
       #
-      def aspect_ratio(style_name)
-        width(style_name).to_f / height(style_name)
+      def aspect_ratio(style_name=nil)
+        style_name ||= reflection.default_style
+        if style_name.equal?(:original)
+          original_width = from_examination(:@original_width)
+          original_height = from_examination(:@original_height)
+          original_width.to_f / original_height
+        else
+          w, h = *dimensions(style_name)
+          w.to_f / h
+        end
       end
 
       #
       # Return the width and height of the named style, as a 2-element
       # array.
       #
-      def dimensions
-        raise 'abstract method called'
+      def dimensions(style_name=nil)
+        style_name ||= reflection.default_style
+        if style_name.equal?(:original)
+          original_width = from_examination(:@original_width)
+          original_height = from_examination(:@original_height)
+          [original_width, original_height]
+        else
+          resize_dimensions(dimensions(:original), reflection.styles[style_name])
+        end
       end
 
       protected  # -----------------------------------------------------
 
       #
       # Return the dimensions, as an array [width, height], that
-      # result from resizing +original_dimensions+ to
-      # +target_dimensions+.  If fill is true, assume the final image
-      # will fill the target box.  Otherwise the aspect ratio will be
-      # maintained.
+      # result from resizing +original_dimensions+ for the given
+      # +style+.
       #
-      def resized_dimensions(original_dimensions, target_dimensions, fill)
-        if fill
-          target_dimensions
+      def resize_dimensions(original_dimensions, style)
+        if style.filled?
+          style.dimensions
         else
           original_aspect_ratio = original_dimensions[0].to_f / original_dimensions[1]
-          target_aspect_ratio = target_dimensions[0].to_f / target_dimensions[1]
+          target_aspect_ratio = style.dimensions[0].to_f / style.dimensions[1]
           if original_aspect_ratio > target_aspect_ratio
-            width = target_dimensions[0]
+            width = style.dimensions[0]
             height = (width / original_aspect_ratio).round
           else
-            height = target_dimensions[1]
+            height = style.dimensions[1]
             width = (height * original_aspect_ratio).round
           end
           [width, height]
         end
       end
-
-      private  # -----------------------------------------------------
-
-      def serialize_dimensions(dimensions)
-        return nil if dimensions.blank?
-        dimensions.join('x')
-      end
-
-      def deserialize_dimensions(string)
-        return nil if string.blank?
-        string.scan(/\d+/).map{|s| s.to_i}
-      end
     end
   end
 end

data/lib/bulldog/attachment/image.rb

@@ -2,33 +2,11 @@ module Bulldog
   module Attachment
     class Image < Base
       handle :image
-
-      #
-      # Return the width and height of the named style, as a 2-element
-      # array.
-      #
-      # For :original, this is based on the output of ImageMagick's
-      # <tt>identify</tt> command.  Other styles are calculated from
-      # the original style's dimensions, plus the style's :size and
-      # :filled attributes.
-      #
-      # +style_name+ defaults to the attribute's #default_style.
-      #
-      def dimensions(style_name)
-        if style_name.equal?(:original)
-          from_examination :original_dimensions
-        else
-          style = reflection.styles[style_name]
-          target_dimensions = style[:size].split(/x/).map{|s| s.to_i}
-          resized_dimensions(dimensions(:original), target_dimensions, style[:filled])
-        end
-      end
-
       include HasDimensions
 
       def unload
         super
-        @original_dimensions = nil
+        @original_width = @original_height = nil
       end
 
       protected  # ---------------------------------------------------
@@ -46,18 +24,19 @@ module Bulldog
       #
       def run_examination
         if stream.missing?
-          @original_dimensions = [1, 1]
+          @original_width, @original_height = 1, 1
           false
         else
           output = `identify -format "%w %h %[exif:Orientation]" #{stream.path} 2> /dev/null`
           if $?.success? && output.present?
             width, height, orientation = *output.scan(/(\d+) (\d+) (\d?)/).first.map{|s| s.to_i}
             rotated = (5..8).include?(orientation)
-            @original_dimensions = rotated ? [height, width] : [width, height]
+            @original_width  = rotated ? height : width
+            @original_height = rotated ? width : height
             true
           else
             Bulldog.logger.warn "command failed (#{$?.exitstatus})"
-            @original_dimensions = [1, 1]
+            @original_width, @original_height = 1, 1
             false
           end
         end

data/lib/bulldog/attachment/pdf.rb

@@ -2,28 +2,6 @@ module Bulldog
   module Attachment
     class Pdf < Base
       handle :pdf
-
-      #
-      # Return the width and height of the named style, as a 2-element
-      # array.
-      #
-      # For :original, this is based on the output of ImageMagick's
-      # <tt>identify</tt> command.  Other styles are calculated from
-      # the original style's dimensions, plus the style's :size and
-      # :filled attributes.
-      #
-      # +style_name+ defaults to the attribute's #default_style.
-      #
-      def dimensions(style_name)
-        if style_name.equal?(:original)
-          from_examination :original_dimensions
-        else
-          style = reflection.styles[style_name]
-          target_dimensions = style[:size].split(/x/).map{|s| s.to_i}
-          resized_dimensions(dimensions(:original), target_dimensions, style[:filled])
-        end
-      end
-
       include HasDimensions
 
       protected  # ---------------------------------------------------
@@ -41,18 +19,15 @@ module Bulldog
       #
       def run_examination
         if stream.missing?
-          @original_dimensions = [1, 1]
+          @original_width, @original_height = 1, 1
           false
         else
-          output = `identify -format "%w %h %[exif:Orientation]" #{stream.path}[0] 2> /dev/null`
+          output = `identify -format "%w %h" #{stream.path}[0] 2> /dev/null`
           if $?.success? && output.present?
-            width, height, orientation = *output.scan(/(\d+) (\d+) (\d?)/).first.map{|s| s.to_i}
-            rotated = (orientation & 0x4).nonzero?
-            @original_dimensions ||= rotated ? [height, width] : [width, height]
+            @original_width, @original_height = *output.scan(/(\d+) (\d+)/).first.map{|s| s.to_i}
             true
           else
             Bulldog.logger.warn "command failed (#{$?.exitstatus})"
-            @original_dimensions = [1, 1]
             false
           end
         end

data/lib/bulldog/attachment/video.rb

@@ -2,19 +2,6 @@ module Bulldog
   module Attachment
     class Video < Base
       handle :video
-
-      #
-      # Return the width and height of the named style, as a 2-element
-      # array.
-      #
-      # This runs ffmpeg for, and only for, the original style.
-      #
-      # +style_name+ defaults to the attribute's #default_style.
-      #
-      def dimensions(style_name)
-        video_tracks(style_name).first.dimensions
-      end
-
       include HasDimensions
 
       #
@@ -26,12 +13,7 @@ module Bulldog
       # +style_name+ defaults to the attribute's #default_style.
       #
       def duration(style_name)
-        # TODO: support styles with different durations
-        if stream.missing?
-          0
-        else
-          from_examination :original_duration
-        end
+        from_examination :@original_duration
       end
 
       #
@@ -40,27 +22,18 @@ module Bulldog
       #
       # Each VideoTrack has:
       #
-      #  * <tt>#dimension</tt> - the dimensions of the video track,
-      #    [width, height].
+      #  * <tt>#duration</tt> - the duration of the video track.
+      #  * <tt>#dimensions</tt> - the [width, height] of the video
+      #    track.
       #
       def video_tracks(style_name=nil)
         style_name ||= reflection.default_style
-        if style_name == :original
-          if stream.missing?
-            [VideoTrack.new(:dimensions => [2, 2])]
-          else
-            examine unless @original_video_tracks
-            if @original_video_tracks.empty?
-              @original_video_tracks << VideoTrack.new(:dimensions => [2, 2])
-            end
-            @original_video_tracks
-          end
+        if style_name.equal?(:original)
+          from_examination :@original_video_tracks
         else
           style = reflection.styles[style_name]
-          target_dimensions = style[:size].split(/x/).map{|s| s.to_i}
           video_tracks(:original).map do |video_track|
-            dimensions = resized_dimensions(dimensions(:original), target_dimensions, style[:filled])
-            dimensions.map!{|i| i &= -2}  # some codecs require multiples of 2
+            dimensions = resize_dimensions(dimensions(:original), style)
             VideoTrack.new(:dimensions => dimensions)
           end
         end
@@ -72,12 +45,12 @@ module Bulldog
       #
       # AudioTrack objects do not yet have any useful methods.
       #
-      def audio_tracks(style_name)
+      def audio_tracks(style_name=nil)
         examine
         @original_audio_tracks
       end
 
-      storable_attribute :duration    , :per_style => true, :memoize => true
+      storable_attribute :duration, :per_style => true, :memoize => true
 
       def unload
         super
@@ -95,38 +68,66 @@ module Bulldog
         :ffmpeg
       end
 
+      #
+      # Overridden to round down to multiples of 2, as required by
+      # some codecs.
+      #
+      def resize_dimensions(original_dimensions, style)
+        dimensions = super
+        dimensions.map!{|i| i &= -2}
+      end
+
       private  # -----------------------------------------------------
 
       #
       # Read the original image metadata with ffmpeg.
       #
       def run_examination
-        return false if stream.missing?
-        output = `ffmpeg -i #{stream.path} 2>&1`
-        parse_output(output)
+        if stream.missing?
+          set_defaults
+          false
+        else
+          output = `ffmpeg -i #{stream.path} 2>&1`
+          # ffmpeg exits nonzero - don't bother checking status.
+          parse_output(output)
+          true
+        end
       end
 
-      def parse_output(output)
-        result = false
+      def set_defaults
         @original_duration = 0
-        @original_video_tracks = []
+        @original_width = 2
+        @original_height = 2
         @original_audio_tracks = []
+        @original_video_tracks = []
+      end
+
+      def parse_output(output)
+        result = false
+        set_defaults
         io = StringIO.new(output)
         while (line = io.gets)
           case line
           when /^Input #0, (.*?), from '(?:.*)':$/
             result = true
+            duration = nil
           when /^  Duration: (\d+):(\d+):(\d+)\.(\d+)/
-            @original_duration = $1.to_i.hours + $2.to_i.minutes + $3.to_i.seconds
+            duration = $1.to_i.hours + $2.to_i.minutes + $3.to_i.seconds
           when /Stream #(?:.*?): Video: /
             if $' =~ /(\d+)x(\d+)/
               dimensions = [$1.to_i, $2.to_i]
             end
-            @original_video_tracks << VideoTrack.new(:dimensions => dimensions)
+            @original_video_tracks << VideoTrack.new(:dimensions => dimensions, :duration => duration)
           when /Stream #(?:.*?): Audio: (.*?)/
-            @original_audio_tracks << AudioTrack.new
+            @original_audio_tracks << AudioTrack.new(:duration => duration)
           end
         end
+        if (track = @original_video_tracks.first)
+          @original_width, @original_height = *track.dimensions
+        end
+        if (track = @original_video_tracks.first || @original_audio_tracks.first)
+          @original_duration = track.duration
+        end
         result
       end
 
@@ -136,6 +137,8 @@ module Bulldog
             send("#{name}=", value)
           end
         end
+
+        attr_accessor :duration
       end
 
       class VideoTrack < Track

data/lib/bulldog/style.rb

@@ -1,8 +1,12 @@
 module Bulldog
+  #
+  # Represents a style to generate.
+  #
   class Style
     def initialize(name, attributes={})
       @name = name
       @attributes = attributes
+      set_dimensions(attributes[:size])
     end
 
     attr_reader :name, :attributes
@@ -15,7 +19,12 @@ module Bulldog
     #
     # Set the value of the given style attribute.
     #
-    delegate :[]=, :to => :attributes
+    def []=(name, value)
+      if name == :size
+        set_dimensions(value)
+      end
+      attributes[name] = value
+    end
 
     #
     # Return true if the argument is a Style with the same name and
@@ -33,6 +42,24 @@ module Bulldog
 
     delegate :hash, :eql?, :to => :name
 
+    #
+    # The [width, height] specified by :size, or nil if there is no :size.
+    #
+    attr_reader :dimensions
+
+    #
+    # Return true if :filled is true, false otherwise.
+    #
+    def filled?
+      !!self[:filled]
+    end
+
+    private
+
+    def set_dimensions(value)
+      @dimensions = value ? value.scan(/\A(\d+)x(\d+)\z/).first.map{|s| s.to_i} : nil
+    end
+
     ORIGINAL = new(:original, {})
   end
 end