Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This document describes the Audio Weaver modules and module library. The MATLAB scripting interface is described in Audio Weaver Matlab MATLAB Scripting API Guide. Read more about the graphical designer in Audio Weaver AWE Designer User’s User Guide.​

Module Library Organization

...

  • Float32 – standard 32-bit floating-point with 1 sign bit, 8 exponent bits, and 23 mantissa bits.

  • Int32 – Standard twos complement 32-bit integer. The signed values are in the range [-2^{31},+(2^{31})][−231,+(231)].

  • Fract32 – Fractional representation where values are scaled in the range [-1 +1)[−1+1) . This is standard integer representation with an implied scale factor of 2^{-31}2−31 .

...

At the top of the module browser, there is a checkbox to filter based on the different module data types. (See abovebelow.). This will filter out modules for hardware that operates on specific sample data type (fract32 for fixed-point). The integer module libraries are typically used for control operations and work on both fixed-point and floating-point targets. The type convert module allows any data type to transfer into the others. This may be destructive if converting to a type with lower resolution.

...

Module Browser overview

Audio Weaver modules are organized into separate browser folders based on their function. The folders are arranged in alphabetical order titled with a short description of the contents. A search bar can be found directly above the browser window. To use the search bar, type the name or some common tag for the wanted module and press enter.

...

Audio Weaver Designer has two modes: Design mode and Tuning mode. In Design mode, design signal flow: by adding modules, making connections, and setting parameters. Tuning mode occurs when the designed layout is run. The layout can only be run if all modules have valid connections. Run the layout by clicking the play button at the top or by right clicking the canvas and selecting “Build and Run.” Tuning mode allows for parameter changes only: no changes to the wiring or structure of the block diagram.

Viewing Module Properties
Anchor
Viewing-Module-Properties
Viewing-Module-Properties

An audio module gets instantiated when dragged to the canvas from the Module Browser, located on the left hand side of the canvas. Module arguments can only be changed in Design mode and affect memory allocation, pins, and wiring. Module variables are tunable parameters which can be changed in either mode. Arguments tend to define memory allocation for the module, which can’t be changed during runtime. For example, in an FIR filter, the length of the filter (number of taps) is specified as an argument. This length affects memory allocation and as a result setting these arguments is only allowed in Design mode. The FIR coefficients (a variable) can change at any time.

After a module is instantiated, change its arguments and variables by right-clicking and selecting “View Properties”. (See above.) which will open up the properties manager at the bottom. (See below.)

...

Properties.”

...

This opens up the Module Properties manager beneath the AWE Designer canvas:

...

In the Matlab code for an FIR module, the module properties maps directly to the function arguments: M=fir_module(NAME, L)

...

Tunable Variables and Inspectors

...

To show variable values, select “Module Variables” under the View menu. With variables shown, it appears as:

...

Module Status

Each module has an associated runtime status with 4 possible values:

...

Wire information is resolved through a process known as pin propagation. The wire information is known from the system input and this information is propagated in module order until it reaches the system output pin. To trigger pin propagation, click on the Propagate changes button ( ) on the toolbar. Alternatively, right-click on an empty part of the canvas and select “Redraw” from the context menu. If there is a wiring error and pin propagation is unable to complete, an error sound will play. To find out more details to this error, run the system.

...

Feedback Wires
Anchor
FeedbackWires
FeedbackWires

Feedback occurs when a wire is routed backwards to an input earlier in the system. Feedback wires must be manually specified.

...

Wire size information must be set using the “Feedback Properties” dialog which is reached by right-clicking on the feedback wire. The following dialogue box opens, allowing the ability to set the wire’s block size, number of channels, sample rate, data type, and whether or not it is complex. This should match the pins that the wire is connecting.

...

Block Size

Each hardware target has a fundamental block size to specify how many samples per block are handled by the real-time audio I/O functions. This is shown on the Server window when the Server launches. (See below.)

...