Skip to content

Add ffmpeg4 installation instructions in warnings #5167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 27, 2022
Merged

Add ffmpeg4 installation instructions in warnings #5167

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f467ae3
add warning with installation instructions when torchaudio>0.12 fails
Oct 26, 2022
6010f53
add line breaks
Oct 26, 2022
41d094b
add new line
Oct 26, 2022
3a63d67
remove new lines...
Oct 26, 2022
bcb641a
add note about runtime restart
Oct 26, 2022
a30a12f
remove one sentence
Oct 26, 2022
a9e87ee
add note about colab
Oct 26, 2022
48b78e0
add formatting to import error
Oct 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions src/datasets/features/audio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,16 +295,22 @@ def _decode_mp3(self, path_or_file):
try: # try torchaudio anyway because sometimes it works (depending on the os and os packages installed)
array, sampling_rate = self._decode_mp3_torchaudio(path_or_file)
except RuntimeError:
warnings.warn(
"\nTo support 'mp3' decoding with `torchaudio>=0.12.0`, please install `ffmpeg4` system package. On Google Colab you can run:\n\n"
"\t!add-apt-repository -y ppa:jonathonf/ffmpeg-4 && apt update && apt install -y ffmpeg\n\n"
"and restart your runtime. Alternatively, you can downgrade `torchaudio`:\n\n"
"\tpip install \"torchaudio<0.12\"`.\n\nOtherwise 'mp3' files will be decoded with `librosa`."
)
try:
# flake8: noqa
import librosa
except ImportError as err:
raise ImportError(
"Your version of `torchaudio` (>=0.12.0) doesn't support decoding 'mp3' files on your machine. "
"To support 'mp3' decoding with `torchaudio>=0.12.0`, please install `ffmpeg>=4` system package "
'or downgrade `torchaudio` to <0.12: `pip install "torchaudio<0.12"`. '
"To support decoding 'mp3' audio files without `torchaudio`, please install `librosa`: "
"`pip install librosa`. Note that decoding will be extremely slow in that case."
"To support 'mp3' decoding with `torchaudio>=0.12.0`, please install `ffmpeg4` system package. On Google Colab you can run:\n\n"
"\t!add-apt-repository -y ppa:jonathonf/ffmpeg-4 && apt update && apt install -y ffmpeg\n\n"
"and restart your runtime. Alternatively, you can downgrade `torchaudio`:\n\n"
"\tpip install \"torchaudio<0.12\"`.\n\nOtherwise 'mp3' files will be decoded with `librosa`:\n\n"
"\tpip install librosa\n\nNote that decoding will be extremely slow in that case."
) from err
# try to decode with librosa for torchaudio>=0.12.0 as a workaround
warnings.warn("Decoding mp3 with `librosa` instead of `torchaudio`, decoding is slow.")
Expand Down