EGLStream.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2017-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * 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_EGL_STREAM_H
#define _ARGUS_EGL_STREAM_H
 
namespace Argus
{
 
DEFINE_UUID(StreamType, STREAM_TYPE_EGL, 3a659360,5231,11e7,9598,18,00,20,0c,9a,66);
 
DEFINE_NAMED_UUID_CLASS(EGLStreamMode);
DEFINE_UUID(EGLStreamMode, EGL_STREAM_MODE_MAILBOX, 33661d40,3ee2,11e6,bdf4,08,00,20,0c,9a,66);
DEFINE_UUID(EGLStreamMode, EGL_STREAM_MODE_FIFO,    33661d41,3ee2,11e6,bdf4,08,00,20,0c,9a,66);
 
DEFINE_UUID(InterfaceID, IID_EGL_OUTPUT_STREAM_SETTINGS, 3a659361,5231,11e7,9598,18,00,20,0c,9a,66);
class IEGLOutputStreamSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_EGL_OUTPUT_STREAM_SETTINGS; }
 
    virtual Status setPixelFormat(const PixelFormat& format) = 0;
    virtual PixelFormat getPixelFormat() const = 0;
 
    virtual Status setResolution(const Size2D<uint32_t>& resolution) = 0;
    virtual Size2D<uint32_t> getResolution() const = 0;
 
    virtual Status setExposureCount(uint32_t exposureCount) = 0;
    virtual uint32_t getExposureCount() const = 0;
 
    virtual Status setEGLDisplay(EGLDisplay eglDisplay) = 0;
    virtual EGLDisplay getEGLDisplay() const = 0;
 
    virtual Status setMode(const EGLStreamMode& mode) = 0;
    virtual EGLStreamMode getMode() const = 0;
 
    virtual Status setFifoLength(uint32_t fifoLength) = 0;
    virtual uint32_t getFifoLength() const = 0;
 
    virtual Status setMetadataEnable(bool metadataEnable) = 0;
    virtual bool getMetadataEnable() const = 0;
 
    virtual bool supportsOutputStreamFormat(const SensorMode* sensorMode,
                                            const PixelFormat& outputFormat) const = 0;
 
    virtual Status setBufferLayout(const BufferLayout& layout) = 0;
    virtual BufferLayout getBufferLayout() const = 0;
 
protected:
    ~IEGLOutputStreamSettings() {}
};
 
DEFINE_UUID(InterfaceID, IID_EGL_OUTPUT_STREAM, 3a659362,5231,11e7,9598,18,00,20,0c,9a,66);
class IEGLOutputStream : public Interface
{
public:
    static const InterfaceID& id() { return IID_EGL_OUTPUT_STREAM; }
 
    virtual Status waitUntilConnected(uint64_t timeout = TIMEOUT_INFINITE) const = 0;
 
    virtual void disconnect() = 0;
 
    virtual PixelFormat getPixelFormat() const = 0;
 
    virtual Size2D<uint32_t> getResolution() const = 0;
 
    virtual EGLDisplay getEGLDisplay() const = 0;
 
    virtual EGLStreamKHR getEGLStream() const = 0;
 
protected:
    ~IEGLOutputStream() {}
};
 
DEFINE_UUID(InterfaceID, IID_EGL_INPUT_STREAM_SETTINGS, c3579170,b1ac,11ec,a893,08,00,20,0c,9a,66);
class IEGLInputStreamSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_EGL_INPUT_STREAM_SETTINGS; }
 
    virtual Status setPixelFormat(const PixelFormat& format) = 0;
    virtual PixelFormat getPixelFormat() const = 0;
 
    virtual Status setResolution(const Size2D<uint32_t>& resolution) = 0;
    virtual Size2D<uint32_t> getResolution() const = 0;
 
    virtual Status setExposureCount(uint32_t exposureCount) = 0;
    virtual uint32_t getExposureCount() const = 0;
 
 
    virtual Status setEGLDisplay(EGLDisplay eglDisplay) = 0;
    virtual EGLDisplay getEGLDisplay() const = 0;
 
    virtual Status setFifoLength(uint32_t fifoLength) = 0;
    virtual uint32_t getFifoLength() const = 0;
 
    virtual bool supportsInputStreamFormat(const SensorMode* sensorMode,
                                            const PixelFormat& inputFormat) const = 0;
 
protected:
    ~IEGLInputStreamSettings() {}
};
 
DEFINE_UUID(InterfaceID, IID_EGL_INPUT_STREAM, c3579171,b1ac,11ec,a893,08,00,20,0c,9a,66)
class IEGLInputStream : public Interface
{
public:
    static const InterfaceID& id() { return IID_EGL_INPUT_STREAM; }
 
    virtual Status waitUntilConnected(uint64_t timeout = TIMEOUT_INFINITE) const = 0;
 
    virtual void disconnect() = 0;
 
    virtual PixelFormat getPixelFormat() const = 0;
 
    virtual Size2D<uint32_t> getResolution() const = 0;
 
    virtual EGLDisplay getEGLDisplay() const = 0;
 
    virtual EGLStreamKHR getEGLStream() const = 0;
 
protected:
    ~IEGLInputStream() {}
};
 
} // namespace Argus
 
#endif // _ARGUS_EGL_STREAM_H