class MovieMasher::Output

Represents a single rendered version of the mashup, including all formatting parameters and quality settings.

There are five types of outputs: Type::AUDIO, Type::IMAGE and Type::VIDEO (the three raw types) as well as Type::SEQUENCE which outputs a folder full of image files from the video in the mashup, and Type::WAVEFORM which outputs an image file from the audio in the mashup.

If outputs need to be uploaded to different locations then each should have its own destination, otherwise they will all share Job#destination. Typically name is set to define the filename that's ultimately uploaded, but this can be overridden by destination. It's important to set extension regardless though since this generally determines the container format used during rendering.

By default outputs are optional, unless required is true. Optional outputs will not halt job processing if there's a problem rendering them. Instead of setting Job#error the problem is added to Job#log as a warning.

Output.create {
  type: Type::VIDEO,                       # aka 'video'
  name: 'video.mp4',                       # implied extension
  dimensions: '512x288',                   # ffmpeg -s switch
  video_rate: 30,                          # ffmpeg -r:v switch
  video_codec: 'libx264 -preset medium',   # ffmpeg -c:v switch
  video_bitrate: '2000K',                  # ffmpeg -b:v switch
  pixel_format: 'yuv420p'                  # ffmpeg -pix_fmt switch
}

Public Class Methods

create(hash = nil) click to toggle source

Returns¶ ↑

Returns a new instance.

# File lib/output.rb, line 36
def create(hash = nil)
  (hash.is_a?(Output) ? hash : Output.new(hash))
end

init_hash(output) click to toggle source

# File lib/output.rb, line 40
def init_hash(output)
  Hashable._init_key output, :type, Type::VIDEO
  output[:av] = __av_type_for_output(output)
  output_type = (Type::SEQUENCE == output[:type] ? '' : output[:type])
  Hashable._init_key output, :name, output_type
  if output[:name].include?('.') && !output[:extension]
    ext = File.extname(output[:name])
    output[:name][ext] = ''
    ext['.'] = ''
    output[:extension] = ext
  end
  case output[:type]
  when Type::VIDEO
    Hashable._init_key output, :audio_bitrate, 224
    Hashable._init_key output, :audio_codec, 'aac'
    Hashable._init_key output, :audio_rate, 44_100
    Hashable._init_key output, :backcolor, 'black'
    Hashable._init_key output, :dimensions, '512x288'
    Hashable._init_key output, :extension, 'mp4'
    Hashable._init_key output, :fill, Fill::NONE
    Hashable._init_key output, :video_rate, 30
    Hashable._init_key output, :pixel_format, 'yuv420p'
    Hashable._init_key output, :gain, Gain::None
    Hashable._init_key output, :precision, 1
    Hashable._init_key output, :video_bitrate, 2_000
    lib264 = 'libx264 -level 41 -movflags faststart'
    Hashable._init_key output, :video_codec, lib264
  when Type::SEQUENCE
    Hashable._init_key output, :backcolor, 'black'
    Hashable._init_key output, :video_rate, 10
    Hashable._init_key output, :extension, 'jpg'
    Hashable._init_key output, :dimensions, '256x144'
    Hashable._init_key output, :quality, 1
    output[:no_audio] = true
  when Type::IMAGE
    Hashable._init_key output, :video_rate, 10
    Hashable._init_key output, :backcolor, 'black'
    Hashable._init_key output, :quality, 1
    Hashable._init_key output, :extension, 'jpg'
    Hashable._init_key output, :dimensions, '256x144'
    Hashable._init_time output, :offset
    output[:no_audio] = true
  when Type::AUDIO
    Hashable._init_key output, :audio_bitrate, 224
    Hashable._init_key output, :precision, 0
    Hashable._init_key output, :audio_codec, 'libmp3lame'
    Hashable._init_key output, :extension, 'mp3'
    Hashable._init_key output, :audio_rate, 44_100
    Hashable._init_key output, :gain, Gain::None
    output[:no_video] = true
  when Type::WAVEFORM
    Hashable._init_key output, :backcolor, 'FFFFFF'
    Hashable._init_key output, :precision, 0
    Hashable._init_key output, :dimensions, '8000x32'
    Hashable._init_key output, :forecolor, '000000'
    Hashable._init_key output, :extension, 'png'
    output[:no_video] = true
  end
  output
end

new(hash) click to toggle source

Calls superclass method

# File lib/output.rb, line 251
def initialize(hash)
  self.class.init_hash(hash)
  super
end

sequence_complete(output) click to toggle source

# File lib/output.rb, line 101
def sequence_complete(output)
  dir_path = output[:rendered_file]
  ok = false
  if File.directory?(dir_path)
    first_frame = 1
    frame_count = (output[:video_rate].to_f * output[:duration]).to_i
    padding = (first_frame + frame_count).to_s.length
    last_file = nil
    frame_count.times do |frame_number|
      ok = true
      file_frame = frame_number + first_frame
      f_name = "#{output[:name]}#{file_frame.to_s.rjust(padding, '0')}"
      file_path = Path.concat(dir_path, "#{f_name}.#{output[:extension]}")
      if File.exist?(file_path)
        last_file = file_path
      elsif last_file
        FileUtils.copy(last_file, file_path)
      else
        ok = false
        break
      end
    end
  end
  ok
end

Public Instance Methods

audio_bitrate() click to toggle source

# File lib/output.rb, line 141
def audio_bitrate
  _get __method__
end

audio_bitrate=(value) click to toggle source

String: FFmpeg -b:a switch, placed before audio_rate.
Integer: The character 'k' will be appended.
Default: 224
Types: Type::AUDIO, Type::WAVEFORM and Type::VIDEO containing audio.

# File lib/output.rb, line 149
def audio_bitrate=(value)
  _set __method__, value
end

audio_codec() click to toggle source

# File lib/output.rb, line 153
def audio_codec
  _get __method__
end

audio_codec=(value) click to toggle source

String: FFmpeg -c:a switch, placed after audio_rate.
Default: aac -strict experimental
Types: Type::AUDIO, Type::WAVEFORM and Type::VIDEO containing audio.

# File lib/output.rb, line 160
def audio_codec=(value)
  _set __method__, value
end

audio_rate() click to toggle source

# File lib/output.rb, line 164
def audio_rate
  _get __method__
end

audio_rate=(value) click to toggle source

String: FFmpeg -r:a switch, placed between audio_bitrate & audio_codec.
Default: 44_100
Types: Type::AUDIO, Type::WAVEFORM and Type::VIDEO containing audio.

# File lib/output.rb, line 171
def audio_rate=(value)
  _set __method__, value
end

av() click to toggle source

String: The AV type.
Constant: AV::AUDIO_ONLY, AV::VIDEO_ONLY or AV::BOTH.
Default: Based on type and no_audio.

# File lib/output.rb, line 178
def av
  _get __method__
end

backcolor() click to toggle source

# File lib/output.rb, line 182
def backcolor
  _get __method__
end

backcolor=(value) click to toggle source

String: Six character hex, rgb(0,0,0) or standard color name.
Default: FFFFFF for Type::WAVEFORM, black for others.
Types: All except Type::AUDIO, but Type::WAVEFORM only accepts hex.

# File lib/output.rb, line 189
def backcolor=(value)
  _set __method__, value
end

destination() click to toggle source

# File lib/output.rb, line 193
def destination
  _get __method__
end

destination=(value) click to toggle source

Transfer: Describes where to upload this output.
Default: Job#destination

# File lib/output.rb, line 199
def destination=(value)
  _set __method__, value
end

dimensions() click to toggle source

# File lib/output.rb, line 203
def dimensions
  _get __method__
end

dimensions=(value) click to toggle source

String: Output pixel size formatted as WIDTHxHEIGHT.
Default: 512x288 for Type::VIDEO, 8000x32 for Type::WAVEFORM, or 256x144.
Types: All except Type::AUDIO.

# File lib/output.rb, line 210
def dimensions=(value)
  _set __method__, value
end

error?() click to toggle source

# File lib/output.rb, line 214
def error?
  err = nil
  err = destination.error? if destination
  if !err && (name.to_s.include? '/')
    err = "output name contains slash - use path instead #{name}"
  end
  err
end

extension() click to toggle source

# File lib/output.rb, line 223
def extension
  _get __method__
end

extension=(value) click to toggle source

String: Extension for rendered file, also implies format.
Default: Removed from name if present, otherwise mp4 for Type::VIDEO, mp3 for Type::AUDIO, png for Type::WAVEFORM and jpg for others.

# File lib/output.rb, line 230
def extension=(value)
  _set __method__, value
end

file_name() click to toggle source

# File lib/output.rb, line 234
def file_name
  fn = Path.strip_slashes(name)
  fn += ".#{extension}" if extension
  fn
end

forecolor() click to toggle source

# File lib/output.rb, line 240
def forecolor
  _get __method__
end

forecolor=(value) click to toggle source

String: Six character Hex color.
Default: 000000
Types: Only Type::WAVEFORM.

# File lib/output.rb, line 247
def forecolor=(value)
  _set __method__, value
end

metadata() click to toggle source

# File lib/output.rb, line 256
def metadata
  (self[:rendered_file] ? MetaReader.new(self[:rendered_file]) : {})
end

name() click to toggle source

# File lib/output.rb, line 260
def name
  _get __method__
end

name=(value) click to toggle source

String: Basename for rendered file.
Default: type, or empty for Type::SEQUENCE.
Types: All, but Type::SEQUENCE appends the frame number to each file.

# File lib/output.rb, line 267
def name=(value)
  _set __method__, value
end

no_audio() click to toggle source

# File lib/output.rb, line 271
def no_audio
  _get __method__
end

no_audio=(value) click to toggle source

Boolean: If true, audio in inputs will not be included.
Default: FALSE
Types: Just Type::VIDEO, but accessible for others.

# File lib/output.rb, line 278
def no_audio=(value)
  _set __method__, value
end

path() click to toggle source

# File lib/output.rb, line 282
def path
  _get __method__
end

path=(value) click to toggle source

String: Prepended to name during upload.
Default: empty

# File lib/output.rb, line 288
def path=(value)
  _set __method__, value
end

precision() click to toggle source

# File lib/output.rb, line 292
def precision
  _get __method__
end

precision=(value) click to toggle source

Integer: Number of decimal places that Job#duration and duration must match by for successful rendering - use negative number to skip duration check.
Default: 1 for Type::VIDEO, 0 for others.
Types: Type::VIDEO, Type::AUDIO, Type::WAVEFORM (Type::SEQUENCE copies last frame repeatedly to match).

# File lib/output.rb, line 302
def precision=(value)
  _set __method__, value
end

preflight(_job) click to toggle source

# File lib/output.rb, line 306
def preflight(_job)
  self.destination = Destination.create_if destination
  return if extension

  # try to determine from name if it has one
  output_name_extension = File.extname name
  return if output_name_extension.to_s.empty?

  self.name = File.basename(name, output_name_extension)
  self.extension = output_name_extension.delete('.')
end

quality() click to toggle source

# File lib/output.rb, line 318
def quality
  _get __method__
end

quality=(value) click to toggle source

Integer: FFmpeg -q:v switch, 1 (best) to 32 (worst).
Default: 1
Types: Type::IMAGE and Type::SEQUENCE.

# File lib/output.rb, line 325
def quality=(value)
  _set __method__, value
end

required() click to toggle source

# File lib/output.rb, line 329
def required
  _get __method__
end

required=(value) click to toggle source

Boolean: Whether or not Job should halt if output fails render or upload.
Default: nil

# File lib/output.rb, line 335
def required=(value)
  _set __method__, value
end

type() click to toggle source

# File lib/output.rb, line 339
def type
  _get __method__
end

type=(value) click to toggle source

String: The kind of output.
Constant: Type::AUDIO, Type::IMAGE, Type::SEQUENCE, Type::VIDEO or Type::WAVEFORM.
Default: Type::VIDEO.

# File lib/output.rb, line 347
def type=(value)
  _set __method__, value
end

video_bitrate() click to toggle source

# File lib/output.rb, line 351
def video_bitrate
  _get __method__
end

video_bitrate=(value) click to toggle source

String: FFmpeg -b:v switch, placed between video_codec & video_rate.
Integer: The character 'k' will be appended.
Default: 2000
Types: Only Type::VIDEO.

# File lib/output.rb, line 359
def video_bitrate=(value)
  _set __method__, value
end

video_codec() click to toggle source

# File lib/output.rb, line 363
def video_codec
  _get __method__
end

video_codec=(value) click to toggle source

String: FFmpeg -c:v switch, between video_format & video_bitrate.
Default: libx264 -level 41 -movflags faststart
Types: Only Type::VIDEO.

# File lib/output.rb, line 370
def video_codec=(value)
  _set __method__, value
end

video_format() click to toggle source

# File lib/output.rb, line 374
def video_format
  _get __method__
end

video_format=(value) click to toggle source

String: FFmpeg -f:v switch, placed between dimensions & video_codec.
Default: nil
Types: Only Type::VIDEO.

# File lib/output.rb, line 381
def video_format=(value)
  _set __method__, value
end

video_rate() click to toggle source

# File lib/output.rb, line 385
def video_rate
  _get __method__
end

video_rate=(value) click to toggle source

String: FFmpeg -r:v switch, placed after video_bitrate.
Default: 30
Types: Type::SEQUENCE and Type::VIDEO.

# File lib/output.rb, line 392
def video_rate=(value)
  _set __method__, value
end