Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
camera_provider.hpp
1 /****************************************************************************
2  *
3  * Copyright 2023 Auterion AG. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  ****************************************************************************/
32 
33 #pragma once
34 
35 #include <rclcpp/rclcpp.hpp>
36 
37 #include "camera.hpp"
38 
39 namespace auterion {
44 class CameraProviderImpl;
45 
54  public:
64  CameraProvider(SDK& sdk, const std::string& device_driver, const std::string& device_identifier,
65  const CameraDescriptor& camera_descriptor);
66  ~CameraProvider() = default;
67 
79  bool configureImage(int width, int height, ImageHeader::Encoding encoding, int step = 0);
80 
89  uint8_t* getImageBuffer(int plane = 0);
90 
95  void publishImageBuffer(const rclcpp::Time& timestamp);
96 
102  bool hasImageSubscribers() const;
103 
108  void publishCameraInfo(const sensor_msgs::msg::CameraInfo& info) const;
109 
110  private:
111  std::shared_ptr<CameraProviderImpl> _impl;
112 };
113 
115 } // namespace auterion
Building block for a camera driver.
Definition: camera_provider.hpp:53
uint8_t * getImageBuffer(int plane=0)
bool hasImageSubscribers() const
bool configureImage(int width, int height, ImageHeader::Encoding encoding, int step=0)
void publishImageBuffer(const rclcpp::Time &timestamp)
void publishCameraInfo(const sensor_msgs::msg::CameraInfo &info) const
CameraProvider(SDK &sdk, const std::string &device_driver, const std::string &device_identifier, const CameraDescriptor &camera_descriptor)
SDK execution class. All callbacks are called on the same thread.
Definition: auterion.hpp:45
Struct describing a camera configuration.
Definition: camera.hpp:229
Encoding
Image encoding, following FourCC.
Definition: camera.hpp:67