.. _package-rst-audition:
======================
Package rst.audition
======================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"4" [label=< | InterauralTimeDifference |
|
| FLOAT32 | value |
| FLOAT32 | weight |
| FLOAT32 | frame_shift |
| FLOAT32 | time_window |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | FormattedSoundChunk |
|
| FloatSoundArray | data |
| UINT32 | rate |
| UINT32 | channels |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | ChannelType |
|
| ALL | 0 |
| LEFT | 1 |
| RIGHT | 2 |
| FRONT | 3 |
| REAR | 4 |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | FloatSoundArray |
|
| FLOAT32 | floatbuffer |
>,shape=box,style=filled,fillcolor="white"];
"1" -> "3"[dir=both,arrowtail=odiamond];
"1":data -> "2"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`FormattedSoundChunk `
* :ref:`FloatSoundArray `
* :ref:`InterauralTimeDifference `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-audition-formattedsoundchunk:
Message FormattedSoundChunk
---------------------------
.. container:: message-rst-audition-formattedsoundchunk-multi
.. container:: message-rst-audition-formattedsoundchunk-documentation
.. py:class:: rst.audition.FormattedSoundChunk
Deinterleaved sound chunk data needed by audiocues component.
.. todo::
What is deinterleaved sound chunk data?
.. codeauthor:: Antoine Deleforge
.. py:attribute:: data
:type: array of :py:class:`rst.audition.FloatSoundArray`
TODO
.. py:attribute:: rate
:type: :py:class:`UINT32`
TODO
@unit(hz?)
.. py:attribute:: channels
:type: :py:class:`UINT32`
**Unit**: number
TODO
.. container:: message-rst-audition-formattedsoundchunk-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/deprecated/rst/audition/FormattedSoundChunk.proto
:lines: 16-47
:language: protobuf
:emphasize-lines: 19-19,25-25,31-31
.. _message-rst-audition-formattedsoundchunk-channeltype:
Message ChannelType
-------------------
.. container:: message-rst-audition-formattedsoundchunk-channeltype-multi
.. container:: message-rst-audition-formattedsoundchunk-channeltype-documentation
.. py:class:: rst.audition.FormattedSoundChunk.ChannelType
See alaudio/alsoundextractor.h from aldebaran for more
information.
.. todo::
this explanation is not helpful
.. py:attribute:: ALL
= 0
*Not documented*
.. py:attribute:: LEFT
= 1
*Not documented*
.. py:attribute:: RIGHT
= 2
*Not documented*
.. py:attribute:: FRONT
= 3
*Not documented*
.. py:attribute:: REAR
= 4
*Not documented*
.. container:: message-rst-audition-formattedsoundchunk-channeltype-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/deprecated/rst/audition/FormattedSoundChunk.proto
:lines: 23-29
:language: protobuf
:emphasize-lines: 2-2,3-3,4-4,5-5,6-6
.. _message-rst-audition-floatsoundarray:
Message FloatSoundArray
-----------------------
.. container:: message-rst-audition-floatsoundarray-multi
.. container:: message-rst-audition-floatsoundarray-documentation
.. py:class:: rst.audition.FloatSoundArray
Deinterleaved float array needed by audiocues component
.. todo::
what is a deinterleaved float array?
.. codeauthor:: Antoine Deleforge
.. py:attribute:: floatbuffer
:type: array of :py:class:`FLOAT32`
**Unit**: TODO
TODO
.. container:: message-rst-audition-floatsoundarray-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/deprecated/rst/audition/FloatSoundArray.proto
:lines: 13-19
:language: protobuf
:emphasize-lines: 6-6
.. _message-rst-audition-interauraltimedifference:
Message InterauralTimeDifference
--------------------------------
.. container:: message-rst-audition-interauraltimedifference-multi
.. container:: message-rst-audition-interauraltimedifference-documentation
.. py:class:: rst.audition.InterauralTimeDifference
**Constraint**: ``len(.value) = len(.weight)``
Interaural time difference measurements.
.. codeauthor:: TODO Vasil
.. py:attribute:: value
:type: array of :py:class:`FLOAT32`
**Unit**: seconds
TODO ITD values
.. py:attribute:: weight
:type: array of :py:class:`FLOAT32`
**Constraint**: ``sum to 1``
**Constraint**: ``0 <= value <= 1``
**Unit**: number
TODO Weights of the ITD value
.. py:attribute:: frame_shift
:type: :py:class:`FLOAT32`
**Unit**: second
TODO Frame shift between time windows
.. py:attribute:: time_window
:type: :py:class:`FLOAT32`
**Unit**: second
Length of the time window to compute an ITD value.
.. container:: message-rst-audition-interauraltimedifference-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/deprecated/rst/audition/InterauralTimeDifference.proto
:lines: 13-41
:language: protobuf
:emphasize-lines: 7-7,15-15,21-21,27-27