sox_utils

Module to change the configuration of libsox, which is used by I/O functions like sox_io_backend and sox_effects.

get_buffer_size

torchaudio.utils.sox_utils.get_buffer_size() → int

Get buffer size for sox effect chain

Returns:

size in bytes of buffers used for processing audio.

Return type:

int

list_effects

torchaudio.utils.sox_utils.list_effects() → Dict[str, str]

List the available sox effect names

Returns:

Mapping from effect name to usage

Return type:

Dict[str, str]

list_read_formats

torchaudio.utils.sox_utils.list_read_formats() → List[str]

List the supported audio formats for read

Returns:

List of supported audio formats

Return type:

List[str]

list_write_formats

torchaudio.utils.sox_utils.list_write_formats() → List[str]

List the supported audio formats for write

Returns:

List of supported audio formats

Return type:

List[str]

set_buffer_size

torchaudio.utils.sox_utils.set_buffer_size(buffer_size: int)

Set buffer size for sox effect chain

Parameters:

buffer_size (int) – Set the size in bytes of the buffers used for processing audio.

See also

http://sox.sourceforge.net/sox.html

set_seed

torchaudio.utils.sox_utils.set_seed(seed: int)

Set libsox’s PRNG

Parameters:

seed (int) – seed value. valid range is int32.

See also

http://sox.sourceforge.net/sox.html

set_use_threads

torchaudio.utils.sox_utils.set_use_threads(use_threads: bool)

Set multithread option for sox effect chain

Parameters:

use_threads (bool) – When True, enables libsox’s parallel effects channels processing. To use mutlithread, the underlying libsox has to be compiled with OpenMP support.

See also

http://sox.sourceforge.net/sox.html

set_verbosity

torchaudio.utils.sox_utils.set_verbosity(verbosity: int)

Set libsox’s verbosity

Parameters:

verbosity (int) –

Set verbosity level of libsox.

• 1 failure messages

• 2 warnings

• 3 details of processing

• 4-6 increasing levels of debug messages

See also

http://sox.sourceforge.net/sox.html