Home Page Toolkit Overview Using GML   User Input Services     Finger Tracker     Calibrator     Frame Grabber     Service protocol Obtaining GML   Installing GML   Licence Developer Documentation   Tcl/Tk API     The GML Canvas     Image processing   Tcl Scripts Library     List of Classes     List of Files   C/C++ API     List of Classes     List of Files

gml_Grabber.h Go to the documentation of this file. /** * @file gml_Grabber.h * * Declares the interface for accessing video grabbers. * * Copyright (c) 1995-2003 CLIPS-IMAG * * See the file "gml_LicenseTerms.txt" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. * * July 17, 2003 (F.B.) * Switch from C++ to C, keep grabber interface to a minimum. * * Created on Januray 1995 (FB). */ #ifndef __GML_GRABBER__ #define __GML_GRABBER__ #include "gml/base/gml_Types.h" #include "gml/base/gml_Errors.h" #include "gml/image/gml_Bitmap.h" #include "gml/base/gml_Callback.h" #define GML_GRABBER_NAME_MAX 255 /** * gml_TGrabberName -- * * Stores a human-readable description of a grabber. */ typedef char gml_TGrabberName [GML_GRABBER_NAME_MAX+1]; /** * @name * gml_Grabber error codes * @{ */ extern gml_TError gml_gGrabberNoneAvailable; /**< there is no available grabber */ extern gml_TError gml_gGrabberNoSuchGrabber; /**< request for a grabber which does not exist */ extern gml_TError gml_gGrabberNoSuchOption; /**< this option is not handled by the grabber */ extern gml_TError gml_gGrabberReadOnlyOption; /**< this option is read-only */ extern gml_TError gml_gGrabberInvalidOptionVal; /**< invalid value for this option */ extern gml_TError gml_gGrabberThreadError; /**< threading related error */ extern gml_TError gml_gGrabberDriverError; /**< driver related error */ /**@ } */ /** * gml_TGrabberFeatureType -- * * Standard grabber options. In general, can be read and written. */ typedef enum { gml_cGrabberOptReduce = 'redu', /**< int, decimation factor from native size. */ gml_cGrabberOptSignalFormat = 'form', /**< int, possible values following */ gml_cGrabberOptSignalFormatPAL = 'pal ', gml_cGrabberOptSignalFormatSECAM = 'seca', gml_cGrabberOptSignalFormatNTSC = 'ntsc', gml_cGrabberOptShareKey = 'shmk', /**< UInt32, the grabber sharing key (unsigned long, r/o) */ gml_cGrabberOptColor = 'colr', /**< int, wether to grab color (int, default true) */ gml_cGrabberOptHue = 'hue ', gml_cGrabberOptSaturation = 'satu', gml_cGrabberOptSharpness = 'shrp', gml_cGrabberOptBrightness = 'brit', gml_cGrabberOptGain = 'gain', gml_cGrabberOptIris = 'iris', gml_cGrabberOptShutter = 'shtr', gml_cGrabberOptExposure = 'xpsr', gml_cGrabberOptWhiteBalanceU = 'whbu', gml_cGrabberOptWhiteBalanceV = 'whbv', gml_cGrabberOptGamma = 'gmma', gml_cGrabberOptTemperature = 'temp', gml_cGrabberOptZoom = 'zoom', gml_cGrabberOptFocus = 'fcus', gml_cGrabberOptPan = 'pan ', gml_cGrabberOptTilt = 'tilt', /* gml_cGrabberOptOpticalFilter = 'opft', gml_cGrabberOptTrigger = 'trgr', gml_cGrabberOptCaptureSize = 'cpsz', gml_cGrabberOptCaptureQuality = 'cpql', gml_cGrabberOptFocusPoint = 'fpnt', gml_cGrabberOptEdgeEnhancement = 'eden', gml_cGrabberOptLightingHint = 'lhnt' */ } gml_TGrabberFeatureType; /** * gml_TGrabberFeatureState -- * * Possible states for grabber features */ typedef enum { gml_cGrabberFlagOn = (1 << 0), gml_cGrabberFlagOff = (1 << 1), gml_cGrabberFlagManual = (1 << 2), gml_cGrabberFlagAuto = (1 << 3), gml_cGrabberFlagTune = (1 << 4), } gml_TGrabberFeatureState; /** * gml_TGrabberFeature -- * * Describes a feature or changeable option of the frame grabber */ typedef struct { gml_TGrabberFeatureType type; /**< feature type (in) */ int state; /**< current or desired state, as a mask of gml_TGrabberFeatureState (inout) */ SInt32 value; /**< current or desired value (inout) */ int capabilities; /**< possible states, as a mask of gml_TGrabberFeatureState (inout) */ SInt32 minimum; /**< minimal possible feature value */ SInt32 maximum; /**< maximal possible feature value */ } gml_TGrabberFeature; /** * gml_TGrabber -- * * A grabber token, returned by "gml_GrabberGet" and subsequently used for all operations on grabbers. */ typedef void* gml_TGrabber; /** * gml_GrabberGet -- * * Gets acces to a grabber. * @param name the name of the grabber we need to get access to. * NULL means first available grabber. * @param grabber is set to point to the requested grabber. */ GML_EXTERN_C gml_TError gml_GrabberGet (gml_TGrabberName* name, gml_TGrabber* grabber); /** * gml_GrabberRelease -- * * Releases a grabber. */ GML_EXTERN_C void gml_GrabberRelease (gml_TGrabber grabber); /** * gml_GrabberList -- * * Returns an array of string describing the available grabbers. * * @param names on successful return, an array of fixed strings. * <names> is allocated by <gml_GrabberDescrs> and must not be * freed by the caller. * @param nb on successful return, the number of available * grabbers. */ GML_EXTERN_C gml_TError gml_GrabberList (gml_TGrabberName** names, int* nb); /** * gml_GrabberGetBitmap -- * * Return a pointer to the bitmap where the lastest aquired frame is stored. * * @bug This is what this function should be designed to do: * Returns a pointer to the oldest available aquired frame, and remove it from * a queue of available frames. Return <NULL> if no frame is available. * This function may only be called inside the registered event handler. * Note that this function will not return the same frame twice. */ GML_EXTERN_C gml_TBitmap* gml_GrabberGetBitmap (gml_TGrabber grabber); /** * gml_GrabberBindOnNewFrame -- * * Registers a callback to be called when a new frame has been aquired. * Only one callback is memorized: * every call erases the previous callback address and parameter. * * @param callback the callback function. <NULL> means remove any bound callback. * @param userParam a parameter that will be provided when the callback in invoked. */ GML_EXTERN_C gml_TError gml_GrabberBindOnNewFrame (gml_TGrabber grabber, gml_TCallback callback, gml_TPointer userParam); /** * gml_GrabberUnbindOnNewFrame -- * * De-registers a callback function that was bound to the * "new frame available" event. See gml_GrabberBindOnNewFrame(). */ GML_EXTERN_C void gml_GrabberUnbindOnNewFrame (gml_TGrabber grabber, gml_TCallback callback, gml_TPointer userParam); /** * gml_GrabberGetOption -- * * Return the value of a grabber option in <option>. * The queried option is specified by the <type> field of <option>. */ GML_EXTERN_C gml_TError gml_GrabberGetOption (gml_TGrabber grabber, gml_TGrabberFeature* option); /** * gml_GrabberSetOption -- * * Change the value or flags of an option. * The queried option is specified by the <type> field of <option>. */ GML_EXTERN_C gml_TError gml_GrabberSetOption (gml_TGrabber grabber, gml_TGrabberFeature* option); /** * gml_GrabberGetName -- * * Return a human-readable name for the grabber. */ GML_EXTERN_C gml_TError gml_GrabberGetName (gml_TGrabber grabber, gml_TGrabberName name); /** * gml_GrabberSettingsDialog -- * * Query about and display a system-level dialog window that allows the user to set * the grabber's settings. * * @param display a boolean: if not 0, request that the dialog be displayed * if it exists. * @param exists a boolean: on return, the int pointed at is set to 0 if * there is no such a dialog. Can be set to NULL if not * interested. */ GML_EXTERN_C gml_TError gml_GrabberSettingsDialog (gml_TGrabber grabber, int display, int* exists); #endif /* ifndef __GML_GRABBER__ */ Generated on Tue Jun 12 14:03:27 2007 for gml by Doxygen 1.5.2.

Contact: julien (dot) letessier (at) gmail (dot) com. Copyright (c) 2000-2007 CLIPS-IMAG Laboratory, Grenoble, France. All rights reserved. W3CXHTML 1.0 W3CCSS 2.0