_fluid_sample_t Struct Reference

Virtual SoundFont sample. More...

Data Fields

char name [21]
 Sample name.
unsigned int start
 Start index.
unsigned int end
 End index, index of last valid sample point (contrary to SF spec).
unsigned int loopstart
 Loop start index.
unsigned int loopend
 Loop end index, first point following the loop (superimposed on loopstart).
unsigned int samplerate
 Sample rate.
int origpitch
 Original pitch (MIDI note number, 0-127).
int pitchadj
 Fine pitch adjustment (+/- 99 cents).
int sampletype
 Values: FLUID_SAMPLETYPE_MONO, FLUID_SAMPLETYPE_RIGHT, FLUID_SAMPLETYPE_LEFT, FLUID_SAMPLETYPE_ROM.
int valid
 Should be TRUE if sample data is valid, FALSE otherwise (in which case it will not be synthesized).
short * data
 Pointer to the sample's data.
int amplitude_that_reaches_noise_floor_is_valid
 Indicates if amplitude_that_reaches_noise_floor is valid (TRUE), set to FALSE initially to calculate.
double amplitude_that_reaches_noise_floor
 The amplitude at which the sample's loop will be below the noise floor.
unsigned int refcount
 Count of voices using this sample (use fluid_sample_refcount to access this field).
int(* notify )(fluid_sample_t *sample, int reason)
 Implement this function to receive notification when sample is no longer used.
void * userdata
 User defined data.

Detailed Description

Virtual SoundFont sample.


Field Documentation

Indicates if amplitude_that_reaches_noise_floor is valid (TRUE), set to FALSE initially to calculate.

Referenced by fluid_voice_optimize_sample().

The amplitude at which the sample's loop will be below the noise floor.

For voice off optimization, calculated automatically.

Referenced by fluid_voice_optimize_sample().

int(* _fluid_sample_t::notify)(fluid_sample_t *sample, int reason)

Implement this function to receive notification when sample is no longer used.

Parameters:
sample Virtual SoundFont sample
reason FLUID_SAMPLE_DONE only currently
Returns:
Should return FLUID_OK

The documentation for this struct was generated from the following file:
Generated on Mon Sep 6 12:29:28 2010 for libfluidsynth by  doxygen 1.6.3