Table Of Contents

Previous topic

Files

Next topic

Hardware Descriptor File

This Page

Platform Descriptor File

The following block declarations are made in the platform descriptor file. They represent hardware resources available on the hardware platform.


AudioDomain


AudioIn

AudioIn is a signal block bundle defined in the platform descriptor file. It enables access to the audio input hardware resources available on the hardware platform.

The audio stream output port values are between +/- 1.0.

# AudioIn declaration, where 'SIZE' represents the number of available audio inputs
signal AudioIn [SIZE] {
        default:        0.0
        rate:           AudioRate
        reset:          MasterReset
        meta:           'Audio Input'
}

_audioCODEC_x >> AudioIn[x];

AudioOut

AudioOut is a signal block bundle defined in the platform descriptor file. It enables access to the audio output hardware resources available on the hardware platform.

The audio stream input port accepts values between +/- 1.0. Values outside this range are clipped.

#AudioOut declaration, where 'SIZE' represents the number of available audio outputs
signal AudioOut [SIZE] {
        default:        0.0
        rate:           AudioRate
        reset:          MasterReset
        meta:           'Audio Output'
}

AudioOut[x] >> _audioCODEC_x;

AudioRate

AudioRate is a constant block defined in the platform descriptor file. It holds the sampling rate value of the audio CODEC.

#AudioRate declaration
constant AudioRate {
        value:  48000
        meta:   'Sampling rate of audio ADCs and DACs (Hz)'
}

ControlDomain


ControlIn

ControlIn is a signal block bundle. It enables access to the analog input hardware resources available on the hardware platform.

#ControlIn declaration, where 'SIZE' represents the number of available analog inputs
signal ControlIn [SIZE] {
        default:        0.0
        rate:           ControlRate
        reset:          MasterReset
        meta:           'Analog Input'
}

_analogADC_x >> ControlIn[x];

ControlOut

AudioOut is a signal block bundle. It enables access to the analog output hardware resources available on the hardware platform.

#ControlOut declaration, where 'SIZE' represents the number of available analog outputs
signal ControlOut [Size] {
        default:        0.0
        rate:           ControlRate
        reset:          MasterReset
        meta:           'Analog Output'
}

ControlOut[x] >> _analogDAC_x;

ControlRate

ControlRate is a constant block defined in the hardware descriptor file. It holds the sampling rate value of the analong analog-to-digital and digital-to-analong converters.

# ControlRate declaration
constant ControlRate {
        value:  2048
        meta:   'Sampling rate of analog ADCs and DACs (Hz)'
}

DigitalIn

DigitalIn is a switch block bundle. It enables access to the digital input hardware resources available on the hardware platform.

#DigitalIn declaration, where 'SIZE' represents the number of available digital inputs
switch DigitalIn [Size] {
        default:        off
        reset:          MasterReset
        meta:           'Digital Input Pin'
}

_digitalInputPin_x >> DigitalIn[x];

DigitalOut

DigitalOut is a switch block bundle. It enables access to the digital output hardware resources available on the hardware platform.

#DigitalOut declaration, where 'SIZE' represents the number of available digital outputs
switch DigitalOut [Size] {
        default:        off
        reset:          MasterReset
        meta:           'Digital Output Pin'
}

DigitalOut[x] >> _digitalOutputPin_x;

MasterReset

Master reset switch for all signal and switch blocks.

switch MasterReset {
        value:  off
        meta:   'Default master reset for all blocks'
}

MidiIn

Midi Input


MidiOut

Midi Output


OscIn

OSC Input


OscOut

OSC Output


SerialIn

Serial Input


SerialOut

Serial Output