Change files into groups / modules

This commit is contained in:
Marcus Weseloh 2020-11-04 21:09:13 +01:00
parent d00849b556
commit a11806aa32
17 changed files with 80 additions and 20 deletions

View file

@ -26,9 +26,8 @@ extern "C" {
#endif
/**
* @file audio.h
* @defgroup Audio Audio Output
* @brief Functions for audio driver output.
* @defgroup AudioFunctions Functions for audio output
*
* Defines functions for creating audio driver output. Use
* new_fluid_audio_driver() to create a new audio driver for a given synth
@ -37,6 +36,8 @@ extern "C" {
* audio driver (although it is not as efficient).
*
* @sa @ref CreatingAudioDriver
*
* @{
*/
/**
@ -77,6 +78,8 @@ FLUIDSYNTH_API int fluid_file_set_encoding_quality(fluid_file_renderer_t *dev, d
FLUIDSYNTH_API int fluid_audio_driver_register(const char **adrivers);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -26,10 +26,12 @@ extern "C" {
#endif
/**
* @file event.h
* @defgroup SequencerEvents Sequencer Events
* @brief Sequencer event functions and defines.
*
* Functions and constants for creating/processing sequencer events.
*
* @{
*/
/**
@ -127,6 +129,8 @@ FLUIDSYNTH_API short fluid_event_get_bank(fluid_event_t *evt);
FLUIDSYNTH_API int fluid_event_get_pitch(fluid_event_t *evt);
FLUIDSYNTH_API unsigned int fluid_event_get_sfont_id(fluid_event_t *evt);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -26,8 +26,10 @@ extern "C" {
#endif
/**
* @file gen.h
* @defgroup Generators SoundFont Generators
* @brief Functions and defines for SoundFont generator effects.
*
* @{
*/
/**
@ -122,6 +124,7 @@ enum fluid_gen_type
#endif
};
/* @} */
#ifdef __cplusplus
}

View file

@ -26,7 +26,7 @@ extern "C" {
#endif
/**
* @file ladspa.h
* @defgroup LADSPA LADSPA Interface
* @brief Functions for manipulating the ladspa effects unit
*
* This header defines useful functions for programmatically manipulating the ladspa
@ -34,6 +34,8 @@ extern "C" {
*
* Using any of those functions requires fluidsynth to be compiled with ladspa support.
* Else all of those functions are useless dummies.
*
* @{
*/
FLUIDSYNTH_API int fluid_ladspa_is_active(fluid_ladspa_fx_t *fx);
@ -57,6 +59,8 @@ FLUIDSYNTH_API int fluid_ladspa_effect_set_control(fluid_ladspa_fx_t *fx, const
FLUIDSYNTH_API int fluid_ladspa_effect_link(fluid_ladspa_fx_t *fx, const char *effect_name,
const char *port_name, const char *name);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -28,7 +28,7 @@ extern "C" {
/**
* @file log.h
* @defgroup Logging Logging
* @brief Logging interface
*
* The default logging function of the fluidsynth prints its messages
@ -47,6 +47,8 @@ extern "C" {
* fluid_set_log_function(FLUID_WARN, NULL, NULL);
* fluid_set_log_function(FLUID_DBG, NULL, NULL);
* @endcode
*
* @{
*/
/**
@ -83,6 +85,7 @@ __attribute__ ((format (printf, 2, 3)))
#endif
;
/* @} */
#ifdef __cplusplus
}

View file

@ -26,8 +26,10 @@ extern "C" {
#endif
/**
* @file midi.h
* @defgroup MIDI MIDI
* @brief Functions for MIDI events, drivers and MIDI file playback.
*
* @{
*/
FLUIDSYNTH_API fluid_midi_event_t *new_fluid_midi_event(void);
@ -152,6 +154,8 @@ FLUIDSYNTH_API int fluid_player_seek(fluid_player_t *player, int ticks);
///
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -28,8 +28,10 @@ extern "C" {
/**
* @file misc.h
* @defgroup Misc Miscellaneous
* @brief Miscellaneous utility functions and defines
*
* @{
*/
/**
@ -64,6 +66,7 @@ FLUIDSYNTH_API int fluid_is_soundfont(const char *filename);
FLUIDSYNTH_API int fluid_is_midifile(const char *filename);
FLUIDSYNTH_API void fluid_free(void* ptr);
/* @} */
#ifdef __cplusplus
}

View file

@ -26,8 +26,10 @@ extern "C" {
#endif
/**
* @file mod.h
* @defgroup Modulators SoundFont Modulators
* @brief SoundFont modulator functions and constants.
*
* @{
*/
@ -91,6 +93,8 @@ FLUIDSYNTH_API int fluid_mod_has_dest(const fluid_mod_t *mod, int gen);
FLUIDSYNTH_API void fluid_mod_clone(fluid_mod_t *mod, const fluid_mod_t *src);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -26,8 +26,10 @@ extern "C" {
#endif
/**
* @file seq.h
* @defgroup Sequencer Sequencer
* @brief MIDI event sequencer.
*
* @{
*/
/**
@ -64,6 +66,8 @@ FLUIDSYNTH_API unsigned int fluid_sequencer_get_tick(fluid_sequencer_t *seq);
FLUIDSYNTH_API void fluid_sequencer_set_time_scale(fluid_sequencer_t *seq, double scale);
FLUIDSYNTH_API double fluid_sequencer_get_time_scale(fluid_sequencer_t *seq);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -28,8 +28,11 @@ extern "C" {
#endif
/**
* @file seqbind.h
* @defgroup SequencerBind Sequencer Binding
* @ingroup Sequencer
* @brief Functions for binding sequencer objects to other subsystems.
*
* @{
*/
FLUIDSYNTH_API
@ -37,6 +40,7 @@ fluid_seq_id_t fluid_sequencer_register_fluidsynth(fluid_sequencer_t *seq, fluid
FLUIDSYNTH_API int
fluid_sequencer_add_midi_event_to_buffer(void *data, fluid_midi_event_t *event);
/* @} */
#ifdef __cplusplus
}

View file

@ -26,9 +26,8 @@ extern "C" {
#endif
/**
* @file settings.h
* @brief Synthesizer settings
* @defgroup SettingsFunctions Functions for settings management
* @defgroup Settings Settings
* @brief Functions for settings management
*
* To create a synthesizer object you will have to specify its
* settings. These settings are stored in a fluid_settings_t object.
@ -49,6 +48,8 @@ extern "C" {
* }
* @endcode
* @sa @ref CreatingSettings
*
* @{
*/
/**
@ -181,6 +182,8 @@ FLUIDSYNTH_API
void fluid_settings_foreach(fluid_settings_t *settings, void *data,
fluid_settings_foreach_t func);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -27,7 +27,7 @@ extern "C" {
/**
* @file sfont.h
* @defgroup SoundFont SoundFont Loader
* @brief SoundFont plugins
*
* It is possible to add new SoundFont loaders to the
@ -59,6 +59,8 @@ extern "C" {
* generator, use fluid_voice_gen_set() or fluid_voice_gen_incr(). When you are
* finished initializing the voice call fluid_voice_start() to
* start playing the synthesis voice.
*
* @{
*/
/**
@ -311,6 +313,8 @@ FLUIDSYNTH_API int fluid_sample_set_sound_data(fluid_sample_t *sample,
FLUIDSYNTH_API int fluid_sample_set_loop(fluid_sample_t *sample, unsigned int loop_start, unsigned int loop_end);
FLUIDSYNTH_API int fluid_sample_set_pitch(fluid_sample_t *sample, int root_key, int fine_tune);
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -28,12 +28,14 @@ extern "C" {
/**
* @file shell.h
* @defgroup Shell Command Shell
* @brief Command shell interface
*
* The shell interface allows you to send simple textual commands to
* the synthesizer, to parse a command file, or to read commands
* from the stdin or other input streams.
*
* @{
*/
FLUIDSYNTH_API fluid_istream_t fluid_get_stdin(void);
@ -89,6 +91,7 @@ FLUIDSYNTH_API void delete_fluid_server(fluid_server_t *server);
FLUIDSYNTH_API int fluid_server_join(fluid_server_t *server);
/* @} */
#ifdef __cplusplus
}

View file

@ -28,7 +28,7 @@ extern "C" {
/**
* @file synth.h
* @defgroup Synth Synthesizer
* @brief Embeddable SoundFont synthesizer
*
* You create a new synthesizer with new_fluid_synth() and you destroy
@ -43,6 +43,8 @@ extern "C" {
*
* The API for sending MIDI events is probably what you expect:
* fluid_synth_noteon(), fluid_synth_noteoff(), ...
*
* @{
*/
@ -398,6 +400,7 @@ FLUIDSYNTH_API int fluid_synth_set_breath_mode(fluid_synth_t *synth,
FLUIDSYNTH_API int fluid_synth_get_breath_mode(fluid_synth_t *synth,
int chan, int *breathmode);
/* @} */
#ifdef __cplusplus
}

View file

@ -29,8 +29,10 @@ extern "C" {
/**
* @file types.h
* @defgroup Types Types
* @brief Type declarations
*
* @{
*/
typedef struct _fluid_hashtable_t fluid_settings_t; /**< Configuration settings instance */
@ -74,6 +76,8 @@ typedef __int64 fluid_long_long_t; // even on 32bit windows
typedef long long fluid_long_long_t;
#endif
/* @} */
#ifdef __cplusplus
}
#endif

View file

@ -27,8 +27,10 @@ extern "C" {
#endif
/**
* @file version.h
* @defgroup Version Library Version
* @brief Library version functions and defines
*
* @{
*/
#define FLUIDSYNTH_VERSION @FLUIDSYNTH_VERSION@ /**< String constant of libfluidsynth version. */
@ -39,6 +41,7 @@ extern "C" {
FLUIDSYNTH_API void fluid_version(int *major, int *minor, int *micro);
FLUIDSYNTH_API char* fluid_version_str(void);
/* @} */
#ifdef __cplusplus
}

View file

@ -26,13 +26,15 @@ extern "C" {
#endif
/**
* @file voice.h
* @defgroup VoiceManipulation Voice Manipulation
* @brief Synthesis voice manipulation functions.
*
* The interface to the synthesizer's voices.
* Examples on using them can be found in fluid_defsfont.c.
* Most of these functions should only be called from within synthesis context,
* such as the SoundFont loader's noteon method.
*
* @{
*/
@ -64,6 +66,8 @@ FLUIDSYNTH_API int fluid_voice_is_sostenuto(const fluid_voice_t *voice);
FLUIDSYNTH_API int fluid_voice_optimize_sample(fluid_sample_t *s);
FLUIDSYNTH_API void fluid_voice_update_param(fluid_voice_t *voice, int gen);
/* @} */
#ifdef __cplusplus
}