Jetson Linux API Reference

32.7.3 Release
BufferStream.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2018, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of NVIDIA CORPORATION nor the names of its
13  * contributors may be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
36 #ifndef _ARGUS_BUFFER_STREAM_H
37 #define _ARGUS_BUFFER_STREAM_H
38 
39 namespace Argus
40 {
41 
76 DEFINE_UUID(StreamType, STREAM_TYPE_BUFFER, c723d960,5231,11e7,9598,18,00,20,0c,9a,66);
77 
88 DEFINE_NAMED_UUID_CLASS(BufferType);
89 DEFINE_UUID(BufferType, BUFFER_TYPE_NONE, c723d961,5231,11e7,9598,18,00,20,0c,9a,66);
90 
101 DEFINE_NAMED_UUID_CLASS(SyncType);
102 DEFINE_UUID(SyncType, SYNC_TYPE_NONE, c723d962,5231,11e7,9598,18,00,20,0c,9a,66);
103 
123 class Buffer : public InterfaceProvider, public Destructable
124 {
125 protected:
126  ~Buffer() {}
127 };
128 
142 {
143 protected:
145 };
146 
154 DEFINE_UUID(InterfaceID, IID_BUFFER_OUTPUT_STREAM_SETTINGS,
155  c723d963,5231,11e7,9598,18,00,20,0c,9a,66);
157 {
158 public:
159  static const InterfaceID& id() { return IID_BUFFER_OUTPUT_STREAM_SETTINGS; }
160 
170  virtual Status setBufferType(const BufferType& type) = 0;
171 
175  virtual BufferType getBufferType() const = 0;
176 
188  virtual Status setSyncType(const SyncType& type) = 0;
189 
193  virtual SyncType getSyncType() const = 0;
194 
202  virtual void setMetadataEnable(bool enable) = 0;
203 
207  virtual bool getMetadataEnable() const = 0;
208 
209 protected:
211 };
212 
220 DEFINE_UUID(InterfaceID, IID_BUFFER_OUTPUT_STREAM, c723d964,5231,11e7,9598,18,00,20,0c,9a,66);
222 {
223 public:
224  static const InterfaceID& id() { return IID_BUFFER_OUTPUT_STREAM; }
225 
229  virtual BufferType getBufferType() const = 0;
230 
234  virtual SyncType getSyncType() const = 0;
235 
247  virtual BufferSettings* createBufferSettings(Status* status = NULL) = 0;
248 
263  virtual Buffer* createBuffer(const BufferSettings* settings, Status* status = NULL) = 0;
264 
296  virtual Buffer* acquireBuffer(uint64_t timeout = TIMEOUT_INFINITE, Status* status = NULL) = 0;
297 
324  virtual Status releaseBuffer(Buffer* buffer) = 0;
325 
340  virtual Status endOfStream() = 0;
341 
342 protected:
344 };
345 
353 DEFINE_UUID(InterfaceID, IID_BUFFER, c723d965,5231,11e7,9598,18,00,20,0c,9a,66);
354 class IBuffer : public Interface
355 {
356 public:
357  static const InterfaceID& id() { return IID_BUFFER; }
358 
362  virtual BufferType getBufferType() const = 0;
363 
367  virtual SyncType getSyncType() const = 0;
368 
378  virtual void setClientData(const void* clientData) = 0;
379 
383  virtual const void* getClientData() const = 0;
384 
400  virtual const CaptureMetadata* getMetadata() const = 0;
401 
402 protected:
403  ~IBuffer() {}
404 };
405 
406 } // namespace Argus
407 
408 #endif // _ARGUS_BUFFER_STREAM_H
Argus::IBufferOutputStream::getSyncType
virtual SyncType getSyncType() const =0
Argus::IBufferOutputStream::getBufferType
virtual BufferType getBufferType() const =0
Returns the BufferType of the stream.
Argus::DEFINE_NAMED_UUID_CLASS
DEFINE_NAMED_UUID_CLASS(BufferType)
Argus::TIMEOUT_INFINITE
const uint64_t TIMEOUT_INFINITE
Constant used for infinite timeouts.
Definition: Types.h:88
Argus::BufferSettings::~BufferSettings
~BufferSettings()
Definition: BufferStream.h:144
Argus::IBuffer::getMetadata
virtual const CaptureMetadata * getMetadata() const =0
Returns the CaptureMetadata object that was attached to this Buffer when it was last output to the st...
Argus::DEFINE_UUID
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
Argus::IBufferOutputStream
Definition: BufferStream.h:221
Argus::IBufferOutputStream::createBufferSettings
virtual BufferSettings * createBufferSettings(Status *status=NULL)=0
Creates a BufferSettings object.
Argus::Buffer::~Buffer
~Buffer()
Definition: BufferStream.h:126
Argus::IBuffer::getBufferType
virtual BufferType getBufferType() const =0
Returns the BufferType of the Buffer.
Argus
Definition: BayerAverageMap.h:39
Argus::CaptureMetadata
Definition: CaptureMetadata.h:48
Argus::IBufferOutputStream::endOfStream
virtual Status endOfStream()=0
Signals the end of the stream.
Argus::Interface
The top-level interface class.
Definition: Types.h:327
Argus::IBufferOutputStreamSettings
Definition: BufferStream.h:156
Argus::IBufferOutputStream::releaseBuffer
virtual Status releaseBuffer(Buffer *buffer)=0
Release a Buffer back to the stream to make it available for a future capture request.
Argus::IBufferOutputStream::~IBufferOutputStream
~IBufferOutputStream()
Definition: BufferStream.h:343
Argus::IBufferOutputStreamSettings::getMetadataEnable
virtual bool getMetadataEnable() const =0
Returns the metadata enable.
Argus::IBuffer::setClientData
virtual void setClientData(const void *clientData)=0
Sets the client data for the Buffer.
Argus::InterfaceID
A unique identifier for a libargus Interface.
Definition: Types.h:337
Argus::IBufferOutputStreamSettings::getBufferType
virtual BufferType getBufferType() const =0
Returns the BufferType to be used for the stream.
Argus::IBufferOutputStreamSettings::~IBufferOutputStreamSettings
~IBufferOutputStreamSettings()
Definition: BufferStream.h:210
Argus::InterfaceProvider
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:358
Argus::IBuffer::~IBuffer
~IBuffer()
Definition: BufferStream.h:403
Argus::IBufferOutputStream::acquireBuffer
virtual Buffer * acquireBuffer(uint64_t timeout=TIMEOUT_INFINITE, Status *status=NULL)=0
Acquires a Buffer from the stream that was written to by a libargus capture request.
Argus::IBufferOutputStreamSettings::setBufferType
virtual Status setBufferType(const BufferType &type)=0
Sets the BufferType for the stream.
Argus::IBufferOutputStream::createBuffer
virtual Buffer * createBuffer(const BufferSettings *settings, Status *status=NULL)=0
Creates a Buffer object.
Argus::IBuffer::id
static const InterfaceID & id()
Definition: BufferStream.h:357
Argus::IBufferOutputStream::id
static const InterfaceID & id()
Definition: BufferStream.h:224
Argus::IBuffer::getSyncType
virtual SyncType getSyncType() const =0
Returns the SyncType of the Buffer.
Argus::Buffer
Definition: BufferStream.h:123
Argus::IBufferOutputStreamSettings::setMetadataEnable
virtual void setMetadataEnable(bool enable)=0
Sets the metadata enable for the stream.
Argus::BufferSettings
Definition: BufferStream.h:141
Argus::IBufferOutputStreamSettings::getSyncType
virtual SyncType getSyncType() const =0
Returns the SyncType to be used for the stream.
Argus::Destructable
A top level object class for libargus objects that are created and owned by the client.
Definition: Types.h:395
Argus::IBuffer::getClientData
virtual const void * getClientData() const =0
Returns the client data from the Buffer.
Argus::IBufferOutputStreamSettings::setSyncType
virtual Status setSyncType(const SyncType &type)=0
Sets the SyncType for the stream.
Argus::Status
Status
Status values returned by API function calls.
Definition: Types.h:93
Argus::IBuffer
Definition: BufferStream.h:354
Argus::IBufferOutputStreamSettings::id
static const InterfaceID & id()
Definition: BufferStream.h:159