MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
Mezzanine::Audio::VocalMorpherParameters Struct Reference

This is a struct containing all the parameters needed to describe a vocal morpher effect. More...

#include <effectparameters.h>

Public Types

enum  MorpherPhoneme {
  EMP_A, EMP_E, EMP_I, EMP_O,
  EMP_U, EMP_AA, EMP_AE, EMP_AH,
  EMP_AO, EMP_EH, EMP_ER, EMP_IH,
  EMP_IY, EMP_UH, EMP_UW, EMP_B,
  EMP_D, EMP_F, EMP_G, EMP_J,
  EMP_K, EMP_L, EMP_M, EMP_N,
  EMP_P, EMP_R, EMP_S, EMP_T,
  EMP_V, EMP_Z
}
 An enum describing the basic phoneme's of the english language.
 
enum  MorpherWaveform { EMW_Sinusoid, EMW_Triangle, EMW_Saw }
 The shape of the wave if it were viewed on an oscillator. More...
 

Public Member Functions

 VocalMorpherParameters (MorpherPhoneme phonemeA=EMP_A, MorpherPhoneme phonemeB=EMP_ER, Integer phonemeACoarseTune=0, Integer phonemeBCoarseTune=0, MorpherWaveform waveform=EMW_Sinusoid, Real rate=1.41f)
 Struct constructor. More...
 

Public Attributes

MorpherPhoneme PhonemeA
 The source phoneme. More...
 
Integer PhonemeACoarseTune
 This is used to adjust the pitch of phoneme filter A in 1-semitone increments. More...
 
MorpherPhoneme PhonemeB
 The destination phoneme. More...
 
Integer PhonemeBCoarseTune
 This is used to adjust the pitch of phoneme filter B in 1-semitone increments. More...
 
Real Rate
 This controls the frequency of the low-frequency oscillator used to morph between the two phoneme filters. More...
 
MorpherWaveform Waveform
 This controls the shape of the low-frequency oscillator used to morph between the two phoneme filters.
 

Detailed Description

This is a struct containing all the parameters needed to describe a vocal morpher effect.

The vocal morpher consists of a pair of 4-band formant filters, used to impose vocal tract effects upon the input signal.

Definition at line 583 of file effectparameters.h.

Member Enumeration Documentation

The shape of the wave if it were viewed on an oscillator.

Enumerator
EMW_Sinusoid 

A curved oscillation with smoother transitions at peak frequencies.

EMW_Triangle 

A linear oscillation with rapid transitions at peak frequencies.

EMW_Saw 

A curved upward oscillation with a rapid drop at it's peak frequency.

Definition at line 623 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::VocalMorpherParameters::VocalMorpherParameters ( MorpherPhoneme  phonemeA = EMP_A,
MorpherPhoneme  phonemeB = EMP_ER,
Integer  phonemeACoarseTune = 0,
Integer  phonemeBCoarseTune = 0,
MorpherWaveform  waveform = EMW_Sinusoid,
Real  rate = 1.41f 
)
inline

Struct constructor.

Parameters
phonemeA@copybriefVocalMorpherParamters::PhonemeA
phonemeB@copybriefVocalMorpherParamters::PhonemeB
phonemeACoarseTune@copybriefVocalMorpherParamters::PhonemeACoarseTune
phonemeBCoarseTune@copybriefVocalMorpherParamters::PhonemeBCoarseTune
waveform@copybriefVocalMorpherParamters::Waveform
rate@copybriefVocalMorpherParamters::Rate

Definition at line 657 of file effectparameters.h.

Member Data Documentation

MorpherPhoneme Mezzanine::Audio::VocalMorpherParameters::PhonemeA

The source phoneme.

Remarks
If both parameters are set to the same phoneme, that determines the filtering effect that will be heard. If these two parameters are set to different phonemes, the filtering effect will morph between the two settings at a rate specified by Rate.

Definition at line 633 of file effectparameters.h.

Integer Mezzanine::Audio::VocalMorpherParameters::PhonemeACoarseTune

This is used to adjust the pitch of phoneme filter A in 1-semitone increments.

Remarks
Range: -24 to 24

Definition at line 640 of file effectparameters.h.

MorpherPhoneme Mezzanine::Audio::VocalMorpherParameters::PhonemeB

The destination phoneme.

Remarks
If both parameters are set to the same phoneme, that determines the filtering effect that will be heard. If these two parameters are set to different phonemes, the filtering effect will morph between the two settings at a rate specified by Rate.

Definition at line 637 of file effectparameters.h.

Integer Mezzanine::Audio::VocalMorpherParameters::PhonemeBCoarseTune

This is used to adjust the pitch of phoneme filter B in 1-semitone increments.

Remarks
Range: -24 to 24

Definition at line 643 of file effectparameters.h.

Real Mezzanine::Audio::VocalMorpherParameters::Rate

This controls the frequency of the low-frequency oscillator used to morph between the two phoneme filters.

Remarks
Range: 0.0 to 10.0

Definition at line 648 of file effectparameters.h.


The documentation for this struct was generated from the following file: