BufferStream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018, 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_BUFFER_STREAM_H
#define _ARGUS_BUFFER_STREAM_H
 
namespace Argus
{
 
DEFINE_UUID(StreamType, STREAM_TYPE_BUFFER, c723d960,5231,11e7,9598,18,00,20,0c,9a,66);
 
DEFINE_NAMED_UUID_CLASS(BufferType);
DEFINE_UUID(BufferType, BUFFER_TYPE_NONE, c723d961,5231,11e7,9598,18,00,20,0c,9a,66);
 
DEFINE_NAMED_UUID_CLASS(SyncType);
DEFINE_UUID(SyncType, SYNC_TYPE_NONE, c723d962,5231,11e7,9598,18,00,20,0c,9a,66);
 
class Buffer : public InterfaceProvider, public Destructable
{
protected:
    ~Buffer() {}
};
 
class BufferSettings : public InterfaceProvider, public Destructable
{
protected:
    ~BufferSettings() {}
};
 
DEFINE_UUID(InterfaceID, IID_BUFFER_OUTPUT_STREAM_SETTINGS,
                         c723d963,5231,11e7,9598,18,00,20,0c,9a,66);
class IBufferOutputStreamSettings : public Interface
{
public:
    static const InterfaceID& id() { return IID_BUFFER_OUTPUT_STREAM_SETTINGS; }
 
    virtual Status setBufferType(const BufferType& type) = 0;
 
    virtual BufferType getBufferType() const = 0;
 
    virtual Status setSyncType(const SyncType& type) = 0;
 
    virtual SyncType getSyncType() const = 0;
 
    virtual void setMetadataEnable(bool enable) = 0;
 
    virtual bool getMetadataEnable() const = 0;
 
protected:
    ~IBufferOutputStreamSettings() {}
};
 
DEFINE_UUID(InterfaceID, IID_BUFFER_OUTPUT_STREAM, c723d964,5231,11e7,9598,18,00,20,0c,9a,66);
class IBufferOutputStream : public Interface
{
public:
    static const InterfaceID& id() { return IID_BUFFER_OUTPUT_STREAM; }
 
    virtual BufferType getBufferType() const = 0;
 
    virtual SyncType getSyncType() const = 0;
 
    virtual BufferSettings* createBufferSettings(Status* status = NULL) = 0;
 
    virtual Buffer* createBuffer(const BufferSettings* settings, Status* status = NULL) = 0;
 
    virtual Buffer* acquireBuffer(uint64_t timeout = TIMEOUT_INFINITE, Status* status = NULL) = 0;
 
    virtual Status releaseBuffer(Buffer* buffer) = 0;
 
    virtual Status endOfStream() = 0;
 
protected:
    ~IBufferOutputStream() {}
};
 
DEFINE_UUID(InterfaceID, IID_BUFFER, c723d965,5231,11e7,9598,18,00,20,0c,9a,66);
class IBuffer : public Interface
{
public:
    static const InterfaceID& id() { return IID_BUFFER; }
 
    virtual BufferType getBufferType() const = 0;
 
    virtual SyncType getSyncType() const = 0;
 
    virtual void setClientData(const void* clientData) = 0;
 
    virtual const void* getClientData() const = 0;
 
    virtual const CaptureMetadata* getMetadata() const = 0;
 
protected:
    ~IBuffer() {}
};
 
} // namespace Argus
 
#endif // _ARGUS_BUFFER_STREAM_H