Settings.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2019, NVIDIA CORPORATION. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *  * Neither the name of NVIDIA CORPORATION nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _ARGUS_SETTINGS_H
#define _ARGUS_SETTINGS_H

namespace Argus
{

DEFINE_UUID(InterfaceID, IID_SOURCE_SETTINGS, eb7ae38c,3c62,4161,a92a,a6,4f,ba,c6,38,83);
class ISourceSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_SOURCE_SETTINGS; }

    virtual Status setExposureTimeRange(const Range<uint64_t>& exposureTimeRange) = 0;

    virtual Range<uint64_t> getExposureTimeRange() const = 0;

    virtual Status setFocusPosition(int32_t position) = 0;

    virtual int32_t getFocusPosition() const = 0;

    virtual Status setApertureMotorStep(int32_t step) = 0;

    virtual int32_t getApertureMotorStep() const = 0;

    virtual Status setApertureMotorSpeed(float speed) = 0;

    virtual float getApertureMotorSpeed() const = 0;

    virtual Status setFrameDurationRange(const Range<uint64_t>& frameDurationRange) = 0;

    virtual Range<uint64_t> getFrameDurationRange() const = 0;

    virtual Status setGainRange(const Range<float>& gainRange) = 0;

    virtual Range<float> getGainRange() const = 0;

    virtual Status setSensorMode(SensorMode* mode) = 0;

    virtual SensorMode* getSensorMode() const = 0;

    virtual Status setOpticalBlack(const BayerTuple<float>& opticalBlackLevels) = 0;

    virtual BayerTuple<float> getOpticalBlack() const = 0;

    virtual Status setOpticalBlackEnable(bool enable) = 0;

    virtual bool getOpticalBlackEnable() const = 0;


protected:
    ~ISourceSettings() {}
};

DEFINE_UUID(InterfaceID, IID_AUTO_CONTROL_SETTINGS, 1f2ad1c6,cb13,440b,bc95,3f,fd,0d,19,91,db);
class IAutoControlSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_AUTO_CONTROL_SETTINGS; }

    virtual Status setAeAntibandingMode(const AeAntibandingMode& mode) = 0;

    virtual AeAntibandingMode getAeAntibandingMode() const = 0;

    virtual Status setAeLock(bool lock) = 0;

    virtual bool getAeLock() const = 0;

    virtual Status setAeRegions(const std::vector<AcRegion>& regions) = 0;

    virtual Status getAeRegions(std::vector<AcRegion>* regions) const = 0;

    virtual Status setAwbLock(bool lock) = 0;

    virtual bool getAwbLock() const = 0;

    virtual Status setAwbMode(const AwbMode& mode) = 0;

    virtual AwbMode getAwbMode() const = 0;

    virtual Status setAwbRegions(const std::vector<AcRegion>& regions) = 0;

    virtual Status getAwbRegions(std::vector<AcRegion>* regions) const = 0;

    virtual Status setWbGains(const BayerTuple<float>& gains) = 0;

    virtual BayerTuple<float> getWbGains() const = 0;

    virtual Size2D<uint32_t> getColorCorrectionMatrixSize() const = 0;

    virtual Status setColorCorrectionMatrix(const std::vector<float>& matrix) = 0;

    virtual Status getColorCorrectionMatrix(std::vector<float>* matrix) const = 0;

    virtual Status setColorCorrectionMatrixEnable(bool enable) = 0;

    virtual bool getColorCorrectionMatrixEnable() const = 0;

    virtual Status setColorSaturation(float saturation) = 0;

    virtual float getColorSaturation() const = 0;

    virtual Status setColorSaturationEnable(bool enable) = 0;

    virtual bool getColorSaturationEnable() const = 0;

    virtual Status setColorSaturationBias(float bias) = 0;

    virtual float getColorSaturationBias() const = 0;

    virtual Status setExposureCompensation(float ev) = 0;

    virtual float getExposureCompensation() const = 0;

    virtual uint32_t getToneMapCurveSize(RGBChannel channel) const = 0;

    virtual Status setToneMapCurve(RGBChannel channel, const std::vector<float>& curve) = 0;

    virtual Status getToneMapCurve(RGBChannel channel, std::vector<float>* curve) const = 0;

    virtual Status setToneMapCurveEnable(bool enable) = 0;

    virtual bool getToneMapCurveEnable() const = 0;

    virtual Status setIspDigitalGainRange(const Range<float>& gain) = 0;

    virtual Range<float> getIspDigitalGainRange() const = 0;

protected:
    ~IAutoControlSettings() {}
};

DEFINE_UUID(InterfaceID, IID_STREAM_SETTINGS, c477aeaf,9cc8,4467,a834,c7,07,d7,b6,9f,a4);
class IStreamSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_STREAM_SETTINGS; }

    virtual Status setSourceClipRect(const Rectangle<float>& clipRect) = 0;

    virtual Rectangle<float> getSourceClipRect() const = 0;

    virtual void setPostProcessingEnable(bool enable) = 0;

    virtual bool getPostProcessingEnable() const = 0;

protected:
    ~IStreamSettings() {}
};

DEFINE_UUID(InterfaceID, IID_DENOISE_SETTINGS, 7A461D20,6AE1,11E6,BDF4,08,00,20,0C,9A,66);
class IDenoiseSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_DENOISE_SETTINGS; }

    virtual Status setDenoiseMode(const DenoiseMode& mode) = 0;

    virtual DenoiseMode getDenoiseMode() const = 0;

    virtual Status setDenoiseStrength(float strength) = 0;

    virtual float getDenoiseStrength() const = 0;

protected:
    ~IDenoiseSettings() {}
};

DEFINE_UUID(InterfaceID, IID_EDGE_ENHANCE_SETTINGS, 7A461D21,6AE1,11E6,BDF4,08,00,20,0C,9A,66);
class IEdgeEnhanceSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_EDGE_ENHANCE_SETTINGS; }

    virtual Status setEdgeEnhanceMode(const EdgeEnhanceMode& mode) = 0;

    virtual EdgeEnhanceMode getEdgeEnhanceMode() const = 0;

    virtual Status setEdgeEnhanceStrength(float strength) = 0;

    virtual float getEdgeEnhanceStrength() const = 0;

protected:
    ~IEdgeEnhanceSettings() {}
};

} // namespace Argus

#endif // _ARGUS_SETTINGS_H