libmpv/
lib.rs

1// Copyright (C) 2016  ParadoxSpiral
2//
3// This file is part of mpv-rs.
4//
5// This library is free software; you can redistribute it and/or
6// modify it under the terms of the GNU Lesser General Public
7// License as published by the Free Software Foundation; either
8// version 2.1 of the License, or (at your option) any later version.
9//
10// This library is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13// Lesser General Public License for more details.
14//
15// You should have received a copy of the GNU Lesser General Public
16// License along with this library; if not, write to the Free Software
17// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18
19//! This crate provides abstractions for
20//! [libmpv](https://github.com/mpv-player/mpv/tree/master/libmpv) of the
21//! [mpv media player](https://github.com/mpv-player/mpv).
22//!
23//! Libmpv requires `LC_NUMERIC` to be `C`, which should be the default value.
24//!
25//! Most of the documentation is paraphrased or even copied from the
26//! [mpv manual](https://mpv.io/manual/master/),
27//! if any questions arise it will probably answer them in much more depth than this documentation.
28//!
29//! # Examples
30//!
31//! See the 'examples' directory in the crate root.
32
33// Procedure for updating to new libmpv:
34// - make any nessecary API change (if so, bump crate version)
35// - update MPV_CLIENT_API consts in lib.rs
36// - run tests and examples to test whether they still work
37
38use std::os::raw as ctype;
39
40pub const MPV_CLIENT_API_MAJOR: ctype::c_ulong = 2;
41pub const MPV_CLIENT_API_MINOR: ctype::c_ulong = 0;
42pub const MPV_CLIENT_API_VERSION: ctype::c_ulong =
43    MPV_CLIENT_API_MAJOR << 16 | MPV_CLIENT_API_MINOR;
44
45mod mpv;
46#[cfg(test)]
47mod tests;
48
49pub use crate::mpv::*;
50
51/// A format mpv can use.
52pub use libmpv_sys::mpv_format as MpvFormat;
53pub mod mpv_format {
54    pub use libmpv_sys::mpv_format_MPV_FORMAT_DOUBLE as Double;
55    pub use libmpv_sys::mpv_format_MPV_FORMAT_FLAG as Flag;
56    pub use libmpv_sys::mpv_format_MPV_FORMAT_INT64 as Int64;
57    pub use libmpv_sys::mpv_format_MPV_FORMAT_NODE as Node;
58    pub use libmpv_sys::mpv_format_MPV_FORMAT_NODE_ARRAY as Array;
59    pub use libmpv_sys::mpv_format_MPV_FORMAT_NODE_MAP as Map;
60    pub use libmpv_sys::mpv_format_MPV_FORMAT_NONE as None;
61    pub use libmpv_sys::mpv_format_MPV_FORMAT_OSD_STRING as OsdString;
62    pub use libmpv_sys::mpv_format_MPV_FORMAT_STRING as String;
63}
64
65/// An libmpv_sys mpv error.
66pub use libmpv_sys::mpv_error as MpvError;
67pub mod mpv_error {
68    pub use libmpv_sys::mpv_error_MPV_ERROR_AO_INIT_FAILED as AoInitFailed;
69    pub use libmpv_sys::mpv_error_MPV_ERROR_COMMAND as Command;
70    pub use libmpv_sys::mpv_error_MPV_ERROR_EVENT_QUEUE_FULL as EventQueueFull;
71    pub use libmpv_sys::mpv_error_MPV_ERROR_GENERIC as Generic;
72    pub use libmpv_sys::mpv_error_MPV_ERROR_INVALID_PARAMETER as InvalidParameter;
73    pub use libmpv_sys::mpv_error_MPV_ERROR_LOADING_FAILED as LoadingFailed;
74    pub use libmpv_sys::mpv_error_MPV_ERROR_NOMEM as NoMem;
75    pub use libmpv_sys::mpv_error_MPV_ERROR_NOTHING_TO_PLAY as NothingToPlay;
76    pub use libmpv_sys::mpv_error_MPV_ERROR_NOT_IMPLEMENTED as NotImplemented;
77    pub use libmpv_sys::mpv_error_MPV_ERROR_OPTION_ERROR as OptionError;
78    pub use libmpv_sys::mpv_error_MPV_ERROR_OPTION_FORMAT as OptionFormat;
79    pub use libmpv_sys::mpv_error_MPV_ERROR_OPTION_NOT_FOUND as OptionNotFound;
80    pub use libmpv_sys::mpv_error_MPV_ERROR_PROPERTY_ERROR as PropertyError;
81    pub use libmpv_sys::mpv_error_MPV_ERROR_PROPERTY_FORMAT as PropertyFormat;
82    pub use libmpv_sys::mpv_error_MPV_ERROR_PROPERTY_NOT_FOUND as PropertyNotFound;
83    pub use libmpv_sys::mpv_error_MPV_ERROR_PROPERTY_UNAVAILABLE as PropertyUnavailable;
84    pub use libmpv_sys::mpv_error_MPV_ERROR_SUCCESS as Success;
85    pub use libmpv_sys::mpv_error_MPV_ERROR_UNINITIALIZED as Uninitialized;
86    pub use libmpv_sys::mpv_error_MPV_ERROR_UNKNOWN_FORMAT as UnknownFormat;
87    pub use libmpv_sys::mpv_error_MPV_ERROR_UNSUPPORTED as Unsupported;
88    pub use libmpv_sys::mpv_error_MPV_ERROR_VO_INIT_FAILED as VoInitFailed;
89}
90
91/// Log verbosity level.
92pub use libmpv_sys::mpv_log_level as LogLevel;
93pub mod mpv_log_level {
94    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_DEBUG as Debug;
95    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_ERROR as Error;
96    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_FATAL as Fatal;
97    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_INFO as Info;
98    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_NONE as None;
99    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_TRACE as Trace;
100    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_V as V;
101    pub use libmpv_sys::mpv_log_level_MPV_LOG_LEVEL_WARN as Warn;
102}
103
104/// The reason a file stopped.
105pub use libmpv_sys::mpv_end_file_reason as EndFileReason;
106pub mod mpv_end_file_reason {
107    pub use libmpv_sys::mpv_end_file_reason_MPV_END_FILE_REASON_EOF as Eof;
108    pub use libmpv_sys::mpv_end_file_reason_MPV_END_FILE_REASON_ERROR as Error;
109    pub use libmpv_sys::mpv_end_file_reason_MPV_END_FILE_REASON_QUIT as Quit;
110    pub use libmpv_sys::mpv_end_file_reason_MPV_END_FILE_REASON_REDIRECT as Redirect;
111    pub use libmpv_sys::mpv_end_file_reason_MPV_END_FILE_REASON_STOP as Stop;
112}
libmpv/lib.rs

libmpv/
lib.rs
