ImagingRemoteFactory.cpp

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.

// Internal Includes
#include "ImagingRemoteFactory.h"
#include "RemoteHandlerInternals.h"
#include "VRPNConnectionCollection.h"
#include <osvr/Common/ClientContext.h>
#include <osvr/Common/ClientInterface.h>
#include <osvr/Common/PathTreeFull.h>
#include <osvr/Util/ChannelCountC.h>
#include <osvr/Util/UniquePtr.h>
#include <osvr/Common/OriginalSource.h>
#include <osvr/Client/InterfaceTree.h>
#include <osvr/Util/Verbosity.h>
#include <osvr/Common/CreateDevice.h>
#include <osvr/Common/ImagingComponent.h>

// Library/third-party includes
// - none

// Standard includes
// - none

namespace osvr {
namespace client {

    class ImagingRemoteHandler : public RemoteHandler {
      public:
        ImagingRemoteHandler(vrpn_ConnectionPtr const &conn,
                             std::string const &deviceName,
                             boost::optional<OSVR_ChannelCount> sensor,
                             common::InterfaceList &ifaces)
            : m_dev(common::createClientDevice(deviceName, conn)),
              m_internals(ifaces), m_all(!sensor.is_initialized()),
              m_sensor(sensor) {
            auto imaging = common::ImagingComponent::create();
            m_dev->addComponent(imaging);
            imaging->registerImageHandler(
                [&](common::ImageData const &data,
                    util::time::TimeValue const &timestamp) {
                    m_handleImage(data, timestamp);
                });
            OSVR_DEV_VERBOSE("Constructed an ImagingHandler for "
                             << deviceName);
        }

        ImagingRemoteHandler &operator=(ImagingRemoteHandler const &) = delete;

        virtual ~ImagingRemoteHandler() {
        }

        virtual void update() { m_dev->update(); }

      private:
        void m_handleImage(common::ImageData const &data,
                           util::time::TimeValue const &timestamp) {
            if (!m_all && *m_sensor != data.sensor) {
                return;
            }

            OSVR_ImagingReport report;
            report.sensor = data.sensor;
            report.state.metadata = data.metadata;
            report.state.data = data.buffer.get();

            m_internals.forEachInterface(
                [&timestamp, &report, &data](common::ClientInterface &iface) {
                    // Note: not setting state here! we don't store image state.
                    auto n = iface.getNumCallbacksFor(report);
                    for (std::size_t i = 0; i < n; ++i) {
                        // Acquire a reference for each callback we're going to
                        // call.
                        iface.getContext().acquireObject(data.buffer);
                    }
                    iface.triggerCallbacks(timestamp, report);
                });
        }

        common::BaseDevicePtr m_dev;
        RemoteHandlerInternals m_internals;
        bool m_all;
        boost::optional<OSVR_ChannelCount> m_sensor;
    };

    ImagingRemoteFactory::ImagingRemoteFactory(
        VRPNConnectionCollection const &conns)
        : m_conns(conns) {}

    shared_ptr<RemoteHandler> ImagingRemoteFactory::
    operator()(common::OriginalSource const &source,
               common::InterfaceList &ifaces, common::ClientContext &) {

        shared_ptr<RemoteHandler> ret;

        if (source.hasTransform()) {
            OSVR_DEV_VERBOSE(
                "Ignoring transform found on route for Imaging data!");
        }

        auto const &devElt = source.getDeviceElement();

        ret.reset(new ImagingRemoteHandler(
            m_conns.getConnection(devElt), devElt.getFullDeviceName(),
            source.getSensorNumberAsChannelCount(), ifaces));
        return ret;
    }

} // namespace client
} // namespace osvr