IFrameGrabberControls.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_DEV_IFRAMEGRABBERCONTROLS_H
#define YARP_DEV_IFRAMEGRABBERCONTROLS_H
 
#include <yarp/dev/api.h>
#include <yarp/dev/ReturnValue.h>
 
#include <string>
 
namespace yarp::dev {
 
enum class BusType
{
    BUS_UNKNOWN = 0,
    BUS_FIREWIRE,
    BUS_USB
};
 
enum class FeatureMode
{
    MODE_UNKNOWN = 0,
    MODE_MANUAL,
    MODE_AUTO
};
 
struct CameraDescriptor
{
    BusType busType = BusType::BUS_UNKNOWN;
    std::string deviceDescription;
};
 
enum class cameraFeature_id_t
{
    YARP_FEATURE_INVALID=-1,
    YARP_FEATURE_BRIGHTNESS=0,
    YARP_FEATURE_EXPOSURE,
    YARP_FEATURE_SHARPNESS,
    YARP_FEATURE_WHITE_BALANCE,
    YARP_FEATURE_HUE,
    YARP_FEATURE_SATURATION,
    YARP_FEATURE_GAMMA,
    YARP_FEATURE_SHUTTER,
    YARP_FEATURE_GAIN,
    YARP_FEATURE_IRIS,
    YARP_FEATURE_FOCUS,
    YARP_FEATURE_TEMPERATURE,
    YARP_FEATURE_TRIGGER,
    YARP_FEATURE_TRIGGER_DELAY,
    YARP_FEATURE_WHITE_SHADING,
    YARP_FEATURE_FRAME_RATE,
    YARP_FEATURE_ZOOM,
    YARP_FEATURE_PAN,
    YARP_FEATURE_TILT,
    YARP_FEATURE_OPTICAL_FILTER,
    YARP_FEATURE_CAPTURE_SIZE,
    YARP_FEATURE_CAPTURE_QUALITY,
    YARP_FEATURE_MIRROR,
    YARP_FEATURE_NUMBER_OF          // this has to be the last one
};
 
class YARP_dev_API IFrameGrabberControls
{
public:
    virtual ~IFrameGrabberControls();
 
    std::string busType2String(BusType type)
    {
        switch (type) {
            case BusType::BUS_FIREWIRE:
                return "FireWire";
            break;
 
            case BusType::BUS_USB:
                return "USB";
            break;
 
            default:
                return "bus type undefined";
            break;
        }
    }
 
    inline FeatureMode toFeatureMode(bool _auto)
    {
        return _auto ? FeatureMode::MODE_AUTO : FeatureMode::MODE_MANUAL;
    }
    virtual yarp::dev::ReturnValue getCameraDescription(CameraDescriptor& camera)=0;
 
    virtual yarp::dev::ReturnValue hasFeature(cameraFeature_id_t, bool& hasFeature) = 0;
 
    virtual yarp::dev::ReturnValue setFeature(cameraFeature_id_t feature, double value) = 0;
 
    virtual yarp::dev::ReturnValue getFeature(cameraFeature_id_t feature, double& value) = 0;
 
    virtual yarp::dev::ReturnValue setFeature(cameraFeature_id_t feature, double value1, double value2) = 0;
 
    virtual yarp::dev::ReturnValue getFeature(cameraFeature_id_t feature, double& value1, double& value2) = 0;
 
    virtual yarp::dev::ReturnValue hasOnOff(cameraFeature_id_t feature, bool& HasOnOff) = 0;
 
    virtual yarp::dev::ReturnValue setActive(cameraFeature_id_t feature, bool onoff) = 0;
 
    virtual yarp::dev::ReturnValue getActive(cameraFeature_id_t feature, bool& isActive) = 0;
 
    virtual yarp::dev::ReturnValue hasAuto(cameraFeature_id_t feature, bool& hasAuto) = 0;
 
    virtual yarp::dev::ReturnValue hasManual(cameraFeature_id_t feature, bool& hasManual) = 0;
 
    virtual yarp::dev::ReturnValue hasOnePush(cameraFeature_id_t feature, bool& hasOnePush) = 0;
 
    virtual yarp::dev::ReturnValue setMode(cameraFeature_id_t feature, FeatureMode mode) = 0;
 
    virtual yarp::dev::ReturnValue getMode(cameraFeature_id_t feature, FeatureMode& mode) = 0;
 
    virtual yarp::dev::ReturnValue setOnePush(cameraFeature_id_t feature) = 0;
};
 
} // namespace yarp::dev
 
#endif // YARP_DEV_IFRAMEGRABBERCONTROLS_H