├── .gitignore
├── README.md
├── samples
├── basic.py
└── pygobject.py
├── CHANGELOG.md
├── setup.py
├── .github
└── workflows
│ └── deploy.yml
├── client.pxd
├── LICENSE
└── mpv.pyx
/.gitignore:
--------------------------------------------------------------------------------
1 | build
2 | pympv.egg-info
3 | dist
4 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | pympv
2 | =====
3 | A python wrapper for libmpv.
4 |
5 | #### Basic usage
6 | ```python
7 | import sys
8 | import mpv
9 |
10 | def main(args):
11 | if len(args) != 1:
12 | print('pass a single media file as argument')
13 | return 1
14 |
15 | try:
16 | m = mpv.Context()
17 | except mpv.MPVError:
18 | print('failed creating context')
19 | return 1
20 |
21 | m.set_option('input-default-bindings')
22 | m.set_option('osc')
23 | m.set_option('input-vo-keyboard')
24 | m.initialize()
25 |
26 | m.command('loadfile', args[0])
27 |
28 | while True:
29 | event = m.wait_event(.01)
30 | if event.id == mpv.Events.none:
31 | continue
32 | print(event.name)
33 | if event.id in [mpv.Events.end_file, mpv.Events.shutdown]:
34 | break
35 |
36 |
37 | if __name__ == '__main__':
38 | try:
39 | exit(main(sys.argv[1:]) or 0)
40 | except mpv.MPVError as e:
41 | print(str(e))
42 | exit(1)
43 | ```
44 |
45 | More examples can be found in the [samples](samples) directory.
46 |
47 | libmpv is a client library for the media player mpv
48 |
49 | For more info see: https://github.com/mpv-player/mpv/blob/master/libmpv/client.h
50 |
51 | pympv was originally written by Andre D, and the PyPI package is maintained
52 | by Hector Martin.
53 |
--------------------------------------------------------------------------------
/samples/basic.py:
--------------------------------------------------------------------------------
1 | # This program is free software: you can redistribute it and/or modify
2 | # it under the terms of the GNU General Public License as published by
3 | # the Free Software Foundation, either version 3 of the License, or
4 | # (at your option) any later version.
5 | #
6 | # This program is distributed in the hope that it will be useful,
7 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
8 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 | # GNU General Public License for more details.
10 | #
11 | # You should have received a copy of the GNU General Public License
12 | # along with this program. If not, see .
13 |
14 | import sys
15 |
16 | import mpv
17 |
18 |
19 | def main(args):
20 | if len(args) != 1:
21 | print('pass a single media file as argument')
22 | return 1
23 |
24 | try:
25 | m = mpv.Context()
26 | except mpv.MPVError:
27 | print('failed creating context')
28 | return 1
29 |
30 | m.set_option('input-default-bindings')
31 | m.set_option('osc')
32 | m.set_option('input-vo-keyboard')
33 | m.initialize()
34 |
35 | m.command('loadfile', args[0])
36 |
37 | while True:
38 | event = m.wait_event(.01)
39 | if event.id == mpv.Events.none:
40 | continue
41 | print(event.name)
42 | if event.id in [mpv.Events.end_file, mpv.Events.shutdown]:
43 | break
44 |
45 |
46 | if __name__ == '__main__':
47 | try:
48 | exit(main(sys.argv[1:]) or 0)
49 | except mpv.MPVError as e:
50 | print(str(e))
51 | exit(1)
52 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | pympv
2 | =====
3 |
4 | ## 0.8.0
5 | - Update to libmpv API 2.0, removing previously deprecated APIs
6 | - Optimise string conversion functions with Cython
7 | - Give str its Python 3 meaning
8 | - Simplify string conversions, since python2 is no more
9 |
10 | ## 0.7.1
11 | - Extract examples into its own directory
12 |
13 | ## 0.6.0
14 | - Add support for the render API
15 | - Deprecate the legacy opengl-cb API
16 |
17 | ## 0.5.1
18 | - Rename async -> asynchronous for Python 3.7 compatibility
19 | - Force Cython rebuilds if Cython is installed
20 |
21 | ## 0.4.1
22 |
23 | - Prepare packaging for PyPI
24 |
25 | ## 0.4.0
26 | - Fix string support in Python2
27 | - Add opengl-cb support
28 | - Improve packaging/setup.py
29 |
30 | ## 0.3.0
31 |
32 | - Fix various failures of data and callbacks
33 | - Sync up header with new errors from 1.11
34 | - Add shutdown() to cleanup a context, GCing the context calls this
35 | - Callbacks and data are no longer associated weakly
36 | - Async data and observe property system changed to be hash() based
37 |
38 | ## 0.2.1
39 |
40 | - Fix possible failures setting property to a map
41 | - Fix possible failures with every single string
42 |
43 |
44 | ## 0.2
45 |
46 | - EOFReasons.restart removed to reflect client.h enum
47 | - Bump to require libmpv 1.9
48 | - Switch mpv.command() to use mpv_command_node, non-async will now return comamnd response data.
49 | This should make no difference to users, but now accepts various forms of data instead of just strings.
50 | - Add try_get_property_async and try_get_property
51 | - Add support for EndOfFileReached.error and EOFReasons.error
52 | - Add support for LogMessage.log_level and LogLevels
53 | - Fix Errors values being positive rather than negative (And totally wrong as a result)
54 | - Add a few new Errors values
55 | - Add support for setting properties, options, and commands to lists and maps
56 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | # This program is free software: you can redistribute it and/or modify
4 | # it under the terms of the GNU General Public License as published by
5 | # the Free Software Foundation, either version 3 of the License, or
6 | # (at your option) any later version.
7 | #
8 | # This program is distributed in the hope that it will be useful,
9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | # GNU General Public License for more details.
12 | #
13 | # You should have received a copy of the GNU General Public License
14 | # along with this program. If not, see .
15 |
16 | import os
17 | import sys
18 | from glob import glob
19 | from os.path import join
20 |
21 | from setuptools import Extension, find_packages, setup
22 |
23 | USE_CYTHON = False
24 | extension_src = "mpv.c"
25 |
26 | if os.path.exists("mpv.pyx"):
27 | try:
28 | from Cython.Build import cythonize
29 | USE_CYTHON = True
30 | extension_src = "mpv.pyx"
31 | except ImportError:
32 | pass
33 |
34 | extra_data = {}
35 | extensions = [Extension("mpv", [extension_src], libraries=["mpv"])]
36 |
37 | if set(["setup.py", "--version", "-V"]) >= set(sys.argv):
38 | extensions = []
39 |
40 | if set(["bdist_wheel", "--plat-name", "win_amd64"]) <= set(sys.argv):
41 | extra_data["data_files"] = [
42 | ("Scripts", ["mpv.dll"]),
43 | ("libs", ["mpv.lib"]),
44 | ("include", glob("mpv/*")),
45 | ]
46 | extensions = [
47 | Extension(
48 | "mpv",
49 | [extension_src],
50 | libraries=["mpv"],
51 | library_dirs=[os.curdir],
52 | include_dirs=[join(os.curdir, "mpv")],
53 | )
54 | ]
55 |
56 | if USE_CYTHON:
57 | extensions = cythonize(extensions, force=True)
58 |
59 |
60 | def read(fname):
61 | return open(os.path.join(os.path.dirname(__file__), fname)).read()
62 |
63 |
64 | setup(
65 | name="pympv",
66 | version="0.9.0",
67 | description="Python bindings for the libmpv library",
68 | # This is supposed to be reST. Cheating by using a common subset of
69 | # reST and Markdown...
70 | long_description=read("README.md"),
71 | long_description_content_type="text/markdown",
72 | author="Andre D",
73 | author_email="andre@andred.ca",
74 | maintainer="Hector Martin",
75 | maintainer_email="marcan@marcan.st",
76 | url="https://github.com/marcan/pympv",
77 | classifiers=[
78 | "Development Status :: 3 - Alpha",
79 | "Programming Language :: Cython",
80 | "Topic :: Multimedia :: Sound/Audio :: Players",
81 | "Topic :: Multimedia :: Video",
82 | "Topic :: Software Development :: Libraries",
83 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
84 | ],
85 | ext_modules=extensions,
86 | **extra_data
87 | )
88 |
--------------------------------------------------------------------------------
/.github/workflows/deploy.yml:
--------------------------------------------------------------------------------
1 | name: deploy
2 |
3 | on:
4 | push:
5 | tags:
6 | - 'v*.*.*'
7 | branches:
8 | - 'publish-test'
9 |
10 | jobs:
11 |
12 | create-windows-wheel:
13 |
14 | runs-on: windows-latest
15 |
16 | steps:
17 | - name: Checkout
18 | uses: actions/checkout@v2
19 |
20 | - name: Download libmpv
21 | run: |
22 | $VERSION = "libmpv/mpv-dev-x86_64-20200524-git-685bd6a.7z"
23 | $URL = "https://sourceforge.net/projects/mpv-player-windows/files"
24 | curl -L -o libmpv.7z "$URL/$VERSION"
25 | 7z x libmpv.7z
26 |
27 | - name: Set VS environment variables
28 | run: |
29 | $VsPath = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer"
30 | echo "$VsPath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
31 |
32 | - name: Set MSVC x86_64 linker path
33 | run: |
34 | $LinkGlob = "VC\Tools\MSVC\*\bin\Hostx64\x64"
35 | $LinkPath = vswhere -latest -products * -find "$LinkGlob" |
36 | Select-Object -Last 1
37 | echo "$LinkPath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
38 |
39 | - name: Create the libmpv zip
40 | shell: cmd
41 | run: |
42 | lib /def:mpv.def /machine:x64 /out:mpv.lib
43 | ren mpv-1.dll mpv.dll
44 | ren include mpv
45 | 7z a libmpv.zip mpv/ mpv.dll mpv.lib
46 |
47 | - name: Install Python 3.9 version
48 | uses: actions/setup-python@v1
49 | with:
50 | python-version: '3.9'
51 | architecture: 'x64'
52 |
53 | - name: Install Python dependencies
54 | run: |
55 | python -m pip install --upgrade pip
56 | pip install setuptools wheel
57 | pip install --upgrade cython
58 |
59 | - name: Create Python wheel
60 | run: |
61 | python setup.py bdist_wheel --plat-name win_amd64 --python-tag cp37
62 |
63 | - name: Upload Windows wheel
64 | uses: actions/upload-artifact@v4
65 | with:
66 | name: dist
67 | path: dist
68 |
69 | deploy-binaries:
70 |
71 | permissions:
72 | id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
73 |
74 | needs: create-windows-wheel
75 |
76 | runs-on: ubuntu-latest
77 |
78 | steps:
79 | - name: Checkout
80 | uses: actions/checkout@v2
81 |
82 | - name: Download Windows wheel
83 | uses: actions/download-artifact@v4
84 |
85 | - name: Install Python dependencies
86 | run: |
87 | python -m pip install --upgrade pip
88 | pip install setuptools twine
89 | pip install --upgrade cython
90 | pip install --upgrade packaging
91 |
92 | - name: Release source code
93 | run: |
94 | python setup.py sdist
95 |
96 | - name: Twine check
97 | run: |
98 | python -m twine check dist/*
99 |
100 | - name: Publish distribution to PyPI
101 | if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
102 | uses: pypa/gh-action-pypi-publish@release/v1
103 |
104 | - name: Publish distribution to TestPyPI
105 | if: github.event_name == 'push' && github.ref == 'refs/heads/publish-test'
106 | uses: pypa/gh-action-pypi-publish@release/v1
107 | with:
108 | repository_url: https://test.pypi.org/legacy/
109 |
--------------------------------------------------------------------------------
/samples/pygobject.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | # This program is free software: you can redistribute it and/or modify
4 | # it under the terms of the GNU General Public License as published by
5 | # the Free Software Foundation, either version 3 of the License, or
6 | # (at your option) any later version.
7 | #
8 | # This program is distributed in the hope that it will be useful,
9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | # GNU General Public License for more details.
12 | #
13 | # You should have received a copy of the GNU General Public License
14 | # along with this program. If not, see .
15 |
16 | import ctypes
17 | import sys
18 | from ctypes import CFUNCTYPE, c_char_p, c_void_p
19 |
20 | import gi
21 | import mpv
22 |
23 | gi.require_version('Gtk', '3.0')
24 | from gi.repository import Gtk, Gdk
25 |
26 | from OpenGL import GL, GLX
27 |
28 |
29 | class MainClass(Gtk.Window):
30 |
31 | def __init__(self, media):
32 | super(MainClass, self).__init__()
33 | self.media = media
34 | self.set_default_size(600, 400)
35 | self.connect("destroy", self.on_destroy)
36 |
37 | frame = Gtk.Frame()
38 | self.area = OpenGlArea()
39 | self.area.connect("realize", self.play)
40 | frame.add(self.area)
41 | self.add(frame)
42 | self.show_all()
43 |
44 | def on_destroy(self, widget, data=None):
45 | Gtk.main_quit()
46 |
47 | def play(self, arg1):
48 | self.area.play(self.media)
49 |
50 |
51 | class OpenGlArea(Gtk.GLArea):
52 |
53 | def __init__(self, **properties):
54 | super().__init__(**properties)
55 |
56 | self.gl_context: mpv.OpenGLRenderContext = None
57 |
58 | try:
59 | self.mpv = mpv.Context()
60 | self.mpv.initialize()
61 | except mpv.MPVError:
62 | raise RuntimeError('failed creating context')
63 |
64 | # self.mpv.set_property("gpu-context", "wayland")
65 | self.mpv.set_property("terminal", True)
66 |
67 | self.connect("realize", self.on_realize)
68 | self.connect("render", self.on_render)
69 | self.connect("unrealize", self.on_unrealize)
70 |
71 | # noinspection PyUnusedLocal
72 | def on_realize(self, area: Gtk.GLArea):
73 | self.make_current()
74 | self.gl_context = mpv.OpenGLRenderContext(self.mpv, get_process_address)
75 | self.gl_context.set_update_callback(self.queue_render)
76 |
77 | def on_unrealize(self, arg):
78 | if self.gl_context:
79 | self.gl_context.close()
80 | self.mpv.shutdown()
81 |
82 | def on_render(self, arg1, arg2):
83 | factor = self.get_scale_factor()
84 | rect: Gdk.Rectangle = self.get_allocated_size()[0]
85 |
86 | if self.gl_context:
87 | fbo = {
88 | "fbo": GL.glGetIntegerv(GL.GL_DRAW_FRAMEBUFFER_BINDING),
89 | "w": rect.width * factor,
90 | "h": rect.height * factor,
91 | }
92 | self.gl_context.render(opengl_fbo=fbo, flip_y=True)
93 |
94 | return True
95 |
96 | def play(self, media):
97 | self.mpv.command('loadfile', media)
98 |
99 |
100 | @CFUNCTYPE(c_void_p, c_char_p)
101 | def get_process_address(name):
102 | address = GLX.glXGetProcAddress(name.decode("utf-8"))
103 | return ctypes.cast(address, ctypes.c_void_p).value
104 |
105 |
106 | if __name__ == '__main__':
107 | args = sys.argv[1:]
108 |
109 | if len(args) == 1:
110 | import locale
111 |
112 | locale.setlocale(locale.LC_NUMERIC, 'C')
113 |
114 | application = MainClass(args[0])
115 | Gtk.main()
116 | else:
117 | print('pass a single media file as argument and try again')
118 |
--------------------------------------------------------------------------------
/client.pxd:
--------------------------------------------------------------------------------
1 | # This program is free software: you can redistribute it and/or modify
2 | # it under the terms of the GNU General Public License as published by
3 | # the Free Software Foundation, either version 3 of the License, or
4 | # (at your option) any later version.
5 | #
6 | # This program is distributed in the hope that it will be useful,
7 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
8 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 | # GNU General Public License for more details.
10 | #
11 | # You should have received a copy of the GNU General Public License
12 | # along with this program. If not, see .
13 |
14 | cdef extern from "mpv/client.h":
15 |
16 | ctypedef signed char int8_t
17 |
18 | ctypedef short int16_t
19 |
20 | ctypedef int int32_t
21 |
22 | ctypedef long int64_t
23 |
24 | ctypedef unsigned char uint8_t
25 |
26 | ctypedef unsigned short uint16_t
27 |
28 | ctypedef unsigned int uint32_t
29 |
30 | ctypedef unsigned long uint64_t
31 |
32 | ctypedef signed char int_least8_t
33 |
34 | ctypedef short int_least16_t
35 |
36 | ctypedef int int_least32_t
37 |
38 | ctypedef long int_least64_t
39 |
40 | ctypedef unsigned char uint_least8_t
41 |
42 | ctypedef unsigned short uint_least16_t
43 |
44 | ctypedef unsigned int uint_least32_t
45 |
46 | ctypedef unsigned long uint_least64_t
47 |
48 | ctypedef signed char int_fast8_t
49 |
50 | ctypedef long int_fast16_t
51 |
52 | ctypedef long int_fast32_t
53 |
54 | ctypedef long int_fast64_t
55 |
56 | ctypedef unsigned char uint_fast8_t
57 |
58 | ctypedef unsigned long uint_fast16_t
59 |
60 | ctypedef unsigned long uint_fast32_t
61 |
62 | ctypedef unsigned long uint_fast64_t
63 |
64 | ctypedef long intptr_t
65 |
66 | ctypedef unsigned long uintptr_t
67 |
68 | ctypedef long intmax_t
69 |
70 | ctypedef unsigned long uintmax_t
71 |
72 | unsigned long mpv_client_api_version() nogil
73 |
74 | cdef struct mpv_handle:
75 | pass
76 |
77 | cdef enum mpv_error:
78 | MPV_ERROR_SUCCESS
79 | MPV_ERROR_EVENT_QUEUE_FULL
80 | MPV_ERROR_NOMEM
81 | MPV_ERROR_UNINITIALIZED
82 | MPV_ERROR_INVALID_PARAMETER
83 | MPV_ERROR_OPTION_NOT_FOUND
84 | MPV_ERROR_OPTION_FORMAT
85 | MPV_ERROR_OPTION_ERROR
86 | MPV_ERROR_PROPERTY_NOT_FOUND
87 | MPV_ERROR_PROPERTY_FORMAT
88 | MPV_ERROR_PROPERTY_UNAVAILABLE
89 | MPV_ERROR_PROPERTY_ERROR
90 | MPV_ERROR_COMMAND
91 | MPV_ERROR_LOADING_FAILED
92 | MPV_ERROR_AO_INIT_FAILED
93 | MPV_ERROR_VO_INIT_FAILED
94 | MPV_ERROR_NOTHING_TO_PLAY
95 | MPV_ERROR_UNKNOWN_FORMAT
96 | MPV_ERROR_UNSUPPORTED
97 | MPV_ERROR_NOT_IMPLEMENTED
98 |
99 | const char *mpv_error_string(int error) nogil
100 |
101 | void mpv_free(void *data) nogil
102 |
103 | const char *mpv_client_name(mpv_handle *ctx) nogil
104 |
105 | mpv_handle *mpv_create() nogil
106 |
107 | int mpv_initialize(mpv_handle *ctx) nogil
108 |
109 | void mpv_terminate_destroy(mpv_handle *ctx) nogil
110 |
111 | int mpv_load_config_file(mpv_handle *ctx, const char *filename) nogil
112 |
113 | int64_t mpv_get_time_us(mpv_handle *ctx) nogil
114 |
115 | cdef enum mpv_format:
116 | MPV_FORMAT_NONE
117 | MPV_FORMAT_STRING
118 | MPV_FORMAT_OSD_STRING
119 | MPV_FORMAT_FLAG
120 | MPV_FORMAT_INT64
121 | MPV_FORMAT_DOUBLE
122 | MPV_FORMAT_NODE
123 | MPV_FORMAT_NODE_ARRAY
124 | MPV_FORMAT_NODE_MAP
125 |
126 | cdef struct ____mpv_node_u_mpv_node_list:
127 | pass
128 |
129 | ctypedef ____mpv_node_u_mpv_node_list ____mpv_node_u_mpv_node_list_t
130 |
131 | cdef union __mpv_node_u:
132 | char *string
133 | int flag
134 | int64_t int64
135 | double double_
136 | mpv_node_list *list
137 |
138 | ctypedef __mpv_node_u __mpv_node_u_t
139 |
140 | cdef struct mpv_node:
141 | __mpv_node_u_t u
142 | mpv_format format
143 |
144 | cdef struct mpv_node_list:
145 | int num
146 | mpv_node *values
147 | char **keys
148 |
149 | cdef struct mpv_byte_array:
150 | void *data
151 | size_t size
152 |
153 | void mpv_free_node_contents(mpv_node *node) nogil
154 |
155 | int mpv_set_option(mpv_handle *ctx, const char *name, mpv_format format, void *data) nogil
156 |
157 | int mpv_set_option_string(mpv_handle *ctx, const char *name, const char *data) nogil
158 |
159 | int mpv_command(mpv_handle *ctx, const char **args) nogil
160 |
161 | int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result) nogil
162 |
163 | int mpv_command_string(mpv_handle *ctx, const char *args) nogil
164 |
165 | int mpv_command_async(mpv_handle *ctx, uint64_t reply_userdata, const char **args) nogil
166 |
167 | int mpv_command_node_async(mpv_handle *ctx, uint64_t reply_userdata, mpv_node *args) nogil
168 |
169 | int mpv_set_property(mpv_handle *ctx, const char *name, mpv_format format, void *data) nogil
170 |
171 | int mpv_set_property_string(mpv_handle *ctx, const char *name, const char *data) nogil
172 |
173 | int mpv_set_property_async(mpv_handle *ctx, uint64_t reply_userdata, const char *name, mpv_format format, void *data) nogil
174 |
175 | int mpv_get_property(mpv_handle *ctx, const char *name, mpv_format format, void *data) nogil
176 |
177 | char *mpv_get_property_string(mpv_handle *ctx, const char *name) nogil
178 |
179 | char *mpv_get_property_osd_string(mpv_handle *ctx, const char *name) nogil
180 |
181 | int mpv_get_property_async(mpv_handle *ctx, uint64_t reply_userdata, const char *name, mpv_format format) nogil
182 |
183 | int mpv_observe_property(mpv_handle *mpv, uint64_t reply_userdata, const char *name, mpv_format format) nogil
184 |
185 | int mpv_unobserve_property(mpv_handle *mpv, uint64_t registered_reply_userdata) nogil
186 |
187 | enum mpv_event_id:
188 | MPV_EVENT_NONE
189 | MPV_EVENT_SHUTDOWN
190 | MPV_EVENT_LOG_MESSAGE
191 | MPV_EVENT_GET_PROPERTY_REPLY
192 | MPV_EVENT_SET_PROPERTY_REPLY
193 | MPV_EVENT_COMMAND_REPLY
194 | MPV_EVENT_START_FILE
195 | MPV_EVENT_END_FILE
196 | MPV_EVENT_FILE_LOADED
197 | MPV_EVENT_IDLE
198 | MPV_EVENT_TICK
199 | MPV_EVENT_CLIENT_MESSAGE
200 | MPV_EVENT_VIDEO_RECONFIG
201 | MPV_EVENT_AUDIO_RECONFIG
202 | MPV_EVENT_SEEK
203 | MPV_EVENT_PLAYBACK_RESTART
204 | MPV_EVENT_PROPERTY_CHANGE
205 |
206 | const char *mpv_event_name(mpv_event_id event) nogil
207 |
208 | cdef struct mpv_event_property:
209 | const char *name
210 | mpv_format format
211 | void *data
212 |
213 | enum mpv_log_level:
214 | MPV_LOG_LEVEL_NONE
215 | MPV_LOG_LEVEL_FATAL
216 | MPV_LOG_LEVEL_ERROR
217 | MPV_LOG_LEVEL_WARN
218 | MPV_LOG_LEVEL_INFO
219 | MPV_LOG_LEVEL_V
220 | MPV_LOG_LEVEL_DEBUG
221 | MPV_LOG_LEVEL_TRACE
222 |
223 | cdef struct mpv_event_log_message:
224 | const char *prefix
225 | const char *level
226 | const char *text
227 | int log_level
228 |
229 | enum mpv_end_file_reason:
230 | MPV_END_FILE_REASON_EOF
231 | MPV_END_FILE_REASON_STOP
232 | MPV_END_FILE_REASON_QUIT
233 | MPV_END_FILE_REASON_ERROR
234 |
235 | cdef struct mpv_event_end_file:
236 | int reason
237 | int error
238 |
239 | cdef struct mpv_event_script_input_dispatch:
240 | int arg0
241 | const char *type
242 |
243 | cdef struct mpv_event_client_message:
244 | int num_args
245 | const char **args
246 |
247 | cdef struct mpv_event:
248 | mpv_event_id event_id
249 | int error
250 | uint64_t reply_userdata
251 | void *data
252 |
253 | int mpv_request_event(mpv_handle *ctx, mpv_event_id event, int enable) nogil
254 |
255 | int mpv_request_log_messages(mpv_handle *ctx, const char *min_level) nogil
256 |
257 | mpv_event *mpv_wait_event(mpv_handle *ctx, double timeout) nogil
258 |
259 | void mpv_wakeup(mpv_handle *ctx) nogil
260 |
261 | void mpv_set_wakeup_callback(mpv_handle *ctx, void (*cb)(void *), void *d) nogil
262 |
263 | int mpv_get_wakeup_pipe(mpv_handle *ctx) nogil
264 |
265 | void mpv_wait_async_requests(mpv_handle *ctx) nogil
266 |
267 | enum mpv_sub_api:
268 | MPV_SUB_API_OPENGL_CB
269 |
270 | void *mpv_get_sub_api(mpv_handle *ctx, mpv_sub_api sub_api) nogil
271 |
272 | cdef extern from "mpv/render.h":
273 | struct mpv_render_context:
274 | pass
275 |
276 | enum mpv_render_param_type:
277 | MPV_RENDER_PARAM_INVALID
278 | MPV_RENDER_PARAM_API_TYPE
279 | MPV_RENDER_PARAM_OPENGL_INIT_PARAMS
280 | MPV_RENDER_PARAM_OPENGL_FBO
281 | MPV_RENDER_PARAM_FLIP_Y
282 | MPV_RENDER_PARAM_DEPTH
283 | MPV_RENDER_PARAM_ICC_PROFILE
284 | MPV_RENDER_PARAM_AMBIENT_LIGHT
285 | MPV_RENDER_PARAM_X11_DISPLAY
286 | MPV_RENDER_PARAM_WL_DISPLAY
287 | MPV_RENDER_PARAM_ADVANCED_CONTROL
288 | MPV_RENDER_PARAM_NEXT_FRAME_INFO
289 | MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME
290 | MPV_RENDER_PARAM_SKIP_RENDERING
291 | MPV_RENDER_PARAM_DRM_DISPLAY
292 | MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE
293 | MPV_RENDER_PARAM_DRM_DISPLAY_V2
294 | MPV_RENDER_PARAM_SW_SIZE
295 | MPV_RENDER_PARAM_SW_FORMAT
296 | MPV_RENDER_PARAM_SW_STRIDE
297 | MPV_RENDER_PARAM_SW_POINTER
298 |
299 | char *MPV_RENDER_API_TYPE_OPENGL
300 | char *MPV_RENDER_API_TYPE_SW
301 |
302 | enum mpv_render_frame_info_flag:
303 | MPV_RENDER_FRAME_INFO_PRESENT
304 | MPV_RENDER_FRAME_INFO_REDRAW
305 | MPV_RENDER_FRAME_INFO_REPEAT
306 | MPV_RENDER_FRAME_INFO_BLOCK_VSYNC
307 |
308 | struct mpv_render_param:
309 | mpv_render_param_type type
310 | void *data
311 |
312 | struct mpv_render_frame_info:
313 | uint64_t flags
314 | int64_t target_time
315 |
316 | int mpv_render_context_create(mpv_render_context **res, mpv_handle *mpv,
317 | mpv_render_param *params) nogil
318 |
319 | int mpv_render_context_set_parameter(mpv_render_context *ctx,
320 | mpv_render_param param) nogil
321 |
322 | int mpv_render_context_get_info(mpv_render_context *ctx,
323 | mpv_render_param param) nogil
324 |
325 | ctypedef void (*mpv_render_update_fn)(void *cb_ctx) nogil
326 |
327 | void mpv_render_context_set_update_callback(mpv_render_context *ctx,
328 | mpv_render_update_fn callback,
329 | void *callback_ctx) nogil
330 |
331 | uint64_t mpv_render_context_update(mpv_render_context *ctx) nogil
332 |
333 | enum mpv_render_update_flag:
334 | MPV_RENDER_UPDATE_FRAME
335 |
336 | int mpv_render_context_render(mpv_render_context *ctx, mpv_render_param *params) nogil
337 |
338 | void mpv_render_context_report_swap(mpv_render_context *ctx) nogil
339 |
340 | void mpv_render_context_free(mpv_render_context *ctx) nogil
341 |
342 | cdef extern from "mpv/render_gl.h":
343 | struct mpv_opengl_init_params:
344 | void *(*get_proc_address)(void *ctx, const char *name)
345 | void *get_proc_address_ctx
346 |
347 | struct mpv_opengl_fbo:
348 | int fbo
349 | int w
350 | int h
351 | int internal_format
352 |
353 | struct _drmModeAtomicReq:
354 | pass
355 |
356 | struct mpv_opengl_drm_params:
357 | int fd
358 | int crtc_id
359 | int connector_id
360 | _drmModeAtomicReq **atomic_request_ptr
361 | int render_fd
362 |
363 | struct mpv_opengl_drm_draw_surface_size:
364 | int width
365 | int height
366 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
--------------------------------------------------------------------------------
/mpv.pyx:
--------------------------------------------------------------------------------
1 | # cython: language_level=3
2 |
3 | # This program is free software: you can redistribute it and/or modify
4 | # it under the terms of the GNU General Public License as published by
5 | # the Free Software Foundation, either version 3 of the License, or
6 | # (at your option) any later version.
7 | #
8 | # This program is distributed in the hope that it will be useful,
9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | # GNU General Public License for more details.
12 | #
13 | # You should have received a copy of the GNU General Public License
14 | # along with this program. If not, see .
15 |
16 | """pympv - Python wrapper for libmpv
17 |
18 | libmpv is a client library for the media player mpv
19 |
20 | For more info see: https://github.com/mpv-player/mpv/blob/master/libmpv/client.h
21 | """
22 |
23 | import cython
24 | import sys, warnings
25 | from threading import Thread, Semaphore
26 | from libc.stdlib cimport malloc, free
27 | from libc.string cimport strcpy, strlen, memset
28 | from cpython.pycapsule cimport PyCapsule_IsValid, PyCapsule_GetPointer
29 |
30 | from client cimport *
31 |
32 | __version__ = "0.3.0"
33 | __author__ = "Andre D"
34 |
35 | _REQUIRED_CAPI_MAJOR = 2
36 | _MIN_CAPI_MINOR = 0
37 |
38 | cdef unsigned long _CAPI_VERSION
39 | with nogil:
40 | _CAPI_VERSION = mpv_client_api_version()
41 |
42 | _CAPI_MAJOR = _CAPI_VERSION >> 16
43 | _CAPI_MINOR = _CAPI_VERSION & 0xFFFF
44 |
45 | if _CAPI_MAJOR != _REQUIRED_CAPI_MAJOR or _CAPI_MINOR < _MIN_CAPI_MINOR:
46 | raise ImportError(
47 | "libmpv version is incorrect. Required %d.%d got %d.%d." %
48 | (_REQUIRED_CAPI_MAJOR, _MIN_CAPI_MINOR, _CAPI_MAJOR, _CAPI_MINOR)
49 | )
50 |
51 | # mpv -> Python
52 | cdef str _strdec(bytes s):
53 | return s.decode("utf-8", "surrogateescape")
54 |
55 | # Python -> mpv
56 | cdef bytes _strenc(str s):
57 | return s.encode("utf-8", "surrogateescape")
58 |
59 | # TODO: Remove this call once Python 3.6 is EOL: it is automatically called by
60 | # Py_Initialize() since Python 3.7 and will be removed in Python 3.11.
61 | cdef extern from "Python.h":
62 | void PyEval_InitThreads()
63 | PyEval_InitThreads()
64 |
65 | class Errors:
66 | """Set of known error codes from MpvError and Event responses.
67 |
68 | Mostly wraps the enum mpv_error.
69 | Values might not always be integers in the future.
70 | You should handle the possibility that error codes may not be any of these values.
71 | """
72 | success = MPV_ERROR_SUCCESS
73 | queue_full = MPV_ERROR_EVENT_QUEUE_FULL
74 | nomem = MPV_ERROR_NOMEM
75 | uninitialized = MPV_ERROR_UNINITIALIZED
76 | invalid_parameter = MPV_ERROR_INVALID_PARAMETER
77 | not_found = MPV_ERROR_OPTION_NOT_FOUND
78 | option_format = MPV_ERROR_OPTION_FORMAT
79 | option_error = MPV_ERROR_OPTION_ERROR
80 | not_found = MPV_ERROR_PROPERTY_NOT_FOUND
81 | property_format = MPV_ERROR_PROPERTY_FORMAT
82 | property_unavailable = MPV_ERROR_PROPERTY_UNAVAILABLE
83 | property_error = MPV_ERROR_PROPERTY_ERROR
84 | command_error = MPV_ERROR_COMMAND
85 | loading_failed = MPV_ERROR_LOADING_FAILED
86 | ao_init_failed = MPV_ERROR_AO_INIT_FAILED
87 | vo_init_failed = MPV_ERROR_VO_INIT_FAILED
88 | nothing_to_play = MPV_ERROR_NOTHING_TO_PLAY
89 | unknown_format = MPV_ERROR_UNKNOWN_FORMAT
90 | unsupported = MPV_ERROR_UNSUPPORTED
91 | not_implemented = MPV_ERROR_NOT_IMPLEMENTED
92 |
93 |
94 | class Events:
95 | """Set of known values for Event ids.
96 |
97 | Mostly wraps the enum mpv_event_id.
98 | Values might not always be integers in the future.
99 | You should handle the possibility that event ids may not be any of these values.
100 | """
101 | none = MPV_EVENT_NONE
102 | shutdown = MPV_EVENT_SHUTDOWN
103 | log_message = MPV_EVENT_LOG_MESSAGE
104 | get_property_reply = MPV_EVENT_GET_PROPERTY_REPLY
105 | set_property_reply = MPV_EVENT_SET_PROPERTY_REPLY
106 | command_reply = MPV_EVENT_COMMAND_REPLY
107 | start_file = MPV_EVENT_START_FILE
108 | end_file = MPV_EVENT_END_FILE
109 | file_loaded = MPV_EVENT_FILE_LOADED
110 | idle = MPV_EVENT_IDLE
111 | tick = MPV_EVENT_TICK
112 | client_message = MPV_EVENT_CLIENT_MESSAGE
113 | video_reconfig = MPV_EVENT_VIDEO_RECONFIG
114 | audio_reconfig = MPV_EVENT_AUDIO_RECONFIG
115 | seek = MPV_EVENT_SEEK
116 | playback_restart = MPV_EVENT_PLAYBACK_RESTART
117 | property_change = MPV_EVENT_PROPERTY_CHANGE
118 |
119 |
120 | class LogLevels:
121 | no = MPV_LOG_LEVEL_NONE
122 | fatal = MPV_LOG_LEVEL_FATAL
123 | error = MPV_LOG_LEVEL_ERROR
124 | warn = MPV_LOG_LEVEL_WARN
125 | info = MPV_LOG_LEVEL_INFO
126 | v = MPV_LOG_LEVEL_V
127 | debug = MPV_LOG_LEVEL_DEBUG
128 | trace = MPV_LOG_LEVEL_TRACE
129 |
130 |
131 | class EOFReasons:
132 | """Known possible values for EndOfFileReached reason.
133 |
134 | You should handle the possibility that the reason may not be any of these values.
135 | """
136 | eof = MPV_END_FILE_REASON_EOF
137 | aborted = MPV_END_FILE_REASON_STOP
138 | quit = MPV_END_FILE_REASON_QUIT
139 | error = MPV_END_FILE_REASON_ERROR
140 |
141 |
142 | cdef class EndOfFileReached(object):
143 | """Data field for MPV_EVENT_END_FILE events
144 |
145 | Wraps: mpv_event_end_file
146 | """
147 | cdef public object reason, error
148 |
149 | cdef _init(self, mpv_event_end_file* eof):
150 | self.reason = eof.reason
151 | self.error = eof.error
152 | return self
153 |
154 |
155 | cdef class LogMessage(object):
156 | """Data field for MPV_EVENT_LOG_MESSAGE events.
157 |
158 | Wraps: mpv_event_log_message
159 | """
160 | cdef public object prefix, level, text, log_level
161 |
162 | cdef _init(self, mpv_event_log_message* msg):
163 | self.level = _strdec(msg.level)
164 | self.prefix = _strdec(msg.prefix)
165 | self.text = _strdec(msg.text)
166 | self.log_level = msg.log_level
167 | return self
168 |
169 |
170 | cdef _convert_node_value(mpv_node node):
171 | if node.format == MPV_FORMAT_STRING:
172 | return _strdec(node.u.string)
173 | elif node.format == MPV_FORMAT_FLAG:
174 | return not not int(node.u.flag)
175 | elif node.format == MPV_FORMAT_INT64:
176 | return int(node.u.int64)
177 | elif node.format == MPV_FORMAT_DOUBLE:
178 | return float(node.u.double_)
179 | elif node.format == MPV_FORMAT_NODE_MAP:
180 | return _convert_value(node.u.list, node.format)
181 | elif node.format == MPV_FORMAT_NODE_ARRAY:
182 | return _convert_value(node.u.list, node.format)
183 | return None
184 |
185 |
186 | cdef _convert_value(void* data, mpv_format format):
187 | cdef mpv_node node
188 | cdef mpv_node_list nodelist
189 | if format == MPV_FORMAT_NODE:
190 | node = (data)[0]
191 | return _convert_node_value(node)
192 | elif format == MPV_FORMAT_NODE_ARRAY:
193 | nodelist = (data)[0]
194 | values = []
195 | for i in range(nodelist.num):
196 | values.append(_convert_node_value(nodelist.values[i]))
197 | return values
198 | elif format == MPV_FORMAT_NODE_MAP:
199 | nodelist = (data)[0]
200 | values = {}
201 | for i in range(nodelist.num):
202 | value = _convert_node_value(nodelist.values[i])
203 | values[_strdec(nodelist.keys[i])] = value
204 | return values
205 | elif format == MPV_FORMAT_STRING:
206 | return _strdec(((data)[0]))
207 | elif format == MPV_FORMAT_FLAG:
208 | return not not (data)[0]
209 | elif format == MPV_FORMAT_INT64:
210 | return int((data)[0])
211 | elif format == MPV_FORMAT_DOUBLE:
212 | return float((data)[0])
213 | return None
214 |
215 |
216 | cdef class Property(object):
217 | """Data field for MPV_EVENT_PROPERTY_CHANGE and MPV_EVENT_GET_PROPERTY_REPLY.
218 |
219 | Wraps: mpv_event_property
220 | """
221 | cdef public object name, data
222 |
223 | cdef _init(self, mpv_event_property* prop):
224 | self.name = _strdec(prop.name)
225 | self.data = _convert_value(prop.data, prop.format)
226 | return self
227 |
228 |
229 | cdef class Event(object):
230 | """Wraps: mpv_event"""
231 | cdef public mpv_event_id id
232 | cdef public int error
233 | cdef public object data, reply_userdata
234 |
235 | @property
236 | def error_str(self):
237 | """mpv_error_string of the error proeprty"""
238 | cdef const char* err_c
239 | with nogil:
240 | err_c = mpv_error_string(self.error)
241 | return _strdec(err_c)
242 |
243 | cdef _data(self, mpv_event* event):
244 | cdef void* data = event.data
245 | cdef mpv_event_client_message* climsg
246 | if self.id == MPV_EVENT_GET_PROPERTY_REPLY:
247 | return Property()._init(data)
248 | elif self.id == MPV_EVENT_PROPERTY_CHANGE:
249 | return Property()._init(data)
250 | elif self.id == MPV_EVENT_LOG_MESSAGE:
251 | return LogMessage()._init(data)
252 | elif self.id == MPV_EVENT_CLIENT_MESSAGE:
253 | climsg = data
254 | args = []
255 | num_args = climsg.num_args
256 | for i in range(num_args):
257 | arg = climsg.args[i]
258 | arg = _strdec(arg)
259 | args.append(arg)
260 | return args
261 | elif self.id == MPV_EVENT_END_FILE:
262 | return EndOfFileReached()._init(data)
263 | return None
264 |
265 | @property
266 | def name(self):
267 | """mpv_event_name of the event id"""
268 | cdef const char* name_c
269 | with nogil:
270 | name_c = mpv_event_name(self.id)
271 | return _strdec(name_c)
272 |
273 | cdef _init(self, mpv_event* event, ctx):
274 | ctxid = id(ctx)
275 | self.id = event.event_id
276 | self.data = self._data(event)
277 | userdata = _reply_userdatas[ctxid].get(event.reply_userdata, None)
278 | if userdata is not None and self.id != MPV_EVENT_PROPERTY_CHANGE:
279 | userdata.remove()
280 | if not userdata.observed and userdata.counter <= 0:
281 | del _reply_userdatas[ctxid][event.reply_userdata]
282 | if userdata is not None:
283 | userdata = userdata.data
284 | self.reply_userdata = userdata
285 | self.error = event.error
286 | return self
287 |
288 |
289 | def _errors(fn):
290 | def wrapped(*k, **kw):
291 | v = fn(*k, **kw)
292 | if v < 0:
293 | raise MPVError(v)
294 | return wrapped
295 |
296 |
297 | class MPVError(Exception):
298 | code = None
299 |
300 | def __init__(self, e):
301 | self.code = e
302 | cdef const char* err_c
303 | cdef int e_i
304 | if not isinstance(e, basestring):
305 | e_i = e
306 | with nogil:
307 | err_c = mpv_error_string(e_i)
308 | e = _strdec(err_c)
309 | Exception.__init__(self, e)
310 |
311 | class PyMPVError(Exception):
312 | pass
313 |
314 | cdef dict _callbacks = {}
315 | cdef dict _reply_userdatas = {}
316 |
317 | class _ReplyUserData(object):
318 | def __init__(self, data):
319 | self.counter = 0
320 | self.data = data
321 | self.observed = False
322 |
323 | def add(self):
324 | self.counter += 1
325 |
326 | def remove(self):
327 | self.counter -= 1
328 |
329 |
330 | cdef class Context(object):
331 | """Base class wrapping a context to interact with mpv.
332 |
333 | Assume all calls can raise MPVError.
334 |
335 | Wraps: mpv_create, mpv_destroy and all mpv_handle related calls
336 | """
337 | cdef mpv_handle *_ctx
338 | cdef object callback, callbackthread, reply_userdata
339 |
340 | @property
341 | def name(self):
342 | """Unique name for every context created.
343 |
344 | Wraps: mpv_client_name
345 | """
346 | cdef const char* name
347 | assert self._ctx
348 | with nogil:
349 | name = mpv_client_name(self._ctx)
350 | return _strdec(name)
351 |
352 | @property
353 | def time(self):
354 | """Internal mpv client time.
355 |
356 | Has an arbitrary start offset, but will never wrap or go backwards.
357 |
358 | Wraps: mpv_get_time_us
359 | """
360 | cdef int64_t time
361 | assert self._ctx
362 | with nogil:
363 | time = mpv_get_time_us(self._ctx)
364 | return time
365 |
366 | @_errors
367 | def request_event(self, event, enable):
368 | """Enable or disable a given event.
369 |
370 | Arguments:
371 | event - See Events
372 | enable - True to enable, False to disable
373 |
374 | Wraps: mpv_request_event
375 | """
376 | assert self._ctx
377 | cdef int enable_i = 1 if enable else 0
378 | cdef int err
379 | cdef mpv_event_id event_id = event
380 | with nogil:
381 | err = mpv_request_event(self._ctx, event_id, enable_i)
382 | return err
383 |
384 | @_errors
385 | def set_log_level(self, loglevel):
386 | """Wraps: mpv_request_log_messages"""
387 | assert self._ctx
388 | loglevel = _strenc(loglevel)
389 | cdef const char* loglevel_c = loglevel
390 | cdef int err
391 | with nogil:
392 | err = mpv_request_log_messages(self._ctx, loglevel_c)
393 | return err
394 |
395 | @_errors
396 | def load_config(self, filename):
397 | """Wraps: mpv_load_config_file"""
398 | assert self._ctx
399 | filename = _strenc(filename)
400 | cdef const char* _filename = filename
401 | cdef int err
402 | with nogil:
403 | err = mpv_load_config_file(self._ctx, _filename)
404 | return err
405 |
406 | def _format_for(self, value):
407 | if isinstance(value, basestring):
408 | return MPV_FORMAT_STRING
409 | elif isinstance(value, bool):
410 | return MPV_FORMAT_FLAG
411 | elif isinstance(value, int):
412 | return MPV_FORMAT_INT64
413 | elif isinstance(value, float):
414 | return MPV_FORMAT_DOUBLE
415 | elif isinstance(value, (tuple, list)):
416 | return MPV_FORMAT_NODE_ARRAY
417 | elif isinstance(value, dict):
418 | return MPV_FORMAT_NODE_MAP
419 | return MPV_FORMAT_NONE
420 |
421 | cdef mpv_node_list* _prep_node_list(self, values):
422 | cdef mpv_node node
423 | cdef mpv_format format
424 | cdef mpv_node_list* node_list = malloc(sizeof(mpv_node_list))
425 | node_list.num = len(values)
426 | node_list.values = NULL
427 | node_list.keys = NULL
428 | if node_list.num:
429 | node_list.values = malloc(node_list.num * sizeof(mpv_node))
430 | for i, value in enumerate(values):
431 | format = self._format_for(value)
432 | node = self._prep_native_value(value, format)
433 | node_list.values[i] = node
434 | return node_list
435 |
436 | cdef mpv_node_list* _prep_node_map(self, map):
437 | cdef char* ckey
438 | cdef mpv_node_list* list
439 | list = self._prep_node_list(map.values())
440 | keys = map.keys()
441 | if not len(keys):
442 | return list
443 | list.keys = malloc(list.num)
444 | for i, key in enumerate(keys):
445 | key = _strenc(key)
446 | ckey = key
447 | list.keys[i] = malloc(len(key) + 1)
448 | strcpy(list.keys[i], ckey)
449 | return list
450 |
451 | cdef mpv_node _prep_native_value(self, value, format):
452 | cdef mpv_node node
453 | node.format = format
454 | if format == MPV_FORMAT_STRING:
455 | value = _strenc(value)
456 | node.u.string = malloc(len(value) + 1)
457 | strcpy(node.u.string, value)
458 | elif format == MPV_FORMAT_FLAG:
459 | node.u.flag = 1 if value else 0
460 | elif format == MPV_FORMAT_INT64:
461 | node.u.int64 = value
462 | elif format == MPV_FORMAT_DOUBLE:
463 | node.u.double_ = value
464 | elif format == MPV_FORMAT_NODE_ARRAY:
465 | node.u.list = self._prep_node_list(value)
466 | elif format == MPV_FORMAT_NODE_MAP:
467 | node.u.list = self._prep_node_map(value)
468 | else:
469 | node.format = MPV_FORMAT_NONE
470 | return node
471 |
472 | cdef _free_native_value(self, mpv_node node):
473 | if node.format in (MPV_FORMAT_NODE_ARRAY, MPV_FORMAT_NODE_MAP):
474 | for i in range(node.u.list.num):
475 | self._free_native_value(node.u.list.values[i])
476 | free(node.u.list.values)
477 | if node.format == MPV_FORMAT_NODE_MAP:
478 | for i in range(node.u.list.num):
479 | free(node.u.list.keys[i])
480 | free(node.u.list.keys)
481 | free(node.u.list)
482 | elif node.format == MPV_FORMAT_STRING:
483 | free(node.u.string)
484 |
485 | def command(self, *cmdlist, asynchronous=False, data=None):
486 | """Send a command to mpv.
487 |
488 | Non-async success returns the command's response data, otherwise None
489 |
490 | Arguments:
491 | Accepts parameters as args
492 |
493 | Keyword Arguments:
494 | asynchronous: True will return right away, status comes in as MPV_EVENT_COMMAND_REPLY
495 | data: Only valid if async, gets sent back as reply_userdata in the Event
496 |
497 | Wraps: mpv_command_node and mpv_command_node_async
498 | """
499 | assert self._ctx
500 | cdef mpv_node node = self._prep_native_value(cmdlist, self._format_for(cmdlist))
501 | cdef mpv_node noderesult
502 | cdef int err
503 | cdef uint64_t data_id
504 | result = None
505 | try:
506 | data_id = id(data)
507 | if not asynchronous:
508 | with nogil:
509 | err = mpv_command_node(self._ctx, &node, &noderesult)
510 | try:
511 | result = _convert_node_value(noderesult) if err >= 0 else None
512 | finally:
513 | with nogil:
514 | mpv_free_node_contents(&noderesult)
515 | else:
516 | userdatas = self.reply_userdata.get(data_id, None)
517 | if userdatas is None:
518 | _reply_userdatas[data_id] = userdatas = _ReplyUserData(data)
519 | userdatas.add()
520 | with nogil:
521 | err = mpv_command_node_async(self._ctx, data_id, &node)
522 | finally:
523 | self._free_native_value(node)
524 | if err < 0:
525 | raise MPVError(err)
526 | return result
527 |
528 | @_errors
529 | def get_property_async(self, prop, data=None):
530 | """Gets the value of a property asynchronously.
531 |
532 | Arguments:
533 | prop: Property to get the value of.
534 |
535 | Keyword arguments:
536 | data: Value to be passed into the reply_userdata of the response event.
537 | Wraps: mpv_get_property_async"""
538 | assert self._ctx
539 | prop = _strenc(prop)
540 | cdef uint64_t id_data = hash(data)
541 | userdatas = self.reply_userdata.get(id_data, None)
542 | if userdatas is None:
543 | self.reply_userdata[id_data] = userdatas = _ReplyUserData(data)
544 | userdatas.add()
545 | cdef const char* prop_c = prop
546 | with nogil:
547 | err = mpv_get_property_async(
548 | self._ctx,
549 | id_data,
550 | prop_c,
551 | MPV_FORMAT_NODE,
552 | )
553 | return err
554 |
555 | def try_get_property_async(self, prop, data=None, default=None):
556 | try:
557 | return self.get_property_async(prop, data=data)
558 | except MPVError:
559 | return default
560 |
561 | def try_get_property(self, prop, default=None):
562 | try:
563 | return self.get_property(prop)
564 | except MPVError:
565 | return default
566 |
567 | def get_property(self, prop):
568 | """Wraps: mpv_get_property"""
569 | assert self._ctx
570 | cdef mpv_node result
571 | prop = _strenc(prop)
572 | cdef const char* prop_c = prop
573 | cdef int err
574 | with nogil:
575 | err = mpv_get_property(
576 | self._ctx,
577 | prop_c,
578 | MPV_FORMAT_NODE,
579 | &result,
580 | )
581 | if err < 0:
582 | raise MPVError(err)
583 | try:
584 | v = _convert_node_value(result)
585 | finally:
586 | with nogil:
587 | mpv_free_node_contents(&result)
588 | return v
589 |
590 | @_errors
591 | def set_property(self, prop, value=True, asynchronous=False, data=None):
592 | """Wraps: mpv_set_property and mpv_set_property_async"""
593 | assert self._ctx
594 | prop = _strenc(prop)
595 | cdef mpv_format format = self._format_for(value)
596 | cdef mpv_node v = self._prep_native_value(value, format)
597 | cdef int err
598 | cdef uint64_t data_id
599 | cdef const char* prop_c
600 | try:
601 | prop_c = prop
602 | if not asynchronous:
603 | with nogil:
604 | err = mpv_set_property(
605 | self._ctx,
606 | prop_c,
607 | MPV_FORMAT_NODE,
608 | &v
609 | )
610 | return err
611 | data_id = hash(data)
612 | userdatas = self.reply_userdata.get(data_id, None)
613 | if userdatas is None:
614 | self.reply_userdata[data_id] = userdatas = _ReplyUserData(data)
615 | userdatas.add()
616 | with nogil:
617 | err = mpv_set_property_async(
618 | self._ctx,
619 | data_id,
620 | prop_c,
621 | MPV_FORMAT_NODE,
622 | &v
623 | )
624 | finally:
625 | self._free_native_value(v)
626 | return err
627 |
628 | @_errors
629 | def set_option(self, prop, value=True):
630 | """Wraps: mpv_set_option"""
631 | assert self._ctx
632 | prop = _strenc(prop)
633 | cdef mpv_format format = self._format_for(value)
634 | cdef mpv_node v = self._prep_native_value(value, format)
635 | cdef int err
636 | cdef const char* prop_c
637 | try:
638 | prop_c = prop
639 | with nogil:
640 | err = mpv_set_option(
641 | self._ctx,
642 | prop_c,
643 | MPV_FORMAT_NODE,
644 | &v
645 | )
646 | finally:
647 | self._free_native_value(v)
648 | return err
649 |
650 | @_errors
651 | def initialize(self):
652 | """Wraps: mpv_initialize"""
653 | assert self._ctx
654 | cdef int err
655 | with nogil:
656 | err = mpv_initialize(self._ctx)
657 | return err
658 |
659 | def wait_event(self, timeout=None):
660 | """Wraps: mpv_wait_event"""
661 | assert self._ctx
662 | cdef double timeout_d = timeout if timeout is not None else -1
663 | cdef mpv_event* event
664 | with nogil:
665 | event = mpv_wait_event(self._ctx, timeout_d)
666 | return Event()._init(event, self)
667 |
668 | def wakeup(self):
669 | """Wraps: mpv_wakeup"""
670 | assert self._ctx
671 | with nogil:
672 | mpv_wakeup(self._ctx)
673 |
674 | def set_wakeup_callback(self, callback):
675 | """Wraps: mpv_set_wakeup_callback"""
676 | assert self._ctx
677 | cdef uint64_t name = id(self)
678 | self.callback = callback
679 | self.callbackthread.set(callback)
680 | with nogil:
681 | mpv_set_wakeup_callback(self._ctx, _c_callback, name)
682 |
683 | def get_wakeup_pipe(self):
684 | """Wraps: mpv_get_wakeup_pipe"""
685 | assert self._ctx
686 | cdef int pipe
687 | with nogil:
688 | pipe = mpv_get_wakeup_pipe(self._ctx)
689 | return pipe
690 |
691 | def __cinit__(self):
692 | ctxid = id(self)
693 | with nogil:
694 | self._ctx = mpv_create()
695 | if not self._ctx:
696 | raise MPVError("Context creation error")
697 | self.callbackthread = CallbackThread()
698 | _callbacks[ctxid] = self.callbackthread
699 | self.reply_userdata = dict()
700 | _reply_userdatas[ctxid] = self.reply_userdata
701 | self.callbackthread.start()
702 |
703 | @_errors
704 | def observe_property(self, prop, data=None):
705 | """Wraps: mpv_observe_property"""
706 | assert self._ctx
707 | cdef uint64_t id_data = hash(data)
708 | id_data = hash(data)
709 | userdatas = self.reply_userdata.get(id_data, None)
710 | if userdatas is None:
711 | self.reply_userdata[id_data] = userdatas = _ReplyUserData(data)
712 | userdatas.observed = True
713 | prop = _strenc(prop)
714 | cdef char* propc = prop
715 | cdef int err
716 | with nogil:
717 | err = mpv_observe_property(
718 | self._ctx,
719 | id_data,
720 | propc,
721 | MPV_FORMAT_NODE,
722 | )
723 | return err
724 |
725 | @_errors
726 | def unobserve_property(self, data):
727 | """Wraps: mpv_unobserve_property"""
728 | assert self._ctx
729 | cdef uint64_t id_data = hash(data)
730 | userdatas = self.reply_userdata.get(id_data, None)
731 | if userdatas is not None:
732 | userdatas.observed = False
733 | if userdatas.counter <= 0:
734 | del self.reply_userdata[id_data]
735 | cdef int err
736 | with nogil:
737 | err = mpv_unobserve_property(
738 | self._ctx,
739 | id_data,
740 | )
741 | return err
742 |
743 | def shutdown(self):
744 | if self._ctx == NULL:
745 | return
746 | ctxid = id(self)
747 | with nogil:
748 | mpv_terminate_destroy(self._ctx)
749 | self.callbackthread.shutdown()
750 | del _callbacks[ctxid]
751 | del _reply_userdatas[ctxid]
752 | self.callback = None
753 | self.reply_userdata = None
754 | self._ctx = NULL
755 |
756 | def __dealloc__(self):
757 | self.shutdown()
758 |
759 | cdef void *_c_getprocaddress(void *ctx, const char *name) noexcept with gil:
760 | return (