<apex:devices xmlns:apex="http://med.kuleuven.be/exporl/apex/4.1.2/experiment">
  <master>{0,1}</master>
  <device id="">{0,unbounded}</device>
</apex:devices>

<xs:element name="devices" type="apex:devicesType"/>

<xs:element name="master" type="xs:IDREF" minOccurs="0" maxOccurs="1">
  <xs:annotation>
    <xs:documentation>The master device is that last one to be started after all stimuli are loaded for all devices. This feature can be used when using triggers to synchronize devices.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="device" type="apex:deviceType" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>All real devices derive from this base.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="driver" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Driver architecture to be used for sound output</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="dummy">
        <xs:annotation>
          <xs:documentation>Dummy soundcard</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="portaudio">
        <xs:annotation>
          <xs:documentation>Portaudio is a cross-platform audio framework</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="qtaudio">
        <xs:annotation>
          <xs:documentation>Qt Multimedia framework</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="asio">
        <xs:annotation>
          <xs:documentation>ASIO is a proprietary windows/mac-only audio framework by Steinberg. Use it if low latency/more then 2 channels is required.</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="coreaudio">
        <xs:annotation>
          <xs:documentation>CoreAudio is MacOsX' audio framework.</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="jack">
        <xs:annotation>
          <xs:documentation>Jack is a cross-platform audio framework. A jack connection will be made to the "drivername" specified in the main config file.</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="card" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Name of the soundcard to be used. Cards are defined in the main config file. Every soundcard in the system can be enumerated in the main configfile. Use the ID defined there. Otherwise the "default" card can be used.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="channels" type="xs:positiveInteger">
  <xs:annotation>
    <xs:documentation>Number of output channels to be used. This is restricted by the selected driver, with a maximum of 2 for portaudio.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="gain" type="apex:channelGainType" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>Final gain of the device, implemented with a software mixer.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="samplerate">
  <xs:annotation>
    <xs:documentation>Sample rate of the device. Warning: not all sample rates are supported by all devices and some drivers automatically convert to other sample rates. Check your sound card documentation.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="16000"/>
      <xs:enumeration value="44100"/>
      <xs:enumeration value="96000"/>
      <xs:enumeration value="32000"/>
      <xs:enumeration value="48000"/>
      <xs:enumeration value="8000"/>
      <xs:enumeration value="22050"/>
      <xs:enumeration value="72000"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="buffersize" minOccurs="0" type="xs:positiveInteger">
  <xs:annotation>
    <xs:documentation>Applies to the soundcard buffer size, not the internal apex buffer size. Larger sizes are more efficient, smaller sizes have smaller latencies. Some notes: for asio, latency is always ( 2 * buffersize + overhead ) / samplerate. The overhead is very small, eg 16 samples for an Rme Multiface. Portaudio however always uses a number of internal buffers, mostly 4. Hence, actual latency is ( 2 * 4 * buffersize + overhead ) / samplerate. For asio/jack: must be set to the system buffer size.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="blocksize" minOccurs="0" type="xs:positiveInteger">
  <xs:annotation>
    <xs:documentation>Applies to the block size that is used in the internal apex audio streams (for filters etc.). Larger sizes are more efficient, smaller sizes have smaller latencies. If not defined, the soundcard buffersize will be used.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="buffersize_apex" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Size of internal apex sound buffer in seconds. This buffer ensures that no buffer underruns occur. The default value is 1s. If continuous filters are used, the system will need this amount of seconds before the next stimulus can be output. Note that the value in seconds is rounded down to the nearest multiple of 8192 samples (the buffersize used to fill the buffer): so using 1 second here, with a samplerate of 44100, the actual amount of time will be 40960 samples / 44100 samples/sec = 0.9 seconds. If a buffersize smaller than 16384 samples is specified, a buffer of 16384 samples will be used.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:decimal">
      <xs:minExclusive value="0"/>
      <xs:maxInclusive value="60"/>
    </xs:restriction>
  </xs:simpleType>
  <!--xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:enumeration value="0.5"/>
                          <xs:enumeration value="1"/>
                          <xs:enumeration value="1.5"/>
                          <xs:enumeration value="2"/>
                          <xs:enumeration value="3"/>
                          <xs:enumeration value="4"/>
                          <xs:enumeration value="5"/>
                          <xs:enumeration value="10"/>
                        </xs:restriction>
                      </xs:simpleType-->
</xs:element>

<xs:element name="padzero" type="xs:nonNegativeInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>If smaller than 16: add padzero*8196 samples to the end of each stream. If larger than 16: add padzero samples to the end of each stream. This avoids dropping of the last N frames on some soundcards (notoriously LynxOne and FirefaceUC)</xs:documentation>
  </xs:annotation>
</xs:element>

<cisim>
  <number_electrodes>{1,1}</number_electrodes>
  <pulserate>{1,1}</pulserate>
  <noiseband electrode="">{1,unbounded}</noiseband>
</cisim>

<xs:element name="cisim" type="apex:cisimType" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Parameters for automatic CI simulation</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="number_electrodes" type="xs:positiveInteger"/>

<xs:element name="pulserate" type="xs:integer"/>

<xs:element name="noiseband" minOccurs="1" maxOccurs="unbounded">
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:IDREF">
        <xs:attribute name="electrode" type="xs:positiveInteger"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

<xs:element name="plugin" type="xs:anyURI"/>

<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded">
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:string">
        <xs:attributeGroup ref="apex:filterParam"/>
        <xs:attribute name="name" type="xs:Name" use="required"/>
        <xs:attribute name="channel" type="xs:nonNegativeInteger" use="optional"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

<xs:element name="device" type="xs:string">
  <xs:annotation>
    <xs:documentation>Device identifier. For NIC 2, this identifier consists of three parts: the device type (e.g. l34) , the implant type (e.g. cic3, cic4) and the device number (e.g. 1, ordered according to the assigned COM port, device 0 is a simulated device).</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="trigger">
  <xs:annotation>
    <xs:documentation>Generate or use a trigger from the audio port. Currently the trigger button status is not checked (nicv2 doesn't allow this yet)</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="in"/>
      <xs:enumeration value="out"/>
      <xs:enumeration value="none"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="powerup_count" minOccurs="0" default="4000" type="xs:nonNegativeInteger">
  <xs:annotation>
    <xs:documentation>Number of powerup pulses to send. No powerup pulses will be sent if this is set to 0.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="volume" minOccurs="0">
  <xs:complexType>
    <xs:annotation>
      <xs:documentation>Volume parameter for Cochlear device. The current level (in clinical units) is calculated according the following formula: round(t + (c-t) * volume/100 * mag) Where: t=treshold level c=comfort level volume=current value of volume parameter mag=magnitude [0,1]</xs:documentation>
    </xs:annotation>
    <xs:simpleContent>
      <xs:extension base="apex:volumeParam">
        <xs:attributeGroup ref="apex:filterParam"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

<defaultmap>
  <inline id="">{1,1}</inline>
  <from_r126>{1,1}</from_r126>
</defaultmap>

<xs:element name="defaultmap">
  <xs:annotation>
    <xs:documentation>Defines the default subject map to be used</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:choice>
      <xs:element name="inline" type="apex:CohMap">
        <xs:annotation>
          <xs:documentation>The map is defined below</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="from_r126">
        <xs:annotation>
          <xs:documentation>The user can select the map from the R126 wizard. R126 is the clinical fitting software.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:choice>
  </xs:complexType>
</xs:element>

<inline id="">
  <number_electrodes>{1,1}</number_electrodes>
  <mode>{1,1}</mode>
  <pulsewidth>{1,1}</pulsewidth>
  <pulsegap>{1,1}</pulsegap>
  <period>{1,1}</period>
  <trigger>{0,1}</trigger>
  <channel comfort="" electrode="" number="" threshold="">{1,22}</channel>
</inline>

<xs:element name="inline" type="apex:CohMap">
  <xs:annotation>
    <xs:documentation>The map is defined below</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="number_electrodes">
  <xs:simpleType>
    <xs:restriction base="xs:positiveInteger">
      <xs:maxInclusive value="22"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="mode" type="apex:CohModeEnum">
  <xs:annotation>
    <xs:documentation>Stimulation mode; bipolar modes use a lower, reverse bipolar modes a higher reference electrode.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="pulsewidth">
  <xs:annotation>
    <xs:documentation>When using a Freedom processor, the maximum phasewidth is 429.8us When using an L34 processor, the maximum phasewidth is 434.4us</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:double">
      <xs:minInclusive value="25"/>
      <xs:maxInclusive value="434.4"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="pulsegap">
  <xs:annotation>
    <xs:documentation>When using a Freedom processor, the maximum phase gap is 57us When using an L34 processor, the maximum phase gap is 58us When using a cic3 implant, the minimum phase gap is 8us When using a cic4 implant, the minimum phase gap is 7us</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:double">
      <xs:minInclusive value="7"/>
      <xs:maxInclusive value="58"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="period">
  <xs:annotation>
    <xs:documentation>When using a Freedom processor, the maximum period is 13078us When using an L34 processor, the maximum period is 13107us When using a cic3 implant, the minimum period is 70us When using a cic4 implant, the minimum period is 64.6us</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:double">
      <xs:minInclusive value="64.6"/>
      <xs:maxInclusive value="13107"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="trigger" minOccurs="0" default="none">
  <xs:annotation>
    <xs:documentation>"all" will result in all pulses having triggers. "none" will result in no pulses having triggers. "first" will result in the first pulses that needs mapping to have a trigger, the ones afterward will have no trigger.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="all"/>
      <xs:enumeration value="none"/>
      <xs:enumeration value="first"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="channel" minOccurs="1" maxOccurs="22">
  <xs:complexType>
    <xs:attribute name="number" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:positiveInteger">
          <xs:maxInclusive value="22"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="electrode" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:positiveInteger">
          <xs:maxInclusive value="22"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="threshold" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:nonNegativeInteger">
          <xs:maxInclusive value="255"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="comfort" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:nonNegativeInteger">
          <xs:maxInclusive value="255"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

<xs:element name="from_r126">
  <xs:annotation>
    <xs:documentation>The user can select the map from the R126 wizard. R126 is the clinical fitting software.</xs:documentation>
  </xs:annotation>
</xs:element>

<filter id="">
  <device>{1,1}</device>
  <channels>{1,1}</channels>
  <continuous>{0,1}</continuous>
</filter>

<xs:element name="filter" minOccurs="0" maxOccurs="unbounded" type="apex:filterType">
  <xs:annotation>
    <xs:documentation>Every filter/generator derives from this base type. All filters to be used are defined here.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="device" type="xs:IDREF">
  <xs:annotation>
    <xs:documentation>ID of the device to which this filter belongs. The mode of the filter (online or offline) is determined by the device.</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="channels" type="xs:positiveInteger">
  <xs:annotation>
    <xs:documentation>Number of channels</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="continuous" type="xs:boolean" minOccurs="0">
  <xs:annotation>
    <xs:documentation>If continuous==true, the filter/generator keeps on running between trials (ie while the user is entering input). Only makes sense for generators.</xs:documentation>
    <!-- FIXME: move to generator -->
  </xs:annotation>
</xs:element>

<xs:element name="type">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="noise">
        <xs:annotation>
          <xs:documentation>White noise (this is NOT gaussian noise)</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <!--xs:enumeration value="square">
                                    <xs:annotation>
                                    <xs:documentation>Square wave with peak amplitude = total
                                    gain</xs:documentation>
                                    </xs:annotation>
                                    </xs:enumeration-->
      <xs:enumeration value="sinus">
        <xs:annotation>
          <xs:documentation>Sinus with peak amplitude = total gain</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
      <!--xs:enumeration value="triangle">
                                    <xs:annotation>
                                    <xs:documentation>Triangle with peak amplitude = total
                                    gain</xs:documentation>
                                    </xs:annotation>
                                    </xs:enumeration-->
      <xs:enumeration value="singlepulse">
        <xs:annotation>
          <xs:documentation>Single pulse with peak amplitude = total gain. The polarity is set using the "polarity" parameter.</xs:documentation>
        </xs:annotation>
      </xs:enumeration>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="basegain" type="xs:double" default="0" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The total gain is basegain+gain. Basegain is useful for amplitude normalization between different blocks</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="invertgain" type="xs:boolean" default="false" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Inverts the gain of the block (but not the basegain). Invertgain is useful for the attenuation of noise depending on an SNR</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="gain" default="0" type="apex:gainparam">
  <xs:annotation>
    <xs:documentation>The total gain is basegain+gain. Gain is a parameter that can be changed by other modules</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="frequency" default="1000">
  <xs:annotation>
    <xs:documentation>Frequency: only makes sense for sinus, square and triangle</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:nonNegativeInteger">
        <xs:attributeGroup ref="apex:filterParam"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

<xs:element name="phase" default="0">
  <xs:annotation>
    <xs:documentation>Phase (rad): only makes sense for sinus, square and triangle</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:double">
        <xs:attributeGroup ref="apex:filterParam"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

<xs:element name="pulsewidth" default="1" type="xs:positiveInteger" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Pulse width in samples. Currently only used for single pulse generator</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="polarity" minOccurs="0" default="positive">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="positive"/>
      <xs:enumeration value="negative"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<xs:element name="basegain" type="apex:gainparam" default="0" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The total gain is basegain+gain. Basegain is useful for amplitude normalization between different blocks</xs:documentation>
  </xs:annotation>
</xs:element>

<xs:element name="invertgain" type="xs:boolean" default="false" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Inverts the gain of the block (but not the basegain). Invertgain is useful for the attenuation of noise depending on an SNR</xs:documentation>
  </xs:annotation>
</xs:element>