Scaler Smoothed Module Example
This page walks through a complete example of an audio module, starting from the high-level MATLAB model and continuing through the generated code. This example is identical to the scaler_smoothed_module.m contained in the Deprecated module library. We go through this module in a systematic fashion and reference the source files listed in Scaler Smoothed Example Source Files. Examples Module Library contains additional module examples which highlight advanced features.
This module example is part of a larger audio module DLL containing several example modules. The base directory for the audio module examples is <AWE>\AWEModules\Source\Examples\where <AWE> refers to the root directory of the Audio Weaver Designer installation.
The directory contains several subdirectories. This directory structure must be followed when creating other custom audio module libraries. In order to build the examples modules, the above path must be on the Audio Weaver module path variable, which can be retrieved in MATLAB with the ‘add_module_path’ command. The correct path should already be included in a normal installation of Designer, but if it is not, or if another path needs to be added, the module path can be updated using the ‘add_module_path’ command or with the File > Set Module Path menu in Designer.
Module M-files
Each audio module has an associated module M-file, item 1 shown in Figure 1. For this example, the file is found in
<AWE>\AWEModules\Source\Examples\matlab\scaler_smoothed_example_module.m
and a listing is shown in scaler_smoothed_example_module.m. When you first initialize Audio Weaver using awe_init.m, this file will be placed on your MATLAB path. The module m-file completely describes the audio module to MATLAB. It contains:
Input and output pins descriptions:
Data types, number of channels, block sizes, sample rates, etc.Instance structure variables:
Date types, variable names, array sizes, memory allocation rules.Documentation:
Descriptions of variables, pins, and text describing the overall audio model.MATLAB implementation of the module:
Processing function (optional), and if needed, set function, bypass function, and get function. There may also be a prebuild function which is called when a system is built.User interface:
Individual variables are exposed and tied to controls. Controls are positioned and configured.Browser information:
This is the information for AWE Designer window to list under specific folder, search tag, bit map image of the module in Designer window etc.
All of these items above are documented in the Audio Weaver Matlab API. The specific items in the module m-file pertaining to module generation are variables, code markers, and wiring allocation guidelines described in Generating Module Libraries (in particular, the sections Specifying Wiring Constraints and Code Markers and Template Substitution).
Subsystems are very similar to modules, but also contain a list of internal modules and a list of connections between modules.
Audio Module Instance Structure
Every audio module has an associated instance data structure that holds the variables – state and parameters – needed by the module. In this example, there are 4 variables described in the module m-file:
add_variable(M, 'gain', 'float', 0, 'parameter', 'Target gain');
M.gain.range=[-10 10];
M.gain.units='linear';
add_variable(M, 'smoothingTime', 'float', 10, 'parameter', 'Time constant of the smoothing process');
M.smoothingTime.range=[0 1000];
M.smoothingTime.units='msec';
add_variable(M, 'currentGain', 'float', M.gain, 'state', 'Instantaneous gain applied by the module. This is also the starting gain of the module.', 1);
M.currentGain.range=M.gain.range;
M.currentGain.units='linear';
add_variable(M, 'smoothingCoeff', 'float', NaN, 'derived', 'Smoothing coefficient', 1);The type definition for the instance data structure is contained in the file ModScalerSmoothedExample.h and is automatically generated by Audio Weaver:
typedef struct _awe_modScalerSmoothedExampleInstance
{
ModuleInstanceDescriptor instance;
float gain; // Target gain
float smoothingTime; // Time constant of the ...
float currentGain; // Instantaneous gain applied ...
float smoothingCoeff; // Smoothing coefficient
} awe_modScalerSmoothedExampleInstance;The instance structure begins with a common substructure of type ModuleInstanceDescriptor. This substructure points to the module's input and output wires, points to the real-time function currently used by the module (Processing, Bypassed, Muted, etc.), and points to the class instance structure.
The module header is followed by the instance variables described in the MATLAB file. There is a one-to-one correspondence between the variables shown in the instance structure and those added by MATLAB. The description of each variable is used as a comment.
The header file also contains a few other items. First, there is a bit mask for each variable in the data structure. The mask corresponds to the position of the variable within the instance structure. Note that the module header is 8 words long and thus the first bit starts in the 9th bit position. This leaves 24 bits to select individual variables or arrays. If you have more than 24 parameters that need adjusting, you will need to store at least some of them in arrays.
These bit masks can be used by the _Set() and _Get() functions to determine which variable within the instance structure has been modified.
#define MASK_ScalerSmoothedExample_gain 0x00000100
#define MASK_ScalerSmoothedExample_smoothingTime 0x00000400
#define MASK_ScalerSmoothedExample_currentGain 0x00000200
#define MASK_ScalerSmoothedExample_smoothingCoeff 0x00000800The header file also defines an offset for each instance variable. Again, this is the offset from the start of the data structure, in 32-bit words. These offsets are provided to help implement system control using a host interface.
#define OFFSET_ScalerSmoothedExample_gain 0x00000008
#define OFFSET_ScalerSmoothedExample_smoothingTime 0x0000000A
#define OFFSET_ScalerSmoothedExample_currentGain 0x00000009
#define OFFSET_ScalerSmoothedExample_smoothingCoeff 0x0000000BThere is a unique class ID.
#define CLASSID_SCALERSMOOTHEDEXAMPLE (CLASS_ID_MODBASE + 32768)
This integer uniquely defines the module class to the Server. Next is the definition of the module's constructor function. In this case, since the module does not have any arrays, the generic module constructor ClassModule_Constructor is used.
The generic module constructor applies to modules that do not have indirect arrays in the instance data structure. It is used by a large number of modules. The constructor function awe_modScalerSmoothedExample_Constructor() is provided as a macro so that the module can be constructed within subsystems. We'll see shortly that the constructor function is defined as NULL within the module's class structure.
#ifndef AWE_STATIC_CODE
// This points the constructor for this class to the base constructor
#define awe_modScalerSmoothedExampleConstructor(ARG1, ARG2, ARG3, ARG4, ARG5) ClassModule_Constructor(CLASSID_SCALERSMOOTHEDEXAMPLE, ARG1, ARG2, ARG3, ARG4, ARG5)
#endifAnd finally, there are definitions for the processing and set functions:
void awe_modScalerSmoothedExampleProcess(void *pInstance);
UINT awe_modScalerSmoothedExampleSet(void *pInstance, UINT mask);
Note: Many of the items are surrounded by #ifdef / #endif pairs. This allows various features of the modules to be enabled or disabled at compile time.
Audio Module Source Code (.c and .h files)
Each audio module has a set of associated functions. These functions, and their definitions, are placed in .c and .h files, respectively. At a minimum, every audio module requires a processing function. In addition, a module may specify several optional functions:
Constructor() – Performs additional memory allocation or initialization when a module is instantiated. If a module has an indirect array, such as an FIR filter, then a constructor function is required. In many cases, MATLAB can generate the constructor function automatically.
Set() – Implements a module's control functions which translate high-level interface variables to low-level variables. The Set() function is automatically called whenever an internal variable of a module is written by the Server during tuning.
Get() – Implements a module's control functions which translate low-level variables to high-level interface variables. The Get() function is automatically called by the Server whenever an internal variable of a module is read during tuning. Very few modules actually implement this function.
Bypass() – Implements custom bypass functionality. Required when one of the standard bypass functions is not suitable.
The module .c source file also contains a single class structure that describes the module to the Audio Weaver run-time and dynamic memory allocation functions. For example, this module contains the class structure:
AWE_MOD_SLOW_ANY_CONST
const Class_awe_modScalerSmoothedExample awe_modScalerSmoothedExampleClass =
{
{
{ NULL, CLASSID_SCALERSMOOTHEDEXAMPLE, }, // Constructor
awe_modScalerSmoothedExampleProcess, // Processing function
IOMatchUpModule_Bypass, // Bypass function
awe_modScalerSmoothedExampleSet, // Set function
0, // Get function
0x00000007, // Module version info
ClassModule_PackArgCounts(4, 0), // (Public words, private words)
{0x0000000F, 0x00000000}, // Specifies which variables are floating-point
},
#ifdef BUILD64
{
offsetof(awe_modScalerSmoothedExampleInstance, gain),
offsetof(awe_modScalerSmoothedExampleInstance, smoothingTime),
offsetof(awe_modScalerSmoothedExampleInstance, currentGain),
offsetof(awe_modScalerSmoothedExampleInstance, smoothingCoeff),
}
#endif
};The class structure contains pointers to the 5 functions listed above. The constructor function is NULL indicating that the module requires no memory outside of its instance structure and that the generic constructor should be used instead.
The #ifdef BUILD64 section is required internally by Designer to correctly access the module’s variables in 64-bit architectures.
Make sure that BUILD64 is defined in the Visual Studio and embedded projects if a 64-bit architecture is being targeted. Failure to add the BUILD64 macro to 64-bit architectures can cause the application to crash while accessing module variables using the control interface.
The class ID, CLASSID_SCALERSMOOTHEDEXAMPLE which is defined above, is a unique integer identifying the module to the Server. When instantiating a module of this class, the Server is told to instantiate a module of class "ModuleScalerSmoothedExample". This string identifier is then translated to the underlying class ID through the module DLL shown as item 9 in Figure 1. Ensuring that each audio module has a unique classID can be tedious. To facilitate this process, each module library has a text file named classids.csv, shown as item 3 in Figure 1, containing a comma separated list of audio modules and their class IDs. A portion of the file is shown below:
IDOFFSET=32768
ScalerSmoothedExample,0
ScalerExample,1
FaderExample,2
FaderExampleFract32,3
PeakHoldExample,4
DownsamplerExample,5The classID for the ScalerSmoothedExample module equals the IDOFFSET (32768) plus the value listed next to its class name below (0). Class IDs starting with 32768 are reserved for custom audio modules.
Audio Module Schema File
The generated schema file ExamplesSchema.sch provides a "blueprint" of all of the available objects on the target processor to the Server. This enables the Audio Weaver Server to instantiate and manipulate objects by name rather than hexadecimal IDs or offsets. The schema file for each module pack is embedded in the module DLL and is shown as item 9 in Figure 1. It contains definitions for all of the available audio modules in the module pack.
The entire schema file for the example module library is shown in ExamplesSchema.sch. The portion corresponding to the ScalerSmoothedExample module is shown below.
ModuleScalerSmoothedExample 0x0xBEEF8800, BaseModule
{
gain float // Target gain
smoothingTime float // Time constant ...
currentGain float // Instantaneous gain ...
smoothingCoeff float // Smoothing coefficient
}Note the one-to-one correspondence between the schema description and the C type definition shown above. Furthermore, the C substructure ModuleInstanceDescriptor maps to the BaseModule descriptor in the schema file.
To create an instance of a smoothly varying scaler on the target, the Server is told "create an instance of class ModuleScalerSmoothedExample and call it Scale1". The Server converts this to the command "create an instance of object 0xBEEF8800" via the schema file. The hexadecimal value 0xBEEF0C16 corresponds to the unique class ID CLASS_ID_MODBASE + 32768contained in the class structure.
Note: CLASS_ID_MODBASE = 0x BEEF0800, which is defined in Framework.h.
On the target, the array of module class objects is traversed looking for class ID 0xBEEF8800. Once the class object is found, the corresponding constructor function, stored as a pointer in the class structure, is used to allocate one instance of the object. The address of the newly instantiated object is returned to the Server, and the Server associates the object's address with the name "Scale1". The Server maintains this mapping between symbol names and actual memory addresses.
The schema file also lists the module's instance variables and is used to compute offsets from the start of an object. When the value "Scale1.gain" is set during tuning, the Server translates this to a specific address on the DSP (PC) using the "Scale1" object address as a base, and then adding an appropriate offset. In this case, the offset equals 8, the size of BaseModule.
Generating Module Code
The MATLAB file scaler_smoothed_example_module.m has a complete description of the audio module with sufficient information to generate all of the source files and documentation. You can generate the source files for a smoothly varying scaler using the commands:
will be created in MATLAB's current working directory. Specify the directories for code generation with the second argument:
homeDir = awe_home('awecore');
SRC_DIR = [homeDir '\Source\Examples\Source'];
INC_DIR = [homeDir '\Source\Examples\Include'];
DOC_DIR = [homeDir '\Source\Examples\Doc'];
INNER_DIR = [homeDir '\Source\Examples\Inner'];
DIR = {SRC_DIR; INC_DIR; DOC_DIR; INNER_DIR};
M = scaler_smoothed_example_module('temp');
awe_generate_module(M, DIR);The following files will be created in the directories specified by DIR:
Include/ModScalerSmoothedExample.h
Source/ModScalerSmoothedExample.c
You can also specify that the C code should be formatted using the ident.exe utility (supplied) via a third argument:
awe_generate_module(M, DIR, 1);
Modules are usually not created in isolation, but are part of a particular module pack library. Modules need to be created as a unified library so that the combined schema file ExamplesSchema.sch can be written. The MATLAB script make_examples.m generates code for the entire Examples module library. The script first creates a cell array of audio modules:
MM=cell(0,0);
MM{end+1}=downsampler_example_module('temp', 2); % 100% instantiation
MM{end+1}=fader_example_fract32_module('temp');
MM{end+1}=fader_example_module('temp');
MM{end+1}=lah_limiter_example_module('temp', 5); % 100% instantiation
MM{end+1}=peak_hold_example_fract32_module('temp');
MM{end+1}=peak_hold_example_module('temp');
MM{end+1}=scaler_example_module('temp');
MM{end+1}=scaler_smoothed_example_module('temp');Important point to be noted here is that the module must be added to cell array with all the arguments required. This is mandatory for new AWE Designer.
Some other example audio modules are subsystems that utilize modules found in other libraries. We indicate this dependency relationship using the lines
[DependMM, DependName]=make_standardmodulepack(0);
USESLIB{1}.MM=DependMM;
USESLIB{1}.str=DependName;
[DependMM, DependName]=make_deprecatedmodulepack(0);
USESLIB{2}.MM=DependMM;
USESLIB{2}.str=DependName;
[DependMM, DependName]=make_advancedmodulepack(0);
USESLIB{3}.MM=DependMM;
USESLIB{3}.str=DependName;Then call a function to generate the source code for the overall library:
awe_generate_library(MM, DIR, 'Examples', USESLIB, GENDOC);
Code for each module in a module pack is separately generated followed by the combined schema file. The third argument, 'Examples', specifies the module pack name and the forth argument specifies the dependencies on other module packs. The fifth argument, GENDOC, controls whether documentation in HTML format should be generated.
When you run the MATLAB script ‘make_examples’ the MATLAB output window will show an output similar to the following:
Generating code for module: DownsamplerExample
Unchanged output file:
<DIR >\Source\Modules\Examples\include\ModDownsamplerExample.h
Unchanged output file:
<DIR >\Source\Modules\Examples\Source\ModDownsamplerExample.c
Generating code for module: FaderExampleFract32
Unchanged output file:
<DIR>\Source\Modules\Examples\include\ModFaderExampleFract32.h
Unchanged output file:
<DIR >\Source\Modules\Examples\Source\ModFaderExampleFract32.c
...
Generated a total of 8 modulesYou'll note that all source files are marked as "Unchanged". Audio Weaver only overwrites generated files if there has been an actual change. This minimizes file changes and makes it easier to work with source code control systems.
Template Substitution
Audio Weaver uses template substitution to generate audio module source and header files. The template files are shown as item 2 in Module Development Overview | OverallEnvironment and two files are used:
<AWE>\matlab\module_generation\templates\awe_module_template.c
<AWE>\matlab\module_generation\templates\awe_module_template.h
The template files contain boiler plate text together with string substitution variables and special preprocessor directives. Consider a portion of the file awe_module_template.h:
/**
* @file
* @brief $description$
*/
#ifndef _MOD_$classNameUpperCase$_H
#define _MOD_$classNameUpperCase$_H
#include "ModCommon.h"
#include "MathHelper.h""Each substitution point is shown as $NAME$ in the template file. These substitution points are replaced with the code markers added via awe_addcodemarker.m commands in the module file. For example, when generating the scaler_smoothed_example_module, the string variable $description$ is replaced by "Linear multichannel smoothly varying scaler" and $classNameUpperCase$ is replaced by "ScalerSmoothedExample" to yield:
/**
* @file
* @brief Linear multichannel smoothly varying scaler
*/
#ifndef _MOD_SCALERSMOOTHEDEXAMPLE_H
#define _MOD_SCALERSMOOTHEDEXAMPLE_H
#include "ModCommon.h"
#include "MathHelper.h""By making changes to the template files, you can make wholesale changes to the entire module library.
The template files also contain special forms of preprocessor directives – independent of the standard C preprocessor directives. Further down in awe_module_template.h, you'll find the function declarations:
void $processFunctionName$(void *pInstance);
##if $useCustomSetFunction$
UINT $setFunctionName$(void *pInstance, UINT mask);
##endif
##if $useCustomGetFunction$
UINT $getFunctionName$(void *pInstance);
##endif
##if $useCustomBypassFunction$
void $bypassFunctionName$(void *pInstance);
##endifThe symbols ## identify a preprocessor directive reserved for the code generator. The directives are evaluated during code generation based on the values of the variables, for example the value of $useCustomSetFunction$ determines if code will be eliminated or exist in the generated file. The scaler smoothed example module has:
$useCustomSetFunction$defined as 1$useCustomGetFunction$defined as 0$useCustomBypassFunction$defined as 0.
This yields the generated header code:
void awe_modScalerSmoothedExampleProcess(void *pInstance);
UINT32 awe_modScalerSmoothedExampleSet(void *pInstance, UINT32 mask);The variables used during template substitution are referred to as "code markers". Many code markers are generated automatically by the awe_generate_module.m function. Some code markers are explicitly defined in scaler_smoothed_example_module.m.
awe_addcodemarker(M, 'processFunction', 'Insert:InnerScalerSmoothed_Process.c');
awe_addcodemarker(M, 'setFunction', 'Insert:InnerScalerSmoothed_Set.c');
awe_addcodemarker(M, 'srcFileInclude', '#include "FilterDesign.h"');Code markers beginning with the string "Insert:" cause input to be read from a specified file. For example, the processing function template in awe_module_template.c is:
AWE_FAST_CODE
void $processFunctionName$(void *pInstance)
{
##if $usePreProcessFunction$
{
$preProcessFunction$
}
##endif
$processFunction$
##if $usePostProcessFunction$
{
$postProcessFunction$
}
##endif
}The string $processFunction$ is taken from the file Inner\InnerScalerSmoothedExample_Process.c
shown in InnerScalerSmoothedExample_Process.c. You'll note that this is bare code missing even the function definition (which is in the template file). The other code markers – "preProcessFunction" and "postProcessFunction" are not defined. After template substitution, we end up with the final processing function ModScalerSmoothedExample.c shown in ModScalerSmoothedExample.c.
Building the Audio Module DLL
At this point, the source code for all of the modules in the Examples library has been generated. Open up and rebuild the Visual Studio solution file <AWE>\AWEModules\Source\Examples\Examples.sln.
with the build configuration set to x86 Release. The solution builds the DLL and then copies it into the directory <AWE>\Bin\win32-vc142-rel so that it can be referenced by the Server. Further details on this step can be found in Building Audio Module DLLs | BuildingExamplesDLL.dll.
Summary of Steps Involved in Writing an Audio Module
To summarize, the steps required in writing a new audio module are:
Create the MATLAB module m-file described in Module M-files. It defines:
Input and output pins
Instance structure variables
Links to inner C code.
Documentation
User interface
Module browser for AWE Designer
Write the inner C code for the processing function.
Write the inner C code for the other module functions,
Constructor(),Set(),Get(), andBypass(), if needed.Pick a unique integer ID (any number in the range 32768 to 63487) for the new module class ID. Add this information to the file classids.csv associated with the module library.
Add the module function to the specific module pack library generation script, for example make_examples.m. Run the script file to generate the source code and create the schema file.
Add the generated .c and .h files to the project for building the audio module pack library (e.g., ExamplesLib.vcproj) and build the library.
Build the audio module DLL so that the new modules are visible by the Server.
Scaler Smoothed Example Source Files
The following sections feature expandable code blocks with the contents of example source files.
scaler_smoothed_example_module.m
InnerScalerSmoothedExample_Process.c
InnerScalerSmoothedExample_Set.c
ModScalerSmoothedExample.h
ModScalerSmoothedExample.c
classids.csv
ExamplesSchema.sch
ExamplesSchema.cpp
Note: no example source for ExamplesSchema.cpp is shown, as this is a C file with initialized binary arrays.