Skip to content

doc/audioutils: Add rtttl-c documentation #18932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linguini1 merged 1 commit into from
May 22, 2026
+24 −0
Merged

doc/audioutils: Add rtttl-c documentation #18932

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions Documentation/applications/audioutils/rtttl-c/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
==========================================
``rtttl-c`` A simple RTTTL parsing library
==========================================

``rtttl-c`` is a simple library for parsing `Ring Tone Text Transfer Language`_
(RTTTL).

.. _Ring Tone Text Transfer Language: https://en.wikipedia.org/wiki/Ring_Tone_Text_Transfer_Language

To use the ``rtttl-c``, first include it from the audioutils::

#include <audioutils/rtttl.h>

then define what to do with a tone::

void
play_tone(struct rtttl_tone tone)
{
/* TODO */
}

and finally play a RTTTL string::

rtttl_play("Jingle Bells:o=5,d=4,b=170,b=170:b,b,b,p,b,b,b,p,b,d6,g.,8a,2b.,8p,c6,c6,c6.,8c6,c6,b,b,8b,8b,b,a,a,b,2a,2d6", play_tone);