d-streamio-ffmpeg 3.0.3

data/lib/ffmpeg/encoding_options.rb

@@ -0,0 +1,200 @@
+module FFMPEG
+  class EncodingOptions < Hash
+    def initialize(options = {})
+      merge!(options)
+    end
+
+    def params_order(k)
+      if k =~ /watermark$/
+        0
+      elsif k =~ /watermark/
+        1
+      elsif k =~ /codec/
+        2
+      elsif k =~ /preset/
+        3
+      else
+        4
+      end
+    end
+
+    def to_a
+      params = []
+
+      # codecs should go before the presets so that the files will be matched successfully
+      # all other parameters go after so that we can override whatever is in the preset
+      keys.sort_by{|k| params_order(k) }.each do |key|
+
+        value   = self[key]
+        a = send("convert_#{key}", value) if value && supports_option?(key)
+        params += a unless a.nil?
+      end
+
+      params += convert_aspect(calculate_aspect) if calculate_aspect?
+      params.map(&:to_s)
+    end
+
+    def width
+      self[:resolution].split("x").first.to_i rescue nil
+    end
+
+    def height
+      self[:resolution].split("x").last.to_i rescue nil
+    end
+
+    private
+    def supports_option?(option)
+      option = RUBY_VERSION < "1.9" ? "convert_#{option}" : "convert_#{option}".to_sym
+      private_methods.include?(option)
+    end
+
+    def convert_aspect(value)
+      ["-aspect", value]
+    end
+
+    def calculate_aspect
+      width, height = self[:resolution].split("x")
+      width.to_f / height.to_f
+    end
+
+    def calculate_aspect?
+      self[:aspect].nil? && self[:resolution]
+    end
+
+    def convert_video_codec(value)
+      ["-vcodec", value]
+    end
+
+    def convert_frame_rate(value)
+      ["-r", value]
+    end
+
+    def convert_resolution(value)
+      ["-s", value]
+    end
+
+    def convert_video_bitrate(value)
+      ["-b:v", k_format(value)]
+    end
+
+    def convert_audio_codec(value)
+      ["-acodec", value]
+    end
+
+    def convert_audio_bitrate(value)
+      ["-b:a", k_format(value)]
+    end
+
+    def convert_audio_sample_rate(value)
+      ["-ar", value]
+    end
+
+    def convert_audio_channels(value)
+      ["-ac", value]
+    end
+
+    def convert_video_max_bitrate(value)
+      ["-maxrate", k_format(value)]
+    end
+
+    def convert_video_min_bitrate(value)
+      ["-minrate", k_format(value)]
+    end
+
+    def convert_buffer_size(value)
+      ["-bufsize", k_format(value)]
+    end
+
+    def convert_video_bitrate_tolerance(value)
+      ["-bt", k_format(value)]
+    end
+
+    def convert_threads(value)
+      ["-threads", value]
+    end
+
+    def convert_target(value)
+      ['-target', value]
+    end
+
+    def convert_duration(value)
+      ["-t", value]
+    end
+
+    def convert_video_preset(value)
+      ["-vpre", value]
+    end
+
+    def convert_audio_preset(value)
+      ["-apre", value]
+    end
+
+    def convert_file_preset(value)
+      ["-fpre", value]
+    end
+
+    def convert_keyframe_interval(value)
+      ["-g", value]
+    end
+
+    def convert_seek_time(value)
+      ["-ss", value]
+    end
+
+    def convert_screenshot(value)
+      result = []
+      unless self[:vframes]
+        result << '-vframes'
+        result << 1
+      end
+      result << '-f'
+      result << 'image2'
+      value ? result : []
+    end
+
+    def convert_quality(value)
+      ['-q:v', value]
+    end
+
+    def convert_vframes(value)
+      ['-vframes', value]
+    end
+
+    def convert_x264_vprofile(value)
+      ["-vprofile", value]
+    end
+
+    def convert_x264_preset(value)
+      ["-preset", value]
+    end
+
+    def convert_watermark(value)
+      ["-i", value]
+    end
+
+    def convert_watermark_filter(value)
+      position = value[:position]
+      padding_x = value[:padding_x] || 10
+      padding_y = value[:padding_y] || 10
+      case position.to_s
+        when "LT"
+          ["-filter_complex", "scale=#{self[:resolution]},overlay=x=#{padding_x}:y=#{padding_y}"]
+        when "RT"
+          ["-filter_complex", "scale=#{self[:resolution]},overlay=x=main_w-overlay_w-#{padding_x}:y=#{padding_y}"]
+        when "LB"
+          ["-filter_complex", "scale=#{self[:resolution]},overlay=x=#{padding_x}:y=main_h-overlay_h-#{padding_y}"]
+        when "RB"
+          ["-filter_complex", "scale=#{self[:resolution]},overlay=x=main_w-overlay_w-#{padding_x}:y=main_h-overlay_h-#{padding_y}"]
+      end
+    end
+
+    def convert_custom(value)
+      raise ArgumentError unless value.class <= Array
+      value
+    end
+
+    def k_format(value)
+      value.to_s.include?("k") ? value : "#{value}k"
+    end
+  end
+end

data/lib/ffmpeg/errors.rb

@@ -0,0 +1,6 @@
+module FFMPEG
+  class Error < StandardError
+  end
+  class HTTPTooManyRequests < StandardError
+  end
+end

data/lib/ffmpeg/io_monkey.rb

@@ -0,0 +1,42 @@
+require 'timeout'
+require 'thread'
+if RUBY_PLATFORM =~ /(win|w)(32|64)$/
+  begin
+    require 'win32/process'
+  rescue LoadError
+    "Warning: streamio-ffmpeg is missing the win32-process gem to properly handle hung transcodings. Install the gem (in Gemfile if using bundler) to avoid errors."
+  end
+end
+
+#
+# Monkey Patch timeout support into the IO class
+#
+class IO
+  def each_with_timeout(pid, seconds, sep_string=$/)
+    last_update = Time.now
+
+    current_thread = Thread.current
+    check_update_thread = Thread.new do
+      loop do
+        sleep 0.1
+        if last_update - Time.now < -seconds
+          current_thread.raise Timeout::Error.new('output wait time expired')
+        end
+      end
+    end
+
+    each(sep_string) do |buffer|
+      last_update = Time.now
+      yield buffer
+    end
+  rescue Timeout::Error
+    if RUBY_PLATFORM =~ /(win|w)(32|64)$/
+      Process.kill(1, pid)
+    else
+      Process.kill('SIGKILL', pid)
+    end
+    raise
+  ensure
+    check_update_thread.kill
+  end
+end

data/lib/ffmpeg/movie.rb

@@ -0,0 +1,257 @@
+require 'time'
+require 'multi_json'
+require 'uri'
+
+module FFMPEG
+  class Movie
+    attr_reader :path, :duration, :time, :bitrate, :rotation, :creation_time
+    attr_reader :video_stream, :video_codec, :video_bitrate, :colorspace, :width, :height, :sar, :dar, :frame_rate
+    attr_reader :audio_streams, :audio_stream, :audio_codec, :audio_bitrate, :audio_sample_rate, :audio_channels, :audio_tags, :audio_sample_fmt
+    attr_reader :container
+    attr_reader :metadata, :format_tags
+
+    UNSUPPORTED_CODEC_PATTERN = /^Unsupported codec with id (\d+) for input stream (\d+)$/
+
+    def initialize(path)
+      @path = path
+
+      if remote?
+        @head = head
+        raise Errno::ENOENT, "the URL '#{path}' does not exist" unless @head.is_a?(Net::HTTPSuccess)
+      else
+        raise Errno::ENOENT, "the file '#{path}' does not exist" unless File.exist?(path)
+      end
+
+      @path = path
+
+      # ffmpeg will output to stderr
+      command = [FFMPEG.ffprobe_binary, '-i', path, *%w(-print_format json -show_format -show_streams -show_error)]
+      std_output = ''
+      std_error = ''
+
+      Open3.popen3(*command) do |stdin, stdout, stderr|
+        std_output = stdout.read unless stdout.nil?
+        std_error = stderr.read unless stderr.nil?
+      end
+
+      fix_encoding(std_output)
+      fix_encoding(std_error)
+
+      begin
+        @metadata = MultiJson.load(std_output, symbolize_keys: true)
+      rescue MultiJson::ParseError
+        raise "Could not parse output from FFProbe:\n#{ std_output }"
+      end
+
+      if @metadata.key?(:error)
+
+        @duration = 0
+
+      else
+        video_streams = @metadata[:streams].select { |stream| stream.key?(:codec_type) and stream[:codec_type] === 'video' }
+        audio_streams = @metadata[:streams].select { |stream| stream.key?(:codec_type) and stream[:codec_type] === 'audio' }
+
+        @container = @metadata[:format][:format_name]
+
+        @duration = @metadata[:format][:duration].to_f
+
+        @time = @metadata[:format][:start_time].to_f
+
+        @format_tags = @metadata[:format][:tags]
+
+        @creation_time = if @format_tags and @format_tags.key?(:creation_time)
+                           begin
+                             Time.parse(@format_tags[:creation_time])
+                           rescue ArgumentError
+                             nil
+                           end
+                         else
+                           nil
+                         end
+
+        @bitrate = @metadata[:format][:bit_rate].to_i
+
+        # TODO: Handle multiple video codecs (is that possible?)
+        video_stream = video_streams.first
+        unless video_stream.nil?
+          @video_codec = video_stream[:codec_name]
+          @colorspace = video_stream[:pix_fmt]
+          @width = video_stream[:width]
+          @height = video_stream[:height]
+          @video_bitrate = video_stream[:bit_rate].to_i
+          @sar = video_stream[:sample_aspect_ratio]
+          @dar = video_stream[:display_aspect_ratio]
+
+          @frame_rate = unless video_stream[:avg_frame_rate] == '0/0'
+                          Rational(video_stream[:avg_frame_rate])
+                        else
+                          nil
+                        end
+
+          @video_stream = "#{video_stream[:codec_name]} (#{video_stream[:profile]}) (#{video_stream[:codec_tag_string]} / #{video_stream[:codec_tag]}), #{colorspace}, #{resolution} [SAR #{sar} DAR #{dar}]"
+
+          @rotation = if video_stream.key?(:tags) and video_stream[:tags].key?(:rotate)
+                        video_stream[:tags][:rotate].to_i
+                      else
+                        nil
+                      end
+        end
+
+        @audio_streams = audio_streams.map do |stream|
+          {
+            :index => stream[:index],
+            :channels => stream[:channels].to_i,
+            :codec_name => stream[:codec_name],
+            :sample_rate => stream[:sample_rate].to_i,
+            :bitrate => stream[:bit_rate].to_i,
+            :channel_layout => stream[:channel_layout],
+            :tags => stream[:streams],
+            :sample_fmt => stream[:sample_fmt],
+            :overview => "#{stream[:codec_name]} (#{stream[:codec_tag_string]} / #{stream[:codec_tag]}), #{stream[:sample_rate]} Hz, #{stream[:channel_layout]}, #{stream[:sample_fmt]}, #{stream[:bit_rate]} bit/s"
+          }
+        end
+
+        audio_stream = @audio_streams.first
+        unless audio_stream.nil?
+          @audio_channels = audio_stream[:channels]
+          @audio_codec = audio_stream[:codec_name]
+          @audio_sample_rate = audio_stream[:sample_rate]
+          @audio_bitrate = audio_stream[:bitrate]
+          @audio_channel_layout = audio_stream[:channel_layout]
+          @audio_tags = audio_stream[:audio_tags]
+          @audio_sample_fmt = audio_stream[:sample_fmt]
+          @audio_stream = audio_stream[:overview]
+        end
+
+      end
+
+      unsupported_stream_ids = unsupported_streams(std_error)
+      nil_or_unsupported = -> (stream) { stream.nil? || unsupported_stream_ids.include?(stream[:index]) }
+
+      @invalid = true if nil_or_unsupported.(video_stream) && nil_or_unsupported.(audio_stream)
+      @invalid = true if @metadata.key?(:error)
+      @invalid = true if std_error.include?("could not find codec parameters")
+    end
+
+    def unsupported_streams(std_error)
+      [].tap do |stream_indices|
+        std_error.each_line do |line|
+          match = line.match(UNSUPPORTED_CODEC_PATTERN)
+          stream_indices << match[2].to_i if match
+        end
+      end
+    end
+
+    def valid?
+      not @invalid
+    end
+
+    def remote?
+      @path =~ URI::regexp(%w(http https))
+    end
+
+    def local?
+      not remote?
+    end
+
+    def width
+      rotation.nil? || rotation == 180 ? @width : @height;
+    end
+
+    def height
+      rotation.nil? || rotation == 180 ? @height : @width;
+    end
+
+    def resolution
+      unless width.nil? or height.nil?
+        "#{width}x#{height}"
+      end
+    end
+
+    def calculated_aspect_ratio
+      aspect_from_dar || aspect_from_dimensions
+    end
+
+    def calculated_pixel_aspect_ratio
+      aspect_from_sar || 1
+    end
+
+    def size
+      if local?
+        File.size(@path)
+      else
+        @head.content_length
+      end
+    end
+
+    def audio_channel_layout
+      # TODO Whenever support for ffmpeg/ffprobe 1.2.1 is dropped this is no longer needed
+      @audio_channel_layout || case(audio_channels)
+                                 when 1
+                                   'stereo'
+                                 when 2
+                                   'stereo'
+                                 when 6
+                                   '5.1'
+                                 else
+                                   'unknown'
+                               end
+    end
+
+    def transcode(output_file, options = EncodingOptions.new, transcoder_options = {}, &block)
+      Transcoder.new(self, output_file, options, transcoder_options).run &block
+    end
+
+    def screenshot(output_file, options = EncodingOptions.new, transcoder_options = {}, &block)
+      Transcoder.new(self, output_file, options.merge(screenshot: true), transcoder_options).run &block
+    end
+
+    protected
+    def aspect_from_dar
+      calculate_aspect(dar)
+    end
+
+    def aspect_from_sar
+      calculate_aspect(sar)
+    end
+
+    def calculate_aspect(ratio)
+      return nil unless ratio
+      w, h = ratio.split(':')
+      return nil if w == '0' || h == '0'
+      @rotation.nil? || (@rotation == 180) ? (w.to_f / h.to_f) : (h.to_f / w.to_f)
+    end
+
+    def aspect_from_dimensions
+      aspect = width.to_f / height.to_f
+      aspect.nan? ? nil : aspect
+    end
+
+    def fix_encoding(output)
+      output[/test/] # Running a regexp on the string throws error if it's not UTF-8
+    rescue ArgumentError
+      output.force_encoding("ISO-8859-1")
+    end
+
+    def head(location=@path, limit=FFMPEG.max_http_redirect_attempts)
+      url = URI(location)
+      return unless url.path
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = url.port == 443
+      response = http.request_head(url.request_uri)
+
+      case response
+        when Net::HTTPRedirection then
+          raise FFMPEG::HTTPTooManyRequests if limit == 0
+          new_uri = url + URI(response['Location'])
+
+          head(new_uri, limit - 1)
+        else
+          response
+      end
+    rescue SocketError, Errno::ECONNREFUSED => e
+      nil
+    end
+  end
+end