pyglet 2.1.12__py3-none-any.whl → 3.0.dev1__py3-none-any.whl

pyglet/media/codecs/base.py

@@ -3,16 +3,16 @@ from __future__ import annotations
 import ctypes
 import io
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, BinaryIO, List, Optional, Union
+from typing import TYPE_CHECKING, BinaryIO, Optional, Union
 
-from pyglet.media.exceptions import CannotSeekException, MediaException
+from pyglet.media.exceptions import MediaException, CannotSeekException
 
 if TYPE_CHECKING:
-    from pyglet.image import AbstractImage
+    from pyglet.graphics import Texture
     from pyglet.image.animation import Animation
     from pyglet.media.codecs import MediaEncoder
     from pyglet.media.drivers.base import MediaEvent
-    from pyglet.media.player import Player
+    from pyglet.media.player import AudioPlayer
 
 
 class AudioFormat:
@@ -21,15 +21,20 @@ class AudioFormat:
     An instance of this class is provided by sources with audio tracks.  You
     should not modify the fields, as they are used internally to describe the
     format of data provided by the source.
-
-    Args:
-        channels (int): The number of channels: 1 for mono or 2 for stereo
-            (pyglet does not yet support surround-sound sources).
-        sample_size (int): Bits per sample; only 8 or 16 are supported.
-        sample_rate (int): Samples per second (in Hertz).
     """
 
     def __init__(self, channels: int, sample_size: int, sample_rate: int) -> None:
+        """Specify the audio format properties.
+
+        Args:
+            channels:
+                The number of channels: 1 for mono or 2 for stereo
+                (pyglet does not yet support surround-sound sources).
+            sample_size:
+                Bits per sample; only 8 or 16 are supported.
+            sample_rate:
+                Samples per second (in Hertz).
+        """
         self.channels = channels
         self.sample_size = sample_size
         self.sample_rate = sample_rate
@@ -91,12 +96,15 @@ class VideoFormat:
     should be displayed at 1280x480.  It is the responsibility of the
     application to perform this scaling.
 
-    Args:
-        width (int): Width of video image, in pixels.
-        height (int): Height of video image, in pixels.
-        sample_aspect (float): Aspect ratio (width over height) of a single
-            video pixel.
-        frame_rate (float): Frame rate (frames per second) of the video.
+        Args:
+            width:
+                Width of video image, in pixels.
+            height:
+                Height of video image, in pixels.
+            sample_aspect:
+                Aspect ratio (width over height) of a single video pixel.
+            frame_rate:
+                Frame rate (frames per second) of the video or ``None`` if not known.
 
             .. versionadded:: 1.2
     """
@@ -110,29 +118,35 @@ class AudioData:
     """A single packet of audio data.
 
     This class is used internally by pyglet.
-
-    Args:
-        data (bytes, ctypes array, or supporting buffer protocol): Sample data.
-        length (int): Size of sample data, in bytes.
-        timestamp (float): Time of the first sample, in seconds.
-        duration (float): Total data duration, in seconds.
-        events (List[:class:`pyglet.media.drivers.base.MediaEvent`]): List of events
-            contained within this packet. Events are timestamped relative to
-            this audio packet.
-
-    .. deprecated:: 2.0.10
-            `timestamp` and `duration` are unused and will be removed eventually.
     """
 
     __slots__ = 'data', 'duration', 'events', 'length', 'pointer', 'timestamp'
 
-    def __init__(self,
-                 data: bytes | ctypes.Array,
-                 length: int,
-                 timestamp: float = 0.0,
-                 duration: float = 0.0,
-                 events: list[MediaEvent] | None = None) -> None:
+    def __init__(
+        self,
+        data: bytes | ctypes.Array,
+        length: int,
+        timestamp: float = 0.0,
+        duration: float = 0.0,
+        events: list[MediaEvent] | None = None,
+    ) -> None:
+        """Events (List[:class:`pyglet.media.drivers.base.MediaEvent`]):
+
+        Args:
+            data:
+                (bytes, ctypes array, or supporting buffer protocol): Sample data.
+            length:
+                Size of sample data, in bytes.
+            timestamp:
+                Time of the first sample, in seconds.
+            duration:
+                Total data duration, in seconds.
+            events:
+                List of events contained within this packet. Events are timestamped relative to this audio packet.
 
+        .. deprecated:: 2.0.10
+        `timestamp` and `duration` are unused and will be removed eventually.
+        """
         if isinstance(data, bytes):
             # bytes are treated specially by ctypes and can be cast to a void pointer, get
             # their content's address like this
@@ -200,21 +214,21 @@ class Source:
         is_player_source (bool): Determine if this source is a player
             current source.
 
-            Check on a :py:class:`~pyglet.media.player.Player` if this source
+            Check on a :py:class:`~pyglet.media.player.AudioPlayer` if this source
             is the current source.
     """
 
     _duration = None
-    _players: List['Player'] = []  # Players created through Source.play
+    _players: list[AudioPlayer] = []  # Players created through Source.play
 
-    audio_format = None
-    video_format = None
-    info = None
-    is_player_source = False
+    audio_format: AudioFormat | None = None
+    video_format: VideoFormat | None = None
+    info: SourceInfo | None = None
+    is_player_source: bool = False
 
     @property
     def duration(self) -> float:
-        """float: The length of the source, in seconds.
+        """The length of the source, in seconds.
 
         Not all source durations can be determined; in this case the value
         is ``None``.
@@ -223,7 +237,7 @@ class Source:
         """
         return self._duration
 
-    def play(self) -> 'Player':
+    def play(self) -> AudioPlayer:
         """Play the source.
 
         This is a convenience method which creates a Player for
@@ -232,8 +246,9 @@ class Source:
         Returns:
             :class:`.Player`
         """
-        from pyglet.media.player import Player  # XXX Nasty circular dependency
-        player = Player()
+        from pyglet.media.player import AudioPlayer  # XXX Nasty circular dependency
+
+        player = AudioPlayer()
         player.queue(self)
         player.play()
         Source._players.append(player)
@@ -259,28 +274,25 @@ class Source:
         few seconds.
 
         .. versionadded:: 1.1
-
-        Returns:
-            :class:`pyglet.image.Animation`
         """
         from pyglet.image import Animation, AnimationFrame
+
         if not self.video_format:
             # XXX: This causes an assertion in the constructor of Animation
             return Animation([])
-        else:
-            frames = []
-            last_ts = 0
+        frames = []
+        last_ts = 0
+        next_ts = self.get_next_video_timestamp()
+        while next_ts is not None:
+            image = self.get_next_video_frame()
+            if image is not None:
+                delay = next_ts - last_ts
+                frames.append(AnimationFrame(image, delay))
+                last_ts = next_ts
             next_ts = self.get_next_video_timestamp()
-            while next_ts is not None:
-                image = self.get_next_video_frame()
-                if image is not None:
-                    delay = next_ts - last_ts
-                    frames.append(AnimationFrame(image, delay))
-                    last_ts = next_ts
-                next_ts = self.get_next_video_timestamp()
-            return Animation(frames)
-
-    def get_next_video_timestamp(self) -> Optional[float]:
+        return Animation(frames)
+
+    def get_next_video_timestamp(self) -> float | None:
         """Get the timestamp of the next video frame.
 
         .. versionadded:: 1.1
@@ -289,33 +301,27 @@ class Source:
             float: The next timestamp, or ``None`` if there are no more video
             frames.
         """
-        pass
 
-    def get_next_video_frame(self) -> Optional['AbstractImage']:
+    def get_next_video_frame(self) -> Texture | None:
         """Get the next video frame.
 
-        .. versionadded:: 1.1
-
         Returns:
-            :class:`pyglet.image.AbstractImage`: The next video frame image,
-            or ``None`` if the video frame could not be decoded or there are
+            The next video frame image, or ``None`` if the video frame could not be decoded or there are
             no more video frames.
+
+        .. versionadded:: 1.1
         """
-        pass
 
-    def save(self,
-             filename: str,
-             file: Optional[BinaryIO] = None,
-             encoder: Optional['MediaEncoder'] = None) -> None:
+    def save(self, filename: str, file: BinaryIO | None = None, encoder: MediaEncoder | None = None) -> None:
         """Save this Source to a file.
 
-        :Parameters:
-            `filename` : str
+        Args:
+            filename
                 Used to set the file format, and to open the output file
                 if `file` is unspecified.
-            `file` : file-like object or None
+            file:
                 File to write audio data to.
-            `encoder` : MediaEncoder or None
+            encoder:
                 If unspecified, all encoders matching the filename extension
                 are tried.  If all fail, the exception from the first one
                 attempted is raised.
@@ -323,14 +329,14 @@ class Source:
         """
         if encoder:
             return encoder.encode(self, filename, file)
-        else:
-            import pyglet.media.codecs
-            return pyglet.media.codecs.registry.encode(self, filename, file)
+        import pyglet.media.codecs
+
+        return pyglet.media.codecs.registry.encode(self, filename, file)
 
     # Internal methods that Player calls on the source:
 
     def is_precise(self) -> bool:
-        """bool: Whether this source is considered precise.
+        """Whether this source is considered precise.
 
         ``x`` bytes on source ``s`` are considered aligned if
         ``x % s.audio_format.bytes_per_frame == 0``, so there'd be no partial
@@ -362,8 +368,8 @@ class Source:
         negatively impacted at best and memory access violations occur at
         worst.
 
-        :Returns:
-            bool: Whether the source is precise.
+        Returns:
+            Whether the source is precise.
         """
         return False
 
@@ -376,7 +382,7 @@ class Source:
         """
         raise CannotSeekException()
 
-    def get_queue_source(self) -> 'Source':
+    def get_queue_source(self) -> Source:
         """Return the ``Source`` to be used as the queue source for a player.
 
         Default implementation returns ``self``.
@@ -386,7 +392,7 @@ class Source:
         """
         return self
 
-    def get_audio_data(self, num_bytes: int, compensation_time=0.0) -> Optional[AudioData]:
+    def get_audio_data(self, num_bytes: int, compensation_time=0.0) -> AudioData | None:
         """Get next packet of audio data.
 
         Args:
@@ -409,10 +415,10 @@ class StreamingSource(Source):
     """A source that is decoded as it is being played.
 
     The source can only be played once at a time on any
-    :class:`~pyglet.media.player.Player`.
+    :class:`~pyglet.media.player.AudioPlayer`.
     """
 
-    def get_queue_source(self) -> 'StreamingSource':
+    def get_queue_source(self) -> StreamingSource:
         """Return the ``Source`` to be used as the source for a player.
 
         Default implementation returns self.
@@ -427,7 +433,6 @@ class StreamingSource(Source):
 
     def delete(self) -> None:
         """Release the resources held by this StreamingSource."""
-        pass
 
 
 class StaticSource(Source):
@@ -469,7 +474,7 @@ class StaticSource(Source):
 
         self._duration = len(self._data) / self.audio_format.bytes_per_second
 
-    def get_queue_source(self) -> Optional['StaticMemorySource']:
+    def get_queue_source(self) -> Optional[StaticMemorySource]:
         if self._data is not None:
             return StaticMemorySource(self._data, self.audio_format)
         return None
@@ -478,7 +483,7 @@ class StaticSource(Source):
         """The StaticSource does not provide audio data.
 
         When the StaticSource is queued on a
-        :class:`~pyglet.media.player.Player`, it creates a
+        :class:`~pyglet.media.player.AudioPlayer`, it creates a
         :class:`.StaticMemorySource` containing its internal audio data and
         audio format.
 
@@ -489,8 +494,7 @@ class StaticSource(Source):
 
 
 class StaticMemorySource(StaticSource):
-    """
-    Helper class for default implementation of :class:`.StaticSource`.
+    """Helper class for default implementation of :class:`.StaticSource`.
 
     Do not use directly. This class is used internally by pyglet.
 
@@ -569,14 +573,14 @@ class SourceGroup:
         self.audio_format = self.audio_format or source.audio_format
         self.info = self.info or source.info
         source = source.get_queue_source()
-        assert (source.audio_format == self.audio_format), "Sources must share the same audio format."
+        assert source.audio_format == self.audio_format, "Sources must share the same audio format."
         self._sources.append(source)
         self.duration += source.duration
 
     def has_next(self) -> bool:
         return len(self._sources) > 1
 
-    def get_queue_source(self) -> 'SourceGroup':
+    def get_queue_source(self) -> SourceGroup:
         return self
 
     def _advance(self) -> None:
@@ -592,14 +596,13 @@ class SourceGroup:
     def get_audio_data(self, num_bytes: float, compensation_time=0.0) -> Optional[AudioData]:
         """Get next audio packet.
 
-        :Parameters:
+        Args:
             `num_bytes` : int
                 Hint for preferred size of audio packet; may be ignored.
 
-        :rtype: `AudioData`
-        :return: Audio data, or None if there is no more data.
+        Returns:
+            Audio data, or ``None`` if there is no more data.
         """
-
         if not self._sources:
             return None
 

pyglet/media/codecs/ffmpeg.py

@@ -1037,7 +1037,7 @@ class FFmpegSource(StreamingSource):
         width = self.video_format.width
         height = self.video_format.height
         pitch = width * 4
-        buf_size = avutil.av_image_get_buffer_size(AV_PIX_FMT_RGBA, width, height, 1) + AV_INPUT_BUFFER_PADDING_SIZE
+        buf_size = avutil.av_image_get_buffer_size(AV_PIX_FMT_RGBA, width, height, 1)
         buffer = (c_uint8 * buf_size)()
         try:
             result = self._ffmpeg_decode_video(video_packet.packet, buffer)
@@ -1195,7 +1195,7 @@ class FFmpegSource(StreamingSource):
 
 
 ffmpeg_init()
-if pyglet.options['debug_media']:
+if pyglet.options.debug_media:
     _debug = True
 else:
     _debug = False

pyglet/media/codecs/ffmpeg_lib/libavformat.py

@@ -132,8 +132,8 @@ AVStream_Fields = [
         ('metadata', POINTER(AVDictionary)),
         ('avg_frame_rate', AVRational),
         ('attached_pic', AVPacket),
-        ('side_data', POINTER(AVPacketSideData)),  # Deprecated in 60. Removed in 62.
-        ('nb_side_data', c_int),  # Deprecated in 60. Removed in 62.
+        ('side_data', POINTER(AVPacketSideData)),
+        ('nb_side_data', c_int),
         ('event_flags', c_int),
         ('r_frame_rate', AVRational),
         ('recommended_encoder_configuration', c_char_p),  # Deprecated. Removed in 59.
@@ -147,16 +147,11 @@ compat.add_version_changes('avformat', 58, AVStream, AVStream_Fields, removals=(
 compat.add_version_changes('avformat', 59, AVStream, AVStream_Fields,
                            removals=('av_class', 'codec', 'recommended_encoder_configuration', 'info'))
 
-for compat_ver in (60, 61):
+for compat_ver in (60, 61, 62):
     compat.add_version_changes('avformat', compat_ver, AVStream, AVStream_Fields,
                                removals=('codec', 'recommended_encoder_configuration', 'info'),
                                repositions=(compat.Reposition("codecpar", "id"),))
 
-compat.add_version_changes('avformat', 62, AVStream, AVStream_Fields,
-                           removals=('codec', 'recommended_encoder_configuration', 'info', 'side_data',
-                                     'nb_side_data'),
-                           repositions=(compat.Reposition("codecpar", "id"),))
-
 
 class AVProgram(Structure):
     pass

pyglet/media/codecs/webaudio_pyodide.py

@@ -0,0 +1,111 @@
+from __future__ import annotations
+
+import weakref
+from typing import BinaryIO, NoReturn, TYPE_CHECKING
+
+import pyglet
+
+from . import MediaDecoder
+from .base import AudioFormat, Source, StaticSource
+
+_debug = pyglet.options.debug_media
+
+try:
+    import js
+    import pyodide.ffi
+except ImportError:
+    raise ImportError("Pyodide not found.")
+
+
+from pyglet.media import get_audio_driver
+
+if TYPE_CHECKING:
+    from pyglet.media.drivers.pyodide_js.adaptation import PyodideJSAudioPlayer
+
+
+class JavascriptWebAudioSource(Source):
+    def __init__(self, filename: str, file: BinaryIO | None = None) -> None:  # noqa: D107
+        if file is None:
+            with open(filename, 'rb') as f:
+                data = f.read()
+            self._file = data
+        else:
+            self._file = file.read()
+
+        self.filename = filename
+        self.js_array = js.Uint8Array.new(self._file)
+        self.audio_buffer = None
+        self._duration = 0
+        self._current_offset = 0
+
+        # Default dummy audio format so AudioPlayer can create an internal PyodideJSAudioPlayer.
+        # The JavaScript internal player doesn't use this object.
+        self.audio_format = AudioFormat(channels=2, sample_size=16, sample_rate=44100)
+
+        # If this audio is not finished loading, a player may be waiting to play it.
+        self._waiting_players = weakref.WeakSet()
+
+        get_audio_driver().decode_audio(self.js_array.buffer).then(self.on_decode).catch(self.on_error)
+
+    def add_player(self, player: PyodideJSAudioPlayer) -> None:
+        self._waiting_players.add(player)
+
+    # Decode the audio data
+    def on_decode(self, audio_buffer) -> None:
+        if _debug:
+            print(f"Decoded {self.filename} successfully.")
+        self.audio_buffer = audio_buffer
+
+        self.audio_format = AudioFormat(
+            channels=self.audio_buffer.numberOfChannels,
+            sample_size=16,
+            sample_rate=self.audio_buffer.sampleRate,
+        )
+        self._duration = self.audio_buffer.duration
+
+        for player in self._waiting_players:
+            player.on_source_finished_loading(self)
+
+        self._waiting_players.clear()
+
+    def on_error(self, error) -> NoReturn:
+        js.console.log(f"Failed decoding {self.filename}: {error}")
+
+        self._waiting_players.clear()
+
+    def __del__(self) -> None:
+        if hasattr(self, '_file'):
+            self._file = None
+
+        self.js_array = None
+        self.audio_buffer = None
+
+    def get_audio_data(self, num_bytes: int, compensation_time: float = 0.0) -> NoReturn:
+        raise NotImplementedError("This is not supported and should not be called.")
+
+    def seek(self, timestamp: float) -> NoReturn:
+        """This is not supported by Javascript."""
+
+
+#########################################
+#   Decoder class:
+#########################################
+
+
+class PyodideDecoder(MediaDecoder):  # noqa: D101
+    def get_file_extensions(self) -> tuple[str, ...]:
+        return '.mp3', '.aac', '.wav', '.ogg', '.webm'
+        # possibly use audio.canPlayType?
+
+    def decode(self, filename: str, file: BinaryIO, streaming: bool = True) -> JavascriptWebAudioSource | StaticSource:
+        if streaming:
+            return JavascriptWebAudioSource(filename, file)
+        return StaticSource(JavascriptWebAudioSource(filename, file))
+
+
+def get_decoders() -> list[PyodideDecoder]:  # noqa: D103
+    return [PyodideDecoder()]
+
+
+def get_encoders() -> list:  # noqa: D103
+    return []

pyglet/media/drivers/__init__.py

@@ -5,7 +5,7 @@ import atexit
 
 import pyglet
 
-_debug = pyglet.options['debug_media']
+_debug = pyglet.options.debug_media
 _is_pyglet_doc_run = hasattr(sys, "is_pyglet_doc_run") and sys.is_pyglet_doc_run
 
 
@@ -15,7 +15,7 @@ if _is_pyglet_doc_run:
 
 else:
 
-    for driver_name in pyglet.options['audio']:
+    for driver_name in pyglet.options.audio:
         try:
             if driver_name == 'pulse':
                 from . import pulse
@@ -55,8 +55,13 @@ else:
                 traceback.print_exc()
 
     else:
-        from . import silent
-        _audio_driver = silent.create_audio_driver()
+        if pyglet.compat_platform == "emscripten":
+            from . import pyodide_js
+
+            _audio_driver = pyodide_js.create_audio_driver()
+        else:
+            from . import silent
+            _audio_driver = silent.create_audio_driver()
 
 
 def get_audio_driver():

pyglet/media/drivers/base.py

@@ -409,7 +409,7 @@ class AbstractAudioPlayer(metaclass=ABCMeta):
         pass
 
     def set_position(self, position):
-        """See :py:attr:`~pyglet.media.Player.position`."""
+        """See :py:attr:`~pyglet.media.AudioPlayer.position`."""
         pass
 
     def set_min_distance(self, min_distance):
@@ -421,7 +421,7 @@ class AbstractAudioPlayer(metaclass=ABCMeta):
         pass
 
     def set_pitch(self, pitch):
-        """See :py:attr:`~pyglet.media.Player.pitch`."""
+        """See :py:attr:`~pyglet.media.AudioPlayer.pitch`."""
         pass
 
     def set_cone_orientation(self, cone_orientation):
@@ -459,7 +459,7 @@ class MediaEvent:
     """Representation of a media event.
 
     These events are used internally by some audio driver implementation to
-    communicate events to the :class:`~pyglet.media.player.Player`.
+    communicate events to the :class:`~pyglet.media.player.AudioPlayer`.
     One example is the ``on_eos`` event.
 
     Args:
@@ -468,7 +468,7 @@ class MediaEvent:
         *args: Any required positional argument to go along with this event.
     """
 
-    __slots__ = 'event', 'timestamp', 'args'
+    __slots__ = 'args', 'event', 'timestamp'
 
     def __init__(self, event, timestamp=0.0, *args):
         # Meaning of timestamp is dependent on context; and not seen by application.

pyglet/media/drivers/openal/__init__.py

@@ -2,7 +2,7 @@ from .adaptation import OpenALDriver
 
 import pyglet
 
-_debug = pyglet.options['debug_media']
+_debug = pyglet.options.debug_media
 _debug_buffers = pyglet.options.get('debug_media_buffers', False)
 
 

pyglet/media/drivers/openal/adaptation.py

@@ -9,7 +9,7 @@ from pyglet.media.player_worker_thread import PlayerWorkerThread
 from pyglet.util import debug_print
 
 if TYPE_CHECKING:
-    from pyglet.media import Source, Player
+    from pyglet.media import Source, AudioPlayer
 
 
 _debug = debug_print('debug_media')
@@ -28,7 +28,7 @@ class OpenALDriver(AbstractAudioDriver):
         self.worker = PlayerWorkerThread()
         self.worker.start()
 
-    def create_audio_player(self, source: 'Source', player: 'Player') -> 'OpenALAudioPlayer':
+    def create_audio_player(self, source: 'Source', player: 'AudioPlayer') -> 'OpenALAudioPlayer':
         assert self.device is not None, 'Device was closed'
         return OpenALAudioPlayer(self, source, player)
 
@@ -91,7 +91,7 @@ class OpenALListener(AbstractListener):
 
 
 class OpenALAudioPlayer(AbstractAudioPlayer):
-    def __init__(self, driver: 'OpenALDriver', source: 'Source', player: 'Player') -> None:
+    def __init__(self, driver: 'OpenALDriver', source: 'Source', player: 'AudioPlayer') -> None:
         super().__init__(source, player)
         self.driver = driver
         self.alsource = driver.context.create_source()

pyglet/media/drivers/pulse/__init__.py

@@ -2,7 +2,7 @@ from .adaptation import PulseAudioDriver
 
 import pyglet
 
-_debug = pyglet.options['debug_media']
+_debug = pyglet.options.debug_media
 
 
 def create_audio_driver():