Version
The Source Editor displays all the properties associated with the SoundSeed Grain plug-in.
The first part of this page covers only the Effect Settings tab of the plug-in. Exceptionally for a plug-in, however, the SoundSeed Grain plug-in has two additional tabs which are covered in the Source Settings section below.
For a general overview of the SoundSeed Grain plug-in, refer to Wwise SoundSeed Grain.
Interface Element |
Description |
||||||
---|---|---|---|---|---|---|---|
Name |
The user-defined name given to this instance of the Wwise SoundSeed Grain plug-in. |
||||||
Source Plug-in |
The type of source plug-in. |
||||||
Notes |
Any additional information about the SoundSeed Grain plug-in. |
||||||
Filename |
The audio source file, WAV or AMB, to be used by the granular synthesizer. Click the browse button to the right of the field to choose the file. |
||||||
Grains | |||||||
Time between Emissions |
Time between each grain emitted, in ms. Select Freq/Time needs to be set to Time Between Emissions. Default value: 1000 |
||||||
Emissions per Second |
Number of grains emitted per second. Select Freq/Time needs to be set to Emissions per Second. Default value: 1 |
||||||
Duration Link |
When Duration Multiplier is selected, grain duration is specified as a multiple of the time between emissions. When Duration is selected, grain duration is completely independent from the time between emissions. When MIDI Duration is selected, and if the synthesizer was spawned from a MIDI note, the note value overrides grain Duration. Modulating the Duration property will modulate MIDI Duration. Default value: Duration Multiplier |
||||||
Duration Multiplier |
Grain duration, expressed as a multiplication factor of the emission rate (set using either Emissions per Second or Time Between Emissions). This control is only available when Duration Link is set to Duration Multiplier. When set to 1, actual grain duration is equal to the time that elapses between each grain, with envelope release overlapping envelope attack, resulting in a continuous dovetailing of grains. When smaller than 1, gaps will exist between grains; when greater than 1, grains stack up. Default value: 1 |
||||||
Duration |
Grain duration, in ms. This control is only available when Duration Link is set to Duration.
Default value: 1000 |
||||||
Amplitude |
Amplitude of grains, in percent. This control is useful when assigned with a modulator, in order to vary the relative level of grains.
Default value: 100 |
||||||
Attack |
Attack time of the grain envelope, in ms. When Window Mode is Release Same as Attack, the Release time is equal to Attack time. The Attack envelope starts at the beginning of the grain and is therefore comprised in the grain’s duration, as opposed to the envelope’s release portion (Release), which starts at the end of the grain. You may also change the Attack time using the upper-left handle in the grain visualizer window.
Default value: 10 |
||||||
Window Mode |
When there's an independent Attack and Release, allows you to set different values for envelope Attack and Release times. Default value: Release Same as Attack |
||||||
Release |
Release time of the grain envelope, in ms. Ignored when Window Mode is Release Same as Attack. The release envelope starts at the end of the grain, and is therefore not comprised in the grain’s duration, as opposed to the envelope’s attack portion (Attack). You may also change the release time using the lower-right handle in the Grain Visualizer window. Default value: 10 |
||||||
Grain Envelope Shape |
Defines the shape of the Attack and Release segments of the grain envelope. Choices available are:
Default value: Linear |
||||||
Playback | |||||||
Position |
Position in the source file from which grains are read. The position is expressed in percentage of the file’s duration. If Snap to Markers is enabled and markers exist, the effective grain start position is that of the marker nearest to the position set with this control. Default value: 0 |
||||||
Snap to Markers |
If enabled, and markers are present, the chosen grain start position is that of the marker nearest to the position set with Position. Default value: false |
||||||
Offset% |
Position in the source file from which grains are read. The position is expressed in percentage of the file’s duration. This position offset is only considered if Snap to Markers is enabled and further offsets the grain start positions from the marker nearest to Position. Default value: 0 |
||||||
Pitch |
The pitch by which grains are transposed, in cents. Values above 0 result in faster playback speeds, while values below 0 result in lower playback speeds. The effective playback speed also depends on grain Speed. Default value: 0 |
||||||
Map MIDI to Grain Pitch |
When set, and if the synthesizer was spawned from a MIDI note, the note value, relative to Root, adds to grain Pitch. Default value: false |
||||||
Root MIDI Note |
Defines the root MIDI note in order to derive an offset to the Pitch from the input MIDI note value. Default value: 60 |
||||||
Speed |
Playback speed of grains.
The effective speed at which grains play also depends on grain Pitch. Default value: 1 |
||||||
Filter | |||||||
Filter Type |
Type of the filter applied on each grain.
Default value: LPF12 |
||||||
Filter Cutoff |
Cutoff (or center) frequency of the grain filter, in Hz. Default value: 20000 |
||||||
Filter Q |
Quality factor of the grain filter. When this value is larger, the filter is more resonant at the filter cutoff frequency. Filter Q only applies when Filter Type is set to LPF12, HPF12, or BP. Default value: 0.707 |
||||||
Positioning | |||||||
Channels |
Defines whether grains should be spatialized onto the output channel configuration of the synthesizer, as defined by Output Config, or just assigned directly.
Default value: Direct Speaker Assignment |
||||||
Azimuth |
Azimuth angle of grains’ spatial positioning, in degrees, with positive values to the right. This control requires Channels to be set to 3D Spatialization, and only makes sense when the synthesizer’s Output Config is set to a multichannel configuration. Default value: 0 |
||||||
Elevation |
Elevation angle of grains’ spatial positioning, in degrees, with positive values to the top. This control requires Channels to be set to 3D Spatialization, and only makes sense when the synthesizer’s Output Config is set to a multichannel configuration. Default value: 0 |
||||||
Spread |
Spread of grains used with spatial positioning, in percentage. This is the equivalent of Attenuation Spread in Wwise. This control requires Channels to be set to 3D Spatialization and only makes sense when the synthesizer’s Output Config is set to a multichannel configuration. Default value: 0 |
||||||
Output | |||||||
Output Config |
Channel configuration forced at the output of the synthesizer. Using a multichannel output configuration is useful for creating 3D ambiences. To do so, set the positioning of the sound to 3D and set an attenuation ShareSet that uses spread at close distances. Design your synthesizer patch such that the output is maximally enveloping, by using 3D Spatialization and modulating Azimuth and, if applicable, Elevation. The channel configuration is visible in the Effect’s VU Meter during playback with Capture running.
Default value: Mono |
||||||
Output Level |
Level applied to the final signal. Default value: 0 |
||||||
VU Meter | |||||||
A per channel peak meter, which meters the signal at the output of the synthesizer, and its channel configuration matches that which is set in the Output group box. For more information about speaker configurations and channels, refer to Understanding Channel Configurations.
|
|||||||
Envelope Visualizer | |||||||
The Envelope Visualizer offers a preview of the grain Envelopes' shapes and overlap. The amount of overlap depends on the emission rate, grain duration, and release. These values are before any RTPC or modulation is applied, so the actual outcome may be quite different. |
|||||||
| |||||||
Grain Modulators (left pane) | |||||||
Modulator 1 Waveform |
Type of waveform of modulator 1. The available waveform types are:
Default value: Random |
||||||
Modulator 1 Time/Freq |
Specify whether to define oscillator rate of Modulator 1 in terms of time (period, in ms) or frequency (Hz). Default value: Frequency |
||||||
Modulator 1 Period |
Period of Modulator 1, in ms. Default value: 1000 |
||||||
Modulator 1 Output |
Output level of Modulator 1. Negative values invert the modulator’s polarity. Default value: 100 |
||||||
Modulator Assignment (right pane)
| |||||||
Amount | |||||||
Amplitude Mod 1 |
Modulation amount of Mod 1 applied to Amplitude. The modulation amount is expressed in percentage, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity).
Default value: 0 |
||||||
Attack Mod 1 |
Modulation amount of Mod 1 applied to Attack. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. One octave up means half the attack’s duration, one octave down means twice the attack’s duration. Negative values have the effect of flipping the modulator’s output signal (that is, inverting its polarity). Default value: 0 |
||||||
Azimuth Mod 1 |
Modulation amount of Mod 1 applied to Azimuth. The modulation amount is expressed in number of degrees, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Duration Mod 1 |
Modulation amount of Mod 1 applied to Duration. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. One octave up means half the duration, and one octave down means twice the duration. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Duration Multiplier Mod 1 |
Modulation amount of Mod 1 applied to Duration Multiplier. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. One octave up means half the duration (i.e. the duration multiplier is halved), and one octave down means twice the duration. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Elevation Mod 1 |
Modulation amount of Mod 1 applied to Elevation. The modulation amount is expressed in number of degrees, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Filter Cutoff Mod 1 |
Modulation amount of Mod 1 applied to Filter Cutoff. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Filter Q Mod 1 |
Modulation amount of Mod 1 applied to Filter Q. The modulation amount is expressed as a Q offset, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Emissions per Second Mod 1 |
Modulation amount of Mod 1 applied to Emissions per Second. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Time Between Emissions Mod 1 |
Modulation amount of Mod 1 applied to Time Between Emissions. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. One octave up means half the duration, and one octave down means twice the duration. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity).
Default value: 0 |
||||||
Position Mod 1 |
Modulation amount of Mod 1 applied to Position. The modulation amount is expressed in percentage of the file duration, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Offset Mod 1 |
Modulation amount of Mod 1 applied to Offset. The modulation amount is expressed in percentage of the file duration, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Release Mod 1 |
Modulation amount of Mod 1 applied to Release. The modulation amount is expressed in number of octaves, above and/or below the original value, depending on the choice of modulator waveshape. One octave up means half the release’s duration, and one octave down means twice the release’s duration. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Speed Mod 1 |
Modulation amount of Mod 1 applied to Speed. The modulation amount is expressed as a speed offset, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Spread Mod 1 |
Modulation amount of Mod 1 applied to Spread. The modulation amount is expressed as an offset, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Pitch Mod 1 |
Modulation amount of Mod 1 applied to Pitch. The modulation amount is expressed in cents, above and/or below the original value, depending on the choice of modulator waveshape. Negative values have the effect of flipping the modulator’s output signal (i.e. inverting its polarity). Default value: 0 |
||||||
Quantization | |||||||
Amplitude Mod 1 Quantization |
Quantization of modulation applied to Amplitude. The available quantization schemes for this property are:
Default value: None |
||||||
Attack Mod 1 Quantization |
Quantization of modulation applied to Attack. The available quantization schemes for this property are:
Default value: None |
||||||
Azimuth Mod 1 Quantization |
Quantization of modulation applied to Azimuth. The available quantization schemes for this property are:
Default value: None |
||||||
Duration Mod 1 Quantization |
Quantization of modulation applied to Duration. The available quantization schemes for this property are:
Default value: None |
||||||
Duration Multiplier Mod 1 Quantization |
Quantization of modulation applied to Duration Multiplier. The available quantization schemes for this property are:
Default value: None |
||||||
Elevation Mod 1 Quantization |
Quantization of modulation applied to Elevation. The available quantization schemes for this property are:
Default value: None |
||||||
Filter Cutoff Mod 1 Quantization |
Quantization of modulation applied to Filter Cutoff. The available quantization schemes for this property are:
Default value: None |
||||||
Filter Q Mod 1 Quantization |
Quantization of modulation applied to Filter Q. The available quantization schemes for this property are:
Default value: None |
||||||
Emissions per Second Mod 1 Quantization |
Quantization of modulation applied to Emissions per Second. The available quantization schemes for this property are:
Default value: None |
||||||
Time Between Emissions Mod 1 Quantization |
Quantization of modulation applied to Time Between Emissions. The available quantization schemes for this property are:
Default value: None |
||||||
Position Mod 1 Quantization |
Quantization of modulation applied to Position. The available quantization schemes for this property are:
Default value: None |
||||||
Offset Mod 1 Quantization |
Quantization of modulation applied to Offset. The available quantization schemes for this property are:
Default value: None |
||||||
Release Mod 1 Quantization |
Quantization of modulation applied to Release. The available quantization schemes for this property are:
Default value: None |
||||||
Speed Mod 1 Quantization |
Quantization of modulation applied to Speed. The available quantization schemes for this property are:
Default value: None |
||||||
Spread Mod 1 Quantization |
Quantization of modulation applied to Spread. The available quantization schemes for this property are:
Default value: None |
||||||
Pitch Mod 1 Quantization |
Quantization of modulation applied to Pitch. The available quantization schemes for this property are:
Default value: None |
This plug-in manages media, so it has two additional tabs in the Source Editor:
Source Tab
In the Source tab, you will find the familiar Wwise Source Editor. There, you may edit Trim, Fades, and Markers like you would for standard sources in Wwise. Note that any change that you perform here is made "pre-effect", that is, it affects the media before it is stored in SoundBanks. Thus, if you change the Trim, the source file that is used by the plug-in at run-time is effectively the trimmed file.
Warning | |
---|---|
Moving the Trim cursors will change the meaning of the Position setting, since it depends on the audio file's duration. |
Markers, if any, are displayed as blue vertical lines in the graph view of the source audio file. The Markers list specifies the source of the markers.
Use File Markers: The source audio file's markers are used.
Use Markers From Transients: Markers are placed by automatic onset detection. These will not appear until you move the Marker Detection Sensitivity slider. The higher the sensitivity, the higher the chance to have markers. Adjust the slider so that detected onsets are closest to what you desire. Then you may edit them manually. Once you edit a marker, the markers mode will change to Manual Markers.
Manual Markers: The markers as set by the user are used. Selecting Manual Markers does not change the markers from what they were in the previous selection. Whether file markers or markers from transients, users can directly edit them at any time. As soon as anything is editing, the Markers selection is set to Manual Markers.
Adding your own markers | |
---|---|
In addition to many standard shortcut menu options, the SoundSeed Grain Source graph view has an Add Custom Marker option to manually add markers. |
In the Effect Settings, enable Snap to Markers to set the effective grain start position to that of the closest marker.
Conversion Tab
In the Conversion tab you may select the Conversion ShareSet that will be used to encode the media prior to storing it in SoundBanks for the purpose of the plug-in. SoundSeed Grain supports all channel downmixing and sample rate options, but only the PCM and ADPCM codecs.
Warning | |
---|---|
Currently, SoundSeed Grain only supports decoding PCM and ADPCM at runtime. If from the Conversion tab you choose another codec (such as Vorbis or Opus) for the SoundSeed Grain Sound SFX, it will fail to play and you will see an error in the Capture Log. |
Note | |
---|---|
You should avoid using ADPCM for files smaller than 64 samples per channel. |
Alternatively, you may select other codecs and have the game "decode" the SoundBank at the point of loading it in memory. Refer to AK::SoundEngine::DecodeBank
in the SDK documentation for more details on the Decode Bank workflow.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise