-
-
num_samples (
int) – number of samples
-num_channels (
int) – number of channels in the output signal
-sampling_rate (
int) – sampling rate in Hz
+num_samples (
int) – number of samples
+num_channels (
int) – number of channels in the output signal
+sampling_rate (
int) – sampling rate in Hzdtype – data type
signal with shape (number of channels, number of samples)
am_fm_synth()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.config.html b/api/audresample.config.html
index 04c0748..84dff90 100644
--- a/api/audresample.config.html
+++ b/api/audresample.config.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -194,7 +194,7 @@ DEFAULT_RESAMPLE_QUALITYSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.define.ResampleQuality.html b/api/audresample.define.ResampleQuality.html
index 6e5738a..1091dc2 100644
--- a/api/audresample.define.ResampleQuality.html
+++ b/api/audresample.define.ResampleQuality.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -227,7 +227,7 @@ VERY_HIGHSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.define.html b/api/audresample.define.html
index 720276f..56268b7 100644
--- a/api/audresample.define.html
+++ b/api/audresample.define.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -184,7 +184,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.html b/api/audresample.html
index f1e5b7e..0836e6c 100644
--- a/api/audresample.html
+++ b/api/audresample.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -196,7 +196,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.remix.html b/api/audresample.remix.html
index 6b855a7..66f5747 100644
--- a/api/audresample.remix.html
+++ b/api/audresample.remix.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -211,25 +211,25 @@ remix()
Parameters
-signal (ndarray) – array with signal values
channels (Union[int, Sequence[int], None]) – channel selection, see description
mixdown (bool) – apply mono mix-down on selection
upmix (Optional[str]) – if 'zeros' it will pad missing channels with zeros,
+
signal (ndarray) – array with signal values
channels (Union[int, Sequence[int], None]) – channel selection, see description
mixdown (bool) – apply mono mix-down on selection
upmix (Optional[str]) – if 'zeros' it will pad missing channels with zeros,
if 'repeat' it will pad by repeating the existing channels
always_copy (bool) – if True always returns a new object
always_copy (bool) – if True always returns a new object
Return type
-
+
Returns
remixed signal with shape (number of channels, number of samples)
Raises
-RuntimeError – if input signal has more than two dimensions
ValueError – if channel selection is invalid and upmix is None
ValueError – if specified upmix method is not known
RuntimeError – if input signal has more than two dimensions
ValueError – if channel selection is invalid and upmix is None
ValueError – if specified upmix method is not known
remix()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.resample.html b/api/audresample.resample.html
index 62c7865..511299a 100644
--- a/api/audresample.resample.html
+++ b/api/audresample.resample.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -161,23 +161,23 @@ resample()
Parameters
-signal (ndarray) – array with signal values
original_rate (int) – original sample rate of the input signal in Hz
target_rate (int) – target sampling rate in Hz
signal (ndarray) – array with signal values
original_rate (int) – original sample rate of the input signal in Hz
target_rate (int) – target sampling rate in Hz
quality (ResampleQuality) – quality of the conversion algorithm
always_copy (bool) – if True always returns a new object
always_copy (bool) – if True always returns a new object
Return type
-
+
Returns
resampled signal with shape (number of channels, number of samples)
Raises
-RuntimeError – if input signal has more than two dimensions
RuntimeError – if input type is not numpy.single
RuntimeError – if input signal has more than two dimensions
RuntimeError – if input type is not numpy.single
resample()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/changelog.html b/changelog.html
index 857df83..3879678 100644
--- a/changelog.html
+++ b/changelog.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -106,6 +106,7 @@
- Contributing
- Changelog
+- Version 1.3.3 (2023-12-13)
- Version 1.3.2 (2023-05-30)
- Version 1.3.1 (2023-05-30)
- Version 1.3.0 (2023-05-30)
@@ -164,6 +165,18 @@ ChangelogKeep a Changelog,
and this project adheres to Semantic Versioning.
+
+Version 1.3.3 (2023-12-13)¶
+
+Added: support for Python 3.12
Fixed: avoid deprecation warning
+by replacing
+pkg_resources
+internally with
+importlib.metadata
Removed: support for Python 3.7
+
Version 1.3.2 (2023-05-30)¶
@@ -309,7 +322,7 @@ Version 0.1.0 (2020-02-12)Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/contributing.html b/contributing.html
index 47e91de..071196c 100644
--- a/contributing.html
+++ b/contributing.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -154,30 +154,37 @@
Contributing¶
Everyone is invited to contribute to this project.
Feel free to create a pull request .
-If you find errors, omissions, inconsistencies or other things
-that need improvement, please create an issue.
+If you find errors,
+omissions,
+inconsistencies,
+or other things
+that need improvement,
+please create an issue.
Development Installation¶
-Instead of pip-installing the latest release from PyPI,
-you should get the newest development version from Github:
+Instead of pip-installing the latest release from PyPI,
+you should get the newest development version from Github:
git clone https://github.com/audeering/audresample/
cd audresample
-# Create virutal environment for this project
+# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audresample
# source $HOME/.envs/audresample/bin/activate
pip install -r requirements.txt
-This way, your installation always stays up-to-date,
+
This way,
+your installation always stays up-to-date,
even if you pull new changes from the Github repository.
Coding Convention¶
We follow the PEP8 convention for Python code
-and check for correct syntax with flake8.
-Exceptions are defined under the [flake8] section
-in setup.cfg.
+and check for correct syntax with ruff.
+In addition,
+we check for common spelling errors with codespell.
+Both tools and possible exceptions
+are defined in pyproject.toml.
The checks are executed in the CI using pre-commit.
You can enable those checks locally by executing:
pip install pre-commit # consider system wide installation
@@ -185,26 +192,27 @@ Coding Conventionpre-commit run --all-files
-Afterwards flake8 is executed
+
Afterwards ruff and codespell are executed
every time you create a commit.
-You can also install flake8
+
You can also install ruff and codespell
and call it directly:
-pip install flake8 # consider system wide installation
-flake8
+pip install ruff codespell # consider system wide installation
+ruff check .
+codespell
It can be restricted to specific folders:
-flake8 audfoo/ tests/
+ruff check audresample/ tests/
+codespell audresample/ tests/
Building the Documentation¶
If you make changes to the documentation,
-you can re-create the HTML pages using Sphinx.
+you can re-create the HTML pages using Sphinx.
You can install it and a few other necessary packages with:
-pip install -r requirements.txt
-pip install -r docs/requirements.txt
+pip install -r docs/requirements.txt
To create the HTML pages, use:
@@ -214,13 +222,13 @@ Building the Documentationbuild/sphinx/html/.
It is also possible to automatically check if all links are still valid:
-python -m sphinx docs/ build/sphinx/linkcheck -b linkcheck
+python -m sphinx docs/ build/sphinx/html -b linkcheck
Running the Tests¶
-You’ll need pytest for that.
+
You’ll need pytest for that.
It can be installed with:
pip install -r tests/requirements.txt
@@ -265,7 +273,7 @@ Creating a New ReleaseSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/genindex.html b/genindex.html
index e06c545..671e314 100644
--- a/genindex.html
+++ b/genindex.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -274,7 +274,7 @@ V
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/index.html b/index.html
index 4003a00..76f9abc 100644
--- a/index.html
+++ b/index.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -144,7 +144,7 @@
audresample¶
-
+ 
audresample remixes or resamples your signals.
Resampling is supported
for signals in single precision floating-point format,
@@ -193,7 +193,7 @@
audresampleSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/install.html b/install.html
index 7099917..c14ad9d 100644
--- a/install.html
+++ b/install.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -178,7 +178,7 @@ InstallationSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/objects.inv b/objects.inv
index 876162e..933633b 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
index 5508bfa..fcd1e02 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -69,7 +69,7 @@
- v1.3.2
+ v1.3.3
@@ -181,7 +181,7 @@ Python Module Index
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/search.html b/search.html
index f0934a6..3bbd8ef 100644
--- a/search.html
+++ b/search.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -168,7 +168,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/searchindex.js b/searchindex.js
index 450c0fe..e5b205b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "fix": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "ad": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "replac": 7, "univers": 7, "python": [7, 8, 11], "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "remov": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virut": 8, "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "flake8": 8, "except": 8, "ar": 8, "under": 8, "section": 8, "setup": 8, "cfg": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "audfoo": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "possibl": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "virtual": 11, "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2": 7, "2023": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "12": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "ad": 7, "python": [7, 8, 11], "fix": 7, "avoid": 7, "deprec": 7, "warn": 7, "replac": 7, "pkg_resourc": 7, "intern": 7, "importlib": 7, "metadata": 7, "remov": 7, "7": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "univers": 7, "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virtual": [8, 11], "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "ruff": 8, "In": 8, "addit": 8, "common": 8, "spell": 8, "codespel": 8, "both": 8, "tool": 8, "possibl": 8, "except": 8, "ar": 8, "pyproject": 8, "toml": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2023": 7, "12": 7, "13": 7, "2": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.3 (2023-12-13)": [[7, "version-1-3-3-2023-12-13"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
diff --git a/usage.html b/usage.html
index 07f1865..8dc7184 100644
--- a/usage.html
+++ b/usage.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -358,7 +358,7 @@ Resample signalSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
- v1.3.2
+ v1.3.3
@@ -227,7 +227,7 @@ VERY_HIGHSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.define.html b/api/audresample.define.html
index 720276f..56268b7 100644
--- a/api/audresample.define.html
+++ b/api/audresample.define.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -184,7 +184,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.html b/api/audresample.html
index f1e5b7e..0836e6c 100644
--- a/api/audresample.html
+++ b/api/audresample.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -196,7 +196,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.remix.html b/api/audresample.remix.html
index 6b855a7..66f5747 100644
--- a/api/audresample.remix.html
+++ b/api/audresample.remix.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -211,25 +211,25 @@ remix()
Parameters
-signal (ndarray) – array with signal values
channels (Union[int, Sequence[int], None]) – channel selection, see description
mixdown (bool) – apply mono mix-down on selection
upmix (Optional[str]) – if 'zeros' it will pad missing channels with zeros,
+
signal (ndarray) – array with signal values
channels (Union[int, Sequence[int], None]) – channel selection, see description
mixdown (bool) – apply mono mix-down on selection
upmix (Optional[str]) – if 'zeros' it will pad missing channels with zeros,
if 'repeat' it will pad by repeating the existing channels
always_copy (bool) – if True always returns a new object
always_copy (bool) – if True always returns a new object
Return type
-
+
Returns
remixed signal with shape (number of channels, number of samples)
Raises
-RuntimeError – if input signal has more than two dimensions
ValueError – if channel selection is invalid and upmix is None
ValueError – if specified upmix method is not known
RuntimeError – if input signal has more than two dimensions
ValueError – if channel selection is invalid and upmix is None
ValueError – if specified upmix method is not known
remix()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.resample.html b/api/audresample.resample.html
index 62c7865..511299a 100644
--- a/api/audresample.resample.html
+++ b/api/audresample.resample.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -161,23 +161,23 @@ resample()
Parameters
-signal (ndarray) – array with signal values
original_rate (int) – original sample rate of the input signal in Hz
target_rate (int) – target sampling rate in Hz
signal (ndarray) – array with signal values
original_rate (int) – original sample rate of the input signal in Hz
target_rate (int) – target sampling rate in Hz
quality (ResampleQuality) – quality of the conversion algorithm
always_copy (bool) – if True always returns a new object
always_copy (bool) – if True always returns a new object
Return type
-
+
Returns
resampled signal with shape (number of channels, number of samples)
Raises
-RuntimeError – if input signal has more than two dimensions
RuntimeError – if input type is not numpy.single
RuntimeError – if input signal has more than two dimensions
RuntimeError – if input type is not numpy.single
resample()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/changelog.html b/changelog.html
index 857df83..3879678 100644
--- a/changelog.html
+++ b/changelog.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -106,6 +106,7 @@
- Contributing
- Changelog
+- Version 1.3.3 (2023-12-13)
- Version 1.3.2 (2023-05-30)
- Version 1.3.1 (2023-05-30)
- Version 1.3.0 (2023-05-30)
@@ -164,6 +165,18 @@ ChangelogKeep a Changelog,
and this project adheres to Semantic Versioning.
+
+Version 1.3.3 (2023-12-13)¶
+
+Added: support for Python 3.12
Fixed: avoid deprecation warning
+by replacing
+pkg_resources
+internally with
+importlib.metadata
Removed: support for Python 3.7
+
Version 1.3.2 (2023-05-30)¶
@@ -309,7 +322,7 @@ Version 0.1.0 (2020-02-12)Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/contributing.html b/contributing.html
index 47e91de..071196c 100644
--- a/contributing.html
+++ b/contributing.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -154,30 +154,37 @@
Contributing¶
Everyone is invited to contribute to this project.
Feel free to create a pull request .
-If you find errors, omissions, inconsistencies or other things
-that need improvement, please create an issue.
+If you find errors,
+omissions,
+inconsistencies,
+or other things
+that need improvement,
+please create an issue.
Development Installation¶
-Instead of pip-installing the latest release from PyPI,
-you should get the newest development version from Github:
+Instead of pip-installing the latest release from PyPI,
+you should get the newest development version from Github:
git clone https://github.com/audeering/audresample/
cd audresample
-# Create virutal environment for this project
+# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audresample
# source $HOME/.envs/audresample/bin/activate
pip install -r requirements.txt
-This way, your installation always stays up-to-date,
+
This way,
+your installation always stays up-to-date,
even if you pull new changes from the Github repository.
Coding Convention¶
We follow the PEP8 convention for Python code
-and check for correct syntax with flake8.
-Exceptions are defined under the [flake8] section
-in setup.cfg.
+and check for correct syntax with ruff.
+In addition,
+we check for common spelling errors with codespell.
+Both tools and possible exceptions
+are defined in pyproject.toml.
The checks are executed in the CI using pre-commit.
You can enable those checks locally by executing:
pip install pre-commit # consider system wide installation
@@ -185,26 +192,27 @@ Coding Conventionpre-commit run --all-files
-Afterwards flake8 is executed
+
Afterwards ruff and codespell are executed
every time you create a commit.
-You can also install flake8
+
You can also install ruff and codespell
and call it directly:
-pip install flake8 # consider system wide installation
-flake8
+pip install ruff codespell # consider system wide installation
+ruff check .
+codespell
It can be restricted to specific folders:
-flake8 audfoo/ tests/
+ruff check audresample/ tests/
+codespell audresample/ tests/
Building the Documentation¶
If you make changes to the documentation,
-you can re-create the HTML pages using Sphinx.
+you can re-create the HTML pages using Sphinx.
You can install it and a few other necessary packages with:
-pip install -r requirements.txt
-pip install -r docs/requirements.txt
+pip install -r docs/requirements.txt
To create the HTML pages, use:
@@ -214,13 +222,13 @@ Building the Documentationbuild/sphinx/html/.
It is also possible to automatically check if all links are still valid:
-python -m sphinx docs/ build/sphinx/linkcheck -b linkcheck
+python -m sphinx docs/ build/sphinx/html -b linkcheck
Running the Tests¶
-You’ll need pytest for that.
+
You’ll need pytest for that.
It can be installed with:
pip install -r tests/requirements.txt
@@ -265,7 +273,7 @@ Creating a New ReleaseSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/genindex.html b/genindex.html
index e06c545..671e314 100644
--- a/genindex.html
+++ b/genindex.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -274,7 +274,7 @@ V
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/index.html b/index.html
index 4003a00..76f9abc 100644
--- a/index.html
+++ b/index.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -144,7 +144,7 @@
audresample¶
-
+
audresample remixes or resamples your signals.
Resampling is supported
for signals in single precision floating-point format,
@@ -193,7 +193,7 @@
audresampleSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/install.html b/install.html
index 7099917..c14ad9d 100644
--- a/install.html
+++ b/install.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -178,7 +178,7 @@ InstallationSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/objects.inv b/objects.inv
index 876162e..933633b 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
index 5508bfa..fcd1e02 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -69,7 +69,7 @@
- v1.3.2
+ v1.3.3
@@ -181,7 +181,7 @@ Python Module Index
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/search.html b/search.html
index f0934a6..3bbd8ef 100644
--- a/search.html
+++ b/search.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -168,7 +168,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/searchindex.js b/searchindex.js
index 450c0fe..e5b205b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "fix": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "ad": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "replac": 7, "univers": 7, "python": [7, 8, 11], "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "remov": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virut": 8, "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "flake8": 8, "except": 8, "ar": 8, "under": 8, "section": 8, "setup": 8, "cfg": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "audfoo": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "possibl": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "virtual": 11, "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2": 7, "2023": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "12": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "ad": 7, "python": [7, 8, 11], "fix": 7, "avoid": 7, "deprec": 7, "warn": 7, "replac": 7, "pkg_resourc": 7, "intern": 7, "importlib": 7, "metadata": 7, "remov": 7, "7": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "univers": 7, "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virtual": [8, 11], "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "ruff": 8, "In": 8, "addit": 8, "common": 8, "spell": 8, "codespel": 8, "both": 8, "tool": 8, "possibl": 8, "except": 8, "ar": 8, "pyproject": 8, "toml": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2023": 7, "12": 7, "13": 7, "2": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.3 (2023-12-13)": [[7, "version-1-3-3-2023-12-13"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
diff --git a/usage.html b/usage.html
index 07f1865..8dc7184 100644
--- a/usage.html
+++ b/usage.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -358,7 +358,7 @@ Resample signalSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
-
-
signal (
ndarray) – array with signal values
-channels (
Union[int,Sequence[int],None]) – channel selection, see description
-mixdown (
bool) – apply mono mix-down on selection
-upmix (
Optional[str]) – if'zeros'it will pad missing channels with zeros, +signal (
ndarray) – array with signal values
+channels (
Union[int,Sequence[int],None]) – channel selection, see description
+mixdown (
bool) – apply mono mix-down on selection
+upmix (
Optional[str]) – if'zeros'it will pad missing channels with zeros, if'repeat'it will pad by repeating the existing channels
-always_copy (
bool) – ifTruealways returns a new object
+always_copy (
bool) – ifTruealways returns a new object
remixed signal with shape (number of channels, number of samples)
-
-
RuntimeError – if input signal has more than two dimensions
-ValueError – if channel selection is invalid and upmix is
None
-ValueError – if specified upmix method is not known
+RuntimeError – if input signal has more than two dimensions
+ValueError – if channel selection is invalid and upmix is
None
+ValueError – if specified upmix method is not known
remix()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/api/audresample.resample.html b/api/audresample.resample.html
index 62c7865..511299a 100644
--- a/api/audresample.resample.html
+++ b/api/audresample.resample.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -161,23 +161,23 @@ resample()
Parameters
-signal (ndarray) – array with signal values
original_rate (int) – original sample rate of the input signal in Hz
target_rate (int) – target sampling rate in Hz
signal (ndarray) – array with signal values
original_rate (int) – original sample rate of the input signal in Hz
target_rate (int) – target sampling rate in Hz
quality (ResampleQuality) – quality of the conversion algorithm
always_copy (bool) – if True always returns a new object
always_copy (bool) – if True always returns a new object
Return type
-
+
Returns
resampled signal with shape (number of channels, number of samples)
Raises
-RuntimeError – if input signal has more than two dimensions
RuntimeError – if input type is not numpy.single
RuntimeError – if input signal has more than two dimensions
RuntimeError – if input type is not numpy.single
resample()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/changelog.html b/changelog.html
index 857df83..3879678 100644
--- a/changelog.html
+++ b/changelog.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -106,6 +106,7 @@
- Contributing
- Changelog
+- Version 1.3.3 (2023-12-13)
- Version 1.3.2 (2023-05-30)
- Version 1.3.1 (2023-05-30)
- Version 1.3.0 (2023-05-30)
@@ -164,6 +165,18 @@ ChangelogKeep a Changelog,
and this project adheres to Semantic Versioning.
+
+Version 1.3.3 (2023-12-13)¶
+
+Added: support for Python 3.12
Fixed: avoid deprecation warning
+by replacing
+pkg_resources
+internally with
+importlib.metadata
Removed: support for Python 3.7
+
Version 1.3.2 (2023-05-30)¶
@@ -309,7 +322,7 @@ Version 0.1.0 (2020-02-12)Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/contributing.html b/contributing.html
index 47e91de..071196c 100644
--- a/contributing.html
+++ b/contributing.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -154,30 +154,37 @@
Contributing¶
Everyone is invited to contribute to this project.
Feel free to create a pull request .
-If you find errors, omissions, inconsistencies or other things
-that need improvement, please create an issue.
+If you find errors,
+omissions,
+inconsistencies,
+or other things
+that need improvement,
+please create an issue.
Development Installation¶
-Instead of pip-installing the latest release from PyPI,
-you should get the newest development version from Github:
+Instead of pip-installing the latest release from PyPI,
+you should get the newest development version from Github:
git clone https://github.com/audeering/audresample/
cd audresample
-# Create virutal environment for this project
+# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audresample
# source $HOME/.envs/audresample/bin/activate
pip install -r requirements.txt
-This way, your installation always stays up-to-date,
+
This way,
+your installation always stays up-to-date,
even if you pull new changes from the Github repository.
Coding Convention¶
We follow the PEP8 convention for Python code
-and check for correct syntax with flake8.
-Exceptions are defined under the [flake8] section
-in setup.cfg.
+and check for correct syntax with ruff.
+In addition,
+we check for common spelling errors with codespell.
+Both tools and possible exceptions
+are defined in pyproject.toml.
The checks are executed in the CI using pre-commit.
You can enable those checks locally by executing:
pip install pre-commit # consider system wide installation
@@ -185,26 +192,27 @@ Coding Conventionpre-commit run --all-files
-Afterwards flake8 is executed
+
Afterwards ruff and codespell are executed
every time you create a commit.
-You can also install flake8
+
You can also install ruff and codespell
and call it directly:
-pip install flake8 # consider system wide installation
-flake8
+pip install ruff codespell # consider system wide installation
+ruff check .
+codespell
It can be restricted to specific folders:
-flake8 audfoo/ tests/
+ruff check audresample/ tests/
+codespell audresample/ tests/
Building the Documentation¶
If you make changes to the documentation,
-you can re-create the HTML pages using Sphinx.
+you can re-create the HTML pages using Sphinx.
You can install it and a few other necessary packages with:
-pip install -r requirements.txt
-pip install -r docs/requirements.txt
+pip install -r docs/requirements.txt
To create the HTML pages, use:
@@ -214,13 +222,13 @@ Building the Documentationbuild/sphinx/html/.
It is also possible to automatically check if all links are still valid:
-python -m sphinx docs/ build/sphinx/linkcheck -b linkcheck
+python -m sphinx docs/ build/sphinx/html -b linkcheck
Running the Tests¶
-You’ll need pytest for that.
+
You’ll need pytest for that.
It can be installed with:
pip install -r tests/requirements.txt
@@ -265,7 +273,7 @@ Creating a New ReleaseSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/genindex.html b/genindex.html
index e06c545..671e314 100644
--- a/genindex.html
+++ b/genindex.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -274,7 +274,7 @@ V
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/index.html b/index.html
index 4003a00..76f9abc 100644
--- a/index.html
+++ b/index.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -144,7 +144,7 @@
audresample¶
-
+
audresample remixes or resamples your signals.
Resampling is supported
for signals in single precision floating-point format,
@@ -193,7 +193,7 @@
audresampleSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/install.html b/install.html
index 7099917..c14ad9d 100644
--- a/install.html
+++ b/install.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -178,7 +178,7 @@ InstallationSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/objects.inv b/objects.inv
index 876162e..933633b 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
index 5508bfa..fcd1e02 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -69,7 +69,7 @@
- v1.3.2
+ v1.3.3
@@ -181,7 +181,7 @@ Python Module Index
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/search.html b/search.html
index f0934a6..3bbd8ef 100644
--- a/search.html
+++ b/search.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -168,7 +168,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/searchindex.js b/searchindex.js
index 450c0fe..e5b205b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "fix": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "ad": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "replac": 7, "univers": 7, "python": [7, 8, 11], "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "remov": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virut": 8, "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "flake8": 8, "except": 8, "ar": 8, "under": 8, "section": 8, "setup": 8, "cfg": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "audfoo": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "possibl": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "virtual": 11, "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2": 7, "2023": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "12": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "ad": 7, "python": [7, 8, 11], "fix": 7, "avoid": 7, "deprec": 7, "warn": 7, "replac": 7, "pkg_resourc": 7, "intern": 7, "importlib": 7, "metadata": 7, "remov": 7, "7": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "univers": 7, "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virtual": [8, 11], "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "ruff": 8, "In": 8, "addit": 8, "common": 8, "spell": 8, "codespel": 8, "both": 8, "tool": 8, "possibl": 8, "except": 8, "ar": 8, "pyproject": 8, "toml": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2023": 7, "12": 7, "13": 7, "2": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.3 (2023-12-13)": [[7, "version-1-3-3-2023-12-13"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
diff --git a/usage.html b/usage.html
index 07f1865..8dc7184 100644
--- a/usage.html
+++ b/usage.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -358,7 +358,7 @@ Resample signalSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
-
-
signal (
ndarray) – array with signal values
-original_rate (
int) – original sample rate of the input signal in Hz
-target_rate (
int) – target sampling rate in Hz
+signal (
ndarray) – array with signal values
+original_rate (
int) – original sample rate of the input signal in Hz
+target_rate (
int) – target sampling rate in Hzquality (
ResampleQuality) – quality of the conversion algorithm
-always_copy (
bool) – ifTruealways returns a new object
+always_copy (
bool) – ifTruealways returns a new object
resampled signal with shape (number of channels, number of samples)
-
-
RuntimeError – if input signal has more than two dimensions
-RuntimeError – if input type is not
numpy.single
+RuntimeError – if input signal has more than two dimensions
+RuntimeError – if input type is not
numpy.single
resample()Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/changelog.html b/changelog.html
index 857df83..3879678 100644
--- a/changelog.html
+++ b/changelog.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -106,6 +106,7 @@
- Contributing
- Changelog
+- Version 1.3.3 (2023-12-13)
- Version 1.3.2 (2023-05-30)
- Version 1.3.1 (2023-05-30)
- Version 1.3.0 (2023-05-30)
@@ -164,6 +165,18 @@ ChangelogKeep a Changelog,
and this project adheres to Semantic Versioning.
+
+Version 1.3.3 (2023-12-13)¶
+
+Added: support for Python 3.12
Fixed: avoid deprecation warning
+by replacing
+pkg_resources
+internally with
+importlib.metadata
Removed: support for Python 3.7
+
Version 1.3.2 (2023-05-30)¶
@@ -309,7 +322,7 @@ Version 0.1.0 (2020-02-12)Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/contributing.html b/contributing.html
index 47e91de..071196c 100644
--- a/contributing.html
+++ b/contributing.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -154,30 +154,37 @@
Contributing¶
Everyone is invited to contribute to this project.
Feel free to create a pull request .
-If you find errors, omissions, inconsistencies or other things
-that need improvement, please create an issue.
+If you find errors,
+omissions,
+inconsistencies,
+or other things
+that need improvement,
+please create an issue.
Development Installation¶
-Instead of pip-installing the latest release from PyPI,
-you should get the newest development version from Github:
+Instead of pip-installing the latest release from PyPI,
+you should get the newest development version from Github:
git clone https://github.com/audeering/audresample/
cd audresample
-# Create virutal environment for this project
+# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audresample
# source $HOME/.envs/audresample/bin/activate
pip install -r requirements.txt
-This way, your installation always stays up-to-date,
+
This way,
+your installation always stays up-to-date,
even if you pull new changes from the Github repository.
Coding Convention¶
We follow the PEP8 convention for Python code
-and check for correct syntax with flake8.
-Exceptions are defined under the [flake8] section
-in setup.cfg.
+and check for correct syntax with ruff.
+In addition,
+we check for common spelling errors with codespell.
+Both tools and possible exceptions
+are defined in pyproject.toml.
The checks are executed in the CI using pre-commit.
You can enable those checks locally by executing:
pip install pre-commit # consider system wide installation
@@ -185,26 +192,27 @@ Coding Conventionpre-commit run --all-files
-Afterwards flake8 is executed
+
Afterwards ruff and codespell are executed
every time you create a commit.
-You can also install flake8
+
You can also install ruff and codespell
and call it directly:
-pip install flake8 # consider system wide installation
-flake8
+pip install ruff codespell # consider system wide installation
+ruff check .
+codespell
It can be restricted to specific folders:
-flake8 audfoo/ tests/
+ruff check audresample/ tests/
+codespell audresample/ tests/
Building the Documentation¶
If you make changes to the documentation,
-you can re-create the HTML pages using Sphinx.
+you can re-create the HTML pages using Sphinx.
You can install it and a few other necessary packages with:
-pip install -r requirements.txt
-pip install -r docs/requirements.txt
+pip install -r docs/requirements.txt
To create the HTML pages, use:
@@ -214,13 +222,13 @@ Building the Documentationbuild/sphinx/html/.
It is also possible to automatically check if all links are still valid:
-python -m sphinx docs/ build/sphinx/linkcheck -b linkcheck
+python -m sphinx docs/ build/sphinx/html -b linkcheck
Running the Tests¶
-You’ll need pytest for that.
+
You’ll need pytest for that.
It can be installed with:
pip install -r tests/requirements.txt
@@ -265,7 +273,7 @@ Creating a New ReleaseSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/genindex.html b/genindex.html
index e06c545..671e314 100644
--- a/genindex.html
+++ b/genindex.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -274,7 +274,7 @@ V
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/index.html b/index.html
index 4003a00..76f9abc 100644
--- a/index.html
+++ b/index.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -144,7 +144,7 @@
audresample¶
-
+
audresample remixes or resamples your signals.
Resampling is supported
for signals in single precision floating-point format,
@@ -193,7 +193,7 @@
audresampleSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/install.html b/install.html
index 7099917..c14ad9d 100644
--- a/install.html
+++ b/install.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -178,7 +178,7 @@ InstallationSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/objects.inv b/objects.inv
index 876162e..933633b 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
index 5508bfa..fcd1e02 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -69,7 +69,7 @@
- v1.3.2
+ v1.3.3
@@ -181,7 +181,7 @@ Python Module Index
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/search.html b/search.html
index f0934a6..3bbd8ef 100644
--- a/search.html
+++ b/search.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -168,7 +168,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/searchindex.js b/searchindex.js
index 450c0fe..e5b205b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "fix": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "ad": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "replac": 7, "univers": 7, "python": [7, 8, 11], "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "remov": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virut": 8, "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "flake8": 8, "except": 8, "ar": 8, "under": 8, "section": 8, "setup": 8, "cfg": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "audfoo": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "possibl": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "virtual": 11, "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2": 7, "2023": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "12": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "ad": 7, "python": [7, 8, 11], "fix": 7, "avoid": 7, "deprec": 7, "warn": 7, "replac": 7, "pkg_resourc": 7, "intern": 7, "importlib": 7, "metadata": 7, "remov": 7, "7": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "univers": 7, "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virtual": [8, 11], "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "ruff": 8, "In": 8, "addit": 8, "common": 8, "spell": 8, "codespel": 8, "both": 8, "tool": 8, "possibl": 8, "except": 8, "ar": 8, "pyproject": 8, "toml": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2023": 7, "12": 7, "13": 7, "2": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.3 (2023-12-13)": [[7, "version-1-3-3-2023-12-13"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
diff --git a/usage.html b/usage.html
index 07f1865..8dc7184 100644
--- a/usage.html
+++ b/usage.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -358,7 +358,7 @@ Resample signalSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
-
+
- Version 1.3.3 (2023-12-13)
- Version 1.3.2 (2023-05-30)
- Version 1.3.1 (2023-05-30)
- Version 1.3.0 (2023-05-30) @@ -164,6 +165,18 @@
Added: support for Python 3.12
+Fixed: avoid deprecation warning +by replacing +
pkg_resources+internally with +importlib.metadata
+Removed: support for Python 3.7
+
ChangelogKeep a Changelog,
and this project adheres to Semantic Versioning.
+
+Version 1.3.3 (2023-12-13)¶
+
+
+
Version 1.3.2 (2023-05-30)¶
@@ -309,7 +322,7 @@ Version 0.1.0 (2020-02-12)Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/contributing.html b/contributing.html
index 47e91de..071196c 100644
--- a/contributing.html
+++ b/contributing.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -154,30 +154,37 @@
Contributing¶
Version 1.3.3 (2023-12-13)¶
+-
+
Version 1.3.2 (2023-05-30)¶
-
@@ -309,7 +322,7 @@
Version 0.1.0 (2020-02-12)Sphinx on 2023/05/30 using the audEERING theme + Built with Sphinx on 2023/12/13 using the audEERING theme
Everyone is invited to contribute to this project. Feel free to create a pull request . -If you find errors, omissions, inconsistencies or other things -that need improvement, please create an issue.
+If you find errors, +omissions, +inconsistencies, +or other things +that need improvement, +please create an issue.Development Installation¶
-Instead of pip-installing the latest release from PyPI, -you should get the newest development version from Github:
+Instead of pip-installing the latest release from PyPI, +you should get the newest development version from Github:
git clone https://github.com/audeering/audresample/
cd audresample
-# Create virutal environment for this project
+# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audresample
# source $HOME/.envs/audresample/bin/activate
pip install -r requirements.txt
This way, your installation always stays up-to-date, +
This way, +your installation always stays up-to-date, even if you pull new changes from the Github repository.
Coding Convention¶
We follow the PEP8 convention for Python code
-and check for correct syntax with flake8.
-Exceptions are defined under the [flake8] section
-in setup.cfg.
pyproject.toml.
The checks are executed in the CI using pre-commit. You can enable those checks locally by executing:
pip install pre-commit # consider system wide installation
@@ -185,26 +192,27 @@ Coding Conventionpre-commit run --all-files
Afterwards flake8 is executed +
Afterwards ruff and codespell are executed every time you create a commit.
-You can also install flake8 +
You can also install ruff and codespell and call it directly:
-pip install flake8 # consider system wide installation
-flake8
+pip install ruff codespell # consider system wide installation
+ruff check .
+codespell
It can be restricted to specific folders:
-flake8 audfoo/ tests/
+ruff check audresample/ tests/
+codespell audresample/ tests/
Building the Documentation¶
If you make changes to the documentation,
-you can re-create the HTML pages using Sphinx.
+you can re-create the HTML pages using Sphinx.
You can install it and a few other necessary packages with:
-pip install -r requirements.txt
-pip install -r docs/requirements.txt
+pip install -r docs/requirements.txt
To create the HTML pages, use:
@@ -214,13 +222,13 @@ Building the Documentationbuild/sphinx/html/.
It is also possible to automatically check if all links are still valid:
-python -m sphinx docs/ build/sphinx/linkcheck -b linkcheck
+python -m sphinx docs/ build/sphinx/html -b linkcheck
Running the Tests¶
-You’ll need pytest for that.
+
You’ll need pytest for that.
It can be installed with:
pip install -r tests/requirements.txt
@@ -265,7 +273,7 @@ Creating a New ReleaseSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/genindex.html b/genindex.html
index e06c545..671e314 100644
--- a/genindex.html
+++ b/genindex.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -274,7 +274,7 @@ V
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/index.html b/index.html
index 4003a00..76f9abc 100644
--- a/index.html
+++ b/index.html
@@ -67,7 +67,7 @@
- v1.3.2
+ v1.3.3
@@ -144,7 +144,7 @@
audresample¶
-
+
audresample remixes or resamples your signals.
Resampling is supported
for signals in single precision floating-point format,
@@ -193,7 +193,7 @@
audresampleSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/install.html b/install.html
index 7099917..c14ad9d 100644
--- a/install.html
+++ b/install.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -178,7 +178,7 @@ InstallationSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/objects.inv b/objects.inv
index 876162e..933633b 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
index 5508bfa..fcd1e02 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -69,7 +69,7 @@
- v1.3.2
+ v1.3.3
@@ -181,7 +181,7 @@ Python Module Index
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/search.html b/search.html
index f0934a6..3bbd8ef 100644
--- a/search.html
+++ b/search.html
@@ -66,7 +66,7 @@
- v1.3.2
+ v1.3.3
@@ -168,7 +168,7 @@
- Built with Sphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme
diff --git a/searchindex.js b/searchindex.js
index 450c0fe..e5b205b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "fix": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "ad": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "replac": 7, "univers": 7, "python": [7, 8, 11], "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "remov": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virut": 8, "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "flake8": 8, "except": 8, "ar": 8, "under": 8, "section": 8, "setup": 8, "cfg": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "audfoo": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "possibl": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "virtual": 11, "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2": 7, "2023": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "12": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api/audresample", "api/audresample.am_fm_synth", "api/audresample.config", "api/audresample.define", "api/audresample.define.ResampleQuality", "api/audresample.remix", "api/audresample.resample", "changelog", "contributing", "genindex", "index", "install", "usage"], "filenames": ["api/audresample.rst", "api/audresample.am_fm_synth.rst", "api/audresample.config.rst", "api/audresample.define.rst", "api/audresample.define.ResampleQuality.rst", "api/audresample.remix.rst", "api/audresample.resample.rst", "changelog.rst", "contributing.rst", "genindex.rst", "index.rst", "install.rst", "usage.rst"], "titles": ["audresample", "am_fm_synth()", "config", "audresample.define", "ResampleQuality", "remix()", "resample()", "Changelog", "Contributing", "Index", "audresample", "Installation", "Usage"], "terms": {"audresampl": [1, 2, 4, 5, 6, 7, 8, 11, 12], "num_sampl": [1, 12], "num_channel": [1, 12], "sampling_r": [1, 12], "dtype": [1, 10], "numpi": [1, 6, 10], "float32": [1, 10], "sourc": [1, 2, 4, 5, 6, 7, 8, 11], "synthes": 1, "an": [1, 5, 8], "am": [1, 12], "fm": [1, 12], "signal": [1, 5, 6, 7, 10], "paramet": [1, 5, 6], "int": [1, 5, 6], "number": [1, 5, 6], "sampl": [1, 5, 6, 12], "channel": [1, 5, 6, 10, 12], "output": 1, "rate": [1, 6, 12], "hz": [1, 6], "data": 1, "type": [1, 5, 6], "return": [1, 5, 6], "ndarrai": [1, 5, 6], "shape": [1, 5, 6, 10, 12], "class": [2, 4], "get": [2, 8], "set": 2, "default": 2, "modul": 2, "h": [2, 4, 6], "defin": [4, 7, 8], "qualiti": [4, 6], "level": 4, "resampl": [4, 7, 10], "l": 4, "m": [4, 8], "q": 4, "v": 4, "none": 5, "mixdown": [5, 10, 12], "fals": [5, 6], "upmix": [5, 7], "always_copi": [5, 6], "The": [5, 6, 7, 8], "argument": [5, 7], "allow": 5, "select": [5, 12], "one": 5, "more": [5, 6], "re": [5, 8], "order": 5, "them": 5, "exampl": [5, 7], "result": 5, "all": [5, 7, 8], "0": [5, 10, 12], "first": [5, 12], "1": [5, 10, 12], "second": [5, 12], "last": [5, 12], "2": [5, 10, 12], "two": [5, 6, 12], "swap": 5, "twice": 5, "rang": 5, "3": [5, 12], "three": [5, 12], "If": [5, 8], "input": [5, 6, 7], "ha": [5, 6], "enough": 5, "fulfil": 5, "you": [5, 8], "can": [5, 8], "method": 5, "fill": 5, "miss": [5, 7], "workflow": 5, "i": [5, 6, 7, 8, 10], "alwai": [5, 6, 8], "downmix": 5, "arrai": [5, 6], "valu": [5, 6], "union": 5, "sequenc": 5, "see": 5, "descript": 5, "bool": [5, 6], "appli": 5, "mono": [5, 12], "mix": [5, 12], "down": 5, "option": 5, "str": 5, "zero": [5, 10], "pad": 5, "repeat": 5, "exist": 5, "true": [5, 6, 10, 12], "new": [5, 6], "object": [5, 6], "rais": [5, 6, 7], "runtimeerror": [5, 6, 7], "than": [5, 6], "dimens": [5, 6], "valueerror": 5, "invalid": 5, "specifi": 5, "known": 5, "original_r": [6, 12], "target_r": [6, 12], "support": [6, 7, 10], "onli": 6, "singl": [6, 7, 10], "precis": [6, 7, 10], "float": [6, 7, 10], "point": [6, 7, 10], "format": [6, 7, 10], "origin": 6, "target": 6, "resamplequ": 6, "convers": 6, "algorithm": 6, "notabl": 7, "chang": [7, 8], "thi": [7, 8], "project": [7, 8], "document": 7, "file": [7, 8], "base": [7, 10], "keep": 7, "adher": 7, "semant": 7, "ad": 7, "python": [7, 8, 11], "fix": 7, "avoid": 7, "deprec": 7, "warn": 7, "replac": 7, "pkg_resourc": 7, "intern": 7, "importlib": 7, "metadata": 7, "remov": 7, "7": 7, "wrong": 7, "deploi": 7, "maco": 7, "wheel": 7, "publish": 7, "action": 7, "github": [7, 8], "build": 7, "step": [7, 8], "switch": 7, "macosx_11_0_arm64": 7, "macosx_10_4_x86_64": 7, "raspberri": 7, "pi": 7, "64": 7, "bit": 7, "aarch64": 7, "32": 7, "armv7l": 7, "code": 7, "readm": 7, "highlight": 7, "function": 7, "packag": [7, 8, 11], "univers": 7, "dedic": 7, "platform": 7, "macosx_12_0_arm64": 7, "macosx_12_0_x86_64": 7, "manylinux_2_17_aarch64": 7, "manylinux_2_17_armv7l": 7, "manylinux_2_17_x86_64": 7, "win_amd64": 7, "requir": [7, 8], "sphinx": [7, 8], "audeer": [7, 8], "theme": 7, "ensur": 7, "correct": [7, 8], "us": [7, 8, 12], "public": 7, "m1": 7, "architectur": 7, "11": 7, "split": 7, "api": 7, "sub": 7, "page": [7, 8], "each": 7, "__init__": 7, "py": 7, "non": 7, "remix": [7, 10], "when": 7, "given": 7, "instead": [7, 8], "convert": 7, "silent": 7, "9": 7, "window": 7, "edit": 7, "link": [7, 8], "doc": [7, 8], "move": 7, "releas": 7, "open": 7, "updat": [7, 8], "binari": [7, 11], "execut": [7, 8], "time": [7, 8], "greatli": 7, "reduc": 7, "initi": 7, "everyon": 8, "invit": 8, "feel": 8, "free": 8, "pull": 8, "request": 8, "find": 8, "error": 8, "omiss": 8, "inconsist": 8, "other": 8, "thing": 8, "need": 8, "improv": 8, "pleas": 8, "issu": 8, "pip": [8, 11], "latest": 8, "from": 8, "pypi": 8, "should": 8, "newest": 8, "version": 8, "git": 8, "clone": 8, "http": 8, "com": 8, "cd": 8, "virtual": [8, 11], "environ": [8, 11], "e": [8, 11], "g": [8, 11], "virtualenv": [8, 11], "python3": [8, 11], "home": [8, 11], "env": [8, 11], "bin": [8, 11], "activ": [8, 11], "r": 8, "txt": 8, "wai": 8, "your": [8, 10], "stai": 8, "up": 8, "date": 8, "even": 8, "repositori": 8, "we": 8, "follow": 8, "pep8": 8, "check": 8, "syntax": 8, "ruff": 8, "In": 8, "addit": 8, "common": 8, "spell": 8, "codespel": 8, "both": 8, "tool": 8, "possibl": 8, "except": 8, "ar": 8, "pyproject": 8, "toml": 8, "ci": 8, "pre": [8, 11], "commit": 8, "enabl": 8, "those": 8, "local": 8, "consid": 8, "system": 8, "wide": 8, "afterward": 8, "everi": 8, "also": 8, "call": 8, "directli": 8, "It": 8, "restrict": 8, "specif": 8, "folder": 8, "make": 8, "html": 8, "few": 8, "necessari": 8, "To": 8, "b": 8, "gener": 8, "avail": 8, "directori": 8, "automat": 8, "still": 8, "valid": 8, "linkcheck": 8, "ll": 8, "pytest": 8, "simpli": 8, "made": 8, "changelog": 8, "rst": 8, "x": 8, "y": 8, "z": 8, "annot": 8, "tag": 8, "push": 8, "soxr": 10, "implement": 10, "provid": 10, "audresamplelib": [10, 11], "have": 10, "look": 10, "instal": 10, "usag": 10, "instruct": 10, "import": [10, 12], "np": 10, "8000": [10, 12], "4": 10, "16000": [10, 12], "creat": [11, 12], "download": 11, "come": 11, "built": 11, "16khz": 12, "am_fm_synth": 12, "16500": 12, "figur": 12, "size": 12, "1200x600": 12, "ax": 12, "1200x200": 12, "1200x400": 12, "48khz": 12, "48000": 12, "num_origin": 12, "8khz": 12, "2667": 12}, "objects": {"": [[0, 0, 0, "-", "audresample"]], "audresample": [[1, 1, 1, "", "am_fm_synth"], [2, 2, 1, "", "config"], [3, 0, 0, "-", "define"], [5, 1, 1, "", "remix"], [6, 1, 1, "", "resample"]], "audresample.config": [[2, 3, 1, "", "DEFAULT_RESAMPLE_QUALITY"]], "audresample.define": [[4, 2, 1, "", "ResampleQuality"]], "audresample.define.ResampleQuality": [[4, 3, 1, "", "HIGH"], [4, 3, 1, "", "LOW"], [4, 3, 1, "", "MEDIUM"], [4, 3, 1, "", "QUICK"], [4, 3, 1, "", "VERY_HIGH"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"audresampl": [0, 3, 10], "am_fm_synth": 1, "config": 2, "default_resample_qu": 2, "defin": 3, "resamplequ": 4, "high": 4, "low": 4, "medium": 4, "quick": 4, "very_high": 4, "remix": [5, 12], "resampl": [6, 12], "changelog": 7, "version": 7, "1": 7, "3": 7, "2023": 7, "12": 7, "13": 7, "2": 7, "05": 7, "30": 7, "0": 7, "01": 7, "27": 7, "2022": 7, "23": 7, "02": 7, "03": 7, "04": 7, "6": 7, "2021": 7, "06": 7, "17": 7, "5": 7, "10": 7, "4": 7, "26": 7, "25": 7, "18": 7, "15": 7, "2020": 7, "contribut": 8, "develop": 8, "instal": [8, 11], "code": 8, "convent": 8, "build": 8, "document": 8, "run": 8, "test": 8, "creat": 8, "new": 8, "releas": 8, "index": 9, "usag": 12, "signal": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"audresample": [[0, "module-audresample"], [10, "audresample"]], "am_fm_synth()": [[1, "am-fm-synth"]], "config": [[2, "config"]], "DEFAULT_RESAMPLE_QUALITY": [[2, "default-resample-quality"]], "audresample.define": [[3, "module-audresample.define"]], "ResampleQuality": [[4, "resamplequality"]], "HIGH": [[4, "high"]], "LOW": [[4, "low"]], "MEDIUM": [[4, "medium"]], "QUICK": [[4, "quick"]], "VERY_HIGH": [[4, "very-high"]], "remix()": [[5, "remix"]], "resample()": [[6, "resample"]], "Changelog": [[7, "changelog"]], "Version 1.3.3 (2023-12-13)": [[7, "version-1-3-3-2023-12-13"]], "Version 1.3.2 (2023-05-30)": [[7, "version-1-3-2-2023-05-30"]], "Version 1.3.1 (2023-05-30)": [[7, "version-1-3-1-2023-05-30"]], "Version 1.3.0 (2023-05-30)": [[7, "version-1-3-0-2023-05-30"]], "Version 1.2.1 (2023-01-27)": [[7, "version-1-2-1-2023-01-27"]], "Version 1.2.0 (2023-01-27)": [[7, "version-1-2-0-2023-01-27"]], "Version 1.1.1 (2022-12-23)": [[7, "version-1-1-1-2022-12-23"]], "Version 1.1.0 (2022-02-03)": [[7, "version-1-1-0-2022-02-03"]], "Version 1.0.0 (2022-01-04)": [[7, "version-1-0-0-2022-01-04"]], "Version 0.1.6 (2021-06-17)": [[7, "version-0-1-6-2021-06-17"]], "Version 0.1.5 (2021-05-10)": [[7, "version-0-1-5-2021-05-10"]], "Version 0.1.4 (2021-03-26)": [[7, "version-0-1-4-2021-03-26"]], "Version 0.1.3 (2021-03-25)": [[7, "version-0-1-3-2021-03-25"]], "Version 0.1.2 (2021-03-18)": [[7, "version-0-1-2-2021-03-18"]], "Version 0.1.1 (2021-01-15)": [[7, "version-0-1-1-2021-01-15"]], "Version 0.1.0 (2020-02-12)": [[7, "version-0-1-0-2020-02-12"]], "Contributing": [[8, "contributing"]], "Development Installation": [[8, "development-installation"]], "Coding Convention": [[8, "coding-convention"]], "Building the Documentation": [[8, "building-the-documentation"]], "Running the Tests": [[8, "running-the-tests"]], "Creating a New Release": [[8, "creating-a-new-release"]], "Index": [[9, "index"]], "Installation": [[11, "installation"]], "Usage": [[12, "usage"]], "Remix signal": [[12, "remix-signal"]], "Resample signal": [[12, "resample-signal"]]}, "indexentries": {"audresample": [[0, "module-audresample"]], "module": [[0, "module-audresample"], [3, "module-audresample.define"]], "am_fm_synth() (in module audresample)": [[1, "audresample.am_fm_synth"]], "default_resample_quality (audresample.config attribute)": [[2, "audresample.config.DEFAULT_RESAMPLE_QUALITY"]], "config (class in audresample)": [[2, "audresample.config"]], "audresample.define": [[3, "module-audresample.define"]], "high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.HIGH"]], "low (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.LOW"]], "medium (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.MEDIUM"]], "quick (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.QUICK"]], "resamplequality (class in audresample.define)": [[4, "audresample.define.ResampleQuality"]], "very_high (audresample.define.resamplequality attribute)": [[4, "audresample.define.ResampleQuality.VERY_HIGH"]], "remix() (in module audresample)": [[5, "audresample.remix"]], "resample() (in module audresample)": [[6, "audresample.resample"]]}})
\ No newline at end of file
diff --git a/usage.html b/usage.html
index 07f1865..8dc7184 100644
--- a/usage.html
+++ b/usage.html
@@ -68,7 +68,7 @@
- v1.3.2
+ v1.3.3
@@ -358,7 +358,7 @@ Resample signalSphinx on 2023/05/30 using the audEERING theme
+ Built with Sphinx on 2023/12/13 using the audEERING theme