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

• SoundChunkCollection
• SoundChunk

clearer: should be made invisible via css

Message SoundChunkCollection

class rst.audition.SoundChunkCollection

Collection of SoundChunk instances.

Auto-generated.

element

Type:array of rst.audition.SoundChunk

The individual elements of the collection.

Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific.

Download this file

message SoundChunkCollection {

    /**
     * The individual elements of the collection.
     *
     * Constraints regarding the empty collection, sorting, duplicated
     * entries etc. are use case specific.
     */
    repeated SoundChunk element = 1;

}

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>

@create_collection

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;
    }