Module: Depix

Defined in:

lib/depix.rb,
lib/depix/enums.rb,
lib/depix/editor.rb,
lib/depix/reader.rb,
lib/depix/structs.rb,
lib/depix/binary/fields.rb,
lib/depix/compact_structs.rb

Defined Under Namespace

Modules: Binary, Synthetics Classes: CompactDPX, DPX, Describe, Editor, FileInfo, FilmInfo, ImageElement, ImageInfo, InvalidHeader, OrientationInfo, Reader, TelevisionInfo, UserInfo

Constant Summary

VERSION =

'3.0.1'

COLORIMETRIC =

{
    :UserDefined => 0,
    :PrintingDensity => 1,
    :Linear => 2,
    :Logarithmic => 3,
    :UnspecifiedVideo => 4,
    :SMTPE_274M => 5,
    :ITU_R709 => 6,
    :ITU_R601_625L => 7,
    :ITU_R601_525L => 8,
    :NTSCCompositeVideo => 9,
    :PALCompositeVideo => 10,
    :ZDepthLinear => 11,
    :DepthHomogeneous => 12
}

COMPONENT_TYPE =

{
  :Undefined => 0,
  :Red => 1,
  :Green => 2,
  :Blue => 3,
  :Alpha => 4,
  :Luma => 6,
  :ColorDifferenceCbCr => 7,
  :Depth => 8,
  :CompositeVideo => 9,
  :RGB => 50,
  :RGBA => 51,
  :ABGR => 52,
  :CbYCrY422 => 100,
  :CbYACrYA4224 => 101,
  :CbYCr444 => 102,
  :CbYCrA4444 => 103,
  :UserDef2Element => 150,
  :UserDef3Element => 151,
  :UserDef4Element => 152,
  :UserDef5Element => 153,
  :UserDef6Element => 154,
  :UserDef7Element => 155,
  :UserDef8Element => 156,
}

CompactInfo =

FileInfo.only(
  :magic,
  :ditto_key,
  :filename,
  :timestamp,
  :image_offset 
)

CompactFilmInfo =

FilmInfo.only(
  :offset,
  :count,
  :frame_position,
  :frame_id,
  :slate,
  :id,
  :type,
  :prefix,
  :sequence_extent,
  :frame_rate
)

CompactOrientation =

OrientationInfo.only(
  :filename,
  :timestamp
)

CompactTelevision =

TelevisionInfo.only(
  :time_code,
  :user_bits,
  :field_number
)

Class Method Summary

• .from_file(path, compact = false) ⇒ Object

  Return a DPX object describing a file at path.

• .from_string(string, compact = false) ⇒ Object

  Return a DPX object describing headers embedded at the start of the string.

Class Method Details

.from_file(path, compact = false) ⇒ Object

Return a DPX object describing a file at path. The second argument specifies whether you need a compact or a full description

# File 'lib/depix.rb', line 26

def self.from_file(path, compact = false)
  Reader.new.from_file(path, compact)
end

.from_string(string, compact = false) ⇒ Object

Return a DPX object describing headers embedded at the start of the string. The second argument specifies whether you need a compact or a full description

# File 'lib/depix.rb', line 32

def self.from_string(string, compact = false)
  Reader.new.parse(string, compact)
end