Package rst.audition

Not documented

Messages

• FormattedSoundChunk
• FloatSoundArray
• InterauralTimeDifference

clearer: should be made invisible via css

Message FormattedSoundChunk

class rst.audition.FormattedSoundChunk

Deinterleaved sound chunk data needed by audiocues component.

Todo

What is deinterleaved sound chunk data?

Code author: Antoine Deleforge <antoine.deleforge@inrialpes.fr>

data

Type:array of rst.audition.FloatSoundArray

TODO

rate

Type:UINT32

TODO @unit(hz?)

channels

Type:UINT32

Unit: number

TODO

Download this file

message FormattedSoundChunk {

    /**
     * See alaudio/alsoundextractor.h from aldebaran for more
     * information.
     * @todo "this explanation is not helpful"
     */
    enum ChannelType {
        ALL   = 0;
        LEFT  = 1;
        RIGHT = 2;
        FRONT = 3;
        REAR  = 4;
    }

    /**
     * TODO
     */
    repeated FloatSoundArray data = 1;

    /**
     * TODO
     */
    // @unit(hz?)
    required uint32          rate = 2;

    /**
     * TODO
     */
    // @unit(number)
    optional uint32      channels = 3 [default = 2];
};

Message ChannelType

class rst.audition.FormattedSoundChunk.ChannelType

See alaudio/alsoundextractor.h from aldebaran for more information.

Todo

this explanation is not helpful

ALL

= 0

Not documented

LEFT

= 1

Not documented

RIGHT

= 2

Not documented

FRONT

= 3

Not documented

REAR

= 4

Not documented

Download this file

    enum ChannelType {
        ALL   = 0;
        LEFT  = 1;
        RIGHT = 2;
        FRONT = 3;
        REAR  = 4;
    }

Message FloatSoundArray

class rst.audition.FloatSoundArray

Deinterleaved float array needed by audiocues component

Todo

what is a deinterleaved float array?

Code author: Antoine Deleforge <antoine.deleforge@inrialpes.fr>

floatbuffer

Type:array of FLOAT32

Unit: TODO

TODO

Download this file

message FloatSoundArray {
    /**
     * TODO
     */
    // @unit(TODO)
    repeated float floatbuffer = 1;
};

Message InterauralTimeDifference

class rst.audition.InterauralTimeDifference

Constraint: len(.value) = len(.weight)

Interaural time difference measurements.

Code author: TODO Vasil <Khalidov> <vasil.khalidov@idiap.ch>

value

Type:array of FLOAT32

Unit: seconds

TODO ITD values

weight

Type:array of FLOAT32

Constraint: sum to 1

Constraint: 0 <= value <= 1

Unit: number

TODO Weights of the ITD value

frame_shift

Type:FLOAT32

Unit: second

TODO Frame shift between time windows

time_window

Type:FLOAT32

Unit: second

Length of the time window to compute an ITD value.

Download this file

message InterauralTimeDifference {

    /**
     * TODO ITD values
     */
    // @unit(seconds)
    repeated float value = 1;

    /**
     * TODO Weights of the ITD value
     */
    // @constraint(sum to 1)
    // @constraint(0 <= value <= 1)
    // @unit(number)
    repeated float weight = 2;

    /**
     * TODO Frame shift between time windows
     */
    // @unit(second)
    required float frame_shift = 3;

    /**
     * Length of the time window to compute an ITD value.
     */
    // @unit(second)
    required float time_window = 4;

}