visiannot.tools.ToolsAudio

Module with functions for loading audio files

Summary

Functions

visiannot.tools.ToolsAudio.convertKeyToChannelId(…)	Converts a key to access data (configuration for ViSiAnnoT) to the index of an audio channel
visiannot.tools.ToolsAudio.getAudioWaveFrequency(path)	Loads audio wave and gets frequency
visiannot.tools.ToolsAudio.getDataAudio(path)	Loads audio data

API

Functions

visiannot.tools.ToolsAudio.convertKeyToChannelId(key_data)

Converts a key to access data (configuration for ViSiAnnoT) to the index of an audio channel

The key must contain the word “left” or “right”, otherwise default channel is 0.

Parameters

key_data (str) – key with channel ID

Returns

channel ID

Return type

int

visiannot.tools.ToolsAudio.getAudioWaveFrequency(path)

Loads audio wave and gets frequency

Parameters

path (str) – path to the audio file

Returns

• data_wave (wave.Wave_read) – see https://docs.python.org/3/library/wave.html#wave-read-objects

• freq (int or float) – frequency

visiannot.tools.ToolsAudio.getDataAudio(path, channel_id=0)

Loads audio data

Parameters

• path (str) – path to the audio file

• channel_id (int) – audio channel to be loaded as a numpy array, set it to -1 to get all channels

Returns

• data_wave (wave.Wave_read) – see https://docs.python.org/3/library/wave.html#wave-read-objects

• data_audio (numpy array) – audio signal, with all channels if channel_id is set to -1

• freq (int) – frequency