Class: Paperclip::Ffmpeg

Inherits:
Processor
  • Object
show all
Defined in:
lib/paperclip-ffmpeg.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file, options = {}, attachment = nil) ⇒ Ffmpeg

Creates a Video object set to work on the file given. It will attempt to transcode the video into one defined by target_geometry which is a “WxH”-style string. format should be specified. Video transcoding will raise no errors unless whiny is true (which it is, by default. If convert_options is set, the options will be appended to the convert command upon video transcoding



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/paperclip-ffmpeg.rb', line 12

def initialize file, options = {}, attachment = nil
  @convert_options = {
    :input => {},
    :output => { :y => nil }
  }
  unless options[:convert_options].nil? || options[:convert_options].class != Hash
    unless options[:convert_options][:input].nil? || options[:convert_options][:input].class != Hash
      @convert_options[:input].reverse_merge! options[:convert_options][:input]
    end
    unless options[:convert_options][:output].nil? || options[:convert_options][:output].class != Hash
      @convert_options[:output].reverse_merge! options[:convert_options][:output]
    end
  end
  
  @geometry        = options[:geometry]
  @file            = file
  @keep_aspect     = !@geometry.nil? && @geometry[-1,1] != '!'
  @pad_only        = @keep_aspect    && @geometry[-1,1] == '#'
  @enlarge_only    = @keep_aspect    && @geometry[-1,1] == '<'
  @shrink_only     = @keep_aspect    && @geometry[-1,1] == '>'
  @whiny           = options[:whiny].nil? ? true : options[:whiny]
  @format          = options[:format]
  @time            = options[:time].nil? ? 3 : options[:time]
  @current_format  = File.extname(@file.path)
  @basename        = File.basename(@file.path, @current_format)
  @meta            = identify
  attachment.instance_write(:meta, @meta)
end

Instance Attribute Details

#convert_options ⇒ Object

Returns the value of attribute convert_options.



4
5
6
 
# File 'lib/paperclip-ffmpeg.rb', line 4

def convert_options
  @convert_options
end

#format ⇒ Object

Returns the value of attribute format.



4
5
6
 
# File 'lib/paperclip-ffmpeg.rb', line 4

def format
  @format
end

#geometry ⇒ Object

Returns the value of attribute geometry.



4
5
6
 
# File 'lib/paperclip-ffmpeg.rb', line 4

def geometry
  @geometry
end

#whiny ⇒ Object

Returns the value of attribute whiny.



4
5
6
 
# File 'lib/paperclip-ffmpeg.rb', line 4

def whiny
  @whiny
end

Instance Method Details

#identify ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/paperclip-ffmpeg.rb', line 129

def identify
  meta = {}
  command = "ffmpeg -i #{File.expand_path(@file.path)} 2>&1"
  Paperclip.log(command)
  ffmpeg = IO.popen(command)
  ffmpeg.each("\r") do |line|
    if line =~ /((\d*)\s.?)fps,/
      meta[:fps] = $1.to_i
    end
    # Matching lines like:
    # Video: h264, yuvj420p, 640x480 [PAR 72:72 DAR 4:3], 10301 kb/s, 30 fps, 30 tbr, 600 tbn, 600 tbc
    if line =~ /Video:(.*)/
      v = $1.to_s.split(',')
      size = v[2].strip!.split(' ').first
      meta[:size] = size.to_s
      meta[:aspect] = size.split('x').first.to_f / size.split('x').last.to_f
    end
    # Matching Duration: 00:01:31.66, start: 0.000000, bitrate: 10404 kb/s
    if line =~ /Duration:(\s.?(\d*):(\d*):(\d*\.\d*))/
      meta[:length] = $2.to_s + ":" + $3.to_s + ":" + $4.to_s
    end
  end
  meta
end

#make ⇒ Object

Performs the transcoding of the file into a thumbnail/video. Returns the Tempfile that contains the new image/video.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/paperclip-ffmpeg.rb', line 42

def make
  src = @file
  dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
  dst.binmode
  
  parameters = []
  # Add geometry
  if @geometry
    # Extract target dimensions
    if @geometry =~ /(\d*)x(\d*)/
      target_width = $1
      target_height = $2
    end
    # Only calculate target dimensions if we have current dimensions
    unless @meta[:size].nil?
      current_geometry = @meta[:size].split('x')
      # Current width and height
      current_width = current_geometry[0]
      current_height = current_geometry[1]
      if @keep_aspect
        if @enlarge_only
          if current_width.to_i < target_width.to_i
            # Keep aspect ratio
            width = target_width.to_i
            height = (width.to_f / (@meta[:aspect].to_f)).to_i
            @convert_options[:output][:s] = "#{width.to_i}x#{height.to_i}"
          else
            return nil
          end
        elsif @shrink_only
          if current_width.to_i > target_width.to_i
            # Keep aspect ratio
            width = target_width.to_i
            height = (width.to_f / (@meta[:aspect].to_f)).to_i
            @convert_options[:output][:s] = "#{width.to_i}x#{height.to_i}"
          else
            return nil
          end
        elsif @pad_only
          # Keep aspect ratio
          width = target_width.to_i
          height = (width.to_f / (@meta[:aspect].to_f)).to_i
          # We should add half the delta as a padding offset Y
          pad_y = (target_height.to_f - height.to_f) / 2
          if pad_y > 0
            @convert_options[:output][:vf] = "scale=#{width}:-1,pad=#{width.to_i}:#{target_height.to_i}:0:#{pad_y}:black"
          else
            @convert_options[:output][:vf] = "scale=#{width}:-1,crop=#{width.to_i}:#{height.to_i}"
          end
        else
          # Keep aspect ratio
          width = target_width.to_i
          height = (width.to_f / (@meta[:aspect].to_f)).to_i
          @convert_options[:output][:s] = "#{width.to_i}x#{height.to_i}"
        end
      else
        # Do not keep aspect ratio
        @convert_options[:output][:s] = "#{target_width.to_i}x#{target_height.to_i}"
      end
    end
  end
  # Add format
  case @format
  when 'jpg', 'jpeg', 'png', 'gif' # Images
    @convert_options[:input][:ss] = @time
    @convert_options[:input][:vframes] = 1
    @convert_options[:output][:f] = 'image2'
  end
  
  # Add source
  parameters << @convert_options[:input].map { |k,v| "-#{k.to_s} #{v} "}
  parameters << "-i :source"
  parameters << @convert_options[:output].map { |k,v| "-#{k.to_s} #{v} "}
  parameters << ":dest"

  parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
  
  Paperclip.log("[paperclip][ffmpeg] #{parameters}")
  begin
    success = Paperclip.run("ffmpeg", parameters, :source => "#{File.expand_path(src.path)}", :dest => File.expand_path(dst.path))
  rescue Cocaine::ExitStatusError => e
    raise PaperclipError, "error while processing video for #{@basename}: #{e}" if @whiny
  end

  dst
end