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

Motion Picture and Television Industry Specific Information. More...

#include <CineonHeader.h>

Inheritance diagram for cineon::IndustryHeader:
Inheritance graph
[legend]

Public Member Functions

 IndustryHeader ()
 Constructor. More...
 
void Reset ()
 Reset class to initial state. 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...
 

Public Attributes

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

U32 TCFromString (const char *str) const
 

Detailed Description

Motion Picture and Television Industry Specific Information.

Constructor & Destructor Documentation

cineon::IndustryHeader::IndustryHeader ( )

Constructor.

Member Function Documentation

void cineon::IndustryHeader::FilmEdgeCode ( char *  edge) const

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
inline

Get the format (e.g., Academy)

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

Get the user-defined frame identification.

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

Get the frame position in sequence.

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

Get the frame rate (frames / second)

Returns
rate
void cineon::IndustryHeader::Reset ( )

Reset class to initial state.

void cineon::IndustryHeader::SetFilmEdgeCode ( const char *  edge)

Set the film edge code information that is machine readable.

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

Set the format (e.g., Academy)

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

Set the user-defined frame identification.

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

Set the frame position in sequence.

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

Set the frame rate (frames / second)

Parameters
raterate
void cineon::IndustryHeader::SetSlateInfo ( const char *  slate)
inline

Set the production information from the camera slate.

Parameters
slatebuffer with slate information
void cineon::IndustryHeader::SlateInfo ( char *  slate) const
inline

Get the production information from the camera slate.

Parameters
slatebuffer to write slate information (200+1 chars)
U32 cineon::IndustryHeader::TCFromString ( const char *  str) const
protected

Member Data Documentation

U32 cineon::IndustryHeader::count

Film edge code count.

U8 cineon::IndustryHeader::filmManufacturingIdCode

Film edge code manufacturing ID code.

U8 cineon::IndustryHeader::filmType

Film edge code type.

ASCII cineon::IndustryHeader::format[32]

Format string, e.g. Academy.

ASCII cineon::IndustryHeader::frameId[32]

Frame identification, e.g. keyframe.

U32 cineon::IndustryHeader::framePosition

Frame position in sequence.

R32 cineon::IndustryHeader::frameRate

Frame rate of original (frame / sec)

U8 cineon::IndustryHeader::perfsOffset

Film edge code offset in perfs.

U32 cineon::IndustryHeader::prefix

Film edge code prefix.

ASCII cineon::IndustryHeader::reserved1[740]

Reserved.

ASCII cineon::IndustryHeader::slateInfo[200]

Slate information.

U8 cineon::IndustryHeader::unused1

Unused (word alignment)


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