PUBLIC

VidIntlBodyOutC::VidIntlBodyOutC(const DPOSPortC> &,ScanT) VidIntlBodyOutC::~VidIntlBodyOutC(void) VidIntlBodyOutC::FrameNo(void) const VidIntlBodyOutC::FieldNo(void) const VidIntlBodyOutC::FieldInFrame(void) const VidIntlBodyOutC::Put(const ImgFieldC &) VidIntlBodyOutC::Output(void) VidIntlBodyOutC::Output(void) const VidIntlBodyC::IsInterlaced(void) const VidIntlBodyC::FieldsPerFrame(void) const DPOPortBodyC::Put(const DataT &) DPOPortBodyC::PutArray(const SArray1dC &) DPOPortBodyC::OutputType(void) const DPOPortBodyC::Save(ostream &) const DPSeekCtrlBodyC::Seek(UIntT) DPSeekCtrlBodyC::DSeek(IntT) DPSeekCtrlBodyC::Tell(void) const DPSeekCtrlBodyC::Size(void) const DPSeekCtrlBodyC::Start(void) const DPOPortBaseBodyC::PutEOS(void) DPOPortBaseBodyC::IsPutReady(void) const DPOPortBaseBodyC::OutputType(void) const DPOPortBaseBodyC::Save(ostream &) const DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) const DPPortBodyC::IsAsync(void) const DPPortBodyC::Save(ostream &) const DPPortBodyC::ConnectedTo(void) const DPPortBodyC::GetAttr(const StringC &,StringC &) DPPortBodyC::SetAttr(const StringC &,const StringC &) BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) 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 RefCounterBaseC::Label(void) const

VidIntlBodyOutC<class PixTypeT>
Body class for interlaced video template output streams.
include	"amma/VidIntlIO.hh"
User Level:	Default
Library:	MvideoIntl
Example:	exVideo1.cc
Section:	Image.Video.Interlace
In Scope:	std

Parent Classes:

public DPOSPortBodyC<class DataT>
public VidIntlBodyC

VidIntlBodyOutC(const DPOSPortC<ImageC<PixTypeT>> & imstream,ScanT scan)

~VidIntlBodyOutC()

Destructor

IndexC FrameNo() const

No. of current frame even if interlaced

IndexC FieldNo() const

No. of current field (= FrameNo for progressive scan)

IndexC FieldInFrame() const

Indicates which field within current frame (= 0 or 1 for interlaced, = 0 for progressive). Numbered backwards for reversed interlace

BooleanT Put(const ImgFieldC<PixTypeT> & field)

Save next image. Returns false if can't.

DPOSPortC<ImageC<PixTypeT>> & Output()

Access output stream.

const DPOSPortC<ImageC<PixTypeT>> & Output() const

Access output stream.

BooleanT IsInterlaced() const

Is Stream interlaced ? (i.e. >1 field per frame)

UIntT FieldsPerFrame() const

BooleanT Put(const ImgFieldC<PixTypeT> &)

Put data.
This function MUST be provided by client class.

IntT PutArray(const SArray1dC<ImgFieldC<PixTypeT>> & data)

Put an array of data to stream.
returns number of elements processed. NB. This need NOT be overridden in client classes unless fast handling of arrays of data elements is required.

const type_info & OutputType() const

Input type.

BooleanT Save(ostream & out) const

Save to ostream.

BooleanT Seek(UIntT off)

Seek to location in stream.
Returns FALSE, if seek failed. (Maybe because its not implemented.) if an error occurered (Seek returned False) then stream position will not be changed.

BooleanT DSeek(IntT off)

Delta Seek, goto location relative to the current one.
The default behavour of this functions is : Do some error checking then: Seek((UIntT)((IntT) Tell() + off)); if an error occurered (DSeek returned False) then stream position will not be changed.

UIntT Tell() const

Find current location in stream.
Defined as the index of the next object to be written or read. May return ((UIntT) (-1)) if not implemented.

UIntT Size() const

Find the total size of the stream. (assuming it starts from 0)
May return ((UIntT) (-1)) if not implemented.

UIntT Start() const

Find the offset where the stream begins, normally zero.
Defaults to 0

void PutEOS()

Put End Of Stream marker.

BooleanT IsPutReady() const

Is port ready for data ?

const type_info & OutputType() const

Output type.

BooleanT Save(ostream & out) const

Save to ostream.

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT IsAsync() const

Does port work asynchronously ?

BooleanT Save(ostream & out) const

Save to ostream.

DPPortC ConnectedTo() const

Is this port connected to another ?
If not returns invalid handle.

BooleanT GetAttr(const StringC & attrName,StringC & attrValue)

Get a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

BooleanT SetAttr(const StringC & attrName,const StringC & attrValue)

Set a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

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.

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

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.

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.