daala_comment(3)

💖 daala_comment(3) 💖

okay bestie, welcome to the Library Functions Manual entry for daala_comment — yes that's the man page name, and yes we're doing this together, grab a snack 🍓

---

✨ NAME ✨

daala_comment — The comment information. that's it, that's the whole vibe. 💅

---

🌸 SYNOPSIS 🌸

#include <codec.h>

🎀 Data Fields 🎀

• char ** user_comments — The array of comment string vectors. it's giving "a whole lil collection of notes" 📝
• int * comment_lengths — An array of the corresponding lengths of each vector, in bytes. yes babe, one length per vector, matching them up one-to-one 🫶
• int comments — The total number of comment strings. the headcount, if you will 👑
• char * vendor — The null-terminated vendor string. who made this stream?? she tells you 💖

---

🦋 Detailed Description 🦋

The comment information. (iconic, brief, we love her for it ✨)

This structure holds in the in-stream metadata corresponding to the 'comment' header packet. The comment header is meant to be used much like someone jotting a quick note on the label of a disc. It should be a short, to the point text note that can be more than a couple words, but not more than a short paragraph. so like… a sticky note, not a whole essay, bestie 💀

The metadata is stored as a series of (tag, value) pairs, in length-encoded string vectors. The first occurrence of the '=' character delimits the tag and value. A particular tag may occur more than once, and order is significant — no cap, the order actually matters 🔥. The character set encoding for the strings is always UTF-8, but the tag names are limited to ASCII, and treated as case-insensitive. See the Daala specification for details. iykyk 📖

In filling in this structure, daala_decode_header_in() will null-terminate the user_comment strings for safety. However, the bitstream format itself treats them as 8-bit clean vectors, possibly containing null characters, and so the length array should be treated as their authoritative length.

⚠️ bestie listen: those strings might look null-terminated but they can absolutely have null characters hiding inside them. the lengths array is the real one. trust her, not the null. 💀

---

💜 Field Documentation 💜

🌈 char* daala_comment::vendor

The null-terminated vendor string. This identifies the software used to encode the stream. like a lil name tag for the encoder 🏷️✨

---

👑 Author 👑

Generated automatically by Doxygen for daala from the source code. not a human, just a robot doing her best 🫶

---

okay that's the whole page babes 💖 this was daala, Version unknown, and the page is daala_comment(3) — mwah, slay, go read the spec, periodt 💅🎀🦋