Go to file

Joni Räsänen beb0cbc5c7 doc: Fix build instruction link		2021-09-21 06:01:35 +03:00
.circleci	CI: Add simple CircleCI config.yml for quick build test	2021-06-07 16:12:56 +03:00
cmake	version: Rename header to follow same hh format as other headers	2021-09-02 12:28:53 +03:00
docs	tests: Add initial unit tests	2021-09-07 12:23:40 +03:00
include	common: Vastly improve the pull_frame timing	2021-09-16 12:04:38 +03:00
packaging	doc: Fix build instruction link	2021-09-21 06:01:35 +03:00
src	common: Add missing includes needed on Linux	2021-09-16 12:16:08 +03:00
test	doc: Fix file links in automated test description	2021-09-16 16:26:28 +03:00
.gitignore	build: Completely Redesigned CMake files (#44 )	2021-08-08 22:18:40 +02:00
BUILDING.md	doc: Update build instructions with c++ version	2021-05-27 12:21:19 +00:00
CMakeLists.txt	build: Better organize the MSVC project generated by CMake	2021-09-08 11:19:36 +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: Update readme with two disclaimers	2021-09-09 08:08:38 +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 Versatile 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. This cross-platform library can be run on both Linux and Windows operating systems. Mac OS is currently not supported, but contributions are welcome to help with this. For SRTP/ZRTP support, uvgRTP uses Crypto++ library.

uvgRTP is still in its beginning stages, meaning that new bugs are still being found and fixed. You can follow the progress on bug fixes here.

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.