libcineon  0.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cineon::Header Struct Reference

Complete DPX Header. More...

#include <CineonHeader.h>

Inheritance diagram for cineon::Header:
Inheritance graph
[legend]
Collaboration diagram for cineon::Header:
Collaboration graph
[legend]

Public Member Functions

 Header ()
 
void Reset ()
 Set the header data to a known start state. More...
 
bool Read (InStream *)
 Set the Input Stream object to read header from. More...
 
bool Write (OutStream *)
 Set the Output Stream object to write header to. More...
 
bool WriteOffsetData (OutStream *)
 
bool Validate ()
 Validate the header. More...
 
bool RequiresByteSwap () const
 Does header require endian byte swap. More...
 
const U32 Size () const
 Returns the size of the header. More...
 
void CalculateOffsets ()
 Calculate all of the offset members in the header. More...
 
void SetDatumSwap (const bool swap)
 Set whether reader/writer should swap component ordering. More...
 
bool Check ()
 
U32 Height () const
 Height of the image (maximum of all elements' heights) adjusted for orientation. More...
 
U32 Width () const
 Width of the image (maximum of all elements' widths) adjusted for orientation. More...
 
int ImageElementCount () const
 Number of Active Elements in the Image. More...
 
void CalculateNumberOfElements ()
 Set member numberOfElements based on channel structure. More...
 
int ImageElementComponentCount (const int element) const
 Number of components for the element. More...
 
DataSize ComponentDataSize (const int element) const
 DataSize required for individual image element components. More...
 
int ComponentByteCount (const int element) const
 Byte count of data element components. More...
 
File Information Methods
U32 MagicNumber () const
 Get magic number, used for byte ordering identification. More...
 
U32 ImageOffset () const
 Get the offset in bytes to the start of the first image element. More...
 
void SetImageOffset (const U32 offset)
 Set the offset in bytes to the start of the first image element. More...
 
U32 GenericSize () const
 Get the size of the generic section within the header. More...
 
U32 IndustrySize () const
 Get the size of the industry section within the header. More...
 
U32 UserSize () const
 Get the size of the user data. More...
 
void SetUserSize (const U32 size)
 Set the size of the user data. More...
 
U32 FileSize () const
 Get the size of the entire file. More...
 
void SetFileSize (const U32 fs)
 Set the size of the entire file. More...
 
void Version (char *v) const
 Get current version string of header. More...
 
void SetVersion (const char *v)
 Set the version string. More...
 
void FileName (char *fn) const
 Get the file name. More...
 
void SetFileName (const char *fn)
 Set the file name. More...
 
void CreationDate (char *ct) const
 Get the creation time/date. More...
 
void SetCreationDate (const char *ct)
 Set the creation time/date. More...
 
void CreationTime (char *ct) const
 Get the creation time/date. More...
 
void SetCreationTime (const char *ct)
 Set the creation time/date. More...
 
void SetCreationTimeDate (const long secs)
 Set the creation time/date. More...
 
Image Information Methods
Orientation ImageOrientation () const
 Get the image orientation. More...
 
void SetImageOrientation (const Orientation orient)
 Set the image orientation. More...
 
U8 NumberOfElements () const
 Get the number of elements. More...
 
void SetNumberOfElements (const U8 num)
 Set the number of elements. More...
 
U8 Metric (const int i) const
 Get the first byte of the channel designator - metric info. More...
 
void SetMetric (const int i, const U8 m)
 Set the first byte of the channel designator - metric info. More...
 
Descriptor ImageDescriptor (const int i) const
 Get the second byte of the channel designator. More...
 
void SetImageDescriptor (const int i, const Descriptor d)
 Set the second byte of the channel designator. More...
 
U8 BitDepth (const int i) const
 Get the bits per pixel. More...
 
void SetBitDepth (const int i, const U8 bpp)
 Set the bits per pixel. More...
 
U32 PixelsPerLine (const int i) const
 Get the pixels per line. More...
 
void SetPixelsPerLine (const int i, const U32 ppl)
 Set the pixels per line. More...
 
U32 LinesPerElement (const int i) const
 Get the lines per element. More...
 
void SetLinesPerElement (const int i, const U32 lpe)
 Set the lines per element. More...
 
R32 LowData (const int i) const
 Get the minimum data value. More...
 
void SetLowData (const int i, const R32 data)
 Set the minimum data value. More...
 
R32 LowQuantity (const int i) const
 Get the quantity of minimum data value. More...
 
void SetLowQuantity (const int i, const R32 quant)
 Set the quantity of minimum data value. More...
 
R32 HighData (const int i) const
 Get the maximum data value. More...
 
void SetHighData (const int i, const R32 data)
 Set the maximum data value. More...
 
R32 HighQuantity (const int i) const
 Get the quantity of maximum data value. More...
 
void SetHighQuantity (const int i, const R32 quant)
 Set the quantity of maximum data value. More...
 
void WhitePoint (R32 xy[2]) const
 Get the white point primary x, y pair. More...
 
void SetWhitePoint (const R32 xy[2])
 Set the white point primary x, y pair. More...
 
void RedPrimary (R32 xy[2]) const
 Get the red primary x, y pair. More...
 
void SetRedPrimary (const R32 xy[2])
 Set the red primary x, y pair. More...
 
void GreenPrimary (R32 xy[2]) const
 Get the green primary x, y pair. More...
 
void SetGreenPrimary (const R32 xy[2])
 Set the green primary x, y pair. More...
 
void BluePrimary (R32 xy[2]) const
 Get the blue primary x, y pair. More...
 
void SetBluePrimary (const R32 xy[2])
 Set the blue primary x, y pair. More...
 
void LabelText (char *ct) const
 Get the label text. More...
 
void SetLabelText (const char *ct)
 Set the label text. More...
 
Interleave ImageInterleave () const
 Get the data interleave mode. More...
 
void SetImageInterleave (const Interleave inter)
 Set the data intearleave mode. More...
 
Packing ImagePacking () const
 Get the data packing mode. More...
 
void SetImagePacking (const Packing pack)
 Set the data packing mode. More...
 
U8 DataSign () const
 Get the data sign (0 = unsigned, 1 = signed) More...
 
void SetDataSign (const U8 sign)
 Set the data sign (0 = unsigned, 1 = signed) More...
 
U8 ImageSense () const
 Get the image sense (0 = positive, 1 = negative) More...
 
void SetImageSense (const U8 sense)
 Set the image sense (0 = positive, 1 = negative) More...
 
U32 EndOfLinePadding () const
 Get the number of bytes padding the end of each line. More...
 
void SetEndOfLinePadding (const U32 eolp)
 Set the number of bytes padding the end of each line. More...
 
U32 EndOfImagePadding () const
 Get the number of bytes padding the end of the image element. More...
 
void SetEndOfImagePadding (const U32 eoip)
 Set the number of bytes padding the end of the image element. More...
 
Image Origination Methods
S32 XOffset () const
 Get the line offset (in pixels) from the first pixel in original image. More...
 
void SetXOffset (const S32 offset)
 Set the line offset (in pixels) from the first pixel in original image. More...
 
S32 YOffset () const
 Get the frame offset (in lines) from the first line in original image. More...
 
void SetYOffset (const S32 offset)
 Set the frame offset (in lines) from the first line in original image. More...
 
void SourceImageFileName (char *fn) const
 Get the source image file name that this image was extracted. More...
 
void SetSourceImageFileName (const char *fn)
 Set the source image file name that this image was extracted. More...
 
void SourceDate (char *td) const
 Get the source image time and date that this image was extracted. More...
 
void SetSourceDate (const char *td)
 Set the source image time and date that this image was extracted. More...
 
void SourceTime (char *td) const
 Get the source image time and date that this image was extracted. More...
 
void SetSourceTime (const char *td)
 Set the source image time and date that this image was extracted. More...
 
void SetSourceTimeDate (const long secs)
 Set the source image time and date that this image was extracted. More...
 
void InputDevice (char *dev) const
 Get the input device name. More...
 
void SetInputDevice (const char *dev)
 Set the input device name. More...
 
void InputDeviceModelNumber (char *sn) const
 Get the input device model number. More...
 
void SetInputDeviceModelNumber (const char *sn)
 Set the input device model number. More...
 
void InputDeviceSerialNumber (char *sn) const
 Get the input device serial number. More...
 
void SetInputDeviceSerialNumber (const char *sn)
 Set the input device serial number. More...
 
R32 XDevicePitch () const
 Get the horizontal pitch of the device. More...
 
void SetXDevicePitch (const R32 size)
 Set the horizontal pitch of the device. More...
 
R32 YDevicePitch () const
 Get the veritcal pitch of the device. More...
 
void SetYDevicePitch (const R32 size)
 Set the vertical pitch of the device. More...
 
R32 Gamma () const
 Get the gamma correction exponent. More...
 
void SetGamma (const R32 gamma)
 Set the gamma correction exponent. More...
 
Motion Picture Industry Specific Methods
void FilmEdgeCode (char *edge) const
 Get the film edge code information that is machine readable. More...
 
void SetFilmEdgeCode (const char *edge)
 Set the film edge code information that is machine readable. More...
 
void Format (char *fmt) const
 Get the format (e.g., Academy) More...
 
void SetFormat (const char *fmt)
 Set the format (e.g., Academy) More...
 
U32 FramePosition () const
 Get the frame position in sequence. More...
 
void SetFramePosition (const U32 pos)
 Set the frame position in sequence. More...
 
R32 FrameRate () const
 Get the frame rate (frames / second) More...
 
void SetFrameRate (const R32 rate)
 Set the frame rate (frames / second) More...
 
void FrameId (char *id) const
 Get the user-defined frame identification. More...
 
void SetFrameId (const char *id)
 Set the user-defined frame identification. More...
 
void SlateInfo (char *slate) const
 Get the production information from the camera slate. More...
 
void SetSlateInfo (const char *slate)
 Set the production information from the camera slate. More...
 

Static Public Member Functions

static bool ValidMagicCookie (const U32 magic)
 Check magic cookie. More...
 
static int DataSizeByteCount (const DataSize ds)
 

Public Attributes

File Information Members
U32 magicNumber
 Indicates start of DPX image file and is used to determine byte order. More...
 
U32 imageOffset
 Offset to image data (in bytes) More...
 
U32 genericSize
 Generic Header length (in bytes) More...
 
U32 industrySize
 Industry Header length (in bytes) More...
 
U32 userSize
 User defined header length (in bytes) More...
 
U32 fileSize
 Total file size (in bytes) More...
 
ASCII version [8]
 Version number of header format. More...
 
ASCII fileName [100]
 File name. More...
 
ASCII creationDate [12]
 Create date /see DateTimeFormat. More...
 
ASCII creationTime [12]
 Create time /see DateTimeFormat. More...
 
ASCII reserved1 [36]
 Reserved. More...
 
Image Information Members
U8 imageOrientation
 Image orientation. More...
 
U8 numberOfElements
 Number of elements (1-8) More...
 
U8 unused1 [2]
 Unused (word alignment) More...
 
ImageElement chan [MAX_ELEMENTS]
 Image element data structures. More...
 
R32 whitePoint [2]
 White point (x, y pair) More...
 
R32 redPrimary [2]
 Red primary chromaticity (x, y pair) More...
 
R32 greenPrimary [2]
 Green primary chromaticity (x, y pair) More...
 
R32 bluePrimary [2]
 Blue primary chromaticity (x, y pair) More...
 
ASCII labelText [200]
 Label text. More...
 
ASCII reserved2 [28]
 Reserved. More...
 
U8 interleave
 Data interleave. More...
 
U8 packing
 Packing. More...
 
U8 dataSign
 Data sign (0 = unsigned, 1 = signed) More...
 
U8 imageSense
 Image sense (0 = positive image, 1 = negative image) More...
 
U32 endOfLinePadding
 End-of-Line Padding. More...
 
U32 endOfImagePadding
 End-of-Image Padding. More...
 
ASCII reserved3 [20]
 
Image Origination Members
S32 xOffset
 X offset. More...
 
S32 yOffset
 Y offset. More...
 
ASCII sourceImageFileName [100]
 Source image file name. More...
 
ASCII sourceDate [12]
 Source date /see DateTimeFormat. More...
 
ASCII sourceTime [12]
 Source time /see DateTimeFormat. More...
 
ASCII inputDevice [64]
 Input device name. More...
 
ASCII inputDeviceModelNumber [32]
 Input device model number. More...
 
ASCII inputDeviceSerialNumber [32]
 Input device serial number. More...
 
R32 xDevicePitch
 X device pitch (samples/mm) More...
 
R32 yDevicePitch
 Y device pitch (samples/mm) More...
 
R32 gamma
 Gamma. More...
 
ASCII reserved4 [40]
 Reserved. More...
 
Motion Picture Industry Specific Members
U8 filmManufacturingIdCode
 Film edge code manufacturing ID code. More...
 
U8 filmType
 Film edge code type. More...
 
U8 perfsOffset
 Film edge code offset in perfs. More...
 
U8 unused1
 Unused (word alignment) More...
 
U32 prefix
 Film edge code prefix. More...
 
U32 count
 Film edge code count. More...
 
ASCII format [32]
 Format string, e.g. Academy. More...
 
U32 framePosition
 Frame position in sequence. More...
 
R32 frameRate
 Frame rate of original (frame / sec) More...
 
ASCII frameId [32]
 Frame identification, e.g. keyframe. More...
 
ASCII slateInfo [200]
 Slate information. More...
 
ASCII reserved1 [740]
 Reserved. More...
 

Protected Member Functions

bool DetermineByteSwap (const U32 magic) const
 
U32 TCFromString (const char *str) const
 

Detailed Description

Complete DPX Header.

Constructor & Destructor Documentation

cineon::Header::Header ( )

Member Function Documentation

U8 cineon::GenericHeader::BitDepth ( const int  i) const
inlineinherited

Get the bits per pixel.

Parameters
ielement index (0-7)
Returns
bit count
void cineon::GenericHeader::BluePrimary ( R32  xy[2]) const
inlineinherited

Get the blue primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
void cineon::GenericHeader::CalculateNumberOfElements ( )
inherited

Set member numberOfElements based on channel structure.

void cineon::Header::CalculateOffsets ( )

Calculate all of the offset members in the header.

bool cineon::Header::Check ( )
int cineon::GenericHeader::ComponentByteCount ( const int  element) const
inherited

Byte count of data element components.

Returns
byte count
cineon::DataSize cineon::GenericHeader::ComponentDataSize ( const int  element) const
inherited

DataSize required for individual image element components.

Returns
datasize of element
void cineon::GenericHeader::CreationDate ( char *  ct) const
inlineinherited

Get the creation time/date.

Parameters
ctbuffer to store creation time/date (24+1 chars)
void cineon::GenericHeader::CreationTime ( char *  ct) const
inlineinherited

Get the creation time/date.

Parameters
ctbuffer to store creation time/date (24+1 chars)
U8 cineon::GenericHeader::DataSign ( ) const
inlineinherited

Get the data sign (0 = unsigned, 1 = signed)

Returns
data sign
int cineon::GenericHeader::DataSizeByteCount ( const DataSize  ds)
staticinherited
bool cineon::Header::DetermineByteSwap ( const U32  magic) const
protected
U32 cineon::GenericHeader::EndOfImagePadding ( ) const
inlineinherited

Get the number of bytes padding the end of the image element.

Parameters
ielement index (0-7)
Returns
count
U32 cineon::GenericHeader::EndOfLinePadding ( ) const
inlineinherited

Get the number of bytes padding the end of each line.

Parameters
ielement index (0-7)
Returns
count
void cineon::GenericHeader::FileName ( char *  fn) const
inlineinherited

Get the file name.

Parameters
fnbuffer to store filename (100+1 chars)
U32 cineon::GenericHeader::FileSize ( ) const
inlineinherited

Get the size of the entire file.

Returns
file size in bytes
void cineon::IndustryHeader::FilmEdgeCode ( char *  edge) const
inherited

Get the film edge code information that is machine readable.

Parameters
edgebuffer to write film edge code information (16+1 chars)
void cineon::IndustryHeader::Format ( char *  fmt) const
inlineinherited

Get the format (e.g., Academy)

Parameters
fmtbuffer to write format information (32+1 chars)
void cineon::IndustryHeader::FrameId ( char *  id) const
inlineinherited

Get the user-defined frame identification.

Parameters
idbuffer to write frame identification (32+1 chars)
U32 cineon::IndustryHeader::FramePosition ( ) const
inlineinherited

Get the frame position in sequence.

Returns
position
R32 cineon::IndustryHeader::FrameRate ( ) const
inlineinherited

Get the frame rate (frames / second)

Returns
rate
R32 cineon::GenericHeader::Gamma ( ) const
inlineinherited

Get the gamma correction exponent.

Returns
gamma exponent
U32 cineon::GenericHeader::GenericSize ( ) const
inlineinherited

Get the size of the generic section within the header.

Returns
generic header size in bytes
void cineon::GenericHeader::GreenPrimary ( R32  xy[2]) const
inlineinherited

Get the green primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
cineon::U32 cineon::Header::Height ( ) const

Height of the image (maximum of all elements' heights) adjusted for orientation.

Returns
height
R32 cineon::GenericHeader::HighData ( const int  i) const
inlineinherited

Get the maximum data value.

Parameters
ielement index (0-7)
Returns
maximum value
R32 cineon::GenericHeader::HighQuantity ( const int  i) const
inlineinherited

Get the quantity of maximum data value.

Parameters
ielement index (0-7)
Returns
quantity
Descriptor cineon::GenericHeader::ImageDescriptor ( const int  i) const
inlineinherited

Get the second byte of the channel designator.

Parameters
ielement index (0-7)
Returns
channel descriptor
int cineon::GenericHeader::ImageElementComponentCount ( const int  element) const
inherited

Number of components for the element.

Returns
number of components
int cineon::GenericHeader::ImageElementCount ( ) const
inherited

Number of Active Elements in the Image.

Returns
element count
Interleave cineon::GenericHeader::ImageInterleave ( ) const
inlineinherited

Get the data interleave mode.

Returns
interleave method
U32 cineon::GenericHeader::ImageOffset ( ) const
inlineinherited

Get the offset in bytes to the start of the first image element.

Returns
offset
Orientation cineon::GenericHeader::ImageOrientation ( ) const
inlineinherited

Get the image orientation.

Returns
orientation enum
Packing cineon::GenericHeader::ImagePacking ( ) const
inlineinherited

Get the data packing mode.

Returns
packing method
U8 cineon::GenericHeader::ImageSense ( ) const
inlineinherited

Get the image sense (0 = positive, 1 = negative)

Returns
image sense
U32 cineon::GenericHeader::IndustrySize ( ) const
inlineinherited

Get the size of the industry section within the header.

Returns
industry header size in bytes
void cineon::GenericHeader::InputDevice ( char *  dev) const
inlineinherited

Get the input device name.

Parameters
devbuffer to write device (64+1)
void cineon::GenericHeader::InputDeviceModelNumber ( char *  sn) const
inlineinherited

Get the input device model number.

Parameters
snbuffer to write device model number (32+1)
void cineon::GenericHeader::InputDeviceSerialNumber ( char *  sn) const
inlineinherited

Get the input device serial number.

Parameters
snbuffer to write device serial number (32+1)
void cineon::GenericHeader::LabelText ( char *  ct) const
inlineinherited

Get the label text.

Parameters
ctbuffer to store label text (200 chars)
U32 cineon::GenericHeader::LinesPerElement ( const int  i) const
inlineinherited

Get the lines per element.

Parameters
ielement index (0-7)
Returns
lines count
R32 cineon::GenericHeader::LowData ( const int  i) const
inlineinherited

Get the minimum data value.

Parameters
ielement index (0-7)
Returns
minimum value
R32 cineon::GenericHeader::LowQuantity ( const int  i) const
inlineinherited

Get the quantity of minimum data value.

Parameters
ielement index (0-7)
Returns
quantity
U32 cineon::GenericHeader::MagicNumber ( ) const
inlineinherited

Get magic number, used for byte ordering identification.

Returns
magic number
U8 cineon::GenericHeader::Metric ( const int  i) const
inlineinherited

Get the first byte of the channel designator - metric info.

Parameters
ielement index (0-7)
Returns
0 = universal metric, 1-254 = vendor-specific
U8 cineon::GenericHeader::NumberOfElements ( ) const
inlineinherited

Get the number of elements.

Returns
element count
U32 cineon::GenericHeader::PixelsPerLine ( const int  i) const
inlineinherited

Get the pixels per line.

Parameters
ielement index (0-7)
Returns
pixel count
bool cineon::Header::Read ( InStream io)

Set the Input Stream object to read header from.

void cineon::GenericHeader::RedPrimary ( R32  xy[2]) const
inlineinherited

Get the red primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
bool cineon::Header::RequiresByteSwap ( ) const
inline

Does header require endian byte swap.

Returns
swap required true/false
void cineon::Header::Reset ( )

Set the header data to a known start state.

void cineon::GenericHeader::SetBitDepth ( const int  i,
const U8  bpp 
)
inlineinherited

Set the bits per pixel.

Parameters
ielement index (0-7)
bppbit count
void cineon::GenericHeader::SetBluePrimary ( const R32  xy[2])
inlineinherited

Set the blue primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetCreationDate ( const char *  ct)
inlineinherited

Set the creation time/date.

Parameters
ctbuffer with creation time/date
void cineon::GenericHeader::SetCreationTime ( const char *  ct)
inlineinherited

Set the creation time/date.

Parameters
ctbuffer with creation time/date
void cineon::GenericHeader::SetCreationTimeDate ( const long  secs)
inherited

Set the creation time/date.

Parameters
secsnumber of seconds since January 1, 1970 00:00
void cineon::GenericHeader::SetDataSign ( const U8  sign)
inlineinherited

Set the data sign (0 = unsigned, 1 = signed)

Parameters
signdata sign
void cineon::Header::SetDatumSwap ( const bool  swap)

Set whether reader/writer should swap component ordering.

Parameters
swapallow swapping true/false
void cineon::GenericHeader::SetEndOfImagePadding ( const U32  eoip)
inlineinherited

Set the number of bytes padding the end of the image element.

Parameters
ielement index (0-7)
eoipcount
void cineon::GenericHeader::SetEndOfLinePadding ( const U32  eolp)
inlineinherited

Set the number of bytes padding the end of each line.

Parameters
ielement index (0-7)
eolpcount
void cineon::GenericHeader::SetFileName ( const char *  fn)
inlineinherited

Set the file name.

Parameters
fnbuffer with filename
void cineon::GenericHeader::SetFileSize ( const U32  fs)
inlineinherited

Set the size of the entire file.

Parameters
fsfile size in bytes
void cineon::IndustryHeader::SetFilmEdgeCode ( const char *  edge)
inherited

Set the film edge code information that is machine readable.

Parameters
edgebuffer with film edge code information
void cineon::IndustryHeader::SetFormat ( const char *  fmt)
inlineinherited

Set the format (e.g., Academy)

Parameters
fmtbuffer with format information
void cineon::IndustryHeader::SetFrameId ( const char *  id)
inlineinherited

Set the user-defined frame identification.

Parameters
idbuffer with frame identification
void cineon::IndustryHeader::SetFramePosition ( const U32  pos)
inlineinherited

Set the frame position in sequence.

Parameters
posposition
void cineon::IndustryHeader::SetFrameRate ( const R32  rate)
inlineinherited

Set the frame rate (frames / second)

Parameters
raterate
void cineon::GenericHeader::SetGamma ( const R32  gamma)
inlineinherited

Set the gamma correction exponent.

Parameters
gammagamma exponent
void cineon::GenericHeader::SetGreenPrimary ( const R32  xy[2])
inlineinherited

Set the green primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetHighData ( const int  i,
const R32  data 
)
inlineinherited

Set the maximum data value.

Parameters
ielement index (0-7)
datamaximum value
void cineon::GenericHeader::SetHighQuantity ( const int  i,
const R32  quant 
)
inlineinherited

Set the quantity of maximum data value.

Parameters
ielement index (0-7)
quantquantity
void cineon::GenericHeader::SetImageDescriptor ( const int  i,
const Descriptor  d 
)
inlineinherited

Set the second byte of the channel designator.

Parameters
ielement index (0-7)
dchannel descriptor
void cineon::GenericHeader::SetImageInterleave ( const Interleave  inter)
inlineinherited

Set the data intearleave mode.

Parameters
interintearleave method
void cineon::GenericHeader::SetImageOffset ( const U32  offset)
inlineinherited

Set the offset in bytes to the start of the first image element.

Parameters
offsetoffset in bytes
void cineon::GenericHeader::SetImageOrientation ( const Orientation  orient)
inlineinherited

Set the image orientation.

Parameters
orientorientation
void cineon::GenericHeader::SetImagePacking ( const Packing  pack)
inlineinherited

Set the data packing mode.

Parameters
packpacking method
void cineon::GenericHeader::SetImageSense ( const U8  sense)
inlineinherited

Set the image sense (0 = positive, 1 = negative)

Parameters
senseimage sense
void cineon::GenericHeader::SetInputDevice ( const char *  dev)
inlineinherited

Set the input device name.

Parameters
devbuffer with device name
void cineon::GenericHeader::SetInputDeviceModelNumber ( const char *  sn)
inlineinherited

Set the input device model number.

Parameters
snbuffer with device model number
void cineon::GenericHeader::SetInputDeviceSerialNumber ( const char *  sn)
inlineinherited

Set the input device serial number.

Parameters
snbuffer with device serial number
void cineon::GenericHeader::SetLabelText ( const char *  ct)
inlineinherited

Set the label text.

Parameters
ctbuffer with label text
void cineon::GenericHeader::SetLinesPerElement ( const int  i,
const U32  lpe 
)
inlineinherited

Set the lines per element.

Parameters
ielement index (0-7)
lpelines count
void cineon::GenericHeader::SetLowData ( const int  i,
const R32  data 
)
inlineinherited

Set the minimum data value.

Parameters
ielement index (0-7)
dataminimum value
void cineon::GenericHeader::SetLowQuantity ( const int  i,
const R32  quant 
)
inlineinherited

Set the quantity of minimum data value.

Parameters
ielement index (0-7)
quantquantity
void cineon::GenericHeader::SetMetric ( const int  i,
const U8  m 
)
inlineinherited

Set the first byte of the channel designator - metric info.

Parameters
ielement index (0-7)
pplmetric
void cineon::GenericHeader::SetNumberOfElements ( const U8  num)
inlineinherited

Set the number of elements.

Parameters
numelement count
void cineon::GenericHeader::SetPixelsPerLine ( const int  i,
const U32  ppl 
)
inlineinherited

Set the pixels per line.

Parameters
ielement index (0-7)
pplpixel count
void cineon::GenericHeader::SetRedPrimary ( const R32  xy[2])
inlineinherited

Set the red primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::IndustryHeader::SetSlateInfo ( const char *  slate)
inlineinherited

Set the production information from the camera slate.

Parameters
slatebuffer with slate information
void cineon::GenericHeader::SetSourceDate ( const char *  td)
inlineinherited

Set the source image time and date that this image was extracted.

Parameters
tdbuffer with time/date string
void cineon::GenericHeader::SetSourceImageFileName ( const char *  fn)
inlineinherited

Set the source image file name that this image was extracted.

Parameters
fnbuffer with source file name
void cineon::GenericHeader::SetSourceTime ( const char *  td)
inlineinherited

Set the source image time and date that this image was extracted.

Parameters
tdbuffer with time/date string
void cineon::GenericHeader::SetSourceTimeDate ( const long  secs)
inherited

Set the source image time and date that this image was extracted.

Parameters
secsnumber of seconds since January 1, 1970 00:00
void cineon::GenericHeader::SetUserSize ( const U32  size)
inlineinherited

Set the size of the user data.

Parameters
sizeuser data size in bytes
void cineon::GenericHeader::SetVersion ( const char *  v)
inlineinherited

Set the version string.

Parameters
vversion string
void cineon::GenericHeader::SetWhitePoint ( const R32  xy[2])
inlineinherited

Set the white point primary x, y pair.

Parameters
xythe x, y pair (2 32-bit floats)
void cineon::GenericHeader::SetXDevicePitch ( const R32  size)
inlineinherited

Set the horizontal pitch of the device.

Parameters
sizepitch in samples/mm
void cineon::GenericHeader::SetXOffset ( const S32  offset)
inlineinherited

Set the line offset (in pixels) from the first pixel in original image.

Parameters
offsetoffset count
void cineon::GenericHeader::SetYDevicePitch ( const R32  size)
inlineinherited

Set the vertical pitch of the device.

Parameters
sizepitch in samples/mm
void cineon::GenericHeader::SetYOffset ( const S32  offset)
inlineinherited

Set the frame offset (in lines) from the first line in original image.

Parameters
offsetoffset count
const U32 cineon::Header::Size ( ) const
inline

Returns the size of the header.

Returns
2048 as defined by the standard
void cineon::IndustryHeader::SlateInfo ( char *  slate) const
inlineinherited

Get the production information from the camera slate.

Parameters
slatebuffer to write slate information (200+1 chars)
void cineon::GenericHeader::SourceDate ( char *  td) const
inlineinherited

Get the source image time and date that this image was extracted.

Parameters
tdbuffer to write time/date string (24+1)
void cineon::GenericHeader::SourceImageFileName ( char *  fn) const
inlineinherited

Get the source image file name that this image was extracted.

Parameters
fnbuffer to write source file name (100+1)
void cineon::GenericHeader::SourceTime ( char *  td) const
inlineinherited

Get the source image time and date that this image was extracted.

Parameters
tdbuffer to write time/date string (24+1)
U32 cineon::IndustryHeader::TCFromString ( const char *  str) const
protectedinherited
U32 cineon::GenericHeader::UserSize ( ) const
inlineinherited

Get the size of the user data.

Returns
user data size in bytes
bool cineon::Header::Validate ( )

Validate the header.

bool cineon::Header::ValidMagicCookie ( const U32  magic)
static

Check magic cookie.

Returns
valid true/false
void cineon::GenericHeader::Version ( char *  v) const
inlineinherited

Get current version string of header.

Parameters
vbuffer to place string, needs to be at least 8+1 bytes long
void cineon::GenericHeader::WhitePoint ( R32  xy[2]) const
inlineinherited

Get the white point primary x, y pair.

Parameters
xybuffer to store the x, y pair (2 32-bit floats)
cineon::U32 cineon::Header::Width ( ) const

Width of the image (maximum of all elements' widths) adjusted for orientation.

Parameters
elementimage element
Returns
width
bool cineon::Header::Write ( OutStream io)

Set the Output Stream object to write header to.

bool cineon::Header::WriteOffsetData ( OutStream io)
R32 cineon::GenericHeader::XDevicePitch ( ) const
inlineinherited

Get the horizontal pitch of the device.

Returns
pitch in samples/mm
S32 cineon::GenericHeader::XOffset ( ) const
inlineinherited

Get the line offset (in pixels) from the first pixel in original image.

Returns
offset count
R32 cineon::GenericHeader::YDevicePitch ( ) const
inlineinherited

Get the veritcal pitch of the device.

Returns
pitch in samples/mm
S32 cineon::GenericHeader::YOffset ( ) const
inlineinherited

Get the frame offset (in lines) from the first line in original image.

Returns
offset count

Member Data Documentation

R32 cineon::GenericHeader::bluePrimary[2]
inherited

Blue primary chromaticity (x, y pair)

ImageElement cineon::GenericHeader::chan[MAX_ELEMENTS]
inherited

Image element data structures.

U32 cineon::IndustryHeader::count
inherited

Film edge code count.

ASCII cineon::GenericHeader::creationDate[12]
inherited

Create date /see DateTimeFormat.

ASCII cineon::GenericHeader::creationTime[12]
inherited

Create time /see DateTimeFormat.

U8 cineon::GenericHeader::dataSign
inherited

Data sign (0 = unsigned, 1 = signed)

U32 cineon::GenericHeader::endOfImagePadding
inherited

End-of-Image Padding.

U32 cineon::GenericHeader::endOfLinePadding
inherited

End-of-Line Padding.

ASCII cineon::GenericHeader::fileName[100]
inherited

File name.

U32 cineon::GenericHeader::fileSize
inherited

Total file size (in bytes)

U8 cineon::IndustryHeader::filmManufacturingIdCode
inherited

Film edge code manufacturing ID code.

U8 cineon::IndustryHeader::filmType
inherited

Film edge code type.

ASCII cineon::IndustryHeader::format[32]
inherited

Format string, e.g. Academy.

ASCII cineon::IndustryHeader::frameId[32]
inherited

Frame identification, e.g. keyframe.

U32 cineon::IndustryHeader::framePosition
inherited

Frame position in sequence.

R32 cineon::IndustryHeader::frameRate
inherited

Frame rate of original (frame / sec)

R32 cineon::GenericHeader::gamma
inherited

Gamma.

U32 cineon::GenericHeader::genericSize
inherited

Generic Header length (in bytes)

R32 cineon::GenericHeader::greenPrimary[2]
inherited

Green primary chromaticity (x, y pair)

U32 cineon::GenericHeader::imageOffset
inherited

Offset to image data (in bytes)

U8 cineon::GenericHeader::imageOrientation
inherited

Image orientation.

See also
Orientation
U8 cineon::GenericHeader::imageSense
inherited

Image sense (0 = positive image, 1 = negative image)

U32 cineon::GenericHeader::industrySize
inherited

Industry Header length (in bytes)

ASCII cineon::GenericHeader::inputDevice[64]
inherited

Input device name.

ASCII cineon::GenericHeader::inputDeviceModelNumber[32]
inherited

Input device model number.

ASCII cineon::GenericHeader::inputDeviceSerialNumber[32]
inherited

Input device serial number.

U8 cineon::GenericHeader::interleave
inherited

Data interleave.

See also
Interleave
ASCII cineon::GenericHeader::labelText[200]
inherited

Label text.

U32 cineon::GenericHeader::magicNumber
inherited

Indicates start of DPX image file and is used to determine byte order.

U8 cineon::GenericHeader::numberOfElements
inherited

Number of elements (1-8)

U8 cineon::GenericHeader::packing
inherited

Packing.

See also
Packing
U8 cineon::IndustryHeader::perfsOffset
inherited

Film edge code offset in perfs.

U32 cineon::IndustryHeader::prefix
inherited

Film edge code prefix.

R32 cineon::GenericHeader::redPrimary[2]
inherited

Red primary chromaticity (x, y pair)

ASCII cineon::GenericHeader::reserved1[36]
inherited

Reserved.

ASCII cineon::IndustryHeader::reserved1[740]
inherited

Reserved.

ASCII cineon::GenericHeader::reserved2[28]
inherited

Reserved.

ASCII cineon::GenericHeader::reserved3[20]
inherited
ASCII cineon::GenericHeader::reserved4[40]
inherited

Reserved.

ASCII cineon::IndustryHeader::slateInfo[200]
inherited

Slate information.

ASCII cineon::GenericHeader::sourceDate[12]
inherited

Source date /see DateTimeFormat.

ASCII cineon::GenericHeader::sourceImageFileName[100]
inherited

Source image file name.

ASCII cineon::GenericHeader::sourceTime[12]
inherited

Source time /see DateTimeFormat.

U8 cineon::GenericHeader::unused1[2]
inherited

Unused (word alignment)

U8 cineon::IndustryHeader::unused1
inherited

Unused (word alignment)

U32 cineon::GenericHeader::userSize
inherited

User defined header length (in bytes)

ASCII cineon::GenericHeader::version[8]
inherited

Version number of header format.

R32 cineon::GenericHeader::whitePoint[2]
inherited

White point (x, y pair)

R32 cineon::GenericHeader::xDevicePitch
inherited

X device pitch (samples/mm)

S32 cineon::GenericHeader::xOffset
inherited

X offset.

R32 cineon::GenericHeader::yDevicePitch
inherited

Y device pitch (samples/mm)

S32 cineon::GenericHeader::yOffset
inherited

Y offset.


The documentation for this struct was generated from the following files: