diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
deleted file mode 100644
index 52eb072..0000000
--- a/.github/workflows/tests.yml
+++ /dev/null
@@ -1,106 +0,0 @@
-name: 'Tests'
-
-
-on:
- push:
- branches: [ '**' ]
- pull_request:
- branches: [ '**' ]
-
-
-defaults:
- run:
- shell: bash
-
-
-jobs:
- test-linux:
- runs-on: ubuntu-latest
- name: 'Linux - Python'
- strategy:
- matrix:
- python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
- fail-fast: false
- env:
- DISPLAY: :0
- PY_MPV_SKIP_TESTS: >-
- test_wait_for_property_event_overflow
- steps:
- - uses: actions/checkout@v4
- - name: 'Install Python'
- uses: actions/setup-python@v5
- with:
- python-version: ${{ matrix.python-version }}
- - name: 'Update Packages'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- execute sudo apt update -y
- execute sudo apt upgrade -y
- - name: 'Install Dependencies'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- execute sudo apt install -y libmpv1 xvfb
- - name: 'Start Xvfb'
- run: |
- echo -e "\033[0;34msudo /usr/bin/Xvfb $DISPLAY -screen 0 1920x1080x24 &\033[0m";
- sudo /usr/bin/Xvfb $DISPLAY -screen 0 1920x1080x24 &
- - name: 'Setup Test Environment'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- execute python -m venv venv
- execute source venv/bin/activate
- execute python -m pip install --upgrade pip
- execute python -m pip install wheel
- execute python -m pip install -r tests/requirements.txt
- - name: 'Run Python Tests'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- execute source venv/bin/activate
- execute xvfb-run python -m unittest
-
- test-windows:
- runs-on: windows-latest
- name: 'Windows - Python'
- strategy:
- matrix:
- python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
- fail-fast: false
- steps:
- - uses: actions/checkout@v4
- - name: 'Install Python'
- uses: actions/setup-python@v5
- with:
- python-version: ${{ matrix.python-version }}
- - name: 'Provide libmpv'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- ARTIFACT="mpv-dev-x86_64-v3-20240121-git-a39f9b6.7z"
- SHA1="0764a4b899a7ebb1476e5b491897c5e2eed8a07f"
- URL="https://sourceforge.net/projects/mpv-player-windows/files/libmpv/$ARTIFACT"
-
- execute curl -L -O "$URL"
- echo -e "\033[0;34mecho -n $SHA1 $ARTIFACT > $ARTIFACT.sha1\033[0m"
- echo -n "$SHA1 $ARTIFACT" > "$ARTIFACT.sha1"
- execute sha1sum --check "$ARTIFACT.sha1"
- execute 7z x "$ARTIFACT"
- execute mv libmpv-2.dll tests
- - name: 'Setup Test Environment'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- execute python -m venv venv
- execute source venv/Scripts/activate
- execute python -m pip install --upgrade pip
- execute python -m pip install wheel
- execute python -m pip install -r tests/requirements.txt
- - name: 'Run Python Tests'
- run: |
- function execute() { echo -e "\033[0;34m$*\033[0m"; "$@"; }
-
- execute source venv/Scripts/activate
- execute python -m unittest
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..dba13ed
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,661 @@
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+.
diff --git a/LICENSE.GPL b/LICENSE.GPL
deleted file mode 100644
index d159169..0000000
--- a/LICENSE.GPL
+++ /dev/null
@@ -1,339 +0,0 @@
- GNU GENERAL PUBLIC LICENSE
- Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.) You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
-
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- GNU GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term "modification".) Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
- 1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
- 2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
-
- c) If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such
- interactive use in the most ordinary way, to print or display an
- announcement including an appropriate copyright notice and a
- notice that there is no warranty (or else, saying that you provide
- a warranty) and that users may redistribute the program under
- these conditions, and telling the user how to view a copy of this
- License. (Exception: if the Program itself is interactive but
- does not normally print such an announcement, your work based on
- the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
- b) Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your
- cost of physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
-
- c) Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is
- allowed only for noncommercial distribution and only if you
- received the program in object code or executable form with such
- an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
- 5. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
- 6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
- 7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
- 9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
- 10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
- NO WARRANTY
-
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
- Gnomovision version 69, Copyright (C) year name of author
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
- , 1 April 1989
- Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
diff --git a/LICENSE.LGPL b/LICENSE.LGPL
deleted file mode 100644
index 4362b49..0000000
--- a/LICENSE.LGPL
+++ /dev/null
@@ -1,502 +0,0 @@
- GNU LESSER GENERAL PUBLIC LICENSE
- Version 2.1, February 1999
-
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
- This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it. You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
- When we speak of free software, we are referring to freedom of use,
-not price. Our General Public Licenses are designed to make sure that
-you have the freedom to distribute copies of free software (and charge
-for this service if you wish); that you receive source code or can get
-it if you want it; that you can change the software and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
- To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights. These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
- For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-
- We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
- To protect each distributor, we want to make it very clear that
-there is no warranty for the free library. Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
- Finally, software patents pose a constant threat to the existence of
-any free program. We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder. Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
- Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License. This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License. We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
- When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library. The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom. The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
- We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License. It also provides other free software developers Less
-of an advantage over competing non-free programs. These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries. However, the Lesser license provides advantages in certain
-special circumstances.
-
- For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard. To achieve this, non-free programs must be
-allowed to use the library. A more frequent case is that a free
-library does the same job as widely used non-free libraries. In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
- In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software. For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
- Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
- The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
- GNU LESSER GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
- A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
- The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-
- "Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
- Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
- 1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
- You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
- 2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) The modified work must itself be a software library.
-
- b) You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-
- c) You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-
- d) If a facility in the modified Library refers to a function or a
- table of data to be supplied by an application program that uses
- the facility, other than as an argument passed when the facility
- is invoked, then you must make a good faith effort to ensure that,
- in the event an application does not supply such function or
- table, the facility still operates, and performs whatever part of
- its purpose remains meaningful.
-
- (For example, a function in a library to compute square roots has
- a purpose that is entirely well-defined independent of the
- application. Therefore, Subsection 2d requires that any
- application-supplied function or table used by this function must
- be optional: if the application does not supply it, the square
- root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-
- Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
- This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
- 4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
- If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
- However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
- When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-
- If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
- Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
- 6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
- You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-
- a) Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever
- changes were used in the work (which must be distributed under
- Sections 1 and 2 above); and, if the work is an executable linked
- with the Library, with the complete machine-readable "work that
- uses the Library", as object code and/or source code, so that the
- user can modify the Library and then relink to produce a modified
- executable containing the modified Library. (It is understood
- that the user who changes the contents of definitions files in the
- Library will not necessarily be able to recompile the application
- to use the modified definitions.)
-
- b) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a
- copy of the library already present on the user's computer system,
- rather than copying library functions into the executable, and (2)
- will operate properly with a modified version of the library, if
- the user installs one, as long as the modified version is
- interface-compatible with the version that the work was made with.
-
- c) Accompany the work with a written offer, valid for at
- least three years, to give the same user the materials
- specified in Subsection 6a, above, for a charge no more
- than the cost of performing this distribution.
-
- d) If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above
- specified materials from the same place.
-
- e) Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
-
- For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
- It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
- 7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
- a) Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library
- facilities. This must be distributed under the terms of the
- Sections above.
-
- b) Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining
- where to find the accompanying uncombined form of the same work.
-
- 8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License. However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
- 9. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
- 10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
- 11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded. In such case, this License incorporates the limitation as if
-written in the body of this License.
-
- 13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation. If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
- 14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission. For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this. Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
- NO WARRANTY
-
- 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Libraries
-
- If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change. You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
- To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2.1 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the
- library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
- , 1 April 1990
- Ty Coon, President of Vice
-
-That's all there is to it!
diff --git a/README.rst b/README.rst
index db57f22..30a518f 100644
--- a/README.rst
+++ b/README.rst
@@ -11,7 +11,7 @@ Installation
.. code:: bash
- pip install mpv
+ pip install python-mpv
...though you can also realistically just copy `mpv.py`_ into your project as it's all nicely contained in one file.
@@ -19,40 +19,23 @@ Installation
Requirements
~~~~~~~~~~~~
-libmpv
-......
+libmpv (no kidding!)
+....................
``libmpv.so`` either locally (in your current working directory) or somewhere in your system library search path. This
module is somewhat lenient as far as ``libmpv`` versions are concerned but since ``libmpv`` is changing quite frequently
you'll only get all the newest features when using an up-to-date version of this module. The unit tests for this module
do some basic automatic version compatibility checks. If you discover anything missing here, please open an `issue`_ or
submit a `pull request`_ on github.
-On Windows you can place libmpv anywhere in your ``%PATH%`` (e.g. next to ``python.exe``) or next to this module's
-``mpv.py``. Before falling back to looking in the mpv module's directory, python-mpv uses the DLL search order built
-into ctypes, which is different to the one Windows uses internally. You can modify `%PATH%` before importing python-mpv
-to modify where python-mpv looks for the DLL. Consult `this stackoverflow post `__
-for details.
-
-Python >= 3.9
-.............
-We only support python stable releases from the last couple of years. We only test the current stable python release. If you find a compatibility issue with an older python version that still has upstream support (that is less than about four years old), feel free to open an issue_ and we'll have a look.
+Python 2.7, 3.5 or 3.6 (officially)
+...................................
+The ``master`` branch officially only supports recent python releases (3.5 onwards), but there is the somewhat outdated
+but functional `py2compat branch`_ providing Python 2 compatibility.
+.. _`py2compat branch`: https://github.com/jaseg/python-mpv/tree/py2compat
.. _`issue`: https://github.com/jaseg/python-mpv/issues
.. _`pull request`: https://github.com/jaseg/python-mpv/pulls
-Supported Platforms
-...................
-
-**Linux**, **Windows** and **OSX** all seem to work mostly fine. For some notes on the installation on Windows see
-`this comment`__. Shared library handling is quite bad on windows, so expect some pain there. On OSX there seems to be
-some bug int the event logic. See `issue 36`_ and `issue 61`_ for details. Creating a pyQT window and having mpv draw
-into it seems to be a workaround (about 10loc), but in case you want this fixed please weigh in on the issue tracker
-since right now there is not many OSX users.
-
-.. __: https://github.com/jaseg/python-mpv/issues/60#issuecomment-352719773
-.. _`issue 61`: https://github.com/jaseg/python-mpv/issues/61
-.. _`issue 36`: https://github.com/jaseg/python-mpv/issues/36
-
Usage
-----
@@ -61,15 +44,13 @@ Usage
import mpv
player = mpv.MPV(ytdl=True)
player.play('https://youtu.be/DOmdB7D-pUU')
- player.wait_for_playback()
-python-mpv mostly exposes mpv's built-in API to python, adding only some porcelain on top. Most "`input commands `_" are mapped to methods of the MPV class. Check out these methods and their docstrings in `the source `__ for things you can do. Additional controls and status information are exposed through `MPV properties `_. These can be accessed like ``player.metadata``, ``player.fullscreen`` and ``player.loop_playlist``.
Threading
~~~~~~~~~
The ``mpv`` module starts one thread for event handling, since MPV sends events that must be processed quickly. The
-event queue has a fixed maximum size and some operations can cause a large number of events to be sent.
+event queue has a fixed maxmimum size and some operations can cause a large number of events to be sent.
If you want to handle threading yourself, you can pass ``start_event_thread=False`` to the ``MPV`` constructor and
manually call the ``MPV`` object's ``_loop`` function. If you have some strong need to not use threads and use some
@@ -82,9 +63,6 @@ All API functions are thread-safe. If one is not, please file an issue on github
Advanced Usage
~~~~~~~~~~~~~~
-Logging, Properties, Python Key Bindings, Screenshots and youtube-dl
-....................................................................
-
.. code:: python
#!/usr/bin/env python3
@@ -105,7 +83,7 @@ Logging, Properties, Python Key Bindings, Screenshots and youtube-dl
player.fullscreen = True
player.loop_playlist = 'inf'
# Option access, in general these require the core to reinitialize
- player['vo'] = 'gpu'
+ player['vo'] = 'opengl'
@player.on_key_press('q')
def my_q_binding():
@@ -121,78 +99,6 @@ Logging, Properties, Python Key Bindings, Screenshots and youtube-dl
del player
-Skipping silence using libav filters
-....................................
-
-The following code uses the libav silencedetect filter to skip silence at the beginning of a file. It works by loading
-the filter, then parsing its output from mpv's log. Thanks to Sean DeNigris on github (#202) for the original code!
-
-.. code:: python
-
- #!/usr/bin/env python3
- import sys
- import mpv
-
- p = mpv.MPV()
- p.play(sys.argv[1])
-
- def skip_silence():
- p.set_loglevel('debug')
- p.af = 'lavfi=[silencedetect=n=-20dB:d=1]'
- p.speed = 100
- def check(evt):
- toks = evt['event']['text'].split()
- if 'silence_end:' in toks:
- return float(toks[2])
- p.time_pos = p.wait_for_event('log_message', cond=check)
- p.speed = 1
- p.af = ''
-
- skip_silence()
- p.wait_for_playback()
-
-Video overlays
-..............
-
-.. code:: python
-
- #!/usr/bin/env python3
- import time
- from PIL import Image, ImageDraw, ImageFont
- import mpv
-
- player = mpv.MPV()
-
- player.loop = True
- player.play('test.webm')
- player.wait_until_playing()
-
- font = ImageFont.truetype('DejaVuSans.ttf', 40)
-
- while not player.core_idle:
-
- time.sleep(0.5)
- overlay = player.create_image_overlay()
-
- for pos in range(0, 500, 5):
- ts = player.time_pos
- if ts is None:
- break
-
- img = Image.new('RGBA', (400, 150), (255, 255, 255, 0))
- d = ImageDraw.Draw(img)
- d.text((10, 10), 'Hello World', font=font, fill=(0, 255, 255, 128))
- d.text((10, 60), f't={ts:.3f}', font=font, fill=(255, 0, 255, 255))
-
- overlay.update(img, pos=(2*pos, pos))
- time.sleep(0.05)
-
- overlay.remove()
-
-
-Playlist handling
-.................
-
.. code:: python
#!/usr/bin/env python3
@@ -211,193 +117,12 @@ Playlist handling
print(player.playlist)
player.wait_for_playback()
-Directly feeding mpv data from python
-.....................................
-
-.. code:: python
-
- #!/usr/bin/env python3
- import mpv
-
- player = mpv.MPV()
- @player.python_stream('foo')
- def reader():
- with open('test.webm', 'rb') as f:
- while True:
- yield f.read(1024*1024)
-
- player.play('python://foo')
- player.wait_for_playback()
-
-Using external subtitles
-........................
-
-The easiest way to load custom subtitles from a file is to pass the ``--sub-file`` option to the ``loadfile`` call:
-
-.. code:: python
-
- #!/usr/bin/env python3
- import mpv
-
- player = mpv.MPV()
- player.loadfile('test.webm', sub_file='test.srt')
- player.wait_for_playback()
-
-Note that you can also pass many other options to ``loadfile``. See the mpv docs for details.
-
-If you want to add subtitle files or streams at runtime, you can use the ``sub-add`` command. ``sub-add`` can only be
-called once the player is done loading the file and starts playing. An easy way to wait for this is to wait for the
-``core-idle`` property.
-
-.. code:: python
-
- #!/usr/bin/env python3
- import mpv
-
- player = mpv.MPV()
- player.play('test.webm')
- player.wait_until_playing()
- player.sub_add('test.srt')
- player.wait_for_playback()
-
-Using MPV's built-in GUI
-........................
-
-python-mpv is using mpv via libmpv. libmpv is meant for embedding into other applications and by default disables most
-GUI features such as the OSD or keyboard input. To enable the built-in GUI, use the following options when initializing
-the MPV instance. See `Issue 102`_ for more details
-
-.. _`issue 102`: https://github.com/jaseg/python-mpv/issues/61
-
-.. code:: python
-
- # Enable the on-screen controller and keyboard shortcuts
- player = mpv.MPV(input_default_bindings=True, input_vo_keyboard=True, osc=True)
-
- # Alternative version using the old "floating box" style on-screen controller
- player = mpv.MPV(player_operation_mode='pseudo-gui',
- script_opts='osc-layout=box,osc-seekbarstyle=bar,osc-deadzonesize=0,osc-minmousemove=3',
- input_default_bindings=True,
- input_vo_keyboard=True,
- osc=True)
-
-PyQT embedding
-..............
-
-.. code:: python
-
- #!/usr/bin/env python3
- import mpv
- import sys
-
- from PyQt5.QtWidgets import *
- from PyQt5.QtCore import *
-
- class Test(QMainWindow):
- def __init__(self, parent=None):
- super().__init__(parent)
- self.container = QWidget(self)
- self.setCentralWidget(self.container)
- self.container.setAttribute(Qt.WA_DontCreateNativeAncestors)
- self.container.setAttribute(Qt.WA_NativeWindow)
- player = mpv.MPV(wid=str(int(self.container.winId())),
- vo='x11', # You may not need this
- log_handler=print,
- loglevel='debug')
- player.play('test.webm')
-
- app = QApplication(sys.argv)
-
- # This is necessary since PyQT stomps over the locale settings needed by libmpv.
- # This needs to happen after importing PyQT before creating the first mpv.MPV instance.
- import locale
- locale.setlocale(locale.LC_NUMERIC, 'C')
- win = Test()
- win.show()
- sys.exit(app.exec_())
-
-PyGObject embedding
-...................
-
-.. code:: python
-
- #!/usr/bin/env python3
- import gi
-
- import mpv
-
- gi.require_version('Gtk', '3.0')
- from gi.repository import Gtk
-
-
- class MainClass(Gtk.Window):
-
- def __init__(self):
- super(MainClass, self).__init__()
- self.set_default_size(600, 400)
- self.connect("destroy", self.on_destroy)
-
- widget = Gtk.Frame()
- self.add(widget)
- self.show_all()
-
- # Must be created >after< the widget is shown, else property 'window' will be None
- self.mpv = mpv.MPV(wid=str(widget.get_property("window").get_xid()))
- self.mpv.play("test.webm")
-
- def on_destroy(self, widget, data=None):
- self.mpv.terminate()
- Gtk.main_quit()
-
-
- if __name__ == '__main__':
- # This is necessary since like Qt, Gtk stomps over the locale settings needed by libmpv.
- # Like with Qt, this needs to happen after importing Gtk but before creating the first mpv.MPV instance.
- import locale
- locale.setlocale(locale.LC_NUMERIC, 'C')
-
- application = MainClass()
- Gtk.main()
-
-Using OpenGL from PyGObject
-...........................
-
-Just like it is possible to render into a GTK widget through X11 windows, it `also is possible to render into a GTK
-widget using OpenGL `__ through this python API.
-
-Using OpenGL from PyQt5/QML
-...........................
-
-Robozman_ has mangaed to `make mpv render into a PyQt5/QML widget using OpenGL
-`__ through this python API.
-
-Using mpv inside imgui inside OpenGL via GLFW
-.............................................
-
-dfaker_ has written a demo (`link `__) that uses mpv to render video into an `imgui `__ UI running on an OpenGL context inside `GLFW `__. Check out their demo to see how to integrate with imgui/OpenGL and how to access properties and manage the lifecycle of an MPV instance.
-
-Running tests
--------------
-
-Use pytest to run tests.
-
-Coding Conventions
+Coding conventions
------------------
The general aim is `PEP 8`_, with liberal application of the "consistency" section. 120 cells line width. Four spaces.
No tabs. Probably don't bother making pure-formatting PRs except if you think it *really* helps readability or it
*really* irks you if you don't.
-License
--------
-
-python-mpv inherits the underlying libmpv's license, which can be either GPLv2 or later (default) or LGPLv2.1 or later.
-For details, see `the mpv copyright page`_.
-
.. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/
-.. _`mpv.py`: https://raw.githubusercontent.com/jaseg/python-mpv/main/mpv.py
-.. _cosven: https://github.com/cosven
-.. _Robozman: https://gitlab.com/robozman
-.. _dfaker: https://github.com/dfaker
-.. _`the mpv copyright page`: https://github.com/mpv-player/mpv/blob/master/Copyright
-
+.. _`mpv.py`: https://raw.githubusercontent.com/jaseg/python-mpv/master/mpv.py
diff --git a/do_release.sh b/do_release.sh
deleted file mode 100755
index b1ae0f3..0000000
--- a/do_release.sh
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/bin/sh
-
-[ $# -eq 1 ] || exit 2
-
-VER="$1"
-
-echo "$VER" | grep '^[0-9]\+\.[0-9]\+\.[0-9]\+$' || {
- echo "Call this script as ./do_release.sh [version] where version has format 1.2.3, without \"v\" prefix."
- exit 2
-}
-
-echo "Creating version $VER"
-
-if [ -n "$(git diff --name-only --cached)" ]; then
- echo "Stash or commit staged changes first"
- exit 2
-fi
-
-sed -i "s/^\\(\\s*version\\s*=\\s*['\"]\\)[^'\"]*\\(['\"]\\s*\\)$/\\1v"$VER"\\2/" pyproject.toml
-sed -i "s/^\\(\\s*__version__\\s*=\\s*['\"]\\)[^'\"]*\\(['\"]\\s*\\)$/\\1"$VER"\\2/" mpv.py
-git add pyproject.toml mpv.py
-git commit -m "Version $VER" --no-edit
-git -c user.signingkey=E36F75307F0A0EC2D145FF5CED7A208EEEC76F2D -c user.email=python-mpv@jaseg.de tag -s "v$VER" -m "Version $VER"
-git push --tags origin
diff --git a/mpv-test.py b/mpv-test.py
new file mode 100755
index 0000000..96bf225
--- /dev/null
+++ b/mpv-test.py
@@ -0,0 +1,464 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim: ts=4 sw=4 et
+
+import unittest
+from unittest import mock
+import math
+import threading
+from contextlib import contextmanager
+import gc
+import os.path
+import time
+
+import mpv
+
+
+TESTVID = os.path.join(os.path.dirname(__file__), 'test.webm')
+MPV_ERRORS = [ l(ec) for ec, l in mpv.ErrorCode.EXCEPTION_DICT.items() if l ]
+
+class MpvTestCase(unittest.TestCase):
+ def setUp(self):
+ self.m = mpv.MPV()
+
+ def tearDown(self):
+ self.m.terminate()
+
+class TestProperties(MpvTestCase):
+ @contextmanager
+ def swallow_mpv_errors(self, exception_exceptions=[]):
+ try:
+ yield
+ except Exception as e:
+ if any(e.args[:2] == ex.args for ex in MPV_ERRORS):
+ if e.args[1] not in exception_exceptions:
+ raise
+ else:
+ raise
+
+ def test_read(self):
+ self.m.loop = 'inf'
+ self.m.play(TESTVID)
+ while self.m.core_idle:
+ time.sleep(0.05)
+ for name in sorted(self.m.property_list):
+ name = name.replace('-', '_')
+ with self.subTest(property_name=name), self.swallow_mpv_errors([
+ mpv.ErrorCode.PROPERTY_UNAVAILABLE,
+ mpv.ErrorCode.PROPERTY_ERROR,
+ mpv.ErrorCode.PROPERTY_NOT_FOUND]):
+ getattr(self.m, name)
+
+ def test_write(self):
+ self.m.loop = 'inf'
+ self.m.play(TESTVID)
+ while self.m.core_idle:
+ time.sleep(0.05)
+ for name in sorted(self.m.property_list):
+ if name in ('external-file','input-ipc-server', 'heartbeat-cmd', 'wid', 'input-file'):
+ continue
+ name = name.replace('-', '_')
+ with self.subTest(property_name=name), self.swallow_mpv_errors([
+ mpv.ErrorCode.PROPERTY_UNAVAILABLE,
+ mpv.ErrorCode.PROPERTY_ERROR,
+ mpv.ErrorCode.PROPERTY_FORMAT,
+ mpv.ErrorCode.PROPERTY_NOT_FOUND]): # This is due to a bug with option-mapped properties in mpv 0.18.1
+ setattr(self.m, name, 100)
+ setattr(self.m, name, 1)
+ setattr(self.m, name, 0)
+ setattr(self.m, name, -1)
+ setattr(self.m, name, 1)
+ setattr(self.m, name, 1.0)
+ setattr(self.m, name, 0.0)
+ setattr(self.m, name, -1.0)
+ setattr(self.m, name, float('nan'))
+ setattr(self.m, name, 'foo')
+ setattr(self.m, name, '')
+ setattr(self.m, name, 'bazbazbaz'*1000)
+ setattr(self.m, name, b'foo')
+ setattr(self.m, name, b'')
+ setattr(self.m, name, b'bazbazbaz'*1000)
+ setattr(self.m, name, True)
+ setattr(self.m, name, False)
+
+ def test_property_bounce(self):
+ self.m.aid = False
+ self.assertEqual(self.m.audio, False)
+ self.m.aid = 'auto'
+ self.assertEqual(self.m.audio, 'auto')
+ self.m.aid = 'no'
+ self.assertEqual(self.m.audio, False)
+ self.m.audio = 'auto'
+ self.assertEqual(self.m.aid, 'auto')
+ self.m.audio = False
+ self.assertEqual(self.m.aid, False)
+ self.m.audio = 'auto'
+ self.assertEqual(self.m.aid, 'auto')
+ self.m.audio = 'no'
+ self.assertEqual(self.m.aid, False)
+
+ def test_array_property_bounce(self):
+ self.m.alang = 'en'
+ self.assertEqual(self.m.alang, ['en'])
+ self.m.alang = 'de'
+ self.assertEqual(self.m.alang, ['de'])
+ self.m.alang = ['de', 'en']
+ self.assertEqual(self.m.alang, ['de', 'en'])
+ self.m.alang = 'de,en'
+ self.assertEqual(self.m.alang, ['de', 'en'])
+ self.m.alang = ['de,en']
+ self.assertEqual(self.m.alang, ['de,en'])
+
+ def test_osd_property_bounce(self):
+ self.m.alang = ['en']
+ self.assertEqual(self.m.osd.alang, 'en')
+ self.m.alang = ['de']
+ self.assertEqual(self.m.osd.alang, 'de')
+ self.m.alang = ['en', 'de']
+ self.assertEqual(self.m.osd.alang, 'en,de')
+
+ def test_raw_property_bounce(self):
+ self.m.alang = 'en'
+ self.assertEqual(self.m.raw.alang, [b'en'])
+ self.m.alang = 'de'
+ self.assertEqual(self.m.raw.alang, [b'de'])
+ self.m.alang = ['de', 'en']
+ self.assertEqual(self.m.raw.alang, [b'de', b'en'])
+ self.m.alang = 'de,en'
+ self.assertEqual(self.m.raw.alang, [b'de', b'en'])
+ self.m.alang = ['de,en']
+ self.assertEqual(self.m.raw.alang, [b'de,en'])
+
+ def test_property_decoding_invalid_utf8(self):
+ invalid_utf8 = b'foo\xc3\x28bar'
+ self.m.alang = invalid_utf8
+ self.assertEqual(self.m.alang, [invalid_utf8])
+ self.assertEqual(self.m.raw.alang, [invalid_utf8])
+ with self.assertRaises(UnicodeDecodeError):
+ self.m.strict.alang
+ with self.assertRaises(UnicodeDecodeError):
+ # alang is considered safe and pasted straight into the OSD string. But OSD strings should always be valid
+ # UTF-8. This test may be removed in case OSD encoding sanitization is handled differently in the future.
+ self.m.osd.alang
+
+ def test_property_decoding_valid_utf8(self):
+ valid_utf8 = 'pröpérty'
+ self.m.alang = valid_utf8
+ self.assertEqual(self.m.alang, [valid_utf8])
+ self.assertEqual(self.m.raw.alang, [valid_utf8.encode('utf-8')])
+ self.assertEqual(self.m.osd.alang, valid_utf8)
+ self.assertEqual(self.m.strict.alang, [valid_utf8])
+
+ def test_property_decoding_multi(self):
+ valid_utf8 = 'pröpérty'
+ invalid_utf8 = b'foo\xc3\x28bar'
+ self.m.alang = [valid_utf8, 'foo', invalid_utf8]
+ self.assertEqual(self.m.alang, [valid_utf8, 'foo', invalid_utf8])
+ self.assertEqual(self.m.raw.alang, [valid_utf8.encode('utf-8'), b'foo', invalid_utf8])
+ with self.assertRaises(UnicodeDecodeError):
+ self.m.strict.alang
+ with self.assertRaises(UnicodeDecodeError):
+ # See comment in test_property_decoding_invalid_utf8
+ self.m.osd.alang
+
+ def test_option_read(self):
+ self.m.loop = 'inf'
+ self.m.play(TESTVID)
+ while self.m.core_idle:
+ time.sleep(0.05)
+ for name in sorted(self.m):
+ with self.subTest(option_name=name), self.swallow_mpv_errors([
+ mpv.ErrorCode.PROPERTY_UNAVAILABLE, mpv.ErrorCode.PROPERTY_NOT_FOUND, mpv.ErrorCode.PROPERTY_ERROR]):
+ self.m[name]
+
+ def test_multivalued_option(self):
+ self.m['external-files'] = ['test.webm', b'test.webm']
+ self.assertEqual(self.m['external-files'], ['test.webm', 'test.webm'])
+
+
+class ObservePropertyTest(MpvTestCase):
+ def test_observe_property(self):
+ handler = mock.Mock()
+
+ m = self.m
+ m.observe_property('vid', handler)
+
+ time.sleep(0.1)
+ m.play(TESTVID)
+
+ time.sleep(0.1) #couple frames
+ m.unobserve_property('vid', handler)
+
+ time.sleep(0.1) #couple frames
+ m.terminate() # needed for synchronization of event thread
+ handler.assert_has_calls([mock.call('vid', 'auto'), mock.call('vid', 1)])
+
+ def test_property_observer_decorator(self):
+ handler = mock.Mock()
+
+ m = self.m
+ m.play(TESTVID)
+
+ m.loop = 'inf'
+ m.mute = True
+
+ @m.property_observer('mute')
+ @m.property_observer('loop')
+ def foo(*args, **kwargs):
+ handler(*args, **kwargs)
+
+ m.mute = False
+ m.loop = False
+ self.assertEqual(m.mute, False)
+ self.assertEqual(m.loop, False)
+
+ # Wait for tick. AFAICT property events are only generated at regular
+ # intervals, and if we change a property too fast we don't get any
+ # events. This is a limitation of the upstream API.
+ time.sleep(0.1)
+ # Another API limitation is that the order of property change events on
+ # different properties does not necessarily exactly match the order in
+ # which these properties were previously accessed. Thus, any_order.
+ handler.assert_has_calls([
+ mock.call('mute', False),
+ mock.call('loop', False)],
+ any_order=True)
+ handler.reset_mock()
+
+ m.mute = True
+ m.loop = 'inf'
+ self.assertEqual(m.mute, True)
+ self.assertEqual(m.loop, 'inf')
+
+ time.sleep(0.05)
+ foo.unobserve_mpv_properties()
+
+ m.mute = False
+ m.loop = False
+ m.mute = True
+ m.loop = 'inf'
+ m.terminate() # needed for synchronization of event thread
+ handler.assert_has_calls([
+ mock.call('mute', True),
+ mock.call('loop', 'inf')],
+ any_order=True)
+
+class KeyBindingTest(MpvTestCase):
+ def test_register_direct_cmd(self):
+ self.m.register_key_binding('a', 'playlist-clear')
+ self.assertEqual(self.m._key_binding_handlers, {})
+ self.m.register_key_binding('Ctrl+Shift+a', 'playlist-clear')
+ self.m.unregister_key_binding('a')
+ self.m.unregister_key_binding('Ctrl+Shift+a')
+
+ def test_register_direct_fun(self):
+ b = mpv.MPV._binding_name
+
+ def reg_test_fun(state, name):
+ pass
+
+ self.m.register_key_binding('a', reg_test_fun)
+ self.assertIn(b('a'), self.m._key_binding_handlers)
+ self.assertEqual(self.m._key_binding_handlers[b('a')], reg_test_fun)
+
+ self.m.unregister_key_binding('a')
+ self.assertNotIn(b('a'), self.m._key_binding_handlers)
+
+ def test_register_direct_bound_method(self):
+ b = mpv.MPV._binding_name
+
+ class RegTestCls:
+ def method(self, state, name):
+ pass
+ instance = RegTestCls()
+
+ self.m.register_key_binding('a', instance.method)
+ self.assertIn(b('a'), self.m._key_binding_handlers)
+ self.assertEqual(self.m._key_binding_handlers[b('a')], instance.method)
+
+ self.m.unregister_key_binding('a')
+ self.assertNotIn(b('a'), self.m._key_binding_handlers)
+
+ def test_register_decorator_fun(self):
+ b = mpv.MPV._binding_name
+
+ @self.m.key_binding('a')
+ def reg_test_fun(state, name):
+ pass
+ self.assertEqual(reg_test_fun.mpv_key_bindings, ['a'])
+ self.assertIn(b('a'), self.m._key_binding_handlers)
+ self.assertEqual(self.m._key_binding_handlers[b('a')], reg_test_fun)
+
+ reg_test_fun.unregister_mpv_key_bindings()
+ self.assertNotIn(b('a'), self.m._key_binding_handlers)
+
+ def test_register_decorator_fun_chaining(self):
+ b = mpv.MPV._binding_name
+
+ @self.m.key_binding('a')
+ @self.m.key_binding('b')
+ def reg_test_fun(state, name):
+ pass
+
+ @self.m.key_binding('c')
+ def reg_test_fun_2_stay_intact(state, name):
+ pass
+
+ self.assertEqual(reg_test_fun.mpv_key_bindings, ['b', 'a'])
+ self.assertIn(b('a'), self.m._key_binding_handlers)
+ self.assertIn(b('b'), self.m._key_binding_handlers)
+ self.assertIn(b('c'), self.m._key_binding_handlers)
+ self.assertEqual(self.m._key_binding_handlers[b('a')], reg_test_fun)
+ self.assertEqual(self.m._key_binding_handlers[b('b')], reg_test_fun)
+
+ reg_test_fun.unregister_mpv_key_bindings()
+ self.assertNotIn(b('a'), self.m._key_binding_handlers)
+ self.assertNotIn(b('b'), self.m._key_binding_handlers)
+ self.assertIn(b('c'), self.m._key_binding_handlers)
+
+ def test_register_simple_decorator_fun_chaining(self):
+ b = mpv.MPV._binding_name
+
+ handler1, handler2 = mock.Mock(), mock.Mock()
+
+ @self.m.on_key_press('a')
+ @self.m.on_key_press('b')
+ def reg_test_fun(*args, **kwargs):
+ handler1(*args, **kwargs)
+
+ @self.m.on_key_press('c')
+ def reg_test_fun_2_stay_intact(*args, **kwargs):
+ handler2(*args, **kwargs)
+
+ self.assertEqual(reg_test_fun.mpv_key_bindings, ['b', 'a'])
+ self.assertIn(b('a'), self.m._key_binding_handlers)
+ self.assertIn(b('b'), self.m._key_binding_handlers)
+ self.assertIn(b('c'), self.m._key_binding_handlers)
+
+ self.m._key_binding_handlers[b('a')]('p-', 'q')
+ handler1.assert_has_calls([ mock.call() ])
+ handler2.assert_has_calls([])
+ handler1.reset_mock()
+ self.m._key_binding_handlers[b('b')]('p-', 'q')
+ handler1.assert_has_calls([ mock.call() ])
+ handler2.assert_has_calls([])
+ self.m._key_binding_handlers[b('c')]('p-', 'q')
+ handler1.assert_has_calls([])
+ handler2.assert_has_calls([ mock.call() ])
+
+ reg_test_fun.unregister_mpv_key_bindings()
+ self.assertNotIn(b('a'), self.m._key_binding_handlers)
+ self.assertNotIn(b('b'), self.m._key_binding_handlers)
+ self.assertIn(b('c'), self.m._key_binding_handlers)
+
+class TestLifecycle(unittest.TestCase):
+ def test_create_destroy(self):
+ thread_names = lambda: [ t.name for t in threading.enumerate() ]
+ self.assertNotIn('MPVEventHandlerThread', thread_names())
+ m = mpv.MPV()
+ self.assertIn('MPVEventHandlerThread', thread_names())
+ m.terminate()
+ self.assertNotIn('MPVEventHandlerThread', thread_names())
+
+ def test_flags(self):
+ with self.assertRaises(AttributeError):
+ mpv.MPV('this-option-does-not-exist')
+ m = mpv.MPV('cursor-autohide-fs-only', 'fs', video=False)
+ self.assertTrue(m.fullscreen)
+ self.assertEqual(m.cursor_autohide, 1000)
+ m.terminate()
+
+ def test_options(self):
+ with self.assertRaises(AttributeError):
+ mpv.MPV(this_option_does_not_exists=23)
+ m = mpv.MPV(osd_level=0, loop='inf', deinterlace=False)
+ self.assertEqual(m.osd_level, 0)
+ self.assertEqual(m.loop, 'inf')
+ self.assertEqual(m.deinterlace, False)
+ m.terminate()
+
+ def test_event_callback(self):
+ handler = mock.Mock()
+ m = mpv.MPV(video=False)
+ m.register_event_callback(handler)
+ m.play(TESTVID)
+ m.wait_for_playback()
+
+ m.unregister_event_callback(handler)
+ handler.assert_has_calls([
+ mock.call({'reply_userdata': 0, 'error': 0, 'event_id': 6, 'event': None}),
+ mock.call({'reply_userdata': 0, 'error': 0, 'event_id': 9, 'event': None}),
+ mock.call({'reply_userdata': 0, 'error': 0, 'event_id': 7, 'event': {'reason': 4}}),
+ ], any_order=True)
+ handler.reset_mock()
+
+ m.terminate()
+ handler.assert_not_called()
+
+ def test_log_handler(self):
+ handler = mock.Mock()
+ m = mpv.MPV(video=False, log_handler=handler)
+ m.play(TESTVID)
+ m.wait_for_playback()
+ m.terminate()
+ handler.assert_any_call('info', 'cplayer', 'Playing: test.webm')
+
+
+class RegressionTests(MpvTestCase):
+
+ def test_unobserve_property_runtime_error(self):
+ """
+ Ensure a `RuntimeError` is not thrown within
+ `unobserve_property`.
+ """
+ handler = mock.Mock()
+
+ self.m.observe_property('loop', handler)
+
+ try:
+ self.m.unobserve_property('loop', handler)
+ except RuntimeError:
+ self.fail(
+ """
+ "RuntimeError" exception thrown within
+ `unobserve_property`
+ """,
+ )
+
+ def test_instance_method_property_observer(self):
+ """
+ Ensure that bound method objects can be used as property observers.
+ See issue #26
+ """
+ handler = mock.Mock()
+ m = self.m
+
+ class T(object):
+ def t(self, *args, **kw):
+ handler(*args, **kw)
+ t = T()
+
+ m.loop = 'inf'
+
+ m.observe_property('loop', t.t)
+
+ m.loop = False
+ self.assertEqual(m.loop, False)
+ # Wait for tick. AFAICT property events are only generated at regular
+ # intervals, and if we change a property too fast we don't get any
+ # events. This is a limitation of the upstream API.
+ time.sleep(0.01)
+ m.loop = 'inf'
+ self.assertEqual(m.loop, 'inf')
+
+ time.sleep(0.02)
+ m.unobserve_property('loop', t.t)
+
+ m.loop = False
+ m.loop = 'inf'
+ m.terminate() # needed for synchronization of event thread
+ handler.assert_has_calls([mock.call('loop', False), mock.call('loop', 'inf')])
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/mpv.py b/mpv.py
index f9bf561..1c32e10 100644
--- a/mpv.py
+++ b/mpv.py
@@ -2,64 +2,36 @@
# vim: ts=4 sw=4 et
#
# Python MPV library module
-# Copyright (C) 2017-2024 Sebastian Götte
+# Copyright (C) 2017 Sebastian Götte
#
-# python-mpv inherits the underlying libmpv's license, which can be either GPLv2 or later (default) or LGPLv2.1 or
-# later. For details, see the mpv copyright page here: https://github.com/mpv-player/mpv/blob/master/Copyright
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
#
-# You may copy, modify, and redistribute this file under the terms of the GNU General Public License version 2 (or, at
-# your option, any later version), or the GNU Lesser General Public License as published by the Free Software
-# Foundation; either version 2.1 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
#
-# This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
-# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU
-# Lesser General Public License for more details.
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see .
#
-# You can find copies of the GPLv2 and LGPLv2.1 licenses in the project repository's LICENSE.GPL and LICENSE.LGPL files.
-
-__version__ = '1.0.8'
from ctypes import *
import ctypes.util
import threading
-import queue
import os
-import os.path
import sys
from warnings import warn
from functools import partial, wraps
-from contextlib import contextmanager
-from concurrent.futures import Future, InvalidStateError
import collections
import re
import traceback
if os.name == 'nt':
- # Note: mpv-2.dll with API version 2 corresponds to mpv v0.35.0. Most things should work with the fallback, too.
- names = ['mpv-2.dll', 'libmpv-2.dll', 'mpv-1.dll']
- for name in names:
- dll = ctypes.util.find_library(name)
- if dll:
- break
- else:
- for name in names:
- dll = os.path.join(os.path.dirname(__file__), name)
- if os.path.isfile(dll):
- break
- else:
- raise OSError('Cannot find mpv-1.dll, mpv-2.dll or libmpv-2.dll in your system %PATH%. One way to deal with this is to ship the dll with your script and put the directory your script is in into %PATH% before "import mpv": os.environ["PATH"] = os.path.dirname(__file__) + os.pathsep + os.environ["PATH"] If mpv-1.dll is located elsewhere, you can add that path to os.environ["PATH"].')
-
- try:
- # flags argument: LOAD_LIBRARY_SEARCH_DEFAULT_DIRS | LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR
- # cf. https://learn.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryexa
- backend = CDLL(dll, 0x00001000 | 0x00000100)
- except Exception as e:
- if not os.path.isabs(dll): # can only be find_library, not the "look next to mpv.py" thing
- raise OSError(f'ctypes.find_library found mpv.dll at {dll}, but ctypes.CDLL could not load it. It looks like find_library found mpv.dll under a relative path entry in %PATH%. Please make sure all paths in %PATH% are absolute. Instead of trying to load mpv.dll from the current working directory, put it somewhere next to your script and add that path to %PATH% using os.environ["PATH"] = os.path.dirname(__file__) + os.pathsep + os.environ["PATH"]') from e
- else:
- raise OSError(f'ctypes.find_library found mpv.dll at {dll}, but ctypes.CDLL could not load it.') from e
+ backend = CDLL('mpv-1.dll')
fs_enc = 'utf-8'
-
else:
import locale
lc, enc = locale.getlocale(locale.LC_NUMERIC)
@@ -69,28 +41,26 @@ else:
sofile = ctypes.util.find_library('mpv')
if sofile is None:
- raise OSError("Cannot find libmpv in the usual places. Depending on your distro, you may try installing an mpv-devel or mpv-libs package. If you have libmpv around but this script can't find it, consult the documentation for ctypes.util.find_library which this script uses to look up the library filename.")
+ raise OSError("Cannot find libmpv in the usual places. Depending on your distro, you may try installing an "
+ "mpv-devel or mpv-libs package. If you have libmpv around but this script can't find it, maybe consult "
+ "the documentation for ctypes.util.find_library which this script uses to look up the library "
+ "filename.")
backend = CDLL(sofile)
fs_enc = sys.getfilesystemencoding()
-class ShutdownError(SystemError):
- pass
-
-class EventOverflowError(SystemError):
- pass
-
class MpvHandle(c_void_p):
pass
-class MpvRenderCtxHandle(c_void_p):
+class MpvOpenGLCbContext(c_void_p):
pass
+
class PropertyUnavailableError(AttributeError):
pass
class ErrorCode(object):
- """For documentation on these, see mpv's libmpv/client.h."""
+ """ For documentation on these, see mpv's libmpv/client.h """
SUCCESS = 0
EVENT_QUEUE_FULL = -1
NOMEM = -2
@@ -104,14 +74,6 @@ class ErrorCode(object):
PROPERTY_UNAVAILABLE = -10
PROPERTY_ERROR = -11
COMMAND = -12
- LOADING_FAILED = -13
- AO_INIT_FAILED = -14
- VO_INIT_FAILED = -15
- NOTHING_TO_PLAY = -16
- UNKNOWN_FORMAT = -17
- UNSUPPORTED = -18
- NOT_IMPLEMENTED = -19
- GENERIC = -20
EXCEPTION_DICT = {
0: None,
@@ -128,142 +90,19 @@ class ErrorCode(object):
-9: lambda *a: TypeError('Tried to get/set mpv property using wrong format, or passed invalid value', *a),
-10: lambda *a: PropertyUnavailableError('mpv property is not available', *a),
-11: lambda *a: RuntimeError('Generic error getting or setting mpv property', *a),
- -12: lambda *a: SystemError('Error running mpv command', *a),
- -14: lambda *a: RuntimeError('Initializing the audio output failed', *a),
- -15: lambda *a: RuntimeError('Initializing the video output failed'),
- -16: lambda *a: RuntimeError('There was no audio or video data to play. This also happens if the file '
- 'was recognized, but did not contain any audio or video streams, or no '
- 'streams were selected.'),
- -17: lambda *a: RuntimeError('When trying to load the file, the file format could not be determined, '
- 'or the file was too broken to open it'),
- -18: lambda *a: ValueError('Generic error for signaling that certain system requirements are not fulfilled'),
- -19: lambda *a: NotImplementedError('The API function which was called is a stub only'),
- -20: lambda *a: RuntimeError('Unspecified error') }
-
- @staticmethod
- def human_readable(ec):
- return _mpv_error_string(ec).decode('utf-8')
+ -12: lambda *a: SystemError('Error running mpv command', *a) }
@staticmethod
def default_error_handler(ec, *args):
- return ValueError(ErrorCode.human_readable(ec), ec, *args)
-
- @classmethod
- def exception_for_ec(kls, ec, *args):
- ec = 0 if ec > 0 else ec
- ex = kls.EXCEPTION_DICT.get(ec, kls.default_error_handler)
- if ex:
- return ex(ec, *args)
+ return ValueError(_mpv_error_string(ec).decode('utf-8'), ec, *args)
@classmethod
def raise_for_ec(kls, ec, func, *args):
- ex = kls.exception_for_ec(ec, *args)
+ ec = 0 if ec > 0 else ec
+ ex = kls.EXCEPTION_DICT.get(ec , kls.default_error_handler)
if ex:
- raise ex
+ raise ex(ec, *args)
-MpvGlGetProcAddressFn = CFUNCTYPE(c_void_p, c_void_p, c_char_p)
-class MpvOpenGLInitParams(Structure):
- _fields_ = [('get_proc_address', MpvGlGetProcAddressFn),
- ('get_proc_address_ctx', c_void_p),
- ('extra_exts', c_void_p)]
-
- def __init__(self, get_proc_address):
- self.get_proc_address = get_proc_address
- self.get_proc_address_ctx = None
- self.extra_exts = None
-
-class MpvOpenGLFBO(Structure):
- _fields_ = [('fbo', c_int),
- ('w', c_int),
- ('h', c_int),
- ('internal_format', c_int)]
-
- def __init__(self, w, h, fbo=0, internal_format=0):
- self.w, self.h = w, h
- self.fbo = fbo
- self.internal_format = internal_format
-
-class MpvRenderFrameInfo(Structure):
- _fields_ = [('flags', c_int64),
- ('target_time', c_int64)]
-
- def as_dict(self):
- return {'flags': self.flags,
- 'target_time': self.target_time}
-
-class MpvOpenGLDRMParams(Structure):
- _fields_ = [('fd', c_int),
- ('crtc_id', c_int),
- ('connector_id', c_int),
- ('atomic_request_ptr', c_void_p),
- ('render_fd', c_int)]
-
-class MpvOpenGLDRMDrawSurfaceSize(Structure):
- _fields_ = [('width', c_int), ('height', c_int)]
-
-class MpvOpenGLDRMParamsV2(Structure):
- _fields_ = [('fd', c_int),
- ('crtc_id', c_int),
- ('connector_id', c_int),
- ('atomic_request_ptr', c_void_p),
- ('render_fd', c_int)]
-
- def __init__(self, crtc_id, connector_id, atomic_request_ptr, fd=-1, render_fd=-1):
- self.crtc_id, self.connector_id = crtc_id, connector_id
- self.atomic_request_ptr = atomic_request_ptr
- self.fd, self.render_fd = fd, render_fd
-
-
-class MpvRenderParam(Structure):
- _fields_ = [('type_id', c_int),
- ('data', c_void_p)]
-
- # maps human-readable type name to (type_id, argtype) tuple.
- # The type IDs come from libmpv/render.h
- TYPES = {"invalid" :(0, None),
- "api_type" :(1, str),
- "opengl_init_params" :(2, MpvOpenGLInitParams),
- "opengl_fbo" :(3, MpvOpenGLFBO),
- "flip_y" :(4, bool),
- "depth" :(5, int),
- "icc_profile" :(6, bytes),
- "ambient_light" :(7, int),
- "x11_display" :(8, c_void_p),
- "wl_display" :(9, c_void_p),
- "advanced_control" :(10, bool),
- "next_frame_info" :(11, MpvRenderFrameInfo),
- "block_for_target_time" :(12, bool),
- "skip_rendering" :(13, bool),
- "drm_display" :(14, MpvOpenGLDRMParams),
- "drm_draw_surface_size" :(15, MpvOpenGLDRMDrawSurfaceSize),
- "drm_display_v2" :(16, MpvOpenGLDRMParamsV2)}
-
- def __init__(self, name, value=None):
- if name not in self.TYPES:
- raise ValueError('unknown render param type "{}"'.format(name))
- self.type_id, cons = self.TYPES[name]
- if cons is None:
- self.value = None
- self.data = c_void_p()
- elif cons is str:
- self.value = value
- self.data = cast(c_char_p(value.encode('utf-8')), c_void_p)
- elif cons is bytes:
- self.value = MpvByteArray(value)
- self.data = cast(pointer(self.value), c_void_p)
- elif cons is bool:
- self.value = c_int(int(bool(value)))
- self.data = cast(pointer(self.value), c_void_p)
- elif cons is c_void_p:
- self.value = value
- self.data = cast(self.value, c_void_p)
- else:
- self.value = cons(**value)
- self.data = cast(pointer(self.value), c_void_p)
-
-def kwargs_to_render_param_array(kwargs):
- t = MpvRenderParam * (len(kwargs)+1)
- return t(*kwargs.items(), ('invalid', None))
class MpvFormat(c_int):
NONE = 0
@@ -298,20 +137,32 @@ class MpvEventID(c_int):
START_FILE = 6
END_FILE = 7
FILE_LOADED = 8
+ TRACKS_CHANGED = 9
+ TRACK_SWITCHED = 10
+ IDLE = 11
+ PAUSE = 12
+ UNPAUSE = 13
+ TICK = 14
+ SCRIPT_INPUT_DISPATCH = 15
CLIENT_MESSAGE = 16
VIDEO_RECONFIG = 17
AUDIO_RECONFIG = 18
+ METADATA_UPDATE = 19
SEEK = 20
PLAYBACK_RESTART = 21
PROPERTY_CHANGE = 22
- QUEUE_OVERFLOW = 24
- HOOK = 25
+ CHAPTER_CHANGE = 23
ANY = ( SHUTDOWN, LOG_MESSAGE, GET_PROPERTY_REPLY, SET_PROPERTY_REPLY, COMMAND_REPLY, START_FILE, END_FILE,
- FILE_LOADED, CLIENT_MESSAGE, VIDEO_RECONFIG, AUDIO_RECONFIG, SEEK, PLAYBACK_RESTART, PROPERTY_CHANGE)
+ FILE_LOADED, TRACKS_CHANGED, TRACK_SWITCHED, IDLE, PAUSE, UNPAUSE, TICK, SCRIPT_INPUT_DISPATCH,
+ CLIENT_MESSAGE, VIDEO_RECONFIG, AUDIO_RECONFIG, METADATA_UPDATE, SEEK, PLAYBACK_RESTART, PROPERTY_CHANGE,
+ CHAPTER_CHANGE )
def __repr__(self):
- return f''
+ return ['NONE', 'SHUTDOWN', 'LOG_MESSAGE', 'GET_PROPERTY_REPLY', 'SET_PROPERTY_REPLY', 'COMMAND_REPLY',
+ 'START_FILE', 'END_FILE', 'FILE_LOADED', 'TRACKS_CHANGED', 'TRACK_SWITCHED', 'IDLE', 'PAUSE', 'UNPAUSE',
+ 'TICK', 'SCRIPT_INPUT_DISPATCH', 'CLIENT_MESSAGE', 'VIDEO_RECONFIG', 'AUDIO_RECONFIG',
+ 'METADATA_UPDATE', 'SEEK', 'PLAYBACK_RESTART', 'PROPERTY_CHANGE', 'CHAPTER_CHANGE'][self.value]
@classmethod
def from_str(kls, s):
@@ -338,209 +189,114 @@ class MpvByteArray(Structure):
_fields_ = [('data', c_void_p),
('size', c_size_t)]
- def __init__(self, value):
- self._value = value
- self.data = cast(c_char_p(value), c_void_p)
- self.size = len(value)
-
def bytes_value(self):
return cast(self.data, POINTER(c_char))[:self.size]
class MpvNode(Structure):
+ _fields_ = [('val', c_longlong),
+ ('format', MpvFormat)]
+
def node_value(self, decoder=identity_decoder):
- return MpvNode.node_cast_value(self.val, self.format.value, decoder)
+ return MpvNode.node_cast_value(byref(c_void_p(self.val)), self.format.value, decoder)
@staticmethod
def node_cast_value(v, fmt=MpvFormat.NODE, decoder=identity_decoder):
- if fmt == MpvFormat.NONE:
- return None
- elif fmt == MpvFormat.STRING:
- return decoder(v.string)
- elif fmt == MpvFormat.OSD_STRING:
- return v.string.decode('utf-8')
- elif fmt == MpvFormat.FLAG:
- return bool(v.flag)
- elif fmt == MpvFormat.INT64:
- return v.int64
- elif fmt == MpvFormat.DOUBLE:
- return v.double
- else:
- if not v.node: # Check for null pointer
- return None
- if fmt == MpvFormat.NODE:
- return v.node.contents.node_value(decoder)
- elif fmt == MpvFormat.NODE_ARRAY:
- return v.list.contents.array_value(decoder)
- elif fmt == MpvFormat.NODE_MAP:
- return v.map.contents.dict_value(decoder)
- elif fmt == MpvFormat.BYTE_ARRAY:
- return v.byte_array.contents.bytes_value()
- else:
- raise TypeError('Unknown MPV node format {}. Please submit a bug report.'.format(fmt))
-
-class MpvNodeUnion(Union):
- _fields_ = [('string', c_char_p),
- ('flag', c_int),
- ('int64', c_int64),
- ('double', c_double),
- ('node', POINTER(MpvNode)),
- ('list', POINTER(MpvNodeList)),
- ('map', POINTER(MpvNodeList)),
- ('byte_array', POINTER(MpvByteArray))]
-
-MpvNode._fields_ = [('val', MpvNodeUnion),
- ('format', MpvFormat)]
+ return {
+ MpvFormat.NONE: lambda v: None,
+ MpvFormat.STRING: lambda v: decoder(cast(v, POINTER(c_char_p)).contents.value),
+ MpvFormat.OSD_STRING: lambda v: cast(v, POINTER(c_char_p)).contents.value.decode('utf-8'),
+ MpvFormat.FLAG: lambda v: bool(cast(v, POINTER(c_int)).contents.value),
+ MpvFormat.INT64: lambda v: cast(v, POINTER(c_longlong)).contents.value,
+ MpvFormat.DOUBLE: lambda v: cast(v, POINTER(c_double)).contents.value,
+ MpvFormat.NODE: lambda v: cast(v, POINTER(MpvNode)).contents.node_value(decoder),
+ MpvFormat.NODE_ARRAY: lambda v: cast(v, POINTER(POINTER(MpvNodeList))).contents.contents.array_value(decoder),
+ MpvFormat.NODE_MAP: lambda v: cast(v, POINTER(POINTER(MpvNodeList))).contents.contents.dict_value(decoder),
+ MpvFormat.BYTE_ARRAY: lambda v: cast(v, POINTER(POINTER(MpvByteArray))).contents.contents.bytes_value(),
+ }[fmt](v)
MpvNodeList._fields_ = [('num', c_int),
('values', POINTER(MpvNode)),
('keys', POINTER(c_char_p))]
+class MpvSubApi(c_int):
+ MPV_SUB_API_OPENGL_CB = 1
+
class MpvEvent(Structure):
_fields_ = [('event_id', MpvEventID),
('error', c_int),
('reply_userdata', c_ulonglong),
- ('_data', c_void_p)]
-
- @property
- def data(self):
- dtype = {
- MpvEventID.GET_PROPERTY_REPLY: MpvEventProperty,
- MpvEventID.PROPERTY_CHANGE: MpvEventProperty,
- MpvEventID.LOG_MESSAGE: MpvEventLogMessage,
- MpvEventID.CLIENT_MESSAGE: MpvEventClientMessage,
- MpvEventID.START_FILE: MpvEventStartFile,
- MpvEventID.END_FILE: MpvEventEndFile,
- MpvEventID.HOOK: MpvEventHook,
- MpvEventID.COMMAND_REPLY: MpvEventCommand,
- }.get(self.event_id.value)
- return cast(self._data, POINTER(dtype)).contents if dtype else None
+ ('data', c_void_p)]
def as_dict(self, decoder=identity_decoder):
- out = cast(create_string_buffer(sizeof(MpvNode)), POINTER(MpvNode))
- _mpv_event_to_node(out, pointer(self))
- rv = out.contents.node_value(decoder=decoder)
- _mpv_free_node_contents(out)
- return rv
-
- def __str__(self):
- d = self.data
- return f'<{type(d).__name__} ({self.event_id.value}) err={self.error} p={self.reply_userdata:016x} d={self.as_dict()}>'
+ dtype = {MpvEventID.END_FILE: MpvEventEndFile,
+ MpvEventID.PROPERTY_CHANGE: MpvEventProperty,
+ MpvEventID.GET_PROPERTY_REPLY: MpvEventProperty,
+ MpvEventID.LOG_MESSAGE: MpvEventLogMessage,
+ MpvEventID.SCRIPT_INPUT_DISPATCH: MpvEventScriptInputDispatch,
+ MpvEventID.CLIENT_MESSAGE: MpvEventClientMessage
+ }.get(self.event_id.value, None)
+ return {'event_id': self.event_id.value,
+ 'error': self.error,
+ 'reply_userdata': self.reply_userdata,
+ 'event': cast(self.data, POINTER(dtype)).contents.as_dict(decoder=decoder) if dtype else None}
class MpvEventProperty(Structure):
- _fields_ = [('_name', c_char_p),
+ _fields_ = [('name', c_char_p),
('format', MpvFormat),
- ('data', MpvNodeUnion)]
-
- @property
- def name(self):
- return self._name.decode("utf-8")
-
- @property
- def value(self):
- return MpvNode.node_cast_value(self.data, self.format.value, decoder=lazy_decoder)
+ ('data', c_void_p)]
+ def as_dict(self, decoder=identity_decoder):
+ value = MpvNode.node_cast_value(self.data, self.format.value, decoder)
+ return {'name': self.name.decode('utf-8'),
+ 'format': self.format,
+ 'data': self.data,
+ 'value': value}
class MpvEventLogMessage(Structure):
- _fields_ = [('_prefix', c_char_p),
- ('_level', c_char_p),
- ('_text', c_char_p)]
+ _fields_ = [('prefix', c_char_p),
+ ('level', c_char_p),
+ ('text', c_char_p)]
- @property
- def prefix(self):
- return self._prefix.decode("utf-8")
+ def as_dict(self, decoder=identity_decoder):
+ return { 'prefix': self.prefix.decode('utf-8'),
+ 'level': self.level.decode('utf-8'),
+ 'text': decoder(self.text).rstrip() }
- @property
- def level(self):
- return self._level.decode("utf-8")
-
- @property
- def text(self):
- return lazy_decoder(self._text)
-
-class MpvEventEndFile(Structure):
- _fields_ = [
- ('reason', c_int),
- ('error', c_int),
- ('playlist_entry_id', c_ulonglong),
- ('playlist_insert_id', c_ulonglong),
- ('playlist_insert_num_entries', c_int),
- ]
-
- EOF = 0
+class MpvEventEndFile(c_int):
+ EOF_OR_INIT_FAILURE = 0
RESTARTED = 1
ABORTED = 2
QUIT = 3
- ERROR = 4
- REDIRECT = 5
-class MpvEventStartFile(Structure):
- _fields_ = [('playlist_entry_id', c_ulonglong),]
+ def as_dict(self, decoder=identity_decoder):
+ return {'reason': self.value}
+
+class MpvEventScriptInputDispatch(Structure):
+ _fields_ = [('arg0', c_int),
+ ('type', c_char_p)]
+
+ def as_dict(self, decoder=identity_decoder):
+ pass # TODO
class MpvEventClientMessage(Structure):
- _fields_ = [('_num_args', c_int),
- ('_args', POINTER(c_char_p))]
+ _fields_ = [('num_args', c_int),
+ ('args', POINTER(c_char_p))]
- @property
- def args(self):
- return [ self._args[i] for i in range(self._num_args) ]
-
-class MpvEventCommand(Structure):
- _fields_ = [('_result', MpvNode)]
-
- def unpack(self, decoder=identity_decoder):
- return self._result.node_value(decoder=decoder)
-
- @property
- def result(self):
- return self.unpack()
-
-class MpvEventHook(Structure):
- _fields_ = [('_name', c_char_p),
- ('id', c_ulonglong),]
-
-
- @property
- def name(self):
- return self._name.decode("utf-8")
-
-StreamReadFn = CFUNCTYPE(c_int64, c_void_p, POINTER(c_char), c_uint64)
-StreamSeekFn = CFUNCTYPE(c_int64, c_void_p, c_int64)
-StreamSizeFn = CFUNCTYPE(c_int64, c_void_p)
-StreamCloseFn = CFUNCTYPE(None, c_void_p)
-StreamCancelFn = CFUNCTYPE(None, c_void_p)
-
-class StreamCallbackInfo(Structure):
- _fields_ = [('cookie', c_void_p),
- ('read', StreamReadFn),
- ('seek', StreamSeekFn),
- ('size', StreamSizeFn),
- ('close', StreamCloseFn),
- ('cancel', StreamCancelFn)]
-
-StreamOpenFn = CFUNCTYPE(c_int, c_void_p, c_char_p, POINTER(StreamCallbackInfo))
+ def as_dict(self, decoder=identity_decoder):
+ return { 'args': [ self.args[i].decode('utf-8') for i in range(self.num_args) ] }
WakeupCallback = CFUNCTYPE(None, c_void_p)
-RenderUpdateFn = CFUNCTYPE(None, c_void_p)
+OpenGlCbUpdateFn = CFUNCTYPE(None, c_void_p)
+OpenGlCbGetProcAddrFn = CFUNCTYPE(None, c_void_p, c_char_p)
-def _handle_func(name, args, restype, errcheck, ctx=MpvHandle, deprecated=False):
+def _handle_func(name, args, restype, errcheck, ctx=MpvHandle):
func = getattr(backend, name)
func.argtypes = [ctx] + args if ctx else args
if restype is not None:
func.restype = restype
if errcheck is not None:
func.errcheck = errcheck
- if deprecated:
- @wraps(func)
- def wrapper(*args, **kwargs):
- if not wrapper.warned: # Only warn on first invocation to prevent spamming
- warn("Backend C api has been deprecated: " + name, DeprecationWarning, stacklevel=2)
- wrapper.warned = True
- return func(*args, **kwargs)
- wrapper.warned = False
-
- globals()['_'+name] = wrapper
- else:
- globals()['_'+name] = func
+ globals()['_'+name] = func
def bytes_free_errcheck(res, func, *args):
notnull_errcheck(res, func, *args)
@@ -556,16 +312,14 @@ def notnull_errcheck(res, func, *args):
ec_errcheck = ErrorCode.raise_for_ec
+def _handle_gl_func(name, args=[], restype=None):
+ _handle_func(name, args, restype, errcheck=None, ctx=MpvOpenGLCbContext)
+
backend.mpv_client_api_version.restype = c_ulong
def _mpv_client_api_version():
ver = backend.mpv_client_api_version()
return ver>>16, ver&0xFFFF
-MPV_VERSION = _mpv_client_api_version()
-if MPV_VERSION < (1, 108):
- ver = '.'.join(str(num) for num in MPV_VERSION)
- raise RuntimeError(f"python-mpv requires libmpv with an API version of 1.108 or higher (libmpv >= 0.33), but you have an older version ({ver}).")
-
backend.mpv_free.argtypes = [c_void_p]
_mpv_free = backend.mpv_free
@@ -576,10 +330,9 @@ backend.mpv_create.restype = MpvHandle
_mpv_create = backend.mpv_create
_handle_func('mpv_create_client', [c_char_p], MpvHandle, notnull_errcheck)
-_handle_func('mpv_create_weak_client', [c_char_p], MpvHandle, notnull_errcheck)
_handle_func('mpv_client_name', [], c_char_p, errcheck=None)
_handle_func('mpv_initialize', [], c_int, ec_errcheck)
-_handle_func('mpv_destroy', [], None, errcheck=None)
+_handle_func('mpv_detach_destroy', [], None, errcheck=None)
_handle_func('mpv_terminate_destroy', [], None, errcheck=None)
_handle_func('mpv_load_config_file', [c_char_p], c_int, ec_errcheck)
_handle_func('mpv_get_time_us', [], c_ulonglong, errcheck=None)
@@ -591,8 +344,7 @@ _handle_func('mpv_command', [POINTER(c_char_p)],
_handle_func('mpv_command_string', [c_char_p, c_char_p], c_int, ec_errcheck)
_handle_func('mpv_command_async', [c_ulonglong, POINTER(c_char_p)], c_int, ec_errcheck)
_handle_func('mpv_command_node', [POINTER(MpvNode), POINTER(MpvNode)], c_int, ec_errcheck)
-_handle_func('mpv_command_node_async', [c_ulonglong, POINTER(MpvNode)], c_int, ec_errcheck)
-_handle_func('mpv_abort_async_command', [c_ulonglong], None, errcheck=None)
+_handle_func('mpv_command_async', [c_ulonglong, POINTER(MpvNode)], c_int, ec_errcheck)
_handle_func('mpv_set_property', [c_char_p, MpvFormat, c_void_p], c_int, ec_errcheck)
_handle_func('mpv_set_property_string', [c_char_p, c_char_p], c_int, ec_errcheck)
@@ -605,7 +357,6 @@ _handle_func('mpv_observe_property', [c_ulonglong, c_char_p, MpvFormat],
_handle_func('mpv_unobserve_property', [c_ulonglong], c_int, ec_errcheck)
_handle_func('mpv_event_name', [c_int], c_char_p, errcheck=None, ctx=None)
-_handle_func('mpv_event_to_node', [POINTER(MpvNode), POINTER(MpvEvent)], c_int, ec_errcheck, ctx=None)
_handle_func('mpv_error_string', [c_int], c_char_p, errcheck=None, ctx=None)
_handle_func('mpv_request_event', [MpvEventID, c_int], c_int, ec_errcheck)
@@ -613,21 +364,20 @@ _handle_func('mpv_request_log_messages', [c_char_p],
_handle_func('mpv_wait_event', [c_double], POINTER(MpvEvent), errcheck=None)
_handle_func('mpv_wakeup', [], None, errcheck=None)
_handle_func('mpv_set_wakeup_callback', [WakeupCallback, c_void_p], None, errcheck=None)
+_handle_func('mpv_get_wakeup_pipe', [], c_int, errcheck=None)
-_handle_func('mpv_stream_cb_add_ro', [c_char_p, c_void_p, StreamOpenFn], c_int, ec_errcheck)
+_handle_func('mpv_get_sub_api', [MpvSubApi], c_void_p, notnull_errcheck)
-_handle_func('mpv_render_context_create', [MpvRenderCtxHandle, MpvHandle, POINTER(MpvRenderParam)], c_int, ec_errcheck, ctx=None)
-_handle_func('mpv_render_context_set_parameter', [MpvRenderParam], c_int, ec_errcheck, ctx=MpvRenderCtxHandle)
-_handle_func('mpv_render_context_get_info', [MpvRenderParam], c_int, ec_errcheck, ctx=MpvRenderCtxHandle)
-_handle_func('mpv_render_context_set_update_callback', [RenderUpdateFn, c_void_p], None, errcheck=None, ctx=MpvRenderCtxHandle)
-_handle_func('mpv_render_context_update', [], c_int64, errcheck=None, ctx=MpvRenderCtxHandle)
-_handle_func('mpv_render_context_render', [POINTER(MpvRenderParam)], c_int, ec_errcheck, ctx=MpvRenderCtxHandle)
-_handle_func('mpv_render_context_report_swap', [], None, errcheck=None, ctx=MpvRenderCtxHandle)
-_handle_func('mpv_render_context_free', [], None, errcheck=None, ctx=MpvRenderCtxHandle)
+_handle_gl_func('mpv_opengl_cb_set_update_callback', [OpenGlCbUpdateFn, c_void_p])
+_handle_gl_func('mpv_opengl_cb_init_gl', [c_char_p, OpenGlCbGetProcAddrFn, c_void_p], c_int)
+_handle_gl_func('mpv_opengl_cb_draw', [c_int, c_int, c_int], c_int)
+_handle_gl_func('mpv_opengl_cb_render', [c_int, c_int], c_int)
+_handle_gl_func('mpv_opengl_cb_report_flip', [c_ulonglong], c_int)
+_handle_gl_func('mpv_opengl_cb_uninit_gl', [], c_int)
def _mpv_coax_proptype(value, proptype=str):
- """Intelligently coax the given python value into something that can be understood as a proptype property."""
+ """ Intelligently coax the given python value into something that can be understood as a proptype property """
if type(value) is bytes:
return value;
elif type(value) is bool:
@@ -638,9 +388,17 @@ def _mpv_coax_proptype(value, proptype=str):
raise TypeError('Cannot coax value of type {} into property type {}'.format(type(value), proptype))
def _make_node_str_list(l):
- """Take a list of python objects and make a MPV string node array from it.
+ """ Take a list of python objects and make a MPV string node array from it.
- As an example, the python list ``l = [ "foo", 23, false ]`` will result in the following MPV node object::
+ As an example, the following python list:
+
+ .. code:: python
+
+ l = [ "foo", 23, false ]
+
+ will result in the following MPV node object:
+
+ .. code::
struct mpv_node {
.format = MPV_NODE_ARRAY,
@@ -654,6 +412,7 @@ def _make_node_str_list(l):
}
}
}
+
"""
char_ps = [ c_char_p(_mpv_coax_proptype(e, str)) for e in l ]
node_list = MpvNodeList(
@@ -661,26 +420,11 @@ def _make_node_str_list(l):
keys=None,
values=( MpvNode * len(l))( *[ MpvNode(
format=MpvFormat.STRING,
- val=MpvNodeUnion(string=p))
+ val=cast(pointer(p), POINTER(c_longlong)).contents) # NOTE: ctypes is kinda crappy here
for p in char_ps ]))
node = MpvNode(
format=MpvFormat.NODE_ARRAY,
- val=MpvNodeUnion(list=pointer(node_list)))
- return char_ps, node_list, node, cast(pointer(node), c_void_p)
-
-def _make_node_str_map(d):
- """Take a dict of python objects and make a MPV string node map from it. """
- char_ps = [ (c_char_p(k.encode('utf-8')), c_char_p(_mpv_coax_proptype(v, str))) for k, v in d.items() ]
- node_list = MpvNodeList(
- num=len(d),
- keys=( c_char_p * len(d))( *[k for k, v in char_ps] ),
- values=( MpvNode * len(d))( *[ MpvNode(
- format=MpvFormat.STRING,
- val=MpvNodeUnion(string=v))
- for k, v in char_ps ]))
- node = MpvNode(
- format=MpvFormat.NODE_MAP,
- val=MpvNodeUnion(map=pointer(node_list)))
+ val=addressof(node_list))
return char_ps, node_list, node, cast(pointer(node), c_void_p)
@@ -692,17 +436,39 @@ def _event_generator(handle):
yield event
-def _create_null_term_cmd_arg_array(name, args):
- args = [name.encode('utf-8')] + [(arg if type(arg) is bytes else str(arg).encode('utf-8'))
- for arg in args if arg is not None] + [None]
- return (c_char_p * len(args))(*args)
+def _event_loop(event_handle, playback_cond, event_callbacks, message_handlers, property_handlers, log_handler):
+ for event in _event_generator(event_handle):
+ try:
+ devent = event.as_dict(decoder=lazy_decoder) # copy data from ctypes
+ eid = devent['event_id']
+ for callback in event_callbacks:
+ callback(devent)
+ if eid in (MpvEventID.SHUTDOWN, MpvEventID.END_FILE):
+ with playback_cond:
+ playback_cond.notify_all()
+ if eid == MpvEventID.PROPERTY_CHANGE:
+ pc = devent['event']
+ name, value, _fmt = pc['name'], pc['value'], pc['format']
+ for handler in property_handlers[name]:
+ handler(name, value)
+ if eid == MpvEventID.LOG_MESSAGE and log_handler is not None:
+ ev = devent['event']
+ log_handler(ev['level'], ev['prefix'], ev['text'])
+ if eid == MpvEventID.CLIENT_MESSAGE:
+ # {'event': {'args': ['key-binding', 'foo', 'u-', 'g']}, 'reply_userdata': 0, 'error': 0, 'event_id': 16}
+ target, *args = devent['event']['args']
+ if target in message_handlers:
+ message_handlers[target](*args)
+ if eid == MpvEventID.SHUTDOWN:
+ _mpv_detach_destroy(event_handle)
+ return
+ except Exception as e:
+ traceback.print_exc()
_py_to_mpv = lambda name: name.replace('_', '-')
_mpv_to_py = lambda name: name.replace('-', '_')
-_drop_nones = lambda *args: [ arg for arg in args if arg is not None ]
-
class _Proxy:
def __init__(self, mpv):
super().__setattr__('mpv', mpv)
@@ -739,138 +505,30 @@ class _DecoderPropertyProxy(_PropertyProxy):
def __setattr__(self, name, value):
setattr(self.mpv, _py_to_mpv(name), value)
-class GeneratorStream:
- """Transform a python generator into an mpv-compatible stream object. The total size of the file can be indicated to
- mpv using the size argument to __init__. Seeking is not supported.
- """
-
- def __init__(self, generator_fun, size=None):
- self._generator_fun = generator_fun
- self.size = size
-
- def seek(self, offset):
- self._read_iter = iter(self._generator_fun())
- self._read_chunk = b''
- return 0 # We only support seeking to the first byte atm
- # implementation in case seeking to arbitrary offsets would be necessary
- # while offset > 0:
- # offset -= len(self.read(offset))
- # return offset
-
- def read(self, size):
- if not self._read_chunk:
- try:
- self._read_chunk += next(self._read_iter)
- except StopIteration:
- return b''
- rv, self._read_chunk = self._read_chunk[:size], self._read_chunk[size:]
- return rv
-
- def close(self):
- self._read_iter = iter([]) # make next read() call return EOF
-
- def cancel(self):
- self._read_iter = iter([]) # make next read() call return EOF
-
-
-class ImageOverlay:
- def __init__(self, m, overlay_id, img=None, pos=(0, 0)):
- self.m = m
- self.overlay_id = overlay_id
- self.pos = pos
- self._size = None
- if img is not None:
- self.update(img)
-
- def update(self, img=None, pos=None):
- from PIL import Image
- if img is not None:
- self.img = img
- img = self.img
-
- w, h = img.size
- stride = w*4
-
- if pos is not None:
- self.pos = pos
- x, y = self.pos
-
- # Pre-multiply alpha channel
- bg = Image.new('RGBA', (w, h), (0, 0, 0, 0))
- out = Image.alpha_composite(bg, img)
-
- # Copy image to ctypes buffer
- if img.size != self._size:
- self._buf = create_string_buffer(w*h*4)
- self._size = img.size
-
- ctypes.memmove(self._buf, out.tobytes('raw', 'BGRA'), w*h*4)
- source = '&' + str(addressof(self._buf))
-
- self.m.overlay_add(self.overlay_id, x, y, source, 0, 'bgra', w, h, stride)
-
- def remove(self):
- self.m.remove_overlay(self.overlay_id)
-
-
-class FileOverlay:
- def __init__(self, m, overlay_id, filename=None, size=None, stride=None, pos=(0,0)):
- self.m = m
- self.overlay_id = overlay_id
- self.pos = pos
- self.size = size
- self.stride = stride
- if filename is not None:
- self.update(filename)
-
- def update(self, filename=None, size=None, stride=None, pos=None):
- if filename is not None:
- self.filename = filename
-
- if pos is not None:
- self.pos = pos
-
- if size is not None:
- self.size = size
-
- if stride is not None:
- self.stride = stride
-
- x, y = self.pos
- w, h = self.size
- stride = self.stride or 4*w
-
- self.m.overlay_add(self, self.overlay_id, x, y, self.filename, 0, 'bgra', w, h, stride)
-
- def remove(self):
- self.m.remove_overlay(self.overlay_id)
-
-
class MPV(object):
- """See man mpv(1) for the details of the implemented commands. All mpv properties can be accessed as
- ``my_mpv.some_property`` and all mpv options can be accessed as ``my_mpv['some-option']``.
+ """ See man mpv(1) for the details of the implemented commands. All mpv
+ properties can be accessed as ```my_mpv.some_property``` and all mpv
+ options can be accessed as ```my_mpv['some-option']```.
- By default, properties are returned as decoded ``str`` and an error is thrown if the value does not contain valid
- utf-8. To get a decoded ``str`` if possibly but ``bytes`` instead of an error if not, use
- ``my_mpv.lazy.some_property``. To always get raw ``bytes``, use ``my_mpv.raw.some_property``. To access a
- property's decoded OSD value, use ``my_mpv.osd.some_property``.
+ By default, properties are returned as decoded ```str``` and an error is thrown if the value does not contain valid
+ utf-8. To get a decoded ```str``` if possibly but ```bytes``` instead of an error if not, use
+ ```my_mpv.lazy.some_property```. To always get raw ```bytes```, use ```my_mpv.raw.some_property```. To access a
+ property's decoded OSD value, use ```my_mpv.osd.some_property```.
- To get API information on an option, use ``my_mpv.option_info('option-name')``. To get API information on a
- property, use ``my_mpv.properties['property-name']``. Take care to use mpv's dashed-names instead of the
+ To get API information on an option, use ```my_mpv.option_info('option-name')```. To get API information on a
+ property, use ```my_mpv.properties['property-name']```. Take care to use mpv's dashed-names instead of the
underscore_names exposed on the python object.
- To make your program not barf hard the first time its used on a weird file system **always** access properties
- containing file names or file tags through ``MPV.raw``. """
-
+ To make your program not barf hard the first time its used on a weird file system **always access properties
+ containing file names or file tags through ```MPV.raw```.
+ """
def __init__(self, *extra_mpv_flags, log_handler=None, start_event_thread=True, loglevel=None, **extra_mpv_opts):
- """Create an MPV instance.
+ """ Create an MPV instance.
- Extra arguments and extra keyword arguments will be passed to mpv as options.
- """
+ Extra arguments and extra keyword arguments will be passed to mpv as options. """
self.handle = _mpv_create()
self._event_thread = None
- self._core_shutdown = False
_mpv_set_option_string(self.handle, b'audio-display', b'no')
istr = lambda o: ('yes' if o else 'no') if type(o) is bool else str(o)
@@ -889,692 +547,251 @@ class MPV(object):
self.lazy = _DecoderPropertyProxy(self, lazy_decoder)
self._event_callbacks = []
- self._command_reply_callbacks = {}
- self._event_handler_lock = threading.Lock()
self._property_handlers = collections.defaultdict(lambda: [])
- self._quit_handlers = set()
self._message_handlers = {}
self._key_binding_handlers = {}
+ self._playback_cond = threading.Condition()
self._event_handle = _mpv_create_client(self.handle, b'py_event_handler')
- self._log_handler = log_handler
- self._stream_protocol_cbs = {}
- self._stream_protocol_frontends = collections.defaultdict(lambda: {})
- self.register_stream_protocol('python', self._python_stream_open)
- self._python_streams = {}
- self._python_stream_catchall = None
- self._exception_futures = set()
- self.overlay_ids = set()
- self.overlays = {}
+ self._loop = partial(_event_loop, self._event_handle, self._playback_cond, self._event_callbacks,
+ self._message_handlers, self._property_handlers, log_handler)
if loglevel is not None or log_handler is not None:
self.set_loglevel(loglevel or 'terminal-default')
if start_event_thread:
self._event_thread = threading.Thread(target=self._loop, name='MPVEventHandlerThread')
- self._event_thread.daemon = True
+ self._event_thread.setDaemon(True)
self._event_thread.start()
else:
self._event_thread = None
- if (m := re.search(r'(\d+)\.(\d+)\.(\d+)', self.mpv_version)):
- self.mpv_version_tuple = tuple(map(int, m.groups()))
- @contextmanager
- def _enqueue_exceptions(self):
- try:
- yield
- except Exception as e:
- for fut in self._exception_futures:
- try:
- fut.set_exception(e)
- break
- except InvalidStateError:
- pass
- else:
- warn(f'Unhandled exception on python-mpv event loop: {e}\n{traceback.format_exc()}', RuntimeWarning)
-
- def _loop(self):
- for event in _event_generator(self._event_handle):
- try:
- eid = event.event_id.value
-
- with self._event_handler_lock:
- if eid == MpvEventID.SHUTDOWN:
- self._core_shutdown = True
-
- for callback in self._event_callbacks:
- with self._enqueue_exceptions():
- callback(event)
-
- if eid == MpvEventID.PROPERTY_CHANGE:
- pc = event.data
- name, value, _fmt = pc.name, pc.value, pc.format
- for handler in self._property_handlers[name]:
- with self._enqueue_exceptions():
- handler(name, value)
-
- if eid == MpvEventID.LOG_MESSAGE and self._log_handler is not None:
- ev = event.data
- with self._enqueue_exceptions():
- self._log_handler(ev.level, ev.prefix, ev.text)
-
- if eid == MpvEventID.CLIENT_MESSAGE:
- # {'event': {'args': ['key-binding', 'foo', 'u-', 'g']}, 'reply_userdata': 0, 'error': 0, 'event_id': 16}
- target, *args = event.data.args
- target = target.decode("utf-8")
- if target in self._message_handlers:
- with self._enqueue_exceptions():
- self._message_handlers[target](*args)
-
- if eid == MpvEventID.COMMAND_REPLY:
- key = event.reply_userdata
- callback = self._command_reply_callbacks.pop(key, None)
- if callback:
- with self._enqueue_exceptions():
- callback(ErrorCode.exception_for_ec(event.error), event.data)
-
- if eid == MpvEventID.QUEUE_OVERFLOW:
- # cache list, since error handlers will unregister themselves
- for cb in list(self._command_reply_callbacks.values()):
- with self._enqueue_exceptions():
- cb(EventOverflowError('libmpv event queue has flown over because events have not been processed fast enough'), None)
-
- if eid == MpvEventID.SHUTDOWN:
- _mpv_destroy(self._event_handle)
- for cb in list(self._command_reply_callbacks.values()):
- with self._enqueue_exceptions():
- cb(ShutdownError('libmpv core has been shutdown'), None)
- return
-
- except Exception as e:
- warn(f'Unhandled {e} inside python-mpv event loop!\n{traceback.format_exc()}', RuntimeWarning)
-
- @property
- def core_shutdown(self):
- """Property indicating whether the core has been shut down. Possible causes for this are e.g. the `quit` command
- or a user closing the mpv window."""
- return self._core_shutdown
-
- def check_core_alive(self):
- """ This method can be used as a sanity check to tests whether the core is still alive at the time it is
- called."""
- if self._core_shutdown:
- raise ShutdownError('libmpv core has been shutdown')
-
- def wait_until_paused(self, timeout=None, catch_errors=True):
- """Waits until playback of the current title is paused or done. Raises a ShutdownError if the core is shutdown while
- waiting."""
- self.wait_for_property('core-idle', timeout=timeout, catch_errors=catch_errors)
-
- def wait_for_playback(self, timeout=None, catch_errors=True):
- """Waits until playback of the current title is finished. Raises a ShutdownError if the core is shutdown while
- waiting.
- """
- self.wait_for_event('end_file', timeout=timeout, catch_errors=catch_errors)
-
- def wait_until_playing(self, timeout=None, catch_errors=True):
- """Waits until playback of the current title has started. Raises a ShutdownError if the core is shutdown while
- waiting."""
- self.wait_for_property('core-idle', lambda idle: not idle, timeout=timeout, catch_errors=catch_errors)
-
- def wait_for_property(self, name, cond=lambda val: val, level_sensitive=True, timeout=None, catch_errors=True):
- """Waits until ``cond`` evaluates to a truthy value on the named property. This can be used to wait for
- properties such as ``idle_active`` indicating the player is done with regular playback and just idling around.
- Raises a ShutdownError when the core is shutdown while waiting.
- """
- with self.prepare_and_wait_for_property(name, cond, level_sensitive, timeout=timeout, catch_errors=catch_errors) as result:
- pass
- return result.result()
-
- def wait_for_shutdown(self, timeout=None, catch_errors=True):
- '''Wait for core to shutdown (e.g. through quit() or terminate()).'''
- try:
- self.wait_for_event(None, timeout=timeout, catch_errors=catch_errors)
- except ShutdownError:
- return
-
- def _set_error_handler(self, future):
- @self.event_callback('shutdown', 'queue-overflow')
- def shutdown_handler(event):
- nonlocal future
- try:
- if event.event_id.value == MpvEventID.SHUTDOWN:
- future.set_exception(ShutdownError('libmpv core has been shutdown'))
- else:
- future.set_exception(EventOverflowError('libmpv event queue has flown over because events have not been processed fast enough'))
- except InvalidStateError:
- pass
- return shutdown_handler.unregister_mpv_events
-
- @contextmanager
- def prepare_and_wait_for_property(self, name, cond=lambda val: val, level_sensitive=True, timeout=None, catch_errors=True):
- """Context manager that waits until ``cond`` evaluates to a truthy value on the named property. See
- prepare_and_wait_for_event for usage.
- Raises a ShutdownError when the core is shutdown while waiting. Re-raises any errors inside ``cond``.
- """
- result = Future()
+ def wait_for_playback(self):
+ """ Waits until playback of the current title is paused or done """
+ with self._playback_cond:
+ self._playback_cond.wait()
+ def wait_for_property(self, name, cond=lambda val: val, level_sensitive=True):
+ """ Waits until ```cond``` evaluates to a truthy value on the named
+ property. This can be used to wait for properties such as
+ ```idle_active``` indicating the player is done with regular playback
+ and just idling around """
+ sema = threading.Semaphore(value=0)
def observer(name, val):
- try:
- rv = cond(val)
- if rv:
- result.set_result(rv)
-
- except InvalidStateError:
- pass
-
- except Exception as e:
- try:
- result.set_exception(e)
- except:
- pass
-
- try:
- result.set_running_or_notify_cancel()
-
- self.observe_property(name, observer)
- err_unregister = self._set_error_handler(result)
- if catch_errors:
- self._exception_futures.add(result)
-
- yield result
-
- if level_sensitive:
- rv = cond(getattr(self, name.replace('-', '_')))
- if rv:
- result.set_result(rv)
- return
-
- self.check_core_alive()
- result.result(timeout)
-
- except InvalidStateError:
- pass
-
- finally:
- err_unregister()
- self.unobserve_property(name, observer)
- self._exception_futures.discard(result)
-
- def wait_for_event(self, *event_types, cond=lambda evt: True, timeout=None, catch_errors=True):
- """Waits for the indicated event(s). If cond is given, waits until cond(event) is true. Raises a ShutdownError
- if the core is shutdown while waiting. This also happens when 'shutdown' is in event_types. Re-raises any error
- inside ``cond``.
- """
- with self.prepare_and_wait_for_event(*event_types, cond=cond, timeout=timeout, catch_errors=catch_errors) as result:
- pass
- return result.result()
-
- @contextmanager
- def prepare_and_wait_for_event(self, *event_types, cond=lambda evt: True, timeout=None, catch_errors=True):
- """Context manager that waits for the indicated event(s) like wait_for_event after running. If cond is given,
- waits until cond(event) is true. Raises a ShutdownError if the core is shutdown while waiting. This also happens
- when 'shutdown' is in event_types. Re-raises any error inside ``cond``.
-
- Compared to wait_for_event this handles the case where a thread waits for an event it itself causes in a
- thread-safe way. An example from the testsuite is:
-
- with self.m.prepare_and_wait_for_event('client_message'):
- self.m.keypress(key)
-
- Using just wait_for_event it would be impossible to ensure the event is caught since it may already have been
- handled in the interval between keypress(...) running and a subsequent wait_for_event(...) call.
- """
- result = Future()
-
- @self.event_callback(*event_types)
- def target_handler(evt):
- try:
- rv = cond(evt)
- if rv:
- result.set_result(rv)
- except Exception as e:
- try:
- result.set_exception(e)
- except InvalidStateError:
- pass
- except InvalidStateError:
- pass
-
- err_unregister = self._set_error_handler(result)
-
- try:
- result.set_running_or_notify_cancel()
- if catch_errors:
- self._exception_futures.add(result)
-
- yield result
-
- self.check_core_alive()
- result.result(timeout)
-
- finally:
- err_unregister()
- target_handler.unregister_mpv_events()
- self._exception_futures.discard(result)
+ if cond(val):
+ sema.release()
+ self.observe_property(name, observer)
+ if not level_sensitive or not cond(getattr(self, name.replace('-', '_'))):
+ sema.acquire()
+ self.unobserve_property(name, observer)
def __del__(self):
if self.handle:
self.terminate()
def terminate(self):
- """Properly terminates this player instance. Preferably use this instead of relying on python's garbage
- collector to cause this to be called from the object's destructor.
-
- This method will detach the main libmpv handle and wait for mpv to shut down and the event thread to finish.
- """
+ """ Pröperly terminates this player instance. Preferably use this
+ instead of relying on python's garbage collector to cause this to be
+ called from the object's destructor. """
self.handle, handle = None, self.handle
if threading.current_thread() is self._event_thread:
- raise UserWarning('terminate() should not be called from event thread (e.g. from a callback function). If '
- 'you want to terminate mpv from here, please call quit() instead, then sync the main thread '
- 'against the event thread using e.g. wait_for_shutdown(), then terminate() from the main thread. '
- 'This call has been transformed into a call to quit().')
- self.quit()
+ # Handle special case to allow event handle to be detached.
+ # This is necessary since otherwise the event thread would deadlock itself.
+ grim_reaper = threading.Thread(target=lambda: _mpv_terminate_destroy(handle))
+ grim_reaper.start()
else:
_mpv_terminate_destroy(handle)
if self._event_thread:
self._event_thread.join()
def set_loglevel(self, level):
- """Set MPV's log level. This adjusts which output will be sent to this object's log handlers. If you just want
- mpv's regular terminal output, you don't need to adjust this but just need to pass a log handler to the MPV
- constructur such as ``MPV(log_handler=print)``.
+ """ Set MPV's log level. This adjusts which output will be sent to this
+ object's log handlers. If you just want mpv's regular terminal output,
+ you don't need to adjust this but just need to pass a log handler to
+ the MPV constructur such as ```MPV(log_handler=print)```.
- Valid log levels are "no", "fatal", "error", "warn", "info", "v" "debug" and "trace". For details see your mpv's
- client.h header file.
- """
+ Valid log levels are "no", "fatal", "error", "warn", "info", "v"
+ "debug" and "trace". For details see your mpv's client.h header file """
_mpv_request_log_messages(self._event_handle, level.encode('utf-8'))
- def string_command(self, name, *args):
- """Execute a raw command."""
- args = _create_null_term_cmd_arg_array(name, args)
- _mpv_command(self.handle, args)
-
- def command_async(self, name, *args, callback=None, decoder=lazy_decoder, **kwargs):
- """Same as mpv_command, but run the command asynchronously. If you provide a callback, that callback will be
- called after completion or on error. This method returns a future that evaluates to the result of the callback
- (if given), and the result of the libmpv call otherwise.
-
- Usage example:
-
- future = player.command_async(...)
- try:
- print('The result was', future.result())
- except Exception as e:
- print('mpv returned an error:', e)
- """
-
- future = Future()
- future.set_running_or_notify_cancel()
-
- if callback is None:
- def callback(error, result):
- if error:
- raise error
- return result
-
- def wrapper(error, result):
- try:
- result = result.unpack(decoder)
- future.set_result(callback(error, result))
- except Exception as e:
- try:
- future.set_exception(e)
- except InvalidStateError:
- pass
-
- def abort():
- _mpv_abort_async_command(self._event_handle, id(future))
- del self._command_reply_callbacks[id(future)]
- future.cancel = abort
-
- self._command_reply_callbacks[id(future)] = wrapper
-
- if kwargs:
- if args:
- raise ValueError('Can only call mpv commands either using positional or using named arguments, not a mix of both.')
- kwargs['name'] = name
- _1, _2, _3, pointer = _make_node_str_map(kwargs)
- else:
- _1, _2, _3, pointer = _make_node_str_list([name, *args])
-
- ppointer = cast(pointer, POINTER(MpvNode))
- _mpv_command_node_async(self._event_handle, id(future), ppointer)
- return future
-
+ def command(self, name, *args):
+ """ Execute a raw command """
+ args = [name.encode('utf-8')] + [ (arg if type(arg) is bytes else str(arg).encode('utf-8'))
+ for arg in args if arg is not None ] + [None]
+ _mpv_command(self.handle, (c_char_p*len(args))(*args))
def node_command(self, name, *args, decoder=strict_decoder):
- self.command(name, *args, decoder=decoder)
-
- def command(self, name, *args, decoder=strict_decoder, **kwargs):
- if kwargs:
- if args:
- raise ValueError('Can only call mpv commands either using positional or using named arguments, not a mix of both.')
- kwargs['name'] = name
- _1, _2, _3, pointer = _make_node_str_map(kwargs)
- else:
- _1, _2, _3, pointer = _make_node_str_list([name, *args])
-
+ _1, _2, _3, pointer = _make_node_str_list([name, *args])
out = cast(create_string_buffer(sizeof(MpvNode)), POINTER(MpvNode))
+ outptr = out #byref(out)
ppointer = cast(pointer, POINTER(MpvNode))
- _mpv_command_node(self.handle, ppointer, out)
- rv = out.contents.node_value(decoder=decoder)
- _mpv_free_node_contents(out)
+ _mpv_command_node(self.handle, ppointer, outptr)
+ rv = MpvNode.node_cast_value(outptr, MpvFormat.NODE, decoder)
+ _mpv_free_node_contents(outptr)
return rv
- def seek(self, amount, reference="relative", precision="keyframes"):
- """Mapped mpv seek command, see man mpv(1)."""
+ def seek(self, amount, reference="relative", precision="default-precise"):
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('seek', amount, reference, precision)
def revert_seek(self):
- """Mapped mpv revert_seek command, see man mpv(1)."""
+ """ Mapped mpv revert_seek command, see man mpv(1). """
self.command('revert_seek');
def frame_step(self):
- """Mapped mpv frame-step command, see man mpv(1)."""
- self.command('frame-step')
+ """ Mapped mpv frame_step command, see man mpv(1). """
+ self.command('frame_step')
def frame_back_step(self):
- """Mapped mpv frame_back_step command, see man mpv(1)."""
+ """ Mapped mpv frame_back_step command, see man mpv(1). """
self.command('frame_back_step')
- def property_add(self, name, value=1):
- """Add the given value to the property's value. On overflow or underflow, clamp the property to the maximum. If
- ``value`` is omitted, assume ``1``.
- """
- self.command('add', name, value)
+ def _add_property(self, name, value=None):
+ self.command('add_property', name, value)
- def property_multiply(self, name, factor):
- """Multiply the value of a property with a numeric factor."""
- self.command('multiply', name, factor)
+ def _cycle_property(self, name, direction='up'):
+ self.command('cycle_property', name, direction)
- def cycle(self, name, direction='up'):
- """Cycle the given property. ``up`` and ``down`` set the cycle direction. On overflow, set the property back to
- the minimum, on underflow set it to the maximum. If ``up`` or ``down`` is omitted, assume ``up``.
- """
- self.command('cycle', name, direction)
+ def _multiply_property(self, name, factor):
+ self.command('multiply_property', name, factor)
def screenshot(self, includes='subtitles', mode='single'):
- """Mapped mpv screenshot command, see man mpv(1)."""
+ """ Mapped mpv screenshot command, see man mpv(1). """
self.command('screenshot', includes, mode)
def screenshot_to_file(self, filename, includes='subtitles'):
- """Mapped mpv screenshot_to_file command, see man mpv(1)."""
+ """ Mapped mpv screenshot_to_file command, see man mpv(1). """
self.command('screenshot_to_file', filename.encode(fs_enc), includes)
def screenshot_raw(self, includes='subtitles'):
- """Mapped mpv screenshot_raw command, see man mpv(1). Returns a pillow Image object."""
+ """ Mapped mpv screenshot_raw command, see man mpv(1). Returns a pillow Image object."""
from PIL import Image
- res = self.command('screenshot-raw', includes)
+ res = self.node_command('screenshot-raw', includes)
if res['format'] != 'bgr0':
raise ValueError('Screenshot in unknown format "{}". Currently, only bgr0 is supported.'
.format(res['format']))
- img = Image.frombytes('RGBA', (res['stride']//4, res['h']), res['data'])
+ img = Image.frombytes('RGBA', (res['w'], res['h']), res['data'])
b,g,r,a = img.split()
return Image.merge('RGB', (r,g,b))
- def allocate_overlay_id(self):
- free_ids = set(range(64)) - self.overlay_ids
- if not free_ids:
- raise IndexError('All overlay IDs are in use')
- next_id, *_ = sorted(free_ids)
- self.overlay_ids.add(next_id)
- return next_id
-
- def free_overlay_id(self, overlay_id):
- self.overlay_ids.remove(overlay_id)
-
- def create_file_overlay(self, filename=None, size=None, stride=None, pos=(0,0)):
- overlay_id = self.allocate_overlay_id()
- overlay = FileOverlay(self, overlay_id, filename, size, stride, pos)
- self.overlays[overlay_id] = overlay
- return overlay
-
- def create_image_overlay(self, img=None, pos=(0,0)):
- overlay_id = self.allocate_overlay_id()
- overlay = ImageOverlay(self, overlay_id, img, pos)
- self.overlays[overlay_id] = overlay
- return overlay
-
- def remove_overlay(self, overlay_id):
- self.overlay_remove(overlay_id)
- self.free_overlay_id(overlay_id)
- del self.overlays[overlay_id]
-
def playlist_next(self, mode='weak'):
- """Mapped mpv playlist_next command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('playlist_next', mode)
def playlist_prev(self, mode='weak'):
- """Mapped mpv playlist_prev command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('playlist_prev', mode)
- def playlist_play_index(self, idx):
- """Mapped mpv playlist-play-index command, see man mpv(1)."""
- self.command('playlist-play-index', idx)
-
@staticmethod
def _encode_options(options):
- return ','.join('{}={}'.format(_py_to_mpv(str(key)), str(val)) for key, val in options.items())
+ return ','.join('{}={}'.format(str(key), str(val)) for key, val in options.items())
- def loadfile(self, filename, mode='replace', index=None, **options):
- """Mapped mpv loadfile command, see man mpv(1)."""
- if self.mpv_version_tuple >= (0, 38, 0):
- if index is None:
- index = -1
- self.command('loadfile', filename.encode(fs_enc), mode, index, MPV._encode_options(options))
- else:
- if index is not None:
- warn(f'The index argument to the loadfile command is only supported on mpv >= 0.38.0')
- self.command('loadfile', filename.encode(fs_enc), mode, MPV._encode_options(options))
+ def loadfile(self, filename, mode='replace', **options):
+ """ Mapped mpv seek command, see man mpv(1). """
+ self.command('loadfile', filename.encode(fs_enc), mode, MPV._encode_options(options))
def loadlist(self, playlist, mode='replace'):
- """Mapped mpv loadlist command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('loadlist', playlist.encode(fs_enc), mode)
def playlist_clear(self):
- """Mapped mpv playlist_clear command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('playlist_clear')
def playlist_remove(self, index='current'):
- """Mapped mpv playlist_remove command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('playlist_remove', index)
def playlist_move(self, index1, index2):
- """Mapped mpv playlist_move command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('playlist_move', index1, index2)
- def playlist_shuffle(self):
- """Mapped mpv playlist-shuffle command, see man mpv(1)."""
- self.command('playlist-shuffle')
-
- def playlist_unshuffle(self):
- """Mapped mpv playlist-unshuffle command, see man mpv(1)."""
- self.command('playlist-unshuffle')
-
def run(self, command, *args):
- """Mapped mpv run command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('run', command, *args)
def quit(self, code=None):
- """Mapped mpv quit command, see man mpv(1)."""
- if code is not None:
- self.command('quit', code)
- else:
- self.command('quit')
+ """ Mapped mpv seek command, see man mpv(1). """
+ self.command('quit', code)
def quit_watch_later(self, code=None):
- """Mapped mpv quit_watch_later command, see man mpv(1)."""
- if code is not None:
- self.command('quit_watch_later', code)
- else:
- self.command('quit_watch_later')
+ """ Mapped mpv seek command, see man mpv(1). """
+ self.command('quit_watch_later', code)
- def stop(self, keep_playlist=False):
- """Mapped mpv stop command, see man mpv(1)."""
- if keep_playlist:
- self.command('stop', 'keep-playlist')
- else:
- self.command('stop')
-
- def audio_add(self, url, flags='select', title=None, lang=None):
- """Mapped mpv audio_add command, see man mpv(1)."""
- self.command('audio_add', url.encode(fs_enc), *_drop_nones(flags, title, lang))
-
- def audio_remove(self, audio_id=None):
- """Mapped mpv audio_remove command, see man mpv(1)."""
- self.command('audio_remove', audio_id)
-
- def audio_reload(self, audio_id=None):
- """Mapped mpv audio_reload command, see man mpv(1)."""
- self.command('audio_reload', audio_id)
-
- def video_add(self, url, flags='select', title=None, lang=None, albumart=None):
- """Mapped mpv video_add command, see man mpv(1)."""
- self.command('video_add', url.encode(fs_enc), *_drop_nones(flags, title, lang, albumart))
-
- def video_remove(self, video_id=None):
- """Mapped mpv video_remove command, see man mpv(1)."""
- self.command('video_remove', video_id)
-
- def video_reload(self, video_id=None):
- """Mapped mpv video_reload command, see man mpv(1)."""
- self.command('video_reload', video_id)
-
- def sub_add(self, url, flags='select', title=None, lang=None):
- """Mapped mpv sub_add command, see man mpv(1)."""
- self.command('sub_add', url.encode(fs_enc), *_drop_nones(flags, title, lang))
+ def sub_add(self, filename):
+ """ Mapped mpv seek command, see man mpv(1). """
+ self.command('sub_add', filename.encode(fs_enc))
def sub_remove(self, sub_id=None):
- """Mapped mpv sub_remove command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('sub_remove', sub_id)
def sub_reload(self, sub_id=None):
- """Mapped mpv sub_reload command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('sub_reload', sub_id)
def sub_step(self, skip):
- """Mapped mpv sub_step command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('sub_step', skip)
def sub_seek(self, skip):
- """Mapped mpv sub_seek command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('sub_seek', skip)
def toggle_osd(self):
- """Mapped mpv osd command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('osd')
- def print_text(self, text):
- """Mapped mpv print-text command, see man mpv(1)."""
- self.command('print-text', text)
-
- def show_text(self, string, duration='-1', level=0):
- """Mapped mpv show_text command, see man mpv(1)."""
+ def show_text(self, string, duration='-', level=None):
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('show_text', string, duration, level)
- def expand_text(self, text):
- """Mapped mpv expand-text command, see man mpv(1)."""
- return self.command('expand-text', text)
-
- def expand_path(self, path):
- """Mapped mpv expand-path command, see man mpv(1)."""
- return self.command('expand-path', path)
-
def show_progress(self):
- """Mapped mpv show_progress command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('show_progress')
- def rescan_external_files(self, mode='reselect'):
- """Mapped mpv rescan-external-files command, see man mpv(1)."""
- self.command('rescan-external-files', mode)
-
def discnav(self, command):
- """Mapped mpv discnav command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('discnav', command)
- def mouse(self, x, y, button=None, mode='single'):
- """Mapped mpv mouse command, see man mpv(1)."""
- if button is None:
- self.command('mouse', x, y, mode)
- else:
- self.command('mouse', x, y, button, mode)
-
- def keypress(self, name):
- """Mapped mpv keypress command, see man mpv(1)."""
- self.command('keypress', name)
-
- def keydown(self, name):
- """Mapped mpv keydown command, see man mpv(1)."""
- self.command('keydown', name)
-
- def keyup(self, name=None):
- """Mapped mpv keyup command, see man mpv(1)."""
- if name is None:
- self.command('keyup')
- else:
- self.command('keyup', name)
-
- def keybind(self, name, command):
- """Mapped mpv keybind command, see man mpv(1)."""
- self.command('keybind', name, command)
-
def write_watch_later_config(self):
- """Mapped mpv write_watch_later_config command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('write_watch_later_config')
def overlay_add(self, overlay_id, x, y, file_or_fd, offset, fmt, w, h, stride):
- """Mapped mpv overlay_add command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('overlay_add', overlay_id, x, y, file_or_fd, offset, fmt, w, h, stride)
def overlay_remove(self, overlay_id):
- """Mapped mpv overlay_remove command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('overlay_remove', overlay_id)
- def osd_overlay(self, overlay_id, data, res_x=0, res_y=720, z=0, hidden=False):
- self.command('osd_overlay', id=overlay_id, data=data, res_x=res_x, res_y=res_y, z=z, hidden=hidden,
- format='ass-events')
-
- def osd_overlay_remove(self, overlay_id):
- self.command('osd_overlay', id=overlay_id, format='none')
-
def script_message(self, *args):
- """Mapped mpv script_message command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('script_message', *args)
def script_message_to(self, target, *args):
- """Mapped mpv script_message_to command, see man mpv(1)."""
+ """ Mapped mpv seek command, see man mpv(1). """
self.command('script_message_to', target, *args)
- def drop_buffers(self):
- self.command('drop_buffers')
-
- def vf_command(self, label, command, argument):
- self.command('vf_command', label, command, argument)
-
- def af_command(self, label, command, argument):
- self.command('af_command', label, command, argument)
-
def observe_property(self, name, handler):
- """Register an observer on the named property. An observer is a function that is called with the new property
- value every time the property's value is changed. The basic function signature is ``fun(property_name,
- new_value)`` with new_value being the decoded property value as a python object. This function can be used as a
+ """ Register an observer on the named property. An observer is a function that is called with the new property
+ value every time the property's value is changed. The basic function signature is ```fun(property_name,
+ new_value)``` with new_value being the decoded property value as a python object. This function can be used as a
function decorator if no handler is given.
- To unregister the observer, call either of ``mpv.unobserve_property(name, handler)``,
- ``mpv.unobserve_all_properties(handler)`` or the handler's ``unobserve_mpv_properties`` attribute::
+ To uunregister the observer, call either of ```mpv.unobserve_property(name, handler)```,
+ ```mpv.unobserve_all_properties(handler)``` or the handler's ```unregister_mpv_properties``` attribute:
- @player.property_observer('volume')
- def my_handler(property_name, new_volume):
- print("It's loud!", new_volume)
+ ```
+ @player.observe_property('volume')
+ def my_handler(new_volume, *):
+ print("It's loud!", volume)
- my_handler.unobserve_mpv_properties()
-
- exit_handler is a function taking no arguments that is called when the underlying mpv handle is terminated (e.g.
- from calling MPV.terminate() or issuing a "quit" input command).
- """
+ my_handler.unregister_mpv_properties()
+ ``` """
self._property_handlers[name].append(handler)
_mpv_observe_property(self._event_handle, hash(name)&0xffffffffffffffff, name.encode('utf-8'), MpvFormat.NODE)
def property_observer(self, name):
- """Function decorator to register a property observer. See ``MPV.observe_property`` for details."""
+ """ Function decorator to register a property observer. See ```MPV.observe_property``` for details. """
def wrapper(fun):
self.observe_property(name, fun)
fun.unobserve_mpv_properties = lambda: self.unobserve_property(name, fun)
@@ -1582,45 +799,44 @@ class MPV(object):
return wrapper
def unobserve_property(self, name, handler):
- """Unregister a property observer. This requires both the observed property's name and the handler function that
- was originally registered as one handler could be registered for several properties. To unregister a handler
- from *all* observed properties see ``unobserve_all_properties``.
- """
+ """ Unregister a property observer. This requires both the observed property's name and the handler function
+ that was originally registered as one handler could be registered for several properties. To unregister a
+ handler from *all* observed properties see ```unobserve_all_properties```. """
self._property_handlers[name].remove(handler)
if not self._property_handlers[name]:
_mpv_unobserve_property(self._event_handle, hash(name)&0xffffffffffffffff)
def unobserve_all_properties(self, handler):
- """Unregister a property observer from *all* observed properties."""
+ """ Unregister a property observer from *all* observed properties. """
for name in self._property_handlers:
self.unobserve_property(name, handler)
def register_message_handler(self, target, handler=None):
- """Register a mpv script message handler. This can be used to communicate with embedded lua scripts. Pass the
+ """ Register a mpv script message handler. This can be used to communicate with embedded lua scripts. Pass the
script message target name this handler should be listening to and the handler function.
WARNING: Only one handler can be registered at a time for any given target.
- To unregister the message handler, call its ``unregister_mpv_messages`` function::
+ To unregister the message handler, call its unregister_mpv_messages function:
- player = mpv.MPV()
- @player.message_handler('foo')
- def my_handler(some, args):
- print(args)
+ ```
+ player = mpv.MPV()
+ @player.message_handler('foo')
+ def my_handler(some, args):
+ print(args)
- my_handler.unregister_mpv_messages()
- """
+ my_handler.unregister_mpv_messages()
+ ``` """
self._register_message_handler_internal(target, handler)
def _register_message_handler_internal(self, target, handler):
self._message_handlers[target] = handler
def unregister_message_handler(self, target_or_handler):
- """Unregister a mpv script message handler for the given script message target name.
+ """ Unregister a mpv script message handler for the given script message target name.
- You can also call the ``unregister_mpv_messages`` function attribute set on the handler function when it is
- registered.
- """
+ You can also call the ```unregister_mpv_messages``` function attribute set on the handler function when it is
+ registered. """
if isinstance(target_or_handler, str):
del self._message_handlers[target_or_handler]
else:
@@ -1629,18 +845,19 @@ class MPV(object):
del self._message_handlers[key]
def message_handler(self, target):
- """Decorator to register a mpv script message handler.
+ """ Decorator to register a mpv script message handler.
WARNING: Only one handler can be registered at a time for any given target.
- To unregister the message handler, call its ``unregister_mpv_messages`` function::
+ To unregister the message handler, call its unregister_mpv_messages function:
- player = mpv.MPV()
- @player.message_handler('foo')
- def my_handler(some, args):
- print(args)
+ ```
+ player = mpv.MPV()
+ @player.message_handler('foo')
+ def my_handler(some, args):
+ print(args)
- my_handler.unregister_mpv_messages()
+ my_handler.unregister_mpv_messages()
"""
def register(handler):
self._register_message_handler_internal(target, handler)
@@ -1649,115 +866,115 @@ class MPV(object):
return register
def register_event_callback(self, callback):
- """Register a blanket event callback receiving all event types.
+ """ Register a blanket event callback receiving all event types.
- To unregister the event callback, call its ``unregister_mpv_events`` function::
+ To unregister the event callback, call its unregister_mpv_events function:
- player = mpv.MPV()
- @player.event_callback('shutdown')
- def my_handler(event):
- print('It ded.')
+ ```
+ player = mpv.MPV()
+ @player.event_callback('shutdown')
+ def my_handler(event):
+ print('It ded.')
- my_handler.unregister_mpv_events()
+ my_handler.unregister_mpv_events()
"""
self._event_callbacks.append(callback)
def unregister_event_callback(self, callback):
- """Unregiser an event callback."""
+ """ Unregiser an event callback. """
self._event_callbacks.remove(callback)
def event_callback(self, *event_types):
- """Function decorator to register a blanket event callback for the given event types. Event types can be given
+ """ Function decorator to register a blanket event callback for the given event types. Event types can be given
as str (e.g. 'start-file'), integer or MpvEventID object.
WARNING: Due to the way this is filtering events, this decorator cannot be chained with itself.
- To unregister the event callback, call its ``unregister_mpv_events`` function::
+ To unregister the event callback, call its unregister_mpv_events function:
- player = mpv.MPV()
- @player.event_callback('shutdown')
- def my_handler(event):
- print('It ded.')
+ ```
+ player = mpv.MPV()
+ @player.event_callback('shutdown')
+ def my_handler(event):
+ print('It ded.')
- my_handler.unregister_mpv_events()
+ my_handler.unregister_mpv_events()
"""
def register(callback):
- with self._event_handler_lock:
- self.check_core_alive()
- types = [MpvEventID.from_str(t) if isinstance(t, str) else t for t in event_types] or MpvEventID.ANY
- @wraps(callback)
- def wrapper(event, *args, **kwargs):
- if event.event_id.value in types:
- callback(event, *args, **kwargs)
- self._event_callbacks.append(wrapper)
- wrapper.unregister_mpv_events = partial(self.unregister_event_callback, wrapper)
- return wrapper
+ types = [MpvEventID.from_str(t) if isinstance(t, str) else t for t in event_types] or MpvEventID.ANY
+ @wraps(callback)
+ def wrapper(event, *args, **kwargs):
+ if event['event_id'] in types:
+ callback(event, *args, **kwargs)
+ self._event_callbacks.append(wrapper)
+ wrapper.unregister_mpv_events = partial(self.unregister_event_callback, wrapper)
+ return wrapper
return register
@staticmethod
def _binding_name(callback_or_cmd):
return 'py_kb_{:016x}'.format(hash(callback_or_cmd)&0xffffffffffffffff)
- def on_key_press(self, keydef, mode='force', repetition=False):
- """Function decorator to register a simplified key binding. The callback is called whenever the key given is
- *pressed*. When the ``repetition=True`` is passed, the callback is called again repeatedly while the key is held
- down.
+ def on_key_press(self, keydef, mode='force'):
+ """ Function decorator to register a simplified key binding. The callback is called whenever the key
+ given is *pressed*.
- To unregister the callback function, you can call its ``unregister_mpv_key_bindings`` attribute::
+ To unregister the callback function, you can call its ```unregister_mpv_key_bindings``` attribute:
- player = mpv.MPV()
- @player.on_key_press('Q')
- def binding():
- print('blep')
+ ```
+ player = mpv.MPV()
+ @player.on_key_press('Q')
+ def binding():
+ print('blep')
- binding.unregister_mpv_key_bindings()
+ binding.unregister_mpv_key_bindings()
+ ```
WARNING: For a single keydef only a single callback/command can be registered at the same time. If you register
a binding multiple times older bindings will be overwritten and there is a possibility of references leaking. So
don't do that.
- The BIG FAT WARNING regarding untrusted keydefs from the key_binding method applies here as well.
- """
+ The BIG FAT WARNING regarding untrusted keydefs from the key_binding method applies here as well. """
+
def register(fun):
@self.key_binding(keydef, mode)
@wraps(fun)
- def wrapper(state='p-', name=None, char=None, *_):
- if state[0] in ('d', 'p') or (repetition and state[0] == 'r'):
+ def wrapper(state='p-', name=None):
+ if state[0] in ('d', 'p'):
fun()
return wrapper
return register
def key_binding(self, keydef, mode='force'):
- """Function decorator to register a low-level key binding.
+ """ Function decorator to register a low-level key binding.
- The callback function signature is ``fun(key_state, key_name, key_char, scale, arg)``.
+ The callback function signature is ```fun(key_state, key_name)``` where ```key_state``` is either ```'U'``` for
+ "key up" or ```'D'``` for "key down".
- The key_state contains up to three chars, corresponding to the regex ``[udr]([m-][c-]?)?``. ``[udr]`` means
- "key up", "key down", or "repetition" for when the key is held down. "m" indicates mouse events, and "c"
- indicates key up events resulting from a logical cancellation. For details check out the mpv man page.
+ The keydef format is: ```[Shift+][Ctrl+][Alt+][Meta+]``` where `````` is either the literal character
+ the key produces (ASCII or Unicode character), or a symbolic name (as printed by ```mpv --input-keylist```)
- The keydef format is: ``[Shift+][Ctrl+][Alt+][Meta+]`` where ```` is either the literal character the
- key produces (ASCII or Unicode character), or a symbolic name (as printed by ``mpv --input-keylist``).
+ To unregister the callback function, you can call its ```unregister_mpv_key_bindings``` attribute:
- To unregister the callback function, you can call its ``unregister_mpv_key_bindings`` attribute::
+ ```
+ player = mpv.MPV()
+ @player.key_binding('Q')
+ def binding(state, name):
+ print('blep')
- player = mpv.MPV()
- @player.key_binding('Q')
- def binding(state, name, char):
- print('blep')
-
- binding.unregister_mpv_key_bindings()
+ binding.unregister_mpv_key_bindings()
+ ```
WARNING: For a single keydef only a single callback/command can be registered at the same time. If you register
a binding multiple times older bindings will be overwritten and there is a possibility of references leaking. So
don't do that.
- BIG FAT WARNING: mpv's key binding mechanism is pretty powerful. This means, you essentially get arbitrary code
- exectution through key bindings. This interface makes some limited effort to sanitize the keydef given in the
- first parameter, but YOU SHOULD NOT RELY ON THIS IN FOR SECURITY. If your input comes from config files, this is
- completely fine--but, if you are about to pass untrusted input into this parameter, better double-check whether
- this is secure in your case.
- """
+ BIG FAT WARNING: mpv's key binding mechanism is pretty powerful. This means, you essentially get arbitrary
+ code exectution through key bindings. This interface makes some limited effort to sanitize the keydef given in
+ the first parameter, but YOU SHOULD NOT RELY ON THIS IN FOR SECURITY. If your input comes from config files,
+ this is completely fine--but, if you are about to pass untrusted input into this parameter, better double-check
+ whether this is secure in your case. """
+
def register(fun):
fun.mpv_key_bindings = getattr(fun, 'mpv_key_bindings', []) + [keydef]
def unregister_all():
@@ -1770,9 +987,8 @@ class MPV(object):
return register
def register_key_binding(self, keydef, callback_or_cmd, mode='force'):
- """Register a key binding. This takes an mpv keydef and either a string containing a mpv command or a python
- callback function. See ``MPV.key_binding`` for details.
- """
+ """ Register a key binding. This takes an mpv keydef and either a string containing a mpv
+ command or a python callback function. See ```MPV.key_binding``` for details. """
if not re.match(r'(Shift+)?(Ctrl+)?(Alt+)?(Meta+)?(.|\w+)', keydef):
raise ValueError('Invalid keydef. Expected format: [Shift+][Ctrl+][Alt+][Meta+]\n'
' is either the literal character the key produces (ASCII or Unicode character), or a '
@@ -1789,15 +1005,11 @@ class MPV(object):
raise TypeError('register_key_binding expects either an str with an mpv command or a python callable.')
self.command('enable-section', binding_name, 'allow-hide-cursor+allow-vo-dragging')
- def _handle_key_binding_message(self, binding_name, key_state, key_name=None, key_char=None, scale=None, arg=None, *_):
- binding_name = binding_name.decode('utf-8')
- key_state = key_state.decode('utf-8')
- key_name = key_name.decode('utf-8') if key_name is not None else None
- key_char = key_char.decode('utf-8') if key_char is not None else None
- self._key_binding_handlers[binding_name](key_state, key_name, key_char, scale, arg)
+ def _handle_key_binding_message(self, binding_name, key_state, key_name):
+ self._key_binding_handlers[binding_name](key_state, key_name)
def unregister_key_binding(self, keydef):
- """Unregister a key binding by keydef."""
+ """ Unregister a key binding by keydef """
binding_name = MPV._binding_name(keydef)
self.command('disable-section', binding_name)
self.command('define-section', binding_name, '')
@@ -1806,307 +1018,37 @@ class MPV(object):
if not self._key_binding_handlers:
self.unregister_message_handler('key-binding')
- def register_stream_protocol(self, proto, open_fn=None):
- """ Register a custom stream protocol as documented in libmpv/stream_cb.h:
- https://github.com/mpv-player/mpv/blob/master/libmpv/stream_cb.h
-
- proto is the protocol scheme, e.g. "foo" for "foo://" urls.
-
- This function can either be used with two parameters or it can be used as a decorator on the target
- function.
-
- open_fn is a function taking an URI string and returning an mpv stream object.
- open_fn may raise a ValueError to signal libmpv the URI could not be opened.
-
- The mpv stream protocol is as follows:
- class Stream:
- @property
- def size(self):
- return None # unknown size
- return size # int with size in bytes
-
- def read(self, size):
- ...
- return read # non-empty bytes object with input
- return b'' # empty byte object signals permanent EOF
-
- def seek(self, pos): # optional
- return new_offset # integer with new byte offset. The new offset may be before the requested offset
- in case an exact seek is inconvenient.
-
- def close(self): # optional
- ...
-
- def cancel(self): # optional
- Abort a running read() or seek() operation
- ...
-
- """
-
- def decorator(open_fn):
- @StreamOpenFn
- def open_backend(_userdata, uri, cb_info):
- try:
- frontend = open_fn(uri.decode('utf-8'))
- except ValueError:
- return ErrorCode.LOADING_FAILED
- except Exception as e:
- for fut in self._exception_futures:
- try:
- fut.set_exception(e)
- break
- except InvalidStateError:
- pass
- else:
- warnings.warn(f'Unhandled exception {e} inside stream open callback for URI {uri}\n{traceback.format_exc()}')
- return ErrorCode.LOADING_FAILED
-
- cb_info.contents.cookie = None
-
- def read_backend(_userdata, buf, bufsize):
- with self._enqueue_exceptions():
- data = frontend.read(bufsize)
- for i in range(len(data)):
- buf[i] = data[i]
- return len(data)
- return -1
- read = cb_info.contents.read = StreamReadFn(read_backend)
-
- def close_backend(_userdata):
- with self._enqueue_exceptions():
- del self._stream_protocol_frontends[proto][uri]
- if hasattr(frontend, 'close'):
- frontend.close()
- close = cb_info.contents.close = StreamCloseFn(close_backend)
-
- seek, size, cancel = None, None, None
-
- if hasattr(frontend, 'seek'):
- def seek_backend(_userdata, offx):
- with self._enqueue_exceptions():
- return frontend.seek(offx)
- return ErrorCode.GENERIC
- seek = cb_info.contents.seek = StreamSeekFn(seek_backend)
-
- if hasattr(frontend, 'size') and frontend.size is not None:
- def size_backend(_userdata):
- with self._enqueue_exceptions():
- return frontend.size
- return 0
- size = cb_info.contents.size = StreamSizeFn(size_backend)
-
- if hasattr(frontend, 'cancel'):
- def cancel_backend(_userdata):
- with self._enqueue_exceptions():
- frontend.cancel()
- cancel = cb_info.contents.cancel = StreamCancelFn(cancel_backend)
-
- # keep frontend and callbacks in memory until closed
- frontend._registered_callbacks = [read, close, seek, size, cancel]
- self._stream_protocol_frontends[proto][uri] = frontend
- return 0
-
- if proto in self._stream_protocol_cbs:
- raise KeyError('Stream protocol already registered')
- # keep backend in memory forever
- self._stream_protocol_cbs[proto] = [open_backend]
- _mpv_stream_cb_add_ro(self.handle, proto.encode('utf-8'), c_void_p(), open_backend)
-
- return open_fn
-
- if open_fn is not None:
- decorator(open_fn)
- return decorator
-
# Convenience functions
def play(self, filename):
- """Play a path or URL (requires ``ytdl`` option to be set)."""
+ """ Play a path or URL (requires ```ytdl``` option to be set) """
self.loadfile(filename)
@property
def playlist_filenames(self):
- """Return all playlist item file names/URLs as a list of strs."""
+ """ Return all playlist item file names/URLs as a list of strs """
return [element['filename'] for element in self.playlist]
def playlist_append(self, filename, **options):
- """Append a path or URL to the playlist. This does not start playing the file automatically. To do that, use
- ``MPV.loadfile(filename, 'append-play')``."""
+ """ Append a path or URL to the playlist. This does not start playing the file automatically. To do that, use
+ ```MPV.loadfile(filename, 'append-play')```. """
self.loadfile(filename, 'append', **options)
- # "Python stream" logic. This is some porcelain for directly playing data from python generators.
-
- def _python_stream_open(self, uri):
- """Internal handler for python:// protocol streams registered through @python_stream(...) and
- @python_stream_catchall
- """
- name, = re.fullmatch('python://(.*)', uri).groups()
-
- if name in self._python_streams:
- generator_fun, size = self._python_streams[name]
- else:
- if self._python_stream_catchall is not None:
- generator_fun, size = self._python_stream_catchall(name)
- else:
- raise ValueError('Python stream name not found and no catch-all defined')
-
- return GeneratorStream(generator_fun, size)
-
- def python_stream(self, name=None, size=None):
- """Register a generator for the python stream with the given name.
-
- name is the name, i.e. the part after the "python://" in the URI, that this generator is registered as.
- size is the total number of bytes in the stream (if known).
-
- Any given name can only be registered once. The catch-all can also only be registered once. To unregister a
- stream, call the .unregister function set on the callback.
-
- If name is None (the default), a name and corresponding python:// URI are automatically generated. You can
- access the name through the .stream_name property set on the callback, and the stream URI for passing into
- mpv.play(...) through the .stream_uri property.
-
- The generator signals EOF by returning, manually raising StopIteration or by yielding b'', an empty bytes
- object.
-
- The generator may be called multiple times if libmpv seeks or loops.
-
- See also: @mpv.python_stream_catchall
-
- @mpv.python_stream('foobar')
- def reader():
- for chunk in chunks:
- yield chunk
- mpv.play('python://foobar')
- mpv.wait_for_playback()
- reader.unregister()
- """
- def register(cb):
- nonlocal name
- if name is None:
- name = f'__python_mpv_anonymous_python_stream_{id(cb)}__'
-
- if name in self._python_streams:
- raise KeyError('Python stream name "{}" is already registered'.format(name))
-
- self._python_streams[name] = (cb, size)
- def unregister():
- if name not in self._python_streams or\
- self._python_streams[name][0] is not cb: # This is just a basic sanity check
- raise RuntimeError('Python stream has already been unregistered')
- del self._python_streams[name]
-
- cb.unregister = unregister
- cb.stream_name = name
- cb.stream_uri = f'python://{name}'
- return cb
-
- return register
-
- @contextmanager
- def play_context(self):
- """ Context manager for streaming bytes straight into libmpv.
-
- This is a convenience wrapper around python_stream. play_context returns a write method, which you can use in
- the body of the context manager to feed libmpv bytes. All bytes you feed in with write() in the body of a single
- call of this context manager are treated as one single file. A queue is used internally, so this function is
- thread-safe. The queue is unlimited, so it cannot block and is safe to call from async code. You can use this
- function to stream chunked data, e.g. from the network.
-
- Use it like this:
-
- with m.play_context() as write:
- with open(TESTVID, 'rb') as f:
- while (chunk := f.read(65536)): # Get some chunks of bytes
- write(chunk)
- """
- q = queue.Queue()
-
- EOF = object() # Get some unique object as EOF marker
- @self.python_stream()
- def reader():
- while (chunk := q.get()) is not EOF:
- if chunk:
- yield chunk
- reader.unregister()
-
- def write(chunk):
- q.put(chunk)
-
- # Start playback before yielding, the first call to reader() will block until write is called at least once.
- self.play(reader.stream_uri)
- yield write
- q.put(EOF)
-
- def play_bytes(self, data):
- """ Play the given bytes object as a single file. """
-
- @self.python_stream()
- def reader():
- yield data
- reader.unregister() # unregister itself
-
- self.play(reader.stream_uri)
-
- def python_stream_catchall(self, cb):
- """ Register a catch-all python stream to be called when no name matches can be found. Use this decorator on a
- function that takes a name argument and returns a (generator, size) tuple (with size being None if unknown).
-
- An invalid URI can be signalled to libmpv by raising a ValueError inside the callback.
-
- See also: @mpv.python_stream(name, size)
-
- @mpv.python_stream_catchall
- def catchall(name):
- if not name.startswith('foo'):
- raise ValueError('Unknown Name')
-
- def foo_reader():
- with open(name, 'rb') as f:
- while True:
- chunk = f.read(1024)
- if not chunk:
- break
- yield chunk
- return foo_reader, None
- mpv.play('python://foo23')
- mpv.wait_for_playback()
- catchall.unregister()
- """
- if self._python_stream_catchall is not None:
- raise KeyError('A catch-all python stream is already registered')
-
- self._python_stream_catchall = cb
- def unregister():
- if self._python_stream_catchall is not cb:
- raise RuntimeError('This catch-all python stream has already been unregistered')
- self._python_stream_catchall = None
- cb.unregister = unregister
- return cb
-
# Property accessors
def _get_property(self, name, decoder=strict_decoder, fmt=MpvFormat.NODE):
- self.check_core_alive()
- out = create_string_buffer(sizeof(MpvNode))
+ out = cast(create_string_buffer(sizeof(c_void_p)), c_void_p)
+ outptr = byref(out)
try:
- cval = _mpv_get_property(self.handle, name.encode('utf-8'), fmt, out)
-
- if fmt is MpvFormat.OSD_STRING:
- return cast(out, POINTER(c_char_p)).contents.value.decode('utf-8')
- elif fmt is MpvFormat.NODE:
- rv = cast(out, POINTER(MpvNode)).contents.node_value(decoder=decoder)
- _mpv_free_node_contents(out)
- return rv
- else:
- raise TypeError('_get_property only supports NODE and OSD_STRING formats.')
+ cval = _mpv_get_property(self.handle, name.encode('utf-8'), fmt, outptr)
+ rv = MpvNode.node_cast_value(outptr, fmt, decoder)
+ if fmt is MpvFormat.NODE:
+ _mpv_free_node_contents(outptr)
+ return rv
except PropertyUnavailableError as ex:
return None
def _set_property(self, name, value):
- self.check_core_alive()
ename = name.encode('utf-8')
- if isinstance(value, dict):
- _1, _2, _3, pointer = _make_node_str_map(value)
- _mpv_set_property(self.handle, ename, MpvFormat.NODE, pointer)
- elif isinstance(value, (list, set)):
+ if isinstance(value, (list, set, dict)):
_1, _2, _3, pointer = _make_node_str_list(value)
_mpv_set_property(self.handle, ename, MpvFormat.NODE, pointer)
else:
@@ -2133,74 +1075,23 @@ class MPV(object):
# Dict-like option access
def __getitem__(self, name, file_local=False):
- """Get an option value."""
+ """ Get an option value """
prefix = 'file-local-options/' if file_local else 'options/'
return self._get_property(prefix+name, lazy_decoder)
def __setitem__(self, name, value, file_local=False):
- """Set an option value."""
+ """ Set an option value """
prefix = 'file-local-options/' if file_local else 'options/'
return self._set_property(prefix+name, value)
def __iter__(self):
- """Iterate over all option names."""
+ """ Iterate over all option names """
return iter(self.options)
def option_info(self, name):
- """Get information on the given option."""
+ """ Get information on the given option """
try:
return self._get_property('option-info/'+name)
except AttributeError:
return None
-
-class MpvRenderContext:
- def __init__(self, mpv, api_type, **kwargs):
- self._mpv = mpv
- kwargs['api_type'] = api_type
-
- buf = cast(create_string_buffer(sizeof(MpvRenderCtxHandle)), POINTER(MpvRenderCtxHandle))
- _mpv_render_context_create(buf, mpv.handle, kwargs_to_render_param_array(kwargs))
- self._handle = buf.contents
-
- def free(self):
- _mpv_render_context_free(self._handle)
-
- def __setattr__(self, name, value):
- if name.startswith('_'):
- super().__setattr__(name, value)
-
- elif name == 'update_cb':
- func = value if value else (lambda: None)
- self._update_cb = value
- self._update_fn_wrapper = RenderUpdateFn(lambda _userdata: func())
- _mpv_render_context_set_update_callback(self._handle, self._update_fn_wrapper, None)
-
- else:
- param = MpvRenderParam(name, value)
- _mpv_render_context_set_parameter(self._handle, param)
-
- def __getattr__(self, name):
- if name == 'update_cb':
- return self._update_cb
-
- elif name == 'handle':
- return self._handle
-
- param = MpvRenderParam(name)
- data_type = type(param.data.contents)
- buf = cast(create_string_buffer(sizeof(data_type)), POINTER(data_type))
- param.data = buf
- _mpv_render_context_get_info(self._handle, param)
- return buf.contents.as_dict()
-
- def update(self):
- """ Calls mpv_render_context_update and returns the MPV_RENDER_UPDATE_FRAME flag (see render.h) """
- return bool(_mpv_render_context_update(self._handle) & 1)
-
- def render(self, **kwargs):
- _mpv_render_context_render(self._handle, kwargs_to_render_param_array(kwargs))
-
- def report_swap(self):
- _mpv_render_context_report_swap(self._handle)
-
diff --git a/pyproject.toml b/pyproject.toml
deleted file mode 100644
index f68661e..0000000
--- a/pyproject.toml
+++ /dev/null
@@ -1,39 +0,0 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools]
-py-modules = ['mpv']
-
-[project]
-name = "mpv"
-version = "v1.0.8"
-description = "A python interface to the mpv media player"
-readme = "README.rst"
-authors = [{name = "jaseg", email = "mpv@jaseg.de"}]
-license = {text = "GPLv2+ or LGPLv2.1+"}
-requires-python = ">=3.9"
-keywords = ['mpv', 'library', 'video', 'audio', 'player', 'display', 'multimedia']
-classifiers = [
- 'Development Status :: 5 - Production/Stable',
- 'Environment :: X11 Applications',
- 'Intended Audience :: Developers',
- 'License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)',
- 'License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)',
- 'Natural Language :: English',
- 'Operating System :: POSIX',
- 'Programming Language :: C',
- 'Programming Language :: Python :: 3.9',
- 'Programming Language :: Python :: 3.10',
- 'Programming Language :: Python :: 3.11',
- 'Programming Language :: Python :: 3.12',
- 'Topic :: Multimedia :: Sound/Audio :: Players',
- 'Topic :: Multimedia :: Video :: Display'
-]
-
-[project.urls]
-homepage = "https://github.com/jaseg/python-mpv"
-
-[project.optional-dependencies]
-screenshot_raw = ["Pillow"]
-test = ['PyVirtualDisplay']
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..5aef279
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.rst
diff --git a/setup.py b/setup.py
new file mode 100755
index 0000000..fd9c58d
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+from setuptools import setup
+setup(
+ name = 'python-mpv',
+ version = '0.3.4',
+ py_modules = ['mpv'],
+ description = 'A python interface to the mpv media player',
+ url = 'https://github.com/jaseg/python-mpv',
+ author = 'jaseg',
+ author_email = 'github@jaseg.net',
+ license = 'AGPLv3+',
+ extras_require = {
+ 'screenshot_raw': ['Pillow']
+ },
+ keywords = ['mpv', 'library', 'video', 'audio', 'player', 'display',
+ 'multimedia'],
+ classifiers = [
+ 'Development Status :: 4 - Beta',
+ 'Environment :: Win32 (MS Windows)',
+ 'Environment :: X11 Applications',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
+ 'Natural Language :: English',
+ 'Operating System :: Microsoft :: Windows',
+ 'Operating System :: POSIX',
+ 'Programming Language :: C',
+ 'Programming Language :: Python :: 3.6',
+ 'Programming Language :: Python :: 3.5',
+ 'Topic :: Multimedia :: Sound/Audio :: Players',
+ 'Topic :: Multimedia :: Video :: Display']
+)
diff --git a/tests/test.webm b/test.webm
similarity index 100%
rename from tests/test.webm
rename to test.webm
diff --git a/tests/__init__.py b/tests/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/tests/requirements.txt b/tests/requirements.txt
deleted file mode 100644
index eabe145..0000000
--- a/tests/requirements.txt
+++ /dev/null
@@ -1 +0,0 @@
-PyVirtualDisplay>=3.0
diff --git a/tests/sub_test.srt b/tests/sub_test.srt
deleted file mode 100644
index e6f36e0..0000000
--- a/tests/sub_test.srt
+++ /dev/null
@@ -1,9 +0,0 @@
-1
-00:00:00,500 --> 00:00:01,000
-This is
-a subtitle test.
-
-2
-00:00:01,000 --> 00:00:02,000
-This is the second subtitle line.
-
diff --git a/tests/test_mpv.py b/tests/test_mpv.py
deleted file mode 100755
index 9c42332..0000000
--- a/tests/test_mpv.py
+++ /dev/null
@@ -1,993 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# vim: ts=4 sw=4 et
-#
-# Python MPV library module
-# Copyright (C) 2017-2022 Sebastian Götte
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
-# License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
-# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not, write to the Free
-# Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-#
-
-import unittest
-from unittest import mock
-import threading
-from contextlib import contextmanager
-import os.path
-import os
-import time
-from concurrent.futures import Future, InvalidStateError
-
-os.environ["PATH"] = os.path.dirname(__file__) + os.pathsep + os.environ["PATH"]
-
-import mpv
-
-
-if os.name == 'nt':
- Display = mock.Mock()
- testvo='gpu'
-
-else:
- from pyvirtualdisplay import Display
- testvo='x11'
-
-
-TESTVID = os.path.join(os.path.dirname(__file__), 'test.webm')
-TESTSRT = os.path.join(os.path.dirname(__file__), 'sub_test.srt')
-MPV_ERRORS = [ l(ec) for ec, l in mpv.ErrorCode.EXCEPTION_DICT.items() if l ]
-SKIP_TESTS = os.environ.get('PY_MPV_SKIP_TESTS', '').split()
-
-
-def timed_print():
- start_time = time.time()
- def do_print(level, prefix, text):
- td = time.time() - start_time
- print('{:.3f} [{}] {}: {}'.format(td, level, prefix, text.strip()), flush=True)
- return do_print
-
-
-class MpvTestCase(unittest.TestCase):
- def setUp(self):
- self.disp = Display()
- self.disp.start()
- self.m = mpv.MPV(vo=testvo, loglevel='debug', log_handler=timed_print())
-
- def tearDown(self):
- self.m.terminate()
- self.disp.stop()
-
-
-class TestProperties(MpvTestCase):
- @contextmanager
- def swallow_mpv_errors(self, exception_exceptions=[]):
- try:
- yield
- except Exception as e:
- if any(e.args[:2] == ex.args for ex in MPV_ERRORS):
- if e.args[1] not in exception_exceptions:
- raise
- else:
- raise
-
- def test_read(self):
- self.m.loop = 'inf'
- self.m.play(TESTVID)
- while self.m.core_idle:
- time.sleep(0.05)
- for name in sorted(self.m.property_list):
- name = name.replace('-', '_')
- with self.subTest(property_name=name), self.swallow_mpv_errors([
- mpv.ErrorCode.PROPERTY_UNAVAILABLE,
- mpv.ErrorCode.PROPERTY_ERROR,
- mpv.ErrorCode.PROPERTY_NOT_FOUND]):
- getattr(self.m, name)
-
- def test_write(self):
- self.m.loop = 'inf'
- self.m.play(TESTVID)
- while self.m.core_idle:
- time.sleep(0.05)
- check_canaries = lambda: os.path.exists('100') or os.path.exists('foo')
- for name in sorted(self.m.property_list):
- # See issue #108 and upstream mpv issues #7919 and #7920.
- if name in ('demuxer', 'audio-demuxer', 'audio-files'):
- continue
- # These may cause files to be created
- if name in ('external-file', 'heartbeat-cmd', 'wid', 'dump-stats', 'log-file') or name.startswith('input-'):
- continue
- # Caues segmentation faults on wayland
- if name in ('current-window-scale',):
- continue
- name = name.replace('-', '_')
- old_canaries = check_canaries()
- with self.subTest(property_name=name), self.swallow_mpv_errors([
- mpv.ErrorCode.PROPERTY_UNAVAILABLE,
- mpv.ErrorCode.PROPERTY_ERROR,
- mpv.ErrorCode.PROPERTY_FORMAT,
- mpv.ErrorCode.PROPERTY_NOT_FOUND]): # This is due to a bug with option-mapped properties in mpv 0.18.1
- setattr(self.m, name, 100)
- setattr(self.m, name, 1)
- setattr(self.m, name, 0)
- setattr(self.m, name, -1)
- setattr(self.m, name, 1)
- setattr(self.m, name, 1.0)
- setattr(self.m, name, 0.0)
- setattr(self.m, name, -1.0)
- setattr(self.m, name, float('nan'))
- setattr(self.m, name, 'foo')
- setattr(self.m, name, '')
- setattr(self.m, name, 'bazbazbaz'*1000)
- setattr(self.m, name, b'foo')
- setattr(self.m, name, b'')
- setattr(self.m, name, b'bazbazbaz'*1000)
- setattr(self.m, name, True)
- setattr(self.m, name, False)
- if not old_canaries and check_canaries():
- raise UserWarning('Property test for {} produced files on file system, might not be safe.'.format(name))
-
- def test_property_bounce(self):
- self.m.aid = False
- self.assertEqual(self.m.audio, False)
- self.m.aid = 'auto'
- self.assertEqual(self.m.audio, 'auto')
- self.m.aid = 'no'
- self.assertEqual(self.m.audio, False)
- self.m.audio = 'auto'
- self.assertEqual(self.m.aid, 'auto')
- self.m.audio = False
- self.assertEqual(self.m.aid, False)
- self.m.audio = 'auto'
- self.assertEqual(self.m.aid, 'auto')
- self.m.audio = 'no'
- self.assertEqual(self.m.aid, False)
-
- def test_array_property_bounce(self):
- self.m.alang = 'en'
- self.assertEqual(self.m.alang, ['en'])
- self.m.alang = 'de'
- self.assertEqual(self.m.alang, ['de'])
- self.m.alang = ['de', 'en']
- self.assertEqual(self.m.alang, ['de', 'en'])
- self.m.alang = 'de,en'
- self.assertEqual(self.m.alang, ['de', 'en'])
- self.m.alang = ['de,en']
- self.assertEqual(self.m.alang, ['de,en'])
-
- def test_osd_property_bounce(self):
- self.m.alang = ['en']
- self.assertEqual(self.m.osd.alang, 'en')
- self.m.alang = ['de']
- self.assertEqual(self.m.osd.alang, 'de')
- self.m.alang = ['en', 'de']
- self.assertEqual(self.m.osd.alang, 'en,de')
-
- def test_raw_property_bounce(self):
- self.m.alang = 'en'
- self.assertEqual(self.m.raw.alang, [b'en'])
- self.m.alang = 'de'
- self.assertEqual(self.m.raw.alang, [b'de'])
- self.m.alang = ['de', 'en']
- self.assertEqual(self.m.raw.alang, [b'de', b'en'])
- self.m.alang = 'de,en'
- self.assertEqual(self.m.raw.alang, [b'de', b'en'])
- self.m.alang = ['de,en']
- self.assertEqual(self.m.raw.alang, [b'de,en'])
-
- def test_property_decoding_invalid_utf8(self):
- invalid_utf8 = b'foo\xc3\x28bar'
- self.m.alang = invalid_utf8
- self.assertEqual(self.m.raw.alang, [invalid_utf8])
- with self.assertRaises(UnicodeDecodeError):
- self.m.strict.alang
- with self.assertRaises(UnicodeDecodeError):
- # alang is considered safe and pasted straight into the OSD string. But OSD strings should always be valid
- # UTF-8. This test may be removed in case OSD encoding sanitization is handled differently in the future.
- self.m.osd.alang
-
- def test_property_decoding_valid_utf8(self):
- valid_utf8 = 'pröpérty'
- self.m.alang = valid_utf8
- self.assertEqual(self.m.alang, [valid_utf8])
- self.assertEqual(self.m.raw.alang, [valid_utf8.encode('utf-8')])
- self.assertEqual(self.m.osd.alang, valid_utf8)
- self.assertEqual(self.m.strict.alang, [valid_utf8])
-
- def test_property_decoding_multi(self):
- valid_utf8 = 'pröpérty'
- invalid_utf8 = b'foo\xc3\x28bar'
- self.m.alang = [valid_utf8, 'foo', invalid_utf8]
- self.assertEqual(self.m.alang, [valid_utf8, 'foo', invalid_utf8])
- self.assertEqual(self.m.raw.alang, [valid_utf8.encode('utf-8'), b'foo', invalid_utf8])
- with self.assertRaises(UnicodeDecodeError):
- self.m.strict.alang
- with self.assertRaises(UnicodeDecodeError):
- # See comment in test_property_decoding_invalid_utf8
- self.m.osd.alang
-
- def test_dict_valued_property(self):
- nasty_stuff = '\xe2\x80\x8e Mozilla/5.0 Foobar \xe2\x80\x8e \xe2\x80\x81'
- self.m.ytdl_raw_options = {'user-agent': nasty_stuff}
- self.assertEqual(self.m.ytdl_raw_options, {'user-agent': nasty_stuff})
-
- def test_option_read(self):
- self.m.loop = 'inf'
- self.m.play(TESTVID)
- while self.m.core_idle:
- time.sleep(0.05)
- for name in sorted(self.m):
- with self.subTest(option_name=name), self.swallow_mpv_errors([
- mpv.ErrorCode.PROPERTY_UNAVAILABLE, mpv.ErrorCode.PROPERTY_NOT_FOUND, mpv.ErrorCode.PROPERTY_ERROR]):
- self.m[name]
-
- def test_multivalued_option(self):
- self.m['external-files'] = ['test.webm', b'test.webm']
- self.assertEqual(self.m['external-files'], ['test.webm', 'test.webm'])
-
-
-class ObservePropertyTest(MpvTestCase):
- def test_observe_property(self):
- handler = mock.Mock()
-
- m = self.m
- m.observe_property('vid', handler)
-
- time.sleep(0.1)
- m.play(TESTVID)
-
- time.sleep(0.5) #couple frames
- m.unobserve_property('vid', handler)
-
- time.sleep(0.1) #couple frames
- m.terminate() # needed for synchronization of event thread
- handler.assert_has_calls([mock.call('vid', 'auto')])
-
- def test_property_observer_decorator(self):
- handler = mock.Mock()
-
- m = self.m
- m.play(TESTVID)
-
- m.slang = 'ru'
- m.mute = True
-
- @m.property_observer('mute')
- @m.property_observer('slang')
- def foo(*args, **kwargs):
- handler(*args, **kwargs)
-
- m.mute = False
- m.slang = 'jp'
- self.assertEqual(m.mute, False)
- self.assertEqual(m.slang, ['jp'])
-
- # Wait for tick. AFAICT property events are only generated at regular
- # intervals, and if we change a property too fast we don't get any
- # events. This is a limitation of the upstream API.
- time.sleep(0.1)
- # Another API limitation is that the order of property change events on
- # different properties does not necessarily exactly match the order in
- # which these properties were previously accessed. Thus, any_order.
- handler.assert_has_calls([
- mock.call('mute', False),
- mock.call('slang', ['jp'])],
- any_order=True)
- handler.reset_mock()
-
- m.mute = True
- m.slang = 'ru'
- self.assertEqual(m.mute, True)
- self.assertEqual(m.slang, ['ru'])
-
- time.sleep(0.1)
- foo.unobserve_mpv_properties()
-
- m.mute = False
- m.slang = 'jp'
- m.mute = True
- m.slang = 'ru'
- m.terminate() # needed for synchronization of event thread
- handler.assert_has_calls([
- mock.call('mute', True),
- mock.call('slang', ['ru'])],
- any_order=True)
-
-
-class KeyBindingTest(MpvTestCase):
- def test_register_direct_cmd(self):
- self.m.register_key_binding('a', 'playlist-clear')
- self.assertEqual(self.m._key_binding_handlers, {})
- self.m.register_key_binding('Ctrl+Shift+a', 'playlist-clear')
- self.m.unregister_key_binding('a')
- self.m.unregister_key_binding('Ctrl+Shift+a')
-
- def test_register_direct_fun(self):
- b = mpv.MPV._binding_name
-
- def reg_test_fun(state, name, char):
- pass
-
- self.m.register_key_binding('a', reg_test_fun)
- self.assertIn(b('a'), self.m._key_binding_handlers)
- self.assertEqual(self.m._key_binding_handlers[b('a')], reg_test_fun)
-
- self.m.unregister_key_binding('a')
- self.assertNotIn(b('a'), self.m._key_binding_handlers)
-
- def test_register_direct_bound_method(self):
- b = mpv.MPV._binding_name
-
- class RegTestCls:
- def method(self, state, name, char):
- pass
- instance = RegTestCls()
-
- self.m.register_key_binding('a', instance.method)
- self.assertIn(b('a'), self.m._key_binding_handlers)
- self.assertEqual(self.m._key_binding_handlers[b('a')], instance.method)
-
- self.m.unregister_key_binding('a')
- self.assertNotIn(b('a'), self.m._key_binding_handlers)
-
- def test_register_decorator_fun(self):
- b = mpv.MPV._binding_name
-
- @self.m.key_binding('a')
- def reg_test_fun(state, name, char):
- pass
- self.assertEqual(reg_test_fun.mpv_key_bindings, ['a'])
- self.assertIn(b('a'), self.m._key_binding_handlers)
- self.assertEqual(self.m._key_binding_handlers[b('a')], reg_test_fun)
-
- reg_test_fun.unregister_mpv_key_bindings()
- self.assertNotIn(b('a'), self.m._key_binding_handlers)
-
- def test_register_decorator_fun_chaining(self):
- b = mpv.MPV._binding_name
-
- @self.m.key_binding('a')
- @self.m.key_binding('b')
- def reg_test_fun(state, name, char):
- pass
-
- @self.m.key_binding('c')
- def reg_test_fun_2_stay_intact(state, name, char):
- pass
-
- self.assertEqual(reg_test_fun.mpv_key_bindings, ['b', 'a'])
- self.assertIn(b('a'), self.m._key_binding_handlers)
- self.assertIn(b('b'), self.m._key_binding_handlers)
- self.assertIn(b('c'), self.m._key_binding_handlers)
- self.assertEqual(self.m._key_binding_handlers[b('a')], reg_test_fun)
- self.assertEqual(self.m._key_binding_handlers[b('b')], reg_test_fun)
-
- reg_test_fun.unregister_mpv_key_bindings()
- self.assertNotIn(b('a'), self.m._key_binding_handlers)
- self.assertNotIn(b('b'), self.m._key_binding_handlers)
- self.assertIn(b('c'), self.m._key_binding_handlers)
-
- def test_wait_for_event_error_forwarding(self):
- self.m.play(TESTVID)
-
- def check(evt):
- raise ValueError('fnord')
-
- with self.assertRaises(ValueError):
- self.m.wait_for_event('end_file', cond=check)
-
- def test_wait_for_property_error_forwarding(self):
- def run():
- nonlocal self
- self.m.wait_until_playing(timeout=2)
- self.m.mute = True
- t = threading.Thread(target=run, daemon=True)
- t.start()
-
- def cond(mute):
- if mute:
- raise ValueError('fnord')
-
- with self.assertRaises(ValueError):
- self.m.play(TESTVID)
- self.m.wait_for_property('mute', cond=cond)
-
- def test_register_simple_decorator_fun_chaining(self):
- self.m.loop = 'inf'
- self.m.play(TESTVID)
- self.m.wait_until_playing(timeout=2)
-
- handler1, handler2 = mock.Mock(), mock.Mock()
-
- @self.m.on_key_press('a')
- @self.m.on_key_press('b')
- def reg_test_fun(*args, **kwargs):
- handler1(*args, **kwargs)
-
- @self.m.on_key_press('c')
- def reg_test_fun_2_stay_intact(*args, **kwargs):
- handler2(*args, **kwargs)
-
- self.assertEqual(reg_test_fun.mpv_key_bindings, ['b', 'a'])
-
- def keypress_and_sync(key):
- with self.m.prepare_and_wait_for_event('client_message', timeout=2):
- self.m.keypress(key)
-
- keypress_and_sync('a')
- handler1.assert_has_calls([ mock.call() ])
- handler2.assert_has_calls([])
- handler1.reset_mock()
-
- self.m.keypress('x')
- self.m.keypress('X')
- keypress_and_sync('b')
- handler1.assert_has_calls([ mock.call() ])
- handler2.assert_has_calls([])
- handler1.reset_mock()
-
- keypress_and_sync('c')
- self.m.keypress('B')
- handler1.assert_has_calls([])
- handler2.assert_has_calls([ mock.call() ])
- handler2.reset_mock()
-
- reg_test_fun.unregister_mpv_key_bindings()
- self.m.keypress('a')
- keypress_and_sync('c')
- self.m.keypress('x')
- self.m.keypress('A')
- handler1.assert_has_calls([])
- handler2.assert_has_calls([ mock.call() ])
-
-
-class TestStreams(unittest.TestCase):
- def test_python_stream(self):
- handler = mock.Mock()
-
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo)
- def cb(evt):
- handler(evt.as_dict(decoder=mpv.lazy_decoder))
- m.register_event_callback(cb)
-
- @m.python_stream('foo')
- def foo_gen():
- with open(TESTVID, 'rb') as f:
- yield f.read()
-
- @m.python_stream('bar')
- def bar_gen():
- yield b''
-
- m.play('python://foo')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'eof', 'playlist_entry_id': 1})
- handler.reset_mock()
-
- m.play('python://bar')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 2, 'file_error': 'unrecognized file format'})
- handler.reset_mock()
-
- m.play('python://baz')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 3, 'file_error': 'loading failed'})
- handler.reset_mock()
-
- m.play('foo://foo')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 4, 'file_error': 'loading failed'})
- handler.reset_mock()
-
- foo_gen.unregister()
-
- m.play('python://foo')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 5, 'file_error': 'loading failed'})
- handler.reset_mock()
-
- m.play('python://bar')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 6, 'file_error': 'unrecognized file format'})
- handler.reset_mock()
-
- m.terminate()
- disp.stop()
-
- def test_custom_stream(self):
- handler = mock.Mock()
- fail_mock = mock.Mock(side_effect=ValueError)
- stream_mock = mock.Mock()
- stream_mock.seek = mock.Mock(return_value=0)
- stream_mock.read = mock.Mock(return_value=b'')
-
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo, video=False)
- def cb(evt):
- handler(evt.as_dict(decoder=mpv.lazy_decoder))
- m.register_event_callback(cb)
-
- m.register_stream_protocol('pythonfail', fail_mock)
-
- @m.register_stream_protocol('pythonsuccess')
- def open_fn(uri):
- self.assertEqual(uri, 'pythonsuccess://foo')
- return stream_mock
-
- m.play('pythondoesnotexist://foo')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 1, 'file_error': 'loading failed'})
- handler.reset_mock()
-
- m.play('pythonfail://foo')
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 2, 'file_error': 'loading failed'})
- handler.reset_mock()
-
- m.play('pythonsuccess://foo')
- m.wait_for_playback()
- stream_mock.seek.assert_any_call(0)
- stream_mock.read.assert_called()
- handler.assert_any_call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 3, 'file_error': 'unrecognized file format'})
-
- m.terminate()
- disp.stop()
-
- def test_stream_open_exception(self):
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo, video=False)
-
- @m.register_stream_protocol('raiseerror')
- def open_fn(uri):
- raise SystemError()
-
- waiting = threading.Semaphore()
- result = Future()
- def run():
- result.set_running_or_notify_cancel()
- try:
- waiting.release()
- m.wait_for_playback()
- result.set_result(False)
- except SystemError:
- result.set_result(True)
- except Exception:
- result.set_result(False)
-
- t = threading.Thread(target=run, daemon=True)
- t.start()
-
- with waiting:
- time.sleep(0.2)
- m.play('raiseerror://foo')
-
- m.wait_for_playback(catch_errors=False)
- try:
- assert result.result()
- finally:
- m.terminate()
- disp.stop()
-
- def test_python_stream_exception(self):
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo)
-
- @m.python_stream('foo')
- def foo_gen():
- with open(TESTVID, 'rb') as f:
- yield f.read(100)
- raise SystemError()
-
- waiting = threading.Semaphore()
- result = Future()
- def run():
- result.set_running_or_notify_cancel()
- try:
- waiting.release()
- m.wait_for_playback()
- result.set_result(False)
- except SystemError:
- result.set_result(True)
- except Exception:
- result.set_result(False)
-
- t = threading.Thread(target=run, daemon=True)
- t.start()
-
- with waiting:
- time.sleep(0.2)
- m.play('python://foo')
-
- m.wait_for_playback(catch_errors=False)
- try:
- assert result.result()
- finally:
- m.terminate()
- disp.stop()
-
- def test_stream_open_forward(self):
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo, video=False)
-
- @m.register_stream_protocol('raiseerror')
- def open_fn(uri):
- raise ValueError()
-
- waiting = threading.Semaphore()
- result = Future()
- def run():
- result.set_running_or_notify_cancel()
- try:
- waiting.release()
- m.wait_for_playback()
- result.set_result(True)
- except Exception:
- result.set_result(False)
-
- t = threading.Thread(target=run, daemon=True)
- t.start()
-
- with waiting:
- time.sleep(0.2)
- m.play('raiseerror://foo')
-
- m.wait_for_playback(catch_errors=False)
- try:
- assert result.result()
- finally:
- m.terminate()
- disp.stop()
-
- def test_play_context(self):
- handler = mock.Mock()
-
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo)
- def cb(evt):
- handler(evt.as_dict(decoder=mpv.lazy_decoder))
- m.register_event_callback(cb)
-
- with m.play_context() as write:
- with open(TESTVID, 'rb') as f:
- write(f.read(100))
- write(f.read(1000))
- write(f.read())
-
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'eof', 'playlist_entry_id': 1})
- m.terminate()
- disp.stop()
-
- def test_play_bytes(self):
- handler = mock.Mock()
-
- disp = Display()
- disp.start()
- m = mpv.MPV(vo=testvo)
- def cb(evt):
- handler(evt.as_dict(decoder=mpv.lazy_decoder))
- m.register_event_callback(cb)
-
- with open(TESTVID, 'rb') as f:
- m.play_bytes(f.read())
-
- m.wait_for_playback()
- handler.assert_any_call({'event': 'end-file', 'reason': 'eof', 'playlist_entry_id': 1})
- m.terminate()
- disp.stop()
-
-
-class TestLifecycle(unittest.TestCase):
- def test_create_destroy(self):
- thread_names = lambda: [ t.name for t in threading.enumerate() ]
- self.assertNotIn('MPVEventHandlerThread', thread_names())
- m = mpv.MPV()
- self.assertIn('MPVEventHandlerThread', thread_names())
- m.terminate()
- self.assertNotIn('MPVEventHandlerThread', thread_names())
-
- def test_flags(self):
- with self.assertRaises(AttributeError):
- mpv.MPV('this-option-does-not-exist')
- m = mpv.MPV('cursor-autohide-fs-only', 'fs', video=False)
- self.assertTrue(m.fullscreen)
- self.assertEqual(m.cursor_autohide, 1000)
- m.terminate()
-
- def test_options(self):
- with self.assertRaises(AttributeError):
- mpv.MPV(this_option_does_not_exists=23)
- m = mpv.MPV(osd_level=0, loop='inf', deinterlace=False)
- self.assertEqual(m.osd_level, 0)
- # For compatibility with mpv master (v0.32.0-585-gfba1c681b8) accept both
- self.assertIn(m.loop, ['inf', True])
- self.assertEqual(m.deinterlace, False)
- m.terminate()
-
- def test_event_callback(self):
- handler = mock.Mock()
- m = mpv.MPV(video=False)
- def cb(evt):
- handler(evt.as_dict(decoder=mpv.lazy_decoder))
- m.register_event_callback(cb)
- m.play(TESTVID)
- m.wait_for_playback()
-
- m.unregister_event_callback(cb)
- handler.assert_has_calls([
- mock.call({'event': 'start-file', 'playlist_entry_id': 1}),
- mock.call({'event': 'end-file', 'reason': 'error', 'playlist_entry_id': 1, 'file_error': 'no audio or video data played'})
- ], any_order=True)
- time.sleep(1)
- handler.reset_mock()
- m.terminate()
- handler.assert_not_called()
-
- def test_wait_for_property_negative(self):
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- result = Future()
- def run():
- nonlocal self
- result.set_running_or_notify_cancel()
- try:
- m.wait_for_property('mute')
- result.set_result(False)
- except mpv.ShutdownError:
- result.set_result(True)
- t = threading.Thread(target=run, daemon=True)
- t.start()
- time.sleep(1)
- m.terminate()
- time.sleep(1)
- t.join()
- self.disp.stop()
- assert result.result()
-
- def test_wait_for_property_positive(self):
- self.disp = Display()
- self.disp.start()
- handler = mock.Mock()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- def run():
- nonlocal self
- m.wait_for_property('mute')
- handler()
- t = threading.Thread(target=run, daemon=True)
- t.start()
- m.wait_until_playing(timeout=2)
- m.mute = True
- t.join()
- m.terminate()
- time.sleep(1)
- handler.assert_called()
- self.disp.stop()
-
- def test_wait_for_event(self):
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- result = Future()
- def run():
- nonlocal self
- result.set_running_or_notify_cancel()
- try:
- m.wait_for_event('seek')
- result.set_result(False)
- except mpv.ShutdownError:
- result.set_result(True)
- t = threading.Thread(target=run, daemon=True)
- t.start()
- time.sleep(1)
- m.terminate()
- t.join()
- self.disp.stop()
- assert result.result()
-
- def test_wait_for_property_shutdown(self):
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- with self.assertRaises(mpv.ShutdownError):
- # level_sensitive=false needed to prevent get_property on dead
- # handle
- with m.prepare_and_wait_for_property('mute', level_sensitive=False):
- m.terminate()
- time.sleep(1)
- self.disp.stop()
-
- @unittest.skipIf('test_wait_for_property_event_overflow' in SKIP_TESTS, reason="kills X-Server first")
- def test_wait_for_property_event_overflow(self):
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- with self.assertRaises(mpv.EventOverflowError):
- # level_sensitive=false needed to prevent get_property on dead
- # handle
- with m.prepare_and_wait_for_property('mute', cond=lambda val: time.sleep(0.001)):
- for i in range(10000):
- try:
- # We really have to try hard to fill up the queue here. Simple async commands will not work,
- # since then command_async will throw a memory error first. Property changes also do not work,
- # since they are only processsed when the event loop is idle. This here works reliably.
- m.command_async('script-message', 'foo', 'bar')
- except:
- pass
- m.terminate()
- time.sleep(1)
- self.disp.stop()
-
- def test_wait_for_event_shutdown(self):
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- with self.assertRaises(mpv.ShutdownError):
- with m.prepare_and_wait_for_event('seek'):
- m.terminate()
- self.disp.stop()
-
- def test_wait_for_shutdown(self):
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo)
- m.play(TESTVID)
- with self.assertRaises(mpv.ShutdownError):
- with m.prepare_and_wait_for_event(None) as result:
- m.terminate()
- result.result()
- self.disp.stop()
-
- def test_log_handler(self):
- handler = mock.Mock()
- self.disp = Display()
- self.disp.start()
- m = mpv.MPV(vo=testvo, log_handler=handler)
- m.play(TESTVID)
- # Wait for playback to start
- m.wait_until_playing(timeout=2)
- m.command("print-text", 'This is a python-mpv test')
- m.wait_for_playback()
- m.terminate()
- for call in handler.mock_calls:
- _1, (a, b, c), _2 = call
- if a == 'info' and b == 'cplayer' and 'This is a python-mpv test' in c:
- break
- else:
- self.fail('"Test log entry not found in log handler calls: '+','.join(repr(call) for call in handler.mock_calls))
- self.disp.stop()
-
-
-class CommandTests(MpvTestCase):
-
- def test_loadfile_with_subtitles(self):
- handler = mock.Mock()
- self.m.property_observer('sub-text')(handler)
-
- self.m.loadfile(TESTVID, sub_file=TESTSRT)
-
- self.m.wait_for_playback()
- handler.assert_any_call('sub-text', 'This is\na subtitle test.')
- handler.assert_any_call('sub-text', 'This is the second subtitle line.')
-
- def test_sub_add(self):
- handler = mock.Mock()
- self.m.property_observer('sub-text')(handler)
- time.sleep(0.5)
-
- self.m.loadfile(TESTVID)
- self.m.wait_until_playing(timeout=2)
- self.m.sub_add(TESTSRT)
-
- self.m.wait_for_playback()
- handler.assert_any_call('sub-text', 'This is\na subtitle test.')
- handler.assert_any_call('sub-text', 'This is the second subtitle line.')
-
- def test_async_command(self):
- handler = mock.Mock()
- callback = mock.Mock()
- self.m.property_observer('sub-text')(handler)
- time.sleep(0.5)
-
- self.m.loadfile(TESTVID)
- self.m.wait_until_playing(timeout=2)
- self.m.command_async('sub_add', TESTSRT, callback=callback)
- reply = self.m.command_async('expand-text', 'test ${mute}')
- assert reply.result() == 'test no'
-
- self.m.wait_for_playback()
- handler.assert_any_call('sub-text', 'This is\na subtitle test.')
- handler.assert_any_call('sub-text', 'This is the second subtitle line.')
- callback.assert_any_call(None, None)
-
-
-class RegressionTests(MpvTestCase):
-
- def test_wait_for_property_concurrency(self):
- players = [mpv.MPV(vo=testvo, loglevel='debug', log_handler=timed_print()) for i in range(2)]
- try:
- for _ in range(150):
- for player in players:
- player.loadfile('tests/test.webm', loop='inf')
- for player in players:
- player.wait_for_property('seekable')
- for player in players:
- player.seek(0, reference='absolute', precision='exact')
-
- except InvalidStateError:
- self.fail('InvalidStateError thrown from wait_for_property')
-
- finally:
- for player in players:
- player.terminate()
-
- def test_unobserve_property_runtime_error(self):
- """
- Ensure a `RuntimeError` is not thrown within
- `unobserve_property`.
- """
- handler = mock.Mock()
-
- self.m.observe_property('loop', handler)
-
- try:
- self.m.unobserve_property('loop', handler)
- except RuntimeError:
- self.fail(
- """
- "RuntimeError" exception thrown within
- `unobserve_property`
- """,
- )
-
- def test_instance_method_property_observer(self):
- """
- Ensure that bound method objects can be used as property observers.
- See issue #26
- """
- handler = mock.Mock()
- m = self.m
-
- class T(object):
- def t(self, *args, **kw):
- handler(*args, **kw)
- t = T()
-
- m.slang = 'ru'
- time.sleep(0.5)
-
- m.observe_property('slang', t.t)
- time.sleep(0.5)
-
- m.slang = 'jp'
- time.sleep(0.5)
-
- m.slang = 'ru'
- time.sleep(0.5)
-
- m.unobserve_property('slang', t.t)
- time.sleep(0.5)
-
- m.slang = 'jp'
- m.slang = 'ru'
- m.terminate() # needed for synchronization of event thread
- handler.assert_has_calls([mock.call('slang', ['jp']), mock.call('slang', ['ru'])])
-