README.md

Roc Toolkit: real-time audio streaming

Roc is a toolkit for real-time audio streaming over the network.

You can read about the project here:

• Overview
• Features

Summary

The toolkit consists of a C library and a set of command-line tools.

Key features:

• real-time streaming with guaranteed latency;
• restoring lost packets using Forward Erasure Correction codes;
• converting between the sender and receiver clock domains;
• CD-quality audio;
• multiple profiles for different CPU and latency requirements;
• portability;
• relying on open, standard protocols.

Besides library and tools, toolkit provides:

• bindings for other programming languages
• modules for sound servers like PulseAudio and PipeWire
• applications

Documentation

Documentation for the latest release is available here.

Additionally, there is also Doxygen-generated documentation for internal modules.

Build status

See details on continuous integration here.

Branch	Status
master
develop

Versioning

See details here:

• GitHub releases
• Changelog
• Development workflow

Platforms

See details here.

If you want to run Roc on an embedded system or a single-board computer, see:

• Cross-compiling
• Tested devices

Plans

See here:

• Project board
• Roadmap

Community

We have a mailing list and an Matrix chat room. See details here.

Contributing

Contributions in any form are always welcome! See contribution guidelines.

Tasks needing help are listed here.

Donating

If you would like to support the project financially, see details on this page.

Thank you!

Licensing

See details on licenses here.

Authors

See a list of maintainers and contributors here.