PUBLIC

VideoInC::VideoInC(void) VideoInC::VideoInC(const FilenameC &,const StringC &,BooleanT) VideoInC::Rectangle(void) const VideoInC::IsOk(void) const VideoInC::Next(IntT) VideoInC::Data(void) VideoInC::ImageNo(void) const VideoInC::Seek(UIntT) VideoInC::Rewind(void) DPISPortC::operator=(const DPISPortC &) DPIPortC::Body(void) DPIPortC::Body(void) const DPIPortC::Get(void) DPIPortC::Get(DataT &) DPIPortC::GetArray(SArray1dC &) DPSeekCtrlC::Seek(UIntT) DPSeekCtrlC::DSeek(IntT) DPSeekCtrlC::Tell(void) const DPSeekCtrlC::Size(void) const DPSeekCtrlC::Start(void) const DPSeekCtrlC::Body(void) DPSeekCtrlC::Body(void) const DPIPortBaseC::Body(void) DPIPortBaseC::Body(void) const DPIPortBaseC::InputType(void) const DPIPortBaseC::IsGetReady(void) const DPIPortBaseC::IsGetEOS(void) const DPIPortBaseC::Discard(void) DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const DPPortC::Body(void) DPPortC::Body(void) const DPPortC::IsAsync(void) const DPPortC::ConnectedTo(void) const DPPortC::GetAttr(const StringC &,StringC &) DPPortC::SetAttr(const StringC &,const StringC &) RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) const DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const RCHandleC::IsValid(void) const RCHandleC::IsValidObject(void) const RCHandleC::operator=(const RCHandleC &) RCHandleC::operator==(const RCHandleC &) const RCHandleC::operator!=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsConst(void) const RCHandleC::IsNotConst(void) const RCHandleC::SetConst(void) const RCHandleC::Invalidate(void) RCHandleC::Body(void) RCHandleC::Body(void) const

VideoInC<class PixelTypeT>
Template i/p video stream class
include	"amma/Video.hh"
User Level:	Default
Library:	Mvideo
Example:	exVideo.cc
Section:	Image.Video
In Scope:	std

Comments:
Class is templated on pixel type, not image type

public DPISPortC<class DataT>

VideoByteInC
VideoYUVInC

ImageC buff;

VideoInC()

Default constructor.
Creates an invalid handle.

VideoInC(const FilenameC & fn,const StringC & fmt = "",BooleanT verbose = FALSE)

Constructor.

ImageRectangleC Rectangle() const

Get Size of working rectangle.

BooleanT IsOk() const

Is current image valid?

BooleanT Next(IntT but = 0)

Goto next but "but" image in stream. Return FALSE if none.

ImageC<PixelTypeT> & Data()

Access image at head of stream.

IndexC ImageNo() const

Current frame no.
Note, this will only return valid information directly after a Next() operation. Otherwise this function will return the frame no, of the image BEFORE the "Next()" to be read (assuming "but" == 0).

BooleanT Seek(UIntT off)

Seek to location in stream.

void Rewind()

Rewinds video stream to the beginning

const DPISPortC<ImageC<PixelTypeT>> & operator=(const DPISPortC<ImageC<PixelTypeT>> & obj)

Assigment.

DPIPortBodyC<ImageC<PixelTypeT>> & Body()

Access body.

const DPIPortBodyC<ImageC<PixelTypeT>> & Body() const

Access body.

ImageC<PixelTypeT> Get()

Get next piece of data.

BooleanT Get(ImageC<PixelTypeT> & buff)

Try and get next piece of data.
If none, return FALSE. else put data into buff.

IntT GetArray(SArray1dC<ImageC<PixelTypeT>> & data)

Get an array of data from stream.
returns the number of elements processed.

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

DPSeekCtrlBodyC & Body()

Access body class.

const DPSeekCtrlBodyC & Body() const

Access body class.

DPIPortBaseBodyC & Body()

Access body.

const DPIPortBaseBodyC & Body() const

Access body.

const type_info & InputType() const

Get type of input port.

BooleanT IsGetReady() const

Is valid data.

BooleanT IsGetEOS() const

Is valid data.

BooleanT Discard()

Discard the next input datum.
returns true on success.

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

DPPortBodyC & Body()

Access body.

const DPPortBodyC & Body() const

Access body.

BooleanT IsAsync() const

Does port work asynchronously ??

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.

RCAbstractC Abstract()

Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const

Is handle of given type ?

void CheckHandleType(const DT & dummy) const

Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const

Save to ostream.

RCHandleAC<DPEntityBodyC> Copy() const

Creat a deep copy of this object.
protected:

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

BooleanT IsValid() const

Check its a valid handle.

BooleanT IsValidObject() const

Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<DPEntityBodyC> & operator=(const RCHandleC<DPEntityBodyC> & oth)

Assignment.

BooleanT operator==(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

BooleanT operator!=(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

UIntT Hash() const

Hash function.x

BooleanT IsConst() const

Is object constant ?

BooleanT IsNotConst() const

Is object not constant ?

void SetConst(void) const

Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()

Turn this into an invalid handle.

DPEntityBodyC & Body()

Direct access to body.

const DPEntityBodyC & Body() const

Constant access to body.