Go to file
Joni Räsänen 27dc0db42e api: Rename addr to remote_address for clarity 2021-07-28 15:32:59 +03:00
.circleci CI: Add simple CircleCI config.yml for quick build test 2021-06-07 16:12:56 +03:00
docs doc: Update list of subsystems used for commits 2021-06-09 14:11:33 +03:00
include api: Rename addr to remote_address for clarity 2021-07-28 15:32:59 +03:00
src api: Rename addr to remote_address for clarity 2021-07-28 15:32:59 +03:00
.gitignore build: Update .gitignore with build directory 2021-05-18 16:41:42 +03:00
BUILDING.md doc: Update build instructions with c++ version 2021-05-27 12:21:19 +00:00
CMakeLists.txt formats: Combine source files of same class 2021-06-23 17:36:18 +03:00
CONTRIBUTING.md doc: First version of contributing guide 2021-06-09 14:44:09 +03:00
COPYING Update copyright 2021-03-23 01:16:42 +02:00
Doxyfile Add Doxygen main page 2021-03-23 01:19:47 +02:00
README.md doc: Added contributing to readme 2021-06-09 14:47:54 +03:00
uvgRTP.pro formats: Combine source files of same class 2021-06-23 17:36:18 +03:00

README.md

uvgRTP

uvgRTP is an Real-Time Transport Protocol (RTP) library written in C++ with a focus on simple to use and high-efficiency media delivery over the internet. It features an intuitive and easy-to-use Application Programming Interface (API), built-in support for transporting Versitile Video Coding (VVC), High Efficiency Video Coding (HEVC), Advanced Video Coding (AVC) encoded video and Opus encoded audio. uvgRTP also supports End-to-End Encrypted (E2EE) media delivery using the combination of Secure RTP (SRTP) and ZRTP. According to our measurements uvgRTP is able to reach a goodput of 600 MB/s (4K at 700fps) for HEVC stream when measured in LAN. The CPU usage is relative to the goodput value, and therefore smaller streams have a very small CPU usage.

uvgRTP is licensed under the permissive BSD 2-Clause License. For SRTP/ZRTP support, uvgRTP uses Crypto++ library.

Currently supported specifications:

The original version of uvgRTP is based on Marko Viitanen's fRTPlib library.

Notable features

  • Built-in support for:
    • AVC/HEVC/VVC video streaming
    • Opus audio streaming
    • Delivery encryption with SRTP/ZRTP
  • Generic interface for custom media types
  • UDP hole punching
  • Simple to use API
  • Permissive license

Building and linking

See BUILDING.md for instructions on how to build and use uvgRTP

Documentation and examples

See documentation and examples to get a better understanding of uvgRTP

Contributing

We warmly welcome any contributions to the project. If you are thinking about submitting a pull request, please read CONTRIBUTING.md before proceeding.

Paper

If you use uvgRTP in your research, please cite the following paper:

A. Altonen, J. Räsänen, J. Laitinen, M. Viitanen, and J. Vanne, “Open-Source RTP Library for High-Speed 4K HEVC Video Streaming”, in Proc. IEEE Int. Workshop on Multimedia Signal Processing, Tampere, Finland, Sept. 2020.