Imaging.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_Imaging_h_GUID_5473F500_E901_419D_46D2_62ED5CB57412
#define INCLUDED_Imaging_h_GUID_5473F500_E901_419D_46D2_62ED5CB57412

// Internal Includes
#include <osvr/ClientKit/Imaging_decl.h>
#include <osvr/ClientKit/Interface.h>
#include <osvr/ClientKit/ImagingC.h>
#include <osvr/Util/ImagingReportTypesC.h>
#include <osvr/Util/TimeValue.h>
#include <osvr/Util/Deletable.h>

// Library/third-party includes
#include <boost/shared_ptr.hpp>
#include <boost/noncopyable.hpp>

// Standard includes
// - none

namespace osvr {

namespace clientkit {
    void registerImagingCallback(Interface &iface, ImagingCallback cb,
                                 void *userdata);
#ifndef OSVR_DOXYGEN_EXTERNAL
    namespace detail {
        class ImagingCallbackRegistration : public util::Deletable,
                                            boost::noncopyable {
          public:
            virtual ~ImagingCallbackRegistration() {}

          private:
            ImagingCallbackRegistration(osvr::clientkit::Interface iface,
                                        ImagingCallback cb,
                                        void *userdata)
                : m_cb(cb), m_userdata(userdata),
                  m_ctx(iface.getContext().get()) {
                osvrRegisterImagingCallback(
                    iface.get(),
                    &ImagingCallbackRegistration::handleRawImagingCallback,
                    this);
            }
            class ImagingDeleter {
              public:
                ImagingDeleter(OSVR_ClientContext ctx) : m_ctx(ctx) {}
                void operator()(OSVR_ImageBufferElement *buf) {
                    osvrClientFreeImage(m_ctx, buf);
                }

              private:
                OSVR_ClientContext m_ctx;
            };

            static void
            handleRawImagingCallback(void *userdata,
                                     const struct OSVR_TimeValue *timestamp,
                                     const struct OSVR_ImagingReport *report) {
                ImagingCallbackRegistration *self =
                    static_cast<ImagingCallbackRegistration *>(userdata);
                ImagingReport newReport;
                newReport.sensor = report->sensor;
                newReport.metadata = report->state.metadata;
                newReport.buffer.reset(report->state.data,
                                       ImagingDeleter(self->m_ctx));
                self->m_cb(self->m_userdata, *timestamp, newReport);
            }

            ImagingCallback m_cb;
            void *m_userdata;
            OSVR_ClientContext m_ctx;
            friend void osvr::clientkit::registerImagingCallback(
                Interface &iface, ImagingCallback cb, void *userdata);
        };
    } // namespace detail

#endif // OSVR_DOXYGEN_EXTERNAL

    inline void registerImagingCallback(Interface &iface,
                                        ImagingCallback cb,
                                        void *userdata) {
        util::boost_util::DeletablePtr ptr(
            new detail::ImagingCallbackRegistration(iface, cb, userdata));
        iface.takeOwnership(ptr);
    }


} // end namespace clientkit

} // end namespace osvr

#endif // INCLUDED_Imaging_h_GUID_5473F500_E901_419D_46D2_62ED5CB57412