object_detection_client.hpp

/****************************************************************************
 *
 * Copyright 2025-2026 Auterion AG. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#pragma once
 
#include <auterion_sdk/object_detection/image_detections_2d.hpp>
#include <functional>
#include <memory>
 
namespace auterion {
 
class SDK;
 
using Detections2DCallback = std::function<void(const ImageDetections2D& image_detections)>;
 
class Detections2DSubscription {
   public:
    Detections2DSubscription(const std::shared_ptr<class Detections2DSubscriptionImpl>& impl);
 
    void onUpdate(Detections2DCallback callback);
 
    void subscribe(Detections2DCallback callback = nullptr);
 
    ImageDetections2D last() const;
 
    bool isLastValid() const;
 
   private:
    std::shared_ptr<class Detections2DSubscriptionImpl> _impl;
};
 
class ObjectDetectionClient {
   public:
    explicit ObjectDetectionClient(SDK& sdk);
 
    virtual ~ObjectDetectionClient();
 
    // Make non-copyable and non-movable
    ObjectDetectionClient(const ObjectDetectionClient&) = delete;
    ObjectDetectionClient& operator=(const ObjectDetectionClient&) = delete;
    ObjectDetectionClient(ObjectDetectionClient&&) = delete;
    ObjectDetectionClient& operator=(ObjectDetectionClient&&) = delete;
 
    Detections2DSubscription& detections2D() const;
 
    ObjectDetectionClient& subscribeDetections2D(Detections2DCallback callback = nullptr) {
        detections2D().subscribe(callback);
        return *this;
    }
 
    void enableObjectDetection();
 
    void disableObjectDetection();
 
   private:
    class Impl;
    std::shared_ptr<Impl> _impl;
};
 
}  // namespace auterion