Revise class naming conventions

Author: bjsowa

CMakeLists.txt

@@ -43,10 +43,10 @@ endif()
 ## Declare a cpp library
 add_library(${PROJECT_NAME} SHARED
   src/web_video_server.cpp
-  src/base_image_streamer.cpp
-  src/base_image_transport_streamer.cpp
-  src/base_libav_streamer.cpp
+  src/image_transport_streamer.cpp
+  src/libav_streamer.cpp
   src/multipart_stream.cpp
+  src/streamer.cpp
   src/utils.cpp
 )
 

…server/base_image_transport_streamer.hpp …ideo_server/image_transport_streamer.hppinclude/web_video_server/base_image_transport_streamer.hpp renamed to include/web_video_server/image_transport_streamer.hpp include/web_video_server/base_image_transport_streamer.hpp renamed to include/web_video_server/image_transport_streamer.hpp

@@ -43,19 +43,19 @@
 #include "rclcpp/node.hpp"
 #include "sensor_msgs/msg/image.hpp"
 
-#include "web_video_server/base_image_streamer.hpp"
+#include "web_video_server/streamer.hpp"
 
 namespace web_video_server
 {
 
-class BaseImageTransportStreamer : public BaseImageStreamer
+class ImageTransportStreamerBase : public StreamerInterface
 {
 public:
-  BaseImageTransportStreamer(
+  ImageTransportStreamerBase(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
-  virtual ~BaseImageTransportStreamer();
+  virtual ~ImageTransportStreamerBase();
 
   virtual void start();
 
@@ -83,13 +83,13 @@ class BaseImageTransportStreamer : public BaseImageStreamer
   void imageCallback(const sensor_msgs::msg::Image::ConstSharedPtr & msg);
 };
 
-class BaseImageTransportStreamerFactory : public BaseImageStreamerFactory
+class ImageTransportStreamerFactoryBase : public StreamerFactoryInterface
 {
 public:
   virtual std::vector<std::string> get_available_topics(rclcpp::Node::SharedPtr node);
 };
 
-class BaseImageTransportSnapshotStreamerFactory : public BaseSnapshotStreamerFactory
+class ImageTransportSnapshotStreamerFactoryBase : public SnapshotStreamerFactoryInterface
 {
 public:
   virtual std::vector<std::string> get_available_topics(rclcpp::Node::SharedPtr node);

…web_video_server/base_libav_streamer.hpp …lude/web_video_server/libav_streamer.hppinclude/web_video_server/base_libav_streamer.hpp renamed to include/web_video_server/libav_streamer.hpp include/web_video_server/base_libav_streamer.hpp renamed to include/web_video_server/libav_streamer.hpp

@@ -52,22 +52,22 @@ extern "C"
 #include "async_web_server_cpp/http_request.hpp"
 #include "rclcpp/node.hpp"
 
-#include "web_video_server/base_image_streamer.hpp"
-#include "web_video_server/base_image_transport_streamer.hpp"
+#include "web_video_server/image_transport_streamer.hpp"
+#include "web_video_server/streamer.hpp"
 
 namespace web_video_server
 {
 
-class BaseLibavStreamer : public BaseImageTransportStreamer
+class LibavStreamerBase : public ImageTransportStreamerBase
 {
 public:
-  BaseLibavStreamer(
+  LibavStreamerBase(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node, const std::string & format_name, const std::string & codec_name,
     const std::string & content_type);
 
-  ~BaseLibavStreamer();
+  ~LibavStreamerBase();
 
 protected:
   virtual void initializeEncoder() = 0;
@@ -98,7 +98,7 @@ class BaseLibavStreamer : public BaseImageTransportStreamer
   uint8_t * io_buffer_;  // custom IO buffer
 };
 
-class BaseLibavStreamerFactory : public BaseImageTransportStreamerFactory
+class LibavStreamerFactoryBase : public ImageTransportStreamerFactoryBase
 {
 public:
   virtual std::string create_viewer(const async_web_server_cpp::HttpRequest & request);

…web_video_server/base_image_streamer.hpp include/web_video_server/streamer.hppinclude/web_video_server/base_image_streamer.hpp renamed to include/web_video_server/streamer.hpp include/web_video_server/base_image_streamer.hpp renamed to include/web_video_server/streamer.hpp

@@ -43,16 +43,16 @@
 namespace web_video_server
 {
 
-class BaseImageStreamer
+class StreamerInterface
 {
 public:
-  BaseImageStreamer(
+  StreamerInterface(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
 
   virtual void start() = 0;
-  virtual ~BaseImageStreamer();
+  virtual ~StreamerInterface();
 
   bool isInactive()
   {
@@ -77,12 +77,12 @@ class BaseImageStreamer
   std::string topic_;
 };
 
-class BaseImageStreamerFactory
+class StreamerFactoryInterface
 {
 public:
   virtual std::string get_type() = 0;
 
-  virtual std::shared_ptr<BaseImageStreamer> create_streamer(
+  virtual std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node) = 0;
@@ -92,6 +92,6 @@ class BaseImageStreamerFactory
   virtual std::vector<std::string> get_available_topics(rclcpp::Node::SharedPtr node);
 };
 
-class BaseSnapshotStreamerFactory : public BaseImageStreamerFactory {};
+class SnapshotStreamerFactoryInterface : public StreamerFactoryInterface {};
 
 }  // namespace web_video_server

include/web_video_server/streamers/h264_streamer.hpp

@@ -36,13 +36,15 @@
 #include "async_web_server_cpp/http_connection.hpp"
 #include "rclcpp/node.hpp"
 
-#include "web_video_server/base_image_streamer.hpp"
-#include "web_video_server/base_libav_streamer.hpp"
+#include "web_video_server/libav_streamer.hpp"
+#include "web_video_server/streamer.hpp"
 
-namespace web_video_server_streamers
+namespace web_video_server
+{
+namespace streamers
 {
 
-class H264Streamer : public web_video_server::BaseLibavStreamer
+class H264Streamer : public LibavStreamerBase
 {
 public:
   H264Streamer(
@@ -56,14 +58,15 @@ class H264Streamer : public web_video_server::BaseLibavStreamer
   std::string preset_;
 };
 
-class H264StreamerFactory : public web_video_server::BaseLibavStreamerFactory
+class H264StreamerFactory : public LibavStreamerFactoryBase
 {
 public:
   std::string get_type() {return "h264";}
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
 };
 
-}  // namespace web_video_server_streamers
+}  // namespace streamers
+}  // namespace web_video_server

include/web_video_server/streamers/jpeg_streamers.hpp

@@ -40,14 +40,16 @@
 #include "async_web_server_cpp/http_connection.hpp"
 #include "rclcpp/node.hpp"
 
-#include "web_video_server/base_image_streamer.hpp"
-#include "web_video_server/base_image_transport_streamer.hpp"
+#include "web_video_server/image_transport_streamer.hpp"
 #include "web_video_server/multipart_stream.hpp"
+#include "web_video_server/streamer.hpp"
 
-namespace web_video_server_streamers
+namespace web_video_server
+{
+namespace streamers
 {
 
-class MjpegStreamer : public web_video_server::BaseImageTransportStreamer
+class MjpegStreamer : public ImageTransportStreamerBase
 {
 public:
   MjpegStreamer(
@@ -60,21 +62,21 @@ class MjpegStreamer : public web_video_server::BaseImageTransportStreamer
   virtual void sendImage(const cv::Mat &, const std::chrono::steady_clock::time_point & time);
 
 private:
-  web_video_server::MultipartStream stream_;
+  MultipartStream stream_;
   int quality_;
 };
 
-class MjpegStreamerFactory : public web_video_server::BaseImageTransportStreamerFactory
+class MjpegStreamerFactory : public ImageTransportStreamerFactoryBase
 {
 public:
   std::string get_type() {return "mjpeg";}
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
 };
 
-class JpegSnapshotStreamer : public web_video_server::BaseImageTransportStreamer
+class JpegSnapshotStreamer : public ImageTransportStreamerBase
 {
 public:
   JpegSnapshotStreamer(
@@ -89,16 +91,16 @@ class JpegSnapshotStreamer : public web_video_server::BaseImageTransportStreamer
   int quality_;
 };
 
-class JpegSnapshotStreamerFactory : public web_video_server::
-  BaseImageTransportSnapshotStreamerFactory
+class JpegSnapshotStreamerFactory : public ImageTransportSnapshotStreamerFactoryBase
 {
 public:
   std::string get_type() {return "jpeg";}
 
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
 };
 
-}  // namespace web_video_server_streamers
+}  // namespace streamers
+}  // namespace web_video_server

include/web_video_server/streamers/png_streamers.hpp

@@ -40,14 +40,16 @@
 #include "rclcpp/node.hpp"
 #include "sensor_msgs/msg/image.hpp"
 
-#include "web_video_server/base_image_streamer.hpp"
-#include "web_video_server/base_image_transport_streamer.hpp"
+#include "web_video_server/image_transport_streamer.hpp"
 #include "web_video_server/multipart_stream.hpp"
+#include "web_video_server/streamer.hpp"
 
-namespace web_video_server_streamers
+namespace web_video_server
+{
+namespace streamers
 {
 
-class PngStreamer : public web_video_server::BaseImageTransportStreamer
+class PngStreamer : public ImageTransportStreamerBase
 {
 public:
   PngStreamer(
@@ -61,21 +63,21 @@ class PngStreamer : public web_video_server::BaseImageTransportStreamer
   virtual cv::Mat decodeImage(const sensor_msgs::msg::Image::ConstSharedPtr & msg);
 
 private:
-  web_video_server::MultipartStream stream_;
+  MultipartStream stream_;
   int quality_;
 };
 
-class PngStreamerFactory : public web_video_server::BaseImageTransportStreamerFactory
+class PngStreamerFactory : public ImageTransportStreamerFactoryBase
 {
 public:
   std::string get_type() {return "png";}
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
 };
 
-class PngSnapshotStreamer : public web_video_server::BaseImageTransportStreamer
+class PngSnapshotStreamer : public ImageTransportStreamerBase
 {
 public:
   PngSnapshotStreamer(
@@ -91,16 +93,16 @@ class PngSnapshotStreamer : public web_video_server::BaseImageTransportStreamer
   int quality_;
 };
 
-class PngSnapshotStreamerFactory : public web_video_server::
-  BaseImageTransportSnapshotStreamerFactory
+class PngSnapshotStreamerFactory : public ImageTransportSnapshotStreamerFactoryBase
 {
 public:
   std::string get_type() {return "png";}
 
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
 };
 
-}  // namespace web_video_server_streamers
+}  // namespace streamers
+}  // namespace web_video_server

include/web_video_server/streamers/ros_compressed_streamer.hpp

@@ -42,13 +42,15 @@
 #include "rclcpp/subscription.hpp"
 #include "sensor_msgs/msg/compressed_image.hpp"
 
-#include "web_video_server/base_image_streamer.hpp"
 #include "web_video_server/multipart_stream.hpp"
+#include "web_video_server/streamer.hpp"
 
-namespace web_video_server_streamers
+namespace web_video_server
+{
+namespace streamers
 {
 
-class RosCompressedStreamer : public web_video_server::BaseImageStreamer
+class RosCompressedStreamer : public StreamerInterface
 {
 public:
   RosCompressedStreamer(
@@ -66,26 +68,26 @@ class RosCompressedStreamer : public web_video_server::BaseImageStreamer
 
 private:
   void imageCallback(const sensor_msgs::msg::CompressedImage::ConstSharedPtr msg);
-  web_video_server::MultipartStream stream_;
+  MultipartStream stream_;
   rclcpp::Subscription<sensor_msgs::msg::CompressedImage>::SharedPtr image_sub_;
   std::chrono::steady_clock::time_point last_frame_;
   sensor_msgs::msg::CompressedImage::ConstSharedPtr last_msg;
   std::mutex send_mutex_;
   std::string qos_profile_name_;
 };
 
-class RosCompressedStreamerFactory : public web_video_server::BaseImageStreamerFactory
+class RosCompressedStreamerFactory : public StreamerFactoryInterface
 {
 public:
   std::string get_type() {return "ros_compressed";}
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
   std::vector<std::string> get_available_topics(rclcpp::Node::SharedPtr node);
 };
 
-class RosCompressedSnapshotStreamer : public web_video_server::BaseImageStreamer
+class RosCompressedSnapshotStreamer : public StreamerInterface
 {
 public:
   RosCompressedSnapshotStreamer(
@@ -108,15 +110,16 @@ class RosCompressedSnapshotStreamer : public web_video_server::BaseImageStreamer
   std::string qos_profile_name_;
 };
 
-class RosCompressedSnapshotStreamerFactory : public web_video_server::BaseSnapshotStreamerFactory
+class RosCompressedSnapshotStreamerFactory : public SnapshotStreamerFactoryInterface
 {
 public:
   std::string get_type() {return "ros_compressed";}
-  std::shared_ptr<web_video_server::BaseImageStreamer> create_streamer(
+  std::shared_ptr<StreamerInterface> create_streamer(
     const async_web_server_cpp::HttpRequest & request,
     async_web_server_cpp::HttpConnectionPtr connection,
     rclcpp::Node::SharedPtr node);
   std::vector<std::string> get_available_topics(rclcpp::Node::SharedPtr node);
 };
 
-}  // namespace web_video_server_streamers
+}  // namespace streamers
+}  // namespace web_video_server