PTLib
Version 2.18.8
|
This class defines a video input device which is actually another video inpuit device. More...
#include <videoio.h>
Public Member Functions | |
PVideoInputDeviceIndirect (PVideoInputDevice *device=NULL, bool autoDelete=true) | |
~PVideoInputDeviceIndirect () | |
virtual void | SetActualDevice (PVideoInputDevice *actualDevice, bool autoDelete=true) |
virtual PVideoInputDevice * | GetActualDevice () const |
virtual Comparison | Compare (const PObject &obj) const |
Compare the two PVideoFrameInfo and return their relative rank. More... | |
virtual void | PrintOn (ostream &strm) const |
Output the contents of the object to the stream. More... | |
virtual PBoolean | SetFrameSize (unsigned width, unsigned height) |
Set the frame size to be used. More... | |
virtual PBoolean | SetFrameSar (unsigned width, unsigned height) |
Set the Storage Aspect Ratio size to be used. More... | |
virtual PBoolean | SetFrameRate (unsigned rate) |
Set the video frame rate to be used on the device. More... | |
virtual PBoolean | SetColourFormat (const PString &colourFormat) |
Set the colour format to be used. More... | |
virtual void | SetResizeMode (ResizeMode mode) |
Set the resize mode to be used. More... | |
virtual PINDEX | CalculateFrameBytes () const |
Get the number of bytes of an image, given a particular width, height and colour format. More... | |
virtual bool | Parse (const PString &str) |
Parse a descriptor string for the video format. More... | |
virtual PString | GetDeviceName () const |
Get the device name of the open device. More... | |
virtual PStringArray | GetDeviceNames () const |
Get a list of all of the drivers available. More... | |
virtual PBoolean | OpenFull (const OpenArgs &args, PBoolean startImmediate=true) |
Open the device given the device name. More... | |
virtual PBoolean | Open (const PString &deviceName, PBoolean startImmediate=true) |
Open the device given the device name. More... | |
virtual PBoolean | IsOpen () |
Determine if the device is currently open. More... | |
virtual PBoolean | Close () |
Close the device. More... | |
virtual PBoolean | Start () |
Start the video device I/O capture. More... | |
virtual PBoolean | Stop () |
Stop the video device I/O capture. More... | |
virtual PBoolean | SetVideoFormat (VideoFormat videoFormat) |
Set the video format to be used. More... | |
virtual int | GetNumChannels () |
Get the number of video channels available on the device. More... | |
virtual PStringArray | GetChannelNames () |
Get the names of video channels available on the device. More... | |
virtual PBoolean | SetChannel (int channelNumber) |
Set the video channel to be used on the device. More... | |
virtual int | GetChannel () const |
Get the video channel to be used on the device. More... | |
virtual PBoolean | SetVFlipState (PBoolean newVFlipState) |
Set the video conversion vertical flip state. More... | |
virtual PBoolean | GetFrameSizeLimits (unsigned &minWidth, unsigned &minHeight, unsigned &maxWidth, unsigned &maxHeight) |
Get the minimum & maximum size of a frame on the device. More... | |
virtual PBoolean | SetNearestFrameSize (unsigned width, unsigned height) |
Set the nearest available frame size to be used. More... | |
virtual bool | SetFrameInfoConverter (const PVideoFrameInfo &info) |
Set the frame info to be used, trying converters if available. More... | |
virtual PBoolean | SetColourFormatConverter (const PString &colourFormat) |
Set the colour format to be used, trying converters if available. More... | |
virtual PBoolean | SetFrameSizeConverter (unsigned width, unsigned height, ResizeMode resizeMode=eMaxResizeMode) |
Set the frame size to be used, trying converters if available. More... | |
virtual int | GetLastError () const |
Get the last error code. More... | |
virtual bool | GetAttributes (Attributes &attributes) |
Get video attributes. More... | |
virtual bool | SetAttributes (const Attributes &attributes) |
Set video attributes. More... | |
virtual PBoolean | SetVideoChannelFormat (int channelNumber, VideoFormat videoFormat) |
Set VideoFormat and VideoChannel in one ioctl. More... | |
virtual bool | GetDeviceCapabilities (Capabilities *capabilities) const |
Retrieve a list of Device Capabilities. More... | |
virtual PBoolean | IsCapturing () |
Determine if the video device I/O capture is in progress. More... | |
virtual bool | FlowControl (const void *flowData) |
Pass data to the inputdevice for flowControl determination. More... | |
virtual bool | SetCaptureMode (unsigned mode) |
Set the capture modes for implementations that support them. More... | |
virtual int | GetCaptureMode () const |
Returns the current capture mode. More... | |
virtual bool | SetControl (PVideoControlInfo::Types type, int value, ControlMode mode) |
![]() | |
~PVideoInputDevice () | |
Create a new video input device. More... | |
virtual PBoolean | CanCaptureVideo () const |
Is the device a camera, and obtain video. More... | |
bool | GetFrame (BYTE *buffer, PINDEX &bytesReturned, bool &keyFrame, bool wait=true) |
Grab a frame. More... | |
virtual PBoolean | GetFrame (PBYTEArray &frame) |
virtual PBoolean | GetFrame (PBYTEArray &frame, unsigned &width, unsigned &height) |
bool | GetFrameData (BYTE *buffer, PINDEX *bytesReturned, bool &keyFrame) |
For backward compatibility. More... | |
bool | GetFrameData (BYTE *buffer, PINDEX *bytesReturned=NULL) |
For backward compatibility. More... | |
bool | GetFrameDataNoDelay (BYTE *buffer, PINDEX *bytesReturned, bool &keyFrame) |
For backward compatibility. More... | |
bool | GetFrameDataNoDelay (BYTE *buffer, PINDEX *bytesReturned=NULL) |
For backward compatibility. More... | |
virtual const PVideoControlInfo & | GetControlInfo (PVideoControlInfo::Types type) const |
![]() | |
virtual | ~PVideoDevice () |
Delete structures created by PVideoDevice();. More... | |
P_DECLARE_STREAMABLE_ENUM (VideoFormat, PAL, NTSC, SECAM, Auto) | |
virtual VideoFormat | GetVideoFormat () const |
Get the video format being used. More... | |
virtual PBoolean | GetVFlipState () |
Get the video conversion vertical flip state. More... | |
virtual PBoolean | GetFrameSize (unsigned &width, unsigned &height) const |
Get the frame size being used. More... | |
virtual PString | GetColourFormat () const |
Get the colour format being used. More... | |
virtual PINDEX | GetMaxFrameBytes () |
Get the maximum frame size in bytes. More... | |
virtual void | SetPreferredColourFormat (const PString &colourFmt) |
Set preferred native colour format from video capture device. More... | |
virtual PString | GetPreferredColourFormat () |
Get preferred native colour format from video capture device. More... | |
![]() | |
P_DECLARE_ENUM_EX (ResizeMode, eMaxResizeMode, eScale, 0, eCropCentre, eCropTopLeft, eScaleKeepAspect) | |
PVideoFrameInfo () | |
Construct video frame information. More... | |
PVideoFrameInfo (unsigned frameWidth, unsigned frameHeight, const PString &colourFormat=PVideoFrameInfo::YUV420P(), unsigned frameRate=15, ResizeMode resizeMode=eScale) | |
virtual unsigned | GetFrameWidth () const |
Get the width of the frame being used. More... | |
virtual unsigned | GetFrameHeight () const |
Get the height of the frame being used. More... | |
virtual PBoolean | GetSarSize (unsigned &width, unsigned &height) const |
Get the Storage Aspect Ratio size being used. More... | |
virtual unsigned | GetSarWidth () const |
Get the width of the Storage Aspect Ratio being used. More... | |
virtual unsigned | GetSarHeight () const |
Get the height of the Storage Aspect Ratio being used. More... | |
virtual unsigned | GetFrameRate () const |
Get the video frame rate used on the device. More... | |
virtual ResizeMode | GetResizeMode () const |
Get the resize mode to be used. More... | |
![]() | |
__inline unsigned | GetTraceContextIdentifier () const |
Get PTRACE context identifier. More... | |
__inline void | SetTraceContextIdentifier (unsigned id) |
__inline void | SetTraceContextIdentifier (const PObject &obj) |
__inline void | SetTraceContextIdentifier (const PObject *obj) |
__inline void | CopyTraceContextIdentifier (PObject &obj) const |
__inline void | CopyTraceContextIdentifier (PObject *obj) const |
virtual | ~PObject () |
__inline const char * | GetClass () const |
__inline bool | IsClass (const char *name) const |
__inline const PObject * | PTraceObjectInstance () const |
virtual PObject * | Clone () const |
Create a copy of the class on the heap. More... | |
template<class CLS > | |
CLS * | CloneAs () const |
As for Clone() but converts to specified type. More... | |
virtual PINDEX | HashFunction () const |
This function yields a hash value required by the PDictionary class. More... | |
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
Determine the byte wise comparison of two objects. More... | |
bool | operator== (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator!= (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator< (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator> (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator<= (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator>= (const PObject &obj) const |
Compare the two objects. More... | |
virtual void | ReadFrom (istream &strm) |
Input the contents of the object from the stream. More... | |
Protected Member Functions | |
virtual bool | InternalGetFrameData (BYTE *buffer, PINDEX &bytesReturned, bool &keyFrame, bool wait) |
PDECLARE_MUTEX (m_actualDeviceMutex) | |
![]() | |
PVideoDevice () | |
Create a new video device (input or output). More... | |
PINDEX | GetMaxFrameBytesConverted (PINDEX rawFrameBytes) const |
PString | GetDeviceNameFromOpenArgs (const OpenArgs &args) const |
PString | ParseDeviceNameTokenString (const char *token, const char *defaultValue) |
int | ParseDeviceNameTokenInt (const char *token, int defaultValue) |
uint64_t | ParseDeviceNameTokenUnsigned (const char *token, uint64_t defaultValue) |
![]() | |
PObject () | |
Constructor for PObject, made protected so cannot ever create one on its own. More... | |
Protected Attributes | |
PVideoInputDevice * | m_actualDevice |
bool | m_autoDeleteActualDevice |
![]() | |
PVideoControlInfo | m_controlInfo [PVideoControlInfo::NumTypes] |
![]() | |
PCaselessString | m_deviceName |
int | m_lastError |
VideoFormat | m_videoFormat |
int | m_channelNumber |
PString | m_preferredColourFormat |
bool | m_nativeVerticalFlip |
PColourConverter * | m_converter |
PBYTEArray | m_frameStore |
![]() | |
unsigned | m_frameWidth |
unsigned | m_frameHeight |
unsigned | m_sarWidth |
unsigned | m_sarHeight |
unsigned | m_frameRate |
PString | m_colourFormat |
ResizeMode | m_resizeMode |
![]() | |
unsigned | m_traceContextIdentifier |
Additional Inherited Members | |
![]() | |
enum | ControlMode { AutomaticControl, AbsoluteControl, RelativeControl, ResetControl } |
![]() | |
enum | StandardSizes { SQCIFWidth = 128, SQCIFHeight = 96, QCIFWidth = 176, QCIFHeight = 144, CIFWidth = 352, CIFHeight = 288, CIF4Width = 704, CIF4Height = 576, CIF16Width = 1408, CIF16Height = 1152, HD480Width = 704, HD480Height = 480, i480Width = 704, i480Height = 480, HD720Width = 1280, HD720Height = 720, p720Width = 1280, p720Height = 720, HD1080Width = 1920, HD1080Height = 1080, i1080Width = 1920, i1080Height = 1080, HDTVWidth = 1920, HDTVHeight = 1080, MaxWidth = 1920, MaxHeight = 1200 } |
![]() | |
enum | Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 } |
Result of the comparison operation performed by the Compare() function. More... | |
![]() | |
static PStringArray | GetDriverNames (PPluginManager *pluginMgr=NULL) |
Get the list of available video input drivers (plug-ins) More... | |
static PStringArray | GetDriversDeviceNames (const PString &driverName, PPluginManager *pluginMgr=NULL) |
Get video input devices that correspond to the specified driver name. More... | |
static PVideoInputDevice * | CreateDevice (const PString &driverName, PPluginManager *pluginMgr=NULL) |
Create the video input device that corresponds to the specified driver name. More... | |
static PVideoInputDevice * | CreateDeviceByName (const PString &deviceName, const PString &driverName=PString::Empty(), PPluginManager *pluginMgr=NULL) |
static PVideoInputDevice * | CreateOpenedDevice (const PString &driverName, const PString &deviceName, bool startImmediate=true, PPluginManager *pluginMgr=NULL) |
Create an opened video input device that corresponds to the specified names. More... | |
static PVideoInputDevice * | CreateOpenedDevice (const PString &deviceName, bool startImmediate=true, PPluginManager *pluginMgr=NULL) |
static PVideoInputDevice * | CreateOpenedDevice (const OpenArgs &args, bool startImmediate=true) |
Create an opened video output device that corresponds to the specified arguments. More... | |
static bool | GetDeviceCapabilities (const PString &deviceName, Capabilities *capabilities, PPluginManager *pluginMgr=NULL) |
Retrieve a list of Device Capabilities for particular device. More... | |
static bool | GetDeviceCapabilities (const PString &deviceName, const PString &driverName, Capabilities *caps, PPluginManager *pluginMgr=NULL) |
Retrieve a list of Device Capabilities for a particular driver. More... | |
static PBoolean | GetInputDeviceCapabilities (const PString &, Capabilities *) |
![]() | |
static const PString & | YUV420P () |
static PINDEX | CalculateFrameBytes (unsigned width, unsigned height, const PString &colourFormat=PVideoFrameInfo::YUV420P()) |
static bool | ParseSize (const PString &str, unsigned &width, unsigned &height) |
Parse the standard size string names. More... | |
static PString | AsString (unsigned width, unsigned height) |
Get a width/height as a standard size string name. More... | |
static PStringArray | GetSizeNames () |
Get all "known" image size names. More... | |
![]() | |
static __inline void | CopyTraceContextIdentifier (PObject &to, const PObject &from) |
static __inline void | CopyTraceContextIdentifier (PObject &to, const PObject *from) |
static __inline void | CopyTraceContextIdentifier (PObject *to, const PObject &from) |
static __inline void | CopyTraceContextIdentifier (PObject *to, const PObject *from) |
static __inline const char * | Class () |
static __inline const PObject * | PTraceObjectInstance (const char *) |
static __inline const PObject * | PTraceObjectInstance (const PObject *obj) |
template<typename T > | |
static Comparison | Compare2 (T v1, T v2) |
Compare two types, returning Comparison type. More... | |
static Comparison | InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size) |
Internal function caled from CompareObjectMemoryDirect() More... | |
This class defines a video input device which is actually another video inpuit device.
|
inlineexplicit |
|
inline |
References SetActualDevice().
|
virtual |
Get the number of bytes of an image, given a particular width, height and colour format.
Reimplemented from PVideoFrameInfo.
|
virtual |
Close the device.
Reimplemented from PVideoInputDevice.
|
virtual |
Compare the two PVideoFrameInfo and return their relative rank.
This ranking is by the relative area of the frame resolution, and frame rate if resolution equal. The final check for equality is on the colourFormat. The SAR and resize mode take no part.
LessThan
, EqualTo
or GreaterThan
according to the relative rank of the objects. Reimplemented from PVideoFrameInfo.
|
virtual |
Pass data to the inputdevice for flowControl determination.
Reimplemented from PVideoInputDevice.
|
virtual |
|
virtual |
Get video attributes.
Reimplemented from PVideoDevice.
|
virtual |
Returns the current capture mode.
See SetCaptureMode() for more details. A return value of -1 indicates an error or the mode is not supported.
Reimplemented from PVideoInputDevice.
|
virtual |
Get the video channel to be used on the device.
Default behaviour returns the value of the channelNumber variable.
Reimplemented from PVideoDevice.
|
virtual |
Get the names of video channels available on the device.
Reimplemented from PVideoDevice.
|
virtual |
Retrieve a list of Device Capabilities.
Reimplemented from PVideoInputDevice.
|
virtual |
Get the device name of the open device.
Reimplemented from PVideoDevice.
|
virtual |
Get a list of all of the drivers available.
Implements PVideoDevice.
|
virtual |
Get the minimum & maximum size of a frame on the device.
Default behaviour returns the value 1 to UINT_MAX for both and returns false.
Reimplemented from PVideoDevice.
|
virtual |
|
virtual |
Get the number of video channels available on the device.
Default behaviour returns 1.
Reimplemented from PVideoDevice.
|
protectedvirtual |
Implements PVideoInputDevice.
|
virtual |
Determine if the video device I/O capture is in progress.
Implements PVideoInputDevice.
|
virtual |
Determine if the device is currently open.
Implements PVideoDevice.
|
virtual |
Open the device given the device name.
Implements PVideoInputDevice.
|
virtual |
Open the device given the device name.
Reimplemented from PVideoDevice.
|
virtual |
Parse a descriptor string for the video format.
This is of the form [fmt ':' ] size [ '@' rate][ '/' crop ]. The size component is as for the ParseSize() function.
The fmt string is the colour format such as "RGB32", "YUV420P" etc.
The rate field is a simple integer from 1 to 100.
The crop field is one of "scale", "resize" (synonym for "scale"), "centre", "center", "topleft" or "crop" (synonym for "topleft").
Note no spaces are allowed in the descriptor.
Reimplemented from PVideoFrameInfo.
|
protected |
|
virtual |
Output the contents of the object to the stream.
The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<<
function.
The default behaviour is to print the class name.
Reimplemented from PVideoDevice.
|
virtual |
Referenced by ~PVideoInputDeviceIndirect().
|
virtual |
Set video attributes.
Reimplemented from PVideoDevice.
|
virtual |
Set the capture modes for implementations that support them.
For example with Video For Windows, this is used to select picture (0) or video (1) modes.
In picture-mode the implementation requests a single frame from the connected camera device. The camera device then does nothing until the frame has been processed and the next is requested.
In video-mode the camera continuously sends new frames.
The default implementation does nothing but returns false.
Reimplemented from PVideoInputDevice.
|
virtual |
Set the video channel to be used on the device.
The channel number is an integer from 0 to GetNumChannels()-1. The special value of -1 will find the first working channel number.
Default behaviour sets the value of the channelNumber variable and then returns true.
Reimplemented from PVideoDevice.
Set the colour format to be used.
Default behaviour sets the value of the colourFormat variable and then returns true if not an empty string.
Reimplemented from PVideoFrameInfo.
|
virtual |
Set the colour format to be used, trying converters if available.
This function will set the colour format on the device to one that is compatible with a registered converter, and install that converter so that the correct format is used.
Reimplemented from PVideoDevice.
|
virtual |
Reimplemented from PVideoInputDevice.
|
virtual |
Set the frame info to be used, trying converters if available.
This function will simply call SetColourFormatConverter(), SetFrameSizeConverter() and SetFrameRate().
Reimplemented from PVideoDevice.
|
virtual |
Set the video frame rate to be used on the device.
Default behaviour sets the value of the frameRate variable and then returns true.
Reimplemented from PVideoFrameInfo.
|
virtual |
Set the Storage Aspect Ratio size to be used.
Default behaviour sets the sarWidth and sarHeight variables and returns true.
Reimplemented from PVideoFrameInfo.
|
virtual |
Set the frame size to be used.
Note that devices may not be able to produce the requested size, and this function will fail. See SetFrameSizeConverter().
Default behaviour sets the frameWidth and frameHeight variables and then sets the converter sizes.
Reimplemented from PVideoDevice.
|
virtual |
Set the frame size to be used, trying converters if available.
If the device does not support the size, a set of alternate resolutions are attempted. A converter is setup if possible.
Reimplemented from PVideoDevice.
|
virtual |
Set the nearest available frame size to be used.
Note that devices may not be able to produce the requested size, so this function picks the nearest available size.
Default behaviour simply calls SetFrameSize().
Reimplemented from PVideoInputDevice.
|
virtual |
Set the resize mode to be used.
Reimplemented from PVideoFrameInfo.
Set the video conversion vertical flip state.
Default action is to return false.
Reimplemented from PVideoDevice.
|
virtual |
Set VideoFormat and VideoChannel in one ioctl.
Reimplemented from PVideoDevice.
|
virtual |
Set the video format to be used.
Default behaviour sets the value of the videoFormat variable and then returns true.
Reimplemented from PVideoDevice.
|
virtual |
Start the video device I/O capture.
Implements PVideoDevice.
|
virtual |
Stop the video device I/O capture.
Implements PVideoDevice.
|
protected |
|
protected |