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.

See also

Wikipedia article containing the definition above

http://en.wikipedia.org/wiki/Audio_signal_processing

Messages

• FormattedSoundChunk
• FloatSoundArray
• InterauralTimeDifference
• SoundChunk

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;

}

Message SoundChunk

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 channels is stored in data as a sequence of sample_count encoded samples, the encoding of which is described by endianness and sample_type.

Depending on the sample rate (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.

Code author: David Klotz <dklotz@techfak.uni-bielefeld.de>

data

Type :OCTET-VECTOR

TODO

sample_count

Type :UINT32

Unit: number

TODO

channels

Type :UINT32

Unit: number

TODO

rate

Type :UINT32

Unit: hz

TODO

sample_type

Type :rst.audition.SoundChunk.SampleType

TODO

endianness

Type :rst.audition.SoundChunk.EndianNess

TODO

Download this file

message SoundChunk {

    /**
     * TODO
     */
    enum SampleType {
        /**
         * Signed 8-bit samples.
         */
        SAMPLE_S8 = 0;

        /**
         * Unsigned 8-bit samples.
         */
        SAMPLE_U8 = 1;

        /**
         * Signed 16-bit samples.
         */
        SAMPLE_S16 = 2;

        /**
         * Unsigned 16-bit samples.
         */
        SAMPLE_U16 = 4;

        /**
         * Signed 24-bit samples.
         */
        SAMPLE_S24 = 8;

        /**
         * Unsigned 24-bit samples.
         */
        SAMPLE_U24 = 16;
    }

    /**
     * TODO
     */
    enum EndianNess {
        ENDIAN_LITTLE = 0;
        ENDIAN_BIG = 1;
    }

    /**
     * TODO
     */
    required bytes data = 1;

    /**
     * TODO
     */
    // @unit(number)
    required uint32 sample_count = 2;

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

    /**
     * TODO
     */
    // @unit(hz)
    optional uint32 rate = 4 [default = 44100];

    /**
     * TODO
     */
    optional SampleType sample_type = 5 [default = SAMPLE_S16];

    /**
     * TODO
     */
    optional EndianNess endianness = 6 [default = ENDIAN_LITTLE];

    // TODO: interleaving type?

}

Message SampleType

class rst.audition.SoundChunk.SampleType

TODO

SAMPLE_S8

= 0

Signed 8-bit samples.

SAMPLE_U8

= 1

Unsigned 8-bit samples.

SAMPLE_S16

= 2

Signed 16-bit samples.

SAMPLE_U16

= 4

Unsigned 16-bit samples.

SAMPLE_S24

= 8

Signed 24-bit samples.

SAMPLE_U24

= 16

Unsigned 24-bit samples.

Download this file

    enum SampleType {
        /**
         * Signed 8-bit samples.
         */
        SAMPLE_S8 = 0;

        /**
         * Unsigned 8-bit samples.
         */
        SAMPLE_U8 = 1;

        /**
         * Signed 16-bit samples.
         */
        SAMPLE_S16 = 2;

        /**
         * Unsigned 16-bit samples.
         */
        SAMPLE_U16 = 4;

        /**
         * Signed 24-bit samples.
         */
        SAMPLE_S24 = 8;

        /**
         * Unsigned 24-bit samples.
         */
        SAMPLE_U24 = 16;
    }

Message EndianNess

class rst.audition.SoundChunk.EndianNess

TODO

ENDIAN_LITTLE

= 0

Not documented

ENDIAN_BIG

= 1

Not documented

Download this file

    enum EndianNess {
        ENDIAN_LITTLE = 0;
        ENDIAN_BIG = 1;
    }