ImageSource.h

Go to the documentation of this file.

// Copyright 2015 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_ImageSource_h_GUID_C1B68116_0322_4DBD_2360_EF4E6A81D5F4
#define INCLUDED_ImageSource_h_GUID_C1B68116_0322_4DBD_2360_EF4E6A81D5F4

// Internal Includes
// - none

// Library/third-party includes
#include <opencv2/core/core.hpp>
#include <osvr/Util/TimeValue.h>

// Standard includes
#include <memory>

namespace osvr {
namespace vbtracker {
    class ImageSource {
      public:
        virtual ~ImageSource();

        virtual bool ok() const = 0;

        virtual bool grab() = 0;

        virtual void retrieve(cv::Mat &color, cv::Mat &gray,
                              osvr::util::time::TimeValue &timestamp);

        inline void retrieve(cv::Mat &color, cv::Mat &gray) {
            osvr::util::time::TimeValue ts;
            retrieve(color, gray, ts);
        }

        virtual cv::Size resolution() const = 0;

        virtual void retrieveColor(cv::Mat &color,
                                   osvr::util::time::TimeValue &timestamp) = 0;
        inline void retrieveColor(cv::Mat &color) {
            osvr::util::time::TimeValue ts;
            retrieveColor(color, ts);
        }

      protected:
        ImageSource() = default;
    };

    using ImageSourcePtr = std::unique_ptr<ImageSource>;
} // namespace vbtracker
} // namespace osvr
#endif // INCLUDED_ImageSource_h_GUID_C1B68116_0322_4DBD_2360_EF4E6A81D5F4