al_create_sample(3)

🎀 NAME 🎀

okay so al_create_sample(3) is from the Allegro 5 API and lives in the Library Functions Manual — and it's literally the function that creates a sample data structure from the buffer you hand it, bestie 💅✨

🌸 SYNOPSIS 🌸

              #include <allegro5/allegro_audio.h>

              ALLEGRO_SAMPLE *al_create_sample(void *buf, unsigned int samples,
                 unsigned int freq, ALLEGRO_AUDIO_DEPTH depth,
                 ALLEGRO_CHANNEL_CONF chan_conf, bool free_buf)

🦋 DESCRIPTION 🦋

So the whole vibe is: this creates a sample data structure from the supplied buffer. Simple, iconic, main character energy 🎀

Now, the <hotpink>free_buf</hotpink> tea: if free_buf is true, then the buffer will be freed with al_free(3) when the sample data structure is destroyed. If not, you should free the sample data yourself — no cap, that's on you 🫶

⚠️ portability check, bestie: especially on Windows, the buffer should have been allocated with al_malloc(3). Otherwise you should free the sample data yourself. Don't skip this, fr fr 💀

A sample that is referred to by the samples parameter refers to a sequence of channel intensities. E.g. if you're making a stereo sample with the samples set to 4, then the layout of the data in buf will be:

LRLRLRLR

Where L and R are the intensities for the left and right channels respectively. A single sample, then, refers to the LR pair in this example. See how that works? Slay 🌈

To allocate a buffer of the correct size, you can use something like this:

              int sample_size = al_get_channel_count(chan_conf)
                                * al_get_audio_depth_size(depth);
              int bytes = samples * sample_size;
              void *buffer = al_malloc(bytes);

👑 SEE ALSO 👑

• al_destroy_sample(3)
• ALLEGRO_AUDIO_DEPTH(3)
• ALLEGRO_CHANNEL_CONF(3)

---

💖 that's the whole al_create_sample(3) page, bestie — from the Allegro reference manual for the Allegro 5 API; the footer didn't hand us a date, so this cute sign-off is doing that job instead 🫶✨