PUBLIC

DPPlayControlBodyC::DPPlayControlBodyC(void) DPPlayControlBodyC::DPPlayControlBodyC(const DPSeekCtrlC &,BooleanT,UIntT,UIntT) DPPlayControlBodyC::~DPPlayControlBodyC(void) DPPlayControlBodyC::Speed(IntT) DPPlayControlBodyC::Tell(void) const DPPlayControlBodyC::LastFrame(void) const DPPlayControlBodyC::Size(void) const DPPlayControlBodyC::Seek(UIntT) DPPlayControlBodyC::Pause(void) DPPlayControlBodyC::Continue(void) DPPlayControlBodyC::Jog(IntT) DPPlayControlBodyC::FixedStart(void) const DPPlayControlBodyC::FixedEnd(void) const DPPlayControlBodyC::ToBeginning(void) DPPlayControlBodyC::FastFwd(void) DPPlayControlBodyC::PlayFwd(void) DPPlayControlBodyC::JogFwd(void) DPPlayControlBodyC::Stop(void) DPPlayControlBodyC::JogBkw(void) DPPlayControlBodyC::PlayBkw(void) DPPlayControlBodyC::FastBkw(void) DPPlayControlBodyC::ToEnd(void) DPPlayControlBodyC::SeekTo(UIntT) DPPlayControlBodyC::PlaySubSequence(int,UIntT,UIntT) DPPlayControlBodyC::SubSeqStart(void) DPPlayControlBodyC::SubSeqEnd(void) DPPlayControlBodyC::SubSeqMode(void) DPPlayControlBodyC::Open(const DPSeekCtrlC &) DPPlayControlBodyC::CheckUpdate(void) DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const BodyRefCounterC::SetUndeletable(void) BodyRefCounterC::ReportInvalidObject(char *) const RefCounterBaseC::Label(void) const

DPPlayControlBodyC
Base play control body class.
include	"amma/DP/PlayControl.hh"
User Level:	Default
Library:	MTDataProc
Example:	exFileFormat.cc
Section:	Data Processing
In Scope:	std

Parent Classes:

public DPEntityBodyC

DPIPlayControlBodyC

PThread::MutexC access;

Access control.

IntT inc;

Increments -ve and +ve 0==Stopped. 1=Normal play..

BooleanT ok;

Are operations succeding?

BooleanT pause;

Actively pause stream ?

PThread::SemaphoreC sema;

Stream pause semaphore.

DPSeekCtrlC ctrl;

Seek control handle.

BooleanT passEOS;

Pass along End Of Stream.

UIntT start;

Inital frame no. (this is a valid frame. )

UIntT end;

final frame no. (this is a valid frame. )

IntT playMode;

0-Once through 1-Once through sub seq. 2-Repeat 3-back and forth.

IntT subStart;

Inital frame no of sub sequence. (this is a valid frame. )

IntT subEnd;

final frame no of sub sequence. (this is a valid frame. )

BooleanT doneRev;

Use in palindrome mode.

IntT at;

Cache of input stream position.

IntT lastFrame;

Last frame displayed.

DPPlayControlBodyC()

Default constructor.

DPPlayControlBodyC(const DPSeekCtrlC & nCntrl,BooleanT nPassEOS = TRUE,UIntT nstart = ((UIntT)-1),UIntT nend = ((UIntT)-1))

~DPPlayControlBodyC()

Destructor.

IntT Speed(IntT ninc)

Set increments.
1 == Normal play -1=Reverse play 2=Double speed forward etc..

UIntT Tell() const

Where are we in the stream ?
This gives the number of the NEXT frame that will be processed.

UIntT LastFrame() const

Get number of last frame read.

UIntT Size() const

How long is the stream ?
This is the number of frames in the sequence.

BooleanT Seek(UIntT pos)

Seek to an absolute position in stream

void Pause()

Pause playing.

void Continue()

Continue playing.

void Jog(IntT frames = 1)

Move 'frames' forward or backward.

UIntT FixedStart() const

Get start of sub sequence.

UIntT FixedEnd() const

Get start of sub sequence.

void ToBeginning()

Goto beginning of sequence. (for GUI)

void FastFwd()

Fast forward. (for GUI)

void PlayFwd()

Play forward. (for GUI)

void JogFwd()

Go forward 1 frame. (for GUI)

void Stop()

Stop (for GUI)

void JogBkw()

Go backward 1 frame. (for GUI)

void PlayBkw()

Play backward. (for GUI)

void FastBkw()

Play backward. (for GUI)

void ToEnd()

Goto end of sequence. (for GUI)

void SeekTo(UIntT loc)

Goto position in sequence. (for GUI)

void PlaySubSequence(int mode,UIntT startfrm,UIntT endfrm)

Play a sub-sequence.
0-Once through whole sequence. 1-Once through sub seq. 2-Repeat 3-back and forth.

IntT & SubSeqStart()

Set sub sequence start.

IntT & SubSeqEnd()

Set sub sequence start.

IntT & SubSeqMode()

Set sub sequence start.

BooleanT Open(const DPSeekCtrlC & nCntrl)

Open new video stream.
This assumes the input stream is locked by the calling function.

void CheckUpdate()

Check state of stream after get.
This assumes the input stream is locked by the calling function.

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT Save(ostream & out) const

Save to ostream.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

void SetUndeletable()

Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.

void ReportInvalidObject(char * Msg = 0) const

Tell user about validation failure.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.