User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
VideoYUVInC::VideoYUVInC(void)
VideoYUVInC::VideoYUVInC(const FilenameC &,const IntT,const StringC &,IntT,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::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
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::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
VideoYUVInC
 
Video input stream for YUVImageC
 
include "amma/VideoYUV.hh"
User Level:Default
Library:Mvideo
Example:exVideo1.cc
Section:Image.Video
In Scope:std

Parent Classes:

Methods:
VideoYUVInC()
Default constructor.

VideoYUVInC(const FilenameC & name,const IntT digits = 0,const StringC & suffix = "",IntT startAtFrame = 0,BooleanT verb = FALSE)
NOTE: This constructor is here for backward compatability only.
'suffix' is now ignored and should be put into 'name'

'digits' is now ignored, and found automaticly.

The filename can now be one of the following, where XXX is the frame number in a multifile sequence. (filename)XXX.(suffix) (filename).(suffix) - The numbers will be inserted in before .(suffix) or a string with '%d' put where digits should be inserted.

Constructs input stream from file name or prefix, with optional file index size and suffix (see main video page). The file index size argument specifies the (minimum) number of digits. It applies only to sequences stored in a separate file for each frame; otherwise it is ignored.


#include "amma/Video.hh"
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<ByteYUVValueC> & 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

#include "amma/DP/SPort.hh"
const DPISPortC<ImageC<PixelTypeT>> & operator=(const DPISPortC<ImageC<PixelTypeT>> & obj)
Assigment.

#include "amma/DP/Port.hh"
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.

#include "amma/DP/SPort.hh"
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

#include "amma/DP/Port.hh"
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.

#include "amma/DP/Entity.hh"
const DPEntityC & operator=(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

BooleanT Save(ostream & out) const

#include "amma/DP/Port.hh"
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.

#include "amma/RCHandleA.hh"
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:

#include "amma/DP/Entity.hh"
const DPEntityC & operator=(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

BooleanT Save(ostream & out) const

#include "amma/RCHandle.hh"
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.


Programmer:Bill Christmas, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001