mbrola 0.0.2__tar.gz

mbrola-0.0.2/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

mbrola-0.0.2/.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+

mbrola-0.0.2/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present gongcastro <gongarciacastro@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

mbrola-0.0.2/Makefile

@@ -0,0 +1,5 @@
+build:
+	hatch build
+
+publish:
+	hatch publish

mbrola-0.0.2/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.3
+Name: mbrola
+Version: 0.0.2
+Summary: A Python front-end for the MBROLA speech synthesizer
+Project-URL: Documentation, https://github.com/gongcastro/pymbrola#readme
+Project-URL: Issues, https://github.com/gongcastro/pymbrola/issues
+Project-URL: Source, https://github.com/gongcastro/pymbrola
+Author-email: gongcastro <gongarciacastro@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# pymbrola
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pymbrola.svg)](https://pypi.org/project/pymbrola)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pymbrola.svg)](https://pypi.org/project/pymbrola)
+
+-----
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+MBROLA is currently available only on Linux-based systems like Ubuntu, or on Windows via the [Windows Susbsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). Install MBROLA in your machine following the instructions in the [MBROLA repository](https://github.com/numediart/MBROLA). If you are using WSL, install MBROLA in WSL. After this, you should be ready to install **pymbrola** using pip.
+
+```console
+pip install pymbrola
+```
+
+## License
+
+`pymbrola` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

mbrola-0.0.2/README.md

@@ -0,0 +1,24 @@
+# pymbrola
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pymbrola.svg)](https://pypi.org/project/pymbrola)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pymbrola.svg)](https://pypi.org/project/pymbrola)
+
+-----
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+MBROLA is currently available only on Linux-based systems like Ubuntu, or on Windows via the [Windows Susbsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). Install MBROLA in your machine following the instructions in the [MBROLA repository](https://github.com/numediart/MBROLA). If you are using WSL, install MBROLA in WSL. After this, you should be ready to install **pymbrola** using pip.
+
+```console
+pip install pymbrola
+```
+
+## License
+
+`pymbrola` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

mbrola-0.0.2/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mbrola"
+dynamic = ["version"]
+description = 'A Python front-end for the MBROLA speech synthesizer'
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "gongcastro", email = "gongarciacastro@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/gongcastro/pymbrola#readme"
+Issues = "https://github.com/gongcastro/pymbrola/issues"
+Source = "https://github.com/gongcastro/pymbrola"
+
+[tool.hatch.version]
+path = "src/mbrola/__about__.py"
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/mbrola tests}"
+
+[tool.coverage.run]
+source_pkgs = ["mbrola", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/mbrola/__about__.py",
+]
+
+[tool.coverage.paths]
+pymbrola = ["src/mbrola", "*/pymbrola/src/mbrola"]
+tests = ["tests", "*/pymbrola/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

mbrola-0.0.2/src/mbrola/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present gongcastro <gongarciacastro@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.2"

mbrola-0.0.2/src/mbrola/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present gongcastro <gongarciacastro@gmail.com>
+#
+# SPDX-License-Identifier: MIT

mbrola-0.0.2/src/mbrola/mbrola.py

@@ -0,0 +1,173 @@
+import os
+import subprocess as sp
+import platform
+import shutil
+import functools
+
+
+class MBROLA:
+    """A class for generating MBROLA sounds.
+
+    An MBROLA class contains the necessary elements to synthesise an audio using MBROLA.
+
+    Args:
+        word (str): label for the mbrola sound.
+        phon (list[str]): list of phonemes.
+        durations (list[int] | int, optional): phoneme duration in milliseconds. Defaults to 100.
+        If an integer is provided, all phonemes in ``phon`` are assumed to be the same length. If a list is provided, each element in the list indicates the duration of each phoneme.
+        pitch (list[int] | int, optional): pitch in Hertz (Hz). Defaults to 200.
+        If an integer is provided, the pitch contour of each phoneme is assumed to be constant at the indicated value. If a list of integers or strings is provided, each element in the list indicates the value at which the pitch contour of each phoneme is kept constant. If a list of lists (of integers or strings), each value in each element describes the pitch contour for each phoneme.
+        onset_silence (int, optional): duration in milliseconds of the silence interval to be inserted at onset. Defaults to 1.
+        offset_silence (int, optional): duration in milliseconds of the silence interval to be inserted at offset. Defaults to 1.
+
+    Attributes:
+        word (str): label for the mbrola sound.
+        phon (list[str]): list of phonemes.
+        durations (list[int] | int, optional): phoneme duration in milliseconds. Defaults to 100.
+        If an integer is provided, all phonemes in ``phon`` are assumed to be the same length. If a list is provided, each element in the list indicates the duration of each phoneme.
+        pitch (list[int] | int, optional): pitch in Hertz (Hz). Defaults to 200.
+        If an integer is provided, the pitch contour of each phoneme is assumed to be constant at the indicated value. If a list of integers or strings is provided, each element in the list indicates the value at which the pitch contour of each phoneme is kept constant. If a list of lists (of integers or strings), each value in each element describes the pitch contour for each phoneme.
+        onset_silence (int, optional): duration in milliseconds of the silence interval to be inserted at onset. Defaults to 1.
+        offset_silence (int, optional): duration in milliseconds of the silence interval to be inserted at offset. Defaults to 1.
+
+    Raises:
+        ValueError: ``word`` must be a string
+        ValueError: ``phon`` must be a list of strings
+        ValueError: ``durations`` must be a list of integers or an integer
+        ValueError: ``phon`` and ``durations`` must have the same length
+        ValueError: ``pitch`` must be a list of integers or an integer
+        ValueError: ``phon`` and ``pitch`` must have the same length
+        ValueError: ``onset_silence`` must be an integer
+        ValueError: ``offset_silence`` must be an integer
+    """
+
+    def __init__(
+        self,
+        word: str,
+        phon: list[str],
+        durations: list[int] | int = 100,
+        pitch: list[int] | int = 200,
+        onset_silence: int = 1,
+        offset_silence: int = 1,
+    ):
+        self.word = word
+        self.phon = phon
+        self.durations = durations
+        self.pitch = pitch
+        self.onset_silence = onset_silence
+        self.offset_silence = offset_silence
+
+        nphon = len(self.phon)
+
+        if isinstance(self.durations, int):
+            self.durations = [self.durations] * nphon
+        self.durations = list(map(str, self.durations))
+        if isinstance(self.pitch, int):
+            self.pitch = [[self.pitch, self.pitch]] * nphon
+        if isinstance(self.pitch[0], int):
+            self.pitch = [list(map(str, [p, p])) for p in self.pitch]
+        self.pitch = [list(map(str, p)) for p in self.pitch]
+
+        validate_mbrola_args(self)
+
+        self.pho = make_pho(self)
+
+    def __str__(self):
+        return str("\n".join(self.pho))
+
+    def __repr__(self):
+        return str("\n".join(self.pho))
+
+    def export_pho(self, file: str):
+        try:
+            with open(f"{file}", "w+") as f:
+                f.write("\n".join(self.pho))
+        except FileNotFoundError:
+            print(f"{file} is not a valid path")
+
+    def make_sound(
+        self,
+        file: str,
+        voice: str = "it4",
+        f0_ratio: float = 1.0,
+        dur_ratio: float = 1.0,
+        remove_pho: bool = True,
+    ):
+        with open("tmp.pho", mode="w") as f:
+            f.write("\n".join(self.pho))
+
+        cmd = f"{mbrola_cmd()} -f {f0_ratio} -t {dur_ratio} /usr/share/mbrola/{voice}/{voice} tmp.pho {file}"
+
+        try:
+            sp.check_output(cmd)
+        except sp.CalledProcessError as e:
+            print(f"Error when making sound for {file}")
+        f.close()
+        if remove_pho:
+            os.remove("tmp.pho")
+        return None
+
+
+def validate_mbrola_args(self) -> None:
+    nphon = len(self.phon)
+    if isinstance(self.durations, list) and len(self.durations) != nphon:
+        raise ValueError("`phon` and `durations` must have the same length")
+    if isinstance(self.pitch, list):
+        if len(self.pitch) != nphon:
+            raise ValueError("`phon` and `pitch` must have the same length")
+    if self.onset_silence <= 0:
+        raise ValueError("`onset_silence` must be a positive integer")
+    if self.offset_silence <= 0:
+        raise ValueError("`offset_silence` must be a positive integer")
+    return None
+
+
+def make_pho(self) -> list[str]:
+    pho = [f"; {self.word}", f"_ {self.onset_silence}"]
+    for ph, d, p in zip(self.phon, self.durations, self.pitch):
+        p_seq = " ".join(p)
+        pho.append(" ".join([ph, d, p_seq]))
+    pho.append(f"_ {self.offset_silence}")
+    return pho
+
+
+@functools.cache
+def mbrola_cmd():
+    """
+    Get MBROLA command for system command line.
+    """
+    try:
+        if is_wsl() or os.name == "posix":
+            return "mbrola"
+        if os.name == "nt":
+            if wsl_available():
+                return "wsl mbrola"
+            else:
+                raise Exception(
+                    f"MBROLA only available on {platform.system()} using the Windows Subsystem for Linux (WSL). Please, follow the instructions in the WSL site: https://learn.microsoft.com/en-us/windows/wsl/install."
+                )
+    except:
+        raise Exception(f"MBROLA not available for {platform.system()}")
+
+
+@functools.cache
+def is_wsl(version: str = platform.uname().release) -> int:
+    """
+    Returns ```True`` if Python is running in WSL, otherwise ```False``
+    """
+    return version.endswith("microsoft-standard-WSL2")
+
+
+@functools.cache
+def wsl_available() -> int:
+    """
+    Returns ```True`` if Windows Subsystem for Linux (WLS) is available from Windows, otherwise ```False``
+    """
+    if os.name != "nt" or not shutil.which("wsl"):
+        return False
+    try:
+        return is_wsl(
+            sp.check_output(["wsl", "uname", "-r"], text=True, timeout=15).strip()
+        )
+    except sp.SubprocessError:
+        return False

mbrola-0.0.2/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present gongcastro <gongarciacastro@gmail.com>
+#
+# SPDX-License-Identifier: MIT