From 4fe246e0d3f68738780924281eef0a007a5bb790 Mon Sep 17 00:00:00 2001 From: Artyom Astafurov Date: Fri, 26 Feb 2021 15:01:51 -0500 Subject: [PATCH 1/4] Update AudioMetaData docstring with encoding values --- torchaudio/backend/common.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/torchaudio/backend/common.py b/torchaudio/backend/common.py index 6ccd36e4dc..32316e4fd5 100644 --- a/torchaudio/backend/common.py +++ b/torchaudio/backend/common.py @@ -9,7 +9,21 @@ class AudioMetaData: :ivar int num_channels: The number of channels :ivar int bits_per_sample: The number of bits per sample. This is 0 for lossy formats, or when it cannot be accurately inferred. - :ivar str encoding: Audio encoding. + :ivar str encoding: Audio encoding + The values encoding can take are one of the following: + + * ``PCM_S``: Signed integer linear PCM + * ``PCM_U``: Unsigned integer linear PCM + * ``PCM_F``: Floating point linear PCM + * ``FLAC``: Flac, Free Lossless Audio Codec + * ``ULAW``: Mu-law, [wikipedia] + * ``ALAW``: A-law [wikipedia] + * ``MP3`` : MP3, MPEG-1 Audio Layer III + * ``VORBIS``: OGG Vorbis [xiph.org] + * ``AMR_WB``: Adaptive Multi-Rate [wikipedia] + * ``AMR_NB``: Adaptive Multi-Rate Wideband [wikipedia] + * ``OPUS``: Opus [opus-codec.org] + * ``UNKNOWN`` : None of avobe """ def __init__( self, From 1319f0ab5fcf9149eeeba8edd0ec4ab60baaf759 Mon Sep 17 00:00:00 2001 From: Artyom Astafurov Date: Fri, 26 Feb 2021 15:03:40 -0500 Subject: [PATCH 2/4] Fix typo --- torchaudio/backend/common.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/torchaudio/backend/common.py b/torchaudio/backend/common.py index 32316e4fd5..ff2149d77e 100644 --- a/torchaudio/backend/common.py +++ b/torchaudio/backend/common.py @@ -23,7 +23,7 @@ class AudioMetaData: * ``AMR_WB``: Adaptive Multi-Rate [wikipedia] * ``AMR_NB``: Adaptive Multi-Rate Wideband [wikipedia] * ``OPUS``: Opus [opus-codec.org] - * ``UNKNOWN`` : None of avobe + * ``UNKNOWN`` : None of above """ def __init__( self, From dace34e151f6756869b656256bd8d22265ac3f16 Mon Sep 17 00:00:00 2001 From: Artyom Astafurov Date: Fri, 26 Feb 2021 15:43:16 -0500 Subject: [PATCH 3/4] update docstring --- torchaudio/backend/common.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/torchaudio/backend/common.py b/torchaudio/backend/common.py index ff2149d77e..128ca4999b 100644 --- a/torchaudio/backend/common.py +++ b/torchaudio/backend/common.py @@ -19,10 +19,10 @@ class AudioMetaData: * ``ULAW``: Mu-law, [wikipedia] * ``ALAW``: A-law [wikipedia] * ``MP3`` : MP3, MPEG-1 Audio Layer III - * ``VORBIS``: OGG Vorbis [xiph.org] - * ``AMR_WB``: Adaptive Multi-Rate [wikipedia] - * ``AMR_NB``: Adaptive Multi-Rate Wideband [wikipedia] - * ``OPUS``: Opus [opus-codec.org] + * ``VORBIS``: OGG Vorbis + * ``AMR_WB``: Adaptive Multi-Rate + * ``AMR_NB``: Adaptive Multi-Rate Wideband + * ``OPUS``: Opus * ``UNKNOWN`` : None of above """ def __init__( From d9f4860467fa77a129837591403e6f5f3d9e455b Mon Sep 17 00:00:00 2001 From: Artyom Astafurov Date: Fri, 26 Feb 2021 16:53:46 -0500 Subject: [PATCH 4/4] Update docstring --- torchaudio/backend/common.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/torchaudio/backend/common.py b/torchaudio/backend/common.py index 128ca4999b..722ce75879 100644 --- a/torchaudio/backend/common.py +++ b/torchaudio/backend/common.py @@ -16,8 +16,8 @@ class AudioMetaData: * ``PCM_U``: Unsigned integer linear PCM * ``PCM_F``: Floating point linear PCM * ``FLAC``: Flac, Free Lossless Audio Codec - * ``ULAW``: Mu-law, [wikipedia] - * ``ALAW``: A-law [wikipedia] + * ``ULAW``: Mu-law + * ``ALAW``: A-law * ``MP3`` : MP3, MPEG-1 Audio Layer III * ``VORBIS``: OGG Vorbis * ``AMR_WB``: Adaptive Multi-Rate