Home
Softono
smolrtsp

smolrtsp

Open source MIT C
485
Stars
117
Forks
0
Issues
20
Watchers
2 weeks
Last Commit

About smolrtsp

![OpenIPC Logo](https://cdn.themactep.com/images/logo_openipc.png) # SmolRTSP [![CI](https://github.com/OpenIPC/smolrtsp/workflows/C/C++%20CI/badge.svg)](https://github.com/OpenIPC/smolrtsp/actions) [![Docs](https://img.shields.io/badge/docs-latest-blue)](https://openipc.github.io/smolrtsp/) SmolRTSP is a simple [RTSP 1.0] server library tailored for embedded devices, such as IP cameras. It supports both TCP and UDP, allows any payload format, and provides a convenient and flexible API. [RTSP 1.0]: https://datatracker.ietf.org/doc/html/rfc2326 ## Highlights - **Small.** SmolRTSP is designed for use in embedded systems (e.g., IP cameras). - **Unopinionated.** You can use SmolRTSP with bare POSIX sockets, [libevent], or any other network framework. - **Zero-copy.** SmolRTSP does not allocate or copy data while parsing. - **Battle-tested.** SmolRTSP is used by [Majestic], an IP camera streamer developed by [OpenIPC]. [libevent]: https://libevent.org/ [array slices]: https://github.com/hirrolot/slice99 ...

Platforms

Web Self-hosted

Languages

C

OpenIPC Logo

SmolRTSP

CI Docs

SmolRTSP is a simple RTSP 1.0 server library tailored for embedded devices, such as IP cameras. It supports both TCP and UDP, allows any payload format, and provides a convenient and flexible API.

Highlights

  • Small. SmolRTSP is designed for use in embedded systems (e.g., IP cameras).
  • Unopinionated. You can use SmolRTSP with bare POSIX sockets, libevent, or any other network framework.
  • Zero-copy. SmolRTSP does not allocate or copy data while parsing.
  • Battle-tested. SmolRTSP is used by Majestic, an IP camera streamer developed by OpenIPC.

Features

  • Supported protocols:
    • [x] RTSP 1.0 (RFC 2326)
    • [x] RTP (RFC 3550)
    • [x] RTP over TCP (interleaved binary data)
    • [x] RTP over UDP
    • [x] SDP (RFC 4566)
    • RTCP (RFC 3550):
      • [x] Sender Report (SR), Receiver Report (RR), SDES (single CNAME), and BYE serialization
  • Supported RTP payload formats:

Installation

If you use CMake, the recommended way is FetchContent:

include(FetchContent)

FetchContent_Declare(
    smolrtsp
    URL https://github.com/OpenIPC/smolrtsp/archive/refs/tags/v1.2.3.tar.gz # v1.2.3
)

FetchContent_MakeAvailable(smolrtsp)

target_link_libraries(MyProject smolrtsp)

Options

Option Description Default
SMOLRTSP_SHARED Build a shared library instead of static. OFF
SMOLRTSP_FULL_MACRO_EXPANSION Show full macro expansion backtraces (DANGEROUS: may impair diagnostics and slow down compilation). OFF

Usage

A simple example server that streams H.264 video and G.711 Mu-Law audio can be found at examples/server.c. The same server can also advertise additional streams: pass -DENABLE_JPEGXS=ON for JPEG XS on the /jpegxs path, -DENABLE_AV1=ON for AV1 on the /av1 path, or -DENABLE_VVC=ON for H.266 / VVC on the /vvc path.

server demo

Run it as follows:

$ mkdir examples/build
$ cd examples/build
$ cmake .. && cmake --build .
$ sudo ./server

Then open a new terminal window to start playing:

$ ffplay rtsp://localhost

Integration

SmolRTSP is agnostic to a network backend: you can run it atop of any network/event loop framework. Currently, we support the following integrations:

Feel free to extend this list with your own integration code.

Release procedure

  1. Update the PROJECT_NUMBER field in Doxyfile.
  2. Update CHANGELOG.md.
  3. Release the project in GitHub Releases.