playsound3 2.0.0__tar.gz

playsound3-2.0.0/LICENSE

@@ -0,0 +1,33 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Taylor Marks <taylor@marksfam.com>
+Copyright (c) 2024 Szymon Mikler <sjmikler@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.
+
+##################################################################
+
+Files used for Unit Tests were downloaded from Wikimedia Commons - they and their licenses can be found at the following urls.
+I am not a lawyer, but it's my belief that as these files are merely used for unit testing and in no way necessary for using
+playsound that playsound can be distributed under the more permissive (supperior, actual free) MIT license and that the
+cancerous copyleft bullshit from the Creative Commons licenses that most of the files have:
+ - https://commons.wikimedia.org/wiki/File:Damonte.mp3
+ - https://commons.wikimedia.org/wiki/File:Sound4.wav
+ - https://commons.wikimedia.org/wiki/File:%D0%91%D1%83%D0%BA%D0%B2%D0%B0_%D0%AF.wav
+ - https://commons.wikimedia.org/wiki/File:Discovery_-_Go_at_throttle_up_(2).mp3

playsound3-2.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: playsound3
+Version: 2.0.0
+Summary: Cross-platform library to play audio files
+Home-page: https://github.com/sjmikler/playsound3
+Author: Szymon Mikler
+Author-email: sjmikler@gmail.com
+License: MIT
+Keywords: sound playsound music wave wav mp3 media song play audio
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Multimedia :: Sound/Audio :: MIDI
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players :: MP3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygobject; platform_system == "Linux"
+
+> This repository was initially forked from [TaylorSMarks/playsound](https://github.com/TaylorSMarks/playsound/blob/master/playsound.py)
+
+## Installation
+
+Install via pip:
+
+```
+pip install playsound3
+```
+
+## Quick Start
+
+Once installed, you can use the playsound function to play sound files:
+
+```python
+from playsound3 import playsound
+
+playsound("/path/to/sound/file.mp3")
+```
+
+## Documentation
+
+The playsound module contains only one thing - the function (also named) playsound:
+
+```python
+def playsound(sound: os.PathLike, block: bool = True) -> None:
+    """Play a sound file using an audio player availabile on your system.
+
+    Args:
+        sound: Path to the sound file.
+        block: If True, the function will block execution until the sound finishes playing.
+    """
+```
+
+It requires one argument - the path to the file with the sound you'd like to play. This may be a local file, or a URL.
+There's an optional second argument, block, which is set to True by default. Setting it to False makes the function run asynchronously.
+
+## Supported systems
+
+* Linux, using GStreamer (built-in on Linux distributions)
+* Windows, using windll.winmm (built-in on Windows)
+* OS X using afplay utility (built-in OS X)

playsound3-2.0.0/README.md

@@ -0,0 +1,42 @@
+> This repository was initially forked from [TaylorSMarks/playsound](https://github.com/TaylorSMarks/playsound/blob/master/playsound.py)
+
+## Installation
+
+Install via pip:
+
+```
+pip install playsound3
+```
+
+## Quick Start
+
+Once installed, you can use the playsound function to play sound files:
+
+```python
+from playsound3 import playsound
+
+playsound("/path/to/sound/file.mp3")
+```
+
+## Documentation
+
+The playsound module contains only one thing - the function (also named) playsound:
+
+```python
+def playsound(sound: os.PathLike, block: bool = True) -> None:
+    """Play a sound file using an audio player availabile on your system.
+
+    Args:
+        sound: Path to the sound file.
+        block: If True, the function will block execution until the sound finishes playing.
+    """
+```
+
+It requires one argument - the path to the file with the sound you'd like to play. This may be a local file, or a URL.
+There's an optional second argument, block, which is set to True by default. Setting it to False makes the function run asynchronously.
+
+## Supported systems
+
+* Linux, using GStreamer (built-in on Linux distributions)
+* Windows, using windll.winmm (built-in on Windows)
+* OS X using afplay utility (built-in OS X)

playsound3-2.0.0/playsound3/__init__.py

@@ -0,0 +1 @@
+from playsound3.playsound3 import playsound

playsound3-2.0.0/playsound3/playsound3.py

@@ -0,0 +1,115 @@
+import ctypes
+import logging
+import os
+import subprocess
+import uuid
+from pathlib import Path
+from platform import system
+from threading import Thread
+from urllib.request import pathname2url
+
+logger = logging.getLogger(__name__)
+
+SYSTEM = system()
+
+
+class PlaysoundException(Exception):
+    pass
+
+
+def playsound(sound: os.PathLike, block: bool = True) -> None:
+    """Play a sound file using an audio player availabile on your system.
+
+    Args:
+        sound: Path to the sound file.
+        block: If True, the function will block execution until the sound finishes playing.
+    """
+    sound = _prepare_path(sound)
+
+    if SYSTEM == "Linux":
+        func = _playsound_gstreamer
+    elif SYSTEM == "Windows":
+        func = _playsound_winmm
+    elif SYSTEM == "Darwin":
+        func = _playsound_afplay
+    else:
+        raise PlaysoundException(f"Platform '{SYSTEM}' is not supported")
+
+    if block:
+        func(sound)
+    else:
+        t = Thread(target=func, args=(sound,)).start()
+
+
+def _prepare_path(sound):
+    path = Path(sound)
+
+    if not path.exists():
+        raise PlaysoundException(f"File not found: {sound}")
+
+    return path.absolute().as_posix()
+
+
+def _playsound_gstreamer(sound):
+    """Play a sound using gstreamer (built-in Linux)."""
+
+    if not sound.startswith(("http://", "https://", "file://")):
+        path = os.path.abspath(sound)
+        if not os.path.exists(path):
+            raise PlaysoundException(f"File not found: {path}")
+        sound = "file://" + pathname2url(path)
+
+    import gi
+
+    # Silences gi warning
+    gi.require_version("Gst", "1.0")
+
+    # GStreamer is included in all Linux distributions
+    from gi.repository import Gst
+
+    Gst.init(None)
+
+    playbin = Gst.ElementFactory.make("playbin", "playbin")
+    playbin.props.uri = sound
+
+    logger.debug("gstreamer: starting playing %s", sound)
+    set_result = playbin.set_state(Gst.State.PLAYING)
+    if set_result != Gst.StateChangeReturn.ASYNC:
+        raise PlaysoundException("playbin.set_state returned " + repr(set_result))
+    bus = playbin.get_bus()
+    try:
+        bus.poll(Gst.MessageType.EOS, Gst.CLOCK_TIME_NONE)
+    finally:
+        playbin.set_state(Gst.State.NULL)
+    logger.debug("gstreamer: finishing play %s", sound)
+
+
+def _send_winmm_mci_command(command):
+    winmm = ctypes.WinDLL("winmm.dll")
+    buffer = ctypes.create_string_buffer(255)
+    error_code = winmm.mciSendStringA(ctypes.c_char_p(command.encode()), buffer, 254, 0)
+    if error_code:
+        logger.error("Error code: %s", error_code)
+    return buffer.value
+
+
+def _playsound_winmm(sound):
+    """Play a sound utilizing windll.winmm."""
+
+    # Select a unique alias for the sound
+    alias = str(uuid.uuid4())
+    logger.debug("winmm: starting playing %s", sound)
+    _send_winmm_mci_command(f'open "{sound}" type mpegvideo alias {alias}')
+    _send_winmm_mci_command(f"play {alias} wait")
+    _send_winmm_mci_command(f"close {alias}")
+    logger.debug("winmm: finishing play %s", sound)
+
+
+def _playsound_afplay(sound):
+    """Uses afplay utility (built-in macOS)."""
+    logger.debug("afplay: starting playing %s", sound)
+    try:
+        subprocess.run(["afplay", sound], check=True)
+    except subprocess.CalledProcessError as e:
+        raise PlaysoundException(f"afplay failed to play sound: {e}")
+    logger.debug("afplay: finishing play %s", sound)

playsound3-2.0.0/playsound3.egg-info/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: playsound3
+Version: 2.0.0
+Summary: Cross-platform library to play audio files
+Home-page: https://github.com/sjmikler/playsound3
+Author: Szymon Mikler
+Author-email: sjmikler@gmail.com
+License: MIT
+Keywords: sound playsound music wave wav mp3 media song play audio
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Multimedia :: Sound/Audio :: MIDI
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players :: MP3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygobject; platform_system == "Linux"
+
+> This repository was initially forked from [TaylorSMarks/playsound](https://github.com/TaylorSMarks/playsound/blob/master/playsound.py)
+
+## Installation
+
+Install via pip:
+
+```
+pip install playsound3
+```
+
+## Quick Start
+
+Once installed, you can use the playsound function to play sound files:
+
+```python
+from playsound3 import playsound
+
+playsound("/path/to/sound/file.mp3")
+```
+
+## Documentation
+
+The playsound module contains only one thing - the function (also named) playsound:
+
+```python
+def playsound(sound: os.PathLike, block: bool = True) -> None:
+    """Play a sound file using an audio player availabile on your system.
+
+    Args:
+        sound: Path to the sound file.
+        block: If True, the function will block execution until the sound finishes playing.
+    """
+```
+
+It requires one argument - the path to the file with the sound you'd like to play. This may be a local file, or a URL.
+There's an optional second argument, block, which is set to True by default. Setting it to False makes the function run asynchronously.
+
+## Supported systems
+
+* Linux, using GStreamer (built-in on Linux distributions)
+* Windows, using windll.winmm (built-in on Windows)
+* OS X using afplay utility (built-in OS X)

playsound3-2.0.0/playsound3.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+playsound3/__init__.py
+playsound3/playsound3.py
+playsound3.egg-info/PKG-INFO
+playsound3.egg-info/SOURCES.txt
+playsound3.egg-info/dependency_links.txt
+playsound3.egg-info/requires.txt
+playsound3.egg-info/top_level.txt

playsound3-2.0.0/playsound3.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

playsound3-2.0.0/playsound3.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[:platform_system == "Linux"]
+pygobject

playsound3-2.0.0/playsound3.egg-info/top_level.txt

@@ -0,0 +1 @@
+playsound3

playsound3-2.0.0/pyproject.toml

@@ -0,0 +1,13 @@
+[tool.pytest.ini_options]
+pythonpath = ["."]
+
+[tool.mypy]
+ignore_missing_imports = true
+exclude = ["devel", "build", "dist"]
+
+[tool.isort]
+profile = "black"
+line_length = 120
+
+[tool.black]
+line_length = 120

playsound3-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

playsound3-2.0.0/setup.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+
+from setuptools import find_packages, setup
+
+
+def package_relative_path(path):
+    return Path(__file__).parent / path
+
+
+long_description = package_relative_path("README.md").read_text(encoding="UTF-8")
+
+setup(
+    name="playsound3",
+    version="2.0.0",
+    description="Cross-platform library to play audio files",
+    url="https://github.com/sjmikler/playsound3",
+    author="Szymon Mikler",
+    author_email="sjmikler@gmail.com",
+    license="MIT",
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Topic :: Multimedia :: Sound/Audio :: MIDI",
+        "Topic :: Multimedia :: Sound/Audio :: Players",
+        "Topic :: Multimedia :: Sound/Audio :: Players :: MP3",
+    ],
+    keywords="sound playsound music wave wav mp3 media song play audio",
+    packages=find_packages(),
+    python_requires=">=3.7",
+    install_requires=[
+        "pygobject; platform_system=='Linux'",
+    ],
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+)