From bb9b5cc61917ac5c11af434d9ec76c050ba8c620 Mon Sep 17 00:00:00 2001 From: Maik Jurischka Date: Fri, 19 Dec 2025 13:08:28 +0100 Subject: [PATCH] re-organize folder structure --- CMakeLists.txt | 13 +++--- README.md | 45 +++++++++++-------- SOCKET_API.md => docs/SOCKET_API.md | 0 .../vizionstreamer/CameraController.h | 2 +- .../vizionstreamer/GStreamerPipeline.h | 0 .../vizionstreamer/SocketServer.h | 0 .../vizionstreamer/StreamingEngine.h | 2 +- .../CameraController.cpp | 2 +- .../GStreamerPipeline.cpp | 2 +- SocketServer.cpp => src/SocketServer.cpp | 2 +- .../StreamingEngine.cpp | 2 +- main.cpp => src/main.cpp | 4 +- 12 files changed, 43 insertions(+), 31 deletions(-) rename SOCKET_API.md => docs/SOCKET_API.md (100%) rename CameraController.h => include/vizionstreamer/CameraController.h (98%) rename GStreamerPipeline.h => include/vizionstreamer/GStreamerPipeline.h (100%) rename SocketServer.h => include/vizionstreamer/SocketServer.h (100%) rename StreamingEngine.h => include/vizionstreamer/StreamingEngine.h (95%) rename CameraController.cpp => src/CameraController.cpp (99%) rename GStreamerPipeline.cpp => src/GStreamerPipeline.cpp (99%) rename SocketServer.cpp => src/SocketServer.cpp (98%) rename StreamingEngine.cpp => src/StreamingEngine.cpp (99%) rename main.cpp => src/main.cpp (97%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 3481bdb..cf74c8f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,6 +11,9 @@ set(VIZIONSDK_LIB_DIR "${VIZIONSDK_ROOT}/lib") # Add VizionSDK include directory include_directories(${VIZIONSDK_INCLUDE_DIR}) +# Add project include directory +include_directories(${CMAKE_SOURCE_DIR}/include) + # ---------------- GStreamer integration ---------------- find_package(PkgConfig REQUIRED) pkg_check_modules(GSTREAMER REQUIRED gstreamer-1.0) @@ -36,11 +39,11 @@ find_library(VIZIONSDK_LIBRARY # Create executable add_executable(vizionStreamer - main.cpp - SocketServer.cpp - CameraController.cpp - GStreamerPipeline.cpp - StreamingEngine.cpp + src/main.cpp + src/SocketServer.cpp + src/CameraController.cpp + src/GStreamerPipeline.cpp + src/StreamingEngine.cpp ) # Link libraries diff --git a/README.md b/README.md index a28d0c0..18cb47b 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ firefox http://localhost:8080 ## Socket Control API -Full API documentation: [SOCKET_API.md](SOCKET_API.md) +Full API documentation: [SOCKET_API.md](docs/SOCKET_API.md) **Socket Path**: `/tmp/vizion_control.sock` @@ -226,23 +226,32 @@ sudo apt install build-essential cmake pkg-config socat \ ``` vizionStreamer/ -├── main.cpp # Main application -├── SocketServer.{h,cpp} # Unix domain socket server -├── CameraController.{h,cpp} # Command processing & camera control -├── StreamingEngine.{h,cpp} # Acquisition loop & streaming -├── GStreamerPipeline.{h,cpp} # GStreamer pipeline wrapper ├── CMakeLists.txt # Build configuration -├── config/ -│ └── VxConfig.conf # VizionSDK configuration -├── scripts/ # Control scripts -│ ├── README.md -│ ├── start_stream.sh -│ ├── stop_stream.sh -│ ├── get_status.sh -│ ├── set_pipeline_*.sh -│ └── get_formats.sh -├── SOCKET_API.md # Complete API documentation -└── README.md # This file +├── LICENSE # Project license +├── README.md # This file +├── include/ # Public header files +│ └── vizionstreamer/ +│ ├── CameraController.h +│ ├── SocketServer.h +│ ├── StreamingEngine.h +│ └── GStreamerPipeline.h +├── src/ # Implementation files +│ ├── main.cpp +│ ├── CameraController.cpp +│ ├── SocketServer.cpp +│ ├── StreamingEngine.cpp +│ └── GStreamerPipeline.cpp +├── config/ # Configuration files +│ └── VxConfig.conf +├── docs/ # Documentation +│ └── SOCKET_API.md +└── scripts/ # Control scripts + ├── README.md + ├── start_stream.sh + ├── stop_stream.sh + ├── get_status.sh + ├── set_pipeline_*.sh + └── get_formats.sh ``` ## Configuration Files @@ -324,6 +333,6 @@ This software uses the following dependencies: ## Support For issues and questions, refer to: -- [SOCKET_API.md](SOCKET_API.md) - Complete API reference +- [SOCKET_API.md](docs/SOCKET_API.md) - Complete API reference - [scripts/README.md](scripts/README.md) - Script usage guide - VizionSDK documentation at https://developer.technexion.com/docs/vision-software/vizionsdk/ diff --git a/SOCKET_API.md b/docs/SOCKET_API.md similarity index 100% rename from SOCKET_API.md rename to docs/SOCKET_API.md diff --git a/CameraController.h b/include/vizionstreamer/CameraController.h similarity index 98% rename from CameraController.h rename to include/vizionstreamer/CameraController.h index 8917ad4..c456e73 100644 --- a/CameraController.h +++ b/include/vizionstreamer/CameraController.h @@ -9,7 +9,7 @@ #pragma once #include -#include "StreamingEngine.h" +#include "vizionstreamer/StreamingEngine.h" #include #include #include diff --git a/GStreamerPipeline.h b/include/vizionstreamer/GStreamerPipeline.h similarity index 100% rename from GStreamerPipeline.h rename to include/vizionstreamer/GStreamerPipeline.h diff --git a/SocketServer.h b/include/vizionstreamer/SocketServer.h similarity index 100% rename from SocketServer.h rename to include/vizionstreamer/SocketServer.h diff --git a/StreamingEngine.h b/include/vizionstreamer/StreamingEngine.h similarity index 95% rename from StreamingEngine.h rename to include/vizionstreamer/StreamingEngine.h index d97bd79..9993db0 100644 --- a/StreamingEngine.h +++ b/include/vizionstreamer/StreamingEngine.h @@ -9,7 +9,7 @@ #pragma once #include -#include "GStreamerPipeline.h" +#include "vizionstreamer/GStreamerPipeline.h" #include #include #include diff --git a/CameraController.cpp b/src/CameraController.cpp similarity index 99% rename from CameraController.cpp rename to src/CameraController.cpp index 9b0d3e2..7efd644 100644 --- a/CameraController.cpp +++ b/src/CameraController.cpp @@ -6,7 +6,7 @@ * https://creativecommons.org/licenses/by-nc-sa/4.0/ */ -#include "CameraController.h" +#include "vizionstreamer/CameraController.h" #include #include diff --git a/GStreamerPipeline.cpp b/src/GStreamerPipeline.cpp similarity index 99% rename from GStreamerPipeline.cpp rename to src/GStreamerPipeline.cpp index d588864..ada9a13 100644 --- a/GStreamerPipeline.cpp +++ b/src/GStreamerPipeline.cpp @@ -6,7 +6,7 @@ * https://creativecommons.org/licenses/by-nc-sa/4.0/ */ -#include "GStreamerPipeline.h" +#include "vizionstreamer/GStreamerPipeline.h" #include #include #include diff --git a/SocketServer.cpp b/src/SocketServer.cpp similarity index 98% rename from SocketServer.cpp rename to src/SocketServer.cpp index e0a7b13..a814b78 100644 --- a/SocketServer.cpp +++ b/src/SocketServer.cpp @@ -6,7 +6,7 @@ * https://creativecommons.org/licenses/by-nc-sa/4.0/ */ -#include "SocketServer.h" +#include "vizionstreamer/SocketServer.h" #include #include #include diff --git a/StreamingEngine.cpp b/src/StreamingEngine.cpp similarity index 99% rename from StreamingEngine.cpp rename to src/StreamingEngine.cpp index 9d19aeb..8e3538f 100644 --- a/StreamingEngine.cpp +++ b/src/StreamingEngine.cpp @@ -6,7 +6,7 @@ * https://creativecommons.org/licenses/by-nc-sa/4.0/ */ -#include "StreamingEngine.h" +#include "vizionstreamer/StreamingEngine.h" #include #include #include diff --git a/main.cpp b/src/main.cpp similarity index 97% rename from main.cpp rename to src/main.cpp index 2a7edd7..430cbb3 100644 --- a/main.cpp +++ b/src/main.cpp @@ -11,8 +11,8 @@ #include #include #include -#include "SocketServer.h" -#include "CameraController.h" +#include "vizionstreamer/SocketServer.h" +#include "vizionstreamer/CameraController.h" std::atomic g_running(true);