Separate public and internal API

Several LIBFREENECT_API macros are removed from identifiers that
are no longer public. Several headers are moved to internal
directory and no longer exported.

Build for Protonect out-of-tree with public API only. This provides
a demo on how to use the public API.

Protonect will be built by default in libfreenect2, controlled with
BUILD_EXAMPLES.

Author: xlz

CMakeLists.txt

@@ -17,6 +17,7 @@ SET(MY_DIR ${libfreenect2_SOURCE_DIR})
 SET(DEPENDS_DIR "${MY_DIR}/depends" CACHE STRING "dependency directory must be set to 'false' if external deps are used")
 
 OPTION(BUILD_SHARED_LIBS "Build shared (ON) or static (OFF) libraries" ON)
+OPTION(BUILD_EXAMPLES "Build examples" ON)
 OPTION(ENABLE_CXX11 "Enable C++11 support" OFF)
 OPTION(ENABLE_OPENCL "Enable OpenCL support" ON)
 OPTION(ENABLE_OPENGL "Enable OpenGL support" ON)
@@ -57,6 +58,7 @@ FIND_PACKAGE(TurboJPEG REQUIRED) #does not provide a package-config file
 # Add includes
 INCLUDE_DIRECTORIES(
   "${MY_DIR}/include"
+  "${MY_DIR}/include/internal"
   ${PROJECT_BINARY_DIR} # for generated headers
   ${LIBFREENECT2_THREADING_INCLUDE_DIR}
   ${LibUSB_INCLUDE_DIRS}
@@ -69,31 +71,31 @@ SET(RESOURCES_INC_FILE "${PROJECT_BINARY_DIR}/resources.inc.h")
 SET(CONFIG_H_FILE "${PROJECT_BINARY_DIR}/libfreenect2/config.h")
 
 SET(SOURCES
-  include/libfreenect2/protocol/command.h
-  include/libfreenect2/protocol/command_transaction.h
-  include/libfreenect2/protocol/response.h
-  include/libfreenect2/protocol/usb_control.h
+  include/internal/libfreenect2/protocol/command.h
+  include/internal/libfreenect2/protocol/command_transaction.h
+  include/internal/libfreenect2/protocol/response.h
+  include/internal/libfreenect2/protocol/usb_control.h
 
-  include/libfreenect2/usb/event_loop.h
-  include/libfreenect2/usb/transfer_pool.h
+  include/internal/libfreenect2/usb/event_loop.h
+  include/internal/libfreenect2/usb/transfer_pool.h
 
   include/libfreenect2/logger.h
-  include/libfreenect2/logging.h
+  include/internal/libfreenect2/logging.h
 
-  include/libfreenect2/async_packet_processor.h  
+  include/internal/libfreenect2/async_packet_processor.h
   include/libfreenect2/depth_packet_processor.h
-  include/libfreenect2/depth_packet_stream_parser.h
-  include/libfreenect2/double_buffer.h
+  include/internal/libfreenect2/depth_packet_stream_parser.h
+  include/internal/libfreenect2/double_buffer.h
   include/libfreenect2/frame_listener.hpp
   include/libfreenect2/frame_listener_impl.h
   include/libfreenect2/libfreenect2.hpp
   include/libfreenect2/packet_pipeline.h
   include/libfreenect2/packet_processor.h
   include/libfreenect2/registration.h
-  include/libfreenect2/resource.h
+  include/internal/libfreenect2/resource.h
   include/libfreenect2/rgb_packet_processor.h
-  include/libfreenect2/rgb_packet_stream_parser.h
-  include/libfreenect2/threading.h
+  include/internal/libfreenect2/rgb_packet_stream_parser.h
+  include/internal/libfreenect2/threading.h
 
   src/transfer_pool.cpp
   src/event_loop.cpp
@@ -220,10 +222,12 @@ CONFIGURE_FILE(freenect2.cmake.in "${PROJECT_BINARY_DIR}/freenect2Config.cmake"
 CONFIGURE_FILE(freenect2.pc.in "${PROJECT_BINARY_DIR}/freenect2.pc" @ONLY)
 
 INSTALL(TARGETS freenect2 DESTINATION lib)
-INSTALL(DIRECTORY "${MY_DIR}/include/" DESTINATION include PATTERN "*.in" EXCLUDE)
+INSTALL(DIRECTORY "${MY_DIR}/include/${PROJECT_NAME}" DESTINATION include PATTERN "*.in" EXCLUDE)
 INSTALL(FILES "${CONFIG_H_FILE}" DESTINATION include/${PROJECT_NAME})
-IF(LIBFREENECT2_THREADING_TINYTHREAD)
-  INSTALL(FILES  "${MY_DIR}/src/tinythread/tinythread.h" DESTINATION include/${PROJECT_NAME}/tinythread/)
-ENDIF(LIBFREENECT2_THREADING_TINYTHREAD)
 INSTALL(FILES "${PROJECT_BINARY_DIR}/freenect2Config.cmake" DESTINATION lib/cmake/freenect2/)
 INSTALL(FILES "${PROJECT_BINARY_DIR}/freenect2.pc" DESTINATION lib/pkgconfig/)
+
+IF(BUILD_EXAMPLES)
+  MESSAGE(STATUS "Configurating examples")
+  ADD_SUBDIRECTORY(${MY_DIR}/examples)
+ENDIF()

examples/CMakeLists.txt

@@ -0,0 +1,80 @@
+CMAKE_MINIMUM_REQUIRED(VERSION 2.8.12.1)
+
+if(WIN32 AND NOT MINGW)
+  if(NOT DEFINED CMAKE_DEBUG_POSTFIX)
+    set(CMAKE_DEBUG_POSTFIX "d")
+  endif()
+endif()
+
+IF(NOT DEFINED CMAKE_BUILD_TYPE)
+  # No effect for multi-configuration generators (e.g. for Visual Studio)
+  SET(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Choose: RelWithDebInfo Release Debug MinSizeRel None")
+ENDIF()
+
+PROJECT(libfreenect2_examples)
+
+SET(MY_DIR ${libfreenect2_examples_SOURCE_DIR})
+SET(DEPENDS_DIR "${MY_DIR}/../depends" CACHE STRING "Dependency directory")
+
+OPTION(ENABLE_OPENGL "Enable OpenGL support" ON)
+
+# The example build system is standalone and will work out-of-tree with these files copied
+SET(freenect2_ROOT_DIR ${MY_DIR}/..)
+SET(flextGL_SOURCES ${freenect2_ROOT_DIR}/src/flextGL.c)
+SET(flextGL_INCLUDE_DIRS ${freenect2_ROOT_DIR}/src) # for flextGL.h
+
+FIND_PACKAGE(PkgConfig)    # try find PKGConfig as it will be used if found
+LIST(APPEND CMAKE_MODULE_PATH ${freenect2_ROOT_DIR}/cmake_modules) # FindGLFW3.cmake
+
+IF(TARGET freenect2)
+  MESSAGE(STATUS "Using in-tree freenect2 target")
+  SET(freenect2_LIBRARIES freenect2)
+ELSE()
+  FIND_PACKAGE(freenect2 REQUIRED)
+ENDIF()
+
+INCLUDE_DIRECTORIES(
+  ${freenect2_INCLUDE_DIR}
+)
+
+LINK_DIRECTORIES(
+  ${freenect2_LIBRARY_DIRS}
+)
+
+SET(Protonect_src
+  Protonect.cpp
+)
+
+SET(Protonect_LIBRARIES
+  ${freenect2_LIBRARIES}
+)
+
+IF(ENABLE_OPENGL)
+  FIND_PACKAGE(GLFW3)
+  FIND_PACKAGE(OpenGL)
+  IF(GLFW3_FOUND AND OPENGL_FOUND)
+    INCLUDE_DIRECTORIES(
+      ${GLFW3_INCLUDE_DIRS}
+      ${flextGL_INCLUDE_DIRS}
+    )
+
+    LINK_DIRECTORIES(${GLFW3_LIBRARY_DIRS})
+    LIST(APPEND Protonect_src
+      viewer.cpp
+      ${flextGL_SOURCES}
+    )
+    LIST(APPEND Protonect_LIBRARIES
+      ${GLFW3_LIBRARIES}
+      ${OPENGL_gl_LIBRARY}
+    )
+    ADD_DEFINITIONS(-DEXAMPLES_WITH_OPENGL_SUPPORT=1)
+  ENDIF()
+ENDIF(ENABLE_OPENGL)
+
+ADD_EXECUTABLE(Protonect
+  ${Protonect_src}
+)
+
+TARGET_LINK_LIBRARIES(Protonect
+  ${Protonect_LIBRARIES}
+)

examples/Protonect.cpp

@@ -31,11 +31,10 @@
 
 #include <libfreenect2/libfreenect2.hpp>
 #include <libfreenect2/frame_listener_impl.h>
-#include <libfreenect2/threading.h>
 #include <libfreenect2/registration.h>
 #include <libfreenect2/packet_pipeline.h>
 #include <libfreenect2/logger.h>
-#ifdef LIBFREENECT2_WITH_OPENGL_SUPPORT
+#ifdef EXAMPLES_WITH_OPENGL_SUPPORT
 #include "viewer.h"
 #endif
 
@@ -186,7 +185,7 @@ int main(int argc, char *argv[])
   libfreenect2::Registration* registration = new libfreenect2::Registration(dev->getIrCameraParams(), dev->getColorCameraParams());
 
   size_t framecount = 0;
-#ifdef LIBFREENECT2_WITH_OPENGL_SUPPORT
+#ifdef EXAMPLES_WITH_OPENGL_SUPPORT
   Viewer viewer;
   if (viewer_enabled)
     viewer.initialize();
@@ -212,7 +211,7 @@ int main(int argc, char *argv[])
       continue;
     }
 
-#ifdef LIBFREENECT2_WITH_OPENGL_SUPPORT
+#ifdef EXAMPLES_WITH_OPENGL_SUPPORT
     viewer.addFrame("RGB", rgb);
     viewer.addFrame("ir", ir);
     viewer.addFrame("depth", depth);

examples/viewer.h

@@ -7,7 +7,7 @@
 #include <string>
 #include <map>
 
-#include <../src/flextGL.h>
+#include "flextGL.h"
 #include <GLFW/glfw3.h>
 
 struct Vertex

freenect2.cmake.in

@@ -7,7 +7,3 @@ FIND_PATH(freenect2_INCLUDE_DIR @PROJECT_NAME@/libfreenect2.hpp
     PATHS @CMAKE_INSTALL_PREFIX@/include
     NO_DEFAULT_PATH
 )
-
-IF("@LIBFREENECT2_THREADING_TINYTHREAD@")
-    SET(freenect2_INCLUDE_DIRS ${freenect2_INCLUDE_DIR} ${freenect2_INCLUDE_DIR}/tinythread)
-ENDIF("@LIBFREENECT2_THREADING_TINYTHREAD@")

…de/libfreenect2/async_packet_processor.h …al/libfreenect2/async_packet_processor.hinclude/libfreenect2/async_packet_processor.h renamed to include/internal/libfreenect2/async_packet_processor.h include/libfreenect2/async_packet_processor.h renamed to include/internal/libfreenect2/async_packet_processor.h

@@ -35,7 +35,7 @@
 namespace libfreenect2
 {
 
-class LIBFREENECT2_API DataCallback
+class DataCallback
 {
 public:
   /**

include/libfreenect2/data_callback.h …de/internal/libfreenect2/data_callback.hinclude/libfreenect2/data_callback.h renamed to include/internal/libfreenect2/data_callback.h include/libfreenect2/data_callback.h renamed to include/internal/libfreenect2/data_callback.h

@@ -43,7 +43,7 @@ namespace libfreenect2
 {
 
 /** Footer of a depth packet. */
-LIBFREENECT2_PACK(struct LIBFREENECT2_API DepthSubPacketFooter
+LIBFREENECT2_PACK(struct DepthSubPacketFooter
 {
   uint32_t magic0;
   uint32_t magic1;
@@ -58,7 +58,7 @@ LIBFREENECT2_PACK(struct LIBFREENECT2_API DepthSubPacketFooter
  * Parser of th depth stream, recognizes valid depth packets in the stream, and
  * passes them on for further processing.
  */
-class LIBFREENECT2_API DepthPacketStreamParser : public DataCallback
+class DepthPacketStreamParser : public DataCallback
 {
 public:
   DepthPacketStreamParser();

…ibfreenect2/depth_packet_stream_parser.h …ibfreenect2/depth_packet_stream_parser.hinclude/libfreenect2/depth_packet_stream_parser.h renamed to include/internal/libfreenect2/depth_packet_stream_parser.h include/libfreenect2/depth_packet_stream_parser.h renamed to include/internal/libfreenect2/depth_packet_stream_parser.h

@@ -36,7 +36,7 @@ namespace libfreenect2
 {
 
 /** Data of a single buffer. */
-struct LIBFREENECT2_API Buffer
+struct Buffer
 {
 public:
   size_t capacity; ///< Capacity of the buffer.
@@ -45,7 +45,7 @@ struct LIBFREENECT2_API Buffer
 };
 
 /** Double bufffer class. */
-class LIBFREENECT2_API DoubleBuffer
+class DoubleBuffer
 {
 public:
   DoubleBuffer();