diff options
Diffstat (limited to '')
| -rw-r--r-- | Cargo.toml | 8 | ||||
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | cog.toml | 8 | ||||
| -rw-r--r-- | libmpv2/CHANGELOG.md | 16 | ||||
| -rw-r--r-- | libmpv2/Cargo.toml | 4 | ||||
| -rw-r--r-- | libmpv2/README.md | 24 | ||||
| -rw-r--r-- | libmpv2/libmpv2-sys/Cargo.toml | 2 | ||||
| -rw-r--r-- | libmpv2/libmpv2-sys/include/client.h | 2408 | ||||
| -rw-r--r-- | libmpv2/libmpv2-sys/include/render.h | 844 | ||||
| -rw-r--r-- | libmpv2/libmpv2-sys/include/render_gl.h | 246 | ||||
| -rw-r--r-- | libmpv2/libmpv2-sys/include/stream_cb.h | 392 | ||||
| -rw-r--r-- | src/cli.rs | 2 | ||||
| -rw-r--r-- | src/download/mod.rs | 5 | ||||
| -rw-r--r-- | treefmt.nix | 1 | ||||
| -rw-r--r-- | yt_dlp/README.md | 8 |
15 files changed, 2046 insertions, 1935 deletions
diff --git a/Cargo.toml b/Cargo.toml index 1c3877e..55b4de0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -29,7 +29,13 @@ serde_json = "1.0.125" sqlx = { version = "0.7.4", features = ["runtime-tokio", "sqlite"] } stderrlog = "0.6.0" tempfile = "3.12.0" -tokio = { version = "1.39.3", features = ["rt-multi-thread", "macros", "process", "time", "io-std"] } +tokio = { version = "1.39.3", features = [ + "rt-multi-thread", + "macros", + "process", + "time", + "io-std", +] } url = { version = "2.5.2", features = ["serde"] } xdg = "2.5.2" yt_dlp = { path = "./yt_dlp/" } diff --git a/README.md b/README.md index 4ec4615..e968887 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. > A fully featured command line YouTube client ## Licensing -This project complies with the REUSE v3.2 specification. This means that every file -clearly states its copyright. -Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you -contributed to `FILES..` to record your contribution (obviously replacing -the `NAME`, `EMAIL` and `FILES..` placeholders with your name, email, and -the paths to the changed files respectively (see the `--help` output for more)). + +This project complies with the REUSE v3.2 specification. This means that every +file clearly states its copyright. Please run +`./scripts/cprh.sh contributer NAME EMAIL FILES..` after you contributed to +`FILES..` to record your contribution (obviously replacing the `NAME`, `EMAIL` +and `FILES..` placeholders with your name, email, and the paths to the changed +files respectively (see the `--help` output for more)). diff --git a/cog.toml b/cog.toml index 6f1b205..d3b7b4b 100644 --- a/cog.toml +++ b/cog.toml @@ -13,10 +13,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "reuse lint", # Check licensing status - "nix flake check", # verify the project builds - "cargo set-version {{version}}", # bump version in Cargo.toml - "nix fmt", # format + "reuse lint", # Check licensing status + "nix flake check", # verify the project builds + "cargo set-version {{version}}", # bump version in Cargo.toml + "nix fmt", # format ] post_bump_hooks = [ "git push", diff --git a/libmpv2/CHANGELOG.md b/libmpv2/CHANGELOG.md index 558dcf1..dc6f861 100644 --- a/libmpv2/CHANGELOG.md +++ b/libmpv2/CHANGELOG.md @@ -16,23 +16,29 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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. +- \[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)) +- 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` +- \[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` +- 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 diff --git a/libmpv2/Cargo.toml b/libmpv2/Cargo.toml index b72f692..72e9fac 100644 --- a/libmpv2/Cargo.toml +++ b/libmpv2/Cargo.toml @@ -32,5 +32,5 @@ sdl2 = "0.36.0" [features] default = ["protocols", "render"] -protocols = [] # Enable custom protocol callbacks -render = [] # Enable custom rendering +protocols = [] # Enable custom protocol callbacks +render = [] # Enable custom rendering diff --git a/libmpv2/README.md b/libmpv2/README.md index 7f77b16..6929354 100644 --- a/libmpv2/README.md +++ b/libmpv2/README.md @@ -10,24 +10,36 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -Credits go to @anlumo for the rendering implementation and @sirno for updating the API to support libmpv version 2.0. +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. +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. +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. +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: +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 +- `protocol`: implementation of custom `filereader://` protocol that… reads + files - `opengl`: openGL rendering onto SDL2 window # Contributing diff --git a/libmpv2/libmpv2-sys/Cargo.toml b/libmpv2/libmpv2-sys/Cargo.toml index fc6d503..5fba086 100644 --- a/libmpv2/libmpv2-sys/Cargo.toml +++ b/libmpv2/libmpv2-sys/Cargo.toml @@ -18,4 +18,4 @@ description = "Libmpv bindings generated by bindgen" keywords = ["media", "playback", "mpv", "libmpv"] [build-dependencies] -bindgen = {version = "0.69.4"} +bindgen = { version = "0.69.4" } diff --git a/libmpv2/libmpv2-sys/include/client.h b/libmpv2/libmpv2-sys/include/client.h index 2055f4e..874c770 100644 --- a/libmpv2/libmpv2-sys/include/client.h +++ b/libmpv2/libmpv2-sys/include/client.h @@ -25,10 +25,10 @@ #include <stdint.h> #ifdef _WIN32 -#define MPV_EXPORT __declspec(dllexport) -#define MPV_SELECTANY __declspec(selectany) +#define MPV_EXPORT __declspec (dllexport) +#define MPV_SELECTANY __declspec (selectany) #elif defined(__GNUC__) || defined(__clang__) -#define MPV_EXPORT __attribute__((visibility("default"))) +#define MPV_EXPORT __attribute__ ((visibility ("default"))) #define MPV_SELECTANY #else #define MPV_EXPORT @@ -42,7 +42,8 @@ #endif #ifdef __cplusplus -extern "C" { +extern "C" +{ #endif /** @@ -83,10 +84,10 @@ extern "C" { * 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 + * 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. * @@ -246,7 +247,7 @@ extern "C" { * relational operators (<, >, <=, >=). */ #define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) -#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(2, 3) +#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION (2, 3) /** * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before @@ -258,29 +259,30 @@ extern "C" { #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); + /** + * 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; + /** + * 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 { + /** + * 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, + 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 @@ -289,16 +291,16 @@ typedef enum mpv_error { * 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, + MPV_ERROR_EVENT_QUEUE_FULL = -1, /** * Memory allocation failed. */ - MPV_ERROR_NOMEM = -2, + MPV_ERROR_NOMEM = -2, /** * The mpv core wasn't configured and initialized yet. See the notes in * mpv_create(). */ - MPV_ERROR_UNINITIALIZED = -3, + 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. @@ -307,16 +309,16 @@ typedef enum mpv_error { /** * Trying to set an option that doesn't exist. */ - MPV_ERROR_OPTION_NOT_FOUND = -5, + MPV_ERROR_OPTION_NOT_FOUND = -5, /** * Trying to set an option using an unsupported MPV_FORMAT. */ - MPV_ERROR_OPTION_FORMAT = -6, + 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, + MPV_ERROR_OPTION_ERROR = -7, /** * The accessed property doesn't exist. */ @@ -324,7 +326,7 @@ typedef enum mpv_error { /** * Trying to set or get a property using an unsupported MPV_FORMAT. */ - MPV_ERROR_PROPERTY_FORMAT = -9, + 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 @@ -334,304 +336,313 @@ typedef enum mpv_error { /** * Error setting or getting a property. */ - MPV_ERROR_PROPERTY_ERROR = -11, + MPV_ERROR_PROPERTY_ERROR = -11, /** * General error when running a command with mpv_command and similar. */ - MPV_ERROR_COMMAND = -12, + MPV_ERROR_COMMAND = -12, /** * Generic error on loading (usually used with mpv_event_end_file.error). */ - MPV_ERROR_LOADING_FAILED = -13, + MPV_ERROR_LOADING_FAILED = -13, /** * Initializing the audio output failed. */ - MPV_ERROR_AO_INIT_FAILED = -14, + MPV_ERROR_AO_INIT_FAILED = -14, /** * Initializing the video output failed. */ - MPV_ERROR_VO_INIT_FAILED = -15, + 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, + 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, + MPV_ERROR_UNKNOWN_FORMAT = -17, /** * Generic error for signaling that certain system requirements are not * fulfilled. */ - MPV_ERROR_UNSUPPORTED = -18, + MPV_ERROR_UNSUPPORTED = -18, /** * The API function which was called is a stub only. */ - MPV_ERROR_NOT_IMPLEMENTED = -19, + 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 "@<id>" in - * addition of the proper mpv_client_name(), where "<id>" 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 { + 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 "@<id>" in + * addition of the proper mpv_client_name(), where "<id>" 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). + * this it to MPV_FORMAT_NONE (which makes some things saner as + * consequence). */ - MPV_FORMAT_NONE = 0, + MPV_FORMAT_NONE = 0, /** * The basic type is char*. It returns the raw property string, like * using ${=property} in input.conf (see input.rst). @@ -650,10 +661,8 @@ typedef enum mpv_format { * 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); + * 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(). * @@ -667,7 +676,7 @@ typedef enum mpv_format { * Or just use mpv_set_property_string(). * */ - MPV_FORMAT_STRING = 1, + 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 @@ -675,9 +684,10 @@ typedef enum mpv_format { * 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. + * Only valid when doing read access. The rest works like + * MPV_FORMAT_STRING. */ - MPV_FORMAT_OSD_STRING = 2, + MPV_FORMAT_OSD_STRING = 2, /** * The basic type is int. The only allowed values are 0 ("no") * and 1 ("yes"). @@ -694,15 +704,15 @@ typedef enum mpv_format { * int flag = 1; * mpv_set_property(ctx, "property", MPV_FORMAT_FLAG, &flag); */ - MPV_FORMAT_FLAG = 3, + MPV_FORMAT_FLAG = 3, /** * The basic type is int64_t. */ - MPV_FORMAT_INT64 = 4, + MPV_FORMAT_INT64 = 4, /** * The basic type is double. */ - MPV_FORMAT_DOUBLE = 5, + MPV_FORMAT_DOUBLE = 5, /** * The type is mpv_node. * @@ -735,45 +745,48 @@ typedef enum mpv_format { * value.u.string = "hello"; * mpv_set_property(ctx, "property", MPV_FORMAT_NODE, &value); */ - MPV_FORMAT_NODE = 6, + MPV_FORMAT_NODE = 6, /** * Used with mpv_node only. Can usually not be used directly. */ - MPV_FORMAT_NODE_ARRAY = 7, + MPV_FORMAT_NODE_ARRAY = 7, /** * See MPV_FORMAT_NODE_ARRAY. */ - MPV_FORMAT_NODE_MAP = 8, + 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; + 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 @@ -793,12 +806,13 @@ typedef struct mpv_node { * assumptions about the contents of union u. */ mpv_format format; -} mpv_node; + } mpv_node; -/** - * (see mpv_node) - */ -typedef struct mpv_node_list { + /** + * (see mpv_node) + */ + typedef struct mpv_node_list + { /** * Number of entries. Negative values are not allowed. */ @@ -821,16 +835,17 @@ typedef struct mpv_node_list { * 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. + * 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; + } mpv_node_list; -/** - * (see mpv_node) - */ -typedef struct mpv_byte_array { + /** + * (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. @@ -840,419 +855,438 @@ typedef struct mpv_byte_array { * 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 { + } 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, + 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, + MPV_EVENT_SHUTDOWN = 1, /** * See mpv_request_log_messages(). */ - MPV_EVENT_LOG_MESSAGE = 2, + MPV_EVENT_LOG_MESSAGE = 2, /** * Reply to a mpv_get_property_async() request. * See also mpv_event and mpv_event_property. @@ -1267,22 +1301,22 @@ typedef enum mpv_event_id { * 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, + 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. + * 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, + 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, + MPV_EVENT_END_FILE = 7, /** * Notification when the file has been loaded (headers were read etc.), and * decoding starts. */ - MPV_EVENT_FILE_LOADED = 8, + MPV_EVENT_FILE_LOADED = 8, #if MPV_ENABLE_DEPRECATED /** * Idle mode was entered. In this mode, no file is played, and the playback @@ -1296,7 +1330,7 @@ typedef enum mpv_event_id { * is not necessarily sent at the right point anymore (at the * start of the program), while the property behaves correctly. */ - MPV_EVENT_IDLE = 11, + 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 @@ -1306,7 +1340,7 @@ typedef enum mpv_event_id { * @deprecated Use mpv_observe_property() with relevant properties instead * (such as "playback-time"). */ - MPV_EVENT_TICK = 14, + MPV_EVENT_TICK = 14, #endif /** * Triggered by the script-message input command. The command uses the @@ -1315,7 +1349,7 @@ typedef enum mpv_event_id { * second argument as strings. * See also mpv_event and mpv_event_client_message. */ - MPV_EVENT_CLIENT_MESSAGE = 16, + 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 @@ -1326,29 +1360,29 @@ typedef enum mpv_event_id { * yourself whether the video parameters really changed before doing * something expensive. */ - MPV_EVENT_VIDEO_RECONFIG = 17, + 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, + 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, + 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, + 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, + 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 @@ -1358,34 +1392,36 @@ typedef enum mpv_event_id { * Event delivery will continue normally once this event was returned * (this forces the client to empty the queue completely). */ - MPV_EVENT_QUEUE_OVERFLOW = 24, + 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, + 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 { + } 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. */ @@ -1409,27 +1445,29 @@ typedef struct mpv_event_property { * 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 { + } 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 @@ -1453,10 +1491,11 @@ typedef struct mpv_event_log_message { * Since API version 1.6. */ mpv_log_level log_level; -} mpv_event_log_message; + } mpv_event_log_message; -/// Since API version 1.9. -typedef enum mpv_end_file_reason { + /// 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 @@ -1489,17 +1528,19 @@ typedef enum mpv_end_file_reason { * Since API version 1.18. */ MPV_END_FILE_REASON_REDIRECT = 5, -} mpv_end_file_reason; + } mpv_end_file_reason; -/// Since API version 1.108. -typedef struct mpv_event_start_file { + /// 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; + } mpv_event_start_file; -typedef struct mpv_event_end_file { + typedef struct mpv_event_end_file + { /** * Corresponds to the values in enum mpv_end_file_reason. * @@ -1521,18 +1562,19 @@ typedef struct mpv_event_end_file { */ 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. + * 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; /** @@ -1541,20 +1583,22 @@ typedef struct mpv_event_end_file { * Since API version 1.108. */ int playlist_insert_num_entries; -} mpv_event_end_file; + } mpv_event_end_file; -typedef struct mpv_event_client_message { + 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 + * 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; + } mpv_event_client_message; -typedef struct mpv_event_hook { + typedef struct mpv_event_hook + { /** * The hook name as passed to mpv_hook_add(). */ @@ -1563,10 +1607,11 @@ typedef struct mpv_event_hook { * Internal ID that must be passed to mpv_hook_continue(). */ uint64_t id; -} mpv_event_hook; + } mpv_event_hook; -// Since API version 1.102. -typedef struct mpv_event_command { + // 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 @@ -1574,9 +1619,10 @@ typedef struct mpv_event_command { * to MPV_FORMAT_NONE on failure. */ mpv_node result; -} mpv_event_command; + } mpv_event_command; -typedef struct mpv_event { + 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. @@ -1617,408 +1663,414 @@ typedef struct mpv_event { * MPV_EVENT_COMMAND_REPLY* mpv_event_command* * other: NULL * - * Note: future enhancements might add new event structs for existing or new - * event types. + * 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); + } 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); + /** + * 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. + * 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; +#define MPV_DEFINE_SYM_PTR(name) \ + MPV_SELECTANY MPV_EXPORT MPV_DECLTYPE (name) * pfn_##name; -MPV_DEFINE_SYM_PTR(mpv_client_api_version) + 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) + MPV_DEFINE_SYM_PTR (mpv_error_string) #define mpv_error_string pfn_mpv_error_string -MPV_DEFINE_SYM_PTR(mpv_free) + MPV_DEFINE_SYM_PTR (mpv_free) #define mpv_free pfn_mpv_free -MPV_DEFINE_SYM_PTR(mpv_client_name) + MPV_DEFINE_SYM_PTR (mpv_client_name) #define mpv_client_name pfn_mpv_client_name -MPV_DEFINE_SYM_PTR(mpv_client_id) + MPV_DEFINE_SYM_PTR (mpv_client_id) #define mpv_client_id pfn_mpv_client_id -MPV_DEFINE_SYM_PTR(mpv_create) + MPV_DEFINE_SYM_PTR (mpv_create) #define mpv_create pfn_mpv_create -MPV_DEFINE_SYM_PTR(mpv_initialize) + MPV_DEFINE_SYM_PTR (mpv_initialize) #define mpv_initialize pfn_mpv_initialize -MPV_DEFINE_SYM_PTR(mpv_destroy) + MPV_DEFINE_SYM_PTR (mpv_destroy) #define mpv_destroy pfn_mpv_destroy -MPV_DEFINE_SYM_PTR(mpv_terminate_destroy) + MPV_DEFINE_SYM_PTR (mpv_terminate_destroy) #define mpv_terminate_destroy pfn_mpv_terminate_destroy -MPV_DEFINE_SYM_PTR(mpv_create_client) + MPV_DEFINE_SYM_PTR (mpv_create_client) #define mpv_create_client pfn_mpv_create_client -MPV_DEFINE_SYM_PTR(mpv_create_weak_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) + 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) + 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) + 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) + 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) + MPV_DEFINE_SYM_PTR (mpv_set_option) #define mpv_set_option pfn_mpv_set_option -MPV_DEFINE_SYM_PTR(mpv_set_option_string) + MPV_DEFINE_SYM_PTR (mpv_set_option_string) #define mpv_set_option_string pfn_mpv_set_option_string -MPV_DEFINE_SYM_PTR(mpv_command) + MPV_DEFINE_SYM_PTR (mpv_command) #define mpv_command pfn_mpv_command -MPV_DEFINE_SYM_PTR(mpv_command_node) + MPV_DEFINE_SYM_PTR (mpv_command_node) #define mpv_command_node pfn_mpv_command_node -MPV_DEFINE_SYM_PTR(mpv_command_ret) + MPV_DEFINE_SYM_PTR (mpv_command_ret) #define mpv_command_ret pfn_mpv_command_ret -MPV_DEFINE_SYM_PTR(mpv_command_string) + MPV_DEFINE_SYM_PTR (mpv_command_string) #define mpv_command_string pfn_mpv_command_string -MPV_DEFINE_SYM_PTR(mpv_command_async) + MPV_DEFINE_SYM_PTR (mpv_command_async) #define mpv_command_async pfn_mpv_command_async -MPV_DEFINE_SYM_PTR(mpv_command_node_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) + 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) + MPV_DEFINE_SYM_PTR (mpv_set_property) #define mpv_set_property pfn_mpv_set_property -MPV_DEFINE_SYM_PTR(mpv_set_property_string) + 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) + MPV_DEFINE_SYM_PTR (mpv_del_property) #define mpv_del_property pfn_mpv_del_property -MPV_DEFINE_SYM_PTR(mpv_set_property_async) + 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) + MPV_DEFINE_SYM_PTR (mpv_get_property) #define mpv_get_property pfn_mpv_get_property -MPV_DEFINE_SYM_PTR(mpv_get_property_string) + 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) + 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) + 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) + MPV_DEFINE_SYM_PTR (mpv_observe_property) #define mpv_observe_property pfn_mpv_observe_property -MPV_DEFINE_SYM_PTR(mpv_unobserve_property) + MPV_DEFINE_SYM_PTR (mpv_unobserve_property) #define mpv_unobserve_property pfn_mpv_unobserve_property -MPV_DEFINE_SYM_PTR(mpv_event_name) + MPV_DEFINE_SYM_PTR (mpv_event_name) #define mpv_event_name pfn_mpv_event_name -MPV_DEFINE_SYM_PTR(mpv_event_to_node) + 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) + MPV_DEFINE_SYM_PTR (mpv_request_event) #define mpv_request_event pfn_mpv_request_event -MPV_DEFINE_SYM_PTR(mpv_request_log_messages) + 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) + MPV_DEFINE_SYM_PTR (mpv_wait_event) #define mpv_wait_event pfn_mpv_wait_event -MPV_DEFINE_SYM_PTR(mpv_wakeup) + MPV_DEFINE_SYM_PTR (mpv_wakeup) #define mpv_wakeup pfn_mpv_wakeup -MPV_DEFINE_SYM_PTR(mpv_set_wakeup_callback) + 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) + 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) + MPV_DEFINE_SYM_PTR (mpv_hook_add) #define mpv_hook_add pfn_mpv_hook_add -MPV_DEFINE_SYM_PTR(mpv_hook_continue) + MPV_DEFINE_SYM_PTR (mpv_hook_continue) #define mpv_hook_continue pfn_mpv_hook_continue -MPV_DEFINE_SYM_PTR(mpv_get_wakeup_pipe) + MPV_DEFINE_SYM_PTR (mpv_get_wakeup_pipe) #define mpv_get_wakeup_pipe pfn_mpv_get_wakeup_pipe #endif diff --git a/libmpv2/libmpv2-sys/include/render.h b/libmpv2/libmpv2-sys/include/render.h index 563e05f..872da7a 100644 --- a/libmpv2/libmpv2-sys/include/render.h +++ b/libmpv2/libmpv2-sys/include/render.h @@ -17,156 +17,159 @@ #include "client.h" #ifdef __cplusplus -extern "C" { +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) - */ + /** + * 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; + /** + * 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 { + /** + * 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). @@ -230,9 +233,8 @@ typedef enum mpv_render_param_type { 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_context_create(). The Display must stay valid for the + * lifetime of the mpv_render_context. Type: Display* */ MPV_RENDER_PARAM_X11_DISPLAY = 8, /** @@ -243,8 +245,8 @@ typedef enum mpv_render_param_type { */ MPV_RENDER_PARAM_WL_DISPLAY = 9, /** - * Better control about rendering and enabling some advanced features. Valid - * for mpv_render_context_create(). + * 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: @@ -252,13 +254,13 @@ typedef enum mpv_render_param_type { * - 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 + * - 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 + * - 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). * @@ -308,8 +310,8 @@ typedef enum mpv_render_param_type { * 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. + * Disabling this without doing anything in addition will result in A/V + * sync being slightly off. */ MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME = 12, /** @@ -343,7 +345,7 @@ typedef enum mpv_render_param_type { * 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. @@ -363,8 +365,8 @@ typedef enum mpv_render_param_type { * * 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 + * 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) @@ -392,34 +394,33 @@ typedef enum mpv_render_param_type { * * 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). + * 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* + * 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. + * 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; + } mpv_render_param_type; /** * For backwards compatibility with the old naming of @@ -427,36 +428,37 @@ typedef enum mpv_render_param_type { */ #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 { + /** + * 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; - + } mpv_render_param; /** * Predefined values for MPV_RENDER_PARAM_API_TYPE. @@ -466,10 +468,12 @@ typedef struct mpv_render_param { // 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 { + /** + * 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 @@ -485,18 +489,18 @@ typedef enum mpv_render_frame_info_flag { * 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, + 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. + * 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, + 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). @@ -504,7 +508,7 @@ typedef enum mpv_render_frame_info_flag { * * Implies MPV_RENDER_FRAME_INFO_PRESENT. */ - MPV_RENDER_FRAME_INFO_REPEAT = 1 << 2, + 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 @@ -512,14 +516,15 @@ typedef enum mpv_render_frame_info_flag { * * Implies MPV_RENDER_FRAME_INFO_PRESENT. */ - MPV_RENDER_FRAME_INFO_BLOCK_VSYNC = 1 << 3, -} mpv_render_frame_info_flag; + 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 { + /** + * 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). @@ -531,221 +536,228 @@ typedef struct mpv_render_frame_info { * 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 + * 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; + } 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); + /** + * 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); + /** + * 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); + /** + * 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); + 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); + /** + * 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); + /** + * 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 { + /** + * 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; + 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); + /** + * 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); + /** + * 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); + /** + * 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) + 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) + 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) + 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) + 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) + 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) + 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) + MPV_DEFINE_SYM_PTR (mpv_render_context_free) #define mpv_render_context_free pfn_mpv_render_context_free #endif diff --git a/libmpv2/libmpv2-sys/include/render_gl.h b/libmpv2/libmpv2-sys/include/render_gl.h index 3d5e18c..75d7051 100644 --- a/libmpv2/libmpv2-sys/include/render_gl.h +++ b/libmpv2/libmpv2-sys/include/render_gl.h @@ -17,113 +17,121 @@ #include "render.h" #ifdef __cplusplus -extern "C" { +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 { + /** + * 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. + * 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); + 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; + } mpv_opengl_init_params; -/** - * For MPV_RENDER_PARAM_OPENGL_FBO. - */ -typedef struct mpv_opengl_fbo { + /** + * 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 @@ -140,33 +148,36 @@ typedef struct mpv_opengl_fbo { * this is the default framebuffer, this can be an equivalent. */ int internal_format; -} mpv_opengl_fbo; + } mpv_opengl_fbo; -/** - * Deprecated. For MPV_RENDER_PARAM_DRM_DISPLAY. - */ -typedef struct mpv_opengl_drm_params { + /** + * 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; + } mpv_opengl_drm_params; -/** - * For MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE. - */ -typedef struct mpv_opengl_drm_draw_surface_size { + /** + * 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; + } mpv_opengl_drm_draw_surface_size; -/** - * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. - */ -typedef struct mpv_opengl_drm_params_v2 { + /** + * For MPV_RENDER_PARAM_DRM_DISPLAY_V2. + */ + typedef struct mpv_opengl_drm_params_v2 + { /** * DRM fd (int). Set to -1 if invalid. */ @@ -183,9 +194,10 @@ typedef struct mpv_opengl_drm_params_v2 { 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. + * 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; @@ -194,11 +206,11 @@ typedef struct mpv_opengl_drm_params_v2 { * Set to -1 if invalid. */ int render_fd; -} mpv_opengl_drm_params_v2; - + } mpv_opengl_drm_params_v2; /** - * For backwards compatibility with the old naming of mpv_opengl_drm_draw_surface_size + * 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 diff --git a/libmpv2/libmpv2-sys/include/stream_cb.h b/libmpv2/libmpv2-sys/include/stream_cb.h index 4257b40..86e8496 100644 --- a/libmpv2/libmpv2-sys/include/stream_cb.h +++ b/libmpv2/libmpv2-sys/include/stream_cb.h @@ -17,154 +17,159 @@ #include "client.h" #ifdef __cplusplus -extern "C" { +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 { + /** + * 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 @@ -185,55 +190,58 @@ typedef struct mpv_stream_cb_info { 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); + } 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) + MPV_DEFINE_SYM_PTR (mpv_stream_cb_add_ro) #define mpv_stream_cb_add_ro pfn_mpv_stream_cb_add_ro #endif diff --git a/src/cli.rs b/src/cli.rs index 4835fc4..8f9d605 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -131,7 +131,7 @@ pub enum SubscriptionCommand { /// Remove any previous subscriptions #[arg(short, long)] - force: bool + force: bool, }, /// List all subscriptions diff --git a/src/download/mod.rs b/src/download/mod.rs index 62fae84..4431d3e 100644 --- a/src/download/mod.rs +++ b/src/download/mod.rs @@ -14,7 +14,10 @@ use crate::{ app::App, download::download_options::download_opts, storage::video_database::{ - downloader::{get_next_uncached_video, set_video_cache_path}, extractor_hash::ExtractorHash, getters::get_video_yt_dlp_opts, Video + downloader::{get_next_uncached_video, set_video_cache_path}, + extractor_hash::ExtractorHash, + getters::get_video_yt_dlp_opts, + Video, }, }; diff --git a/treefmt.nix b/treefmt.nix index 15baf5d..6dac5a6 100644 --- a/treefmt.nix +++ b/treefmt.nix @@ -7,7 +7,6 @@ # # You should have received a copy of the License along with this program. # If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. - { treefmt-nix, pkgs, diff --git a/yt_dlp/README.md b/yt_dlp/README.md index 7e25590..591ef2e 100644 --- a/yt_dlp/README.md +++ b/yt_dlp/README.md @@ -18,7 +18,7 @@ Some text about the project. ## Licence -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. |