openni_driver.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2011 Willow Garage, 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:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * 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.
 *   * Neither the name of Willow Garage, Inc. 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 OWNER 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.
 *
 */

#include <pcl/pcl_config.h>
#ifdef HAVE_OPENNI

#ifndef OPENNI_OPENNI_H_
#define OPENNI_OPENNI_H_
#include <string>
#include <vector>
#include <map>
#include "openni_exception.h"
#include "openni_device.h"
#include <boost/shared_ptr.hpp>
#include <boost/weak_ptr.hpp>
#include <XnCppWrapper.h>

#include <pcl/pcl_macros.h>

namespace openni_wrapper
{
  //class OpenNIDevice;

  class PCL_EXPORTS OpenNIDriver
  {
  public:
    ~OpenNIDriver () throw ();

    inline static OpenNIDriver& getInstance ();

    unsigned updateDeviceList ();

    inline unsigned getNumberDevices () const throw ();

    boost::shared_ptr<OpenNIDevice> createVirtualDevice (const std::string& path, bool repeat, bool stream) const;

    boost::shared_ptr<OpenNIDevice> getDeviceByIndex (unsigned index) const;

    boost::shared_ptr<OpenNIDevice> getDeviceBySerialNumber (const std::string& serial_number) const;
    
#ifndef _WIN32

    boost::shared_ptr<OpenNIDevice> getDeviceByAddress (unsigned char bus, unsigned char address) const;
#endif

    const char* getSerialNumber (unsigned index) const throw ();

    const char* getConnectionString (unsigned index) const throw ();

    const char* getVendorName (unsigned index) const throw ();

    const char* getProductName (unsigned index) const throw ();

    unsigned short getVendorID (unsigned index) const throw ();

    unsigned short getProductID (unsigned index) const throw ();

    unsigned char  getBus (unsigned index) const throw ();

    unsigned char  getAddress (unsigned index) const throw ();

    void stopAll ();

    static void
    getDeviceType (const std::string& connection_string, unsigned short& vendorId, unsigned short& productId);
  protected:

    struct PCL_EXPORTS DeviceContext
    {
      DeviceContext (const xn::NodeInfo& device_node, xn::NodeInfo* image_node, xn::NodeInfo* depth_node, xn::NodeInfo * ir_node);
      DeviceContext (const xn::NodeInfo & device_node);
      DeviceContext (const DeviceContext&);
      xn::NodeInfo device_node;
      boost::shared_ptr<xn::NodeInfo> image_node;
      boost::shared_ptr<xn::NodeInfo> depth_node;
      boost::shared_ptr<xn::NodeInfo> ir_node;
      boost::weak_ptr<OpenNIDevice> device;
    } ;

    OpenNIDriver ();
    boost::shared_ptr<OpenNIDevice> getDevice (unsigned index) const;

#ifndef _WIN32
    // workaround to get additional device nformation like serial number, vendor and product name, until Primesense fix this
    void getDeviceInfos () throw ();
#endif

    mutable std::vector<DeviceContext> device_context_;
    mutable xn::Context context_;

    std::map< unsigned char, std::map<unsigned char, unsigned > > bus_map_;
    std::map< std::string, unsigned > serial_map_;
    std::map< std::string, unsigned > connection_string_map_;
  } ;

  OpenNIDriver&
  OpenNIDriver::getInstance ()
  {
    static OpenNIDriver driver;
    return driver;
  }

  unsigned
  OpenNIDriver::getNumberDevices () const throw ()
  {
    return static_cast<unsigned> (device_context_.size ());
  }
} // namespace
#endif
#endif