WildMidi_OpenBuffer(3)

πŸ’– WildMidi_OpenBuffer(3) πŸ’–

okay bestie, welcome to the WildMidi Programmer's Manual β€” yes, the actual manual manual, and yes, we're doing this together 🫢 this one's about feeding WildMidi a midi file that you already have chillin' in memory. no file opening, no drama, just vibes and a buffer.


✨ NAME ✨

WildMidi_OpenBuffer β€” open a midi file buffer for processing 🌸

πŸ“š LIBRARY πŸ“š

libWildMidi

like. that's the library. that's the whole section. she's brief and she knows it πŸ’…

🧚 SYNOPSIS 🧚

#include <wildmidi_lib.h>

midi *WildMidi_OpenBuffer (uint8_t *midibuffer, uint32_t size)

🌈 DESCRIPTION 🌈

okay so the whole point of this function is: you already have a file sitting in memory (you buffered it yourself, main character behavior), and now you want WildMidi to actually do something with it. so you call this. and it opens that buffered file for processing. slay ✨

  • midibuffer β€” this is the memory location of your buffered file, bestie πŸ“ and listen, it needs to be in one of these formats: HMP, HMI, MIDI, or XMIDI. no substitutions, no "I made my own format", okay? and the second you call this function, any changes you make to that buffer afterwards will have no effect β€” it's giving "the door's closed, we've moved on" πŸšͺ✨
  • size β€” the size of the midi file, in bytes, as stored in memory πŸ“

πŸŽ€ RETURN VALUE πŸŽ€

returns NULL on error 😭 otherwise it hands you back a handle for the midi buffer you just opened πŸ‘‘ iconic.

πŸ‘€ SEE ALSO πŸ‘€

go read those too, they're the rest of the friend group πŸ’œ

✍️ AUTHOR ✍️

Chris Ison <chrisisonwildcode@gmail.com> and Bret Curtis <psi29a@gmail.com> β€” thank you kings 🫢

Copyright (C) WildMidi Developers 2001-2016

This file is part of WildMIDI.

WildMIDI is free software: you can redistribute and/or modify the player under the terms of the GNU General Public License and you can redistribute and/or modify the library under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the licenses, or(at your option) any later version.

WildMIDI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU Lesser General Public License for more details.

You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with WildMIDI. If not, see <http://www.gnu.org/licenses/>.

This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.

⚠️ no cap: the "no warranty" bit is real. the legal girlies said what they said.

and that's the whole page!! this one was written down on 10 March 2016, and you're reading WildMidi_OpenBuffer(3) β€” mwah, go buffer something pretty πŸ’…πŸ’–