Skip to content

Commit

Permalink
Merge pull request #367 from Trinitou/activeAndProcessingDocumentation
Browse files Browse the repository at this point in the history
Adjust active and processing state documentation
  • Loading branch information
abique authored Dec 6, 2023
2 parents 1e09a99 + 80ed37b commit d8b7bba
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions include/clap/plugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,35 +60,35 @@ typedef struct clap_plugin {
// the [min, max] range, which is bounded by [1, INT32_MAX].
// Once activated the latency and port configuration must remain constant, until deactivation.
// Returns true on success.
// [main-thread & !active_state]
// [main-thread & !active]
bool(CLAP_ABI *activate)(const struct clap_plugin *plugin,
double sample_rate,
uint32_t min_frames_count,
uint32_t max_frames_count);
// [main-thread & active_state]
// [main-thread & active]
void(CLAP_ABI *deactivate)(const struct clap_plugin *plugin);

// Call start processing before processing.
// Returns true on success.
// [audio-thread & active_state & !processing_state]
// [audio-thread & active & !processing]
bool(CLAP_ABI *start_processing)(const struct clap_plugin *plugin);

// Call stop processing before sending the plugin to sleep.
// [audio-thread & active_state & processing_state]
// [audio-thread & active & processing]
void(CLAP_ABI *stop_processing)(const struct clap_plugin *plugin);

// - Clears all buffers, performs a full reset of the processing state (filters, oscillators,
// envelopes, lfo, ...) and kills all voices.
// - The parameter's value remain unchanged.
// - clap_process.steady_time may jump backward.
//
// [audio-thread & active_state]
// [audio-thread & active]
void(CLAP_ABI *reset)(const struct clap_plugin *plugin);

// process audio, events, ...
// All the pointers coming from clap_process_t and its nested attributes,
// are valid until process() returns.
// [audio-thread & active_state & processing_state]
// [audio-thread & active & processing]
clap_process_status(CLAP_ABI *process)(const struct clap_plugin *plugin,
const clap_process_t *process);

Expand Down

0 comments on commit d8b7bba

Please sign in to comment.