AFINITBYTEORDER(3)

📦 version 0.3.6, in alpine 3.24, arch rolling, debian bookworm, debian trixie, epel 10, epel 9, fedora 43, fedora 44, nixpkgs unstable, opensuse-leap 16.0, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay so bestie, this page is afInitCompression — it initializes compression for a track in an audio file setup. that's the whole vibe. 🎀

it lives in the Audio File Library manual, section 3, and the header up top literally reads AFINITBYTEORDER(3) — yes the title is a lil cursed and does not match the function, no cap, but the function you actually want is afInitCompression. iykyk. 💅

✨ SYNOPSIS ✨

#include <audiofile.h>

void afInitCompression(AFfilesetup setup, int track, int compression);

🌸 PARAMETERS 🌸

  • setup — a valid file setup, the kind you get back from afNewFileSetup(3). that's your foundation, bestie.
  • track — which track inside the audio file setup we're talking about. for all currently supported file formats, track is always AF_DEFAULT_TRACK. always. no drama.
  • compression — an identifier for the compression type you want, like AF_COMPRESSION_G711_ULAW, used for the audio data in that track.

🦋 DESCRIPTION 🦋

so you've got an AFfilesetup structure that came from afNewFileSetup(3), and you've got a track identified by track (which, reminder, is AF_DEFAULT_TRACK for all currently supported file formats), and afInitCompression does exactly what it says on the tin: it initializes that track to the compression you specified. slay. 🔥

here are the compression types currently supported, and yes i am listing every single one because we don't skip:

  • AF_COMPRESSION_NONE — no compression at all. raw. unbothered. natural.
  • AF_COMPRESSION_G711_ULAW — CCITT G.711 mu-law encoding
  • AF_COMPRESSION_G711_ALAW — CCITT G.711 A-law encoding
  • AF_COMPRESSION_IMA — IMA ADPCM encoding
  • AF_COMPRESSION_MS_ADPCM — MS ADPCM encoding
  • AF_COMPRESSION_FLAC — FLAC
  • AF_COMPRESSION_ALAC — Apple Lossless Audio Codec

😭 ERRORS 😭

afInitCompression can produce the following errors, and when it does, it's giving "read the error code, bestie":

  • AF_BAD_FILESETUP — setup represents an invalid file setup. 🙈
  • AF_BAD_TRACKID — track represents an invalid track identifier.
  • AF_BAD_COMPTYPE — compression represents an invalid compression type. 💀

🌈 SEE ALSO 🌈

👑 AUTHOR 👑

Michael Pruester... no wait, Michael Pruett <michael@68k.org> 💜

and that's the whole page, bestie. this one came out of the Audio File Library 0.3.6, dated 03/06/2013 — iconic behavior honestly, periodt. go forth and compress. 🫶✨

📦 where this page comes from