roar_str2codec(3)

💖 roar_str2codec(3) 💖

okay bestie, welcome to the RoarAudio corner of the System Manager's Manual 🌸 today we're doing roar_str2codec(3) — the manual page for the two little codec-name-and-ID translator girlies. yes, both functions live in one page, they're roommates, it's giving iconic duo energy 💅

---

✨ NAME ✨

• roar_str2codec — get a codec ID by its codec name 🎀
• roar_codec2str — get a codec name by its ID 🦋

---

✨ SYNOPSIS ✨

#include <roaraudio.h>

int    roar_str2codec (char * codec);
char * roar_codec2str (int    codec);

---

✨ DESCRIPTION ✨

so roar_str2codec does the thing where you hand it a string and it hands you back a RoarAudio Codec ID. and not just the plain names either — it also knows some common aliases, because of course it does, she's well-connected 💅

roar_codec2str is literally just the reverse move of roar_str2codec: you give it the ID and it gives you a name back. no cap. 🔁

and here's the lil fact that ties it all together: if a codec is valid, then this should be true:

roar_str2codec(roar_codec2str(codec)) == codec

⚠️ but listen, bestie — because of aliasing and case insensitivity, the reverse operation does not need to be true. so don't go assuming round-trips are always a thing, okay? that's just how she is 🙈

---

✨ THREAD SAFETY ✨

okay this part ate 🔥 because roar_codec2str returns a static unique pointer for each codec, that means it's fully thread safe. periodt. no locks, no drama, just vibes 🫶

---

✨ RETURN VALUE ✨

• On success, roar_str2codec returns a codec ID. 🎉
• On error, -1 is returned. 💀
• roar_codec2str returns the name of the codec, or NULL on error. 😭

🚨 real talk though: you must not free this pointer, and you must not write to it either. hands off, bestie, that pointer is not yours 🙅‍♀️

---

✨ EXAMPLES ✨

FIXME 😭 yeah... the examples section is literally just sitting there empty. the author said "not me leaving this blank" and then left it blank. we respect the honesty tho 🍓

---

✨ SEE ALSO ✨

• libroar(7)
• RoarAudio(7)

---

RoarAudio · May 2011 · roar_str2codec(3) 🎀

and that's the whole page babes, tysm for reading, go translate some codecs, mwah 💖✨🦋