Skip to content

pwen123/librealsense

Repository files navigation

Intel® RealSense™ Cross Platform API

Whats new? - Summary of changes in librealsense2, including RS400 support, API changes and new functionality.

Platform Build Status
Linux and OS X Build Status
Windows Build status

This project is a cross-platform library (Linux, Windows, Mac) for capturing data from the Intel® RealSense™ SR300 and RS4XX depth cameras.

Developer kits containing the necessary hardware to use this library are available for purchase at this link. This project is separate from the production software stack available in the Intel® RealSense™ SDK, namely that this library only encompasses camera capture functionality without additional computer vision algorithms.

Table of Contents

Useful Links

Documentation

A comprehensive suite of sample and tutorial applications are provided in the /examples subdirectory. For new users, it is best to review the tutorial series of apps which are designed to progressively introduce API features.

  • C API - With doxygen-style API comments
  • To build documentation locally from sources, on Ubuntu run the following commands:
    • sudo apt-get install doxygen
    • doxygen doc/doxygen/doxyfile
  • C API - With doxygen-style API comments
  • Frame Management - Frame Memory Management, Threading Model and Syncronization
  • Frame Metadata - support for frame-metadata attributes
  • Python Bindings - official python bindings for librealsense
  • What's New? - changes in librealsense2
  • Getting Started - Getting started with OpenCV
  • Troubleshooting - Useful tips when debugging issues related to the camera
  • Error Handling - Documents librealsense error handling policy
  • Device specific topics:

Functionality

  1. Native streams: depth, color, infrared and fisheye.
  2. Synthetic streams: rectified images, depth aligned to color and vice versa, etc.
  3. Intrinsic/extrinsic calibration information.
  4. Majority of hardware-specific functionality for individual camera generations (UVC XU controls).
  5. Multi-camera capture across heterogeneous camera architectures
  6. Motion-tracking sensors acquisition

Compatible Devices

  1. RealSense SR300
  2. RealSense RS400/410/430/450

Compatible Platforms

The library is written in standards-conforming C++11 and relies only on the C89 ABI for its public interface. It is developed and tested on the following platforms:

  1. Ubuntu 14/16 LTS (GCC 4.9 toolchain)
  2. Windows 10 (Visual Studio 2015 Update 3)
  3. Mac OS X 10.7+ (Clang toolchain) Temporarily unavailable
  4. Ostro

Hardware Requirements

Developer kits containing the necessary hardware to use this library are available for purchase at this link. In addition, several consumer tablets and laptops with integrated cameras may also function, such as the HP Spectre x2 with R200.

Developer kits require USB 3.0. RealSense™ cameras do not provide backwards compatibility with USB 2.0. Not all USB host chipsets are compatible with this library, although it has been validated with recent generations of the Intel Host Controller chipset. An exhaustive list of incompatible hardware is not presently provided. On x86, a Haswell or newer architecture is recommended.

For small-form factor usages, this library has been demonstrated to work on the following boards:

Integrations

The library has been integrated with a number of third-party components and operating systems. While most of these projects are not directly supported by the team, they are useful resources for users of this library.

Additional language bindings (experimental, community maintained):

License

Copyright 2016 Intel Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project 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.

Releases

No releases published

Packages

No packages published

Languages

  • C++ 51.4%
  • C 33.6%
  • Python 5.9%
  • C# 3.5%
  • Java 2.1%
  • CMake 1.3%
  • Other 2.2%