|
wavelength 1.0.0
|
The effect sets a song applies to the synthesiser channels at given bars. More...
#include <fxmgr.h>
Classes | |
| struct | FX |
| The effects of one channel in a set. More... | |
| struct | FXSet |
| One set of effects and the bar it applies at. More... | |
Public Member Functions | |
| FXMgr (int nNumChannels, int nChorusDepth) | |
| Construct the manager with one set, at bar 0, of no effects. | |
| ~FXMgr () | |
| Release the sets. | |
| void | Activate () |
| Start applying the effects, beginning with the current set. | |
| void | Reset () |
| Stop applying the effects and remove them from every channel. | |
| void | AddSet (int nBar) |
| Append a set of no effects. | |
| void | ApplySet (int nSet) |
| Make a set current, and apply it to the channels while the manager is active. | |
| int | GetNumSets () const |
| Report the number of sets. | |
| int | GetCurrentSet () const |
| Report the current set. | |
| void | CopySet (int nFrom, int nTo) |
| Copy the effects of one set to another. | |
| int | GetSetBar (int nSet) const |
| Report the bar a set applies at. | |
| void | SetStutter (int nSet, int nChannel, int nStutter) |
| Set the stutter of a channel in a set, and apply it at once when the set is current. | |
| void | SetFilter (int nSet, int nChannel, int nFilter) |
| Set the filter of a channel in a set, and apply it at once when the set is current. | |
| void | SetChorus (int nSet, int nChannel, int nChorus) |
| Set the chorus of a channel in a set, and apply it at once when the set is current. | |
| int | GetStutter (int nSet, int nChannel) const |
| Report the stutter of a channel in a set. | |
| int | GetFilter (int nSet, int nChannel) const |
| Report the filter of a channel in a set. | |
| int | GetChorus (int nSet, int nChannel) const |
| Report the chorus of a channel in a set. | |
| void | Load (BinStream &stream) |
| Replace the sets with the sets Save() writes, and make the first set current. | |
| void | Save (BinStream &stream) const |
| Write the number of sets in one byte, then for each set the bar in four bytes of the console's byte order and one byte for each effect of each channel. | |
The effect sets a song applies to the synthesiser channels at given bars.
The RTTI includes the nested FXMgr::FX and FXMgr::FXSet. The class is not polymorphic. Each set has one FX for each channel. While the manager is active, the current set drives the stutter gate, the filter controllers, and the chorus controllers of every channel.
| FXMgr::FXMgr | ( | int | nNumChannels, |
| int | nChorusDepth ) |
Construct the manager with one set, at bar 0, of no effects.
The name is inferred.
| nNumChannels | The channels. |
| nChorusDepth | The value of the second chorus controller while the chorus is on. |
| FXMgr::~FXMgr | ( | ) |
Release the sets.
| void FXMgr::Activate | ( | ) |
Start applying the effects, beginning with the current set.
| void FXMgr::Reset | ( | ) |
Stop applying the effects and remove them from every channel.
| void FXMgr::AddSet | ( | int | nBar | ) |
Append a set of no effects.
The name is inferred.
| nBar | The bar the set applies at. |
| void FXMgr::ApplySet | ( | int | nSet | ) |
Make a set current, and apply it to the channels while the manager is active.
| nSet | The set. |
| int FXMgr::GetNumSets | ( | ) | const |
Report the number of sets.
| int FXMgr::GetCurrentSet | ( | ) | const |
Report the current set.
The name is inferred.
| void FXMgr::CopySet | ( | int | nFrom, |
| int | nTo ) |
Copy the effects of one set to another.
The name is inferred.
| nFrom | The set to copy. |
| nTo | The set to replace. |
| int FXMgr::GetSetBar | ( | int | nSet | ) | const |
Report the bar a set applies at.
| nSet | The set. |
| void FXMgr::SetStutter | ( | int | nSet, |
| int | nChannel, | ||
| int | nStutter ) |
Set the stutter of a channel in a set, and apply it at once when the set is current.
The name is inferred.
| nSet | The set. |
| nChannel | The channel. |
| nStutter | Whether the stutter gate holds the channel. |
| void FXMgr::SetFilter | ( | int | nSet, |
| int | nChannel, | ||
| int | nFilter ) |
Set the filter of a channel in a set, and apply it at once when the set is current.
The name is inferred.
| nSet | The set. |
| nChannel | The channel. |
| nFilter | The value of the filter controllers. |
| void FXMgr::SetChorus | ( | int | nSet, |
| int | nChannel, | ||
| int | nChorus ) |
Set the chorus of a channel in a set, and apply it at once when the set is current.
The name is inferred.
| nSet | The set. |
| nChannel | The channel. |
| nChorus | Whether the chorus controllers are on. |
| int FXMgr::GetStutter | ( | int | nSet, |
| int | nChannel ) const |
Report the stutter of a channel in a set.
The name is inferred.
| nSet | The set. |
| nChannel | The channel. |
| int FXMgr::GetFilter | ( | int | nSet, |
| int | nChannel ) const |
Report the filter of a channel in a set.
The name is inferred.
| nSet | The set. |
| nChannel | The channel. |
| int FXMgr::GetChorus | ( | int | nSet, |
| int | nChannel ) const |
Report the chorus of a channel in a set.
The name is inferred.
| nSet | The set. |
| nChannel | The channel. |
| void FXMgr::Load | ( | BinStream & | stream | ) |
Replace the sets with the sets Save() writes, and make the first set current.
Each effect reads back as 1 when its byte is not zero.
| stream | The stream to read from. |
| void FXMgr::Save | ( | BinStream & | stream | ) | const |
Write the number of sets in one byte, then for each set the bar in four bytes of the console's byte order and one byte for each effect of each channel.
| stream | The stream to write to. |