glycin-core 4.0.0-alpha

Sandboxed image decoding
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! Glycin allows to decode images into [`gdk::Texture`]s and to extract image
//! metadata. The decoding happens in sandboxed modular image loaders that have
//! to be provided as binaries. The [`glycin-utils`](glycin_utils) for more
//! details.
//!
//! # Example
//!
//! You need to enable the `gdk4` feature for this example to work.
//!
//! ```no_run
//! # use glycin_core::*;
//! # async {
//! let file = gio::File::for_path("image.jpg");
//! let image = Loader::new(file).load().await?;
//!
//! let height = image.details().height();
//! let texture = image.next_frame().await?.texture();
//! # Ok::<(), ErrorCtx>(()) };
//! ```
//!
//! You can pass the [`texture`](Frame#structfield.texture) of a [`Frame`] to
//! [`gtk4::Image::from_paintable()`] to display the image.
//!
//! # External Dependencies
//!
//! Glycin requires the libraries *libglib2.0*, *liblcms2*, *libfontconfig*, and
//! *libseccomp* packages to be installed. For the `gdk4` feature, *libgtk-4* is
//! required as well. To actually work with images, loaders for the respective
//! formats have to be installed. Glycin provides [loaders] for many formats
//! that are packaged with many distributions. When working in the default
//! sandbox mode, the `bwrap` binary of *bubblewrap* is required as well. The
//! required dependencies can usually be installed through commands like
//!
//! ```sh
//! $ apt install libgtk-4-dev liblcms2-dev libfontconfig-dev libseccomp-dev glycin-loaders bubblewrap
//! ```
//!
//! on Debian/Ubuntu or
//!
//! ```sh
//! $ dnf install gtk4-devel lcms2-devel fontconfig-devel libseccomp-devel glycin-loaders bubblewrap
//! ```
//!
//! on Fedora.
//!
//! # Features
//!
//! - `gdk4` --- Enables interoperability with [`gdk4`](gdk) by enabling to get
//!   a [`gdk::Texture`] directly.
//! - `tokio` --- Makes glycin compatible with [`zbus`] using [`tokio`].
//!
//! [`gtk4::Image::from_paintable()`]: https://gtk-rs.org/gtk4-rs/git/docs/gtk4/struct.Image.html#method.from_paintable
//! [loaders]: https://gitlab.gnome.org/GNOME/glycin#supported-image-formats

#![cfg_attr(
    feature = "builtin",
    allow(dead_code, unused_variables, unused_imports)
)]

#[cfg(all(not(feature = "async-io"), not(feature = "tokio")))]
mod error_message {
    compile_error!(
        "Feature 'async-io' (default) or 'tokio' must be enabled to provide an async runtime."
    );
}

#[cfg(all(feature = "async-io", feature = "tokio"))]
mod error_message {
    compile_error!(
        "Features 'async-io' (default) or and 'tokio' cannot be enabled at the same time."
    );
}

#[cfg(all(not(feature = "external"), not(feature = "builtin")))]
mod error_message {
    compile_error!(
        "Feature 'external' or 'builtin' must be enabled to provide a way to load images."
    );
}

#[cfg(all(
    feature = "builtin",
    not(any(feature = "builtin-image-rs", feature = "builtin-test"))
))]
compile_error!(
    "At least one builtin loader feature like 'builtin-image-rs' has to be enabled if 'builtin' is enabled."
);

mod api;
pub mod config;
#[cfg(feature = "external")]
mod dbus;
#[cfg(not(feature = "external"))]
mod dbus_shim;
mod error;
#[cfg(feature = "external")]
mod fontconfig;
mod icc;
mod main_context;
mod orientation;
#[cfg(feature = "external")]
mod pool;
#[cfg(not(feature = "external"))]
mod pool_shim;
#[cfg(feature = "external")]
mod sandbox;
mod source;
mod util;

#[cfg(feature = "gobject")]
pub mod gobject;

/// Max texture size 8 GB in bytes
pub(crate) const MAX_TEXTURE_SIZE: u64 = 8 * 10u64.pow(9);

pub const COMPAT_VERSION: u8 = 2;

pub use api::*;
#[cfg(not(feature = "external"))]
use dbus_shim as dbus;
pub use error::{Error, ErrorContext, ErrorKind};
pub use glycin_common::{MemoryFormat, MemoryFormatSelection, Operation, OperationId, Operations};
pub use gufo_common::cicp::Cicp;
pub use main_context::MainContextSelector;
pub use pool::{Pool, PoolConfig};
#[cfg(not(feature = "external"))]
use pool_shim as pool;
#[cfg(feature = "gdk4")]
pub use util::gdk_memory_format;