CaptureMetadata.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2023, 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_CAPTURE_METADATA_H
#define _ARGUS_CAPTURE_METADATA_H
 
namespace Argus
{
 
class CaptureMetadata : public InterfaceProvider
{
protected:
    ~CaptureMetadata() {}
};
 
class CaptureMetadataContainer : public InterfaceProvider, public Destructable
{
protected:
    ~CaptureMetadataContainer() {}
};
 
DEFINE_UUID(InterfaceID, IID_BAYER_HISTOGRAM, 50bc4f1c,6424,beb7,baae,b0,90,c9,c3,25,9e);
class IBayerHistogram : public Interface
{
public:
 
    static const InterfaceID& id() { return IID_BAYER_HISTOGRAM; }
 
    virtual uint32_t getBinCount() const = 0;
 
    virtual Status getHistogram(std::vector< BayerTuple<uint32_t> >* histogram) const = 0;
 
protected:
 
    ~IBayerHistogram() {}
};
 
DEFINE_UUID(InterfaceID, IID_RGB_HISTOGRAM, 50bc4f1d,6424,beb7,baae,b0,90,c9,c3,25,9e);
class IRGBHistogram : public Interface
{
public:
 
    static const InterfaceID& id() { return IID_RGB_HISTOGRAM; }
 
    virtual uint32_t getBinCount() const = 0;
 
    virtual Status getHistogram(std::vector< RGBTuple<uint32_t> >* histogram) const = 0;
 
protected:
 
    ~IRGBHistogram() {}
};
 
DEFINE_UUID(InterfaceID, IID_STREAM_CAPTURE_METADATA, 61cbe0a8,0ee1,4c67,baae,02,02,1a,b8,d9,47);
class IStreamCaptureMetadata : public Interface
{
public:
 
    static const InterfaceID& id() { return IID_STREAM_CAPTURE_METADATA; }
 
    virtual Rectangle<float> getSourceClipRect() const = 0;
 
protected:
 
    ~IStreamCaptureMetadata() {}
};
 
DEFINE_UUID(InterfaceID, IID_CAPTURE_METADATA, 5f6ac5d4,59e8,45d0,8bac,38,09,1f,f8,74,a9);
class ICaptureMetadata : public Interface
{
public:
 
    static const InterfaceID& id() { return IID_CAPTURE_METADATA; }
 
    static const uint32_t NUM_COLOR_CORRECTION_ELEMENTS = 9;
    static const uint32_t NUM_AWB_WB_ESTIMATE_ELEMENTS = 4;
 
    virtual uint32_t getCaptureId() const = 0;
 
    virtual uint32_t getClientData() const = 0;
 
    virtual InterfaceProvider* getStreamMetadata(const OutputStream* stream) const = 0;
 
    virtual const InterfaceProvider* getBayerHistogram() const = 0;
 
    virtual const InterfaceProvider* getRGBHistogram() const = 0;
 
    virtual bool getAeLocked() const = 0;
 
    virtual Status getAeRegions(std::vector<AcRegion>* regions) const = 0;
 
    virtual Rectangle<uint32_t> getBayerHistogramRegion() const = 0;
 
    virtual AeState getAeState() const = 0;
 
    virtual AeFlickerState getFlickerState() const = 0;
 
    virtual int32_t getAperturePosition() const = 0;
 
    virtual int32_t getFocuserPosition() const = 0;
 
    virtual uint32_t getAwbCct() const = 0;
 
    virtual BayerTuple<float> getAwbGains() const = 0;
 
    virtual AwbMode getAwbMode() const = 0;
 
    virtual Status getAwbRegions(std::vector<AcRegion>* regions) const = 0;
 
    virtual AfMode getAfMode() const = 0;
 
    virtual Status getAfRegions(std::vector<AcRegion>* regions) const = 0;
 
    virtual Status getSharpnessScore(std::vector<float>* values) const = 0;
 
    virtual AwbState getAwbState() const = 0;
 
    virtual Status getAwbWbEstimate(std::vector<float>* estimate) const = 0;
 
    virtual bool getColorCorrectionMatrixEnable() const = 0;
 
    virtual Status getColorCorrectionMatrix(std::vector<float>* ccMatrix) const = 0;
 
    virtual float getColorSaturation() const = 0;
 
    virtual uint64_t getFrameDuration() const = 0;
 
    virtual float getIspDigitalGain() const = 0;
 
    virtual uint64_t getFrameReadoutTime() const = 0;
 
    virtual float getSceneLux() const = 0;
 
    virtual float getSensorAnalogGain() const = 0;
 
    virtual uint64_t getSensorExposureTime() const = 0;
 
    virtual uint32_t getSensorSensitivity() const = 0;
 
    virtual uint64_t getSensorTimestamp() const = 0;
 
    virtual bool getToneMapCurveEnabled() const = 0;
 
    virtual Status getToneMapCurve(RGBChannel channel, std::vector<float>* curve) const = 0;
 
protected:
    ~ICaptureMetadata() {}
};
 
DEFINE_UUID(InterfaceID, IID_DENOISE_METADATA, 7A461D23,6AE1,11E6,BDF4,08,00,20,0C,9A,66);
class IDenoiseMetadata : public Interface
{
public:
    static const InterfaceID& id() { return IID_DENOISE_METADATA; }
 
    virtual DenoiseMode getDenoiseMode() const = 0;
 
    virtual float getDenoiseStrength() const = 0;
 
protected:
    ~IDenoiseMetadata() {}
};
 
DEFINE_UUID(InterfaceID, IID_EDGE_ENHANCE_METADATA, 7A461D24,6AE1,11E6,BDF4,08,00,20,0C,9A,66);
class IEdgeEnhanceMetadata : public Interface
{
public:
    static const InterfaceID& id() { return IID_EDGE_ENHANCE_METADATA; }
 
    virtual EdgeEnhanceMode getEdgeEnhanceMode() const = 0;
 
    virtual float getEdgeEnhanceStrength() const = 0;
 
protected:
    ~IEdgeEnhanceMetadata() {}
};
 
} // namespace Argus
 
#endif // _ARGUS_CAPTURE_METADATA_H