.. _platformDoc:

.. index:: single: Platform Descriptor File
.. index:: single: Files; Platform Descriptor File

========================
Platform Descriptor File
========================

The following block declarations are made in the :ref:`platform descriptor file <platformDoc>`. They represent hardware resources available on the hardware platform.

* AudioDomain_
* AudioIn_
* AudioOut_
* AudioRate_
* ControlIn_
* ControlOut_
* ControlRate_
* ControlDomain_
* DigitalIn_
* DigitalOut_
* MasterReset_
* MidiIn_
* MidiOut_
* OscIn_
* OscOut_
* SerialIn_
* SerialOut_

----

.. index:: single: AudioDomain
.. _AudioDomain:

AudioDomain
===========

----

.. index:: single: AudioIn
.. _AudioIn:

AudioIn
=======

AudioIn is a :ref:`signal block bundle <signalDoc>` defined in the :ref:`platform descriptor file <platformDoc>`. 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];

----

.. index:: single: AudioOut
.. _AudioOut:

AudioOut
========

AudioOut is a :ref:`signal block bundle <signalDoc>` defined in the :ref:`platform descriptor file <platformDoc>`. 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;

----

.. index:: single: AudioRate
.. _AudioRate:

AudioRate
=========

AudioRate is a :ref:`constant <constantDoc>` block defined in the :ref:`platform descriptor file <platformDoc>`. 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)'
	}

----

.. index:: single: ControlDomain
.. _ControlDomain:

ControlDomain
=============

----
	
.. index:: single: ControlIn
.. _ControlIn:

ControlIn
=========

ControlIn is a :ref:`signal block bundle <signalDoc>`. 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];

----
	
.. index:: single: ControlOut
.. _ControlOut:
	
ControlOut
==========

AudioOut is a :ref:`signal block bundle <signalDoc>`. 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;

----

.. index:: single: ControlRate
.. _ControlRate:

ControlRate
===========

ControlRate is a :ref:`constant <constantDoc>` block defined in the :ref:`hardware descriptor file <hardwareDoc>`. 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)'
	}
	
----

.. index:: single: DigitalIn
.. _DigitalIn:

DigitalIn
=========

DigitalIn is a :ref:`switch block bundle <switchDoc>`. 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];

----

.. index:: single: DigitalOut
.. _DigitalOut:

DigitalOut
==========

DigitalOut is a :ref:`switch block bundle <switchDoc>`. 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;

----

.. index:: single: MasterReset
.. _MasterReset:

MasterReset
===========

Master reset switch for all :ref:`signal <signalDoc>` and :ref:`switch <switchDoc>` blocks.

::

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

.. index:: single: MidiIn
.. _MidiIn:

MidiIn
======

Midi Input

----

.. index:: single: MidiOut
.. _MidiOut:

MidiOut
=======

Midi Output

----

.. index:: single: OscIn
.. _OscIn:

OscIn
=====

OSC Input

----

.. index:: single: OscOut
.. _OscOut:

OscOut
======

OSC Output

----

.. index:: single: SerialIn
.. _SerialIn:

SerialIn
========

Serial Input

----

.. index:: single: SerialOut
.. _SerialOut:

SerialOut
=========

Serial Output