Source code for torchaudio.backend.utils

"""Defines utilities for switching audio backends"""
import os
import warnings
from typing import List, Optional

import torchaudio
from torchaudio._internal import module_utils as _mod_utils

from . import no_backend, soundfile_backend, sox_io_backend

__all__ = [

def _is_backend_dispatcher_enabled() -> bool:
    return os.getenv("TORCHAUDIO_USE_BACKEND_DISPATCHER") == "1"

[docs]def list_audio_backends() -> List[str]: """List available backends Returns: List[str]: The list of available backends. """ if _is_backend_dispatcher_enabled(): warnings.warn("list_audio_backend's return value is irrelevant when the I/O backend dispatcher is enabled.") backends = [] if _mod_utils.is_module_available("soundfile"): backends.append("soundfile") if torchaudio._extension._SOX_INITIALIZED: backends.append("sox_io") return backends
[docs]def set_audio_backend(backend: Optional[str]): """Set the backend for I/O operation Args: backend (str or None): Name of the backend. One of ``"sox_io"`` or ``"soundfile"`` based on availability of the system. If ``None`` is provided the current backend is unassigned. """ if _is_backend_dispatcher_enabled(): warnings.warn("set_audio_backend is a no-op when the I/O backend dispatcher is enabled.") return if backend is not None and backend not in list_audio_backends(): raise RuntimeError(f'Backend "{backend}" is not one of ' f"available backends: {list_audio_backends()}.") if backend is None: module = no_backend elif backend == "sox_io": module = sox_io_backend elif backend == "soundfile": module = soundfile_backend else: raise NotImplementedError(f'Unexpected backend "{backend}"') for func in ["save", "load", "info"]: setattr(torchaudio, func, getattr(module, func))
def _init_audio_backend(): backends = list_audio_backends() if "sox_io" in backends: set_audio_backend("sox_io") elif "soundfile" in backends: set_audio_backend("soundfile") else: warnings.warn("No audio backend is available.") set_audio_backend(None)
[docs]def get_audio_backend() -> Optional[str]: """Get the name of the current backend Returns: Optional[str]: The name of the current backend or ``None`` if no backend is assigned. """ if _is_backend_dispatcher_enabled(): warnings.warn("get_audio_backend's return value is irrelevant when the I/O backend dispatcher is enabled.") if torchaudio.load == no_backend.load: return None if torchaudio.load == sox_io_backend.load: return "sox_io" if torchaudio.load == soundfile_backend.load: return "soundfile" raise ValueError("Unknown backend.")


Access comprehensive developer documentation for PyTorch

View Docs


Get in-depth tutorials for beginners and advanced developers

View Tutorials


Find development resources and get your questions answered

View Resources