Jetson Linux API Reference

39.2 Release
NvSIPLCameraQuery.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
13 #ifndef NVSIPL_CAMERA_QUERY_HPP
14 #define NVSIPL_CAMERA_QUERY_HPP
15 
16 #include "NvSIPLCommon.hpp"
17 #include "NvSIPLCameraTypes.hpp"
18 #include <memory>
19 #include <vector>
20 #include <string>
21 
22 namespace nvsipl {
23 
33  std::vector<sensorconfig::ModuleConfig> coeModuleList;
35  std::vector<sensorconfig::ModuleConfig> gmslModuleList;
38  std::vector<sensorconfig::TransportConfig> coeTransportList;
41  std::vector<sensorconfig::TransportConfig> gmslTransportList;
44 };
45 
53 public:
54 
55  static constexpr uint32_t MAJOR_VER = 1u;
56  static constexpr uint32_t MINOR_VER = 1u;
57  static constexpr uint32_t PATCH_VER = 0u;
58 
60  struct Version {
62  uint32_t uMajor = MAJOR_VER;
64  uint32_t uMinor = MINOR_VER;
66  uint32_t uPatch = PATCH_VER;
67  };
68 
93  static void GetVersion(Version& version);
94 
123  static std::unique_ptr<INvSIPLCameraQuery> GetInstance(void);
124 
150  virtual SIPLStatus ParseDatabase(void) = 0;
151 
181  virtual SIPLStatus ParseJsonFile(std::string fileName) = 0;
182 
207  virtual const CameraDeviceInfoList* GetDeviceInfoList() const = 0;
208 
235  virtual SIPLStatus GetModuleConfig(const std::string& name,
236  sensorconfig::ModuleConfig& oConfig) const = 0;
237 
264  virtual SIPLStatus GetTransportSettings(const std::string& name,
265  sensorconfig::TransportConfig& oSettings) const = 0;
266 
296  virtual SIPLStatus GetSensorSystemConfig(const std::string& name,
297  sensorconfig::SensorSystemConfig& oConfig) const = 0;
298 
306  {
307  LINK_0 = 0x0001,
308  LINK_1 = 0x0010,
309  LINK_2 = 0x0100,
310  LINK_3 = 0x1000
311  };
312 
347  const std::vector<uint32_t>& vMasks) const = 0;
348 
353  virtual const std::vector<std::string>& GetCameraConfigNames() const = 0;
354 
355  virtual ~INvSIPLCameraQuery() = default;
356 };
357 
358 } // namespace nvsipl
359 #endif // NVSIPL_CAMERA_QUERY_HPP
nvsipl::INvSIPLCameraQuery::GetSensorSystemConfig
virtual SIPLStatus GetSensorSystemConfig(const std::string &name, sensorconfig::SensorSystemConfig &oConfig) const =0
Builds a complete sensor system configuration from module template.
nvsipl::CameraDeviceInfoList::coeModuleList
std::vector< sensorconfig::ModuleConfig > coeModuleList
Holds a vector of sensorconfig::ModuleConfig objects for Camera-over-Ethernet (CoE) modules.
Definition: NvSIPLCameraQuery.hpp:33
nvsipl::CameraDeviceInfoList::gmslTransportList
std::vector< sensorconfig::TransportConfig > gmslTransportList
Holds a vector of sensorconfig::TransportConfig objects for GMSL transport configurations.
Definition: NvSIPLCameraQuery.hpp:41
nvsipl::CameraDeviceInfoList
Defines a list of all external image devices supported by SIPL.
Definition: NvSIPLCameraQuery.hpp:30
nvsipl::sensorconfig::SensorSystemConfig
Combined structure describing module configurations and transport configurations.
Definition: NvSIPLCameraTypes.hpp:824
nvsipl::INvSIPLCameraQuery::LINK_2
@ LINK_2
3rd Link
Definition: NvSIPLCameraQuery.hpp:309
nvsipl::INvSIPLCameraQuery::~INvSIPLCameraQuery
virtual ~INvSIPLCameraQuery()=default
nvsipl::INvSIPLCameraQuery::ApplyMask
virtual SIPLStatus ApplyMask(sensorconfig::SensorSystemConfig &sysConfig, const std::vector< uint32_t > &vMasks) const =0
Applies masks to the input sensor system configuration.
nvsipl::INvSIPLCameraQuery::Version
Holds version information for NvSIPLCameraQuery API.
Definition: NvSIPLCameraQuery.hpp:60
NvSIPLCommon.hpp
NVIDIA SIPL: Common Data Structures - SIPL
nvsipl::CameraDeviceInfoList::coeTransportList
std::vector< sensorconfig::TransportConfig > coeTransportList
Holds a vector of sensorconfig::TransportConfig objects for Camera-over-Ethernet transport configurat...
Definition: NvSIPLCameraQuery.hpp:38
nvsipl::CameraDeviceInfoList::gmslModuleList
std::vector< sensorconfig::ModuleConfig > gmslModuleList
Holds a vector of sensorconfig::ModuleConfig objects for GMSL modules.
Definition: NvSIPLCameraQuery.hpp:35
nvsipl::INvSIPLCameraQuery::LINK_0
@ LINK_0
1st Link
Definition: NvSIPLCameraQuery.hpp:307
NvSIPLCameraTypes.hpp
nvsipl::INvSIPLCameraQuery::GetTransportSettings
virtual SIPLStatus GetTransportSettings(const std::string &name, sensorconfig::TransportConfig &oSettings) const =0
Returns transport settings by name.
nvsipl::INvSIPLCameraQuery::MAJOR_VER
static constexpr uint32_t MAJOR_VER
Definition: NvSIPLCameraQuery.hpp:55
nvsipl::INvSIPLCameraQuery::EnableMask
EnableMask
Defines link enable masks for deserializers/transports.
Definition: NvSIPLCameraQuery.hpp:305
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:153
nvsipl::CameraDeviceInfoList::sensorSystemConfig
sensorconfig::SensorSystemConfig sensorSystemConfig
Holds a sensorconfig::SensorSystemConfig object.
Definition: NvSIPLCameraQuery.hpp:43
nvsipl::INvSIPLCameraQuery::GetVersion
static void GetVersion(Version &version)
Returns the library version.
nvsipl::INvSIPLCameraQuery::GetDeviceInfoList
virtual const CameraDeviceInfoList * GetDeviceInfoList() const =0
Returns a pointer to the list of all external image devices supported by NvSIPLCameraQuery API and SI...
nvsipl::INvSIPLCameraQuery::Version::uMinor
uint32_t uMinor
Holds the minor version number.
Definition: NvSIPLCameraQuery.hpp:64
nvsipl::INvSIPLCameraQuery::ParseJsonFile
virtual SIPLStatus ParseJsonFile(std::string fileName)=0
Parses the input JSON file containing a list of user-specified camera configurations.
nvsipl::INvSIPLCameraQuery::GetModuleConfig
virtual SIPLStatus GetModuleConfig(const std::string &name, sensorconfig::ModuleConfig &oConfig) const =0
Returns a ModuleConfig object by name.
nvsipl::INvSIPLCameraQuery::LINK_1
@ LINK_1
2nd Link
Definition: NvSIPLCameraQuery.hpp:308
nvsipl::INvSIPLCameraQuery::GetInstance
static std::unique_ptr< INvSIPLCameraQuery > GetInstance(void)
Gets a handle to an instance of INvSIPLCameraQuery.
nvsipl::INvSIPLCameraQuery::ParseDatabase
virtual SIPLStatus ParseDatabase(void)=0
Parses the built-in JSON database and updates the internal state of the implementation class.
nvsipl::INvSIPLCameraQuery::PATCH_VER
static constexpr uint32_t PATCH_VER
Definition: NvSIPLCameraQuery.hpp:57
nvsipl::INvSIPLCameraQuery::GetCameraConfigNames
virtual const std::vector< std::string > & GetCameraConfigNames() const =0
Returns a list of camera configuration names.
nvsipl::INvSIPLCameraQuery
Defines the public data structures and describes the interfaces for NvSIPLCameraQuery.
Definition: NvSIPLCameraQuery.hpp:52
nvsipl::sensorconfig::TransportConfig
Definition: NvSIPLCameraTypes.hpp:804
nvsipl::INvSIPLCameraQuery::Version::uPatch
uint32_t uPatch
Holds the patch version number.
Definition: NvSIPLCameraQuery.hpp:66
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: NvSIPLCameraQuery.hpp:22
nvsipl::INvSIPLCameraQuery::Version::uMajor
uint32_t uMajor
Holds the major version number.
Definition: NvSIPLCameraQuery.hpp:62
nvsipl::sensorconfig::ModuleConfig
Definition: NvSIPLCameraTypes.hpp:778
nvsipl::INvSIPLCameraQuery::LINK_3
@ LINK_3
4th Link
Definition: NvSIPLCameraQuery.hpp:310
nvsipl::INvSIPLCameraQuery::MINOR_VER
static constexpr uint32_t MINOR_VER
Definition: NvSIPLCameraQuery.hpp:56