plugins/vidinput_dc/videoio1394dc.h

   1 /*
   2  * videoio1394dc.h
   3  *
   4  * Copyright:
   5  * Copyright (c) 2002 Ryutaroh Matsumoto <ryutaroh@rmatsumoto.org>
   6  *
   7  * The contents of this file are subject to the Mozilla Public License
   8  * Version 1.0 (the "License"); you may not use this file except in
   9  * compliance with the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS"
  13  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  14  * the License for the specific language governing rights and limitations
  15  * under the License.
  16  *
  17  *
  18  * Classes to support streaming video input from IEEE 1394 cameras.
  19  * Detailed explanation can be found at src/ptlib/unix/video4dc1394.cxx
  20  *
  21  * $Log$
  22  * Revision 1.1  2003/12/17 15:40:56  dominance
  23  * Added DC Plugin as provided by Julien Puydt <julien.puydt@laposte.net>. Needs manual patching of plugins/configure for now though. (i.e. disabled by default, run autoconf in plugins/)
  24  *
  25  * Revision 1.2  2002/05/30 22:49:35  dereks
  26  * correct implementation of GetInputDeviceNames().
  27  *
  28  * Revision 1.1  2002/02/20 02:37:26  dereks
  29  * Initial release of Firewire camera support for linux.
  30  * Many thanks to Ryutaroh Matsumoto <ryutaroh@rmatsumoto.org>.
  31  *
  32  *
  33  */
  34
  35
  36 #ifndef _PVIDEOIO1394DC
  37
  38 #define _PVIDEOIO1394DC
  39
  40 #ifdef __GNUC__
  41 #pragma interface
  42 #endif
  43
  44 #include <libraw1394/raw1394.h>
  45 #include <libdc1394/dc1394_control.h>
  46
  47 /** This class defines a video input device that
  48     generates fictitous image data.
  49 */
  50 class PVideoInput1394DcDevice : public PVideoInputDevice
  51 {
  52     PCLASSINFO(PVideoInput1394DcDevice, PVideoInputDevice);
  53  public:
  54   /** Create a new video input device.
  55    */
  56     PVideoInput1394DcDevice();
  57
  58     /**Close the video input device on destruction.
  59       */
  60     ~PVideoInput1394DcDevice();
  61
  62     /**Open the device given the device name.
  63       */
  64     BOOL Open(
  65       const PString & deviceName,   /// Device name to open
  66       BOOL startImmediate = TRUE    /// Immediately start device
  67     );
  68
  69     /**Determine of the device is currently open.
  70       */
  71     BOOL IsOpen();
  72
  73     /**Close the device.
  74       */
  75     BOOL Close();
  76
  77     /**Start the video device I/O.
  78       */
  79     BOOL Start();
  80
  81     /**Stop the video device I/O capture.
  82       */
  83     BOOL Stop();
  84
  85     /**Determine if the video device I/O capture is in progress.
  86       */
  87     BOOL IsCapturing();
  88
  89     /**Get a list of all of the drivers available.
  90       */
  91     static PStringList GetInputDeviceNames();
  92
  93     PStringList GetDeviceNames() const
  94     { return GetInputDeviceNames(); }
  95
  96     /**Get the maximum frame size in bytes.
  97
  98        Note a particular device may be able to provide variable length
  99        frames (eg motion JPEG) so will be the maximum size of all frames.
 100       */
 101     PINDEX GetMaxFrameBytes();
 102
 103     BOOL GetFrame(
 104       PBYTEArray & frame
 105     );
 106
 107     /**Grab a frame, after a delay as specified by the frame rate.
 108       */
 109     BOOL GetFrameData(
 110       BYTE * buffer,                 /// Buffer to receive frame
 111       PINDEX * bytesReturned = NULL  /// OPtional bytes returned.
 112     );
 113
 114     /**Grab a frame. Do not delay according to the current frame rate parameter.
 115       */
 116     BOOL GetFrameDataNoDelay(
 117       BYTE * buffer,                 /// Buffer to receive frame
 118       PINDEX * bytesReturned = NULL  /// OPtional bytes returned.
 119     );
 120
 121
 122     /**Get the brightness of the image. 0xffff-Very bright.
 123      */
 124     int GetBrightness();
 125
 126     /**Set brightness of the image. 0xffff-Very bright.
 127      */
 128     BOOL SetBrightness(unsigned newBrightness);
 129
 130
 131     /**Get the whiteness of the image. 0xffff-Very white.
 132      */
 133     int GetWhiteness();
 134
 135     /**Set whiteness of the image. 0xffff-Very white.
 136      */
 137     BOOL SetWhiteness(unsigned newWhiteness);
 138
 139
 140     /**Get the colour of the image. 0xffff-lots of colour.
 141      */
 142     int GetColour();
 143
 144     /**Set colour of the image. 0xffff-lots of colour.
 145      */
 146     BOOL SetColour(unsigned newColour);
 147
 148
 149     /**Get the contrast of the image. 0xffff-High contrast.
 150      */
 151     int GetContrast();
 152
 153     /**Set contrast of the image. 0xffff-High contrast.
 154      */
 155     BOOL SetContrast(unsigned newContrast);
 156
 157
 158     /**Get the hue of the image. 0xffff-High hue.
 159      */
 160     int GetHue();
 161
 162     /**Set hue of the image. 0xffff-High hue.
 163      */
 164     BOOL SetHue(unsigned newHue);
 165
 166
 167     /**Return whiteness, brightness, colour, contrast and hue in one call.
 168      */
 169     BOOL GetParameters (int *whiteness, int *brightness,
 170                                 int *colour, int *contrast, int *hue);
 171
 172     /**Get the minimum & maximum size of a frame on the device.
 173     */
 174     BOOL GetFrameSizeLimits(
 175       unsigned & minWidth,   /// Variable to receive minimum width
 176       unsigned & minHeight,  /// Variable to receive minimum height
 177       unsigned & maxWidth,   /// Variable to receive maximum width
 178       unsigned & maxHeight   /// Variable to receive maximum height
 179     ) ;
 180
 181     void ClearMapping();
 182
 183     int GetNumChannels();
 184     BOOL SetChannel(
 185          int channelNumber  /// New channel number for device.
 186     );
 187     BOOL SetFrameRate(
 188       unsigned rate  /// Frames  per second
 189     );
 190     BOOL SetVideoFormat(
 191       VideoFormat videoFormat   /// New video format
 192     );
 193     BOOL SetFrameSize(
 194       unsigned width,   /// New width of frame
 195       unsigned height   /// New height of frame
 196     );
 197     BOOL SetColourFormat(
 198       const PString & colourFormat   // New colour format for device.
 199     );
 200
 201
 202     /**Try all known video formats & see which ones are accepted by the video driver
 203      */
 204     BOOL TestAllFormats();
 205
 206     /**Set the frame size to be used, trying converters if available.
 207
 208        If the device does not support the size, a set of alternate resolutions
 209        are attempted.  A converter is setup if possible.
 210     */
 211     BOOL SetFrameSizeConverter(
 212       unsigned width,        /// New width of frame
 213       unsigned height,       /// New height of frame
 214       BOOL     bScaleNotCrop /// Scale or crop/pad preference
 215     );
 216
 217     /**Set the colour format to be used, trying converters if available.
 218
 219        This function will set the colour format on the device to one that
 220        is compatible with a registered converter, and install that converter
 221        so that the correct format is used.
 222     */
 223     BOOL SetColourFormatConverter(
 224       const PString & colourFormat // New colour format for device.
 225     );
 226
 227
 228  protected:
 229     PINDEX frameBytes;
 230     raw1394handle_t handle;
 231     BOOL is_capturing;
 232     BOOL UseDMA;
 233     nodeid_t * camera_nodes;
 234     int numCameras;
 235     dc1394_cameracapture camera;
 236     int capturing_duration;
 237     PString      desiredColourFormat;
 238     unsigned     desiredFrameWidth;
 239     unsigned     desiredFrameHeight;
 240 };
 241
 242 #endif
 243
 244
 245 // End Of File ///////////////////////////////////////////////////////////////