AFOPENFILE(3)

💖 AFOPENFILE(3) 💖

okay bestie, welcome to the Audio File Library glow-up zone ✨ this is the page for afOpenFile, and it's literally the moment your audio file gets a handle — like, an actual AFfilehandle — so every other call in the library has something to hold onto. no cap. 🫶

✨ NAME ✨

afOpenFile — open an audio file and create a file handle structure used for subsequent calls to the Audio File Library 🎀

🌸 SYNOPSIS 🌸

#include <audiofile.h>

AFfilehandle afOpenFile(const char *path, const char *mode,
    AFfilesetup setup);

💅 PARAMETERS 💅

• path — the path to the file you wanna open. that's it, that's the vibe. 🗂️
• mode — tells it how you're opening the file: "r" for reading or "w" for writing. pick your fighter. ✨
• setup — an AFfilesetup created by afNewFileSetup(3). here's the tea though: this value is ignored for files opened for reading, except when the file format is AF_FILE_RAWDATA. so raw data is the one exception that gets to be main character. 👑

🌈 RETURN VALUE 🌈

Upon success, afOpenFile returns a valid AFfilehandle which can be used in subsequent calls to the Audio File Library. slay. 🎉

Upon failure, afOpenFile returns NULL and generates an error. not slay. 😭

When you're done with the file, afCloseFile(3) is what you use to close it — don't just ghost it, bestie. 💖

🔥 ERRORS 🔥

afOpenFile can produce the following errors — here's the full roster, no skipping:

• AF_BAD_OPEN — A call to open failed. 💀
• AF_BAD_READ — A call to read failed
• AF_BAD_WRITE — A call to write failed.
• AF_BAD_LSEEK — A call to lseek failed.
• AF_BAD_MALLOC — Memory allocation failed. the malloc said no 💔
• AF_BAD_FILEFMT — setup specifies a file format which is unsupported for mode.
• AF_BAD_SAMPFMT — The file's sample format is not supported.
• AF_BAD_WIDTH — The file's sample width is not supported.
• AF_BAD_RATE — The file's sample rate is not supported.
• AF_BAD_CHANNELS — The number of channels in the file is not supported.
• AF_BAD_FILESETUP — setup specifies an invalid or unsupported configuration.

fr fr, if you get one of these, something about your file or your setup just did not pass the vibe check. 🙈

🦋 SEE ALSO 🦋

• afCloseFile(3)
• afNewFileSetup(3)
• afInitFileFormat(3)
• afInitSampleFormat(3)
• afReadFrames(3)
• afWriteFrames(3)

👑 AUTHOR 👑

Michael Pruett <michael@68k.org> — iconic, we stan 💜

and that's the whole page, bestie!! this was Audio File Library 0.3.6, dated 03/06/2013, and honestly? it ate. go open that file. periodt. 💅✨🌸