api: Remove packet processors from public API

Packet processors should not appear in public API. Users never
directly interact with these classes.

Author: xlz

include/internal/libfreenect2/depth_packet_processor.h

@@ -40,7 +40,7 @@ namespace libfreenect2
 {
 
 /** Data packet with depth information. */
-struct LIBFREENECT2_API DepthPacket
+struct DepthPacket
 {
   uint32_t sequence;
   uint32_t timestamp;
@@ -51,11 +51,11 @@ struct LIBFREENECT2_API DepthPacket
 /** Class for processing depth information. */
 typedef PacketProcessor<DepthPacket> BaseDepthPacketProcessor;
 
-class LIBFREENECT2_API DepthPacketProcessor : public BaseDepthPacketProcessor
+class DepthPacketProcessor : public BaseDepthPacketProcessor
 {
 public:
   /** Configuration of depth processing. */
-  struct LIBFREENECT2_API Config
+  struct Config
   {
     float MinDepth;
     float MaxDepth;
@@ -67,7 +67,7 @@ class LIBFREENECT2_API DepthPacketProcessor : public BaseDepthPacketProcessor
   };
 
   /** Parameters of depth processing. */
-  struct LIBFREENECT2_API Parameters
+  struct Parameters
   {
     float ab_multiplier;
     float ab_multiplier_per_frq[3];
@@ -125,7 +125,7 @@ class LIBFREENECT2_API DepthPacketProcessor : public BaseDepthPacketProcessor
 class OpenGLDepthPacketProcessorImpl;
 
 /** Depth packet processor using OpenGL. */
-class LIBFREENECT2_API OpenGLDepthPacketProcessor : public DepthPacketProcessor
+class OpenGLDepthPacketProcessor : public DepthPacketProcessor
 {
 public:
   OpenGLDepthPacketProcessor(void *parent_opengl_context_ptr, bool debug);
@@ -147,7 +147,7 @@ class LIBFREENECT2_API OpenGLDepthPacketProcessor : public DepthPacketProcessor
 class CpuDepthPacketProcessorImpl;
 
 /** Depth packet processor using the CPU. */
-class LIBFREENECT2_API CpuDepthPacketProcessor : public DepthPacketProcessor
+class CpuDepthPacketProcessor : public DepthPacketProcessor
 {
 public:
   CpuDepthPacketProcessor();
@@ -168,7 +168,7 @@ class LIBFREENECT2_API CpuDepthPacketProcessor : public DepthPacketProcessor
 class OpenCLDepthPacketProcessorImpl;
 
 /** Depth packet processor using OpenCL. */
-class LIBFREENECT2_API OpenCLDepthPacketProcessor : public DepthPacketProcessor
+class OpenCLDepthPacketProcessor : public DepthPacketProcessor
 {
 public:
   OpenCLDepthPacketProcessor(const int deviceId = -1);

include/internal/libfreenect2/rgb_packet_processor.h

@@ -40,7 +40,7 @@ namespace libfreenect2
 {
 
 /** Packet with JPEG data. */
-struct LIBFREENECT2_API RgbPacket
+struct RgbPacket
 {
   uint32_t sequence;
 
@@ -56,7 +56,7 @@ struct LIBFREENECT2_API RgbPacket
 typedef PacketProcessor<RgbPacket> BaseRgbPacketProcessor;
 
 /** JPEG processor. */
-class LIBFREENECT2_API RgbPacketProcessor : public BaseRgbPacketProcessor
+class RgbPacketProcessor : public BaseRgbPacketProcessor
 {
 public:
   RgbPacketProcessor();
@@ -68,7 +68,7 @@ class LIBFREENECT2_API RgbPacketProcessor : public BaseRgbPacketProcessor
 };
 
 /** Class for dumping the JPEG information, eg to file. */
-class LIBFREENECT2_API DumpRgbPacketProcessor : public RgbPacketProcessor
+class DumpRgbPacketProcessor : public RgbPacketProcessor
 {
 public:
   DumpRgbPacketProcessor();
@@ -80,7 +80,7 @@ class LIBFREENECT2_API DumpRgbPacketProcessor : public RgbPacketProcessor
 class TurboJpegRgbPacketProcessorImpl;
 
 /** Processor to decode JPEG to image, using TurboJpeg. */
-class LIBFREENECT2_API TurboJpegRgbPacketProcessor : public RgbPacketProcessor
+class TurboJpegRgbPacketProcessor : public RgbPacketProcessor
 {
 public:
   TurboJpegRgbPacketProcessor();

include/libfreenect2/packet_pipeline.h

@@ -30,13 +30,13 @@
 #define PACKET_PIPELINE_H_
 
 #include <libfreenect2/config.h>
-#include <libfreenect2/depth_packet_processor.h>
-#include <libfreenect2/rgb_packet_processor.h>
 
 namespace libfreenect2
 {
 
 class DataCallback;
+class RgbPacketProcessor;
+class DepthPacketProcessor;
 
 /** Packet pipeline for data processing of the device. */
 class LIBFREENECT2_API PacketPipeline
@@ -52,38 +52,27 @@ class LIBFREENECT2_API PacketPipeline
   virtual DepthPacketProcessor *getDepthPacketProcessor() const = 0;
 };
 
-class RgbPacketStreamParser;
-class DepthPacketStreamParser;
+class BasePacketPipelineComponents;
 
 /** Front of the pipeline, RGB and Depth parsing and processing. */
 class LIBFREENECT2_API BasePacketPipeline : public PacketPipeline
 {
-protected:
-  RgbPacketStreamParser *rgb_parser_;
-  DepthPacketStreamParser *depth_parser_;
-
-  RgbPacketProcessor *rgb_processor_;
-  BaseRgbPacketProcessor *async_rgb_processor_;
-  DepthPacketProcessor *depth_processor_;
-  BaseDepthPacketProcessor *async_depth_processor_;
-
-  virtual void initialize();
-  virtual DepthPacketProcessor *createDepthPacketProcessor() = 0;
 public:
+  BasePacketPipeline();
   virtual ~BasePacketPipeline();
 
   virtual PacketParser *getRgbPacketParser() const;
   virtual PacketParser *getIrPacketParser() const;
 
   virtual RgbPacketProcessor *getRgbPacketProcessor() const;
   virtual DepthPacketProcessor *getDepthPacketProcessor() const;
+protected:
+  BasePacketPipelineComponents *comp_;
 };
 
 /** Complete pipe line with depth processing by the CPU. */
 class LIBFREENECT2_API CpuPacketPipeline : public BasePacketPipeline
 {
-protected:
-  virtual DepthPacketProcessor *createDepthPacketProcessor();
 public:
   CpuPacketPipeline();
   virtual ~CpuPacketPipeline();
@@ -96,7 +85,6 @@ class LIBFREENECT2_API OpenGLPacketPipeline : public BasePacketPipeline
 protected:
   void *parent_opengl_context_;
   bool debug_;
-  virtual DepthPacketProcessor *createDepthPacketProcessor();
 public:
   OpenGLPacketPipeline(void *parent_opengl_context = 0, bool debug = false);
   virtual ~OpenGLPacketPipeline();
@@ -109,7 +97,6 @@ class LIBFREENECT2_API OpenCLPacketPipeline : public BasePacketPipeline
 {
 protected:
   const int deviceId;
-  virtual DepthPacketProcessor *createDepthPacketProcessor();
 public:
   OpenCLPacketPipeline(const int deviceId = -1);
   virtual ~OpenCLPacketPipeline();

src/libfreenect2.cpp

@@ -39,6 +39,8 @@
 #include <libfreenect2/usb/event_loop.h>
 #include <libfreenect2/usb/transfer_pool.h>
 #include <libfreenect2/packet_pipeline.h>
+#include <libfreenect2/depth_packet_processor.h>
+#include <libfreenect2/rgb_packet_processor.h>
 #include <libfreenect2/protocol/usb_control.h>
 #include <libfreenect2/protocol/command.h>
 #include <libfreenect2/protocol/response.h>

src/packet_pipeline.cpp

@@ -39,13 +39,28 @@ PacketPipeline::~PacketPipeline()
 {
 }
 
-void BasePacketPipeline::initialize()
+class BasePacketPipelineComponents
+{
+public:
+  RgbPacketStreamParser *rgb_parser_;
+  DepthPacketStreamParser *depth_parser_;
+
+  RgbPacketProcessor *rgb_processor_;
+  BaseRgbPacketProcessor *async_rgb_processor_;
+  DepthPacketProcessor *depth_processor_;
+  BaseDepthPacketProcessor *async_depth_processor_;
+
+  ~BasePacketPipelineComponents();
+  void initialize(RgbPacketProcessor *rgb, DepthPacketProcessor *depth);
+};
+
+void BasePacketPipelineComponents::initialize(RgbPacketProcessor *rgb, DepthPacketProcessor *depth)
 {
   rgb_parser_ = new RgbPacketStreamParser();
   depth_parser_ = new DepthPacketStreamParser();
 
-  rgb_processor_ = new TurboJpegRgbPacketProcessor();
-  depth_processor_ = createDepthPacketProcessor();
+  rgb_processor_ = rgb;
+  depth_processor_ = depth;
 
   async_rgb_processor_ = new AsyncPacketProcessor<RgbPacket>(rgb_processor_);
   async_depth_processor_ = new AsyncPacketProcessor<DepthPacket>(depth_processor_);
@@ -54,7 +69,7 @@ void BasePacketPipeline::initialize()
   depth_parser_->setPacketProcessor(async_depth_processor_);
 }
 
-BasePacketPipeline::~BasePacketPipeline()
+BasePacketPipelineComponents::~BasePacketPipelineComponents()
 {
   delete async_rgb_processor_;
   delete async_depth_processor_;
@@ -64,72 +79,58 @@ BasePacketPipeline::~BasePacketPipeline()
   delete depth_parser_;
 }
 
+BasePacketPipeline::BasePacketPipeline(): comp_(new BasePacketPipelineComponents()) {}
+
+BasePacketPipeline::~BasePacketPipeline()
+{
+  delete comp_;
+}
+
 BasePacketPipeline::PacketParser *BasePacketPipeline::getRgbPacketParser() const
 {
-  return rgb_parser_;
+  return comp_->rgb_parser_;
 }
 
 BasePacketPipeline::PacketParser *BasePacketPipeline::getIrPacketParser() const
 {
-  return depth_parser_;
+  return comp_->depth_parser_;
 }
 
 RgbPacketProcessor *BasePacketPipeline::getRgbPacketProcessor() const
 {
-  return rgb_processor_;
+  return comp_->rgb_processor_;
 }
 
 DepthPacketProcessor *BasePacketPipeline::getDepthPacketProcessor() const
 {
-  return depth_processor_;
+  return comp_->depth_processor_;
 }
 
 CpuPacketPipeline::CpuPacketPipeline()
 { 
-  initialize();
+  comp_->initialize(new TurboJpegRgbPacketProcessor(), new CpuDepthPacketProcessor());
 }
 
 CpuPacketPipeline::~CpuPacketPipeline() { }
 
-DepthPacketProcessor *CpuPacketPipeline::createDepthPacketProcessor()
-{
-  CpuDepthPacketProcessor *depth_processor = new CpuDepthPacketProcessor();
-  
-  return depth_processor;
-}
-
 #ifdef LIBFREENECT2_WITH_OPENGL_SUPPORT
 OpenGLPacketPipeline::OpenGLPacketPipeline(void *parent_opengl_context, bool debug) : parent_opengl_context_(parent_opengl_context), debug_(debug)
 { 
-  initialize();
+  comp_->initialize(new TurboJpegRgbPacketProcessor(), new OpenGLDepthPacketProcessor(parent_opengl_context_, debug_));
 }
 
 OpenGLPacketPipeline::~OpenGLPacketPipeline() { }
-
-DepthPacketProcessor *OpenGLPacketPipeline::createDepthPacketProcessor()
-{
-  OpenGLDepthPacketProcessor *depth_processor = new OpenGLDepthPacketProcessor(parent_opengl_context_, debug_);
-  
-  return depth_processor;
-}
 #endif // LIBFREENECT2_WITH_OPENGL_SUPPORT
 
 
 #ifdef LIBFREENECT2_WITH_OPENCL_SUPPORT
 
 OpenCLPacketPipeline::OpenCLPacketPipeline(const int deviceId) : deviceId(deviceId)
 { 
-  initialize();
+  comp_->initialize(new TurboJpegRgbPacketProcessor(), new OpenCLDepthPacketProcessor(deviceId));
 }
 
 OpenCLPacketPipeline::~OpenCLPacketPipeline() { }
-
-DepthPacketProcessor *OpenCLPacketPipeline::createDepthPacketProcessor()
-{
-  OpenCLDepthPacketProcessor *depth_processor = new OpenCLDepthPacketProcessor(deviceId);
-  
-  return depth_processor;
-}
 #endif // LIBFREENECT2_WITH_OPENCL_SUPPORT
 
 } /* namespace libfreenect2 */