camera.h

/*
 * BSD 3-Clause License
 *
 * Copyright (c) 2019, Analog Devices, Inc.
 * 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.
 */
#ifndef CAMERA_H
#define CAMERA_H

#include "camera_definitions.h"
#include "sdk_exports.h"
#include "status_definitions.h"

#include <functional>
#include <string>
#include <vector>

namespace aditof {

class Frame;
class DepthSensorInterface;
class StorageInterface;
class TemperatureSensorInterface;

class SDK_API Camera {
  public:
    virtual ~Camera() = default;

    virtual Status initialize() = 0;

    virtual Status start() = 0;

    virtual Status stop() = 0;

    virtual Status setMode(const std::string &mode,
                           const std::string &modeFilename = {}) = 0;

    virtual Status
    getAvailableModes(std::vector<std::string> &availableModes) const = 0;

    virtual Status setFrameType(const std::string &frameType) = 0;

    virtual Status getAvailableFrameTypes(
        std::vector<std::string> &availableFrameTypes) const = 0;

    virtual Status requestFrame(Frame *frame,
                                FrameUpdateCallback cb = nullptr) = 0;

    virtual Status getDetails(CameraDetails &details) const = 0;

    virtual Status
    getAvailableControls(std::vector<std::string> &controls) const = 0;

    virtual Status setControl(const std::string &control,
                              const std::string &value) = 0;

    virtual Status getControl(const std::string &control,
                              std::string &value) const = 0;

    virtual Status getImageSensors(
        std::vector<std::shared_ptr<DepthSensorInterface>> &sensors) = 0;

    virtual Status
    getEeproms(std::vector<std::shared_ptr<StorageInterface>> &eeproms) = 0;

    virtual Status getTemperatureSensors(
        std::vector<std::shared_ptr<TemperatureSensorInterface>> &sensors) = 0;
};

} // namespace aditof

#endif // CAMERA_H