Overview

Consumes processing cycles on the target in Set function

Discussion

This module consumes processing cycles on the target in Set function. You specify the number of clock ticks to consume per trigger in to the set function. The units of clock ticks is processor specific, but it matches the information returned by the Audio Weaver profiling function awe_profile.m. When the trigger event happens, the module has a while loop in the set function which waits until the specified number of clock ticks has passed.

The module is used to test BSP implementations. The module's Set function is supposed to be implemented in a separate thread from the processing function. If properly implemented, triggering the Set function should not cause any drop-outs in real-time audio processing. It will interfere with tuning communication (like meter updates).

Type Definition

typedef struct _ModuleCycleBurnerSet
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 numCycles;                              // Number of cycles to consumer per trigger event
    INT32 trigger;                                // Used to trigger cycles consume process in Set function.
} ModuleCycleBurnerSetClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
numCycles	int	parameter	0	0	0:2000000000
trigger	int	state	0	1	Unrestricted

MATLAB Usage

File Name: cycle_burner_set_module.m

 M=cycle_burner_set_module(NAME)
 The cycle burner set module implements wait logic in Set function.  It is useful
 for testing whether BSP code is properly implemented.  Arguments:
    NAME - name of the module.