Multimedia API Reference

November 16, 2016 | 24.2.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CaptureSession.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, 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 
37 #ifndef _ARGUS_CAPTURE_SESSION_H
38 #define _ARGUS_CAPTURE_SESSION_H
39 
50 namespace Argus
51 {
52 
59 {
60 protected:
62 };
63 
69 DEFINE_UUID(InterfaceID, IID_CAPTURE_SESSION, 813644f5,bc21,4013,af44,dd,da,b5,7a,9d,13);
70 
71 class ICaptureSession : public Interface
72 {
73 public:
74  static const InterfaceID& id() { return IID_CAPTURE_SESSION; }
75 
84  virtual Status cancelRequests() = 0;
85 
103  virtual uint32_t capture(const Request* request,
104  uint64_t timeout = TIMEOUT_INFINITE,
105  Status* status = NULL) = 0;
106 
126  virtual uint32_t captureBurst(const std::vector<const Request*>& requestList,
127  uint64_t timeout = TIMEOUT_INFINITE,
128  Status* status = NULL) = 0;
129 
133  virtual uint32_t maxBurstRequests() const = 0;
134 
147  virtual Request* createRequest(const CaptureIntent& intent = CAPTURE_INTENT_PREVIEW,
148  uint32_t clientData = 0,
149  Status* status = NULL) = 0;
150 
159  virtual OutputStreamSettings* createOutputStreamSettings(Status* status = NULL) = 0;
160 
174  virtual OutputStream* createOutputStream(const OutputStreamSettings* settings,
175  Status* status = NULL) = 0;
176 
180  virtual bool isRepeating() const = 0;
181 
193  virtual Status repeat(const Request* request) = 0;
194 
206  virtual Status repeatBurst(const std::vector<const Request*>& requestList) = 0;
207 
211  virtual void stopRepeat() = 0;
212 
220  virtual Status waitForIdle(uint64_t timeout = TIMEOUT_INFINITE) const = 0;
221 
222 protected:
224 };
225 
226 } // namespace Argus
228 #endif // _ARGUS_CAPTURE_SESSION_H
The base interface for a class that provides libargus interfaces.
Definition: Types.h:343
virtual Status repeat(const Request *request)=0
Sets up a repeating request.
Output streams are created and owned by CaptureSessions, and they maintain a connection with an EGLSt...
Definition: Stream.h:72
Status
Status values returned by API function calls.
Definition: Types.h:220
The top-level interface class.
Definition: Types.h:312
virtual Status waitForIdle(uint64_t timeout=TIMEOUT_INFINITE) const =0
Waits until all pending captures are complete.
virtual Status cancelRequests()=0
Removes all previously submitted requests from the queue.
A request defines the parameters to configure the capture.
Definition: Request.h:58
virtual void stopRepeat()=0
Shuts down any repeating capture.
Describes the core interface available to CaptureSessions.
static const InterfaceID & id()
virtual OutputStream * createOutputStream(const OutputStreamSettings *settings, Status *status=NULL)=0
Creates an OutputStream object.
virtual bool isRepeating() const =0
Returns true if there is a streaming request in place.
DEFINE_UUID(ExtensionName, EXT_BAYER_SHARPNESS_MAP, 7d5e0470, 4ea6, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
The Ext::BayerSharpnessMap extension adds internally-generated sharpness metrics to CaptureMetadata r...
The object that controls all operations on a single sensor.
virtual uint32_t maxBurstRequests() const =0
Returns the maximum number of capture requests that can be included in a burst capture.
const uint64_t TIMEOUT_INFINITE
Constant used for infinite timeouts.
Definition: Types.h:96
A unique identifier for an libargus Interface.
Definition: Types.h:322
virtual OutputStreamSettings * createOutputStreamSettings(Status *status=NULL)=0
Creates an OutputStreamSettings object, which is used to configure the settings for OutputStream crea...
virtual Status repeatBurst(const std::vector< const Request * > &requestList)=0
Sets up a repeating burst request.
Settings for OutputStream creation are exposed by the OutputStreamSettings class. ...
Definition: Stream.h:82
virtual Request * createRequest(const CaptureIntent &intent=CAPTURE_INTENT_PREVIEW, uint32_t clientData=0, Status *status=NULL)=0
Creates a request object that can be later used with this CaptureSession.
A top level object class for libargus objects that are created and owned by the client.
Definition: Types.h:380
virtual uint32_t capture(const Request *request, uint64_t timeout=TIMEOUT_INFINITE, Status *status=NULL)=0
Submits a single capture request to the request queue.
virtual uint32_t captureBurst(const std::vector< const Request * > &requestList, uint64_t timeout=TIMEOUT_INFINITE, Status *status=NULL)=0
Submits a burst to the request queue.