TuttleOFX  1
Public Member Functions | Protected Member Functions
dpx::IndustryHeader Struct Reference

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

#include <DPXHeader.h>

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

Public Member Functions

 IndustryHeader ()
 Constructor.
void Reset ()
 Reset class to initial state.
Motion Picture Industry Specific Methods
void FilmEdgeCode (char *edge) const
 Get the film edge code information that is machine readable.
void SetFileEdgeCode (const char *edge)
 Set the film edge code information that is machine readable.
void Format (char *fmt) const
 Get the format (e.g., Academy)
void SetFormat (const char *fmt)
 Set the format (e.g., Academy)
U32 FramePosition () const
 Get the frame position in sequence.
void SetFramePosition (const U32 pos)
 Set the frame position in sequence.
U32 SequenceLength () const
 Get the total number of frames in sequence.
void SetSequenceLength (const U32 len)
 Set the total number of frames in sequence.
U32 HeldCount () const
 Get the how many sequential frames for which to hold current frame.
void SetHeldCount (const U32 count)
 Set the how many sequential frames for which to hold current frame.
R32 FrameRate () const
 Get the frame rate (frames / second)
void SetFrameRate (const R32 rate)
 Set the frame rate (frames / second)
R32 ShutterAngle () const
 Get the shutter angle of the motion picture camera.
void SetShutterAngle (const R32 angle)
 Set the shutter angle of the motion picture camera.
void FrameId (char *id) const
 Get the user-defined frame identification.
void SetFrameId (const char *id)
 Set the user-defined frame identification.
void SlateInfo (char *slate) const
 Get the production information from the camera slate.
void SetSlateInfo (const char *slate)
 Set the production information from the camera slate.
Television Industry Specific Methods
void TimeCode (char *str) const
 Get the time code.
void SetTimeCode (const char *str)
 Set the time code.
void UserBits (char *str) const
 Get the user bits.
void SetUserBits (const char *str)
 Set the user bits.
U8 Interlace () const
 Get the interlace (0 = noninterlace, 1 = 2:1 interlace)
void SetInterlace (const U8 lace)
 Set the interlace (0 = noninterlace, 1 = 2:1 interlace)
U8 FieldNumber () const
 Get the field number of the video decoded.
void SetFieldNumber (const U8 fn)
 Set the field number of the video decoded.
VideoSignal Signal () const
 Get the video sournce.
void SetSignal (const VideoSignal vs)
 Set the video sournce.
R32 HorizontalSampleRate () const
 Get the clock rate at which samples were aquired.
void SetHorizontalSampleRate (const R32 rate)
 Set the clock rate at which samples were aquired.
R32 VerticalSampleRate () const
 Get the rate at which scanning the whole image is repeated.
void SetVerticalSampleRate (const R32 rate)
 Set the rate at which scanning the whole image is repeated.
R32 TemporalFrameRate () const
 Get the applied gamma correction.
void SetTemporalFrameRate (const R32 rate)
 Set the applied gamma correction.
R32 TimeOffset () const
 Get the time offset from sync to first pixel.
void SetTimeOffset (const R32 offset)
 Set the time offset from sync to first pixel.
R32 Gamma () const
 Get the applied gamma correction.
void SetGamma (const R32 g)
 Set the applied gamma correction.
R32 BlackLevel () const
 Get the reference black level.
void SetBlackLevel (const R32 bl)
 Set the reference black level.
R32 BlackGain () const
 Get the gain applied to signals below the breakpoint.
void SetBlackGain (const R32 bg)
 Set the gain applied to signals below the breakpoint.
R32 BreakPoint () const
 Get the breakpoint which gamma is applied.
void SetBreakPoint (const R32 bp)
 Set the breakpoint which gamma is applied.
R32 WhiteLevel () const
 Get the reference white level.
void SetWhiteLevel (const R32 wl)
 Set the reference white level.
R32 IntegrationTimes () const
 Get the temporal sampling rate of television cameras.
void SetIntegrationTimes (const R32 times)
 Set the temporal sampling rate of television cameras.

Data Fields

Motion Picture Industry Specific Members
ASCII filmManufacturingIdCode [2]
 Film edge code manufacturing ID code.
ASCII filmType [2]
 Film edge code type.
ASCII perfsOffset [2]
 Film edge code offset in perfs.
ASCII prefix [6]
 Film edge code prefix.
ASCII count [4]
 Film edge code count.
ASCII format [32]
 Format string, e.g. Academy.
U32 framePosition
 Frame position in sequence.
U32 sequenceLength
 Sequence length.
U32 heldCount
 Held count (1 = default)
R32 frameRate
 Frame rate of original (frame / sec)
R32 shutterAngle
 Shutter angle of camera (degrees)
ASCII frameId [32]
 Frame identification, e.g. keyframe.
ASCII slateInfo [100]
 Slate information.
ASCII reserved4 [56]
 Reserved.
Television Industry Specific Members
U32 timeCode
 Time code.
U32 userBits
 User bits.
U8 interlace
 Interlace (0 = noninterlace, 1 = 2:1 interlace)
U8 fieldNumber
 Field number.
U8 videoSignal
 Video signal.
U8 zero
 Structure alignment padding.
R32 horizontalSampleRate
 Horizontal sample rate (in Hz)
R32 verticalSampleRate
 Vertical sample rate (in Hz)
R32 temporalFrameRate
 Temporal sample rate (in Hz)
R32 timeOffset
 Time offset from sync to first pixel (in ms)
R32 gamma
 Gamma.
R32 blackLevel
 Black level.
R32 blackGain
 Black gain.
R32 breakPoint
 Break point.
R32 whiteLevel
 White level.
R32 integrationTimes
 Integration time (in sec)
ASCII reserved5 [76]
 Reserved.

Protected Member Functions

U32 TCFromString (const char *str) const

Detailed Description

Motion Picture and Television Industry Specific Information.

Definition at line 1031 of file DPXHeader.h.

Constructor & Destructor Documentation

dpx::IndustryHeader::IndustryHeader ( )

Constructor.

Definition at line 131 of file DPXHeader.cpp.

Member Function Documentation

R32 dpx::IndustryHeader::BlackGain ( ) const [inline]

Get the gain applied to signals below the breakpoint.

Returns:
value

Definition at line 2240 of file DPXHeader.h.

References blackGain.

R32 dpx::IndustryHeader::BlackLevel ( ) const [inline]

Get the reference black level.

Returns:
value

Definition at line 2230 of file DPXHeader.h.

References blackLevel.

R32 dpx::IndustryHeader::BreakPoint ( ) const [inline]

Get the breakpoint which gamma is applied.

Returns:
value

Definition at line 2250 of file DPXHeader.h.

References breakPoint.

U8 dpx::IndustryHeader::FieldNumber ( ) const [inline]

Get the field number of the video decoded.

Returns:
field number

Definition at line 2160 of file DPXHeader.h.

References fieldNumber.

void dpx::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)

Definition at line 640 of file DPXHeader.cpp.

void dpx::IndustryHeader::Format ( char *  fmt) const [inline]

Get the format (e.g., Academy)

Parameters:
fmtbuffer to write format information (32+1 chars)

Definition at line 2066 of file DPXHeader.h.

References format.

void dpx::IndustryHeader::FrameId ( char *  id) const [inline]

Get the user-defined frame identification.

Parameters:
idbuffer to write frame identification (32+1 chars)

Definition at line 2127 of file DPXHeader.h.

References frameId.

U32 dpx::IndustryHeader::FramePosition ( ) const [inline]

Get the frame position in sequence.

Returns:
position

Definition at line 2077 of file DPXHeader.h.

References framePosition.

R32 dpx::IndustryHeader::FrameRate ( ) const [inline]

Get the frame rate (frames / second)

Returns:
rate

Definition at line 2107 of file DPXHeader.h.

References frameRate.

R32 dpx::IndustryHeader::Gamma ( ) const [inline]

Get the applied gamma correction.

Returns:
gamma

Definition at line 2220 of file DPXHeader.h.

References gamma.

U32 dpx::IndustryHeader::HeldCount ( ) const [inline]

Get the how many sequential frames for which to hold current frame.

Returns:
count

Definition at line 2097 of file DPXHeader.h.

References heldCount.

R32 dpx::IndustryHeader::HorizontalSampleRate ( ) const [inline]

Get the clock rate at which samples were aquired.

Returns:
rate

Definition at line 2180 of file DPXHeader.h.

References horizontalSampleRate.

R32 dpx::IndustryHeader::IntegrationTimes ( ) const [inline]

Get the temporal sampling rate of television cameras.

Returns:
rate

Definition at line 2270 of file DPXHeader.h.

References integrationTimes.

U8 dpx::IndustryHeader::Interlace ( ) const [inline]

Get the interlace (0 = noninterlace, 1 = 2:1 interlace)

Returns:
interlace value

Definition at line 2150 of file DPXHeader.h.

References interlace.

void dpx::IndustryHeader::Reset ( )

Reset class to initial state.

Reimplemented in dpx::Header.

Definition at line 137 of file DPXHeader.cpp.

References EmptyString(), and dpx::kUndefined.

Referenced by dpx::Header::Reset().

Here is the call graph for this function:

U32 dpx::IndustryHeader::SequenceLength ( ) const [inline]

Get the total number of frames in sequence.

Returns:
length

Definition at line 2087 of file DPXHeader.h.

References sequenceLength.

void dpx::IndustryHeader::SetBlackGain ( const R32  bg) [inline]

Set the gain applied to signals below the breakpoint.

Parameters:
bgvalue

Definition at line 2245 of file DPXHeader.h.

References blackGain.

void dpx::IndustryHeader::SetBlackLevel ( const R32  bl) [inline]

Set the reference black level.

Parameters:
blvalue

Definition at line 2235 of file DPXHeader.h.

References blackLevel.

void dpx::IndustryHeader::SetBreakPoint ( const R32  bp) [inline]

Set the breakpoint which gamma is applied.

Parameters:
bpvalue

Definition at line 2255 of file DPXHeader.h.

References breakPoint.

void dpx::IndustryHeader::SetFieldNumber ( const U8  fn) [inline]

Set the field number of the video decoded.

Parameters:
fnfield number

Definition at line 2165 of file DPXHeader.h.

References fieldNumber.

void dpx::IndustryHeader::SetFileEdgeCode ( const char *  edge)

Set the film edge code information that is machine readable.

Parameters:
edgebuffer with film edge code information

Definition at line 662 of file DPXHeader.cpp.

void dpx::IndustryHeader::SetFormat ( const char *  fmt) [inline]

Set the format (e.g., Academy)

Parameters:
fmtbuffer with format information

Definition at line 2072 of file DPXHeader.h.

References format.

void dpx::IndustryHeader::SetFrameId ( const char *  id) [inline]

Set the user-defined frame identification.

Parameters:
idbuffer with frame identification

Definition at line 2133 of file DPXHeader.h.

References frameId.

void dpx::IndustryHeader::SetFramePosition ( const U32  pos) [inline]

Set the frame position in sequence.

Parameters:
posposition

Definition at line 2082 of file DPXHeader.h.

References framePosition.

void dpx::IndustryHeader::SetFrameRate ( const R32  rate) [inline]

Set the frame rate (frames / second)

Parameters:
raterate

Definition at line 2112 of file DPXHeader.h.

References frameRate.

void dpx::IndustryHeader::SetGamma ( const R32  g) [inline]

Set the applied gamma correction.

Parameters:
ggamma

Definition at line 2225 of file DPXHeader.h.

References gamma.

void dpx::IndustryHeader::SetHeldCount ( const U32  count) [inline]

Set the how many sequential frames for which to hold current frame.

Parameters:
countcount

Definition at line 2102 of file DPXHeader.h.

References count, and heldCount.

void dpx::IndustryHeader::SetHorizontalSampleRate ( const R32  rate) [inline]

Set the clock rate at which samples were aquired.

Parameters:
raterate

Definition at line 2185 of file DPXHeader.h.

References horizontalSampleRate.

void dpx::IndustryHeader::SetIntegrationTimes ( const R32  times) [inline]

Set the temporal sampling rate of television cameras.

Parameters:
timesrate

Definition at line 2275 of file DPXHeader.h.

References integrationTimes.

void dpx::IndustryHeader::SetInterlace ( const U8  lace) [inline]

Set the interlace (0 = noninterlace, 1 = 2:1 interlace)

Parameters:
laceinterlace value

Definition at line 2155 of file DPXHeader.h.

References interlace.

void dpx::IndustryHeader::SetSequenceLength ( const U32  len) [inline]

Set the total number of frames in sequence.

Parameters:
lenlength

Definition at line 2092 of file DPXHeader.h.

References sequenceLength.

void dpx::IndustryHeader::SetShutterAngle ( const R32  angle) [inline]

Set the shutter angle of the motion picture camera.

Parameters:
angledegress of the temporal sampling aperture

Definition at line 2122 of file DPXHeader.h.

References shutterAngle.

void dpx::IndustryHeader::SetSignal ( const VideoSignal  vs) [inline]

Set the video sournce.

Parameters:
vssignal

Definition at line 2175 of file DPXHeader.h.

References videoSignal.

void dpx::IndustryHeader::SetSlateInfo ( const char *  slate) [inline]

Set the production information from the camera slate.

Parameters:
slatebuffer with slate information

Definition at line 2144 of file DPXHeader.h.

References slateInfo.

void dpx::IndustryHeader::SetTemporalFrameRate ( const R32  rate) [inline]

Set the applied gamma correction.

Parameters:
rategamma

Definition at line 2205 of file DPXHeader.h.

References temporalFrameRate.

void dpx::IndustryHeader::SetTimeCode ( const char *  str)

Set the time code.

Parameters:
strbuffer with time code

Definition at line 737 of file DPXHeader.cpp.

void dpx::IndustryHeader::SetTimeOffset ( const R32  offset) [inline]

Set the time offset from sync to first pixel.

Parameters:
offsettime in microseconds

Definition at line 2215 of file DPXHeader.h.

References timeOffset.

void dpx::IndustryHeader::SetUserBits ( const char *  str)

Set the user bits.

Parameters:
strbuffer with user bits

Definition at line 745 of file DPXHeader.cpp.

void dpx::IndustryHeader::SetVerticalSampleRate ( const R32  rate) [inline]

Set the rate at which scanning the whole image is repeated.

Parameters:
raterate

Definition at line 2195 of file DPXHeader.h.

References verticalSampleRate.

void dpx::IndustryHeader::SetWhiteLevel ( const R32  wl) [inline]

Set the reference white level.

Parameters:
wlvalue

Definition at line 2265 of file DPXHeader.h.

References whiteLevel.

R32 dpx::IndustryHeader::ShutterAngle ( ) const [inline]

Get the shutter angle of the motion picture camera.

Returns:
degress of the temporal sampling aperture

Definition at line 2117 of file DPXHeader.h.

References shutterAngle.

VideoSignal dpx::IndustryHeader::Signal ( ) const [inline]

Get the video sournce.

Returns:
signal

Definition at line 2170 of file DPXHeader.h.

References videoSignal.

void dpx::IndustryHeader::SlateInfo ( char *  slate) const [inline]

Get the production information from the camera slate.

Parameters:
slatebuffer to write slate information (100+1 chars)

Definition at line 2138 of file DPXHeader.h.

References slateInfo.

dpx::U32 dpx::IndustryHeader::TCFromString ( const char *  str) const [protected]

Definition at line 705 of file DPXHeader.cpp.

R32 dpx::IndustryHeader::TemporalFrameRate ( ) const [inline]

Get the applied gamma correction.

Returns:
rate

Definition at line 2200 of file DPXHeader.h.

References temporalFrameRate.

void dpx::IndustryHeader::TimeCode ( char *  str) const

Get the time code.

Parameters:
strbuffer to write time code (12 chars)

Definition at line 683 of file DPXHeader.cpp.

References Hex().

Here is the call graph for this function:

R32 dpx::IndustryHeader::TimeOffset ( ) const [inline]

Get the time offset from sync to first pixel.

Returns:
time in microseconds

Definition at line 2210 of file DPXHeader.h.

References timeOffset.

void dpx::IndustryHeader::UserBits ( char *  str) const

Get the user bits.

Parameters:
strbuffer to write user bits (12 chars)

Definition at line 694 of file DPXHeader.cpp.

References Hex().

Here is the call graph for this function:

R32 dpx::IndustryHeader::VerticalSampleRate ( ) const [inline]

Get the rate at which scanning the whole image is repeated.

Returns:
rate

Definition at line 2190 of file DPXHeader.h.

References verticalSampleRate.

R32 dpx::IndustryHeader::WhiteLevel ( ) const [inline]

Get the reference white level.

Returns:
value

Definition at line 2260 of file DPXHeader.h.

References whiteLevel.

Field Documentation

R32 dpx::IndustryHeader::blackGain

Black gain.

Definition at line 1072 of file DPXHeader.h.

Referenced by BlackGain(), and SetBlackGain().

R32 dpx::IndustryHeader::blackLevel

Black level.

Definition at line 1071 of file DPXHeader.h.

Referenced by BlackLevel(), and SetBlackLevel().

R32 dpx::IndustryHeader::breakPoint

Break point.

Definition at line 1073 of file DPXHeader.h.

Referenced by BreakPoint(), and SetBreakPoint().

ASCII dpx::IndustryHeader::count[4]

Film edge code count.

Definition at line 1042 of file DPXHeader.h.

Referenced by SetHeldCount().

U8 dpx::IndustryHeader::fieldNumber

Field number.

Definition at line 1063 of file DPXHeader.h.

Referenced by FieldNumber(), and SetFieldNumber().

ASCII dpx::IndustryHeader::filmManufacturingIdCode[2]

Film edge code manufacturing ID code.

Definition at line 1038 of file DPXHeader.h.

ASCII dpx::IndustryHeader::filmType[2]

Film edge code type.

Definition at line 1039 of file DPXHeader.h.

ASCII dpx::IndustryHeader::format[32]

Format string, e.g. Academy.

Definition at line 1043 of file DPXHeader.h.

Referenced by Format(), and SetFormat().

ASCII dpx::IndustryHeader::frameId[32]

Frame identification, e.g. keyframe.

Definition at line 1049 of file DPXHeader.h.

Referenced by FrameId(), and SetFrameId().

U32 dpx::IndustryHeader::framePosition

Frame position in sequence.

Definition at line 1044 of file DPXHeader.h.

Referenced by FramePosition(), and SetFramePosition().

R32 dpx::IndustryHeader::frameRate

Frame rate of original (frame / sec)

Definition at line 1047 of file DPXHeader.h.

Referenced by FrameRate(), and SetFrameRate().

R32 dpx::IndustryHeader::gamma

Gamma.

Definition at line 1070 of file DPXHeader.h.

Referenced by Gamma(), and SetGamma().

U32 dpx::IndustryHeader::heldCount

Held count (1 = default)

Definition at line 1046 of file DPXHeader.h.

Referenced by HeldCount(), and SetHeldCount().

R32 dpx::IndustryHeader::horizontalSampleRate

Horizontal sample rate (in Hz)

Definition at line 1066 of file DPXHeader.h.

Referenced by HorizontalSampleRate(), and SetHorizontalSampleRate().

R32 dpx::IndustryHeader::integrationTimes

Integration time (in sec)

Definition at line 1075 of file DPXHeader.h.

Referenced by IntegrationTimes(), and SetIntegrationTimes().

U8 dpx::IndustryHeader::interlace

Interlace (0 = noninterlace, 1 = 2:1 interlace)

Definition at line 1062 of file DPXHeader.h.

Referenced by Interlace(), and SetInterlace().

ASCII dpx::IndustryHeader::perfsOffset[2]

Film edge code offset in perfs.

Definition at line 1040 of file DPXHeader.h.

ASCII dpx::IndustryHeader::prefix[6]

Film edge code prefix.

Definition at line 1041 of file DPXHeader.h.

ASCII dpx::IndustryHeader::reserved4[56]

Reserved.

Definition at line 1051 of file DPXHeader.h.

ASCII dpx::IndustryHeader::reserved5[76]

Reserved.

Definition at line 1076 of file DPXHeader.h.

U32 dpx::IndustryHeader::sequenceLength

Sequence length.

Definition at line 1045 of file DPXHeader.h.

Referenced by SequenceLength(), and SetSequenceLength().

R32 dpx::IndustryHeader::shutterAngle

Shutter angle of camera (degrees)

Definition at line 1048 of file DPXHeader.h.

Referenced by SetShutterAngle(), and ShutterAngle().

ASCII dpx::IndustryHeader::slateInfo[100]

Slate information.

Definition at line 1050 of file DPXHeader.h.

Referenced by SetSlateInfo(), and SlateInfo().

R32 dpx::IndustryHeader::temporalFrameRate

Temporal sample rate (in Hz)

Definition at line 1068 of file DPXHeader.h.

Referenced by SetTemporalFrameRate(), and TemporalFrameRate().

U32 dpx::IndustryHeader::timeCode

Time code.

Definition at line 1060 of file DPXHeader.h.

R32 dpx::IndustryHeader::timeOffset

Time offset from sync to first pixel (in ms)

Definition at line 1069 of file DPXHeader.h.

Referenced by SetTimeOffset(), and TimeOffset().

U32 dpx::IndustryHeader::userBits

User bits.

Definition at line 1061 of file DPXHeader.h.

R32 dpx::IndustryHeader::verticalSampleRate

Vertical sample rate (in Hz)

Definition at line 1067 of file DPXHeader.h.

Referenced by SetVerticalSampleRate(), and VerticalSampleRate().

U8 dpx::IndustryHeader::videoSignal

Video signal.

See also:
VideoSignal

Definition at line 1064 of file DPXHeader.h.

Referenced by SetSignal(), and Signal().

R32 dpx::IndustryHeader::whiteLevel

White level.

Definition at line 1074 of file DPXHeader.h.

Referenced by SetWhiteLevel(), and WhiteLevel().

U8 dpx::IndustryHeader::zero

Structure alignment padding.

Definition at line 1065 of file DPXHeader.h.

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