Class: FFMPEG::Movie

Inherits:
Object
  • Object
show all
Defined in:
lib/ffmpeg/movie.rb

Constant Summary collapse

UNSUPPORTED_CODEC_PATTERN =
/^Unsupported codec with id (\d+) for input stream (\d+)$/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ Movie



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
128
129
130
131
132
133
134
135
# File 'lib/ffmpeg/movie.rb', line 16

def initialize(path)
  @path = path

  if remote?
    @head = head
    unless @head.is_a?(Net::HTTPSuccess)
      raise Errno::ENOENT, "the URL '#{path}' does not exist or is not available (response code: #{@head.code})"
    end
  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
     = MultiJson.load(std_output, symbolize_keys: true)
  rescue MultiJson::ParseError
    raise "Could not parse output from FFProbe:\n#{ std_output }"
  end

  if .key?(:error)

    @duration = 0

  else
    video_streams = [:streams].select { |stream| stream.key?(:codec_type) and stream[:codec_type] === 'video' }
    audio_streams = [:streams].select { |stream| stream.key?(:codec_type) and stream[:codec_type] === 'audio' }

    @container = [:format][:format_name]

    @duration = [:format][:duration].to_f

    @time = [:format][:start_time].to_f

    @format_tags = [: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 = [: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],
        :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_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 .key?(:error)
  @invalid = true if std_error.include?("could not find codec parameters")
end

Instance Attribute Details

#audio_bitrateObject (readonly)

Returns the value of attribute audio_bitrate



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_bitrate
  @audio_bitrate
end

#audio_channelsObject (readonly)

Returns the value of attribute audio_channels



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_channels
  @audio_channels
end

#audio_codecObject (readonly)

Returns the value of attribute audio_codec



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_codec
  @audio_codec
end

#audio_sample_rateObject (readonly)

Returns the value of attribute audio_sample_rate



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_sample_rate
  @audio_sample_rate
end

#audio_streamObject (readonly)

Returns the value of attribute audio_stream



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_stream
  @audio_stream
end

#audio_streamsObject (readonly)

Returns the value of attribute audio_streams



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_streams
  @audio_streams
end

#audio_tagsObject (readonly)

Returns the value of attribute audio_tags



10
11
12
# File 'lib/ffmpeg/movie.rb', line 10

def audio_tags
  @audio_tags
end

#bitrateObject (readonly)

Returns the value of attribute bitrate



8
9
10
# File 'lib/ffmpeg/movie.rb', line 8

def bitrate
  @bitrate
end

#colorspaceObject (readonly)

Returns the value of attribute colorspace



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def colorspace
  @colorspace
end

#containerObject (readonly)

Returns the value of attribute container



11
12
13
# File 'lib/ffmpeg/movie.rb', line 11

def container
  @container
end

#creation_timeObject (readonly)

Returns the value of attribute creation_time



8
9
10
# File 'lib/ffmpeg/movie.rb', line 8

def creation_time
  @creation_time
end

#darObject (readonly)

Returns the value of attribute dar



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def dar
  @dar
end

#durationObject (readonly)

Returns the value of attribute duration



8
9
10
# File 'lib/ffmpeg/movie.rb', line 8

def duration
  @duration
end

#format_tagsObject (readonly)

Returns the value of attribute format_tags



12
13
14
# File 'lib/ffmpeg/movie.rb', line 12

def format_tags
  @format_tags
end

#frame_rateObject (readonly)

Returns the value of attribute frame_rate



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def frame_rate
  @frame_rate
end

#heightObject (readonly)

Returns the value of attribute height



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def height
  @height
end

#metadataObject (readonly)

Returns the value of attribute metadata



12
13
14
# File 'lib/ffmpeg/movie.rb', line 12

def 
  
end

#pathObject (readonly)

Returns the value of attribute path



8
9
10
# File 'lib/ffmpeg/movie.rb', line 8

def path
  @path
end

#rotationObject (readonly)

Returns the value of attribute rotation



8
9
10
# File 'lib/ffmpeg/movie.rb', line 8

def rotation
  @rotation
end

#sarObject (readonly)

Returns the value of attribute sar



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def sar
  @sar
end

#timeObject (readonly)

Returns the value of attribute time



8
9
10
# File 'lib/ffmpeg/movie.rb', line 8

def time
  @time
end

#video_bitrateObject (readonly)

Returns the value of attribute video_bitrate



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def video_bitrate
  @video_bitrate
end

#video_codecObject (readonly)

Returns the value of attribute video_codec



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def video_codec
  @video_codec
end

#video_streamObject (readonly)

Returns the value of attribute video_stream



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def video_stream
  @video_stream
end

#widthObject (readonly)

Returns the value of attribute width



9
10
11
# File 'lib/ffmpeg/movie.rb', line 9

def width
  @width
end

Instance Method Details

#audio_channel_layoutObject



188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/ffmpeg/movie.rb', line 188

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

#calculated_aspect_ratioObject



172
173
174
# File 'lib/ffmpeg/movie.rb', line 172

def calculated_aspect_ratio
  aspect_from_dar || aspect_from_dimensions
end

#calculated_pixel_aspect_ratioObject



176
177
178
# File 'lib/ffmpeg/movie.rb', line 176

def calculated_pixel_aspect_ratio
  aspect_from_sar || 1
end

#local?Boolean



154
155
156
# File 'lib/ffmpeg/movie.rb', line 154

def local?
  not remote?
end

#remote?Boolean



150
151
152
# File 'lib/ffmpeg/movie.rb', line 150

def remote?
  @path =~ URI::regexp(%w(http https))
end

#resolutionObject



166
167
168
169
170
# File 'lib/ffmpeg/movie.rb', line 166

def resolution
  unless width.nil? or height.nil?
    "#{width}x#{height}"
  end
end

#screenshot(output_file, options = EncodingOptions.new, transcoder_options = {}, &block) ⇒ Object



206
207
208
# File 'lib/ffmpeg/movie.rb', line 206

def screenshot(output_file, options = EncodingOptions.new, transcoder_options = {}, &block)
  Transcoder.new(self, output_file, options.merge(screenshot: true), transcoder_options).run &block
end

#sizeObject



180
181
182
183
184
185
186
# File 'lib/ffmpeg/movie.rb', line 180

def size
  if local?
    File.size(@path)
  else
    @head.content_length
  end
end

#transcode(output_file, options = EncodingOptions.new, transcoder_options = {}, &block) ⇒ Object



202
203
204
# File 'lib/ffmpeg/movie.rb', line 202

def transcode(output_file, options = EncodingOptions.new, transcoder_options = {}, &block)
  Transcoder.new(self, output_file, options, transcoder_options).run &block
end

#unsupported_streams(std_error) ⇒ Object



137
138
139
140
141
142
143
144
# File 'lib/ffmpeg/movie.rb', line 137

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

#valid?Boolean



146
147
148
# File 'lib/ffmpeg/movie.rb', line 146

def valid?
  not @invalid
end