Camera.h

Go to the documentation of this file.

 
/*******************************************************************************
 * This file is part of the Zivid 3D Camera API
 *
 * Copyright 2015-2020 (C) Zivid AS
 * All rights reserved.
 * 
 * Zivid Software License, v1.0
 * 
 * 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 Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 * 
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 * 
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 * 
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS 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.
 *
 * Contact: Zivid Support <support@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include "Zivid/APIExport.h"
#include "Zivid/CameraIntrinsics.h"
#include "Zivid/CameraRevision.h"
#include "Zivid/CameraState.h"
#include "Zivid/ComputeDevice.h"
#include "Zivid/DeviceCloud.h"
#include "Zivid/Frame.h"
#include "Zivid/SerialNumber.h"
#include "Zivid/Settings.h"
#include "Zivid/Settings2D.h"
 
#include <functional>
#include <memory>
 
namespace Zivid
{
    class CloudVisualizer;
    class Frame2D;
 
    class Camera
    {
    public:
        using FrameCallback = std::function<void(Frame)>;
 
        using StateCallback [[deprecated("1.2.0: No longer in use elsewhere")]] = std::function<void(CameraState)>;
 
    public:
        ZIVID_API_EXPORT Camera();
 
        ZIVID_API_EXPORT ~Camera();
 
        ZIVID_API_EXPORT Camera(const Camera &other) noexcept;
 
        ZIVID_API_EXPORT Camera &operator=(const Camera &other) noexcept;
 
        ZIVID_API_EXPORT Camera(Camera &&other) noexcept;
 
        ZIVID_API_EXPORT Camera &operator=(Camera &&other) noexcept;
 
        ZIVID_API_EXPORT Camera &connect();
 
        ZIVID_API_EXPORT Camera &connect(const Settings &settings);
 
        ZIVID_API_EXPORT void disconnect();
 
        ZIVID_API_EXPORT void setSettings(Settings settings);
 
        ZIVID_API_EXPORT Settings settings() const;
 
        ZIVID_API_EXPORT DeviceCloud allocateDeviceCloud();
 
        ZIVID_API_EXPORT CameraState state() const;
 
        ZIVID_API_EXPORT void setComputeDevice(ComputeDevice device);
 
        ZIVID_API_EXPORT void setFrameCallback(FrameCallback callback);
 
        ZIVID_API_EXPORT void startLive();
 
        ZIVID_API_EXPORT void stopLive();
 
        ZIVID_API_EXPORT Frame capture();
 
        ZIVID_API_EXPORT Frame capture(DeviceCloud &deviceCloud);
 
        ZIVID_API_EXPORT Frame2D capture2D(const Settings2D &settings);
 
        ZIVID_API_EXPORT ComputeDevice computeDevice();
 
#ifndef NO_DOC
        ZIVID_API_EXPORT explicit Camera(class CameraImpl &&other);
        ZIVID_API_EXPORT const CameraImpl &getImpl() const;
        ZIVID_API_EXPORT CameraImpl &getImpl();
#endif
        ZIVID_API_EXPORT std::string modelName() const;
 
        ZIVID_API_EXPORT CameraRevision revision() const;
 
        ZIVID_API_EXPORT SerialNumber serialNumber() const;
 
        ZIVID_API_EXPORT std::string firmwareVersion() const;
 
        ZIVID_API_EXPORT size_t userDataMaxSizeBytes() const;
 
        ZIVID_API_EXPORT void writeUserData(const std::vector<uint8_t> &data);
 
        ZIVID_API_EXPORT std::vector<uint8_t> userData() const;
 
        ZIVID_API_EXPORT CameraIntrinsics intrinsics() const;
 
        ZIVID_API_EXPORT std::string toString() const;
 
        ZIVID_API_EXPORT bool operator==(const Camera &other) const;
        ZIVID_API_EXPORT bool operator!=(const Camera &other) const;
 
    private:
        std::shared_ptr<class CameraImpl> m_impl;
    };
 
    ZIVID_API_EXPORT std::ostream &operator<<(std::ostream &stream, const Camera &camera);
 
    class SettingsBatch
    {
    public:
        explicit SettingsBatch(Camera &camera)
            : m_settings{ camera.settings() }
            , m_camera{ camera }
        {}
 
        SettingsBatch(const SettingsBatch &) = delete;
        SettingsBatch &operator=(const SettingsBatch &) = delete;
        SettingsBatch &operator=(SettingsBatch &&) = delete;
 
        SettingsBatch(SettingsBatch &&other) noexcept
            : m_settings{ std::move(other.m_settings) }
            , m_camera{ other.m_camera }
        {
            other.m_apply = false;
        }
 
        ~SettingsBatch() noexcept(false)
        {
            if(m_apply)
            {
                m_camera.setSettings(std::move(m_settings));
            }
        }
 
        template<typename Setting>
        SettingsBatch &set(const Setting &value)
        {
            m_settings.set(value);
            return *this;
        }
 
        template<typename Setting>
        friend SettingsBatch operator<<(SettingsBatch &&setter, Setting value)
        {
            setter.set(value);
            return std::move(setter);
        }
 
    private:
        bool m_apply{ true };
        Settings m_settings;
        Camera &m_camera;
    };
 
    template<typename Setting>
    SettingsBatch operator<<(Camera &camera, Setting value)
    {
        return SettingsBatch{ camera } << value;
    }
} // namespace Zivid