From 0ae5018c33cc4bfe27583c9902472b499f4bd269 Mon Sep 17 00:00:00 2001 From: Benedikt Peetz Date: Fri, 23 Aug 2024 12:57:19 +0200 Subject: refactor(libmpv2): Move to the `crates` directory --- crates/libmpv2/.gitignore | 14 + crates/libmpv2/CHANGELOG.md | 45 + crates/libmpv2/Cargo.toml | 36 + crates/libmpv2/LICENSE | 174 ++ crates/libmpv2/README.md | 47 + crates/libmpv2/examples/events.rs | 93 ++ crates/libmpv2/examples/opengl.rs | 139 ++ crates/libmpv2/examples/protocol.rs | 87 + crates/libmpv2/libmpv2-sys/Cargo.toml | 21 + crates/libmpv2/libmpv2-sys/LICENSE | 174 ++ crates/libmpv2/libmpv2-sys/README.md | 13 + crates/libmpv2/libmpv2-sys/build.rs | 43 + crates/libmpv2/libmpv2-sys/include/client.h | 2082 ++++++++++++++++++++++++ crates/libmpv2/libmpv2-sys/include/render.h | 769 +++++++++ crates/libmpv2/libmpv2-sys/include/render_gl.h | 221 +++ crates/libmpv2/libmpv2-sys/include/stream_cb.h | 253 +++ crates/libmpv2/libmpv2-sys/src/lib.rs | 22 + crates/libmpv2/libmpv2-sys/update.sh | 14 + crates/libmpv2/src/lib.rs | 175 ++ crates/libmpv2/src/mpv.rs | 620 +++++++ crates/libmpv2/src/mpv/errors.rs | 110 ++ crates/libmpv2/src/mpv/events.rs | 383 +++++ crates/libmpv2/src/mpv/protocol.rs | 261 +++ crates/libmpv2/src/mpv/render.rs | 406 +++++ crates/libmpv2/src/tests.rs | 222 +++ crates/libmpv2/update.sh | 16 + 26 files changed, 6440 insertions(+) create mode 100644 crates/libmpv2/.gitignore create mode 100644 crates/libmpv2/CHANGELOG.md create mode 100644 crates/libmpv2/Cargo.toml create mode 100644 crates/libmpv2/LICENSE create mode 100644 crates/libmpv2/README.md create mode 100644 crates/libmpv2/examples/events.rs create mode 100644 crates/libmpv2/examples/opengl.rs create mode 100644 crates/libmpv2/examples/protocol.rs create mode 100644 crates/libmpv2/libmpv2-sys/Cargo.toml create mode 100644 crates/libmpv2/libmpv2-sys/LICENSE create mode 100644 crates/libmpv2/libmpv2-sys/README.md create mode 100644 crates/libmpv2/libmpv2-sys/build.rs create mode 100644 crates/libmpv2/libmpv2-sys/include/client.h create mode 100644 crates/libmpv2/libmpv2-sys/include/render.h create mode 100644 crates/libmpv2/libmpv2-sys/include/render_gl.h create mode 100644 crates/libmpv2/libmpv2-sys/include/stream_cb.h create mode 100644 crates/libmpv2/libmpv2-sys/src/lib.rs create mode 100755 crates/libmpv2/libmpv2-sys/update.sh create mode 100644 crates/libmpv2/src/lib.rs create mode 100644 crates/libmpv2/src/mpv.rs create mode 100644 crates/libmpv2/src/mpv/errors.rs create mode 100644 crates/libmpv2/src/mpv/events.rs create mode 100644 crates/libmpv2/src/mpv/protocol.rs create mode 100644 crates/libmpv2/src/mpv/render.rs create mode 100644 crates/libmpv2/src/tests.rs create mode 100755 crates/libmpv2/update.sh (limited to 'crates') diff --git a/crates/libmpv2/.gitignore b/crates/libmpv2/.gitignore new file mode 100644 index 0000000..868b9ad --- /dev/null +++ b/crates/libmpv2/.gitignore @@ -0,0 +1,14 @@ +# yt - A fully featured command line YouTube client +# +# Copyright (C) 2024 Benedikt Peetz +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This file is part of Yt. +# +# You should have received a copy of the License along with this program. +# If not, see . + +/target +/examples/target +/libmpv2-sys/target +Cargo.lock diff --git a/crates/libmpv2/CHANGELOG.md b/crates/libmpv2/CHANGELOG.md new file mode 100644 index 0000000..dc6f861 --- /dev/null +++ b/crates/libmpv2/CHANGELOG.md @@ -0,0 +1,45 @@ + + +# Changelog + +## Unreleased + +## Version 3.0.0 + +- \[breaking\] Support libmpv version 2.0 (mpv version 0.35.0). Mpv versions \<= + 0.34.0 will no longer be supported. +- Add OpenGL rendering + +## Version 2.0.1 + +- Fix `playlist_previous_*` commands using wrong mpv command + ([issue](https://github.com/ParadoxSpiral/libmpv-rs/issues/17)) +- Use local libmpv-sys as dependency except on crates.io + +## Version 2.0.0 + +- Add method `Mpv::with_initializer` to set options before initialization +- \[breaking\] Borrow `&mut self` in `wait_event` to disallow using two events + where the first points to data freed in the second `wait_event` call +- \[breaking\] `PropertyData<'_>` is no longer `Clone` or `PartialEq`, + `Event<'_>` is no longer `Clone` to avoid cloning/comparing `MpvNode` + +## Version 1.1.0 + +- Add an `MpvNode` that implements `GetData`, i.a. with `MpvNodeArrayIter` and + `MpvNodeMapIter` variants that support e.g. properties `audio-parmas` and + `playlist` + +## Version 1.0.1 + +- Use debug formatting in impl of `Display` trait for `Error` diff --git a/crates/libmpv2/Cargo.toml b/crates/libmpv2/Cargo.toml new file mode 100644 index 0000000..72e9fac --- /dev/null +++ b/crates/libmpv2/Cargo.toml @@ -0,0 +1,36 @@ +# yt - A fully featured command line YouTube client +# +# Copyright (C) 2024 Benedikt Peetz +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This file is part of Yt. +# +# You should have received a copy of the License along with this program. +# If not, see . + +[workspace] +members = ["libmpv2-sys"] + +[package] +name = "libmpv2" +version = "4.0.0" +edition = "2021" +license = "LGPL-2.1" +readme = "README.md" +description = "Libmpv abstraction that's easy to use and can play next to all codecs and containers" +keywords = ["media", "playback", "mpv", "libmpv"] + + +[dependencies] +libmpv2-sys = { path = "libmpv2-sys", version = "4.0.0" } +log = "0.4.22" +thiserror = "1.0.63" + +[dev-dependencies] +crossbeam = "0.7" +sdl2 = "0.36.0" + +[features] +default = ["protocols", "render"] +protocols = [] # Enable custom protocol callbacks +render = [] # Enable custom rendering diff --git a/crates/libmpv2/LICENSE b/crates/libmpv2/LICENSE new file mode 100644 index 0000000..7dd5aab --- /dev/null +++ b/crates/libmpv2/LICENSE @@ -0,0 +1,174 @@ +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. + +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. + +one line to give the library's name and an idea of what it does. +Copyright (C) year name of author + +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. + +signature of Ty Coon, 1 April 1990 +Ty Coon, President of Vice +That's all there is to it! diff --git a/crates/libmpv2/README.md b/crates/libmpv2/README.md new file mode 100644 index 0000000..6929354 --- /dev/null +++ b/crates/libmpv2/README.md @@ -0,0 +1,47 @@ + + +Credits go to @anlumo for the rendering implementation and @sirno for updating +the API to support libmpv version 2.0. + +# libmpv2-rs + +A libmpv abstraction written in rust that's easy to use and provides the ability +to read next to all video and audio codecs. + +# Dependencies + +Rust version >= 1.30. Libmpv version 2.0 (mpv version 0.35.0) is the minimum +required version. + +For ease of building, you can use the `build_libmpv` feature that is used to +link against. Especially useful to cross compile to windows. The `MPV_SOURCE` +environment variable needs to be set to a directory containing the mpv source +you want to build against. For windows targets this is expected to be already +built, with a directory named `MPV_SOURCE/64` or `/32` containing +[build artifacts](https://mpv.srsfckn.biz/) for 64-bit and 32-bit targets +respectively. On unix this is expected to be a copy of the mpv-build repo. + +# Examples + +To run an example, execute +`cargo run [--release] --example x -- test-data/jellyfish.mp4`, where x is any +of: + +- `events`: event enumeration +- `protocol`: implementation of custom `filereader://` protocol that… reads + files +- `opengl`: openGL rendering onto SDL2 window + +# Contributing + +All pull requests/issues welcome. diff --git a/crates/libmpv2/examples/events.rs b/crates/libmpv2/examples/events.rs new file mode 100644 index 0000000..8f7c79f --- /dev/null +++ b/crates/libmpv2/examples/events.rs @@ -0,0 +1,93 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use libmpv2::{events::*, mpv_node::MpvNode, *}; + +use std::{collections::HashMap, env, thread, time::Duration}; + +const VIDEO_URL: &str = "https://www.youtube.com/watch?v=VLnWf1sQkjY"; + +fn main() -> Result<()> { + let path = env::args() + .nth(1) + .unwrap_or_else(|| String::from(VIDEO_URL)); + + // Create an `Mpv` and set some properties. + let mpv = Mpv::with_initializer(|init| { + init.set_property("vo", "null")?; + Ok(()) + }) + .unwrap(); + mpv.set_property("volume", 15)?; + + let mut ev_ctx = EventContext::new(mpv.ctx); + ev_ctx.disable_deprecated_events()?; + ev_ctx.observe_property("volume", Format::Int64, 0)?; + ev_ctx.observe_property("demuxer-cache-state", Format::Node, 0)?; + + crossbeam::scope(|scope| { + scope.spawn(|_| { + mpv.command("loadfile", &[&path, "append-play"]).unwrap(); + + thread::sleep(Duration::from_secs(3)); + + mpv.set_property("volume", 25).unwrap(); + + thread::sleep(Duration::from_secs(5)); + + // Trigger `Event::EndFile`. + mpv.command("playlist-next", &["force"]).unwrap(); + }); + scope.spawn(move |_| loop { + let ev = ev_ctx.wait_event(600.).unwrap_or(Err(Error::Null)); + + match ev { + Ok(Event::EndFile(r)) => { + println!("Exiting! Reason: {:?}", r); + break; + } + + Ok(Event::PropertyChange { + name: "demuxer-cache-state", + change: PropertyData::Node(mpv_node), + .. + }) => { + let ranges = seekable_ranges(mpv_node); + println!("Seekable ranges updated: {:?}", ranges); + } + Ok(e) => println!("Event triggered: {:?}", e), + Err(e) => println!("Event errored: {:?}", e), + } + }); + }) + .unwrap(); + Ok(()) +} + +fn seekable_ranges(demuxer_cache_state: MpvNode) -> Vec<(f64, f64)> { + let mut res = Vec::new(); + let props = demuxer_cache_state + .map() + .unwrap() + .collect::>(); + let ranges = props + .get("seekable-ranges") + .unwrap() + .clone() + .array() + .unwrap(); + for node in ranges { + let range = node.map().unwrap().collect::>(); + let start = range.get("start").unwrap().f64().unwrap(); + let end = range.get("end").unwrap().f64().unwrap(); + res.push((start, end)); + } + res +} diff --git a/crates/libmpv2/examples/opengl.rs b/crates/libmpv2/examples/opengl.rs new file mode 100644 index 0000000..1de307f --- /dev/null +++ b/crates/libmpv2/examples/opengl.rs @@ -0,0 +1,139 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use libmpv2::{ + render::{OpenGLInitParams, RenderContext, RenderParam, RenderParamApiType}, + Mpv, +}; +use std::{env, ffi::c_void}; + +fn get_proc_address(display: &sdl2::VideoSubsystem, name: &str) -> *mut c_void { + display.gl_get_proc_address(name) as *mut c_void +} + +const VIDEO_URL: &str = "test-data/jellyfish.mp4"; + +#[derive(Debug)] +enum UserEvent { + MpvEventAvailable, + RedrawRequested, +} + +fn main() { + let (window, mut events_loop, event_subsystem, video, _context) = create_sdl2_context(); + + let path = env::args() + .nth(1) + .unwrap_or_else(|| String::from(VIDEO_URL)); + + let mut mpv = Mpv::with_initializer(|init| { + init.set_property("vo", "libmpv")?; + Ok(()) + }) + .unwrap(); + let mut render_context = RenderContext::new( + unsafe { mpv.ctx.as_mut() }, + vec![ + RenderParam::ApiType(RenderParamApiType::OpenGl), + RenderParam::InitParams(OpenGLInitParams { + get_proc_address, + ctx: video, + }), + ], + ) + .expect("Failed creating render context"); + + event_subsystem + .register_custom_event::() + .unwrap(); + + mpv.event_context_mut().disable_deprecated_events().unwrap(); + + let event_sender = event_subsystem.event_sender(); + render_context.set_update_callback(move || { + event_sender + .push_custom_event(UserEvent::RedrawRequested) + .unwrap(); + }); + + let event_sender = event_subsystem.event_sender(); + mpv.event_context_mut().set_wakeup_callback(move || { + event_sender + .push_custom_event(UserEvent::MpvEventAvailable) + .unwrap(); + }); + mpv.command("loadfile", &[&path, "replace"]).unwrap(); + + 'render: loop { + for event in events_loop.poll_iter() { + use sdl2::event::Event; + + if event.is_user_event() { + match event.as_user_event_type::().unwrap() { + UserEvent::RedrawRequested => { + let (width, height) = window.drawable_size(); + render_context + .render::(0, width as _, height as _, true) + .expect("Failed to draw on sdl2 window"); + window.gl_swap_window(); + } + UserEvent::MpvEventAvailable => loop { + match mpv.event_context_mut().wait_event(0.0) { + Some(Ok(libmpv2::events::Event::EndFile(_))) => { + break 'render; + } + Some(Ok(mpv_event)) => { + eprintln!("MPV event: {:?}", mpv_event); + } + Some(Err(err)) => { + eprintln!("MPV Error: {}", err); + break 'render; + } + None => break, + } + }, + } + } + + match event { + Event::Quit { .. } => { + break 'render; + } + _ => (), + } + } + } +} + +fn create_sdl2_context() -> ( + sdl2::video::Window, + sdl2::EventPump, + sdl2::EventSubsystem, + sdl2::VideoSubsystem, + sdl2::video::GLContext, +) { + let sdl = sdl2::init().unwrap(); + let video = sdl.video().unwrap(); + let event_subsystem = sdl.event().unwrap(); + let gl_attr = video.gl_attr(); + gl_attr.set_context_profile(sdl2::video::GLProfile::Core); + gl_attr.set_context_version(3, 3); + gl_attr.set_context_flags().forward_compatible().set(); + let window = video + .window("OpenGL mpv", 960, 540) + .opengl() + .resizable() + .build() + .unwrap(); + let gl_context = window.gl_create_context().unwrap(); + let event_loop = sdl.event_pump().unwrap(); + + (window, event_loop, event_subsystem, video, gl_context) +} diff --git a/crates/libmpv2/examples/protocol.rs b/crates/libmpv2/examples/protocol.rs new file mode 100644 index 0000000..46702d6 --- /dev/null +++ b/crates/libmpv2/examples/protocol.rs @@ -0,0 +1,87 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use std::{ + env, + fs::File, + io::{Read, Seek, SeekFrom}, + mem, thread, + time::Duration, +}; + +#[cfg(all(not(test), not(feature = "protocols")))] +compile_error!("The feature `protocols` needs to be enabled for this example`"); + +#[cfg(feature = "protocols")] +fn main() { + use libmpv2::{protocol::*, *}; + + let path = format!( + "filereader://{}", + env::args() + .nth(1) + .expect("Expected path to local media as argument, found nil.") + ); + + let protocol = unsafe { + Protocol::new( + "filereader".into(), + (), + open, + close, + read, + Some(seek), + Some(size), + ) + }; + + let mpv = Mpv::new().unwrap(); + mpv.set_property("volume", 25).unwrap(); + + let proto_ctx = mpv.create_protocol_context(); + proto_ctx.register(protocol).unwrap(); + + mpv.command("loadfile", &[&path, "append-play"]).unwrap(); + + thread::sleep(Duration::from_secs(10)); + + mpv.command("seek", &["15"]).unwrap(); + + thread::sleep(Duration::from_secs(5)); +} + +fn open(_: &mut (), uri: &str) -> File { + // Open the file, and strip the `filereader://` part + let ret = File::open(&uri[13..]).unwrap(); + + println!("Opened file[{}], ready for orders o7", &uri[13..]); + ret +} + +fn close(_: Box) { + println!("Closing file, bye bye~~"); +} + +fn read(cookie: &mut File, buf: &mut [i8]) -> i64 { + unsafe { + let forbidden_magic = mem::transmute::<&mut [i8], &mut [u8]>(buf); + + cookie.read(forbidden_magic).unwrap() as _ + } +} + +fn seek(cookie: &mut File, offset: i64) -> i64 { + println!("Seeking to byte {}", offset); + cookie.seek(SeekFrom::Start(offset as u64)).unwrap() as _ +} + +fn size(cookie: &mut File) -> i64 { + cookie.metadata().unwrap().len() as _ +} diff --git a/crates/libmpv2/libmpv2-sys/Cargo.toml b/crates/libmpv2/libmpv2-sys/Cargo.toml new file mode 100644 index 0000000..5fba086 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/Cargo.toml @@ -0,0 +1,21 @@ +# yt - A fully featured command line YouTube client +# +# Copyright (C) 2024 Benedikt Peetz +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This file is part of Yt. +# +# You should have received a copy of the License along with this program. +# If not, see . + +[package] +name = "libmpv2-sys" +version = "4.0.0" +edition = "2021" +license = "LGPL-2.1" +build = "build.rs" +description = "Libmpv bindings generated by bindgen" +keywords = ["media", "playback", "mpv", "libmpv"] + +[build-dependencies] +bindgen = { version = "0.69.4" } diff --git a/crates/libmpv2/libmpv2-sys/LICENSE b/crates/libmpv2/libmpv2-sys/LICENSE new file mode 100644 index 0000000..7dd5aab --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/LICENSE @@ -0,0 +1,174 @@ +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. + +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. + +one line to give the library's name and an idea of what it does. +Copyright (C) year name of author + +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. + +signature of Ty Coon, 1 April 1990 +Ty Coon, President of Vice +That's all there is to it! diff --git a/crates/libmpv2/libmpv2-sys/README.md b/crates/libmpv2/libmpv2-sys/README.md new file mode 100644 index 0000000..35302b8 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/README.md @@ -0,0 +1,13 @@ + + +FFI bindings for libmpv, generated by bindgen at compile time. diff --git a/crates/libmpv2/libmpv2-sys/build.rs b/crates/libmpv2/libmpv2-sys/build.rs new file mode 100644 index 0000000..bf9a02e --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/build.rs @@ -0,0 +1,43 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use std::env; +use std::path::PathBuf; + +fn main() { + let bindings = bindgen::Builder::default() + .formatter(bindgen::Formatter::Prettyplease) + .header("include/client.h") + .header("include/render.h") + .header("include/render_gl.h") + .header("include/stream_cb.h") + .impl_debug(true) + .opaque_type("mpv_handle") + .opaque_type("mpv_render_context") + .enable_function_attribute_detection() + .clang_args(&[ + "-fretain-comments-from-system-headers", + &format!( + "--include-directory={}", + env::var("LIBCLANG_INCLUDE_PATH").unwrap() + ), + "--verbose", + ]) + .generate_comments(true) + .generate() + .expect("Unable to generate bindings"); + + let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()); + bindings + .write_to_file(out_path.join("bindings.rs")) + .expect("Couldn't write bindings!"); + + println!("cargo:rustc-link-lib=mpv"); +} diff --git a/crates/libmpv2/libmpv2-sys/include/client.h b/crates/libmpv2/libmpv2-sys/include/client.h new file mode 100644 index 0000000..874c770 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/include/client.h @@ -0,0 +1,2082 @@ +/* + * yt - A fully featured command line YouTube client + * + * Copyright (C) 2017 the mpv developers + * Copyright (C) 2024 Benedikt Peetz + * SPDX-License-Identifier: GPL-3.0-or-later + * + * This file is part of Yt. + * + * You should have received a copy of the License along with this program. + * If not, see . + */ + +/* + * Note: the client API is licensed under ISC (see above) to enable + * other wrappers outside of mpv. But keep in mind that the + * mpv core is by default still GPLv2+ - unless built with + * -Dgpl=false, which makes it LGPLv2+. + */ + +#ifndef MPV_CLIENT_API_H_ +#define MPV_CLIENT_API_H_ + +#include +#include + +#ifdef _WIN32 +#define MPV_EXPORT __declspec (dllexport) +#define MPV_SELECTANY __declspec (selectany) +#elif defined(__GNUC__) || defined(__clang__) +#define MPV_EXPORT __attribute__ ((visibility ("default"))) +#define MPV_SELECTANY +#else +#define MPV_EXPORT +#define MPV_SELECTANY +#endif + +#ifdef __cpp_decltype +#define MPV_DECLTYPE decltype +#else +#define MPV_DECLTYPE __typeof__ +#endif + +#ifdef __cplusplus +extern "C" +{ +#endif + +/** + * Mechanisms provided by this API + * ------------------------------- + * + * This API provides general control over mpv playback. It does not give you + * direct access to individual components of the player, only the whole thing. + * It's somewhat equivalent to MPlayer's slave mode. You can send commands, + * retrieve or set playback status or settings with properties, and receive + * events. + * + * The API can be used in two ways: + * 1) Internally in mpv, to provide additional features to the command line + * player. Lua scripting uses this. (Currently there is no plugin API to + * get a client API handle in external user code. It has to be a fixed + * part of the player at compilation time.) + * 2) Using mpv as a library with mpv_create(). This basically allows embedding + * mpv in other applications. + * + * Documentation + * ------------- + * + * The libmpv C API is documented directly in this header. Note that most + * actual interaction with this player is done through + * options/commands/properties, which can be accessed through this API. + * Essentially everything is done with them, including loading a file, + * retrieving playback progress, and so on. + * + * These are documented elsewhere: + * * http://mpv.io/manual/master/#options + * * http://mpv.io/manual/master/#list-of-input-commands + * * http://mpv.io/manual/master/#properties + * + * You can also look at the examples here: + * * https://github.com/mpv-player/mpv-examples/tree/master/libmpv + * + * Event loop + * ---------- + * + * In general, the API user should run an event loop in order to receive + * events. This event loop should call mpv_wait_event(), which will return once + * a new mpv client API is available. It is also possible to integrate client + * API usage in other event loops (e.g. GUI toolkits) with the + * mpv_set_wakeup_callback() function, and then polling for events by calling + * mpv_wait_event() with a 0 timeout. + * + * Note that the event loop is detached from the actual player. Not calling + * mpv_wait_event() will not stop playback. It will eventually congest the + * event queue of your API handle, though. + * + * Synchronous vs. asynchronous calls + * ---------------------------------- + * + * The API allows both synchronous and asynchronous calls. Synchronous calls + * have to wait until the playback core is ready, which currently can take + * an unbounded time (e.g. if network is slow or unresponsive). Asynchronous + * calls just queue operations as requests, and return the result of the + * operation as events. + * + * Asynchronous calls + * ------------------ + * + * The client API includes asynchronous functions. These allow you to send + * requests instantly, and get replies as events at a later point. The + * requests are made with functions carrying the _async suffix, and replies + * are returned by mpv_wait_event() (interleaved with the normal event stream). + * + * A 64 bit userdata value is used to allow the user to associate requests + * with replies. The value is passed as reply_userdata parameter to the request + * function. The reply to the request will have the reply + * mpv_event->reply_userdata field set to the same value as the + * reply_userdata parameter of the corresponding request. + * + * This userdata value is arbitrary and is never interpreted by the API. Note + * that the userdata value 0 is also allowed, but then the client must be + * careful not accidentally interpret the mpv_event->reply_userdata if an + * event is not a reply. (For non-replies, this field is set to 0.) + * + * Asynchronous calls may be reordered in arbitrarily with other synchronous + * and asynchronous calls. If you want a guaranteed order, you need to wait + * until asynchronous calls report completion before doing the next call. + * + * See also the section "Asynchronous command details" in the manpage. + * + * Multithreading + * -------------- + * + * The client API is generally fully thread-safe, unless otherwise noted. + * Currently, there is no real advantage in using more than 1 thread to access + * the client API, since everything is serialized through a single lock in the + * playback core. + * + * Basic environment requirements + * ------------------------------ + * + * This documents basic requirements on the C environment. This is especially + * important if mpv is used as library with mpv_create(). + * + * - The LC_NUMERIC locale category must be set to "C". If your program calls + * setlocale(), be sure not to use LC_ALL, or if you do, reset LC_NUMERIC + * to its sane default: setlocale(LC_NUMERIC, "C"). + * - If a X11 based VO is used, mpv will set the xlib error handler. This error + * handler is process-wide, and there's no proper way to share it with other + * xlib users within the same process. This might confuse GUI toolkits. + * - mpv uses some other libraries that are not library-safe, such as Fribidi + * (used through libass), ALSA, FFmpeg, and possibly more. + * - The FPU precision must be set at least to double precision. + * - On Windows, mpv will call timeBeginPeriod(1). + * - On memory exhaustion, mpv will kill the process. + * - In certain cases, mpv may start sub processes (such as with the ytdl + * wrapper script). + * - Using UNIX IPC (off by default) will override the SIGPIPE signal handler, + * and set it to SIG_IGN. Some invocations of the "subprocess" command will + * also do that. + * - mpv may start sub processes, so overriding SIGCHLD, or waiting on all PIDs + * (such as calling wait()) by the parent process or any other library within + * the process must be avoided. libmpv itself only waits for its own PIDs. + * - If anything in the process registers signal handlers, they must set the + * SA_RESTART flag. Otherwise you WILL get random failures on signals. + * + * Encoding of filenames + * --------------------- + * + * mpv uses UTF-8 everywhere. + * + * On some platforms (like Linux), filenames actually do not have to be UTF-8; + * for this reason libmpv supports non-UTF-8 strings. libmpv uses what the + * kernel uses and does not recode filenames. At least on Linux, passing a + * string to libmpv is like passing a string to the fopen() function. + * + * On Windows, filenames are always UTF-8, libmpv converts between UTF-8 and + * UTF-16 when using win32 API functions. libmpv never uses or accepts + * filenames in the local 8 bit encoding. It does not use fopen() either; + * it uses _wfopen(). + * + * On macOS, filenames and other strings taken/returned by libmpv can have + * inconsistent unicode normalization. This can sometimes lead to problems. + * You have to hope for the best. + * + * Also see the remarks for MPV_FORMAT_STRING. + * + * Embedding the video window + * -------------------------- + * + * Using the render API (in render.h) is recommended. This API requires + * you to create and maintain an OpenGL context, to which you can render + * video using a specific API call. This API does not include keyboard or mouse + * input directly. + * + * There is an older way to embed the native mpv window into your own. You have + * to get the raw window handle, and set it as "wid" option. This works on X11, + * win32, and macOS only. It's much easier to use than the render API, but + * also has various problems. + * + * Also see client API examples and the mpv manpage. There is an extensive + * discussion here: + * https://github.com/mpv-player/mpv-examples/tree/master/libmpv#methods-of-embedding-the-video-window + * + * Compatibility + * ------------- + * + * mpv development doesn't stand still, and changes to mpv internals as well as + * to its interface can cause compatibility issues to client API users. + * + * The API is versioned (see MPV_CLIENT_API_VERSION), and changes to it are + * documented in DOCS/client-api-changes.rst. The C API itself will probably + * remain compatible for a long time, but the functionality exposed by it + * could change more rapidly. For example, it's possible that options are + * renamed, or change the set of allowed values. + * + * Defensive programming should be used to potentially deal with the fact that + * options, commands, and properties could disappear, change their value range, + * or change the underlying datatypes. It might be a good idea to prefer + * MPV_FORMAT_STRING over other types to decouple your code from potential + * mpv changes. + * + * Also see: DOCS/compatibility.rst + * + * Future changes + * -------------- + * + * This are the planned changes that will most likely be done on the next major + * bump of the library: + * + * - remove all symbols that are marked as deprecated + * - reassign enum numerical values to remove gaps + * - disabling all events by default + */ + +/** + * The version is incremented on each API change. The 16 lower bits form the + * minor version number, and the 16 higher bits the major version number. If + * the API becomes incompatible to previous versions, the major version + * number is incremented. This affects only C part, and not properties and + * options. + * + * Every API bump is described in DOCS/client-api-changes.rst + * + * You can use MPV_MAKE_VERSION() and compare the result with integer + * relational operators (<, >, <=, >=). + */ +#define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) +#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION (2, 3) + +/** + * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before + * including any libmpv headers. Then deprecated symbols will be excluded + * from the headers. (Of course, deprecated properties and commands and + * other functionality will still work.) + */ +#ifndef MPV_ENABLE_DEPRECATED +#define MPV_ENABLE_DEPRECATED 1 +#endif + + /** + * Return the MPV_CLIENT_API_VERSION the mpv source has been compiled with. + */ + MPV_EXPORT unsigned long mpv_client_api_version (void); + + /** + * Client context used by the client API. Every client has its own private + * handle. + */ + typedef struct mpv_handle mpv_handle; + + /** + * List of error codes than can be returned by API functions. 0 and positive + * return values always mean success, negative values are always errors. + */ + typedef enum mpv_error + { + /** + * No error happened (used to signal successful operation). + * Keep in mind that many API functions returning error codes can also + * return positive values, which also indicate success. API users can + * hardcode the fact that ">= 0" means success. + */ + MPV_ERROR_SUCCESS = 0, + /** + * The event ringbuffer is full. This means the client is choked, and can't + * receive any events. This can happen when too many asynchronous requests + * have been made, but not answered. Probably never happens in practice, + * unless the mpv core is frozen for some reason, and the client keeps + * making asynchronous requests. (Bugs in the client API implementation + * could also trigger this, e.g. if events become "lost".) + */ + MPV_ERROR_EVENT_QUEUE_FULL = -1, + /** + * Memory allocation failed. + */ + MPV_ERROR_NOMEM = -2, + /** + * The mpv core wasn't configured and initialized yet. See the notes in + * mpv_create(). + */ + MPV_ERROR_UNINITIALIZED = -3, + /** + * Generic catch-all error if a parameter is set to an invalid or + * unsupported value. This is used if there is no better error code. + */ + MPV_ERROR_INVALID_PARAMETER = -4, + /** + * Trying to set an option that doesn't exist. + */ + MPV_ERROR_OPTION_NOT_FOUND = -5, + /** + * Trying to set an option using an unsupported MPV_FORMAT. + */ + MPV_ERROR_OPTION_FORMAT = -6, + /** + * Setting the option failed. Typically this happens if the provided option + * value could not be parsed. + */ + MPV_ERROR_OPTION_ERROR = -7, + /** + * The accessed property doesn't exist. + */ + MPV_ERROR_PROPERTY_NOT_FOUND = -8, + /** + * Trying to set or get a property using an unsupported MPV_FORMAT. + */ + MPV_ERROR_PROPERTY_FORMAT = -9, + /** + * The property exists, but is not available. This usually happens when the + * associated subsystem is not active, e.g. querying audio parameters while + * audio is disabled. + */ + MPV_ERROR_PROPERTY_UNAVAILABLE = -10, + /** + * Error setting or getting a property. + */ + MPV_ERROR_PROPERTY_ERROR = -11, + /** + * General error when running a command with mpv_command and similar. + */ + MPV_ERROR_COMMAND = -12, + /** + * Generic error on loading (usually used with mpv_event_end_file.error). + */ + MPV_ERROR_LOADING_FAILED = -13, + /** + * Initializing the audio output failed. + */ + MPV_ERROR_AO_INIT_FAILED = -14, + /** + * Initializing the video output failed. + */ + MPV_ERROR_VO_INIT_FAILED = -15, + /** + * 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. + */ + MPV_ERROR_NOTHING_TO_PLAY = -16, + /** + * When trying to load the file, the file format could not be determined, + * or the file was too broken to open it. + */ + MPV_ERROR_UNKNOWN_FORMAT = -17, + /** + * Generic error for signaling that certain system requirements are not + * fulfilled. + */ + MPV_ERROR_UNSUPPORTED = -18, + /** + * The API function which was called is a stub only. + */ + MPV_ERROR_NOT_IMPLEMENTED = -19, + /** + * Unspecified error. + */ + MPV_ERROR_GENERIC = -20 + } mpv_error; + + /** + * Return a string describing the error. For unknown errors, the string + * "unknown error" is returned. + * + * @param error error number, see enum mpv_error + * @return A static string describing the error. The string is completely + * static, i.e. doesn't need to be deallocated, and is valid forever. + */ + MPV_EXPORT const char *mpv_error_string (int error); + + /** + * General function to deallocate memory returned by some of the API + * functions. Call this only if it's explicitly documented as allowed. + * Calling this on mpv memory not owned by the caller will lead to undefined + * behavior. + * + * @param data A valid pointer returned by the API, or NULL. + */ + MPV_EXPORT void mpv_free (void *data); + + /** + * Return the name of this client handle. Every client has its own unique + * name, which is mostly used for user interface purposes. + * + * @return The client name. The string is read-only and is valid until the + * mpv_handle is destroyed. + */ + MPV_EXPORT const char *mpv_client_name (mpv_handle *ctx); + + /** + * Return the ID of this client handle. Every client has its own unique ID. + * This ID is never reused by the core, even if the mpv_handle at hand gets + * destroyed and new handles get allocated. + * + * IDs are never 0 or negative. + * + * Some mpv APIs (not necessarily all) accept a name in the form "@" in + * addition of the proper mpv_client_name(), where "" is the ID in + * decimal form (e.g. "@123"). For example, the "script-message-to" command + * takes the client name as first argument, but also accepts the client ID + * formatted in this manner. + * + * @return The client ID. + */ + MPV_EXPORT int64_t mpv_client_id (mpv_handle *ctx); + + /** + * Create a new mpv instance and an associated client API handle to control + * the mpv instance. This instance is in a pre-initialized state, + * and needs to be initialized to be actually used with most other API + * functions. + * + * Some API functions will return MPV_ERROR_UNINITIALIZED in the + * uninitialized state. You can call mpv_set_property() (or + * mpv_set_property_string() and other variants, and before mpv 0.21.0 + * mpv_set_option() etc.) to set initial options. After this, call + * mpv_initialize() to start the player, and then use e.g. mpv_command() to + * start playback of a file. + * + * The point of separating handle creation and actual initialization is that + * you can configure things which can't be changed during runtime. + * + * Unlike the command line player, this will have initial settings suitable + * for embedding in applications. The following settings are different: + * - stdin/stdout/stderr and the terminal will never be accessed. This is + * equivalent to setting the --no-terminal option. + * (Technically, this also suppresses C signal handling.) + * - No config files will be loaded. This is roughly equivalent to using + * --config=no. Since libmpv 1.15, you can actually re-enable this option, + * which will make libmpv load config files during mpv_initialize(). If you + * do this, you are strongly encouraged to set the "config-dir" option too. + * (Otherwise it will load the mpv command line player's config.) + * For example: + * mpv_set_option_string(mpv, "config-dir", "/my/path"); // set config + * root mpv_set_option_string(mpv, "config", "yes"); // enable config loading + * (call mpv_initialize() _after_ this) + * - Idle mode is enabled, which means the playback core will enter idle mode + * if there are no more files to play on the internal playlist, instead of + * exiting. This is equivalent to the --idle option. + * - Disable parts of input handling. + * - Most of the different settings can be viewed with the command line + * player by running "mpv --show-profile=libmpv". + * + * All this assumes that API users want a mpv instance that is strictly + * isolated from the command line player's configuration, user settings, and + * so on. You can re-enable disabled features by setting the appropriate + * options. + * + * The mpv command line parser is not available through this API, but you can + * set individual options with mpv_set_property(). Files for playback must be + * loaded with mpv_command() or others. + * + * Note that you should avoid doing concurrent accesses on the uninitialized + * client handle. (Whether concurrent access is definitely allowed or not has + * yet to be decided.) + * + * @return a new mpv client API handle. Returns NULL on error. Currently, + * this can happen in the following situations: + * - out of memory + * - LC_NUMERIC is not set to "C" (see general remarks) + */ + MPV_EXPORT mpv_handle *mpv_create (void); + + /** + * Initialize an uninitialized mpv instance. If the mpv instance is already + * running, an error is returned. + * + * This function needs to be called to make full use of the client API if the + * client API handle was created with mpv_create(). + * + * Only the following options are required to be set _before_ + * mpv_initialize(): + * - options which are only read at initialization time: + * - config + * - config-dir + * - input-conf + * - load-scripts + * - script + * - player-operation-mode + * - input-app-events (macOS) + * - all encoding mode options + * + * @return error code + */ + MPV_EXPORT int mpv_initialize (mpv_handle *ctx); + + /** + * Disconnect and destroy the mpv_handle. ctx will be deallocated with this + * API call. + * + * If the last mpv_handle is detached, the core player is destroyed. In + * addition, if there are only weak mpv_handles (such as created by + * mpv_create_weak_client() or internal scripts), these mpv_handles will + * be sent MPV_EVENT_SHUTDOWN. This function may block until these clients + * have responded to the shutdown event, and the core is finally destroyed. + */ + MPV_EXPORT void mpv_destroy (mpv_handle *ctx); + + /** + * Similar to mpv_destroy(), but brings the player and all clients down + * as well, and waits until all of them are destroyed. This function blocks. + * The advantage over mpv_destroy() is that while mpv_destroy() merely + * detaches the client handle from the player, this function quits the + * player, waits until all other clients are destroyed (i.e. all mpv_handles + * are detached), and also waits for the final termination of the player. + * + * Since mpv_destroy() is called somewhere on the way, it's not safe to + * call other functions concurrently on the same context. + * + * Since mpv client API version 1.29: + * The first call on any mpv_handle will block until the core is destroyed. + * This means it will wait until other mpv_handle have been destroyed. If + * you want asynchronous destruction, just run the "quit" command, and then + * react to the MPV_EVENT_SHUTDOWN event. If another mpv_handle already + * called mpv_terminate_destroy(), this call will not actually block. It will + * destroy the mpv_handle, and exit immediately, while other mpv_handles + * might still be uninitializing. + * + * Before mpv client API version 1.29: + * If this is called on a mpv_handle that was not created with mpv_create(), + * this function will merely send a quit command and then call + * mpv_destroy(), without waiting for the actual shutdown. + */ + MPV_EXPORT void mpv_terminate_destroy (mpv_handle *ctx); + + /** + * Create a new client handle connected to the same player core as ctx. This + * context has its own event queue, its own mpv_request_event() state, its + * own mpv_request_log_messages() state, its own set of observed properties, + * and its own state for asynchronous operations. Otherwise, everything is + * shared. + * + * This handle should be destroyed with mpv_destroy() if no longer + * needed. The core will live as long as there is at least 1 handle + * referencing it. Any handle can make the core quit, which will result in + * every handle receiving MPV_EVENT_SHUTDOWN. + * + * This function can not be called before the main handle was initialized + * with mpv_initialize(). The new handle is always initialized, unless + * ctx=NULL was passed. + * + * @param ctx Used to get the reference to the mpv core; handle-specific + * settings and parameters are not used. + * If NULL, this function behaves like mpv_create() (ignores + * name). + * @param name The client name. This will be returned by mpv_client_name(). + * If the name is already in use, or contains non-alphanumeric characters + * (other than '_'), the name is modified to fit. If NULL, an arbitrary name + * is automatically chosen. + * @return a new handle, or NULL on error + */ + MPV_EXPORT mpv_handle *mpv_create_client (mpv_handle *ctx, const char *name); + + /** + * This is the same as mpv_create_client(), but the created mpv_handle is + * treated as a weak reference. If all mpv_handles referencing a core are + * weak references, the core is automatically destroyed. (This still goes + * through normal uninit of course. Effectively, if the last non-weak + * mpv_handle is destroyed, then the weak mpv_handles receive + * MPV_EVENT_SHUTDOWN and are asked to terminate as well.) + * + * Note if you want to use this like refcounting: you have to be aware that + * mpv_terminate_destroy() _and_ mpv_destroy() for the last non-weak + * mpv_handle will block until all weak mpv_handles are destroyed. + */ + MPV_EXPORT mpv_handle *mpv_create_weak_client (mpv_handle *ctx, + const char *name); + + /** + * Load a config file. This loads and parses the file, and sets every entry + * in the config file's default section as if mpv_set_option_string() is + * called. + * + * The filename should be an absolute path. If it isn't, the actual path used + * is unspecified. (Note: an absolute path starts with '/' on UNIX.) If the + * file wasn't found, MPV_ERROR_INVALID_PARAMETER is returned. + * + * If a fatal error happens when parsing a config file, + * MPV_ERROR_OPTION_ERROR is returned. Errors when setting options as well as + * other types or errors are ignored (even if options do not exist). You can + * still try to capture the resulting error messages with + * mpv_request_log_messages(). Note that it's possible that some options were + * successfully set even if any of these errors happen. + * + * @param filename absolute path to the config file on the local filesystem + * @return error code + */ + MPV_EXPORT int mpv_load_config_file (mpv_handle *ctx, const char *filename); + + /** + * Return the internal time in nanoseconds. This has an arbitrary start + * offset, but will never wrap or go backwards. + * + * Note that this is always the real time, and doesn't necessarily have to do + * with playback time. For example, playback could go faster or slower due to + * playback speed, or due to playback being paused. Use the "time-pos" + * property instead to get the playback status. + * + * Unlike other libmpv APIs, this can be called at absolutely any time (even + * within wakeup callbacks), as long as the context is valid. + * + * Safe to be called from mpv render API threads. + */ + MPV_EXPORT int64_t mpv_get_time_ns (mpv_handle *ctx); + + /** + * Same as mpv_get_time_ns but in microseconds. + */ + MPV_EXPORT int64_t mpv_get_time_us (mpv_handle *ctx); + + /** + * Data format for options and properties. The API functions to get/set + * properties and options support multiple formats, and this enum describes + * them. + */ + typedef enum mpv_format + { + /** + * Invalid. Sometimes used for empty values. This is always defined to 0, + * so a normal 0-init of mpv_format (or e.g. mpv_node) is guaranteed to set + * this it to MPV_FORMAT_NONE (which makes some things saner as + * consequence). + */ + MPV_FORMAT_NONE = 0, + /** + * The basic type is char*. It returns the raw property string, like + * using ${=property} in input.conf (see input.rst). + * + * NULL isn't an allowed value. + * + * Warning: although the encoding is usually UTF-8, this is not always the + * case. File tags often store strings in some legacy codepage, + * and even filenames don't necessarily have to be in UTF-8 (at + * least on Linux). If you pass the strings to code that requires + * valid UTF-8, you have to sanitize it in some way. + * On Windows, filenames are always UTF-8, and libmpv converts + * between UTF-8 and UTF-16 when using win32 API functions. See + * the "Encoding of filenames" section for details. + * + * Example for reading: + * + * char *result = NULL; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_STRING, &result) < + * 0) goto error; printf("%s\n", result); mpv_free(result); + * + * Or just use mpv_get_property_string(). + * + * Example for writing: + * + * char *value = "the new value"; + * // yep, you pass the address to the variable + * // (needed for symmetry with other types and mpv_get_property) + * mpv_set_property(ctx, "property", MPV_FORMAT_STRING, &value); + * + * Or just use mpv_set_property_string(). + * + */ + MPV_FORMAT_STRING = 1, + /** + * The basic type is char*. It returns the OSD property string, like + * using ${property} in input.conf (see input.rst). In many cases, this + * is the same as the raw string, but in other cases it's formatted for + * display on OSD. It's intended to be human readable. Do not attempt to + * parse these strings. + * + * Only valid when doing read access. The rest works like + * MPV_FORMAT_STRING. + */ + MPV_FORMAT_OSD_STRING = 2, + /** + * The basic type is int. The only allowed values are 0 ("no") + * and 1 ("yes"). + * + * Example for reading: + * + * int result; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_FLAG, &result) < 0) + * goto error; + * printf("%s\n", result ? "true" : "false"); + * + * Example for writing: + * + * int flag = 1; + * mpv_set_property(ctx, "property", MPV_FORMAT_FLAG, &flag); + */ + MPV_FORMAT_FLAG = 3, + /** + * The basic type is int64_t. + */ + MPV_FORMAT_INT64 = 4, + /** + * The basic type is double. + */ + MPV_FORMAT_DOUBLE = 5, + /** + * The type is mpv_node. + * + * For reading, you usually would pass a pointer to a stack-allocated + * mpv_node value to mpv, and when you're done you call + * mpv_free_node_contents(&node). + * You're expected not to write to the data - if you have to, copy it + * first (which you have to do manually). + * + * For writing, you construct your own mpv_node, and pass a pointer to the + * API. The API will never write to your data (and copy it if needed), so + * you're free to use any form of allocation or memory management you like. + * + * Warning: when reading, always check the mpv_node.format member. For + * example, properties might change their type in future versions + * of mpv, or sometimes even during runtime. + * + * Example for reading: + * + * mpv_node result; + * if (mpv_get_property(ctx, "property", MPV_FORMAT_NODE, &result) < 0) + * goto error; + * printf("format=%d\n", (int)result.format); + * mpv_free_node_contents(&result). + * + * Example for writing: + * + * mpv_node value; + * value.format = MPV_FORMAT_STRING; + * value.u.string = "hello"; + * mpv_set_property(ctx, "property", MPV_FORMAT_NODE, &value); + */ + MPV_FORMAT_NODE = 6, + /** + * Used with mpv_node only. Can usually not be used directly. + */ + MPV_FORMAT_NODE_ARRAY = 7, + /** + * See MPV_FORMAT_NODE_ARRAY. + */ + MPV_FORMAT_NODE_MAP = 8, + /** + * A raw, untyped byte array. Only used only with mpv_node, and only in + * some very specific situations. (Some commands use it.) + */ + MPV_FORMAT_BYTE_ARRAY = 9 + } mpv_format; + + /** + * Generic data storage. + * + * If mpv writes this struct (e.g. via mpv_get_property()), you must not + * change the data. In some cases (mpv_get_property()), you have to free it + * with mpv_free_node_contents(). If you fill this struct yourself, you're + * also responsible for freeing it, and you must not call + * mpv_free_node_contents(). + */ + typedef struct mpv_node + { + union + { + char *string; /** valid if format==MPV_FORMAT_STRING */ + int flag; /** valid if format==MPV_FORMAT_FLAG */ + int64_t int64; /** valid if format==MPV_FORMAT_INT64 */ + double double_; /** valid if format==MPV_FORMAT_DOUBLE */ + /** + * valid if format==MPV_FORMAT_NODE_ARRAY + * or if format==MPV_FORMAT_NODE_MAP + */ + struct mpv_node_list *list; + /** + * valid if format==MPV_FORMAT_BYTE_ARRAY + */ + struct mpv_byte_array *ba; + } u; + /** + * Type of the data stored in this struct. This value rules what members in + * the given union can be accessed. The following formats are currently + * defined to be allowed in mpv_node: + * + * MPV_FORMAT_STRING (u.string) + * MPV_FORMAT_FLAG (u.flag) + * MPV_FORMAT_INT64 (u.int64) + * MPV_FORMAT_DOUBLE (u.double_) + * MPV_FORMAT_NODE_ARRAY (u.list) + * MPV_FORMAT_NODE_MAP (u.list) + * MPV_FORMAT_BYTE_ARRAY (u.ba) + * MPV_FORMAT_NONE (no member) + * + * If you encounter a value you don't know, you must not make any + * assumptions about the contents of union u. + */ + mpv_format format; + } mpv_node; + + /** + * (see mpv_node) + */ + typedef struct mpv_node_list + { + /** + * Number of entries. Negative values are not allowed. + */ + int num; + /** + * MPV_FORMAT_NODE_ARRAY: + * values[N] refers to value of the Nth item + * + * MPV_FORMAT_NODE_MAP: + * values[N] refers to value of the Nth key/value pair + * + * If num > 0, values[0] to values[num-1] (inclusive) are valid. + * Otherwise, this can be NULL. + */ + mpv_node *values; + /** + * MPV_FORMAT_NODE_ARRAY: + * unused (typically NULL), access is not allowed + * + * MPV_FORMAT_NODE_MAP: + * keys[N] refers to key of the Nth key/value pair. If num > 0, keys[0] to + * keys[num-1] (inclusive) are valid. Otherwise, this can be NULL. + * The keys are in random order. The only guarantee is that keys[N] + * belongs to the value values[N]. NULL keys are not allowed. + */ + char **keys; + } mpv_node_list; + + /** + * (see mpv_node) + */ + typedef struct mpv_byte_array + { + /** + * Pointer to the data. In what format the data is stored is up to whatever + * uses MPV_FORMAT_BYTE_ARRAY. + */ + void *data; + /** + * Size of the data pointed to by ptr. + */ + size_t size; + } mpv_byte_array; + + /** + * Frees any data referenced by the node. It doesn't free the node itself. + * Call this only if the mpv client API set the node. If you constructed the + * node yourself (manually), you have to free it yourself. + * + * If node->format is MPV_FORMAT_NONE, this call does nothing. Likewise, if + * the client API sets a node with this format, this function doesn't need to + * be called. (This is just a clarification that there's no danger of + * anything strange happening in these cases.) + */ + MPV_EXPORT void mpv_free_node_contents (mpv_node *node); + + /** + * Set an option. Note that you can't normally set options during runtime. It + * works in uninitialized state (see mpv_create()), and in some cases in at + * runtime. + * + * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a + * mpv_node with the given format and data, and passing the mpv_node to this + * function. + * + * Note: this is semi-deprecated. For most purposes, this is not needed + * anymore. Starting with mpv version 0.21.0 (version 1.23) most options can + * be set with mpv_set_property() (and related functions), and even before + * mpv_initialize(). In some obscure corner cases, using this function + * to set options might still be required (see + * "Inconsistencies between options and properties" in the manpage). + * Once these are resolved, the option setting functions might be fully + * deprecated. + * + * @param name Option name. This is the same as on the mpv command line, but + * without the leading "--". + * @param format see enum mpv_format. + * @param[in] data Option value (according to the format). + * @return error code + */ + MPV_EXPORT int mpv_set_option (mpv_handle *ctx, const char *name, + mpv_format format, void *data); + + /** + * Convenience function to set an option to a string value. This is like + * calling mpv_set_option() with MPV_FORMAT_STRING. + * + * @return error code + */ + MPV_EXPORT int mpv_set_option_string (mpv_handle *ctx, const char *name, + const char *data); + + /** + * Send a command to the player. Commands are the same as those used in + * input.conf, except that this function takes parameters in a pre-split + * form. + * + * The commands and their parameters are documented in input.rst. + * + * Does not use OSD and string expansion by default (unlike + * mpv_command_string() and input.conf). + * + * @param[in] args NULL-terminated list of strings. Usually, the first item + * is the command, and the following items are arguments. + * @return error code + */ + MPV_EXPORT int mpv_command (mpv_handle *ctx, const char **args); + + /** + * Same as mpv_command(), but allows passing structured data in any format. + * In particular, calling mpv_command() is exactly like calling + * mpv_command_node() with the format set to MPV_FORMAT_NODE_ARRAY, and + * every arg passed in order as MPV_FORMAT_STRING. + * + * Does not use OSD and string expansion by default. + * + * The args argument can have one of the following formats: + * + * MPV_FORMAT_NODE_ARRAY: + * Positional arguments. Each entry is an argument using an arbitrary + * format (the format must be compatible to the used command). Usually, + * the first item is the command name (as MPV_FORMAT_STRING). The order + * of arguments is as documented in each command description. + * + * MPV_FORMAT_NODE_MAP: + * Named arguments. This requires at least an entry with the key "name" + * to be present, which must be a string, and contains the command name. + * The special entry "_flags" is optional, and if present, must be an + * array of strings, each being a command prefix to apply. All other + * entries are interpreted as arguments. They must use the argument + * names as documented in each command description. Some commands do not + * support named arguments at all, and must use MPV_FORMAT_NODE_ARRAY. + * + * @param[in] args mpv_node with format set to one of the values documented + * above (see there for details) + * @param[out] result Optional, pass NULL if unused. If not NULL, and if the + * function succeeds, this is set to command-specific + * return data. You must call mpv_free_node_contents() to free it (again, + * only if the command actually succeeds). Not many commands actually use + * this at all. + * @return error code (the result parameter is not set on error) + */ + MPV_EXPORT int mpv_command_node (mpv_handle *ctx, mpv_node *args, + mpv_node *result); + + /** + * This is essentially identical to mpv_command() but it also returns a + * result. + * + * Does not use OSD and string expansion by default. + * + * @param[in] args NULL-terminated list of strings. Usually, the first item + * is the command, and the following items are arguments. + * @param[out] result Optional, pass NULL if unused. If not NULL, and if the + * function succeeds, this is set to command-specific + * return data. You must call mpv_free_node_contents() to free it (again, + * only if the command actually succeeds). Not many commands actually use + * this at all. + * @return error code (the result parameter is not set on error) + */ + MPV_EXPORT int mpv_command_ret (mpv_handle *ctx, const char **args, + mpv_node *result); + + /** + * Same as mpv_command, but use input.conf parsing for splitting arguments. + * This is slightly simpler, but also more error prone, since arguments may + * need quoting/escaping. + * + * This also has OSD and string expansion enabled by default. + */ + MPV_EXPORT int mpv_command_string (mpv_handle *ctx, const char *args); + + /** + * Same as mpv_command, but run the command asynchronously. + * + * Commands are executed asynchronously. You will receive a + * MPV_EVENT_COMMAND_REPLY event. This event will also have an + * error code set if running the command failed. For commands that + * return data, the data is put into mpv_event_command.result. + * + * The only case when you do not receive an event is when the function call + * itself fails. This happens only if parsing the command itself (or + * otherwise validating it) fails, i.e. the return code of the API call is + * not 0 or positive. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata the value mpv_event.reply_userdata of the reply will + * be set to (see section about asynchronous calls) + * @param args NULL-terminated list of strings (see mpv_command()) + * @return error code (if parsing or queuing the command fails) + */ + MPV_EXPORT int mpv_command_async (mpv_handle *ctx, uint64_t reply_userdata, + const char **args); + + /** + * Same as mpv_command_node(), but run it asynchronously. Basically, this + * function is to mpv_command_node() what mpv_command_async() is to + * mpv_command(). + * + * See mpv_command_async() for details. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata the value mpv_event.reply_userdata of the reply will + * be set to (see section about asynchronous calls) + * @param args as in mpv_command_node() + * @return error code (if parsing or queuing the command fails) + */ + MPV_EXPORT int mpv_command_node_async (mpv_handle *ctx, + uint64_t reply_userdata, + mpv_node *args); + + /** + * Signal to all async requests with the matching ID to abort. This affects + * the following API calls: + * + * mpv_command_async + * mpv_command_node_async + * + * All of these functions take a reply_userdata parameter. This API function + * tells all requests with the matching reply_userdata value to try to return + * as soon as possible. If there are multiple requests with matching ID, it + * aborts all of them. + * + * This API function is mostly asynchronous itself. It will not wait until + * the command is aborted. Instead, the command will terminate as usual, but + * with some work not done. How this is signaled depends on the specific + * command (for example, the "subprocess" command will indicate it by + * "killed_by_us" set to true in the result). How long it takes also depends + * on the situation. The aborting process is completely asynchronous. + * + * Not all commands may support this functionality. In this case, this + * function will have no effect. The same is true if the request using the + * passed reply_userdata has already terminated, has not been started yet, or + * was never in use at all. + * + * You have to be careful of race conditions: the time during which the abort + * request will be effective is _after_ e.g. mpv_command_async() has + * returned, and before the command has signaled completion with + * MPV_EVENT_COMMAND_REPLY. + * + * @param reply_userdata ID of the request to be aborted (see above) + */ + MPV_EXPORT void mpv_abort_async_command (mpv_handle *ctx, + uint64_t reply_userdata); + + /** + * Set a property to a given value. Properties are essentially variables + * which can be queried or set at runtime. For example, writing to the pause + * property will actually pause or unpause playback. + * + * If the format doesn't match with the internal format of the property, + * access usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, + * the data is automatically converted and access succeeds. For example, + * MPV_FORMAT_INT64 is always converted to MPV_FORMAT_DOUBLE, and access + * using MPV_FORMAT_STRING usually invokes a string parser. The same happens + * when calling this function with MPV_FORMAT_NODE: the underlying format may + * be converted to another type if possible. + * + * Using a format other than MPV_FORMAT_NODE is equivalent to constructing a + * mpv_node with the given format and data, and passing the mpv_node to this + * function. (Before API version 1.21, this was different.) + * + * Note: starting with mpv 0.21.0 (client API version 1.23), this can be used + * to set options in general. It even can be used before mpv_initialize() has + * been called. If called before mpv_initialize(), setting properties not + * backed by options will result in MPV_ERROR_PROPERTY_UNAVAILABLE. In some + * cases, properties and options still conflict. In these cases, + * mpv_set_property() accesses the options before mpv_initialize(), and + * the properties after mpv_initialize(). These conflicts will be + * removed in mpv 0.23.0. See mpv_set_option() for further remarks. + * + * @param name The property name. See input.rst for a list of properties. + * @param format see enum mpv_format. + * @param[in] data Option value. + * @return error code + */ + MPV_EXPORT int mpv_set_property (mpv_handle *ctx, const char *name, + mpv_format format, void *data); + + /** + * Convenience function to set a property to a string value. + * + * This is like calling mpv_set_property() with MPV_FORMAT_STRING. + */ + MPV_EXPORT int mpv_set_property_string (mpv_handle *ctx, const char *name, + const char *data); + + /** + * Convenience function to delete a property. + * + * This is equivalent to running the command "del [name]". + * + * @param name The property name. See input.rst for a list of properties. + * @return error code + */ + MPV_EXPORT int mpv_del_property (mpv_handle *ctx, const char *name); + + /** + * Set a property asynchronously. You will receive the result of the + * operation as MPV_EVENT_SET_PROPERTY_REPLY event. The mpv_event.error field + * will contain the result status of the operation. Otherwise, this function + * is similar to mpv_set_property(). + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata see section about asynchronous calls + * @param name The property name. + * @param format see enum mpv_format. + * @param[in] data Option value. The value will be copied by the function. It + * will never be modified by the client API. + * @return error code if sending the request failed + */ + MPV_EXPORT int mpv_set_property_async (mpv_handle *ctx, + uint64_t reply_userdata, + const char *name, mpv_format format, + void *data); + + /** + * Read the value of the given property. + * + * If the format doesn't match with the internal format of the property, + * access usually will fail with MPV_ERROR_PROPERTY_FORMAT. In some cases, + * the data is automatically converted and access succeeds. For example, + * MPV_FORMAT_INT64 is always converted to MPV_FORMAT_DOUBLE, and access + * using MPV_FORMAT_STRING usually invokes a string formatter. + * + * @param name The property name. + * @param format see enum mpv_format. + * @param[out] data Pointer to the variable holding the option value. On + * success, the variable will be set to a copy of the option + * value. For formats that require dynamic memory + * allocation, you can free the value with mpv_free() (strings) or + * mpv_free_node_contents() (MPV_FORMAT_NODE). + * @return error code + */ + MPV_EXPORT int mpv_get_property (mpv_handle *ctx, const char *name, + mpv_format format, void *data); + + /** + * Return the value of the property with the given name as string. This is + * equivalent to mpv_get_property() with MPV_FORMAT_STRING. + * + * See MPV_FORMAT_STRING for character encoding issues. + * + * On error, NULL is returned. Use mpv_get_property() if you want + * fine-grained error reporting. + * + * @param name The property name. + * @return Property value, or NULL if the property can't be retrieved. Free + * the string with mpv_free(). + */ + MPV_EXPORT char *mpv_get_property_string (mpv_handle *ctx, const char *name); + + /** + * Return the property as "OSD" formatted string. This is the same as + * mpv_get_property_string, but using MPV_FORMAT_OSD_STRING. + * + * @return Property value, or NULL if the property can't be retrieved. Free + * the string with mpv_free(). + */ + MPV_EXPORT char *mpv_get_property_osd_string (mpv_handle *ctx, + const char *name); + + /** + * Get a property asynchronously. You will receive the result of the + * operation as well as the property data with the + * MPV_EVENT_GET_PROPERTY_REPLY event. You should check the mpv_event.error + * field on the reply event. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata see section about asynchronous calls + * @param name The property name. + * @param format see enum mpv_format. + * @return error code if sending the request failed + */ + MPV_EXPORT int mpv_get_property_async (mpv_handle *ctx, + uint64_t reply_userdata, + const char *name, mpv_format format); + + /** + * Get a notification whenever the given property changes. You will receive + * updates as MPV_EVENT_PROPERTY_CHANGE. Note that this is not very precise: + * for some properties, it may not send updates even if the property changed. + * This depends on the property, and it's a valid feature request to ask for + * better update handling of a specific property. (For some properties, like + * ``clock``, which shows the wall clock, this mechanism doesn't make too + * much sense anyway.) + * + * Property changes are coalesced: the change events are returned only once + * the event queue becomes empty (e.g. mpv_wait_event() would block or return + * MPV_EVENT_NONE), and then only one event per changed property is returned. + * + * You always get an initial change notification. This is meant to initialize + * the user's state to the current value of the property. + * + * Normally, change events are sent only if the property value changes + * according to the requested format. mpv_event_property will contain the + * property value as data member. + * + * Warning: if a property is unavailable or retrieving it caused an error, + * MPV_FORMAT_NONE will be set in mpv_event_property, even if the + * format parameter was set to a different value. In this case, the + * mpv_event_property.data field is invalid. + * + * If the property is observed with the format parameter set to + * MPV_FORMAT_NONE, you get low-level notifications whether the property + * _may_ have changed, and the data member in mpv_event_property will be + * unset. With this mode, you will have to determine yourself whether the + * property really changed. On the other hand, this mechanism can be faster + * and uses less resources. + * + * Observing a property that doesn't exist is allowed. (Although it may still + * cause some sporadic change events.) + * + * Keep in mind that you will get change notifications even if you change a + * property yourself. Try to avoid endless feedback loops, which could happen + * if you react to the change notifications triggered by your own change. + * + * Only the mpv_handle on which this was called will receive the property + * change events, or can unobserve them. + * + * Safe to be called from mpv render API threads. + * + * @param reply_userdata This will be used for the mpv_event.reply_userdata + * field for the received MPV_EVENT_PROPERTY_CHANGE + * events. (Also see section about asynchronous calls, + * although this function is somewhat different from + * actual asynchronous calls.) + * If you have no use for this, pass 0. + * Also see mpv_unobserve_property(). + * @param name The property name. + * @param format see enum mpv_format. Can be MPV_FORMAT_NONE to omit values + * from the change events. + * @return error code (usually fails only on OOM or unsupported format) + */ + MPV_EXPORT int mpv_observe_property (mpv_handle *mpv, + uint64_t reply_userdata, + const char *name, mpv_format format); + + /** + * Undo mpv_observe_property(). This will remove all observed properties for + * which the given number was passed as reply_userdata to + * mpv_observe_property. + * + * Safe to be called from mpv render API threads. + * + * @param registered_reply_userdata ID that was passed to + * mpv_observe_property + * @return negative value is an error code, >=0 is number of removed + * properties on success (includes the case when 0 were removed) + */ + MPV_EXPORT int mpv_unobserve_property (mpv_handle *mpv, + uint64_t registered_reply_userdata); + + typedef enum mpv_event_id + { + /** + * Nothing happened. Happens on timeouts or sporadic wakeups. + */ + MPV_EVENT_NONE = 0, + /** + * Happens when the player quits. The player enters a state where it tries + * to disconnect all clients. Most requests to the player will fail, and + * the client should react to this and quit with mpv_destroy() as soon as + * possible. + */ + MPV_EVENT_SHUTDOWN = 1, + /** + * See mpv_request_log_messages(). + */ + MPV_EVENT_LOG_MESSAGE = 2, + /** + * Reply to a mpv_get_property_async() request. + * See also mpv_event and mpv_event_property. + */ + MPV_EVENT_GET_PROPERTY_REPLY = 3, + /** + * Reply to a mpv_set_property_async() request. + * (Unlike MPV_EVENT_GET_PROPERTY, mpv_event_property is not used.) + */ + MPV_EVENT_SET_PROPERTY_REPLY = 4, + /** + * Reply to a mpv_command_async() or mpv_command_node_async() request. + * See also mpv_event and mpv_event_command. + */ + MPV_EVENT_COMMAND_REPLY = 5, + /** + * Notification before playback start of a file (before the file is + * loaded). See also mpv_event and mpv_event_start_file. + */ + MPV_EVENT_START_FILE = 6, + /** + * Notification after playback end (after the file was unloaded). + * See also mpv_event and mpv_event_end_file. + */ + MPV_EVENT_END_FILE = 7, + /** + * Notification when the file has been loaded (headers were read etc.), and + * decoding starts. + */ + MPV_EVENT_FILE_LOADED = 8, +#if MPV_ENABLE_DEPRECATED + /** + * Idle mode was entered. In this mode, no file is played, and the playback + * core waits for new commands. (The command line player normally quits + * instead of entering idle mode, unless --idle was specified. If mpv + * was started with mpv_create(), idle mode is enabled by default.) + * + * @deprecated This is equivalent to using mpv_observe_property() on the + * "idle-active" property. The event is redundant, and might be + * removed in the far future. As a further warning, this event + * is not necessarily sent at the right point anymore (at the + * start of the program), while the property behaves correctly. + */ + MPV_EVENT_IDLE = 11, + /** + * Sent every time after a video frame is displayed. Note that currently, + * this will be sent in lower frequency if there is no video, or playback + * is paused - but that will be removed in the future, and it will be + * restricted to video frames only. + * + * @deprecated Use mpv_observe_property() with relevant properties instead + * (such as "playback-time"). + */ + MPV_EVENT_TICK = 14, +#endif + /** + * Triggered by the script-message input command. The command uses the + * first argument of the command as client name (see mpv_client_name()) to + * dispatch the message, and passes along all arguments starting from the + * second argument as strings. + * See also mpv_event and mpv_event_client_message. + */ + MPV_EVENT_CLIENT_MESSAGE = 16, + /** + * Happens after video changed in some way. This can happen on resolution + * changes, pixel format changes, or video filter changes. The event is + * sent after the video filters and the VO are reconfigured. Applications + * embedding a mpv window should listen to this event in order to resize + * the window if needed. + * Note that this event can happen sporadically, and you should check + * yourself whether the video parameters really changed before doing + * something expensive. + */ + MPV_EVENT_VIDEO_RECONFIG = 17, + /** + * Similar to MPV_EVENT_VIDEO_RECONFIG. This is relatively uninteresting, + * because there is no such thing as audio output embedding. + */ + MPV_EVENT_AUDIO_RECONFIG = 18, + /** + * Happens when a seek was initiated. Playback stops. Usually it will + * resume with MPV_EVENT_PLAYBACK_RESTART as soon as the seek is finished. + */ + MPV_EVENT_SEEK = 20, + /** + * There was a discontinuity of some sort (like a seek), and playback + * was reinitialized. Usually happens on start of playback and after + * seeking. The main purpose is allowing the client to detect when a seek + * request is finished. + */ + MPV_EVENT_PLAYBACK_RESTART = 21, + /** + * Event sent due to mpv_observe_property(). + * See also mpv_event and mpv_event_property. + */ + MPV_EVENT_PROPERTY_CHANGE = 22, + /** + * Happens if the internal per-mpv_handle ringbuffer overflows, and at + * least 1 event had to be dropped. This can happen if the client doesn't + * read the event queue quickly enough with mpv_wait_event(), or if the + * client makes a very large number of asynchronous calls at once. + * + * Event delivery will continue normally once this event was returned + * (this forces the client to empty the queue completely). + */ + MPV_EVENT_QUEUE_OVERFLOW = 24, + /** + * Triggered if a hook handler was registered with mpv_hook_add(), and the + * hook is invoked. If you receive this, you must handle it, and continue + * the hook with mpv_hook_continue(). + * See also mpv_event and mpv_event_hook. + */ + MPV_EVENT_HOOK = 25, + // Internal note: adjust INTERNAL_EVENT_BASE when adding new events. + } mpv_event_id; + + /** + * Return a string describing the event. For unknown events, NULL is + * returned. + * + * Note that all events actually returned by the API will also yield a + * non-NULL string with this function. + * + * @param event event ID, see see enum mpv_event_id + * @return A static string giving a short symbolic name of the event. It + * consists of lower-case alphanumeric characters and can include "-" + * characters. This string is suitable for use in e.g. scripting + * interfaces. + * The string is completely static, i.e. doesn't need to be + * deallocated, and is valid forever. + */ + MPV_EXPORT const char *mpv_event_name (mpv_event_id event); + + typedef struct mpv_event_property + { + /** + * Name of the property. + */ + const char *name; + /** + * Format of the data field in the same struct. See enum mpv_format. + * This is always the same format as the requested format, except when + * the property could not be retrieved (unavailable, or an error happened), + * in which case the format is MPV_FORMAT_NONE. + */ + mpv_format format; + /** + * Received property value. Depends on the format. This is like the + * pointer argument passed to mpv_get_property(). + * + * For example, for MPV_FORMAT_STRING you get the string with: + * + * char *value = *(char **)(event_property->data); + * + * Note that this is set to NULL if retrieving the property failed (the + * format will be MPV_FORMAT_NONE). + */ + void *data; + } mpv_event_property; + + /** + * Numeric log levels. The lower the number, the more important the message + * is. MPV_LOG_LEVEL_NONE is never used when receiving messages. The string + * in the comment after the value is the name of the log level as used for + * the mpv_request_log_messages() function. Unused numeric values are unused, + * but reserved for future use. + */ + typedef enum mpv_log_level + { + MPV_LOG_LEVEL_NONE = 0, /// "no" - disable absolutely all messages + MPV_LOG_LEVEL_FATAL = 10, /// "fatal" - critical/aborting errors + MPV_LOG_LEVEL_ERROR = 20, /// "error" - simple errors + MPV_LOG_LEVEL_WARN = 30, /// "warn" - possible problems + MPV_LOG_LEVEL_INFO = 40, /// "info" - informational message + MPV_LOG_LEVEL_V = 50, /// "v" - noisy informational message + MPV_LOG_LEVEL_DEBUG = 60, /// "debug" - very noisy technical information + MPV_LOG_LEVEL_TRACE = 70, /// "trace" - extremely noisy + } mpv_log_level; + + typedef struct mpv_event_log_message + { + /** + * The module prefix, identifies the sender of the message. As a special + * case, if the message buffer overflows, this will be set to the string + * "overflow" (which doesn't appear as prefix otherwise), and the text + * field will contain an informative message. + */ + const char *prefix; + /** + * The log level as string. See mpv_request_log_messages() for possible + * values. The level "no" is never used here. + */ + const char *level; + /** + * The log message. It consists of 1 line of text, and is terminated with + * a newline character. (Before API version 1.6, it could contain multiple + * or partial lines.) + */ + const char *text; + /** + * The same contents as the level field, but as a numeric ID. + * Since API version 1.6. + */ + mpv_log_level log_level; + } mpv_event_log_message; + + /// Since API version 1.9. + typedef enum mpv_end_file_reason + { + /** + * The end of file was reached. Sometimes this may also happen on + * incomplete or corrupted files, or if the network connection was + * interrupted when playing a remote file. It also happens if the + * playback range was restricted with --end or --frames or similar. + */ + MPV_END_FILE_REASON_EOF = 0, + /** + * Playback was stopped by an external action (e.g. playlist controls). + */ + MPV_END_FILE_REASON_STOP = 2, + /** + * Playback was stopped by the quit command or player shutdown. + */ + MPV_END_FILE_REASON_QUIT = 3, + /** + * Some kind of error happened that lead to playback abort. Does not + * necessarily happen on incomplete or broken files (in these cases, both + * MPV_END_FILE_REASON_ERROR or MPV_END_FILE_REASON_EOF are possible). + * + * mpv_event_end_file.error will be set. + */ + MPV_END_FILE_REASON_ERROR = 4, + /** + * The file was a playlist or similar. When the playlist is read, its + * entries will be appended to the playlist after the entry of the current + * file, the entry of the current file is removed, and a MPV_EVENT_END_FILE + * event is sent with reason set to MPV_END_FILE_REASON_REDIRECT. Then + * playback continues with the playlist contents. + * Since API version 1.18. + */ + MPV_END_FILE_REASON_REDIRECT = 5, + } mpv_end_file_reason; + + /// Since API version 1.108. + typedef struct mpv_event_start_file + { + /** + * Playlist entry ID of the file being loaded now. + */ + int64_t playlist_entry_id; + } mpv_event_start_file; + + typedef struct mpv_event_end_file + { + /** + * Corresponds to the values in enum mpv_end_file_reason. + * + * Unknown values should be treated as unknown. + */ + mpv_end_file_reason reason; + /** + * If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code + * (one of MPV_ERROR_...) giving an approximate reason why playback + * failed. In other cases, this field is 0 (no error). + * Since API version 1.9. + */ + int error; + /** + * Playlist entry ID of the file that was being played or attempted to be + * played. This has the same value as the playlist_entry_id field in the + * corresponding mpv_event_start_file event. + * Since API version 1.108. + */ + int64_t playlist_entry_id; + /** + * If loading ended, because the playlist entry to be played was for + * example a playlist, and the current playlist entry is replaced with a + * number of other entries. This may happen at least with + * MPV_END_FILE_REASON_REDIRECT (other event types may use this for similar + * but different purposes in the future). In this case, playlist_insert_id + * will be set to the playlist entry ID of the first inserted entry, and + * playlist_insert_num_entries to the total number of inserted playlist + * entries. Note this in this specific case, the ID of the last inserted + * entry is playlist_insert_id+num-1. Beware that depending on + * circumstances, you may observe the new playlist entries before seeing + * the event (e.g. reading the "playlist" property or getting a property + * change notification before receiving the event). Since API + * version 1.108. + */ + int64_t playlist_insert_id; + /** + * See playlist_insert_id. Only non-0 if playlist_insert_id is valid. Never + * negative. + * Since API version 1.108. + */ + int playlist_insert_num_entries; + } mpv_event_end_file; + + typedef struct mpv_event_client_message + { + /** + * Arbitrary arguments chosen by the sender of the message. If num_args > + * 0, you can access args[0] through args[num_args - 1] (inclusive). What + * these arguments mean is up to the sender and receiver. + * None of the valid items are NULL. + */ + int num_args; + const char **args; + } mpv_event_client_message; + + typedef struct mpv_event_hook + { + /** + * The hook name as passed to mpv_hook_add(). + */ + const char *name; + /** + * Internal ID that must be passed to mpv_hook_continue(). + */ + uint64_t id; + } mpv_event_hook; + + // Since API version 1.102. + typedef struct mpv_event_command + { + /** + * Result data of the command. Note that success/failure is signaled + * separately via mpv_event.error. This field is only for result data + * in case of success. Most commands leave it at MPV_FORMAT_NONE. Set + * to MPV_FORMAT_NONE on failure. + */ + mpv_node result; + } mpv_event_command; + + typedef struct mpv_event + { + /** + * One of mpv_event. Keep in mind that later ABI compatible releases might + * add new event types. These should be ignored by the API user. + */ + mpv_event_id event_id; + /** + * This is mainly used for events that are replies to (asynchronous) + * requests. It contains a status code, which is >= 0 on success, or < 0 + * on error (a mpv_error value). Usually, this will be set if an + * asynchronous request fails. + * Used for: + * MPV_EVENT_GET_PROPERTY_REPLY + * MPV_EVENT_SET_PROPERTY_REPLY + * MPV_EVENT_COMMAND_REPLY + */ + int error; + /** + * If the event is in reply to a request (made with this API and this + * API handle), this is set to the reply_userdata parameter of the request + * call. Otherwise, this field is 0. + * Used for: + * MPV_EVENT_GET_PROPERTY_REPLY + * MPV_EVENT_SET_PROPERTY_REPLY + * MPV_EVENT_COMMAND_REPLY + * MPV_EVENT_PROPERTY_CHANGE + * MPV_EVENT_HOOK + */ + uint64_t reply_userdata; + /** + * The meaning and contents of the data member depend on the event_id: + * MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* + * MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* + * MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* + * MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* + * MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) + * MPV_EVENT_END_FILE: mpv_event_end_file* + * MPV_EVENT_HOOK: mpv_event_hook* + * MPV_EVENT_COMMAND_REPLY* mpv_event_command* + * other: NULL + * + * Note: future enhancements might add new event structs for existing or + * new event types. + */ + void *data; + } mpv_event; + + /** + * Convert the given src event to a mpv_node, and set *dst to the result. + * *dst is set to a MPV_FORMAT_NODE_MAP, with fields for corresponding + * mpv_event and mpv_event.data/mpv_event_* fields. + * + * The exact details are not completely documented out of laziness. A start + * is located in the "Events" section of the manpage. + * + * *dst may point to newly allocated memory, or pointers in mpv_event. You + * must copy the entire mpv_node if you want to reference it after mpv_event + * becomes invalid (such as making a new mpv_wait_event() call, or destroying + * the mpv_handle from which it was returned). Call mpv_free_node_contents() + * to free any memory allocations made by this API function. + * + * Safe to be called from mpv render API threads. + * + * @param dst Target. This is not read and fully overwritten. Must be + * released with mpv_free_node_contents(). Do not write to pointers returned + * by it. (On error, this may be left as an empty node.) + * @param src The source event. Not modified (it's not const due to the + * author's prejudice of the C version of const). + * @return error code (MPV_ERROR_NOMEM only, if at all) + */ + MPV_EXPORT int mpv_event_to_node (mpv_node *dst, mpv_event *src); + + /** + * Enable or disable the given event. + * + * Some events are enabled by default. Some events can't be disabled. + * + * (Informational note: currently, all events are enabled by default, except + * MPV_EVENT_TICK.) + * + * Safe to be called from mpv render API threads. + * + * @param event See enum mpv_event_id. + * @param enable 1 to enable receiving this event, 0 to disable it. + * @return error code + */ + MPV_EXPORT int mpv_request_event (mpv_handle *ctx, mpv_event_id event, + int enable); + + /** + * Enable or disable receiving of log messages. These are the messages the + * command line player prints to the terminal. This call sets the minimum + * required log level for a message to be received with + * MPV_EVENT_LOG_MESSAGE. + * + * @param min_level Minimal log level as string. Valid log levels: + * no fatal error warn info v debug trace + * The value "no" disables all messages. This is the + * default. An exception is the value "terminal-default", which uses the log + * level as set by the "--msg-level" option. This works even if the terminal + * is disabled. (Since API version 1.19.) Also see mpv_log_level. + * @return error code + */ + MPV_EXPORT int mpv_request_log_messages (mpv_handle *ctx, + const char *min_level); + + /** + * Wait for the next event, or until the timeout expires, or if another + * thread makes a call to mpv_wakeup(). Passing 0 as timeout will never wait, + * and is suitable for polling. + * + * The internal event queue has a limited size (per client handle). If you + * don't empty the event queue quickly enough with mpv_wait_event(), it will + * overflow and silently discard further events. If this happens, making + * asynchronous requests will fail as well (with MPV_ERROR_EVENT_QUEUE_FULL). + * + * Only one thread is allowed to call this on the same mpv_handle at a time. + * The API won't complain if more than one thread calls this, but it will + * cause race conditions in the client when accessing the shared mpv_event + * struct. Note that most other API functions are not restricted by this, and + * no API function internally calls mpv_wait_event(). Additionally, + * concurrent calls to different mpv_handles are always safe. + * + * As long as the timeout is 0, this is safe to be called from mpv render API + * threads. + * + * @param timeout Timeout in seconds, after which the function returns even + * if no event was received. A MPV_EVENT_NONE is returned on timeout. A value + * of 0 will disable waiting. Negative values will wait with an infinite + * timeout. + * @return A struct containing the event ID and other data. The pointer (and + * fields in the struct) stay valid until the next mpv_wait_event() + * call, or until the mpv_handle is destroyed. You must not write to + * the struct, and all memory referenced by it will be automatically + * released by the API on the next mpv_wait_event() call, or when the + * context is destroyed. The return value is never NULL. + */ + MPV_EXPORT mpv_event *mpv_wait_event (mpv_handle *ctx, double timeout); + + /** + * Interrupt the current mpv_wait_event() call. This will wake up the thread + * currently waiting in mpv_wait_event(). If no thread is waiting, the next + * mpv_wait_event() call will return immediately (this is to avoid lost + * wakeups). + * + * mpv_wait_event() will receive a MPV_EVENT_NONE if it's woken up due to + * this call. But note that this dummy event might be skipped if there are + * already other events queued. All what counts is that the waiting thread + * is woken up at all. + * + * Safe to be called from mpv render API threads. + */ + MPV_EXPORT void mpv_wakeup (mpv_handle *ctx); + + /** + * Set a custom function that should be called when there are new events. Use + * this if blocking in mpv_wait_event() to wait for new events is not + * feasible. + * + * Keep in mind that the callback will be called from foreign threads. You + * must not make any assumptions of the environment, and you must return as + * soon as possible (i.e. no long blocking waits). Exiting the callback + * through any other means than a normal return is forbidden (no throwing + * exceptions, no longjmp() calls). You must not change any local thread + * state (such as the C floating point environment). + * + * You are not allowed to call any client API functions inside of the + * callback. In particular, you should not do any processing in the callback, + * but wake up another thread that does all the work. The callback is meant + * strictly for notification only, and is called from arbitrary core parts of + * the player, that make no considerations for reentrant API use or allowing + * the callee to spend a lot of time doing other things. Keep in mind that + * it's also possible that the callback is called from a thread while a mpv + * API function is called (i.e. it can be reentrant). + * + * In general, the client API expects you to call mpv_wait_event() to receive + * notifications, and the wakeup callback is merely a helper utility to make + * this easier in certain situations. Note that it's possible that there's + * only one wakeup callback invocation for multiple events. You should call + * mpv_wait_event() with no timeout until MPV_EVENT_NONE is reached, at which + * point the event queue is empty. + * + * If you actually want to do processing in a callback, spawn a thread that + * does nothing but call mpv_wait_event() in a loop and dispatches the result + * to a callback. + * + * Only one wakeup callback can be set. + * + * @param cb function that should be called if a wakeup is required + * @param d arbitrary userdata passed to cb + */ + MPV_EXPORT void mpv_set_wakeup_callback (mpv_handle *ctx, + void (*cb) (void *d), void *d); + + /** + * Block until all asynchronous requests are done. This affects functions + * like mpv_command_async(), which return immediately and return their result + * as events. + * + * This is a helper, and somewhat equivalent to calling mpv_wait_event() in a + * loop until all known asynchronous requests have sent their reply as event, + * except that the event queue is not emptied. + * + * In case you called mpv_suspend() before, this will also forcibly reset the + * suspend counter of the given handle. + */ + MPV_EXPORT void mpv_wait_async_requests (mpv_handle *ctx); + + /** + * A hook is like a synchronous event that blocks the player. You register + * a hook handler with this function. You will get an event, which you need + * to handle, and once things are ready, you can let the player continue with + * mpv_hook_continue(). + * + * Currently, hooks can't be removed explicitly. But they will be implicitly + * removed if the mpv_handle it was registered with is destroyed. This also + * continues the hook if it was being handled by the destroyed mpv_handle + * (but this should be avoided, as it might mess up order of hook execution). + * + * Hook handlers are ordered globally by priority and order of registration. + * Handlers for the same hook with same priority are invoked in order of + * registration (the handler registered first is run first). Handlers with + * lower priority are run first (which seems backward). + * + * See the "Hooks" section in the manpage to see which hooks are currently + * defined. + * + * Some hooks might be reentrant (so you get multiple MPV_EVENT_HOOK for the + * same hook). If this can happen for a specific hook type, it will be + * explicitly documented in the manpage. + * + * Only the mpv_handle on which this was called will receive the hook events, + * or can "continue" them. + * + * @param reply_userdata This will be used for the mpv_event.reply_userdata + * field for the received MPV_EVENT_HOOK events. + * If you have no use for this, pass 0. + * @param name The hook name. This should be one of the documented names. But + * if the name is unknown, the hook event will simply be never + * raised. + * @param priority See remarks above. Use 0 as a neutral default. + * @return error code (usually fails only on OOM) + */ + MPV_EXPORT int mpv_hook_add (mpv_handle *ctx, uint64_t reply_userdata, + const char *name, int priority); + + /** + * Respond to a MPV_EVENT_HOOK event. You must call this after you have + * handled the event. There is no way to "cancel" or "stop" the hook. + * + * Calling this will will typically unblock the player for whatever the hook + * is responsible for (e.g. for the "on_load" hook it lets it continue + * playback). + * + * It is explicitly undefined behavior to call this more than once for each + * MPV_EVENT_HOOK, to pass an incorrect ID, or to call this on a mpv_handle + * different from the one that registered the handler and received the event. + * + * @param id This must be the value of the mpv_event_hook.id field for the + * corresponding MPV_EVENT_HOOK. + * @return error code + */ + MPV_EXPORT int mpv_hook_continue (mpv_handle *ctx, uint64_t id); + +#if MPV_ENABLE_DEPRECATED + + /** + * Return a UNIX file descriptor referring to the read end of a pipe. This + * pipe can be used to wake up a poll() based processing loop. The purpose of + * this function is very similar to mpv_set_wakeup_callback(), and provides + * a primitive mechanism to handle coordinating a foreign event loop and the + * libmpv event loop. The pipe is non-blocking. It's closed when the + * mpv_handle is destroyed. This function always returns the same value (on + * success). + * + * This is in fact implemented using the same underlying code as for + * mpv_set_wakeup_callback() (though they don't conflict), and it is as if + * each callback invocation writes a single 0 byte to the pipe. When the pipe + * becomes readable, the code calling poll() (or select()) on the pipe should + * read all contents of the pipe and then call mpv_wait_event(c, 0) until + * no new events are returned. The pipe contents do not matter and can just + * be discarded. There is not necessarily one byte per readable event in the + * pipe. For example, the pipes are non-blocking, and mpv won't block if the + * pipe is full. Pipes are normally limited to 4096 bytes, so if there are + * more than 4096 events, the number of readable bytes can not equal the + * number of events queued. Also, it's possible that mpv does not write to + * the pipe once it's guaranteed that the client was already signaled. See + * the example below how to do it correctly. + * + * Example: + * + * int pipefd = mpv_get_wakeup_pipe(mpv); + * if (pipefd < 0) + * error(); + * while (1) { + * struct pollfd pfds[1] = { + * { .fd = pipefd, .events = POLLIN }, + * }; + * // Wait until there are possibly new mpv events. + * poll(pfds, 1, -1); + * if (pfds[0].revents & POLLIN) { + * // Empty the pipe. Doing this before calling mpv_wait_event() + * // ensures that no wakeups are missed. It's not so important to + * // make sure the pipe is really empty (it will just cause some + * // additional wakeups in unlikely corner cases). + * char unused[256]; + * read(pipefd, unused, sizeof(unused)); + * while (1) { + * mpv_event *ev = mpv_wait_event(mpv, 0); + * // If MPV_EVENT_NONE is received, the event queue is empty. + * if (ev->event_id == MPV_EVENT_NONE) + * break; + * // Process the event. + * ... + * } + * } + * } + * + * @deprecated this function will be removed in the future. If you need this + * functionality, use mpv_set_wakeup_callback(), create a pipe + * manually, and call write() on your pipe in the callback. + * + * @return A UNIX FD of the read end of the wakeup pipe, or -1 on error. + * On MS Windows/MinGW, this will always return -1. + */ + MPV_EXPORT int mpv_get_wakeup_pipe (mpv_handle *ctx); + +#endif + +/** + * Defining MPV_CPLUGIN_DYNAMIC_SYM during plugin compilation will replace + * mpv_* functions with function pointers. Those pointer will be initialized + * when loading the plugin. + * + * It is recommended to use this symbol table when targeting Windows. The + * loader does not have notion of global symbols. Loading cplugin into mpv + * process will not allow this plugin to call any of the symbols that may be + * available in other modules. Instead cplugin has to link explicitly to + * specific PE binary, libmpv-2.dll/mpv.exe or any other binary that may have + * linked mpv statically. This limits portability of cplugin as it would need + * to be compiled separately for each of target PE binary that includes mpv's + * symbols. Which in practice is unrealistic, as we want one cplugin to be + * loaded without those restrictions. + * + * Instead of linking to any PE binary, we create function pointers for all + * mpv's exported symbols. For convenience names of entrypoints are redefined + * to those pointer, so no changes are required in cplugin source code, except + * of defining MPV_CPLUGIN_DYNAMIC_SYM. Those function pointer are exported to + * make them available for mpv to init with correct values during runtime, + * before calling `mpv_open_cplugin`. + * + * Note that those pointers are decorated with `selectany` attribute, so no + * need to worry about multiple definitions, linker will keep only single + * instance. + */ +#ifdef MPV_CPLUGIN_DYNAMIC_SYM + +#define MPV_DEFINE_SYM_PTR(name) \ + MPV_SELECTANY MPV_EXPORT MPV_DECLTYPE (name) * pfn_##name; + + MPV_DEFINE_SYM_PTR (mpv_client_api_version) +#define mpv_client_api_version pfn_mpv_client_api_version + MPV_DEFINE_SYM_PTR (mpv_error_string) +#define mpv_error_string pfn_mpv_error_string + MPV_DEFINE_SYM_PTR (mpv_free) +#define mpv_free pfn_mpv_free + MPV_DEFINE_SYM_PTR (mpv_client_name) +#define mpv_client_name pfn_mpv_client_name + MPV_DEFINE_SYM_PTR (mpv_client_id) +#define mpv_client_id pfn_mpv_client_id + MPV_DEFINE_SYM_PTR (mpv_create) +#define mpv_create pfn_mpv_create + MPV_DEFINE_SYM_PTR (mpv_initialize) +#define mpv_initialize pfn_mpv_initialize + MPV_DEFINE_SYM_PTR (mpv_destroy) +#define mpv_destroy pfn_mpv_destroy + MPV_DEFINE_SYM_PTR (mpv_terminate_destroy) +#define mpv_terminate_destroy pfn_mpv_terminate_destroy + MPV_DEFINE_SYM_PTR (mpv_create_client) +#define mpv_create_client pfn_mpv_create_client + MPV_DEFINE_SYM_PTR (mpv_create_weak_client) +#define mpv_create_weak_client pfn_mpv_create_weak_client + MPV_DEFINE_SYM_PTR (mpv_load_config_file) +#define mpv_load_config_file pfn_mpv_load_config_file + MPV_DEFINE_SYM_PTR (mpv_get_time_ns) +#define mpv_get_time_ns pfn_mpv_get_time_ns + MPV_DEFINE_SYM_PTR (mpv_get_time_us) +#define mpv_get_time_us pfn_mpv_get_time_us + MPV_DEFINE_SYM_PTR (mpv_free_node_contents) +#define mpv_free_node_contents pfn_mpv_free_node_contents + MPV_DEFINE_SYM_PTR (mpv_set_option) +#define mpv_set_option pfn_mpv_set_option + MPV_DEFINE_SYM_PTR (mpv_set_option_string) +#define mpv_set_option_string pfn_mpv_set_option_string + MPV_DEFINE_SYM_PTR (mpv_command) +#define mpv_command pfn_mpv_command + MPV_DEFINE_SYM_PTR (mpv_command_node) +#define mpv_command_node pfn_mpv_command_node + MPV_DEFINE_SYM_PTR (mpv_command_ret) +#define mpv_command_ret pfn_mpv_command_ret + MPV_DEFINE_SYM_PTR (mpv_command_string) +#define mpv_command_string pfn_mpv_command_string + MPV_DEFINE_SYM_PTR (mpv_command_async) +#define mpv_command_async pfn_mpv_command_async + MPV_DEFINE_SYM_PTR (mpv_command_node_async) +#define mpv_command_node_async pfn_mpv_command_node_async + MPV_DEFINE_SYM_PTR (mpv_abort_async_command) +#define mpv_abort_async_command pfn_mpv_abort_async_command + MPV_DEFINE_SYM_PTR (mpv_set_property) +#define mpv_set_property pfn_mpv_set_property + MPV_DEFINE_SYM_PTR (mpv_set_property_string) +#define mpv_set_property_string pfn_mpv_set_property_string + MPV_DEFINE_SYM_PTR (mpv_del_property) +#define mpv_del_property pfn_mpv_del_property + MPV_DEFINE_SYM_PTR (mpv_set_property_async) +#define mpv_set_property_async pfn_mpv_set_property_async + MPV_DEFINE_SYM_PTR (mpv_get_property) +#define mpv_get_property pfn_mpv_get_property + MPV_DEFINE_SYM_PTR (mpv_get_property_string) +#define mpv_get_property_string pfn_mpv_get_property_string + MPV_DEFINE_SYM_PTR (mpv_get_property_osd_string) +#define mpv_get_property_osd_string pfn_mpv_get_property_osd_string + MPV_DEFINE_SYM_PTR (mpv_get_property_async) +#define mpv_get_property_async pfn_mpv_get_property_async + MPV_DEFINE_SYM_PTR (mpv_observe_property) +#define mpv_observe_property pfn_mpv_observe_property + MPV_DEFINE_SYM_PTR (mpv_unobserve_property) +#define mpv_unobserve_property pfn_mpv_unobserve_property + MPV_DEFINE_SYM_PTR (mpv_event_name) +#define mpv_event_name pfn_mpv_event_name + MPV_DEFINE_SYM_PTR (mpv_event_to_node) +#define mpv_event_to_node pfn_mpv_event_to_node + MPV_DEFINE_SYM_PTR (mpv_request_event) +#define mpv_request_event pfn_mpv_request_event + MPV_DEFINE_SYM_PTR (mpv_request_log_messages) +#define mpv_request_log_messages pfn_mpv_request_log_messages + MPV_DEFINE_SYM_PTR (mpv_wait_event) +#define mpv_wait_event pfn_mpv_wait_event + MPV_DEFINE_SYM_PTR (mpv_wakeup) +#define mpv_wakeup pfn_mpv_wakeup + MPV_DEFINE_SYM_PTR (mpv_set_wakeup_callback) +#define mpv_set_wakeup_callback pfn_mpv_set_wakeup_callback + MPV_DEFINE_SYM_PTR (mpv_wait_async_requests) +#define mpv_wait_async_requests pfn_mpv_wait_async_requests + MPV_DEFINE_SYM_PTR (mpv_hook_add) +#define mpv_hook_add pfn_mpv_hook_add + MPV_DEFINE_SYM_PTR (mpv_hook_continue) +#define mpv_hook_continue pfn_mpv_hook_continue + MPV_DEFINE_SYM_PTR (mpv_get_wakeup_pipe) +#define mpv_get_wakeup_pipe pfn_mpv_get_wakeup_pipe + +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/crates/libmpv2/libmpv2-sys/include/render.h b/crates/libmpv2/libmpv2-sys/include/render.h new file mode 100644 index 0000000..872da7a --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/include/render.h @@ -0,0 +1,769 @@ +/* + * yt - A fully featured command line YouTube client + * + * Copyright (C) 2018 the mpv developers + * Copyright (C) 2024 Benedikt Peetz + * SPDX-License-Identifier: GPL-3.0-or-later + * + * This file is part of Yt. + * + * You should have received a copy of the License along with this program. + * If not, see . + */ + +#ifndef MPV_CLIENT_API_RENDER_H_ +#define MPV_CLIENT_API_RENDER_H_ + +#include "client.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + + /** + * Overview + * -------- + * + * This API can be used to make mpv render using supported graphic APIs (such + * as OpenGL). It can be used to handle video display. + * + * The renderer needs to be created with mpv_render_context_create() before + * you start playback (or otherwise cause a VO to be created). Then (with + * most backends) mpv_render_context_render() can be used to explicitly + * render the current video frame. Use + * mpv_render_context_set_update_callback() to get notified when there is a + * new frame to draw. + * + * Preferably rendering should be done in a separate thread. If you call + * normal libmpv API functions on the renderer thread, deadlocks can result + * (these are made non-fatal with timeouts, but user experience will + * obviously suffer). See "Threading" section below. + * + * You can output and embed video without this API by setting the mpv "wid" + * option to a native window handle (see "Embedding the video window" section + * in the client.h header). In general, using the render API is recommended, + * because window embedding can cause various issues, especially with GUI + * toolkits and certain platforms. + * + * Supported backends + * ------------------ + * + * OpenGL: via MPV_RENDER_API_TYPE_OPENGL, see render_gl.h header. + * Software: via MPV_RENDER_API_TYPE_SW, see section "Software renderer" + * + * Threading + * --------- + * + * You are recommended to do rendering on a separate thread than normal + * libmpv use. + * + * The mpv_render_* functions can be called from any thread, under the + * following conditions: + * - only one of the mpv_render_* functions can be called at the same time + * (unless they belong to different mpv cores created by mpv_create()) + * - never can be called from within the callbacks set with + * mpv_set_wakeup_callback() or mpv_render_context_set_update_callback() + * - if the OpenGL backend is used, for all functions the OpenGL context + * must be "current" in the calling thread, and it must be the same OpenGL + * context as the mpv_render_context was created with. Otherwise, + * undefined behavior will occur. + * - the thread does not call libmpv API functions other than the + * mpv_render_* functions, except APIs which are declared as safe (see + * below). Likewise, there must be no lock or wait dependency from the render + * thread to a thread using other libmpv functions. Basically, the situation + * that your render thread waits for a "not safe" libmpv API function to + * return must not happen. If you ignore this requirement, deadlocks can + * happen, which are made non-fatal with timeouts; then playback quality will + * be degraded, and the message mpv_render_context_render() not being called + * or stuck. is logged. If you set MPV_RENDER_PARAM_ADVANCED_CONTROL, you + * promise that this won't happen, and must absolutely guarantee it, or a + * real deadlock will freeze the mpv core thread forever. + * + * libmpv functions which are safe to call from a render thread are: + * - functions marked with "Safe to be called from mpv render API threads." + * - client.h functions which don't have an explicit or implicit mpv_handle + * parameter + * - mpv_render_* functions; but only for the same mpv_render_context + * pointer. If the pointer is different, mpv_render_context_free() is not + * safe. (The reason is that if MPV_RENDER_PARAM_ADVANCED_CONTROL is set, it + * may have to process still queued requests from the core, which it can do + * only for the current context, while requests for other contexts would + * deadlock. Also, it may have to wait and block for the core to terminate + * the video chain to make sure no resources are used after context + * destruction.) + * - if the mpv_handle parameter refers to a different mpv core than the one + * you're rendering for (very obscure, but allowed) + * + * Note about old libmpv version: + * + * Before API version 1.105 (basically in mpv 0.29.x), simply enabling + * MPV_RENDER_PARAM_ADVANCED_CONTROL could cause deadlock issues. This + * can be worked around by setting the "vd-lavc-dr" option to "no". In + * addition, you were required to call all mpv_render*() API functions from + * the same thread on which mpv_render_context_create() was originally run + * (for the same the mpv_render_context). Not honoring it led to UB + * (deadlocks, use of invalid mp_thread handles), even if you moved your + * GL context to a different thread correctly. These problems were addressed + * in API version 1.105 (mpv 0.30.0). + * + * Context and handle lifecycle + * ---------------------------- + * + * Video initialization will fail if the render context was not initialized + * yet (with mpv_render_context_create()), or it will revert to a VO that + * creates its own window. + * + * Currently, there can be only 1 mpv_render_context at a time per mpv core. + * + * Calling mpv_render_context_free() while a VO is using the render context + * is active will disable video. + * + * You must free the context with mpv_render_context_free() before the mpv + * core is destroyed. If this doesn't happen, undefined behavior will result. + * + * Software renderer + * ----------------- + * + * MPV_RENDER_API_TYPE_SW provides an extremely simple (but slow) renderer to + * memory surfaces. You probably don't want to use this. Use other render API + * types, or other methods of video embedding. + * + * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to + * MPV_RENDER_API_TYPE_SW. + * + * Call mpv_render_context_render() with various MPV_RENDER_PARAM_SW_* fields + * to render the video frame to an in-memory surface. The following fields + * are required: MPV_RENDER_PARAM_SW_SIZE, MPV_RENDER_PARAM_SW_FORMAT, + * MPV_RENDER_PARAM_SW_STRIDE, MPV_RENDER_PARAM_SW_POINTER. + * + * This method of rendering is very slow, because everything, including color + * conversion, scaling, and OSD rendering, is done on the CPU, + * single-threaded. In particular, large video or display sizes, as well as + * presence of OSD or subtitles can make it too slow for realtime. As with + * other software rendering VOs, setting "sw-fast" may help. Enabling or + * disabling zimg may help, depending on the platform. + * + * In addition, certain multimedia job creation measures like HDR may not + * work properly, and will have to be manually handled by for example + * inserting filters. + * + * This API is not really suitable to extract individual frames from video + * etc. (basically non-playback uses) - there are better libraries for this. + * It can be used this way, but it may be clunky and tricky. + * + * Further notes: + * - MPV_RENDER_PARAM_FLIP_Y is currently ignored (unsupported) + * - MPV_RENDER_PARAM_DEPTH is ignored (meaningless) + */ + + /** + * Opaque context, returned by mpv_render_context_create(). + */ + typedef struct mpv_render_context mpv_render_context; + + /** + * Parameters for mpv_render_param (which is used in a few places such as + * mpv_render_context_create(). + * + * Also see mpv_render_param for conventions and how to use it. + */ + typedef enum mpv_render_param_type + { + /** + * Not a valid value, but also used to terminate a params array. Its value + * is always guaranteed to be 0 (even if the ABI changes in the future). + */ + MPV_RENDER_PARAM_INVALID = 0, + /** + * The render API to use. Valid for mpv_render_context_create(). + * + * Type: char* + * + * Defined APIs: + * + * MPV_RENDER_API_TYPE_OPENGL: + * OpenGL desktop 2.1 or later (preferably core profile compatible to + * OpenGL 3.2), or OpenGLES 2.0 or later. + * Providing MPV_RENDER_PARAM_OPENGL_INIT_PARAMS is required. + * It is expected that an OpenGL context is valid and "current" when + * calling mpv_render_* functions (unless specified otherwise). It + * must be the same context for the same mpv_render_context. + */ + MPV_RENDER_PARAM_API_TYPE = 1, + /** + * Required parameters for initializing the OpenGL renderer. Valid for + * mpv_render_context_create(). + * Type: mpv_opengl_init_params* + */ + MPV_RENDER_PARAM_OPENGL_INIT_PARAMS = 2, + /** + * Describes a GL render target. Valid for mpv_render_context_render(). + * Type: mpv_opengl_fbo* + */ + MPV_RENDER_PARAM_OPENGL_FBO = 3, + /** + * Control flipped rendering. Valid for mpv_render_context_render(). + * Type: int* + * If the value is set to 0, render normally. Otherwise, render it flipped, + * which is needed e.g. when rendering to an OpenGL default framebuffer + * (which has a flipped coordinate system). + */ + MPV_RENDER_PARAM_FLIP_Y = 4, + /** + * Control surface depth. Valid for mpv_render_context_render(). + * Type: int* + * This implies the depth of the surface passed to the render function in + * bits per channel. If omitted or set to 0, the renderer will assume 8. + * Typically used to control dithering. + */ + MPV_RENDER_PARAM_DEPTH = 5, + /** + * ICC profile blob. Valid for mpv_render_context_set_parameter(). + * Type: mpv_byte_array* + * Set an ICC profile for use with the "icc-profile-auto" option. (If the + * option is not enabled, the ICC data will not be used.) + */ + MPV_RENDER_PARAM_ICC_PROFILE = 6, + /** + * Ambient light in lux. Valid for mpv_render_context_set_parameter(). + * Type: int* + * This can be used for automatic gamma correction. + */ + MPV_RENDER_PARAM_AMBIENT_LIGHT = 7, + /** + * X11 Display, sometimes used for hwdec. Valid for + * mpv_render_context_create(). The Display must stay valid for the + * lifetime of the mpv_render_context. Type: Display* + */ + MPV_RENDER_PARAM_X11_DISPLAY = 8, + /** + * Wayland display, sometimes used for hwdec. Valid for + * mpv_render_context_create(). The wl_display must stay valid for the + * lifetime of the mpv_render_context. + * Type: struct wl_display* + */ + MPV_RENDER_PARAM_WL_DISPLAY = 9, + /** + * Better control about rendering and enabling some advanced features. + * Valid for mpv_render_context_create(). + * + * This conflates multiple requirements the API user promises to abide if + * this option is enabled: + * + * - The API user's render thread, which is calling the mpv_render_*() + * functions, never waits for the core. Otherwise deadlocks can happen. + * See "Threading" section. + * - The callback set with mpv_render_context_set_update_callback() can + * now be called even if there is no new frame. The API user should call + * the mpv_render_context_update() function, and interpret the return value + * for whether a new frame should be rendered. + * - Correct functionality is impossible if the update callback is not + * set, or not set soon enough after mpv_render_context_create() (the core + * can block while waiting for you to call mpv_render_context_update(), and + * if the update callback is not correctly set, it will deadlock, or + * block for too long). + * + * In general, setting this option will enable the following features (and + * possibly more): + * + * - "Direct rendering", which means the player decodes directly to a + * texture, which saves a copy per video frame ("vd-lavc-dr" option + * needs to be enabled, and the rendering backend as well as the + * underlying GPU API/driver needs to have support for it). + * - Rendering screenshots with the GPU API if supported by the backend + * (instead of using a suboptimal software fallback via libswscale). + * + * Warning: do not just add this without reading the "Threading" section + * above, and then wondering that deadlocks happen. The + * requirements are tricky. But also note that even if advanced + * control is disabled, not adhering to the rules will lead to + * playback problems. Enabling advanced controls simply makes + * violating these rules fatal. + * + * Type: int*: 0 for disable (default), 1 for enable + */ + MPV_RENDER_PARAM_ADVANCED_CONTROL = 10, + /** + * Return information about the next frame to render. Valid for + * mpv_render_context_get_info(). + * + * Type: mpv_render_frame_info* + * + * It strictly returns information about the _next_ frame. The implication + * is that e.g. mpv_render_context_update()'s return value will have + * MPV_RENDER_UPDATE_FRAME set, and the user is supposed to call + * mpv_render_context_render(). If there is no next frame, then the + * return value will have is_valid set to 0. + */ + MPV_RENDER_PARAM_NEXT_FRAME_INFO = 11, + /** + * Enable or disable video timing. Valid for mpv_render_context_render(). + * + * Type: int*: 0 for disable, 1 for enable (default) + * + * When video is timed to audio, the player attempts to render video a bit + * ahead, and then do a blocking wait until the target display time is + * reached. This blocks mpv_render_context_render() for up to the amount + * specified with the "video-timing-offset" global option. You can set + * this parameter to 0 to disable this kind of waiting. If you do, it's + * recommended to use the target time value in mpv_render_frame_info to + * wait yourself, or to set the "video-timing-offset" to 0 instead. + * + * Disabling this without doing anything in addition will result in A/V + * sync being slightly off. + */ + MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 12, + /** + * Use to skip rendering in mpv_render_context_render(). + * + * Type: int*: 0 for rendering (default), 1 for skipping + * + * If this is set, you don't need to pass a target surface to the render + * function (and if you do, it's completely ignored). This can still call + * into the lower level APIs (i.e. if you use OpenGL, the OpenGL context + * must be set). + * + * Be aware that the render API will consider this frame as having been + * rendered. All other normal rules also apply, for example about whether + * you have to call mpv_render_context_report_swap(). It also does timing + * in the same way. + */ + MPV_RENDER_PARAM_SKIP_RENDERING = 13, + /** + * Deprecated. Not supported. Use MPV_RENDER_PARAM_DRM_DISPLAY_V2 instead. + * Type : struct mpv_opengl_drm_params* + */ + MPV_RENDER_PARAM_DRM_DISPLAY = 14, + /** + * DRM draw surface size, contains draw surface dimensions. + * Valid for mpv_render_context_create(). + * Type : struct mpv_opengl_drm_draw_surface_size* + */ + MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE = 15, + /** + * DRM display, contains drm display handles. + * Valid for mpv_render_context_create(). + * Type : struct mpv_opengl_drm_params_v2* + */ + MPV_RENDER_PARAM_DRM_DISPLAY_V2 = 16, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface size, mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: int[2] (e.g.: int s[2] = {w, h}; param.data = &s[0];) + * + * The video frame is transformed as with other VOs. Typically, this means + * the video gets scaled and black bars are added if the video size or + * aspect ratio mismatches with the target size. + */ + MPV_RENDER_PARAM_SW_SIZE = 17, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel format, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: char* (e.g.: char *f = "rgb0"; param.data = f;) + * + * Valid values are: + * "rgb0", "bgr0", "0bgr", "0rgb" + * 4 bytes per pixel RGB, 1 byte (8 bit) per component, component + * bytes with increasing address from left to right (e.g. "rgb0" has r at + * address 0), the "0" component contains uninitialized garbage (often + * the value 0, but not necessarily; the bad naming is inherited from + * FFmpeg) + * Pixel alignment size: 4 bytes + * "rgb24" + * 3 bytes per pixel RGB. This is strongly discouraged because it is + * very slow. + * Pixel alignment size: 1 bytes + * other + * The API may accept other pixel formats, using mpv internal format + * names, as long as it's internally marked as RGB, has exactly 1 + * plane, and is supported as conversion output. It is not a good idea + * to rely on any of these. Their semantics and handling could change. + */ + MPV_RENDER_PARAM_SW_FORMAT = 18, + /** + * MPV_RENDER_API_TYPE_SW only: rendering target surface bytes per line, + * mandatory. + * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render(). + * Type: size_t* + * + * This is the number of bytes between a pixel (x, y) and (x, y + 1) on the + * target surface. It must be a multiple of the pixel size, and have space + * for the surface width as specified by MPV_RENDER_PARAM_SW_SIZE. + * + * Both stride and pointer value should be a multiple of 64 to facilitate + * fast SIMD operation. Lower alignment might trigger slower code paths, + * and in the worst case, will copy the entire target frame. If mpv is + * built with zimg (and zimg is not disabled), the performance impact might + * be less. In either cases, the pointer and stride must be aligned at + * least to the pixel alignment size. Otherwise, crashes and undefined + * behavior is possible on platforms which do not support unaligned + * accesses (either through normal memory access or aligned SIMD memory + * access instructions). + */ + MPV_RENDER_PARAM_SW_STRIDE = 19, + /* + * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel data + * pointer, mandatory. Valid for MPV_RENDER_API_TYPE_SW & + * mpv_render_context_render(). Type: void* + * + * This points to the first pixel at the left/top corner (0, 0). In + * particular, each line y starts at (pointer + stride * y). Upon + * rendering, all data between pointer and (pointer + stride * h) is + * overwritten. Whether the padding between (w, y) and (0, y + 1) is + * overwritten is left unspecified (it should not be, but unfortunately + * some scaler backends will do it anyway). It is assumed that even the + * padding after the last line (starting at bytepos(w, h) until (pointer + + * stride * h)) is writable. + * + * See MPV_RENDER_PARAM_SW_STRIDE for alignment requirements. + */ + MPV_RENDER_PARAM_SW_POINTER = 20, + } mpv_render_param_type; + +/** + * For backwards compatibility with the old naming of + * MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE + */ +#define MPV_RENDER_PARAM_DRM_OSD_SIZE MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE + + /** + * Used to pass arbitrary parameters to some mpv_render_* functions. The + * meaning of the data parameter is determined by the type, and each + * MPV_RENDER_PARAM_* documents what type the value must point to. + * + * Each value documents the required data type as the pointer you cast to + * void* and set on mpv_render_param.data. For example, if + * MPV_RENDER_PARAM_FOO documents the type as Something* , then the code + * should look like this: + * + * Something foo = {...}; + * mpv_render_param param; + * param.type = MPV_RENDER_PARAM_FOO; + * param.data = & foo; + * + * Normally, the data field points to exactly 1 object. If the type is char*, + * it points to a 0-terminated string. + * + * In all cases (unless documented otherwise) the pointers need to remain + * valid during the call only. Unless otherwise documented, the API functions + * will not write to the params array or any data pointed to it. + * + * As a convention, parameter arrays are always terminated by type==0. There + * is no specific order of the parameters required. The order of the 2 fields + * in this struct is guaranteed (even after ABI changes). + */ + typedef struct mpv_render_param + { + enum mpv_render_param_type type; + void *data; + } mpv_render_param; + +/** + * Predefined values for MPV_RENDER_PARAM_API_TYPE. + */ +// See render_gl.h +#define MPV_RENDER_API_TYPE_OPENGL "opengl" +// See section "Software renderer" +#define MPV_RENDER_API_TYPE_SW "sw" + + /** + * Flags used in mpv_render_frame_info.flags. Each value represents a bit in + * it. + */ + typedef enum mpv_render_frame_info_flag + { + /** + * Set if there is actually a next frame. If unset, there is no next frame + * yet, and other flags and fields that require a frame to be queued will + * be unset. + * + * This is set for _any_ kind of frame, even for redraw requests. + * + * Note that when this is unset, it simply means no new frame was + * decoded/queued yet, not necessarily that the end of the video was + * reached. A new frame can be queued after some time. + * + * If the return value of mpv_render_context_render() had the + * MPV_RENDER_UPDATE_FRAME flag set, this flag will usually be set as well, + * unless the frame is rendered, or discarded by other asynchronous events. + */ + MPV_RENDER_FRAME_INFO_PRESENT = 1 << 0, + /** + * If set, the frame is not an actual new video frame, but a redraw + * request. For example if the video is paused, and an option that affects + * video rendering was changed (or any other reason), an update request can + * be issued and this flag will be set. + * + * Typically, redraw frames will not be subject to video timing. + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_REDRAW = 1 << 1, + /** + * If set, this is supposed to reproduce the previous frame perfectly. This + * is usually used for certain "video-sync" options ("display-..." modes). + * Typically the renderer will blit the video from a FBO. Unset otherwise. + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_REPEAT = 1 << 2, + /** + * If set, the player timing code expects that the user thread blocks on + * vsync (by either delaying the render call, or by making a call to + * mpv_render_context_report_swap() at vsync time). + * + * Implies MPV_RENDER_FRAME_INFO_PRESENT. + */ + MPV_RENDER_FRAME_INFO_BLOCK_VSYNC = 1 << 3, + } mpv_render_frame_info_flag; + + /** + * Information about the next video frame that will be rendered. Can be + * retrieved with MPV_RENDER_PARAM_NEXT_FRAME_INFO. + */ + typedef struct mpv_render_frame_info + { + /** + * A bitset of mpv_render_frame_info_flag values (i.e. multiple flags are + * combined with bitwise or). + */ + uint64_t flags; + /** + * Absolute time at which the frame is supposed to be displayed. This is in + * the same unit and base as the time returned by mpv_get_time_us(). For + * frames that are redrawn, or if vsync locked video timing is used (see + * "video-sync" option), then this can be 0. The "video-timing-offset" + * option determines how much "headroom" the render thread gets (but a high + * enough frame rate can reduce it anyway). mpv_render_context_render() + * will normally block until the time is elapsed, unless you pass it + * MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 0. + */ + int64_t target_time; + } mpv_render_frame_info; + + /** + * Initialize the renderer state. Depending on the backend used, this will + * access the underlying GPU API and initialize its own objects. + * + * You must free the context with mpv_render_context_free(). Not doing so + * before the mpv core is destroyed may result in memory leaks or crashes. + * + * Currently, only at most 1 context can exists per mpv core (it represents + * the main video output). + * + * You should pass the following parameters: + * - MPV_RENDER_PARAM_API_TYPE to select the underlying backend/GPU API. + * - Backend-specific init parameter, like + * MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. + * - Setting MPV_RENDER_PARAM_ADVANCED_CONTROL and following its rules is + * strongly recommended. + * - If you want to use hwdec, possibly hwdec interop resources. + * + * @param res set to the context (on success) or NULL (on failure). The value + * is never read and always overwritten. + * @param mpv handle used to get the core (the mpv_render_context won't + * depend on this specific handle, only the core referenced by it) + * @param params an array of parameters, terminated by type==0. It's left + * unspecified what happens with unknown parameters. At least + * MPV_RENDER_PARAM_API_TYPE is required, and most backends + * will require another backend-specific parameter. + * @return error code, including but not limited to: + * MPV_ERROR_UNSUPPORTED: the OpenGL version is not supported + * (or required extensions are missing) + * MPV_ERROR_NOT_IMPLEMENTED: an unknown API type was provided, or + * support for the requested API was not + * built in the used libmpv binary. + * MPV_ERROR_INVALID_PARAMETER: at least one of the provided parameters + * was not valid. + */ + MPV_EXPORT int mpv_render_context_create (mpv_render_context **res, + mpv_handle *mpv, + mpv_render_param *params); + + /** + * Attempt to change a single parameter. Not all backends and parameter types + * support all kinds of changes. + * + * @param ctx a valid render context + * @param param the parameter type and data that should be set + * @return error code. If a parameter could actually be changed, this returns + * success, otherwise an error code depending on the parameter type + * and situation. + */ + MPV_EXPORT int mpv_render_context_set_parameter (mpv_render_context *ctx, + mpv_render_param param); + + /** + * Retrieve information from the render context. This is NOT a counterpart to + * mpv_render_context_set_parameter(), because you generally can't read + * parameters set with it, and this function is not meant for this purpose. + * Instead, this is for communicating information from the renderer back to + * the user. See mpv_render_param_type; entries which support this function + * explicitly mention it, and for other entries you can assume it will fail. + * + * You pass param with param.type set and param.data pointing to a variable + * of the required data type. The function will then overwrite that variable + * with the returned value (at least on success). + * + * @param ctx a valid render context + * @param param the parameter type and data that should be retrieved + * @return error code. If a parameter could actually be retrieved, this + * returns success, otherwise an error code depending on the parameter type + * and situation. MPV_ERROR_NOT_IMPLEMENTED is used for unknown + * param.type, or if retrieving it is not supported. + */ + MPV_EXPORT int mpv_render_context_get_info (mpv_render_context *ctx, + mpv_render_param param); + + typedef void (*mpv_render_update_fn) (void *cb_ctx); + + /** + * Set the callback that notifies you when a new video frame is available, or + * if the video display configuration somehow changed and requires a redraw. + * Similar to mpv_set_wakeup_callback(), you must not call any mpv API from + * the callback, and all the other listed restrictions apply (such as not + * exiting the callback by throwing exceptions). + * + * This can be called from any thread, except from an update callback. In + * case of the OpenGL backend, no OpenGL state or API is accessed. + * + * Calling this will raise an update callback immediately. + * + * @param callback callback(callback_ctx) is called if the frame should be + * redrawn + * @param callback_ctx opaque argument to the callback + */ + MPV_EXPORT void + mpv_render_context_set_update_callback (mpv_render_context *ctx, + mpv_render_update_fn callback, + void *callback_ctx); + + /** + * The API user is supposed to call this when the update callback was invoked + * (like all mpv_render_* functions, this has to happen on the render thread, + * and _not_ from the update callback itself). + * + * This is optional if MPV_RENDER_PARAM_ADVANCED_CONTROL was not set + * (default). Otherwise, it's a hard requirement that this is called after + * each update callback. If multiple update callback happened, and the + * function could not be called sooner, it's OK to call it once after the + * last callback. + * + * If an update callback happens during or after this function, the function + * must be called again at the soonest possible time. + * + * If MPV_RENDER_PARAM_ADVANCED_CONTROL was set, this will do additional work + * such as allocating textures for the video decoder. + * + * @return a bitset of mpv_render_update_flag values (i.e. multiple flags are + * combined with bitwise or). Typically, this will tell the API user + * what should happen next. E.g. if the MPV_RENDER_UPDATE_FRAME flag + * is set, mpv_render_context_render() should be called. If flags unknown to + * the API user are set, or if the return value is 0, nothing needs to be + * done. + */ + MPV_EXPORT uint64_t mpv_render_context_update (mpv_render_context *ctx); + + /** + * Flags returned by mpv_render_context_update(). Each value represents a bit + * in the function's return value. + */ + typedef enum mpv_render_update_flag + { + /** + * A new video frame must be rendered. mpv_render_context_render() must be + * called. + */ + MPV_RENDER_UPDATE_FRAME = 1 << 0, + } mpv_render_context_flag; + + /** + * Render video. + * + * Typically renders the video to a target surface provided via + * mpv_render_param (the details depend on the backend in use). Options like + * "panscan" are applied to determine which part of the video should be + * visible and how the video should be scaled. You can change these options + * at runtime by using the mpv property API. + * + * The renderer will reconfigure itself every time the target surface + * configuration (such as size) is changed. + * + * This function implicitly pulls a video frame from the internal queue and + * renders it. If no new frame is available, the previous frame is redrawn. + * The update callback set with mpv_render_context_set_update_callback() + * notifies you when a new frame was added. The details potentially depend on + * the backends and the provided parameters. + * + * Generally, libmpv will invoke your update callback some time before the + * video frame should be shown, and then lets this function block until the + * supposed display time. This will limit your rendering to video FPS. You + * can prevent this by setting the "video-timing-offset" global option to 0. + * (This applies only to "audio" video sync mode.) + * + * You should pass the following parameters: + * - Backend-specific target object, such as MPV_RENDER_PARAM_OPENGL_FBO. + * - Possibly transformations, such as MPV_RENDER_PARAM_FLIP_Y. + * + * @param ctx a valid render context + * @param params an array of parameters, terminated by type==0. Which + * parameters are required depends on the backend. It's left unspecified what + * happens with unknown parameters. + * @return error code + */ + MPV_EXPORT int mpv_render_context_render (mpv_render_context *ctx, + mpv_render_param *params); + + /** + * Tell the renderer that a frame was flipped at the given time. This is + * optional, but can help the player to achieve better timing. + * + * Note that calling this at least once informs libmpv that you will use this + * function. If you use it inconsistently, expect bad video playback. + * + * If this is called while no video is initialized, it is ignored. + * + * @param ctx a valid render context + */ + MPV_EXPORT void mpv_render_context_report_swap (mpv_render_context *ctx); + + /** + * Destroy the mpv renderer state. + * + * If video is still active (e.g. a file playing), video will be disabled + * forcefully. + * + * @param ctx a valid render context. After this function returns, this is + * not a valid pointer anymore. NULL is also allowed and does nothing. + */ + MPV_EXPORT void mpv_render_context_free (mpv_render_context *ctx); + +#ifdef MPV_CPLUGIN_DYNAMIC_SYM + + MPV_DEFINE_SYM_PTR (mpv_render_context_create) +#define mpv_render_context_create pfn_mpv_render_context_create + MPV_DEFINE_SYM_PTR (mpv_render_context_set_parameter) +#define mpv_render_context_set_parameter pfn_mpv_render_context_set_parameter + MPV_DEFINE_SYM_PTR (mpv_render_context_get_info) +#define mpv_render_context_get_info pfn_mpv_render_context_get_info + MPV_DEFINE_SYM_PTR (mpv_render_context_set_update_callback) +#define mpv_render_context_set_update_callback \ + pfn_mpv_render_context_set_update_callback + MPV_DEFINE_SYM_PTR (mpv_render_context_update) +#define mpv_render_context_update pfn_mpv_render_context_update + MPV_DEFINE_SYM_PTR (mpv_render_context_render) +#define mpv_render_context_render pfn_mpv_render_context_render + MPV_DEFINE_SYM_PTR (mpv_render_context_report_swap) +#define mpv_render_context_report_swap pfn_mpv_render_context_report_swap + MPV_DEFINE_SYM_PTR (mpv_render_context_free) +#define mpv_render_context_free pfn_mpv_render_context_free + +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/crates/libmpv2/libmpv2-sys/include/render_gl.h b/crates/libmpv2/libmpv2-sys/include/render_gl.h new file mode 100644 index 0000000..75d7051 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/include/render_gl.h @@ -0,0 +1,221 @@ +/* + * yt - A fully featured command line YouTube client + * + * Copyright (C) 2018 the mpv developers + * Copyright (C) 2024 Benedikt Peetz + * SPDX-License-Identifier: GPL-3.0-or-later + * + * This file is part of Yt. + * + * You should have received a copy of the License along with this program. + * If not, see . + */ + +#ifndef MPV_CLIENT_API_RENDER_GL_H_ +#define MPV_CLIENT_API_RENDER_GL_H_ + +#include "render.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + + /** + * OpenGL backend + * -------------- + * + * This header contains definitions for using OpenGL with the render.h API. + * + * OpenGL interop + * -------------- + * + * The OpenGL backend has some special rules, because OpenGL itself uses + * implicit per-thread contexts, which causes additional API problems. + * + * This assumes the OpenGL context lives on a certain thread controlled by + * the API user. All mpv_render_* APIs have to be assumed to implicitly use + * the OpenGL context if you pass a mpv_render_context using the OpenGL + * backend, unless specified otherwise. + * + * The OpenGL context is indirectly accessed through the OpenGL function + * pointers returned by the get_proc_address callback in + * mpv_opengl_init_params. Generally, mpv will not load the system OpenGL + * library when using this API. + * + * OpenGL state + * ------------ + * + * OpenGL has a large amount of implicit state. All the mpv functions + * mentioned above expect that the OpenGL state is reasonably set to OpenGL + * standard defaults. Likewise, mpv will attempt to leave the OpenGL context + * with standard defaults. The following state is excluded from this: + * + * - the glViewport state + * - the glScissor state (but GL_SCISSOR_TEST is in its default value) + * - glBlendFuncSeparate() state (but GL_BLEND is in its default value) + * - glClearColor() state + * - mpv may overwrite the callback set with glDebugMessageCallback() + * - mpv always disables GL_DITHER at init + * + * Messing with the state could be avoided by creating shared OpenGL + * contexts, but this is avoided for the sake of compatibility and + * interoperability. + * + * On OpenGL 2.1, mpv will strictly call functions like glGenTextures() to + * create OpenGL objects. You will have to do the same. This ensures that + * objects created by mpv and the API users don't clash. Also, legacy state + * must be either in its defaults, or not interfere with core state. + * + * API use + * ------- + * + * The mpv_render_* API is used. That API supports multiple backends, and + * this section documents specifics for the OpenGL backend. + * + * Use mpv_render_context_create() with MPV_RENDER_PARAM_API_TYPE set to + * MPV_RENDER_API_TYPE_OPENGL, and MPV_RENDER_PARAM_OPENGL_INIT_PARAMS + * provided. + * + * Call mpv_render_context_render() with MPV_RENDER_PARAM_OPENGL_FBO to + * render the video frame to an FBO. + * + * Hardware decoding + * ----------------- + * + * Hardware decoding via this API is fully supported, but requires some + * additional setup. (At least if direct hardware decoding modes are wanted, + * instead of copying back surface data from GPU to CPU RAM.) + * + * There may be certain requirements on the OpenGL implementation: + * + * - Windows: ANGLE is required (although in theory GL/DX interop could be + * used) + * - Intel/Linux: EGL is required, and also the native display resource needs + * to be provided (e.g. MPV_RENDER_PARAM_X11_DISPLAY for X11 + * and MPV_RENDER_PARAM_WL_DISPLAY for Wayland) + * - nVidia/Linux: Both GLX and EGL should work (GLX is required if vdpau is + * used, e.g. due to old drivers.) + * - macOS: CGL is required (CGLGetCurrentContext() returning non-NULL) + * - iOS: EAGL is required (EAGLContext.currentContext returning non-nil) + * + * Once these things are setup, hardware decoding can be enabled/disabled at + * any time by setting the "hwdec" property. + */ + + /** + * For initializing the mpv OpenGL state via + * MPV_RENDER_PARAM_OPENGL_INIT_PARAMS. + */ + typedef struct mpv_opengl_init_params + { + /** + * This retrieves OpenGL function pointers, and will use them in subsequent + * operation. + * Usually, you can simply call the GL context APIs from this callback + * (e.g. glXGetProcAddressARB or wglGetProcAddress), but some APIs do not + * always return pointers for all standard functions (even if present); in + * this case you have to compensate by looking up these functions yourself + * when libmpv wants to resolve them through this callback. libmpv will not + * normally attempt to resolve GL functions on its own, nor does it link to + * GL libraries directly. + */ + void *(*get_proc_address) (void *ctx, const char *name); + /** + * Value passed as ctx parameter to get_proc_address(). + */ + void *get_proc_address_ctx; + } mpv_opengl_init_params; + + /** + * For MPV_RENDER_PARAM_OPENGL_FBO. + */ + typedef struct mpv_opengl_fbo + { + /** + * Framebuffer object name. This must be either a valid FBO generated by + * glGenFramebuffers() that is complete and color-renderable, or 0. If the + * value is 0, this refers to the OpenGL default framebuffer. + */ + int fbo; + /** + * Valid dimensions. This must refer to the size of the framebuffer. This + * must always be set. + */ + int w, h; + /** + * Underlying texture internal format (e.g. GL_RGBA8), or 0 if unknown. If + * this is the default framebuffer, this can be an equivalent. + */ + int internal_format; + } mpv_opengl_fbo; + + /** + * Deprecated. For MPV_RENDER_PARAM_DRM_DISPLAY. + */ + typedef struct mpv_opengl_drm_params + { + int fd; + int crtc_id; + int connector_id; + struct _drmModeAtomicReq **atomic_request_ptr; + int render_fd; + } mpv_opengl_drm_params; + + /** + * For MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE. + */ + typedef struct mpv_opengl_drm_draw_surface_size + { + /** + * size of the draw plane surface in pixels. + */ + int width, height; + } mpv_opengl_drm_draw_surface_size; + + /** + * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. + */ + typedef struct mpv_opengl_drm_params_v2 + { + /** + * DRM fd (int). Set to -1 if invalid. + */ + int fd; + + /** + * Currently used crtc id + */ + int crtc_id; + + /** + * Currently used connector id + */ + int connector_id; + + /** + * Pointer to a drmModeAtomicReq pointer that is being used for the + * renderloop. This pointer should hold a pointer to the atomic request + * pointer The atomic request pointer is usually changed at every + * renderloop. + */ + struct _drmModeAtomicReq **atomic_request_ptr; + + /** + * DRM render node. Used for VAAPI interop. + * Set to -1 if invalid. + */ + int render_fd; + } mpv_opengl_drm_params_v2; + +/** + * For backwards compatibility with the old naming of + * mpv_opengl_drm_draw_surface_size + */ +#define mpv_opengl_drm_osd_size mpv_opengl_drm_draw_surface_size + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/crates/libmpv2/libmpv2-sys/include/stream_cb.h b/crates/libmpv2/libmpv2-sys/include/stream_cb.h new file mode 100644 index 0000000..86e8496 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/include/stream_cb.h @@ -0,0 +1,253 @@ +/* + * yt - A fully featured command line YouTube client + * + * Copyright (C) 2017 the mpv developers + * Copyright (C) 2024 Benedikt Peetz + * SPDX-License-Identifier: GPL-3.0-or-later + * + * This file is part of Yt. + * + * You should have received a copy of the License along with this program. + * If not, see . + */ + +#ifndef MPV_CLIENT_API_STREAM_CB_H_ +#define MPV_CLIENT_API_STREAM_CB_H_ + +#include "client.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + + /** + * Warning: this API is not stable yet. + * + * Overview + * -------- + * + * This API can be used to make mpv read from a stream with a custom + * implementation. This interface is inspired by funopen on BSD and + * fopencookie on linux. The stream is backed by user-defined callbacks + * which can implement customized open, read, seek, size and close behaviors. + * + * Usage + * ----- + * + * Register your stream callbacks with the mpv_stream_cb_add_ro() function. + * You have to provide a mpv_stream_cb_open_ro_fn callback to it (open_fn + * argument). + * + * Once registered, you can `loadfile myprotocol://myfile`. Your open_fn will + * be invoked with the URI and you must fill out the provided + * mpv_stream_cb_info struct. This includes your stream callbacks (like + * read_fn), and an opaque cookie, which will be passed as the first argument + * to all the remaining stream callbacks. + * + * Note that your custom callbacks must not invoke libmpv APIs as that would + * cause a deadlock. (Unless you call a different mpv_handle than the one the + * callback was registered for, and the mpv_handles refer to different mpv + * instances.) + * + * Stream lifetime + * --------------- + * + * A stream remains valid until its close callback has been called. It's up + * to libmpv to call the close callback, and the libmpv user cannot close it + * directly with the stream_cb API. + * + * For example, if you consider your custom stream to become suddenly invalid + * (maybe because the underlying stream died), libmpv will continue using + * your stream. All you can do is returning errors from each callback, until + * libmpv gives up and closes it. + * + * Protocol registration and lifetime + * ---------------------------------- + * + * Protocols remain registered until the mpv instance is terminated. This + * means in particular that it can outlive the mpv_handle that was used to + * register it, but once mpv_terminate_destroy() is called, your registered + * callbacks will not be called again. + * + * Protocol unregistration is finished after the mpv core has been destroyed + * (e.g. after mpv_terminate_destroy() has returned). + * + * If you do not call mpv_terminate_destroy() yourself (e.g. plugin-style + * code), you will have to deal with the registration or even streams + * outliving your code. Here are some possible ways to do this: + * - call mpv_terminate_destroy(), which destroys the core, and will make + * sure all streams are closed once this function returns + * - you refcount all resources your stream "cookies" reference, so that it + * doesn't matter if streams live longer than expected + * - create "cancellation" semantics: after your protocol has been + * unregistered, notify all your streams that are still opened, and make them + * drop all referenced resources - then return errors from the stream + * callbacks as long as the stream is still opened + * + */ + + /** + * Read callback used to implement a custom stream. The semantics of the + * callback match read(2) in blocking mode. Short reads are allowed (you can + * return less bytes than requested, and libmpv will retry reading the rest + * with another call). If no data can be immediately read, the callback must + * block until there is new data. A return of 0 will be interpreted as final + * EOF, although libmpv might retry the read, or seek to a different + * position. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @param buf buffer to read data into + * @param size of the buffer + * @return number of bytes read into the buffer + * @return 0 on EOF + * @return -1 on error + */ + typedef int64_t (*mpv_stream_cb_read_fn) (void *cookie, char *buf, + uint64_t nbytes); + + /** + * Seek callback used to implement a custom stream. + * + * Note that mpv will issue a seek to position 0 immediately after opening. + * This is used to test whether the stream is seekable (since seekability + * might depend on the URI contents, not just the protocol). Return + * MPV_ERROR_UNSUPPORTED if seeking is not implemented for this stream. This + * seek also serves to establish the fact that streams start at position 0. + * + * This callback can be NULL, in which it behaves as if always returning + * MPV_ERROR_UNSUPPORTED. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @param offset target absolute stream position + * @return the resulting offset of the stream + * MPV_ERROR_UNSUPPORTED or MPV_ERROR_GENERIC if the seek failed + */ + typedef int64_t (*mpv_stream_cb_seek_fn) (void *cookie, int64_t offset); + + /** + * Size callback used to implement a custom stream. + * + * Return MPV_ERROR_UNSUPPORTED if no size is known. + * + * This callback can be NULL, in which it behaves as if always returning + * MPV_ERROR_UNSUPPORTED. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + * @return the total size in bytes of the stream + */ + typedef int64_t (*mpv_stream_cb_size_fn) (void *cookie); + + /** + * Close callback used to implement a custom stream. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + */ + typedef void (*mpv_stream_cb_close_fn) (void *cookie); + + /** + * Cancel callback used to implement a custom stream. + * + * This callback is used to interrupt any current or future read and seek + * operations. It will be called from a separate thread than the demux + * thread, and should not block. + * + * This callback can be NULL. + * + * Available since API 1.106. + * + * @param cookie opaque cookie identifying the stream, + * returned from mpv_stream_cb_open_fn + */ + typedef void (*mpv_stream_cb_cancel_fn) (void *cookie); + + /** + * See mpv_stream_cb_open_ro_fn callback. + */ + typedef struct mpv_stream_cb_info + { + /** + * Opaque user-provided value, which will be passed to the other callbacks. + * The close callback will be called to release the cookie. It is not + * interpreted by mpv. It doesn't even need to be a valid pointer. + * + * The user sets this in the mpv_stream_cb_open_ro_fn callback. + */ + void *cookie; + + /** + * Callbacks set by the user in the mpv_stream_cb_open_ro_fn callback. Some + * of them are optional, and can be left unset. + * + * The following callbacks are mandatory: read_fn, close_fn + */ + mpv_stream_cb_read_fn read_fn; + mpv_stream_cb_seek_fn seek_fn; + mpv_stream_cb_size_fn size_fn; + mpv_stream_cb_close_fn close_fn; + mpv_stream_cb_cancel_fn cancel_fn; /* since API 1.106 */ + } mpv_stream_cb_info; + + /** + * Open callback used to implement a custom read-only (ro) stream. The user + * must set the callback fields in the passed info struct. The cookie field + * also can be set to store state associated to the stream instance. + * + * Note that the info struct is valid only for the duration of this callback. + * You can't change the callbacks or the pointer to the cookie at a later + * point. + * + * Each stream instance created by the open callback can have different + * callbacks. + * + * The close_fn callback will terminate the stream instance. The pointers to + * your callbacks and cookie will be discarded, and the callbacks will not be + * called again. + * + * @param user_data opaque user data provided via mpv_stream_cb_add() + * @param uri name of the stream to be opened (with protocol prefix) + * @param info fields which the user should fill + * @return 0 on success, MPV_ERROR_LOADING_FAILED if the URI cannot be + * opened. + */ + typedef int (*mpv_stream_cb_open_ro_fn) (void *user_data, char *uri, + mpv_stream_cb_info *info); + + /** + * Add a custom stream protocol. This will register a protocol handler under + * the given protocol prefix, and invoke the given callbacks if an URI with + * the matching protocol prefix is opened. + * + * The "ro" is for read-only - only read-only streams can be registered with + * this function. + * + * The callback remains registered until the mpv core is registered. + * + * If a custom stream with the same name is already registered, then the + * MPV_ERROR_INVALID_PARAMETER error is returned. + * + * @param protocol protocol prefix, for example "foo" for "foo://" URIs + * @param user_data opaque pointer passed into the mpv_stream_cb_open_fn + * callback. + * @return error code + */ + MPV_EXPORT int mpv_stream_cb_add_ro (mpv_handle *ctx, const char *protocol, + void *user_data, + mpv_stream_cb_open_ro_fn open_fn); + +#ifdef MPV_CPLUGIN_DYNAMIC_SYM + + MPV_DEFINE_SYM_PTR (mpv_stream_cb_add_ro) +#define mpv_stream_cb_add_ro pfn_mpv_stream_cb_add_ro + +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/crates/libmpv2/libmpv2-sys/src/lib.rs b/crates/libmpv2/libmpv2-sys/src/lib.rs new file mode 100644 index 0000000..36a8199 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/src/lib.rs @@ -0,0 +1,22 @@ +#![allow(non_upper_case_globals)] +#![allow(non_camel_case_types)] +#![allow(non_snake_case)] + +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +include!(concat!(env!("OUT_DIR"), "/bindings.rs")); + +#[inline] +/// Returns the associated error string. +pub fn mpv_error_str(e: mpv_error) -> &'static str { + let raw = unsafe { mpv_error_string(e) }; + unsafe { ::std::ffi::CStr::from_ptr(raw) }.to_str().unwrap() +} diff --git a/crates/libmpv2/libmpv2-sys/update.sh b/crates/libmpv2/libmpv2-sys/update.sh new file mode 100755 index 0000000..eb9c3c1 --- /dev/null +++ b/crates/libmpv2/libmpv2-sys/update.sh @@ -0,0 +1,14 @@ +#!/usr/bin/env sh + +# yt - A fully featured command line YouTube client +# +# Copyright (C) 2024 Benedikt Peetz +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This file is part of Yt. +# +# You should have received a copy of the License along with this program. +# If not, see . + +[ "$1" = "upgrade" ] && cargo upgrade +cargo update diff --git a/crates/libmpv2/src/lib.rs b/crates/libmpv2/src/lib.rs new file mode 100644 index 0000000..4d8d18a --- /dev/null +++ b/crates/libmpv2/src/lib.rs @@ -0,0 +1,175 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +//! This crate provides abstractions for +//! [libmpv](https://github.com/mpv-player/mpv/tree/master/libmpv) of the +//! [mpv media player](https://github.com/mpv-player/mpv). +//! +//! Libmpv requires `LC_NUMERIC` to be `C`, which should be the default value. +//! +//! Most of the documentation is paraphrased or even copied from the +//! [mpv manual](https://mpv.io/manual/master/), +//! if any questions arise it will probably answer them in much more depth than this documentation. +//! +//! # Examples +//! +//! See the 'examples' directory in the crate root. + +// Procedure for updating to new libmpv: +// - make any nessecary API change (if so, bump crate version) +// - update MPV_CLIENT_API consts in lib.rs +// - run tests and examples to test whether they still work + +#![allow(non_upper_case_globals)] + +use std::fmt::Display; +use std::os::raw as ctype; + +pub const MPV_CLIENT_API_MAJOR: ctype::c_ulong = 2; +pub const MPV_CLIENT_API_MINOR: ctype::c_ulong = 2; +pub const MPV_CLIENT_API_VERSION: ctype::c_ulong = + MPV_CLIENT_API_MAJOR << 16 | MPV_CLIENT_API_MINOR; + +mod mpv; +#[cfg(test)] +mod tests; + +pub use crate::mpv::*; + +/// A format mpv can use. +pub use libmpv2_sys::mpv_format as MpvFormat; +pub mod mpv_format { + pub use libmpv2_sys::mpv_format_MPV_FORMAT_DOUBLE as Double; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_FLAG as Flag; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_INT64 as Int64; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_NODE as Node; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_NODE_ARRAY as Array; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_NODE_MAP as Map; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_NONE as None; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_OSD_STRING as OsdString; + pub use libmpv2_sys::mpv_format_MPV_FORMAT_STRING as String; +} + +/// An libmpv2_sys mpv error. +pub use libmpv2_sys::mpv_error as MpvError; +pub mod mpv_error { + pub use libmpv2_sys::mpv_error_MPV_ERROR_AO_INIT_FAILED as AoInitFailed; + pub use libmpv2_sys::mpv_error_MPV_ERROR_COMMAND as Command; + pub use libmpv2_sys::mpv_error_MPV_ERROR_EVENT_QUEUE_FULL as EventQueueFull; + pub use libmpv2_sys::mpv_error_MPV_ERROR_GENERIC as Generic; + pub use libmpv2_sys::mpv_error_MPV_ERROR_INVALID_PARAMETER as InvalidParameter; + pub use libmpv2_sys::mpv_error_MPV_ERROR_LOADING_FAILED as LoadingFailed; + pub use libmpv2_sys::mpv_error_MPV_ERROR_NOMEM as NoMem; + pub use libmpv2_sys::mpv_error_MPV_ERROR_NOTHING_TO_PLAY as NothingToPlay; + pub use libmpv2_sys::mpv_error_MPV_ERROR_NOT_IMPLEMENTED as NotImplemented; + pub use libmpv2_sys::mpv_error_MPV_ERROR_OPTION_ERROR as OptionError; + pub use libmpv2_sys::mpv_error_MPV_ERROR_OPTION_FORMAT as OptionFormat; + pub use libmpv2_sys::mpv_error_MPV_ERROR_OPTION_NOT_FOUND as OptionNotFound; + pub use libmpv2_sys::mpv_error_MPV_ERROR_PROPERTY_ERROR as PropertyError; + pub use libmpv2_sys::mpv_error_MPV_ERROR_PROPERTY_FORMAT as PropertyFormat; + pub use libmpv2_sys::mpv_error_MPV_ERROR_PROPERTY_NOT_FOUND as PropertyNotFound; + pub use libmpv2_sys::mpv_error_MPV_ERROR_PROPERTY_UNAVAILABLE as PropertyUnavailable; + pub use libmpv2_sys::mpv_error_MPV_ERROR_SUCCESS as Success; + pub use libmpv2_sys::mpv_error_MPV_ERROR_UNINITIALIZED as Uninitialized; + pub use libmpv2_sys::mpv_error_MPV_ERROR_UNKNOWN_FORMAT as UnknownFormat; + pub use libmpv2_sys::mpv_error_MPV_ERROR_UNSUPPORTED as Unsupported; + pub use libmpv2_sys::mpv_error_MPV_ERROR_VO_INIT_FAILED as VoInitFailed; +} + +/// Log verbosity level. +pub use libmpv2_sys::mpv_log_level as LogLevel; +pub mod mpv_log_level { + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_DEBUG as Debug; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_ERROR as Error; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_FATAL as Fatal; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_INFO as Info; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_NONE as None; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_TRACE as Trace; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_V as V; + pub use libmpv2_sys::mpv_log_level_MPV_LOG_LEVEL_WARN as Warn; +} + +/// The reason a file stopped. +#[derive(Debug, Clone, Copy)] +pub enum EndFileReason { + /** + * The end of file was reached. Sometimes this may also happen on + * incomplete or corrupted files, or if the network connection was + * interrupted when playing a remote file. It also happens if the + * playback range was restricted with --end or --frames or similar. + */ + Eof, + + /** + * Playback was stopped by an external action (e.g. playlist controls). + */ + Stop, + + /** + * Playback was stopped by the quit command or player shutdown. + */ + Quit, + + /** + * Some kind of error happened that lead to playback abort. Does not + * necessarily happen on incomplete or broken files (in these cases, both + * MPV_END_FILE_REASON_ERROR or MPV_END_FILE_REASON_EOF are possible). + * + * mpv_event_end_file.error will be set. + */ + Error, + + /** + * The file was a playlist or similar. When the playlist is read, its + * entries will be appended to the playlist after the entry of the current + * file, the entry of the current file is removed, and a MPV_EVENT_END_FILE + * event is sent with reason set to MPV_END_FILE_REASON_REDIRECT. Then + * playback continues with the playlist contents. + * Since API version 1.18. + */ + Redirect, +} + +impl From for EndFileReason { + fn from(value: libmpv2_sys::mpv_end_file_reason) -> Self { + match value { + 0 => Self::Eof, + 2 => Self::Stop, + 3 => Self::Quit, + 4 => Self::Error, + 5 => Self::Redirect, + _ => unreachable!("Other enum variants do not exist yet"), + } + } +} + +impl Display for EndFileReason { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + EndFileReason::Eof => f.write_str("The end of file was reached.")?, + EndFileReason::Error => { + f.write_str( + "Playback was stopped by an external action (e.g. playlist controls).", + )?; + } + EndFileReason::Quit => { + f.write_str("Playback was stopped by the quit command or player shutdown.")?; + } + EndFileReason::Redirect => { + f.write_str("Some kind of error happened that lead to playback abort.")?; + } + EndFileReason::Stop => { + f.write_str("The file was a playlist or similar.")?; + } + } + + Ok(()) + } +} diff --git a/crates/libmpv2/src/mpv.rs b/crates/libmpv2/src/mpv.rs new file mode 100644 index 0000000..9d554a6 --- /dev/null +++ b/crates/libmpv2/src/mpv.rs @@ -0,0 +1,620 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +macro_rules! mpv_cstr_to_str { + ($cstr: expr) => { + std::ffi::CStr::from_ptr($cstr) + .to_str() + .map_err(Error::from) + }; +} + +mod errors; + +/// Event handling +pub mod events; +/// Custom protocols (`protocol://$url`) for playback +#[cfg(feature = "protocols")] +pub mod protocol; +/// Custom rendering +#[cfg(feature = "render")] +pub mod render; + +use log::debug; + +pub use self::errors::*; +use self::events::EventContext; +use super::*; + +use std::{ + ffi::CString, + mem::MaybeUninit, + ops::Deref, + ptr::{self, NonNull}, + sync::atomic::AtomicBool, +}; + +fn mpv_err(ret: T, err: ctype::c_int) -> Result { + if err == 0 { + Ok(ret) + } else { + // debug!("Creating a raw error: {}", to_string_mpv_error(err)); + Err(Error::Raw(err)) + } +} + +/// This trait describes which types are allowed to be passed to getter mpv APIs. +pub unsafe trait GetData: Sized { + #[doc(hidden)] + fn get_from_c_void Result>(mut fun: F) -> Result { + let mut val = MaybeUninit::uninit(); + let _ = fun(val.as_mut_ptr() as *mut _)?; + Ok(unsafe { val.assume_init() }) + } + fn get_format() -> Format; +} + +/// This trait describes which types are allowed to be passed to setter mpv APIs. +pub unsafe trait SetData: Sized { + #[doc(hidden)] + fn call_as_c_void Result>( + mut self, + mut fun: F, + ) -> Result { + fun(&mut self as *mut Self as _) + } + fn get_format() -> Format; +} + +unsafe impl GetData for f64 { + fn get_format() -> Format { + Format::Double + } +} + +unsafe impl SetData for f64 { + fn get_format() -> Format { + Format::Double + } +} + +unsafe impl GetData for i64 { + fn get_format() -> Format { + Format::Int64 + } +} + +pub mod mpv_node { + use self::sys_node::SysMpvNode; + use crate::{Error, Format, GetData, Result}; + use std::{mem::MaybeUninit, os::raw::c_void, ptr}; + + #[derive(Debug, Clone)] + pub enum MpvNode { + String(String), + Flag(bool), + Int64(i64), + Double(f64), + ArrayIter(MpvNodeArrayIter), + MapIter(MpvNodeMapIter), + None, + } + + impl MpvNode { + pub fn bool(&self) -> Option { + if let MpvNode::Flag(value) = *self { + Some(value) + } else { + None + } + } + pub fn i64(&self) -> Option { + if let MpvNode::Int64(value) = *self { + Some(value) + } else { + None + } + } + pub fn f64(&self) -> Option { + if let MpvNode::Double(value) = *self { + Some(value) + } else { + None + } + } + + pub fn str(&self) -> Option<&str> { + if let MpvNode::String(value) = self { + Some(value) + } else { + None + } + } + + pub fn array(self) -> Option { + if let MpvNode::ArrayIter(value) = self { + Some(value) + } else { + None + } + } + + pub fn map(self) -> Option { + if let MpvNode::MapIter(value) = self { + Some(value) + } else { + None + } + } + } + + impl PartialEq for MpvNode { + fn eq(&self, other: &Self) -> bool { + match (self, other) { + (Self::String(l0), Self::String(r0)) => l0 == r0, + (Self::Flag(l0), Self::Flag(r0)) => l0 == r0, + (Self::Int64(l0), Self::Int64(r0)) => l0 == r0, + (Self::Double(l0), Self::Double(r0)) => l0 == r0, + (Self::ArrayIter(l0), Self::ArrayIter(r0)) => l0.clone().eq(r0.clone()), + (Self::MapIter(l0), Self::MapIter(r0)) => l0.clone().eq(r0.clone()), + _ => core::mem::discriminant(self) == core::mem::discriminant(other), + } + } + } + + #[derive(Debug)] + struct DropWrapper(libmpv2_sys::mpv_node); + + impl Drop for DropWrapper { + fn drop(&mut self) { + unsafe { + libmpv2_sys::mpv_free_node_contents(&mut self.0 as *mut libmpv2_sys::mpv_node) + }; + } + } + + pub mod sys_node { + use super::{DropWrapper, MpvNode, MpvNodeArrayIter, MpvNodeMapIter}; + use crate::{mpv_error, mpv_format, Error, Result}; + use std::rc::Rc; + + #[derive(Debug, Clone)] + pub struct SysMpvNode { + // Reference counted pointer to a parent node so it stays alive long enough. + // + // MPV has one big cleanup function that takes a node so store the parent node + // and force it to stay alive until the reference count hits 0. + parent: Option>, + node: libmpv2_sys::mpv_node, + } + + impl SysMpvNode { + pub fn new(node: libmpv2_sys::mpv_node, drop: bool) -> Self { + Self { + parent: if drop { + Some(Rc::new(DropWrapper(node))) + } else { + None + }, + node, + } + } + + pub fn child(self: Self, node: libmpv2_sys::mpv_node) -> Self { + Self { + parent: self.parent, + node, + } + } + + pub fn value(&self) -> Result { + let node = self.node; + Ok(match node.format { + mpv_format::Flag => MpvNode::Flag(unsafe { node.u.flag } == 1), + mpv_format::Int64 => MpvNode::Int64(unsafe { node.u.int64 }), + mpv_format::Double => MpvNode::Double(unsafe { node.u.double_ }), + mpv_format::String => { + let text = unsafe { mpv_cstr_to_str!(node.u.string) }?.to_owned(); + MpvNode::String(text) + } + mpv_format::Array => { + let list = unsafe { *node.u.list }; + let iter = MpvNodeArrayIter { + node: self.clone(), + start: unsafe { *node.u.list }.values, + end: unsafe { list.values.offset(list.num.try_into().unwrap()) }, + }; + return Ok(MpvNode::ArrayIter(iter)); + } + + mpv_format::Map => MpvNode::MapIter(MpvNodeMapIter { + list: unsafe { *node.u.list }, + curr: 0, + node: self.clone(), + }), + mpv_format::None => MpvNode::None, + _ => return Err(Error::Raw(mpv_error::PropertyError)), + }) + } + } + } + + #[derive(Debug, Clone)] + pub struct MpvNodeArrayIter { + // Reference counted pointer to a parent node so it stays alive long enough. + // + // MPV has one big cleanup function that takes a node so store the parent node + // and force it to stay alive until the reference count hits 0. + node: SysMpvNode, + start: *const libmpv2_sys::mpv_node, + end: *const libmpv2_sys::mpv_node, + } + + impl Iterator for MpvNodeArrayIter { + type Item = MpvNode; + + fn next(&mut self) -> Option { + if self.start == self.end { + None + } else { + unsafe { + let result = ptr::read(self.start); + let node = SysMpvNode::child(self.node.clone(), result); + self.start = self.start.offset(1); + node.value().ok() + } + } + } + } + + #[derive(Debug, Clone)] + pub struct MpvNodeMapIter { + // Reference counted pointer to a parent node so it stays alive long enough. + // + // MPV has one big cleanup function that takes a node so store the parent node + // and force it to stay alive until the reference count hits 0. + node: SysMpvNode, + list: libmpv2_sys::mpv_node_list, + curr: usize, + } + + impl Iterator for MpvNodeMapIter { + type Item = (String, MpvNode); + + fn next(&mut self) -> Option { + if self.curr >= self.list.num.try_into().unwrap() { + None + } else { + let offset = self.curr.try_into().unwrap(); + let (key, value) = unsafe { + ( + mpv_cstr_to_str!(*self.list.keys.offset(offset)), + *self.list.values.offset(offset), + ) + }; + self.curr += 1; + let node = SysMpvNode::child(self.node.clone(), value); + Some((key.unwrap().to_string(), node.value().unwrap())) + } + } + } + + unsafe impl GetData for MpvNode { + fn get_from_c_void Result>(mut fun: F) -> Result { + let mut val = MaybeUninit::uninit(); + fun(val.as_mut_ptr() as *mut _)?; + let sys_node = unsafe { val.assume_init() }; + let node = SysMpvNode::new(sys_node, true); + node.value() + } + + fn get_format() -> Format { + Format::Node + } + } +} + +unsafe impl SetData for i64 { + fn get_format() -> Format { + Format::Int64 + } +} + +unsafe impl GetData for bool { + fn get_format() -> Format { + Format::Flag + } +} + +unsafe impl SetData for bool { + fn call_as_c_void Result>(self, mut fun: F) -> Result { + let mut cpy: i64 = if self { 1 } else { 0 }; + fun(&mut cpy as *mut i64 as *mut _) + } + + fn get_format() -> Format { + Format::Flag + } +} + +unsafe impl GetData for String { + fn get_from_c_void Result>(mut fun: F) -> Result { + let ptr = &mut ptr::null(); + fun(ptr as *mut *const ctype::c_char as _)?; + + let ret = unsafe { mpv_cstr_to_str!(*ptr) }?.to_owned(); + unsafe { libmpv2_sys::mpv_free(*ptr as *mut _) }; + Ok(ret) + } + + fn get_format() -> Format { + Format::String + } +} + +unsafe impl SetData for String { + fn call_as_c_void Result>(self, mut fun: F) -> Result { + let string = CString::new(self)?; + fun((&mut string.as_ptr()) as *mut *const ctype::c_char as *mut _) + } + + fn get_format() -> Format { + Format::String + } +} + +/// Wrapper around an `&str` returned by mpv, that properly deallocates it with mpv's allocator. +#[derive(Debug, Hash, Eq, PartialEq)] +pub struct MpvStr<'a>(&'a str); +impl<'a> Deref for MpvStr<'a> { + type Target = str; + + fn deref(&self) -> &str { + self.0 + } +} +impl<'a> Drop for MpvStr<'a> { + fn drop(&mut self) { + unsafe { libmpv2_sys::mpv_free(self.0.as_ptr() as *mut u8 as _) }; + } +} + +unsafe impl<'a> GetData for MpvStr<'a> { + fn get_from_c_void Result>( + mut fun: F, + ) -> Result> { + let ptr = &mut ptr::null(); + let _ = fun(ptr as *mut *const ctype::c_char as _)?; + + Ok(MpvStr(unsafe { mpv_cstr_to_str!(*ptr) }?)) + } + + fn get_format() -> Format { + Format::String + } +} + +unsafe impl<'a> SetData for &'a str { + fn call_as_c_void Result>(self, mut fun: F) -> Result { + let string = CString::new(self)?; + fun((&mut string.as_ptr()) as *mut *const ctype::c_char as *mut _) + } + + fn get_format() -> Format { + Format::String + } +} + +#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)] +/// Subset of `mpv_format` used by the public API. +pub enum Format { + String, + Flag, + Int64, + Double, + Node, +} + +impl Format { + fn as_mpv_format(&self) -> MpvFormat { + match *self { + Format::String => mpv_format::String, + Format::Flag => mpv_format::Flag, + Format::Int64 => mpv_format::Int64, + Format::Double => mpv_format::Double, + Format::Node => mpv_format::Node, + } + } +} + +/// Context passed to the `initializer` of `Mpv::with_initialzer`. +pub struct MpvInitializer { + ctx: *mut libmpv2_sys::mpv_handle, +} + +impl MpvInitializer { + /// Set the value of a property. + pub fn set_property(&self, name: &str, data: T) -> Result<()> { + let name = CString::new(name)?; + let format = T::get_format().as_mpv_format() as _; + data.call_as_c_void(|ptr| { + mpv_err((), unsafe { + libmpv2_sys::mpv_set_property(self.ctx, name.as_ptr(), format, ptr) + }) + }) + } + + /// Set the value of an option + pub fn set_option(&self, name: &str, data: T) -> Result<()> { + let name = CString::new(name)?; + let format = T::get_format().as_mpv_format() as _; + data.call_as_c_void(|ptr| { + mpv_err((), unsafe { + libmpv2_sys::mpv_set_option(self.ctx, name.as_ptr(), format, ptr) + }) + }) + } +} + +/// The central mpv context. +pub struct Mpv { + /// The handle to the mpv core + pub ctx: NonNull, + event_context: EventContext, + #[cfg(feature = "protocols")] + protocols_guard: AtomicBool, +} + +unsafe impl Send for Mpv {} +unsafe impl Sync for Mpv {} + +impl Drop for Mpv { + fn drop(&mut self) { + unsafe { + libmpv2_sys::mpv_terminate_destroy(self.ctx.as_ptr()); + } + } +} + +impl Mpv { + /// Create a new `Mpv`. + /// The default settings can be probed by running: `$ mpv --show-profile=libmpv`. + pub fn new() -> Result { + Mpv::with_initializer(|_| Ok(())) + } + + /// Create a new `Mpv`. + /// The same as `Mpv::new`, but you can set properties before `Mpv` is initialized. + pub fn with_initializer Result<()>>( + initializer: F, + ) -> Result { + let api_version = unsafe { libmpv2_sys::mpv_client_api_version() }; + if crate::MPV_CLIENT_API_MAJOR != api_version >> 16 { + return Err(Error::VersionMismatch { + linked: crate::MPV_CLIENT_API_VERSION, + loaded: api_version, + }); + } + + let ctx = unsafe { libmpv2_sys::mpv_create() }; + if ctx.is_null() { + return Err(Error::Null); + } + + initializer(MpvInitializer { ctx })?; + mpv_err((), unsafe { libmpv2_sys::mpv_initialize(ctx) }).map_err(|err| { + unsafe { libmpv2_sys::mpv_terminate_destroy(ctx) }; + err + })?; + + let ctx = unsafe { NonNull::new_unchecked(ctx) }; + + Ok(Mpv { + ctx, + event_context: EventContext::new(ctx), + #[cfg(feature = "protocols")] + protocols_guard: AtomicBool::new(false), + }) + } + + /// Execute a command + pub fn execute(&self, name: &str, args: &[&str]) -> Result<()> { + if args.is_empty() { + debug!("Running mpv command: '{}'", name); + } else { + debug!("Running mpv command: '{} {}'", name, args.join(" ")); + } + + self.command(name, args)?; + + Ok(()) + } + + /// Load a configuration file. The path has to be absolute, and a file. + pub fn load_config(&self, path: &str) -> Result<()> { + let file = CString::new(path)?.into_raw(); + let ret = mpv_err((), unsafe { + libmpv2_sys::mpv_load_config_file(self.ctx.as_ptr(), file) + }); + unsafe { + drop(CString::from_raw(file)); + }; + ret + } + + pub fn event_context(&self) -> &EventContext { + &self.event_context + } + + pub fn event_context_mut(&mut self) -> &mut EventContext { + &mut self.event_context + } + + /// Send a command to the `Mpv` instance. This uses `mpv_command_string` internally, + /// so that the syntax is the same as described in the [manual for the input.conf](https://mpv.io/manual/master/#list-of-input-commands). + /// + /// Note that you may have to escape strings with `""` when they contain spaces. + /// + /// # Examples + /// + /// ``` + /// # use libmpv2::{Mpv}; + /// # use libmpv2::mpv_node::MpvNode; + /// # use std::collections::HashMap; + /// mpv.command("loadfile", &["test-data/jellyfish.mp4", "append-play"]).unwrap(); + /// # let node = mpv.get_property::("playlist").unwrap(); + /// # let mut list = node.array().unwrap().collect::>(); + /// # let map = list.pop().unwrap().map().unwrap().collect::>(); + /// # assert_eq!(map, HashMap::from([(String::from("id"), MpvNode::Int64(1)), (String::from("current"), MpvNode::Flag(true)), (String::from("filename"), MpvNode::String(String::from("test-data/jellyfish.mp4")))])); + /// ``` + pub fn command(&self, name: &str, args: &[&str]) -> Result<()> { + let mut cmd = name.to_owned(); + + for elem in args { + cmd.push(' '); + cmd.push_str(elem); + } + + let raw = CString::new(cmd)?; + mpv_err((), unsafe { + libmpv2_sys::mpv_command_string(self.ctx.as_ptr(), raw.as_ptr()) + }) + } + + /// Set the value of a property. + pub fn set_property(&self, name: &str, data: T) -> Result<()> { + let name = CString::new(name)?; + let format = T::get_format().as_mpv_format() as _; + data.call_as_c_void(|ptr| { + mpv_err((), unsafe { + libmpv2_sys::mpv_set_property(self.ctx.as_ptr(), name.as_ptr(), format, ptr) + }) + }) + } + + /// Get the value of a property. + pub fn get_property(&self, name: &str) -> Result { + let name = CString::new(name)?; + + let format = T::get_format().as_mpv_format() as _; + T::get_from_c_void(|ptr| { + mpv_err((), unsafe { + libmpv2_sys::mpv_get_property(self.ctx.as_ptr(), name.as_ptr(), format, ptr) + }) + }) + } + + /// Internal time in microseconds, this has an arbitrary offset, and will never go backwards. + /// + /// This can be called at any time, even if it was stated that no API function should be called. + pub fn get_internal_time(&self) -> i64 { + unsafe { libmpv2_sys::mpv_get_time_us(self.ctx.as_ptr()) } + } +} diff --git a/crates/libmpv2/src/mpv/errors.rs b/crates/libmpv2/src/mpv/errors.rs new file mode 100644 index 0000000..a2baee5 --- /dev/null +++ b/crates/libmpv2/src/mpv/errors.rs @@ -0,0 +1,110 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use std::{ffi::NulError, os::raw as ctype, str::Utf8Error}; + +use thiserror::Error; + +use super::mpv_error; + +#[allow(missing_docs)] +pub type Result = ::std::result::Result; + +#[derive(Error, Debug)] +pub enum Error { + #[error("loading file failed: {error}")] + Loadfile { error: String }, + + #[error("version mismatch detected! Linked version ({linked}) is unequal to the loaded version ({loaded})")] + VersionMismatch { + linked: ctype::c_ulong, + loaded: ctype::c_ulong, + }, + + #[error("invalid utf8 returned")] + InvalidUtf8, + + #[error("null pointer returned")] + Null, + + #[error("raw error returned: {}", to_string_mpv_error(*(.0)))] + Raw(crate::MpvError), +} + +impl From for Error { + fn from(_other: NulError) -> Error { + Error::Null + } +} + +impl From for Error { + fn from(_other: Utf8Error) -> Error { + Error::InvalidUtf8 + } +} +impl From for Error { + fn from(other: crate::MpvError) -> Error { + Error::Raw(other) + } +} + +pub(crate) fn to_string_mpv_error(num: crate::MpvError) -> String { + let (error, help) = to_string_mpv_error_raw(num); + + if help.is_empty() { + error.to_owned() + } else { + format!("{} ({})", error, help) + } +} + +fn to_string_mpv_error_raw(num: crate::MpvError) -> (&'static str, &'static str) { + // debug!("Turning error num '{}' to a string.", num); + + match num { + mpv_error::EventQueueFull => ( + "The event ringbuffer is full.", + "This means the client is choked, and can't receive any events. This can happen when too many asynchronous requests have been made, but not answered. Probably never happens in practice, unless the mpv core is frozen for some reason, and the client keeps making asynchronous requests. (Bugs in the client API implementation could also trigger this, e.g. if events become \"lost\".)", + ), + + mpv_error::NoMem => ("Memory allocation failed.", ""), + + mpv_error::Uninitialized => ("The mpv core wasn't configured and initialized yet", " See the notes in mpv_create()."), + + mpv_error::InvalidParameter => ("Generic catch-all error if a parameter is set to an invalid or unsupported value.", "This is used if there is no better error code."), + + mpv_error::OptionNotFound => ("Trying to set an option that doesn't exist.", ""), + mpv_error::OptionFormat => ("Trying to set an option using an unsupported MPV_FORMAT.", ""), + mpv_error::OptionError => ("Setting the option failed", " Typically this happens if the provided option value could not be parsed."), + + mpv_error::PropertyNotFound => ("The accessed property doesn't exist.", ""), + mpv_error::PropertyFormat => ("Trying to set or get a property using an unsupported MPV_FORMAT.", ""), + mpv_error::PropertyUnavailable => ("The property exists, but is not available", "This usually happens when the associated subsystem is not active, e.g. querying audio parameters while audio is disabled."), + mpv_error::PropertyError => ("Error setting or getting a property.", ""), + + mpv_error::Command => ("General error when running a command with mpv_command and similar.", ""), + + mpv_error::LoadingFailed => ("Generic error on loading (usually used with mpv_event_end_file.error).", ""), + + mpv_error::AoInitFailed => ("Initializing the audio output failed.", ""), + mpv_error::VoInitFailed => ("Initializing the video output failed.", ""), + + mpv_error::NothingToPlay => ("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."), + + mpv_error::UnknownFormat => (" * When trying to load the file, the file format could not be determined, or the file was too broken to open it.", ""), + + mpv_error::Generic => ("Generic error for signaling that certain system requirements are not fulfilled.", ""), + mpv_error::NotImplemented => ("The API function which was called is a stub only", ""), + mpv_error::Unsupported => ("Unspecified error.", ""), + + mpv_error::Success => unreachable!("This is not an error. It's just here, to ensure that the 0 case marks an success'"), + _ => unreachable!("Mpv seems to have changed it's constants."), + } +} diff --git a/crates/libmpv2/src/mpv/events.rs b/crates/libmpv2/src/mpv/events.rs new file mode 100644 index 0000000..cbe1ef3 --- /dev/null +++ b/crates/libmpv2/src/mpv/events.rs @@ -0,0 +1,383 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use crate::mpv_node::sys_node::SysMpvNode; +use crate::{mpv::mpv_err, *}; + +use std::ffi::{c_void, CString}; +use std::os::raw as ctype; +use std::ptr::NonNull; +use std::slice; + +/// An `Event`'s ID. +pub use libmpv2_sys::mpv_event_id as EventId; + +use self::mpv_node::MpvNode; +pub mod mpv_event_id { + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_AUDIO_RECONFIG as AudioReconfig; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_CLIENT_MESSAGE as ClientMessage; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_COMMAND_REPLY as CommandReply; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_END_FILE as EndFile; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_FILE_LOADED as FileLoaded; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_GET_PROPERTY_REPLY as GetPropertyReply; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_HOOK as Hook; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_LOG_MESSAGE as LogMessage; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_NONE as None; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_PLAYBACK_RESTART as PlaybackRestart; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_PROPERTY_CHANGE as PropertyChange; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_QUEUE_OVERFLOW as QueueOverflow; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_SEEK as Seek; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_SET_PROPERTY_REPLY as SetPropertyReply; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_SHUTDOWN as Shutdown; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_START_FILE as StartFile; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_TICK as Tick; + pub use libmpv2_sys::mpv_event_id_MPV_EVENT_VIDEO_RECONFIG as VideoReconfig; +} + +#[derive(Debug)] +/// Data that is returned by both `GetPropertyReply` and `PropertyChange` events. +pub enum PropertyData<'a> { + Str(&'a str), + OsdStr(&'a str), + Flag(bool), + Int64(i64), + Double(ctype::c_double), + Node(MpvNode), +} + +impl<'a> PropertyData<'a> { + // SAFETY: meant to extract the data from an event property. See `mpv_event_property` in + // `client.h` + unsafe fn from_raw(format: MpvFormat, ptr: *mut ctype::c_void) -> Result> { + assert!(!ptr.is_null()); + match format { + mpv_format::Flag => Ok(PropertyData::Flag(*(ptr as *mut bool))), + mpv_format::String => { + let char_ptr = *(ptr as *mut *mut ctype::c_char); + Ok(PropertyData::Str(mpv_cstr_to_str!(char_ptr)?)) + } + mpv_format::OsdString => { + let char_ptr = *(ptr as *mut *mut ctype::c_char); + Ok(PropertyData::OsdStr(mpv_cstr_to_str!(char_ptr)?)) + } + mpv_format::Double => Ok(PropertyData::Double(*(ptr as *mut f64))), + mpv_format::Int64 => Ok(PropertyData::Int64(*(ptr as *mut i64))), + mpv_format::Node => { + let sys_node = *(ptr as *mut libmpv2_sys::mpv_node); + let node = SysMpvNode::new(sys_node, false); + return Ok(PropertyData::Node(node.value().unwrap())); + } + mpv_format::None => unreachable!(), + _ => unimplemented!(), + } + } +} + +pub type PlaylistEntryId = i64; + +#[derive(Debug)] +pub enum Event<'a> { + /// Received when the player is shutting down + Shutdown, + /// *Has not been tested*, received when explicitly asked to MPV + LogMessage { + prefix: &'a str, + level: &'a str, + text: &'a str, + log_level: LogLevel, + }, + /// Received when using get_property_async + GetPropertyReply { + name: &'a str, + result: PropertyData<'a>, + reply_userdata: u64, + }, + /// Received when using set_property_async + SetPropertyReply(u64), + /// Received when using command_async + CommandReply(u64), + /// Event received when a new file is playing + StartFile(PlaylistEntryId), + /// Event received when the file being played currently has stopped, for an error or not + EndFile(EndFileReason), + /// Event received when a file has been *loaded*, but has not been started + FileLoaded, + ClientMessage(Vec<&'a str>), + VideoReconfig, + AudioReconfig, + /// The player changed current position + Seek, + PlaybackRestart, + /// Received when used with observe_property + PropertyChange { + name: &'a str, + change: PropertyData<'a>, + reply_userdata: u64, + }, + /// Received when the Event Queue is full + QueueOverflow, + /// A deprecated event + Deprecated(libmpv2_sys::mpv_event), +} + +unsafe extern "C" fn wu_wrapper(ctx: *mut c_void) { + if ctx.is_null() { + panic!("ctx for wakeup wrapper is NULL"); + } + + (*(ctx as *mut F))(); +} + +/// Context to listen to events. +pub struct EventContext { + ctx: NonNull, + wakeup_callback_cleanup: Option>, +} + +unsafe impl Send for EventContext {} + +impl EventContext { + pub fn new(ctx: NonNull) -> Self { + EventContext { + ctx, + wakeup_callback_cleanup: None, + } + } + + /// Enable an event. + pub fn enable_event(&self, ev: events::EventId) -> Result<()> { + mpv_err((), unsafe { + libmpv2_sys::mpv_request_event(self.ctx.as_ptr(), ev, 1) + }) + } + + /// Enable all, except deprecated, events. + pub fn enable_all_events(&self) -> Result<()> { + for i in (2..9).chain(16..19).chain(20..23).chain(24..26) { + self.enable_event(i)?; + } + Ok(()) + } + + /// Disable an event. + pub fn disable_event(&self, ev: events::EventId) -> Result<()> { + mpv_err((), unsafe { + libmpv2_sys::mpv_request_event(self.ctx.as_ptr(), ev, 0) + }) + } + + /// Diable all deprecated events. + pub fn disable_deprecated_events(&self) -> Result<()> { + self.disable_event(libmpv2_sys::mpv_event_id_MPV_EVENT_IDLE)?; + Ok(()) + } + + /// Diable all events. + pub fn disable_all_events(&self) -> Result<()> { + for i in 2..26 { + self.disable_event(i as _)?; + } + Ok(()) + } + + /// Observe `name` property for changes. `id` can be used to unobserve this (or many) properties + /// again. + pub fn observe_property(&self, name: &str, format: Format, id: u64) -> Result<()> { + let name = CString::new(name)?; + mpv_err((), unsafe { + libmpv2_sys::mpv_observe_property( + self.ctx.as_ptr(), + id, + name.as_ptr(), + format.as_mpv_format() as _, + ) + }) + } + + /// Unobserve any property associated with `id`. + pub fn unobserve_property(&self, id: u64) -> Result<()> { + mpv_err((), unsafe { + libmpv2_sys::mpv_unobserve_property(self.ctx.as_ptr(), id) + }) + } + + /// Wait for `timeout` seconds for an `Event`. Passing `0` as `timeout` will poll. + /// For more information, as always, see the mpv-sys docs of `mpv_wait_event`. + /// + /// This function is intended to be called repeatedly in a wait-event loop. + /// + /// Returns `Some(Err(...))` if there was invalid utf-8, or if either an + /// `MPV_EVENT_GET_PROPERTY_REPLY`, `MPV_EVENT_SET_PROPERTY_REPLY`, `MPV_EVENT_COMMAND_REPLY`, + /// or `MPV_EVENT_PROPERTY_CHANGE` event failed, or if `MPV_EVENT_END_FILE` reported an error. + pub fn wait_event(&mut self, timeout: f64) -> Option> { + let event = unsafe { *libmpv2_sys::mpv_wait_event(self.ctx.as_ptr(), timeout) }; + + // debug!("Got an event from mpv: {:#?}", event); + + if event.event_id != mpv_event_id::None { + if let Err(e) = mpv_err((), event.error) { + return Some(Err(e)); + } + } + + match event.event_id { + mpv_event_id::None => None, + mpv_event_id::Shutdown => Some(Ok(Event::Shutdown)), + mpv_event_id::LogMessage => { + let log_message = + unsafe { *(event.data as *mut libmpv2_sys::mpv_event_log_message) }; + + let prefix = unsafe { mpv_cstr_to_str!(log_message.prefix) }; + Some(prefix.and_then(|prefix| { + Ok(Event::LogMessage { + prefix, + level: unsafe { mpv_cstr_to_str!(log_message.level)? }, + text: unsafe { mpv_cstr_to_str!(log_message.text)? }, + log_level: log_message.log_level, + }) + })) + } + mpv_event_id::GetPropertyReply => { + let property = unsafe { *(event.data as *mut libmpv2_sys::mpv_event_property) }; + + let name = unsafe { mpv_cstr_to_str!(property.name) }; + Some(name.and_then(|name| { + // SAFETY: safe because we are passing format + data from an mpv_event_property + let result = unsafe { PropertyData::from_raw(property.format, property.data) }?; + + Ok(Event::GetPropertyReply { + name, + result, + reply_userdata: event.reply_userdata, + }) + })) + } + mpv_event_id::SetPropertyReply => Some(mpv_err( + Event::SetPropertyReply(event.reply_userdata), + event.error, + )), + mpv_event_id::CommandReply => Some(mpv_err( + Event::CommandReply(event.reply_userdata), + event.error, + )), + mpv_event_id::StartFile => { + let playlist_id = unsafe { *(event.data as *mut i64) }; + + Some(Ok(Event::StartFile(playlist_id))) + } + mpv_event_id::EndFile => { + let end_file = unsafe { *(event.data as *mut libmpv2_sys::mpv_event_end_file) }; + + // debug!("Got an end file event, with error code '{:#?}'", end_file); + + if let Err(e) = mpv_err((), end_file.error) { + Some(Err(e)) + } else { + Some(Ok(Event::EndFile(end_file.reason.into()))) + } + } + mpv_event_id::FileLoaded => Some(Ok(Event::FileLoaded)), + mpv_event_id::ClientMessage => { + let client_message = + unsafe { *(event.data as *mut libmpv2_sys::mpv_event_client_message) }; + let messages = unsafe { + slice::from_raw_parts_mut(client_message.args, client_message.num_args as _) + }; + Some(Ok(Event::ClientMessage( + messages + .iter() + .map(|msg| unsafe { mpv_cstr_to_str!(*msg) }) + .collect::>>() + .unwrap(), + ))) + } + mpv_event_id::VideoReconfig => Some(Ok(Event::VideoReconfig)), + mpv_event_id::AudioReconfig => Some(Ok(Event::AudioReconfig)), + mpv_event_id::Seek => Some(Ok(Event::Seek)), + mpv_event_id::PlaybackRestart => Some(Ok(Event::PlaybackRestart)), + mpv_event_id::PropertyChange => { + let property = unsafe { *(event.data as *mut libmpv2_sys::mpv_event_property) }; + + // This happens if the property is not available. For example, + // if you reached EndFile while observing a property. + if property.format == mpv_format::None { + None + } else { + let name = unsafe { mpv_cstr_to_str!(property.name) }; + Some(name.and_then(|name| { + // SAFETY: safe because we are passing format + data from an mpv_event_property + let change = + unsafe { PropertyData::from_raw(property.format, property.data) }?; + + Ok(Event::PropertyChange { + name, + change, + reply_userdata: event.reply_userdata, + }) + })) + } + } + mpv_event_id::QueueOverflow => Some(Ok(Event::QueueOverflow)), + _ => Some(Ok(Event::Deprecated(event))), + } + } + + /// Set a custom function that should be called when there are new events. Use this if + /// blocking in [wait_event](#method.wait_event) to wait for new events is not feasible. + /// + /// Keep in mind that the callback will be called from foreign threads. You must not make + /// any assumptions of the environment, and you must return as soon as possible (i.e. no + /// long blocking waits). Exiting the callback through any other means than a normal return + /// is forbidden (no throwing exceptions, no `longjmp()` calls). You must not change any + /// local thread state (such as the C floating point environment). + /// + /// You are not allowed to call any client API functions inside of the callback. In + /// particular, you should not do any processing in the callback, but wake up another + /// thread that does all the work. The callback is meant strictly for notification only, + /// and is called from arbitrary core parts of the player, that make no considerations for + /// reentrant API use or allowing the callee to spend a lot of time doing other things. + /// Keep in mind that it’s also possible that the callback is called from a thread while a + /// mpv API function is called (i.e. it can be reentrant). + /// + /// In general, the client API expects you to call [wait_event](#method.wait_event) to receive + /// notifications, and the wakeup callback is merely a helper utility to make this easier in + /// certain situations. Note that it’s possible that there’s only one wakeup callback + /// invocation for multiple events. You should call [wait_event](#method.wait_event) with no timeout until + /// `None` is returned, at which point the event queue is empty. + /// + /// If you actually want to do processing in a callback, spawn a thread that does nothing but + /// call [wait_event](#method.wait_event) in a loop and dispatches the result to a callback. + /// + /// Only one wakeup callback can be set. + pub fn set_wakeup_callback(&mut self, callback: F) { + if let Some(wakeup_callback_cleanup) = self.wakeup_callback_cleanup.take() { + wakeup_callback_cleanup(); + } + let raw_callback = Box::into_raw(Box::new(callback)); + self.wakeup_callback_cleanup = Some(Box::new(move || unsafe { + drop(Box::from_raw(raw_callback)); + }) as Box); + unsafe { + libmpv2_sys::mpv_set_wakeup_callback( + self.ctx.as_ptr(), + Some(wu_wrapper::), + raw_callback as *mut c_void, + ); + } + } +} + +impl Drop for EventContext { + fn drop(&mut self) { + if let Some(wakeup_callback_cleanup) = self.wakeup_callback_cleanup.take() { + wakeup_callback_cleanup(); + } + } +} diff --git a/crates/libmpv2/src/mpv/protocol.rs b/crates/libmpv2/src/mpv/protocol.rs new file mode 100644 index 0000000..4ae4f16 --- /dev/null +++ b/crates/libmpv2/src/mpv/protocol.rs @@ -0,0 +1,261 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use super::*; + +use std::alloc::{self, Layout}; +use std::marker::PhantomData; +use std::mem; +use std::os::raw as ctype; +use std::panic; +use std::panic::RefUnwindSafe; +use std::slice; +use std::sync::{atomic::Ordering, Mutex}; + +impl Mpv { + /// Create a context with which custom protocols can be registered. + /// + /// # Panics + /// Panics if a context already exists + pub fn create_protocol_context(&self) -> ProtocolContext + where + T: RefUnwindSafe, + U: RefUnwindSafe, + { + match self.protocols_guard.compare_exchange( + false, + true, + Ordering::AcqRel, + Ordering::Acquire, + ) { + Ok(_) => ProtocolContext::new(self.ctx, PhantomData::<&Self>), + Err(_) => panic!("A protocol context already exists"), + } + } +} + +/// Return a persistent `T` that is passed to all other `Stream*` functions, panic on errors. +pub type StreamOpen = fn(&mut U, &str) -> T; +/// Do any necessary cleanup. +pub type StreamClose = fn(Box); +/// Seek to the given offset. Return the new offset, or either `MpvError::Generic` if seeking +/// failed or panic. +pub type StreamSeek = fn(&mut T, i64) -> i64; +/// Target buffer with fixed capacity. +/// Return either the number of read bytes, `0` on EOF, or either `-1` or panic on error. +pub type StreamRead = fn(&mut T, &mut [ctype::c_char]) -> i64; +/// Return the total size of the stream in bytes. Panic on error. +pub type StreamSize = fn(&mut T) -> i64; + +unsafe extern "C" fn open_wrapper( + user_data: *mut ctype::c_void, + uri: *mut ctype::c_char, + info: *mut libmpv2_sys::mpv_stream_cb_info, +) -> ctype::c_int +where + T: RefUnwindSafe, + U: RefUnwindSafe, +{ + let data = user_data as *mut ProtocolData; + + (*info).cookie = user_data; + (*info).read_fn = Some(read_wrapper::); + (*info).seek_fn = Some(seek_wrapper::); + (*info).size_fn = Some(size_wrapper::); + (*info).close_fn = Some(close_wrapper::); + + let ret = panic::catch_unwind(|| { + let uri = mpv_cstr_to_str!(uri as *const _).unwrap(); + ptr::write( + (*data).cookie, + ((*data).open_fn)(&mut (*data).user_data, uri), + ); + }); + + if ret.is_ok() { + 0 + } else { + mpv_error::Generic as _ + } +} + +unsafe extern "C" fn read_wrapper( + cookie: *mut ctype::c_void, + buf: *mut ctype::c_char, + nbytes: u64, +) -> i64 +where + T: RefUnwindSafe, + U: RefUnwindSafe, +{ + let data = cookie as *mut ProtocolData; + + let ret = panic::catch_unwind(|| { + let slice = slice::from_raw_parts_mut(buf, nbytes as _); + ((*data).read_fn)(&mut *(*data).cookie, slice) + }); + if let Ok(ret) = ret { + ret + } else { + -1 + } +} + +unsafe extern "C" fn seek_wrapper(cookie: *mut ctype::c_void, offset: i64) -> i64 +where + T: RefUnwindSafe, + U: RefUnwindSafe, +{ + let data = cookie as *mut ProtocolData; + + if (*data).seek_fn.is_none() { + return mpv_error::Unsupported as _; + } + + let ret = + panic::catch_unwind(|| (*(*data).seek_fn.as_ref().unwrap())(&mut *(*data).cookie, offset)); + if let Ok(ret) = ret { + ret + } else { + mpv_error::Generic as _ + } +} + +unsafe extern "C" fn size_wrapper(cookie: *mut ctype::c_void) -> i64 +where + T: RefUnwindSafe, + U: RefUnwindSafe, +{ + let data = cookie as *mut ProtocolData; + + if (*data).size_fn.is_none() { + return mpv_error::Unsupported as _; + } + + let ret = panic::catch_unwind(|| (*(*data).size_fn.as_ref().unwrap())(&mut *(*data).cookie)); + if let Ok(ret) = ret { + ret + } else { + mpv_error::Unsupported as _ + } +} + +#[allow(unused_must_use)] +unsafe extern "C" fn close_wrapper(cookie: *mut ctype::c_void) +where + T: RefUnwindSafe, + U: RefUnwindSafe, +{ + let data = Box::from_raw(cookie as *mut ProtocolData); + + panic::catch_unwind(|| ((*data).close_fn)(Box::from_raw((*data).cookie))); +} + +struct ProtocolData { + cookie: *mut T, + user_data: U, + + open_fn: StreamOpen, + close_fn: StreamClose, + read_fn: StreamRead, + seek_fn: Option>, + size_fn: Option>, +} + +/// This context holds state relevant to custom protocols. +/// It is created by calling `Mpv::create_protocol_context`. +pub struct ProtocolContext<'parent, T: RefUnwindSafe, U: RefUnwindSafe> { + ctx: NonNull, + protocols: Mutex>>, + _does_not_outlive: PhantomData<&'parent Mpv>, +} + +unsafe impl<'parent, T: RefUnwindSafe, U: RefUnwindSafe> Send for ProtocolContext<'parent, T, U> {} +unsafe impl<'parent, T: RefUnwindSafe, U: RefUnwindSafe> Sync for ProtocolContext<'parent, T, U> {} + +impl<'parent, T: RefUnwindSafe, U: RefUnwindSafe> ProtocolContext<'parent, T, U> { + fn new( + ctx: NonNull, + marker: PhantomData<&'parent Mpv>, + ) -> ProtocolContext<'parent, T, U> { + ProtocolContext { + ctx, + protocols: Mutex::new(Vec::new()), + _does_not_outlive: marker, + } + } + + /// Register a custom `Protocol`. Once a protocol has been registered, it lives as long as + /// `Mpv`. + /// + /// Returns `Error::Mpv(MpvError::InvalidParameter)` if a protocol with the same name has + /// already been registered. + pub fn register(&self, protocol: Protocol) -> Result<()> { + let mut protocols = self.protocols.lock().unwrap(); + protocol.register(self.ctx.as_ptr())?; + protocols.push(protocol); + Ok(()) + } +} + +/// `Protocol` holds all state used by a custom protocol. +pub struct Protocol { + name: String, + data: *mut ProtocolData, +} + +impl Protocol { + /// `name` is the prefix of the protocol, e.g. `name://path`. + /// + /// `user_data` is data that will be passed to `open_fn`. + /// + /// # Safety + /// Do not call libmpv functions in any supplied function. + /// All panics of the provided functions are catched and can be used as generic error returns. + pub unsafe fn new( + name: String, + user_data: U, + open_fn: StreamOpen, + close_fn: StreamClose, + read_fn: StreamRead, + seek_fn: Option>, + size_fn: Option>, + ) -> Protocol { + let c_layout = Layout::from_size_align(mem::size_of::(), mem::align_of::()).unwrap(); + let cookie = alloc::alloc(c_layout) as *mut T; + let data = Box::into_raw(Box::new(ProtocolData { + cookie, + user_data, + + open_fn, + close_fn, + read_fn, + seek_fn, + size_fn, + })); + + Protocol { name, data } + } + + fn register(&self, ctx: *mut libmpv2_sys::mpv_handle) -> Result<()> { + let name = CString::new(&self.name[..])?; + unsafe { + mpv_err( + (), + libmpv2_sys::mpv_stream_cb_add_ro( + ctx, + name.as_ptr(), + self.data as *mut _, + Some(open_wrapper::), + ), + ) + } + } +} diff --git a/crates/libmpv2/src/mpv/render.rs b/crates/libmpv2/src/mpv/render.rs new file mode 100644 index 0000000..91db34e --- /dev/null +++ b/crates/libmpv2/src/mpv/render.rs @@ -0,0 +1,406 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use crate::{mpv::mpv_err, Error, Result}; +use std::collections::HashMap; +use std::ffi::{c_void, CStr}; +use std::os::raw::c_int; +use std::ptr; + +type DeleterFn = unsafe fn(*mut c_void); + +pub struct RenderContext { + ctx: *mut libmpv2_sys::mpv_render_context, + update_callback_cleanup: Option>, +} + +/// For initializing the mpv OpenGL state via RenderParam::OpenGLInitParams +pub struct OpenGLInitParams { + /// This retrieves OpenGL function pointers, and will use them in subsequent + /// operation. + /// Usually, you can simply call the GL context APIs from this callback (e.g. + /// glXGetProcAddressARB or wglGetProcAddress), but some APIs do not always + /// return pointers for all standard functions (even if present); in this + /// case you have to compensate by looking up these functions yourself when + /// libmpv wants to resolve them through this callback. + /// libmpv will not normally attempt to resolve GL functions on its own, nor + /// does it link to GL libraries directly. + pub get_proc_address: fn(ctx: &GLContext, name: &str) -> *mut c_void, + + /// Value passed as ctx parameter to get_proc_address(). + pub ctx: GLContext, +} + +/// For RenderParam::FBO +pub struct FBO { + pub fbo: i32, + pub width: i32, + pub height: i32, +} + +#[repr(u32)] +#[derive(Clone)] +pub enum RenderFrameInfoFlag { + Present = libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_PRESENT, + Redraw = libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_REDRAW, + Repeat = libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_REPEAT, + BlockVSync = libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_BLOCK_VSYNC, +} + +impl From for RenderFrameInfoFlag { + // mpv_render_frame_info_flag is u32, but mpv_render_frame_info.flags is u64 o\ + fn from(val: u64) -> Self { + let val = val as u32; + match val { + libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_PRESENT => { + RenderFrameInfoFlag::Present + } + libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_REDRAW => { + RenderFrameInfoFlag::Redraw + } + libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_REPEAT => { + RenderFrameInfoFlag::Repeat + } + libmpv2_sys::mpv_render_frame_info_flag_MPV_RENDER_FRAME_INFO_BLOCK_VSYNC => { + RenderFrameInfoFlag::BlockVSync + } + _ => panic!("Tried converting invalid value to RenderFrameInfoFlag"), + } + } +} + +#[derive(Clone)] +pub struct RenderFrameInfo { + pub flags: RenderFrameInfoFlag, + pub target_time: i64, +} + +pub enum RenderParamApiType { + OpenGl, +} + +pub enum RenderParam { + Invalid, + ApiType(RenderParamApiType), + InitParams(OpenGLInitParams), + FBO(FBO), + FlipY(bool), + Depth(i32), + ICCProfile(Vec), + AmbientLight(i32), + X11Display(*const c_void), + WaylandDisplay(*const c_void), + AdvancedControl(bool), + NextFrameInfo(RenderFrameInfo), + BlockForTargetTime(bool), + SkipRendering(bool), +} + +impl From<&RenderParam> for u32 { + fn from(val: &RenderParam) -> Self { + match val { + RenderParam::Invalid => 0, + RenderParam::ApiType(_) => 1, + RenderParam::InitParams(_) => 2, + RenderParam::FBO(_) => 3, + RenderParam::FlipY(_) => 4, + RenderParam::Depth(_) => 5, + RenderParam::ICCProfile(_) => 6, + RenderParam::AmbientLight(_) => 7, + RenderParam::X11Display(_) => 8, + RenderParam::WaylandDisplay(_) => 9, + RenderParam::AdvancedControl(_) => 10, + RenderParam::NextFrameInfo(_) => 11, + RenderParam::BlockForTargetTime(_) => 12, + RenderParam::SkipRendering(_) => 13, + } + } +} + +unsafe extern "C" fn gpa_wrapper(ctx: *mut c_void, name: *const i8) -> *mut c_void { + if ctx.is_null() { + panic!("ctx for get_proc_address wrapper is NULL"); + } + + let params: *mut OpenGLInitParams = ctx as _; + let params = &*params; + (params.get_proc_address)( + ¶ms.ctx, + CStr::from_ptr(name) + .to_str() + .expect("Could not convert function name to str"), + ) +} + +unsafe extern "C" fn ru_wrapper(ctx: *mut c_void) { + if ctx.is_null() { + panic!("ctx for render_update wrapper is NULL"); + } + + (*(ctx as *mut F))(); +} + +impl From> for libmpv2_sys::mpv_opengl_init_params { + fn from(val: OpenGLInitParams) -> Self { + Self { + get_proc_address: Some(gpa_wrapper::>), + get_proc_address_ctx: Box::into_raw(Box::new(val)) as *mut c_void, + } + } +} + +impl From> for libmpv2_sys::mpv_render_param { + fn from(val: RenderParam) -> Self { + let type_ = u32::from(&val); + let data = match val { + RenderParam::Invalid => ptr::null_mut(), + RenderParam::ApiType(api_type) => match api_type { + RenderParamApiType::OpenGl => { + libmpv2_sys::MPV_RENDER_API_TYPE_OPENGL.as_ptr() as *mut c_void + } + }, + RenderParam::InitParams(params) => { + Box::into_raw(Box::new(libmpv2_sys::mpv_opengl_init_params::from(params))) + as *mut c_void + } + RenderParam::FBO(fbo) => Box::into_raw(Box::new(fbo)) as *mut c_void, + RenderParam::FlipY(flip) => Box::into_raw(Box::new(flip as c_int)) as *mut c_void, + RenderParam::Depth(depth) => Box::into_raw(Box::new(depth)) as *mut c_void, + RenderParam::ICCProfile(bytes) => { + Box::into_raw(bytes.into_boxed_slice()) as *mut c_void + } + RenderParam::AmbientLight(lux) => Box::into_raw(Box::new(lux)) as *mut c_void, + RenderParam::X11Display(ptr) => ptr as *mut _, + RenderParam::WaylandDisplay(ptr) => ptr as *mut _, + RenderParam::AdvancedControl(adv_ctrl) => { + Box::into_raw(Box::new(adv_ctrl as c_int)) as *mut c_void + } + RenderParam::NextFrameInfo(frame_info) => { + Box::into_raw(Box::new(frame_info)) as *mut c_void + } + RenderParam::BlockForTargetTime(block) => { + Box::into_raw(Box::new(block as c_int)) as *mut c_void + } + RenderParam::SkipRendering(skip_rendering) => { + Box::into_raw(Box::new(skip_rendering as c_int)) as *mut c_void + } + }; + Self { type_, data } + } +} + +unsafe fn free_void_data(ptr: *mut c_void) { + drop(Box::::from_raw(ptr as *mut T)); +} + +unsafe fn free_init_params(ptr: *mut c_void) { + let params = Box::from_raw(ptr as *mut libmpv2_sys::mpv_opengl_init_params); + drop(Box::from_raw( + params.get_proc_address_ctx as *mut OpenGLInitParams, + )); +} + +impl RenderContext { + pub fn new( + mpv: &mut libmpv2_sys::mpv_handle, + params: impl IntoIterator>, + ) -> Result { + let params: Vec<_> = params.into_iter().collect(); + let mut raw_params: Vec = Vec::new(); + raw_params.reserve(params.len() + 1); + let mut raw_ptrs: HashMap<*const c_void, DeleterFn> = HashMap::new(); + + for p in params { + // The render params are type-erased after they are passed to mpv. This is where we last + // know their real types, so we keep a deleter here. + let deleter: Option = match p { + RenderParam::InitParams(_) => Some(free_init_params::), + RenderParam::FBO(_) => Some(free_void_data::), + RenderParam::FlipY(_) => Some(free_void_data::), + RenderParam::Depth(_) => Some(free_void_data::), + RenderParam::ICCProfile(_) => Some(free_void_data::>), + RenderParam::AmbientLight(_) => Some(free_void_data::), + RenderParam::NextFrameInfo(_) => Some(free_void_data::), + _ => None, + }; + let raw_param: libmpv2_sys::mpv_render_param = p.into(); + if let Some(deleter) = deleter { + raw_ptrs.insert(raw_param.data, deleter); + } + + raw_params.push(raw_param); + } + // the raw array must end with type = 0 + raw_params.push(libmpv2_sys::mpv_render_param { + type_: 0, + data: ptr::null_mut(), + }); + + unsafe { + let raw_array = + Box::into_raw(raw_params.into_boxed_slice()) as *mut libmpv2_sys::mpv_render_param; + let ctx = Box::into_raw(Box::new(std::ptr::null_mut() as _)); + let err = libmpv2_sys::mpv_render_context_create(ctx, &mut *mpv, raw_array); + drop(Box::from_raw(raw_array)); + for (ptr, deleter) in raw_ptrs.iter() { + (deleter)(*ptr as _); + } + + mpv_err( + Self { + ctx: *Box::from_raw(ctx), + update_callback_cleanup: None, + }, + err, + ) + } + } + + pub fn set_parameter(&self, param: RenderParam) -> Result<()> { + unsafe { + mpv_err( + (), + libmpv2_sys::mpv_render_context_set_parameter( + self.ctx, + libmpv2_sys::mpv_render_param::from(param), + ), + ) + } + } + + pub fn get_info(&self, param: RenderParam) -> Result> { + let is_next_frame_info = matches!(param, RenderParam::NextFrameInfo(_)); + let raw_param = libmpv2_sys::mpv_render_param::from(param); + let res = unsafe { libmpv2_sys::mpv_render_context_get_info(self.ctx, raw_param) }; + if res == 0 { + if !is_next_frame_info { + panic!("I don't know how to handle this info type."); + } + let raw_frame_info = raw_param.data as *mut libmpv2_sys::mpv_render_frame_info; + unsafe { + let raw_frame_info = *raw_frame_info; + return Ok(RenderParam::NextFrameInfo(RenderFrameInfo { + flags: raw_frame_info.flags.into(), + target_time: raw_frame_info.target_time, + })); + } + } + Err(Error::Raw(res)) + } + + /// Render video. + /// + /// Typically renders the video to a target surface provided via `fbo` + /// (the details depend on the backend in use). Options like "panscan" are + /// applied to determine which part of the video should be visible and how the + /// video should be scaled. You can change these options at runtime by using the + /// mpv property API. + /// + /// The renderer will reconfigure itself every time the target surface + /// configuration (such as size) is changed. + /// + /// This function implicitly pulls a video frame from the internal queue and + /// renders it. If no new frame is available, the previous frame is redrawn. + /// The update callback set with [set_update_callback](Self::set_update_callback) + /// notifies you when a new frame was added. The details potentially depend on + /// the backends and the provided parameters. + /// + /// Generally, libmpv will invoke your update callback some time before the video + /// frame should be shown, and then lets this function block until the supposed + /// display time. This will limit your rendering to video FPS. You can prevent + /// this by setting the "video-timing-offset" global option to 0. (This applies + /// only to "audio" video sync mode.) + /// + /// # Arguments + /// + /// * `fbo` - A framebuffer object to render to. In OpenGL, 0 is the current backbuffer + /// * `width` - The width of the framebuffer in pixels. This is used for scaling the + /// video properly. + /// * `height` - The height of the framebuffer in pixels. This is used for scaling the + /// video properly. + /// * `flip` - Whether to draw the image upside down. This is needed for OpenGL because + /// it uses a coordinate system with positive Y up, but videos use positive + /// Y down. + pub fn render(&self, fbo: i32, width: i32, height: i32, flip: bool) -> Result<()> { + let mut raw_params: Vec = Vec::with_capacity(3); + let mut raw_ptrs: HashMap<*const c_void, DeleterFn> = HashMap::new(); + + let raw_param: libmpv2_sys::mpv_render_param = + RenderParam::::FBO(FBO { fbo, width, height }).into(); + raw_ptrs.insert(raw_param.data, free_void_data::); + raw_params.push(raw_param); + let raw_param: libmpv2_sys::mpv_render_param = RenderParam::::FlipY(flip).into(); + raw_ptrs.insert(raw_param.data, free_void_data::); + raw_params.push(raw_param); + // the raw array must end with type = 0 + raw_params.push(libmpv2_sys::mpv_render_param { + type_: 0, + data: ptr::null_mut(), + }); + + let raw_array = + Box::into_raw(raw_params.into_boxed_slice()) as *mut libmpv2_sys::mpv_render_param; + + let ret = unsafe { + mpv_err( + (), + libmpv2_sys::mpv_render_context_render(self.ctx, raw_array), + ) + }; + unsafe { + drop(Box::from_raw(raw_array)); + } + + unsafe { + for (ptr, deleter) in raw_ptrs.iter() { + (deleter)(*ptr as _); + } + } + + ret + } + + /// Set the callback that notifies you when a new video frame is available, or if the video display + /// configuration somehow changed and requires a redraw. Similar to [EventContext::set_wakeup_callback](crate::events::EventContext::set_wakeup_callback), you + /// must not call any mpv API from the callback, and all the other listed restrictions apply (such + /// as not exiting the callback by throwing exceptions). + /// + /// This can be called from any thread, except from an update callback. In case of the OpenGL backend, + /// no OpenGL state or API is accessed. + /// + /// Calling this will raise an update callback immediately. + pub fn set_update_callback(&mut self, callback: F) { + if let Some(update_callback_cleanup) = self.update_callback_cleanup.take() { + update_callback_cleanup(); + } + let raw_callback = Box::into_raw(Box::new(callback)); + self.update_callback_cleanup = Some(Box::new(move || unsafe { + drop(Box::from_raw(raw_callback)); + }) as Box); + unsafe { + libmpv2_sys::mpv_render_context_set_update_callback( + self.ctx, + Some(ru_wrapper::), + raw_callback as *mut c_void, + ); + } + } +} + +impl Drop for RenderContext { + fn drop(&mut self) { + if let Some(update_callback_cleanup) = self.update_callback_cleanup.take() { + update_callback_cleanup(); + } + unsafe { + libmpv2_sys::mpv_render_context_free(self.ctx); + } + } +} diff --git a/crates/libmpv2/src/tests.rs b/crates/libmpv2/src/tests.rs new file mode 100644 index 0000000..1e7635d --- /dev/null +++ b/crates/libmpv2/src/tests.rs @@ -0,0 +1,222 @@ +// yt - A fully featured command line YouTube client +// +// Copyright (C) 2024 Benedikt Peetz +// SPDX-License-Identifier: GPL-3.0-or-later +// +// This file is part of Yt. +// +// You should have received a copy of the License along with this program. +// If not, see . + +use crate::events::{Event, EventContext, PropertyData}; +use crate::mpv_node::MpvNode; +use crate::*; + +use std::collections::HashMap; +use std::thread; +use std::time::Duration; + +#[test] +fn initializer() { + let mpv = Mpv::with_initializer(|init| { + init.set_property("osc", true)?; + init.set_property("input-default-bindings", true)?; + init.set_property("volume", 30)?; + + Ok(()) + }) + .unwrap(); + + assert_eq!(true, mpv.get_property("osc").unwrap()); + assert_eq!(true, mpv.get_property("input-default-bindings").unwrap()); + assert_eq!(30i64, mpv.get_property("volume").unwrap()); +} + +#[test] +fn properties() { + let mpv = Mpv::new().unwrap(); + mpv.set_property("volume", 0).unwrap(); + mpv.set_property("vo", "null").unwrap(); + mpv.set_property("ytdl-format", "best[width<240]").unwrap(); + mpv.set_property("sub-gauss", 0.6).unwrap(); + + assert_eq!(0i64, mpv.get_property("volume").unwrap()); + let vo: MpvStr = mpv.get_property("vo").unwrap(); + assert_eq!("null", &*vo); + assert_eq!(true, mpv.get_property("ytdl").unwrap()); + let subg: f64 = mpv.get_property("sub-gauss").unwrap(); + assert_eq!( + 0.6, + f64::round(subg * f64::powi(10.0, 4)) / f64::powi(10.0, 4) + ); + mpv.command( + "loadfile", + &["test-data/speech_12kbps_mb.wav", "append-play"], + ) + .unwrap(); + thread::sleep(Duration::from_millis(250)); + + let title: MpvStr = mpv.get_property("media-title").unwrap(); + assert_eq!(&*title, "speech_12kbps_mb.wav"); +} + +macro_rules! assert_event_occurs { + ($ctx:ident, $timeout:literal, $( $expected:pat),+) => { + loop { + match $ctx.wait_event($timeout) { + $( Some($expected) )|+ => { + break; + }, + None => { + continue + }, + other => panic!("Event did not occur, got: {:?}", other), + } + } + } +} + +#[test] +fn events() { + let mpv = Mpv::new().unwrap(); + let mut ev_ctx = EventContext::new(mpv.ctx); + ev_ctx.disable_deprecated_events().unwrap(); + + ev_ctx.observe_property("volume", Format::Int64, 0).unwrap(); + ev_ctx + .observe_property("media-title", Format::String, 1) + .unwrap(); + + mpv.set_property("vo", "null").unwrap(); + + // speed up playback so test finishes faster + mpv.set_property("speed", 100).unwrap(); + + assert_event_occurs!( + ev_ctx, + 3., + Ok(Event::PropertyChange { + name: "volume", + change: PropertyData::Int64(100), + reply_userdata: 0, + }) + ); + + mpv.set_property("volume", 0).unwrap(); + assert_event_occurs!( + ev_ctx, + 10., + Ok(Event::PropertyChange { + name: "volume", + change: PropertyData::Int64(0), + reply_userdata: 0, + }) + ); + assert!(ev_ctx.wait_event(3.).is_none()); + mpv.command("loadfile", &["test-data/jellyfish.mp4", "append-play"]) + .unwrap(); + assert_event_occurs!(ev_ctx, 10., Ok(Event::StartFile)); + assert_event_occurs!( + ev_ctx, + 10., + Ok(Event::PropertyChange { + name: "media-title", + change: PropertyData::Str("jellyfish.mp4"), + reply_userdata: 1, + }) + ); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::FileLoaded)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::VideoReconfig)); + + mpv.command("loadfile", &["test-data/speech_12kbps_mb.wav", "replace"]) + .unwrap(); + assert_event_occurs!(ev_ctx, 3., Ok(Event::VideoReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::VideoReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::EndFile(mpv_end_file_reason::Stop))); + assert_event_occurs!(ev_ctx, 3., Ok(Event::StartFile)); + assert_event_occurs!( + ev_ctx, + 3., + Ok(Event::PropertyChange { + name: "media-title", + change: PropertyData::Str("speech_12kbps_mb.wav"), + reply_userdata: 1, + }) + ); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::VideoReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::FileLoaded)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::PlaybackRestart)); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert_event_occurs!(ev_ctx, 10., Ok(Event::EndFile(mpv_end_file_reason::Eof))); + assert_event_occurs!(ev_ctx, 3., Ok(Event::AudioReconfig)); + assert!(ev_ctx.wait_event(3.).is_none()); +} + +#[test] +fn node_map() -> Result<()> { + let mpv = Mpv::new()?; + + mpv.command( + "loadfile", + &["test-data/speech_12kbps_mb.wav", "append-play"], + ) + .unwrap(); + + thread::sleep(Duration::from_millis(250)); + let audio_params = mpv.get_property::("audio-params")?; + let params = audio_params.map().unwrap().collect::>(); + + assert_eq!(params.len(), 5); + + let format = params.get("format").unwrap(); + assert_eq!(format, &MpvNode::String("s16".to_string())); + + let samplerate = params.get("samplerate").unwrap(); + assert_eq!(samplerate, &MpvNode::Int64(48_000)); + + let channels = params.get("channels").unwrap(); + assert_eq!(channels, &MpvNode::String("mono".to_string())); + + let hr_channels = params.get("hr-channels").unwrap(); + assert_eq!(hr_channels, &MpvNode::String("mono".to_string())); + + let channel_count = params.get("channel-count").unwrap(); + assert_eq!(channel_count, &MpvNode::Int64(1)); + + Ok(()) +} + +#[test] +fn node_array() -> Result<()> { + let mpv = Mpv::new()?; + + mpv.command( + "loadfile", + &["test-data/speech_12kbps_mb.wav", "append-play"], + ) + .unwrap(); + + thread::sleep(Duration::from_millis(250)); + let playlist = mpv.get_property::("playlist")?; + let items = playlist.array().unwrap().collect::>(); + + assert_eq!(items.len(), 1); + let track = items[0].clone().map().unwrap().collect::>(); + + let filename = track.get("filename").unwrap(); + + assert_eq!( + filename, + &MpvNode::String("test-data/speech_12kbps_mb.wav".to_string()) + ); + + Ok(()) +} diff --git a/crates/libmpv2/update.sh b/crates/libmpv2/update.sh new file mode 100755 index 0000000..1ff19c6 --- /dev/null +++ b/crates/libmpv2/update.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env sh + +# yt - A fully featured command line YouTube client +# +# Copyright (C) 2024 Benedikt Peetz +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This file is part of Yt. +# +# You should have received a copy of the License along with this program. +# If not, see . + +[ "$1" = "upgrade" ] && cargo upgrade +cargo update + +./libmpv2-sys/update.sh "$@" -- cgit 1.4.1