247 lines
8.4 KiB
Python
247 lines
8.4 KiB
Python
|
# ----------------------------------------------------------------------------
|
||
|
|
# pyglet
|
||
|
|
# Copyright (c) 2006-2008 Alex Holkner
|
||
|
|
# Copyright (c) 2008-2020 pyglet contributors
|
||
|
|
# All rights reserved.
|
||
|
|
#
|
||
|
|
# Redistribution and use in source and binary forms, with or without
|
||
|
|
# modification, are permitted provided that the following conditions
|
||
|
|
# are met:
|
||
|
|
#
|
||
|
|
# * Redistributions of source code must retain the above copyright
|
||
|
|
# notice, this list of conditions and the following disclaimer.
|
||
|
|
# * Redistributions in binary form must reproduce the above copyright
|
||
|
|
# notice, this list of conditions and the following disclaimer in
|
||
|
|
# the documentation and/or other materials provided with the
|
||
|
|
# distribution.
|
||
|
|
# * Neither the name of pyglet nor the names of its
|
||
|
|
# contributors may be used to endorse or promote products
|
||
|
|
# derived from this software without specific prior written
|
||
|
|
# permission.
|
||
|
|
#
|
||
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||
|
|
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||
|
|
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
|
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||
|
|
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
|
|
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||
|
|
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||
|
|
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||
|
|
# POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
# ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
"""Various utility functions used internally by pyglet
|
||
|
|
"""
|
||
|
|
|
||
|
|
import os
|
||
|
|
import sys
|
||
|
|
|
||
|
|
import pyglet
|
||
|
|
|
||
|
|
|
||
|
|
def asbytes(s):
|
||
|
|
if isinstance(s, bytes):
|
||
|
|
return s
|
||
|
|
elif isinstance(s, str):
|
||
|
|
return bytes(ord(c) for c in s)
|
||
|
|
else:
|
||
|
|
return bytes(s)
|
||
|
|
|
||
|
|
|
||
|
|
def asbytes_filename(s):
|
||
|
|
if isinstance(s, bytes):
|
||
|
|
return s
|
||
|
|
elif isinstance(s, str):
|
||
|
|
return s.encode(encoding=sys.getfilesystemencoding())
|
||
|
|
|
||
|
|
|
||
|
|
def asstr(s):
|
||
|
|
if s is None:
|
||
|
|
return ''
|
||
|
|
if isinstance(s, str):
|
||
|
|
return s
|
||
|
|
return s.decode("utf-8")
|
||
|
|
|
||
|
|
|
||
|
|
def with_metaclass(meta, *bases):
|
||
|
|
"""
|
||
|
|
Function from jinja2/_compat.py. License: BSD.
|
||
|
|
Use it like this::
|
||
|
|
class BaseForm:
|
||
|
|
pass
|
||
|
|
class FormType(type):
|
||
|
|
pass
|
||
|
|
class Form(with_metaclass(FormType, BaseForm)):
|
||
|
|
pass
|
||
|
|
This requires a bit of explanation: the basic idea is to make a
|
||
|
|
dummy metaclass for one level of class instantiation that replaces
|
||
|
|
itself with the actual metaclass. Because of internal type checks
|
||
|
|
we also need to make sure that we downgrade the custom metaclass
|
||
|
|
for one level to something closer to type (that's why __call__ and
|
||
|
|
__init__ comes back from type etc.).
|
||
|
|
This has the advantage over six.with_metaclass of not introducing
|
||
|
|
dummy classes into the final MRO.
|
||
|
|
"""
|
||
|
|
class MetaClass(meta):
|
||
|
|
__call__ = type.__call__
|
||
|
|
__init__ = type.__init__
|
||
|
|
|
||
|
|
def __new__(cls, name, this_bases, d):
|
||
|
|
if this_bases is None:
|
||
|
|
return type.__new__(cls, name, (), d)
|
||
|
|
return meta(name, bases, d)
|
||
|
|
|
||
|
|
return MetaClass('temporary_class', None, {})
|
||
|
|
|
||
|
|
|
||
|
|
def debug_print(enabled_or_option='debug'):
|
||
|
|
"""Get a debug printer that is enabled based on a boolean input or a pyglet option.
|
||
|
|
The debug print function returned should be used in an assert. This way it can be
|
||
|
|
optimized out when running python with the -O flag.
|
||
|
|
|
||
|
|
Usage example::
|
||
|
|
|
||
|
|
from pyglet.debug import debug_print
|
||
|
|
_debug_media = debug_print('debug_media')
|
||
|
|
|
||
|
|
def some_func():
|
||
|
|
assert _debug_media('My debug statement')
|
||
|
|
|
||
|
|
:parameters:
|
||
|
|
`enabled_or_options` : bool or str
|
||
|
|
If a bool is passed, debug printing is enabled if it is True. If str is passed
|
||
|
|
debug printing is enabled if the pyglet option with that name is True.
|
||
|
|
|
||
|
|
:returns: Function for debug printing.
|
||
|
|
"""
|
||
|
|
if isinstance(enabled_or_option, bool):
|
||
|
|
enabled = enabled_or_option
|
||
|
|
else:
|
||
|
|
enabled = pyglet.options.get(enabled_or_option, False)
|
||
|
|
|
||
|
|
if enabled:
|
||
|
|
def _debug_print(*args, **kwargs):
|
||
|
|
print(*args, **kwargs)
|
||
|
|
return True
|
||
|
|
|
||
|
|
else:
|
||
|
|
def _debug_print(*args, **kwargs):
|
||
|
|
return True
|
||
|
|
|
||
|
|
return _debug_print
|
||
|
|
|
||
|
|
|
||
|
|
class Codecs:
|
||
|
|
"""Utility class for handling adding and querying of codecs."""
|
||
|
|
|
||
|
|
def __init__(self):
|
||
|
|
self._decoders = []
|
||
|
|
self._encoders = []
|
||
|
|
self._decoder_extensions = {} # Map str -> list of matching ImageDecoders
|
||
|
|
self._encoder_extensions = {} # Map str -> list of matching ImageEncoders
|
||
|
|
|
||
|
|
def get_encoders(self, filename=None):
|
||
|
|
"""Get a list of all encoders. If a `filename` is provided, only
|
||
|
|
encoders supporting that extension will be returned. An empty list
|
||
|
|
will be return if no encoders for that extension are available.
|
||
|
|
"""
|
||
|
|
if filename:
|
||
|
|
extension = os.path.splitext(filename)[1].lower()
|
||
|
|
return self._encoder_extensions.get(extension, [])
|
||
|
|
return self._encoders
|
||
|
|
|
||
|
|
def get_decoders(self, filename=None):
|
||
|
|
"""Get an ordered list of all decoders. If a `filename` is provided,
|
||
|
|
decoders supporting that extension will be ordered first in the list.
|
||
|
|
"""
|
||
|
|
decoders = []
|
||
|
|
if filename:
|
||
|
|
extension = os.path.splitext(filename)[1].lower()
|
||
|
|
decoders += self._decoder_extensions.get(extension, [])
|
||
|
|
decoders += [e for e in self._decoders if e not in decoders]
|
||
|
|
return decoders
|
||
|
|
|
||
|
|
def add_decoders(self, module):
|
||
|
|
"""Add a decoder module. The module must define `get_decoders`. Once
|
||
|
|
added, the appropriate decoders defined in the codec will be returned by
|
||
|
|
Codecs.get_decoders.
|
||
|
|
"""
|
||
|
|
for decoder in module.get_decoders():
|
||
|
|
self._decoders.append(decoder)
|
||
|
|
for extension in decoder.get_file_extensions():
|
||
|
|
if extension not in self._decoder_extensions:
|
||
|
|
self._decoder_extensions[extension] = []
|
||
|
|
self._decoder_extensions[extension].append(decoder)
|
||
|
|
|
||
|
|
def add_encoders(self, module):
|
||
|
|
"""Add an encoder module. The module must define `get_encoders`. Once
|
||
|
|
added, the appropriate encoders defined in the codec will be returned by
|
||
|
|
Codecs.get_encoders.
|
||
|
|
"""
|
||
|
|
for encoder in module.get_encoders():
|
||
|
|
self._encoders.append(encoder)
|
||
|
|
for extension in encoder.get_file_extensions():
|
||
|
|
if extension not in self._encoder_extensions:
|
||
|
|
self._encoder_extensions[extension] = []
|
||
|
|
self._encoder_extensions[extension].append(encoder)
|
||
|
|
|
||
|
|
|
||
|
|
class Decoder:
|
||
|
|
def get_file_extensions(self):
|
||
|
|
"""Return a list or tuple of accepted file extensions, e.g. ['.wav', '.ogg']
|
||
|
|
Lower-case only.
|
||
|
|
"""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|
||
|
|
def decode(self, *args, **kwargs):
|
||
|
|
"""Read and decode the given file object and return an approprite
|
||
|
|
pyglet object. Throws DecodeException if there is an error.
|
||
|
|
`filename` can be a file type hint.
|
||
|
|
"""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|
||
|
|
def __hash__(self):
|
||
|
|
return hash(self.__class__.__name__)
|
||
|
|
|
||
|
|
def __eq__(self, other):
|
||
|
|
return self.__class__.__name__ == other.__class__.__name__
|
||
|
|
|
||
|
|
def __repr__(self):
|
||
|
|
return "{0}{1}".format(self.__class__.__name__, self.get_file_extensions())
|
||
|
|
|
||
|
|
|
||
|
|
class Encoder:
|
||
|
|
def get_file_extensions(self):
|
||
|
|
"""Return a list or tuple of accepted file extensions, e.g. ['.wav', '.ogg']
|
||
|
|
Lower-case only.
|
||
|
|
"""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|
||
|
|
def encode(self, media, file, filename):
|
||
|
|
"""Encode the given media type to the given file. `filename`
|
||
|
|
provides a hint to the file format desired. options are
|
||
|
|
encoder-specific, and unknown options should be ignored or
|
||
|
|
issue warnings.
|
||
|
|
"""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|
||
|
|
def __hash__(self):
|
||
|
|
return hash(self.__class__.__name__)
|
||
|
|
|
||
|
|
def __eq__(self, other):
|
||
|
|
return self.__class__.__name__ == other.__class__.__name__
|
||
|
|
|
||
|
|
def __repr__(self):
|
||
|
|
return "{0}{1}".format(self.__class__.__name__, self.get_file_extensions())
|
||
|
|
|
||
|
|
|
||
|
|
class DecodeException(Exception):
|
||
|
|
exception_priority = 10
|
||
|
|
|
||
|
|
|
||
|
|
class EncodeException(Exception):
|
||
|
|
pass
|