编辑 | blame | 历史 | 原始文档

Logo

中文README | VideoPipe Website

Introduction

VideoPipe is a framework for video analysis and structuring, written in C++. It has minimal dependencies and is easy to use. It operates like a pipeline, where each node is independent and can be combined in various ways. VideoPipe can be used to build different types of video analysis applications, suitable for scenarios such as video structuring, image search, face recognition, and behavior analysis in traffic/security fields (such as traffic incident detection).

![](./doc/g1.gif)

Advantages and Features

VideoPipe is similar to NVIDIA's DeepStream and Huawei's mxVision frameworks, but it is easier to use and more portable.

Here is a comparison table:

Name Open Source Learning Curve Supported Platforms Performance Third-Party Dependencies
DeepStream No High NVIDIA only High Many
mxVision No High Huawei only High Many
VideoPipe Yes Low Any platform Medium Few

VideoPipe uses a plugin-oriented coding style that allows for flexible configuration based on different needs. We can use independent plugins (referred to as Node types within the framework) to build various types of video analysis applications. You only need to prepare the model and understand how to parse its output. Inference can be implemented using different backends, such as OpenCV::DNN (default), TensorRT, PaddleInference, ONNXRuntime, or any other backend you prefer.

![](./doc/p1.png)

Demonstration

https://github.com/sherlockchou86/video_pipe_c/assets/13251045/b1289faa-e2c7-4d38-871e-879ae36f6d50

To watch in fullscreen, use the button in the bottom right corner of the player,more video demos

Functions

VideoPipe is a framework that simplifies the integration of computer vision algorithm models. It is important to note that it is not a deep learning framework like TensorFlow or TensorRT. The main features of VideoPipe are as follows:

  • Stream Reading: Supports mainstream video stream protocols such as UDP, RTSP, RTMP, file, and application. It also supports image reading.
  • Video Decoding: Supports video and image decoding based on OpenCV/GStreamer (with hardware acceleration).
  • Algorithm Inference: Supports multi-level inference based on deep learning algorithms, such as object detection, image classification, feature extraction, and image generation. It also supports the integration of traditional image algorithms.
  • Object Tracking: Supports object tracking, such as IOU and SORT tracking algorithms.
  • Behavior Analysis (BA): Supports behavior analysis based on tracking, such as traffic behavior detection like line-crossing, parking, and violations.
  • Business Logic: Allows integration of any custom business logic, which can be closely related to specific business requirements.
  • Data Proxy: Supports pushing structured data (in JSON, XML, or custom formats) to the cloud, files, or other third-party platforms via methods like Kafka or Socket.
  • Recording: Supports video recording for specific time periods and capturing screenshots of specific frames, with the ability to save them as files.
  • On-Screen Display (OSD): Supports overlaying structured data and business logic processing results onto frames.
  • Video Encoding: Supports video and image encoding based on OpenCV/GStreamer (with hardware acceleration).
  • Stream Pushing: Supports mainstream video stream protocols such as UDP, RTSP, RTMP, file, and application. It also supports image streaming.

Getting Started Quickly

Dependencies

Platforms
- Ubuntu 18.04 x86_64 NVIDIA rtx/tesla GPUs
- Ubuntu 18.04 aarch64 NVIDIA jetson serials device,tx2 tested
- Ubuntu 18.04 x86_64 Cambrian MLU serials device, MLU 370 tested (code not provided)
- Ubuntu 18.04 aarch64 Rockchip RK35** serials device, RK3588 tested (code not provided)
- Wait for your test

Basics
- C++ 17
- OpenCV >= 4.6
- GStreamer 1.14.5 (Required by OpenCV)
- GCC >= 7.5

Optional, if you need to implement your own inference backend or use a backend other than opencv::dnn.
- CUDA
- TensorRT
- Paddle Inference
- ONNX Runtime
- Anything you like

how to install CUDA and TensorRT

how to install Paddle_Inference

Compilation and Debugging

  1. run git clone https://github.com/sherlockchou86/VideoPipe.git
  2. run cd VideoPipe
  3. run mkdir build && cd build
  4. run cmake ..
  5. run make -j8

After compilation, all library files are stored in build/libs, and all sample executables are located in build/bin. During Step 4, you can add some compilation options:

  • -DVP_WITH_CUDA=ON (Compile CUDA-related features; default is OFF)
  • -DVP_WITH_TRT=ON (Compile TensorRT-related features and samples; default is OFF)
  • -DVP_WITH_PADDLE=ON (Compile PaddlePaddle-related features and samples; default is OFF)
  • -DVP_WITH_KAFKA=ON (Compile Kafka-related features and samples; default is OFF)
  • -DVP_BUILD_COMPLEX_SAMPLES=ON (Compile advanced samples; default is OFF)

For example, to enable CUDA and TensorRT modules, you can run:
bash cmake -DVP_WITH_CUDA=ON -DVP_WITH_TRT=ON ..
If you run just:
bash cmake ..
all code will be executed on the CPU.

To run the compiled samples, first download the model files and test data:

  1. Google Drive - Download test files and models
  2. Baidu Drive - Download test files and models

Place the downloaded directory (named vp_data) in any location (e.g., /root/abc). Then, run the sample in the same directory where vp_data is located. For example, execute the command:

[path to VideoPipe]/build/bin/1-1-1_sample

at /root/abc.

Note: The ./third_party/ directory contains independent projects. Some are header-only libraries directly referenced by VideoPipe, while others include CPP files that can be compiled or run independently. VideoPipe depends on these libraries, and they will be automatically compiled during the VideoPipe build process. These libraries also contain their own samples; for specific usage instructions, refer to the README files in the corresponding subdirectories.

How to use

Here’s a guide on how to build and run a sample pipeline with VideoPipe. You can either compile VideoPipe as a library and link it, or directly include the source code and compile the entire application.

Below is a sample code demonstrating how to construct a pipeline and run it. Please make sure to update the file paths in the code accordingly:

#include "../nodes/vp_file_src_node.h"
#include "../nodes/infers/vp_yunet_face_detector_node.h"
#include "../nodes/infers/vp_sface_feature_encoder_node.h"
#include "../nodes/osd/vp_face_osd_node_v2.h"
#include "../nodes/vp_screen_des_node.h"
#include "../nodes/vp_rtmp_des_node.h"
#include "../utils/analysis_board/vp_analysis_board.h"

/*
* Name: 1-1-N Sample
* Complete code located at: samples/1-1-N_sample.cpp
* Functionality: 1 video input, 1 video analysis task (face detection and recognition), 2 outputs (screen display/RTMP stream)
*/

int main() {
    VP_SET_LOG_INCLUDE_CODE_LOCATION(false);
    VP_SET_LOG_INCLUDE_THREAD_ID(false);
    VP_LOGGER_INIT();

    // 1. Create nodes
    // Video Source Node
    auto file_src_0 = std::make_shared<vp_nodes::vp_file_src_node>("file_src_0", 0, "./test_video/10.mp4", 0.6);
    
    // 2. Model Inference Nodes
    // First-level inference: Face detection
    auto yunet_face_detector_0 = std::make_shared<vp_nodes::vp_yunet_face_detector_node>("yunet_face_detector_0", "./models/face/face_detection_yunet_2022mar.onnx");
    // Second-level inference: Face recognition
    auto sface_face_encoder_0 = std::make_shared<vp_nodes::vp_sface_feature_encoder_node>("sface_face_encoder_0", "./models/face/face_recognition_sface_2021dec.onnx");
    
    // 3. OSD Node
    // Draw results on frames
    auto osd_0 = std::make_shared<vp_nodes::vp_face_osd_node_v2>("osd_0");
    
    // Screen Display Node
    auto screen_des_0 = std::make_shared<vp_nodes::vp_screen_des_node>("screen_des_0", 0);
    // RTMP Stream Node
    auto rtmp_des_0 = std::make_shared<vp_nodes::vp_rtmp_des_node>("rtmp_des_0", 0, "rtmp://192.168.77.60/live/10000");

    // Build the pipeline by linking the nodes
    yunet_face_detector_0->attach_to({file_src_0});
    sface_face_encoder_0->attach_to({yunet_face_detector_0});
    osd_0->attach_to({sface_face_encoder_0});

    // Split the pipeline automatically to display results on screen and stream via RTMP
    screen_des_0->attach_to({osd_0});
    rtmp_des_0->attach_to({osd_0});

    // Start the pipeline
    file_src_0->start();

    // Visualize the pipeline
    vp_utils::vp_analysis_board board({file_src_0});
    board.display();
}

Note: Running this code will show three displays:
1. Pipeline Status: A live update of the pipeline’s status.
2. Screen Output: The GUI display showing results.
3. RTMP Output: The streaming output available at the specified RTMP URL.

![](./doc/g3.png)

Prototype Examples

ID Sample Screenshot
1 face_tracking_sample ![](./doc/p18.png)
2 vehicle_tracking_sample ![](./doc/p22.png)
3 mask_rcnn_sample ![](./doc/p30.png)
4 openpose_sample ![](./doc/p31.png)
5 face_swap_sample ![](./doc/p57.png)

A total of over 40 prototype examples are available. Click here to view more.

Read More

WeChat Discussion Group

![](./doc/vx.png)

Thanks

Featured|HelloGitHub

编辑 | blame | 历史 | 原始文档
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file 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.
CMakeLists 4 KB
README 11 KB
README_CN 9 KB
SAMPLES 4 KB
doc/about 6 KB
doc/env 5 KB
log/2024-12-21 10 KB
log/2024-12-22 5 KB
log/2024-12-23 599 KB
log/2024-12-24 87 KB
nodes/README 8 KB
nodes/ba/README 711 b
nodes/infers/README 574 b
nodes/osd/README 239 b
nodes/record/README 622 b
nodes/track/deep_sort/README 62 b
nodes/track/sort/README 55 b
samples/CMakeLists 13 KB
samples/README 4 KB
samples/face_recognize/README 3 KB
samples/face_recognize/static/cropped_faces/readme 44 b
samples/lpr_camera/README 3 KB
samples/lpr_camera/static/plate_images/readme 53 b
samples/math_review/README 3 KB
samples/math_review/static/screenshot_images/readme 42 b
samples/similiarity_search/README 5 KB
samples/similiarity_search/static/cropped_images/readme 60 b
samples/similiarity_search/static/query_images/readme 61 b
samples/vehicle_behaviour_analysis/README 4 KB
samples/vehicle_behaviour_analysis/static/record_images/readme 47 b
samples/vehicle_behaviour_analysis/static/record_videos/readme 47 b
samples/vehicle_property_and_similiarity_search/README 4 KB
samples/vehicle_property_and_similiarity_search/static/cropped_images/readme 60 b
samples/vehicle_property_and_similiarity_search/static/query_images/readme 61 b
third_party/bhtsne/README 271 b
third_party/cereal/README 176 b
third_party/cereal/external/rapidxml/license 3 KB
third_party/kissnet/README 172 b
third_party/paddle_ocr/CMakeLists 2 KB
third_party/paddle_ocr/README 1 KB
third_party/rtsp_server/CMakeLists 970 b
third_party/rtsp_server/README 2 KB
third_party/tinyexpr/CMakeLists 569 b
third_party/tinyexpr/README 355 b
third_party/trt_vehicle/CMakeLists 3 KB
third_party/trt_vehicle/README 2 KB
third_party/trt_vehicle/build/CMakeCache 24 KB
third_party/trt_vehicle/build/CMakeFiles/TargetDirectories 858 b
third_party/trt_vehicle/build/CMakeFiles/trt_vehicle.dir/link 4 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle.dir/link 3 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle_cluster.dir/link 3 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle_color_type.dir/link 3 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle_compare.dir/link 3 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle_plate.dir/link 3 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle_scan.dir/link 3 KB
third_party/trt_vehicle/build/CMakeFiles/vehicle_search.dir/link 3 KB
third_party/trt_yolov8/CMakeLists 2 KB
third_party/trt_yolov8/README 3 KB
third_party/trt_yolov8/build/CMakeCache 24 KB
third_party/trt_yolov8/build/CMakeFiles/TargetDirectories 709 b
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8.dir/dlink 825 b
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8.dir/link 4 KB
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8_cls_test.dir/link 3 KB
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8_det_test.dir/link 3 KB
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8_pose_test.dir/link 3 KB
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8_seg_test.dir/link 3 KB
third_party/trt_yolov8/build/CMakeFiles/trt_yolov8_wts_2_engine.dir/link 3 KB
utils/logger/README 2 KB