Jetson Linux API Reference

39.2 Release
NvFusaCaptureExternal.hpp
Go to the documentation of this file.
1 /* SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
3  *
4  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
5  * property and proprietary rights in and to this material, related
6  * documentation and any modifications thereto. Any use, reproduction,
7  * disclosure or distribution of this material and related documentation
8  * without an express license agreement from NVIDIA CORPORATION or
9  * its affiliates is strictly prohibited.
10  */
11 
12 #ifndef INCLUDED_FUSA_CAPTURE_EXTERNAL_H
13 #define INCLUDED_FUSA_CAPTURE_EXTERNAL_H
14 
17 #include "nvscibuf.h"
18 
19 #include <cstdint>
20 
27 
58 {
59 public:
69  virtual NvFusaCaptureStatus registerBuffer(NvSciBufObj& buffer) const = 0;
70 
81  virtual NvFusaCaptureStatus unregisterBuffer(NvSciBufObj& buffer) const = 0;
82 
92  virtual NvFusaCaptureStatus startCapture(NvSciBufObj& buffer)
93  {
95  }
96 
108  NvSciBufObj& buffer, const uint32_t timeout)
109  {
111  }
112 
116  virtual ~INvFusaCaptureHandler() = default;
122 protected:
123  INvFusaCaptureHandler() = default;
124 };
125 
130 {
131 public:
137  virtual uint8_t getChannelNumber(void) const noexcept = 0;
138 
142  virtual NvFusaCaptureStatus startCapture(NvSciBufObj& buffer) override = 0;
144  NvSciBufObj& buffer, const uint32_t timeout) override = 0;
150  ~INvFusaCaptureCoeHandler() override = default;
157 protected:
159 };
160 
165 {
166 public:
181  static NvFusaCaptureStatus openCoeHandler(CoeSettings const &settings,
182  INvFusaCaptureCoeHandler ** const handler);
189  static void closeHandler(INvFusaCaptureHandler * const handler);
190 
194  INvFusaCapture() = default;
195  INvFusaCapture(INvFusaCapture const &) = delete;
196  INvFusaCapture(INvFusaCapture &&) = delete;
197  INvFusaCapture& operator=(INvFusaCapture const &) & = delete;
198  INvFusaCapture& operator=(INvFusaCapture &&) & = delete;
199  virtual ~INvFusaCapture() = default;
201 };
202 
203 } // namespace NvFusaCaptureExternal
204 
205 #endif // INCLUDED_FUSA_CAPTURE_EXTERNAL_H
NvFusaCaptureExternal::INvFusaCaptureCoeHandler::INvFusaCaptureCoeHandler
INvFusaCaptureCoeHandler()
Definition: NvFusaCaptureExternal.hpp:158
NvFusaCaptureExternal::INvFusaCaptureHandler::startCapture
virtual NvFusaCaptureStatus startCapture(NvSciBufObj &buffer)
Enqueue a capture to handler.
Definition: NvFusaCaptureExternal.hpp:92
NvFusaCaptureExternal::INvFusaCaptureCoeHandler::startCapture
virtual NvFusaCaptureStatus startCapture(NvSciBufObj &buffer) override=0
NvFusaCaptureExternal::INvFusaCapture::operator=
INvFusaCapture & operator=(INvFusaCapture const &) &=delete
NvFusaCaptureExternal::INvFusaCaptureHandler::~INvFusaCaptureHandler
virtual ~INvFusaCaptureHandler()=default
NvFusaCaptureExternalEnums.hpp
NvFusaCaptureExternal::INvFusaCaptureHandler::operator=
INvFusaCaptureHandler & operator=(INvFusaCaptureHandler &other) &=delete
NvFusaCaptureExternal::INvFusaCaptureCoeHandler::operator=
INvFusaCaptureCoeHandler & operator=(INvFusaCaptureCoeHandler &other) &=delete
NvFusaCaptureExternal::INvFusaCaptureHandler::getCaptureStatus
virtual NvFusaCaptureStatus getCaptureStatus(NvSciBufObj &buffer, const uint32_t timeout)
Gets the capture status.
Definition: NvFusaCaptureExternal.hpp:107
NvFusaCaptureExternal::INvFusaCaptureHandler
Interface INvFusaCaptureHandler, the common interface for all captures handlers.
Definition: NvFusaCaptureExternal.hpp:57
NvFusaCaptureExternal::INvFusaCapture::closeHandler
static void closeHandler(INvFusaCaptureHandler *const handler)
Closes a handler.
NvFusaCaptureExternalStructs.hpp
NvFusaCaptureExternal::INvFusaCapture::INvFusaCapture
INvFusaCapture()=default
NvFusaCaptureExternal::INvFusaCaptureCoeHandler::getChannelNumber
virtual uint8_t getChannelNumber(void) const noexcept=0
Gets the channel number assigned to the CoE handler.
NvFusaCaptureExternal::INvFusaCapture::~INvFusaCapture
virtual ~INvFusaCapture()=default
NvFusaCaptureExternal::INvFusaCaptureHandler::registerBuffer
virtual NvFusaCaptureStatus registerBuffer(NvSciBufObj &buffer) const =0
Registers a buffer with the capture handler.
NvFusaCaptureExternal::INvFusaCapture
Top level interface to interact with fusa capture drivers and handlers.
Definition: NvFusaCaptureExternal.hpp:164
NvFusaCaptureExternal::INvFusaCaptureHandler::INvFusaCaptureHandler
INvFusaCaptureHandler()=default
NvFusaCaptureExternal::INvFusaCaptureCoeHandler
Interface INvFusaCaptureCoeHandler, the interface for camera over ethernet (CoE) handlers.
Definition: NvFusaCaptureExternal.hpp:129
NvFusaCaptureExternal::INvFusaCaptureHandler::unregisterBuffer
virtual NvFusaCaptureStatus unregisterBuffer(NvSciBufObj &buffer) const =0
Unregisters a buffer with the capture handler.
NvFusaCaptureExternal::NvFusaCaptureStatus::NOT_SUPPORTED
@ NOT_SUPPORTED
Unsupported or unimplemented.
NvFusaCaptureExternal::CoeSettings
Structure containing settings for camera over ethernet (CoE) handler setup.
Definition: NvFusaCaptureExternalStructs.hpp:23
NvFusaCaptureExternal::INvFusaCaptureCoeHandler::getCaptureStatus
virtual NvFusaCaptureStatus getCaptureStatus(NvSciBufObj &buffer, const uint32_t timeout) override=0
NvFusaCaptureExternal::NvFusaCaptureStatus
NvFusaCaptureStatus
Defines the status codes returned by functions in NvFusaCaptureExternal namespace.
Definition: NvFusaCaptureExternalEnums.hpp:20
NvFusaCaptureExternal::INvFusaCaptureCoeHandler::~INvFusaCaptureCoeHandler
~INvFusaCaptureCoeHandler() override=default
NvFusaCaptureExternal::INvFusaCapture::openCoeHandler
static NvFusaCaptureStatus openCoeHandler(CoeSettings const &settings, INvFusaCaptureCoeHandler **const handler)
Opens a CoE handler.
NvFusaCaptureExternal
Definition: NvFusaCaptureExternal.hpp:26