sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated the shared library bindings

Browse source
This commit is contained in:
Paul Ferrand 2019-12-01 23:17:50 +01:00
parent 030e0c16ee
commit 30bf269359
2 changed files with 208 additions and 134 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

259
src/sfizz.h
View file

@ -33,143 +33,155 @@ extern "C" {
#endif #endif
typedef struct sfizz_synth_t sfizz_synth_t; typedef struct sfizz_synth_t sfizz_synth_t;
typedef enum {
SFIZZ_OVERSAMPLING_X1 = 1,
SFIZZ_OVERSAMPLING_X2 = 2,
SFIZZ_OVERSAMPLING_X4 = 4,
SFIZZ_OVERSAMPLING_X8 = 8
} sfizz_oversampling_factor_t;
/** /**
* @brief Creates a sfizz synth. * @brief Creates a sfizz synth. This object has to be freed by the caller
* This object has to be freed by the caller using sfizz_free(). * using sfizz_free().
* *
* @return sfizz_synth_t* * @return sfizz_synth_t*
*/ */
sfizz_synth_t* sfizz_create_synth(); sfizz_synth_t* sfizz_create_synth();
/** /**
* @brief Frees an existing sfizz synth. * @brief Frees an existing sfizz synth.
* *
* @param synth The synth to destroy * @param synth The synth to destroy
*/ */
void sfizz_free(sfizz_synth_t* synth); void sfizz_free(sfizz_synth_t* synth);
/** /**
* @brief Loads an SFZ file. * @brief Loads an SFZ file. The file path can be absolute or relative. All
* The file path can be absolute or relative. All file operations for this SFZ file will be relative to the parent directory of the SFZ file. * file operations for this SFZ file will be relative to the parent
* directory of the SFZ file.
* *
* @param synth The sfizz synth. * @param synth The sfizz synth.
* @param path A null-terminated string representing a path to an SFZ file. * @param path A null-terminated string representing a path to an SFZ
* @return true when file loading went OK. * file.
* @return false if some error occured while loading. *
* @return true when file loading went OK.
* @return false if some error occured while loading.
*/ */
bool sfizz_load_file(sfizz_synth_t* synth, const char* path); bool sfizz_load_file(sfizz_synth_t* synth, const char* path);
/** /**
* @brief Returns the number of regions in the currently loaded SFZ file. * @brief Returns the number of regions in the currently loaded SFZ file.
* *
* @param synth * @param synth The synth
* @return int the number of regions *
* @return int the number of regions
*/ */
int sfizz_get_num_regions(sfizz_synth_t* synth); int sfizz_get_num_regions(sfizz_synth_t* synth);
/** /**
* @brief Returns the number of groups in the currently loaded SFZ file. * @brief Returns the number of groups in the currently loaded SFZ file.
* *
* @param synth * @param synth The synth
* @return int the number of groups *
* @return int the number of groups
*/ */
int sfizz_get_num_groups(sfizz_synth_t* synth); int sfizz_get_num_groups(sfizz_synth_t* synth);
/** /**
* @brief Returns the number of masters in the currently loaded SFZ file. * @brief Returns the number of masters in the currently loaded SFZ file.
* *
* @param synth * @param synth The synth
* @return int the number of masters *
* @return int the number of masters
*/ */
int sfizz_get_num_masters(sfizz_synth_t* synth); int sfizz_get_num_masters(sfizz_synth_t* synth);
/** /**
* @brief Returns the number of curves in the currently loaded SFZ file. * @brief Returns the number of curves in the currently loaded SFZ file.
* *
* @param synth * @param synth The synth
* @return int the number of curves *
* @return int the number of curves
*/ */
int sfizz_get_num_curves(sfizz_synth_t* synth); int sfizz_get_num_curves(sfizz_synth_t* synth);
/** /**
* @brief Returns the number of preloaded samples for the current SFZ file. * @brief Returns the number of preloaded samples for the current SFZ file.
* *
* @param synth * @param synth The synth
* @return int the number of preloaded samples *
* @return int the number of preloaded samples
*/ */
int sfizz_get_num_preloaded_samples(sfizz_synth_t* synth); int sfizz_get_num_preloaded_samples(sfizz_synth_t* synth);
/** /**
* @brief Returns the number of active voices. * @brief Returns the number of active voices. Note that this function is a
* Note that this function is a basic indicator and does not aim to be perfect. * basic indicator and does not aim to be perfect. In particular, it
* In particular, it runs on the calling thread so voices may well start or stop * runs on the calling thread so voices may well start or stop while
* while the function is checking which voice is active. * the function is checking which voice is active.
* *
* @param synth * @param synth The synth
* @return int the number of playing voices *
* @return int the number of playing voices
*/ */
int sfizz_get_num_active_voices(sfizz_synth_t* synth); int sfizz_get_num_active_voices(sfizz_synth_t* synth);
/** /**
* @brief Sets the expected number of samples per block. * @brief Sets the expected number of samples per block. If unsure, give an
* If unsure, give an upper bound since right now ugly things may happen if you * upper bound since right now ugly things may happen if you go over
* go over this number. * this number.
* *
* @param synth * @param synth The synth
* @param samples_per_block the number of samples per block * @param samples_per_block the number of samples per block
*/ */
void sfizz_set_samples_per_block(sfizz_synth_t* synth, int samples_per_block); void sfizz_set_samples_per_block(sfizz_synth_t* synth, int samples_per_block);
/** /**
* @brief Sets the sample rate for the synth. * @brief Sets the sample rate for the synth. This is the output sample
* This is the output sample rate. This setting does not affect the internal * rate. This setting does not affect the internal processing.
* processing.
* *
* @param synth * @param synth The synth
* @param sample_rate the sample rate * @param sample_rate the sample rate
*/ */
void sfizz_set_sample_rate(sfizz_synth_t* synth, float sample_rate); void sfizz_set_sample_rate(sfizz_synth_t* synth, float sample_rate);
/** /**
* @brief Send a note on event to the synth. * @brief Send a note on event to the synth. As with all MIDI events, this
* As with all MIDI events, this needs to happen before the call to sfizz_render_block * needs to happen before the call to sfizz_render_block in each
* in each block. * block.
* *
* @param synth * @param synth The synth
* @param delay the delay of the event in the block, in samples. * @param delay the delay of the event in the block, in samples.
* @param channel the MIDI channel; currently starts at 1 (FIXME) * @param channel the MIDI channel; currently starts at 1 (FIXME)
* @param note_number the MIDI note number * @param note_number the MIDI note number
* @param velocity the MIDI velocity * @param velocity the MIDI velocity
*/ */
void sfizz_send_note_on(sfizz_synth_t* synth, int delay, int channel, int note_number, char velocity); void sfizz_send_note_on(sfizz_synth_t* synth, int delay, int channel, int note_number, char velocity);
/** /**
* @brief Send a note off event to the synth. * @brief Send a note off event to the synth. As with all MIDI events, this
* As with all MIDI events, this needs to happen before the call to sfizz_render_block * needs to happen before the call to sfizz_render_block in each
* in each block. As per the SFZ spec the velocity of note-off events is usually replaced * block. As per the SFZ spec the velocity of note-off events is
* by the note-on velocity. * usually replaced by the note-on velocity.
* *
* @param synth * @param synth The synth
* @param delay the delay of the event in the block, in samples. * @param delay the delay of the event in the block, in samples.
* @param channel the MIDI channel; currently starts at 1 (FIXME) * @param channel the MIDI channel; currently starts at 1 (FIXME)
* @param note_number the MIDI note number * @param note_number the MIDI note number
* @param velocity the MIDI velocity * @param velocity the MIDI velocity
*/ */
void sfizz_send_note_off(sfizz_synth_t* synth, int delay, int channel, int note_number, char velocity); void sfizz_send_note_off(sfizz_synth_t* synth, int delay, int channel, int note_number, char velocity);
/** /**
* @brief Send a CC event to the synth. * @brief Send a CC event to the synth. As with all MIDI events, this needs
* As with all MIDI events, this needs to happen before the call to sfizz_render_block * to happen before the call to sfizz_render_block in each block.
* in each block.
* *
* @param synth * @param synth The synth
* @param delay the delay of the event in the block, in samples. * @param delay the delay of the event in the block, in samples.
* @param channel the MIDI channel; currently starts at 1 (FIXME) * @param channel the MIDI channel; currently starts at 1 (FIXME)
* @param cc_number the MIDI CC number * @param cc_number the MIDI CC number
* @param cc_value the MIDI CC value * @param cc_value the MIDI CC value
*/ */
void sfizz_send_cc(sfizz_synth_t* synth, int delay, int channel, int cc_number, char cc_value); void sfizz_send_cc(sfizz_synth_t* synth, int delay, int channel, int cc_number, char cc_value);
/** /**
* @brief Send a pitch wheel event. (CURRENTLY UNIMPLEMENTED) * @brief Send a pitch wheel event. (CURRENTLY UNIMPLEMENTED)
* *
* @param synth * @param synth The synth
* @param delay * @param delay The delay
* @param channel * @param channel The channel
* @param pitch * @param pitch The pitch
*/ */
void sfizz_send_pitch_wheel(sfizz_synth_t* synth, int delay, int channel, int pitch); void sfizz_send_pitch_wheel(sfizz_synth_t* synth, int delay, int channel, int pitch);
@ -184,59 +196,104 @@ void sfizz_send_pitch_wheel(sfizz_synth_t* synth, int delay, int channel, int pi
void sfizz_send_aftertouch(sfizz_synth_t* synth, int delay, int channel, char aftertouch); void sfizz_send_aftertouch(sfizz_synth_t* synth, int delay, int channel, char aftertouch);
/** /**
* @brief Send a tempo event. (CURRENTLY UNIMPLEMENTED) * @brief Send a tempo event. (CURRENTLY UNIMPLEMENTED)
* *
* @param synth * @param synth The synth
* @param delay * @param delay The delay
* @param seconds_per_quarter * @param seconds_per_quarter The seconds per quarter
*/ */
void sfizz_send_tempo(sfizz_synth_t* synth, int delay, float seconds_per_quarter); void sfizz_send_tempo(sfizz_synth_t* synth, int delay, float seconds_per_quarter);
/** /**
* @brief Render a block audio data into a stereo channel. * @brief Render a block audio data into a stereo channel. No other channel
* No other channel configuration is supported. The synth will gracefully ignore your request if you * configuration is supported. The synth will gracefully ignore your
* provide a value. You should pass all the relevant events for the block (midi notes, CCs, ...) before * request if you provide a value. You should pass all the relevant
* rendering each block. The synth will memorize the inputs and render sample accurates envelopes * events for the block (midi notes, CCs, ...) before rendering each
* depending on the input events passed to it. * block. The synth will memorize the inputs and render sample
* accurates envelopes depending on the input events passed to it.
* *
* @param synth * @param synth The synth
* @param channels pointers to the left and right channel of the output * @param channels pointers to the left and right channel of the
* @param num_channels should be equal to 2 for the time being. * output
* @param num_frames number of frames to fill. This should be less than or equal to the expected * @param num_channels should be equal to 2 for the time being.
* samples_per_block. * @param num_frames number of frames to fill. This should be less than
* or equal to the expected samples_per_block.
*/ */
void sfizz_render_block(sfizz_synth_t* synth, float** channels, int num_channels, int num_frames); void sfizz_render_block(sfizz_synth_t* synth, float** channels, int num_channels, int num_frames);
/** /**
* @brief Force a memory cleanup of the samples loaded in the background. * @brief Get the size of the preloaded data. This returns the number of
* This should happen automatically but if you want it done more frequently * floats used in the preloading buffers.
* this is the way to go.
* *
* @param synth * @param synth The synth
*
* @return the preloaded data size in sizeof(floats)
*/ */
void sfizz_force_garbage_collection(sfizz_synth_t* synth); unsigned int sfizz_get_preload_size(sfizz_synth_t* synth);
/**
* @brief Sets the size of the preloaded data in number of floats (not
* bytes). This will disable the callbacks for the duration of the
* load.
*
* @param synth The synth
* @param[in] preload_size The preload size
*/
void sfizz_set_preload_size(sfizz_synth_t* synth, unsigned int preload_size);
/** /**
* @brief Set the global instrument volume. * @brief Get the internal oversampling rate. This is the sampling rate of
* the engine, not the output or expected rate of the calling
* function. For the latter use the `get_sample_rate()` functions.
* *
* @param synth * @param synth The synth
* @param volume the new volume *
* @return The internal sample rate of the engine
*/
sfizz_oversampling_factor_t sfizz_get_oversampling_factor(sfizz_synth_t* synth);
/**
* @brief Set the internal oversampling rate. This is the sampling rate of
* the engine, not the output or expected rate of the calling
* function. For the latter use the `set_sample_rate()` functions.
*
* Increasing this value (up to x8 oversampling) improves the
* quality of the output at the expense of memory consumption and
* background loading speed. The main render path still uses the
* same linear interpolation algorithm and should not see its
* performance decrease, but the files are oversampled upon loading
* which increases the stress on the background loader and reduce
* the loading speed. You can tweak the size of the preloaded data
* to compensate for the memory increase, but the full loading will
* need to take place anyway.
*
* @param synth The synth
* @param[in] preload_size The preload size
*
* @return The internal sample rate of the engine
*/
void sfizz_set_oversampling_factor(sfizz_synth_t* synth, sfizz_oversampling_factor_t preload_size);
/**
* @brief Set the global instrument volume.
*
* @param synth The synth
* @param volume the new volume
*/ */
void sfizz_set_volume(sfizz_synth_t* synth, float volume); void sfizz_set_volume(sfizz_synth_t* synth, float volume);
/** /**
* @brief Get the global instrument volume. * @brief Get the global instrument volume.
* *
* @param synth * @param synth The synth
* @return float the instrument volume *
* @return float the instrument volume
*/ */
float sfizz_get_volume(sfizz_synth_t* synth); float sfizz_get_volume(sfizz_synth_t* synth);
/** /**
* @brief Sets the number of voices used by the synth * @brief Sets the number of voices used by the synth
* *
* @param synth * @param synth The synth
* @param num_voices * @param num_voices The number voices
*/ */
void sfizz_set_num_voices(sfizz_synth_t* synth, int num_voices); void sfizz_set_num_voices(sfizz_synth_t* synth, int num_voices);
/** /**

21
src/sfizz/sfizz_wrapper.cpp
View file

@ -21,6 +21,7 @@
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#include "Config.h"
#include "Synth.h" #include "Synth.h"
#include "sfizz.h" #include "sfizz.h"
@ -127,10 +128,26 @@ void sfizz_render_block(sfizz_synth_t* synth, float** channels, int num_channels
self->renderBlock({{channels[0], channels[1]}, static_cast<size_t>(num_frames)}); self->renderBlock({{channels[0], channels[1]}, static_cast<size_t>(num_frames)});
} }
void sfizz_force_garbage_collection(sfizz_synth_t* synth) unsigned int sfizz_get_preload_size(sfizz_synth_t* synth)
{ {
auto self = reinterpret_cast<sfz::Synth*>(synth); auto self = reinterpret_cast<sfz::Synth*>(synth);
self->garbageCollect(); return self->getPreloadSize();
}
void sfizz_set_preload_size(sfizz_synth_t* synth, unsigned int preload_size)
{
auto self = reinterpret_cast<sfz::Synth*>(synth);
self->setPreloadSize(preload_size);
}
sfizz_oversampling_factor_t sfizz_get_oversampling_factor(sfizz_synth_t* synth)
{
auto self = reinterpret_cast<sfz::Synth*>(synth);
return static_cast<sfizz_oversampling_factor_t>(self->getOversamplingFactor());
}
void sfizz_set_oversampling_factor(sfizz_synth_t* synth, sfizz_oversampling_factor_t preload_size)
{
auto self = reinterpret_cast<sfz::Synth*>(synth);
self->setOversamplingFactor(static_cast<sfz::Oversampling>(preload_size));
} }
void sfizz_set_volume(sfizz_synth_t* synth, float volume) void sfizz_set_volume(sfizz_synth_t* synth, float volume)