PS04Modulator

PS04Modulator — The modulator module of an insert effect

Synopsis


#include <PS04-modulator.h>


            PS04Modulator;
PS04ModulatorType ps04_modulator_get_type   (const PS04Modulator *self);
const char* ps04_modulator_get_type_string  (const PS04Modulator *self);
const PS04VibeModulation* ps04_modulator_get_vibe
                                            (const PS04Modulator *self);
const PS04WideModulation* ps04_modulator_get_wide
                                            (const PS04Modulator *self);

            PS04VibeModulation;
int         ps04_vibe_modulation_get_depth  (const PS04VibeModulation *self);
int         ps04_vibe_modulation_get_rate   (const PS04VibeModulation *self);
int         ps04_vibe_modulation_get_balance
                                            (const PS04VibeModulation *self);

            PS04WideModulation;
int         ps04_wide_modulation_get_time   (const PS04WideModulation *self);
int         ps04_wide_modulation_get_wet_level
                                            (const PS04WideModulation *self);
int         ps04_wide_modulation_get_dry_level
                                            (const PS04WideModulation *self);

Description

The PS04Modulator class represents the modulator module of a PS-04 insert effect. The modulation may be one of 17 types, each with its own set of parameters, which you get to by first calling ps04_modulator_get_type() and then one of the accessor methods (ps04_modulator_get_vibe() et al.) such as within a switch statement.

Details

PS04Modulator

typedef struct {
  guint8 type;
  union
  {
    PS04VibeModulation vibe;
    PS04WideModulation wide;
  } params;
} PS04Modulator;

ps04_modulator_get_type ()

PS04ModulatorType ps04_modulator_get_type   (const PS04Modulator *self);

self : A pointer to the modulator.
Returns : The modulator type.

ps04_modulator_get_type_string ()

const char* ps04_modulator_get_type_string  (const PS04Modulator *self);

self : A pointer to the modulator.
Returns : A display string representing the modulator type.

ps04_modulator_get_vibe ()

const PS04VibeModulation* ps04_modulator_get_vibe
                                            (const PS04Modulator *self);

Provides access to the VIBE modulation parameters if that's the modulator type. Otherwise flags an error.

self : A pointer to the modulator.
Returns : A pointer to the vibe modulation parameters.

ps04_modulator_get_wide ()

const PS04WideModulation* ps04_modulator_get_wide
                                            (const PS04Modulator *self);

Provides access to the WIDE modulation parameters if that's the modulator type. Otherwise flags an error.

self : A pointer to the modulator.
Returns : A pointer to the wide modulation parameters.

PS04VibeModulation

typedef struct {
  guint8 depth;
  guint8 rate;
  guint8 bal;
} PS04VibeModulation;

ps04_vibe_modulation_get_depth ()

int         ps04_vibe_modulation_get_depth  (const PS04VibeModulation *self);

This function returns the effect depth.

self : A pointer to the vibe modulation struct.
Returns : the depth value (0-10).

ps04_vibe_modulation_get_rate ()

int         ps04_vibe_modulation_get_rate   (const PS04VibeModulation *self);

This function returns the effect speed.

self : A pointer to the vibe modulation struct.
Returns : the rate value (1-30).

ps04_vibe_modulation_get_balance ()

int         ps04_vibe_modulation_get_balance
                                            (const PS04VibeModulation *self);

This function returns the balance between the direct sound and effect sound.

self : A pointer to the vibe modulation struct.
Returns : the balance value (0-30).

PS04WideModulation

typedef struct {
  guint8 time;
  guint8 wetlvl;
  guint8 drylvl;
} PS04WideModulation;

ps04_wide_modulation_get_time ()

int         ps04_wide_modulation_get_time   (const PS04WideModulation *self);

This function returns the delay time.

self : A pointer to the wide modulation struct.
Returns : the time value (1-64).

ps04_wide_modulation_get_wet_level ()

int         ps04_wide_modulation_get_wet_level
                                            (const PS04WideModulation *self);

This function returns the mix amount of the effect sound.

self : A pointer to the wide modulation struct.
Returns : the level value (0-30).

ps04_wide_modulation_get_dry_level ()

int         ps04_wide_modulation_get_dry_level
                                            (const PS04WideModulation *self);

This function returns the mix amount of the direct sound.

self : A pointer to the wide modulation struct.
Returns : the level value (0-30).