core/vidl/vidl_iidc1394_params.h

Go to the documentation of this file.

// This is core/vidl/vidl_iidc1394_params.h
#ifndef vidl_iidc1394_params_h_
#define vidl_iidc1394_params_h_
#ifdef VCL_NEEDS_PRAGMA_INTERFACE
#pragma interface
#endif
//:
// \file
// \brief A parameters struct for IIDC 1394 camera streams
//
// \author Matt Leotta
// \date 10 Jan 2006
//
// These parameters are as described by the
// IIDC 1394-base Digital Camera Specification
// they should work for any istream that follows this
// specification.

#include <vcl_string.h>
#include <vcl_vector.h>
#include "vidl_pixel_format.h"

//: A parameters struct for IIDC 1394 camera streams
//
// The setter functions are provided for convenience, so that the
// parameters can be set through an anonymous object.
// \code
//   ostream.open( filename,
//                 vidl_iidc1394_params()
//                 .frame_rate( vidl_iidc1394_params::FRAMERATE_7_5 )
//                 .video_mode( vidl_iidc1394_params::MODE_1024x768_YUV422 ) );
// \endcode
struct vidl_iidc1394_params
{
  //: Available data transfer speeds
  enum speed_t { ISO_SPEED_100= 0,
                 ISO_SPEED_200,
                 ISO_SPEED_400,
                 ISO_SPEED_800,
                 ISO_SPEED_1600,
                 ISO_SPEED_3200 };

  //: Return the speed value for a speed setting
  static unsigned int speed_val(speed_t s);

  //: Available frame rates
  enum frame_rate_t { FRAMERATE_1_875= 32,
                      FRAMERATE_3_75,
                      FRAMERATE_7_5,
                      FRAMERATE_15,
                      FRAMERATE_30,
                      FRAMERATE_60,
                      FRAMERATE_120,
                      FRAMERATE_240 };

  //: Return the frame rate as a floating point value
  static float frame_rate_val(frame_rate_t r);

  //: Available video modes (format and mode combined)
  enum video_mode_t { MODE_160x120_YUV444= 64,
                      MODE_320x240_YUV422,
                      MODE_640x480_YUV411,
                      MODE_640x480_YUV422,
                      MODE_640x480_RGB8,
                      MODE_640x480_MONO8,
                      MODE_640x480_MONO16,
                      MODE_800x600_YUV422,
                      MODE_800x600_RGB8,
                      MODE_800x600_MONO8,
                      MODE_1024x768_YUV422,
                      MODE_1024x768_RGB8,
                      MODE_1024x768_MONO8,
                      MODE_800x600_MONO16,
                      MODE_1024x768_MONO16,
                      MODE_1280x960_YUV422,
                      MODE_1280x960_RGB8,
                      MODE_1280x960_MONO8,
                      MODE_1600x1200_YUV422,
                      MODE_1600x1200_RGB8,
                      MODE_1600x1200_MONO8,
                      MODE_1280x960_MONO16,
                      MODE_1600x1200_MONO16,
                      MODE_EXIF,
                      MODE_FORMAT7_0,
                      MODE_FORMAT7_1,
                      MODE_FORMAT7_2,
                      MODE_FORMAT7_3,
                      MODE_FORMAT7_4,
                      MODE_FORMAT7_5,
                      MODE_FORMAT7_6,
                      MODE_FORMAT7_7 };

  //: Available camera features
  enum feature_t{ FEATURE_BRIGHTNESS,
                  FEATURE_EXPOSURE,
                  FEATURE_SHARPNESS,
                  FEATURE_WHITE_BALANCE,
                  FEATURE_HUE,
                  FEATURE_SATURATION,
                  FEATURE_GAMMA,
                  FEATURE_SHUTTER,
                  FEATURE_GAIN,
                  FEATURE_IRIS,
                  FEATURE_FOCUS,
                  FEATURE_TEMPERATURE,
                  FEATURE_TRIGGER,
                  FEATURE_TRIGGER_DELAY,
                  FEATURE_WHITE_SHADING,
                  FEATURE_FRAME_RATE,
                  FEATURE_ZOOM,
                  FEATURE_PAN,
                  FEATURE_TILT,
                  FEATURE_OPTICAL_FILTER,
                  FEATURE_CAPTURE_SIZE,
                  FEATURE_CAPTURE_QUALITY};

  //: Available feature control modes
  enum feature_mode_t{ FEATURE_MODE_MANUAL,
                       FEATURE_MODE_AUTO,
                       FEATURE_MODE_ONE_PUSH_AUTO};

  //: Return string describing the mode
  static vcl_string video_mode_string(video_mode_t m);

  //: Return string describing the feature
  static vcl_string feature_string(feature_t f);

  //: Return string describing the feature mode
  static vcl_string feature_mode_string(feature_mode_t fm);

  //: Return the format number from the video mode enumeration
  static unsigned int video_format_val(video_mode_t m);
  //: Return the mode number from the video mode enumeration
  static unsigned int video_mode_val(video_mode_t m);

  //: Return the pixel format of the video mode
  // \note Only works for predefined modes (not Format 7 or Exif)
  static vidl_pixel_format pixel_format(video_mode_t m);

  //: Return the image resolution of the video mode
  // \note Only works for predefined modes (not Format 7 or Exif)
  static bool resolution(video_mode_t m, unsigned& ni, unsigned& nj);

  //: Return the video mode enumeration for a format and mode
  static video_mode_t video_mode(unsigned int format, unsigned int mode);

  //: Describes the valid options for the parameters
  struct valid_options;

  //: Describes a feature and its set of options
  struct feature_options;

  //-------------------------------------------------------

  //: The global unique identifier of the camera (default 0)
  vxl_uint_64 guid_;

  //: The data transfer speed (default ISO_SPEED_400)
  speed_t speed_;

  //: Operate the camera in 1394b mode
  bool b_mode_;

  //: The frame rate (default FRAMERATE_15)
  frame_rate_t frame_rate_;

  //: The video format and mode (default MODE_640x480_RGB8)
  video_mode_t video_mode_;

  //: The settings of camera features
  vcl_vector<feature_options> features_;

  //-------------------------------------------------------

  //: Construct to default values
  vidl_iidc1394_params();

  //: Set the guid
  vidl_iidc1394_params& guid( vxl_uint_64 the_guid )
  { guid_ = the_guid; return *this; }

  //: Set the speed
  vidl_iidc1394_params& speed( speed_t s )
  { speed_ = s; return *this; }

  //: Set b mode
  vidl_iidc1394_params& b_mode( bool b )
  { b_mode_ = b; return *this; }

  //: Set the frame rate
  vidl_iidc1394_params& frame_rate( frame_rate_t r )
  { frame_rate_ = r; return *this; }

  //: Set the video mode
  vidl_iidc1394_params& video_mode(video_mode_t m)
  { video_mode_ = m; return *this; }
};


//=============================================================================

//: Describes a feature and its set of options
struct vidl_iidc1394_params::feature_options
{
  feature_t       id;
  bool            available;
  bool            absolute_capable;
  bool            readout_capable;
  bool            on_off_capable;
  bool            polarity_capable;
  bool            is_on;
  feature_mode_t  active_mode;

  vcl_vector<feature_mode_t>  available_modes;

// FIXME - add trigger options
#if 0
  trigger_modes_t    trigger_modes;
  trigger_mode_t     trigger_mode;
  trigger_polarity_t trigger_polarity;
  trigger_sources_t  trigger_sources;
  trigger_source_t   trigger_source;
#endif

  unsigned int       min;
  unsigned int       max;
  unsigned int       value;
  unsigned int       BU_value;
  unsigned int       RV_value;
  unsigned int       B_value;
  unsigned int       R_value;
  unsigned int       G_value;
  unsigned int       target_value;

  bool               abs_control;
  float              abs_value;
  float              abs_max;
  float              abs_min;
};

//=============================================================================

//: This structure holds the set of valid options for parameters
// The istream class should be able to produce this object by
// probing cameras on the 1394 bus
struct vidl_iidc1394_params::valid_options
{
  //: A valid mode and its valid frame rates
  struct valid_mode
  {
    video_mode_t mode;
    vcl_vector<frame_rate_t> frame_rates;
  };

  //: A valid camera and its options
  struct camera
  {
    vxl_uint_64 guid; // global unique identifier
    vcl_string vendor;
    vcl_string model;
    speed_t speed;
    bool b_mode;
    vcl_vector<valid_mode> modes;
    vcl_vector<vidl_iidc1394_params::feature_options> features;
    video_mode_t curr_mode;
    frame_rate_t curr_frame_rate;
  };

  //: A vector of the valid cameras
  // one object for each camera detected on the bus
  vcl_vector<camera> cameras;
};

#endif // vidl_iidc1394_params_h_