.. _package-rst-audition:
======================
Package rst.audition
======================
Audio signal processing, sometimes referred to as audio processing,
is the intentional alteration of auditory signals, or sound.
This package contains data type definitions related to audio
processing.
.. seealso::
Wikipedia article containing the definition above
http://en.wikipedia.org/wiki/Audio_signal_processing
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/corlab.css";
node [fontsize=11]
node [fontname="Arial"]
edge [fontsize=11]
edge [fontname="Arial"]
"5" [label=< | SoundChunk |
|
| OCTET-VECTOR | data |
| UINT32 | sample_count |
| UINT32 | channels |
| UINT32 | rate |
| SampleType | sample_type |
| EndianNess | endianness |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | EndianNess |
|
| ENDIAN_LITTLE | 0 |
| ENDIAN_BIG | 1 |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | SampleType |
|
| SAMPLE_S8 | 0 |
| SAMPLE_U8 | 1 |
| SAMPLE_S16 | 2 |
| SAMPLE_U16 | 4 |
| SAMPLE_S24 | 8 |
| SAMPLE_U24 | 16 |
>,shape=box,style=filled,fillcolor="white"];
"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"];
"5" -> "7" [dir=both,arrowtail=odiamond];
"5" -> "6" [dir=both,arrowtail=odiamond];
"5":endianness -> "7" [];
"5":sample_type -> "6" [];
"1" -> "3" [dir=both,arrowtail=odiamond];
"1":data -> "2" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`FormattedSoundChunk `
* :ref:`FloatSoundArray `
* :ref:`InterauralTimeDifference `
* :ref:`SoundChunk `
.. 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-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/FormattedSoundChunk.proto
:lines: 14-45
: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-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/FormattedSoundChunk.proto
:lines: 21-27
: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-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/FloatSoundArray.proto
:lines: 11-17
: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-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/InterauralTimeDifference.proto
:lines: 11-39
:language: protobuf
:emphasize-lines: 7-7,15-15,21-21,27-27
.. _message-rst-audition-soundchunk:
Message SoundChunk
------------------
.. container:: message-rst-audition-soundchunk-multi
.. container:: message-rst-audition-soundchunk-documentation
.. py:class:: rst.audition.SoundChunk
**Constraint**: ``len(.data) == 8 * .channels * .sample_count * TODO(.sample_type)``
Objects of this represent a chunk of an audio stream.
The audio information for one or more :py:attr:`channels ` is stored in
:py:attr:`data ` as a sequence of :py:attr:`sample_count ` encoded samples, the
encoding of which is described by :py:attr:`endianness ` and :py:attr:`sample_type `.
Depending on the sample rate (:py:attr:`rate `), such a chunk of audio
corresponds to a certain amount of time during which its samples
have been recorded.
Interpretation of RSB timestamps:
create:
Capture time of the audio buffer. More precisely, the
timestamp should correspond to the first sample contained
in the buffer.
.. codeauthor:: David Klotz
.. py:attribute:: data
:type: :py:class:`OCTET-VECTOR`
TODO
.. py:attribute:: sample_count
:type: :py:class:`UINT32`
**Unit**: number
TODO
.. py:attribute:: channels
:type: :py:class:`UINT32`
**Unit**: number
TODO
.. py:attribute:: rate
:type: :py:class:`UINT32`
**Unit**: hz
TODO
.. py:attribute:: sample_type
:type: :py:class:`rst.audition.SoundChunk.SampleType`
TODO
.. py:attribute:: endianness
:type: :py:class:`rst.audition.SoundChunk.EndianNess`
TODO
.. container:: message-rst-audition-soundchunk-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/SoundChunk.proto
:lines: 27-107
:language: protobuf
:emphasize-lines: 49-49,55-55,61-61,67-67,72-72,77-77
.. _message-rst-audition-soundchunk-sampletype:
Message SampleType
------------------
.. container:: message-rst-audition-soundchunk-sampletype-multi
.. container:: message-rst-audition-soundchunk-sampletype-documentation
.. py:class:: rst.audition.SoundChunk.SampleType
TODO
.. py:attribute:: SAMPLE_S8
= 0
Signed 8-bit samples.
.. py:attribute:: SAMPLE_U8
= 1
Unsigned 8-bit samples.
.. py:attribute:: SAMPLE_S16
= 2
Signed 16-bit samples.
.. py:attribute:: SAMPLE_U16
= 4
Unsigned 16-bit samples.
.. py:attribute:: SAMPLE_S24
= 8
Signed 24-bit samples.
.. py:attribute:: SAMPLE_U24
= 16
Unsigned 24-bit samples.
.. container:: message-rst-audition-soundchunk-sampletype-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/SoundChunk.proto
:lines: 32-62
:language: protobuf
:emphasize-lines: 5-5,10-10,15-15,20-20,25-25,30-30
.. _message-rst-audition-soundchunk-endianness:
Message EndianNess
------------------
.. container:: message-rst-audition-soundchunk-endianness-multi
.. container:: message-rst-audition-soundchunk-endianness-documentation
.. py:class:: rst.audition.SoundChunk.EndianNess
TODO
.. py:attribute:: ENDIAN_LITTLE
= 0
*Not documented*
.. py:attribute:: ENDIAN_BIG
= 1
*Not documented*
.. container:: message-rst-audition-soundchunk-endianness-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.10-merge-simulator/rst-manual/../rst-proto/proto/stable/rst/audition/SoundChunk.proto
:lines: 67-70
:language: protobuf
:emphasize-lines: 2-2,3-3