gstreamer/
lib.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3#![cfg_attr(docsrs, feature(doc_cfg))]
4#![allow(clippy::missing_safety_doc)]
5#![allow(clippy::manual_range_contains)]
6#![allow(clippy::manual_c_str_literals)]
7#![doc = include_str!("../README.md")]
8
9// Re-exported for the subclass gst_plugin_define! macro
10pub use glib;
11pub use gstreamer_sys as ffi;
12#[deprecated = "Use `gst::pastey` instead"]
13pub use pastey as paste;
14pub use pastey;
15
16#[doc(hidden)]
17pub static INITIALIZED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
18
19#[cold]
20#[inline(never)]
21#[track_caller]
22pub fn assert_initialized() {
23    #[allow(unused_unsafe)]
24    if unsafe { ffi::gst_is_initialized() } != glib::ffi::GTRUE {
25        panic!("GStreamer has not been initialized. Call `gst::init` first.");
26    } else {
27        crate::INITIALIZED.store(true, std::sync::atomic::Ordering::SeqCst);
28    }
29}
30
31macro_rules! assert_initialized_main_thread {
32    () => {
33        if !crate::INITIALIZED.load(std::sync::atomic::Ordering::SeqCst) {
34            $crate::assert_initialized();
35        }
36    };
37}
38
39macro_rules! skip_assert_initialized {
40    () => {};
41}
42
43#[allow(clippy::needless_borrow)]
44#[allow(clippy::let_unit_value)]
45#[allow(unused_imports)]
46mod auto;
47pub use crate::auto::*;
48
49#[macro_use]
50#[cfg(feature = "serde")]
51mod serde_macros;
52
53#[macro_use]
54pub mod log;
55#[cfg(feature = "v1_28")]
56#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
57pub mod log_context;
58#[cfg(feature = "log")]
59pub use crate::log::DebugCategoryLogger;
60pub use crate::log::{
61    CAT_BUFFER, CAT_BUFFER_LIST, CAT_BUS, CAT_CALL_TRACE, CAT_CAPS, CAT_CLOCK, CAT_CONTEXT,
62    CAT_DEFAULT, CAT_ELEMENT_PADS, CAT_ERROR_SYSTEM, CAT_EVENT, CAT_GST_INIT, CAT_LOCKING,
63    CAT_MEMORY, CAT_MESSAGE, CAT_META, CAT_NEGOTIATION, CAT_PADS, CAT_PARAMS, CAT_PARENTAGE,
64    CAT_PERFORMANCE, CAT_PIPELINE, CAT_PLUGIN_INFO, CAT_PLUGIN_LOADING, CAT_PROBE, CAT_PROPERTIES,
65    CAT_QOS, CAT_REFCOUNTING, CAT_REGISTRY, CAT_RUST, CAT_SCHEDULING, CAT_SIGNAL, CAT_STATES,
66    DebugCategory, DebugLogFunction, DebugLogger, DebugMessage, LoggedObject,
67};
68
69#[cfg(feature = "v1_28")]
70#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
71pub use crate::log_context::{LogContext, LogContextBuilder};
72
73#[cfg(target_os = "macos")]
74mod macos;
75#[cfg(all(target_os = "macos", feature = "v1_22"))]
76pub use crate::macos::*;
77
78#[macro_use]
79mod error;
80pub use crate::error::*;
81
82#[macro_use]
83pub mod miniobject;
84pub use miniobject::{MiniObject, MiniObjectRef};
85
86#[macro_use]
87mod value;
88pub use crate::value::{
89    Array, ArrayRef, Bitmask, Fraction, FractionRange, IntRange, List, ListRef,
90};
91#[cfg(feature = "v1_28")]
92#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
93pub use crate::value::{UniqueList, UniqueListRef};
94#[cfg(feature = "serde")]
95#[macro_use]
96mod value_serde;
97
98#[macro_use]
99mod id_str;
100pub use crate::id_str::IdStr;
101
102#[cfg(feature = "serde")]
103mod flag_serde;
104
105pub mod message;
106pub use crate::message::{Message, MessageErrorDomain, MessageRef, MessageView, MessageViewMut};
107
108pub mod structure;
109pub use crate::structure::{Structure, StructureRef};
110#[cfg(feature = "serde")]
111mod structure_serde;
112
113pub mod caps;
114pub use crate::caps::{Caps, CapsFilterMapAction, CapsRef};
115mod caps_features;
116#[cfg(feature = "serde")]
117mod caps_serde;
118pub use crate::caps_features::{
119    CAPS_FEATURE_MEMORY_SYSTEM_MEMORY, CAPS_FEATURES_MEMORY_SYSTEM_MEMORY, CapsFeatures,
120    CapsFeaturesRef,
121};
122#[cfg(feature = "serde")]
123mod caps_features_serde;
124
125pub mod tags;
126pub use crate::tags::{
127    Tag, TagList, TagListRef, tag_exists, tag_get_description, tag_get_flag, tag_get_nick,
128    tag_get_type,
129};
130#[cfg(feature = "serde")]
131mod tags_serde;
132
133#[macro_use]
134pub mod meta;
135#[cfg(feature = "v1_16")]
136#[cfg_attr(docsrs, doc(cfg(feature = "v1_16")))]
137pub use crate::meta::MetaSeqnum;
138pub use crate::meta::{
139    Meta, MetaAPI, MetaAPIExt, MetaRef, MetaRefMut, ParentBufferMeta, ProtectionMeta,
140    ReferenceTimestampMeta,
141};
142pub mod buffer;
143pub use crate::buffer::{
144    BUFFER_COPY_ALL, BUFFER_COPY_METADATA, Buffer, BufferMap, BufferRef, MappedBuffer,
145};
146mod buffer_cursor;
147pub use crate::buffer_cursor::{BufferCursor, BufferRefCursor};
148pub mod memory;
149mod memory_wrapped;
150#[cfg(feature = "v1_26")]
151#[cfg_attr(docsrs, doc(cfg(feature = "v1_26")))]
152pub use crate::memory::MemoryRefTrace;
153pub use crate::memory::{MappedMemory, Memory, MemoryMap, MemoryRef};
154pub use crate::memory_wrapped::{MemoryIntoInnerError, rust_allocator};
155#[cfg(feature = "serde")]
156mod buffer_serde;
157pub mod slice;
158
159pub mod sample;
160pub use crate::sample::{Sample, SampleRef};
161#[cfg(feature = "serde")]
162mod sample_serde;
163
164pub mod bufferlist;
165pub use crate::bufferlist::{BufferList, BufferListRef};
166#[cfg(feature = "serde")]
167mod bufferlist_serde;
168
169pub mod query;
170pub use crate::query::{Query, QueryRef, QueryView, QueryViewMut};
171pub mod event;
172pub use crate::event::{Event, EventRef, EventView, EventViewMut, GroupId, Seqnum};
173pub mod context;
174#[cfg(feature = "v1_28")]
175#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
176pub use crate::context::TASK_POOL_CONTEXT_TYPE;
177pub use crate::context::{Context, ContextRef};
178mod rank;
179pub use crate::rank::Rank;
180mod static_caps;
181pub use crate::static_caps::*;
182mod static_pad_template;
183pub use crate::static_pad_template::*;
184
185pub mod promise;
186pub use promise::{Promise, PromiseError};
187
188pub mod bus;
189mod element;
190pub mod element_factory;
191
192mod dynamic_type_factory;
193
194mod bin;
195pub use bin::BinBuilder;
196
197mod pipeline;
198pub use pipeline::PipelineBuilder;
199
200mod allocation_params;
201pub use self::allocation_params::AllocationParams;
202mod allocator;
203
204mod element_factory_type;
205pub use element_factory_type::*;
206
207mod tracer;
208mod tracer_factory;
209
210// OS dependent Bus extensions (also import the other platform mod for doc)
211#[cfg(any(unix, docsrs))]
212mod bus_unix;
213#[cfg(any(windows, docsrs))]
214mod bus_windows;
215
216mod child_proxy;
217mod date_time;
218#[cfg(feature = "serde")]
219mod date_time_serde;
220mod device_monitor;
221mod device_provider;
222mod device_provider_factory;
223mod enums;
224mod ghost_pad;
225pub mod gobject;
226mod iterator;
227mod object;
228mod pad;
229pub use pad::{
230    EventForeachAction, PadBuilder, PadGetRangeSuccess, PadProbeData, PadProbeId, PadProbeInfo,
231    StreamLock,
232};
233mod control_binding;
234mod control_source;
235mod parse_context;
236mod preset;
237mod proxy_pad;
238mod registry;
239mod system_clock;
240mod tag_setter;
241pub mod task;
242pub use task::{TaskLock, TaskLockGuard};
243mod task_pool;
244pub use self::iterator::{Iterator, IteratorError, IteratorImpl, StdIterator};
245pub use crate::{
246    device_monitor::DeviceMonitorFilterId,
247    element::{
248        ELEMENT_METADATA_AUTHOR, ELEMENT_METADATA_DESCRIPTION, ELEMENT_METADATA_DOC_URI,
249        ELEMENT_METADATA_ICON_NAME, ELEMENT_METADATA_KLASS, ELEMENT_METADATA_LONGNAME,
250        ElementMessageType, NotifyWatchId,
251    },
252    enums::{
253        ClockError, ClockSuccess, FlowError, FlowReturn, FlowSuccess, MessageType, PadLinkError,
254        PadLinkReturn, PadLinkSuccess, StateChangeError, StateChangeSuccess, TagError,
255    },
256    parse_context::ParseContext,
257    task_pool::{TaskHandle, TaskPoolTaskHandle},
258};
259mod plugin_feature;
260
261mod plugin;
262pub mod stream;
263pub mod stream_collection;
264
265mod typefind;
266pub use crate::typefind::*;
267mod typefind_factory;
268
269pub mod format;
270pub use crate::format::{
271    ClockTime, GenericFormattedValue, GenericSignedFormattedValue, Signed, clock_time,
272};
273
274mod segment;
275pub use crate::segment::*;
276#[cfg(feature = "serde")]
277mod segment_serde;
278
279mod timed_value;
280pub use crate::timed_value::TimedValue;
281
282pub mod toc;
283pub use crate::toc::{Toc, TocEntry, TocEntryRef, TocRef};
284#[cfg(feature = "serde")]
285mod toc_serde;
286
287mod clock;
288pub use crate::clock::{AtomicClockReturn, ClockId, PeriodicClockId, SingleShotClockId};
289
290mod time_offsets;
291pub use time_offsets::*;
292
293mod buffer_pool;
294pub use crate::buffer_pool::{BufferPoolAcquireParams, BufferPoolConfig, BufferPoolConfigRef};
295
296mod pad_template;
297pub use pad_template::PadTemplateBuilder;
298
299pub mod param_spec;
300pub use crate::param_spec::{ParamSpecArray, ParamSpecFraction};
301
302mod functions;
303pub use crate::functions::*;
304
305mod utils;
306pub use crate::utils::ObjectLockGuard;
307
308pub mod parse;
309
310#[cfg(feature = "v1_28")]
311#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
312pub mod cpuid;
313
314#[cfg(feature = "v1_18")]
315mod gtype;
316
317use std::ptr;
318
319#[doc(alias = "gst_init_check")]
320pub fn init() -> Result<(), glib::Error> {
321    unsafe {
322        use glib::translate::*;
323
324        let mut error = ptr::null_mut();
325        if from_glib(ffi::gst_init_check(
326            ptr::null_mut(),
327            ptr::null_mut(),
328            &mut error,
329        )) {
330            crate::INITIALIZED.store(true, std::sync::atomic::Ordering::SeqCst);
331            Ok(())
332        } else {
333            Err(from_glib_full(error))
334        }
335    }
336}
337
338// rustdoc-stripper-ignore-next
339/// Deinitialize GStreamer
340///
341/// # Safety
342///
343/// This must only be called once during the lifetime of the process, once no GStreamer threads
344/// are running anymore and all GStreamer resources are released.
345pub unsafe fn deinit() {
346    unsafe {
347        crate::INITIALIZED.store(false, std::sync::atomic::Ordering::SeqCst);
348        ffi::gst_deinit();
349    }
350}
351
352pub const PARAM_FLAG_CONTROLLABLE: glib::ParamFlags = glib::ParamFlags::USER_1;
353pub const PARAM_FLAG_MUTABLE_READY: glib::ParamFlags = glib::ParamFlags::USER_2;
354pub const PARAM_FLAG_MUTABLE_PAUSED: glib::ParamFlags = glib::ParamFlags::USER_3;
355pub const PARAM_FLAG_MUTABLE_PLAYING: glib::ParamFlags = glib::ParamFlags::USER_4;
356#[cfg(feature = "v1_18")]
357pub const PARAM_FLAG_DOC_SHOW_DEFAULT: glib::ParamFlags = glib::ParamFlags::USER_5;
358#[cfg(feature = "v1_18")]
359pub const PARAM_FLAG_CONDITIONALLY_AVAILABLE: glib::ParamFlags = glib::ParamFlags::USER_6;
360
361// Re-export all the traits in a prelude module, so that applications
362// can always "use gst::prelude::*" without getting conflicts
363pub mod prelude {
364    #[doc(hidden)]
365    pub use glib::prelude::*;
366    pub use muldiv::MulDiv;
367    pub use opt_ops::prelude::*;
368
369    // OS dependent Bus extensions (also import the other platform trait for doc)
370    #[cfg(any(unix, docsrs))]
371    pub use crate::bus_unix::UnixBusExtManual;
372    #[cfg(any(windows, docsrs))]
373    pub use crate::bus_windows::WindowsBusExtManual;
374    #[cfg(feature = "v1_18")]
375    pub use crate::gtype::PluginApiExt;
376    pub use crate::{
377        auto::traits::*,
378        bin::GstBinExtManual,
379        buffer_pool::BufferPoolExtManual,
380        child_proxy::ChildProxyExtManual,
381        clock::ClockExtManual,
382        control_binding::ControlBindingExtManual,
383        control_source::ControlSourceExtManual,
384        device_monitor::DeviceMonitorExtManual,
385        device_provider::{DeviceProviderClassExt, DeviceProviderExtManual},
386        element::{ElementClassExt, ElementExtManual},
387        format::prelude::*,
388        gobject::GObjectExtManualGst,
389        log::DebugLogger,
390        memory::MemoryType,
391        message::MessageErrorDomain,
392        meta::{MetaAPI, MetaAPIExt, MetaTag},
393        miniobject::IsMiniObject,
394        object::GstObjectExtManual,
395        pad::PadExtManual,
396        param_spec::GstParamSpecBuilderExt,
397        pipeline::GstPipelineExtManual,
398        plugin_feature::PluginFeatureExtManual,
399        preset::PresetExtManual,
400        slice::ByteSliceExt,
401        tag_setter::TagSetterExtManual,
402        tags::{CustomTag, Tag},
403        task_pool::{TaskHandle, TaskPoolExtManual},
404        typefind::TypeFindImpl,
405        utils::Displayable,
406        value::GstValueExt,
407    };
408}
409
410#[macro_use]
411pub mod subclass;
gstreamer/lib.rs

gstreamer/
lib.rs
