libfluidsynth  1.1.11
Macros | Functions
misc.h File Reference

Miscellaneous utility functions and defines. More...

Macros

#define FLUID_OK   (0)
 Value that indicates success, used by most libfluidsynth functions. More...
 
#define FLUID_FAILED   (-1)
 Value that indicates failure, used by most libfluidsynth functions. More...
 

Functions

FLUIDSYNTH_API int fluid_is_soundfont (const char *filename)
 Check if a file is a SoundFont file. More...
 
FLUIDSYNTH_API int fluid_is_midifile (const char *filename)
 Check if a file is a MIDI file. More...
 

Detailed Description

Miscellaneous utility functions and defines.

Macro Definition Documentation

◆ FLUID_OK

#define FLUID_OK   (0)

Value that indicates success, used by most libfluidsynth functions.

Since
1.1.0

NOTE: This was not publicly defined prior to libfluidsynth 1.1.0. When writing code which should also be compatible with older versions, something like the following can be used:

#include <fluidsynth.h>
#ifndef FLUID_OK
#define FLUID_OK (0)
#define FLUID_FAILED (-1)
#endif
Examples
fluidsynth_register_adriver.c.

◆ FLUID_FAILED

#define FLUID_FAILED   (-1)

Value that indicates failure, used by most libfluidsynth functions.

Since
1.1.0

NOTE: See FLUID_OK for more details.

Function Documentation

◆ fluid_is_soundfont()

FLUIDSYNTH_API int fluid_is_soundfont ( const char *  filename)

Check if a file is a SoundFont file.

Parameters
filenamePath to the file to check
Returns
TRUE if it could be a SoundFont, FALSE otherwise
Note
The current implementation only checks for the "RIFF" header in the file. Version >1.1.9 also checks for "sfbk" header. It is useful to distinguish between SoundFont and other (e.g. MIDI) files.

◆ fluid_is_midifile()

FLUIDSYNTH_API int fluid_is_midifile ( const char *  filename)

Check if a file is a MIDI file.

Parameters
filenamePath to the file to check
Returns
TRUE if it could be a MIDI file, FALSE otherwise

The current implementation only checks for the "MThd" header in the file. It is useful only to distinguish between SoundFont and MIDI files.


Generated for libfluidsynth by doxygen 1.8.17