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;
186#[cfg(feature = "futures")]
187pub(crate) mod promise_futures;
188pub use promise::{Promise, PromiseError};
189
190pub mod bus;
191#[cfg(feature = "futures")]
192pub(crate) mod bus_futures;
193mod element;
194pub mod element_factory;
195
196mod dynamic_type_factory;
197
198mod bin;
199pub use bin::BinBuilder;
200
201mod pipeline;
202pub use pipeline::PipelineBuilder;
203
204mod allocation_params;
205pub use self::allocation_params::AllocationParams;
206mod allocator;
207
208mod element_factory_type;
209pub use element_factory_type::*;
210
211mod tracer;
212mod tracer_factory;
213
214// OS dependent Bus extensions (also import the other platform mod for doc)
215#[cfg(any(unix, docsrs))]
216mod bus_unix;
217#[cfg(any(windows, docsrs))]
218mod bus_windows;
219
220mod child_proxy;
221mod date_time;
222#[cfg(feature = "serde")]
223mod date_time_serde;
224mod device_monitor;
225mod device_provider;
226mod device_provider_factory;
227mod enums;
228mod ghost_pad;
229pub mod gobject;
230mod iterator;
231mod object;
232mod pad;
233pub use pad::{
234    EventForeachAction, PadBuilder, PadGetRangeSuccess, PadProbeData, PadProbeId, PadProbeInfo,
235    StreamLock,
236};
237mod control_binding;
238mod control_source;
239mod parse_context;
240mod preset;
241mod proxy_pad;
242mod registry;
243mod system_clock;
244mod tag_setter;
245pub mod task;
246pub use task::{TaskLock, TaskLockGuard};
247mod task_pool;
248pub use self::iterator::{Iterator, IteratorError, IteratorImpl, StdIterator};
249pub use crate::{
250    device_monitor::DeviceMonitorFilterId,
251    element::{
252        ELEMENT_METADATA_AUTHOR, ELEMENT_METADATA_DESCRIPTION, ELEMENT_METADATA_DOC_URI,
253        ELEMENT_METADATA_ICON_NAME, ELEMENT_METADATA_KLASS, ELEMENT_METADATA_LONGNAME,
254        ElementMessageType, NotifyWatchId,
255    },
256    enums::{
257        ClockError, ClockSuccess, FlowError, FlowReturn, FlowSuccess, MessageType, PadLinkError,
258        PadLinkReturn, PadLinkSuccess, StateChangeError, StateChangeSuccess, TagError,
259    },
260    parse_context::ParseContext,
261    task_pool::{TaskHandle, TaskPoolTaskHandle},
262};
263mod plugin_feature;
264
265mod plugin;
266pub mod stream;
267pub mod stream_collection;
268
269mod typefind;
270pub use crate::typefind::*;
271mod typefind_factory;
272
273pub mod format;
274pub use crate::format::{
275    ClockTime, GenericFormattedValue, GenericSignedFormattedValue, Signed, clock_time,
276};
277
278mod segment;
279pub use crate::segment::*;
280#[cfg(feature = "serde")]
281mod segment_serde;
282
283mod timed_value;
284pub use crate::timed_value::TimedValue;
285
286pub mod toc;
287pub use crate::toc::{Toc, TocEntry, TocEntryRef, TocRef};
288#[cfg(feature = "serde")]
289mod toc_serde;
290
291mod clock;
292pub use crate::clock::{AtomicClockReturn, ClockId, PeriodicClockId, SingleShotClockId};
293
294mod time_offsets;
295pub use time_offsets::*;
296
297mod buffer_pool;
298pub use crate::buffer_pool::{BufferPoolAcquireParams, BufferPoolConfig, BufferPoolConfigRef};
299
300mod pad_template;
301pub use pad_template::PadTemplateBuilder;
302
303pub mod param_spec;
304pub use crate::param_spec::{ParamSpecArray, ParamSpecFraction};
305
306mod functions;
307pub use crate::functions::*;
308
309mod utils;
310pub use crate::utils::ObjectLockGuard;
311
312pub mod parse;
313
314#[cfg(feature = "v1_28")]
315#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
316pub mod cpuid;
317
318#[cfg(feature = "v1_18")]
319mod gtype;
320
321use std::ptr;
322
323#[doc(alias = "gst_init_check")]
324pub fn init() -> Result<(), glib::Error> {
325    unsafe {
326        use glib::translate::*;
327
328        let mut error = ptr::null_mut();
329        if from_glib(ffi::gst_init_check(
330            ptr::null_mut(),
331            ptr::null_mut(),
332            &mut error,
333        )) {
334            crate::INITIALIZED.store(true, std::sync::atomic::Ordering::SeqCst);
335            Ok(())
336        } else {
337            Err(from_glib_full(error))
338        }
339    }
340}
341
342// rustdoc-stripper-ignore-next
343/// Deinitialize GStreamer
344///
345/// # Safety
346///
347/// This must only be called once during the lifetime of the process, once no GStreamer threads
348/// are running anymore and all GStreamer resources are released.
349pub unsafe fn deinit() {
350    unsafe {
351        crate::INITIALIZED.store(false, std::sync::atomic::Ordering::SeqCst);
352        ffi::gst_deinit();
353    }
354}
355
356pub const PARAM_FLAG_CONTROLLABLE: glib::ParamFlags = glib::ParamFlags::USER_1;
357pub const PARAM_FLAG_MUTABLE_READY: glib::ParamFlags = glib::ParamFlags::USER_2;
358pub const PARAM_FLAG_MUTABLE_PAUSED: glib::ParamFlags = glib::ParamFlags::USER_3;
359pub const PARAM_FLAG_MUTABLE_PLAYING: glib::ParamFlags = glib::ParamFlags::USER_4;
360#[cfg(feature = "v1_18")]
361pub const PARAM_FLAG_DOC_SHOW_DEFAULT: glib::ParamFlags = glib::ParamFlags::USER_5;
362#[cfg(feature = "v1_18")]
363pub const PARAM_FLAG_CONDITIONALLY_AVAILABLE: glib::ParamFlags = glib::ParamFlags::USER_6;
364
365// Re-export all the traits in a prelude module, so that applications
366// can always "use gst::prelude::*" without getting conflicts
367pub mod prelude {
368    #[doc(hidden)]
369    pub use glib::prelude::*;
370    pub use muldiv::MulDiv;
371    pub use opt_ops::prelude::*;
372
373    // OS dependent Bus extensions (also import the other platform trait for doc)
374    #[cfg(any(unix, docsrs))]
375    pub use crate::bus_unix::UnixBusExtManual;
376    #[cfg(any(windows, docsrs))]
377    pub use crate::bus_windows::WindowsBusExtManual;
378    #[cfg(feature = "v1_18")]
379    pub use crate::gtype::PluginApiExt;
380    pub use crate::{
381        auto::traits::*,
382        bin::GstBinExtManual,
383        buffer_pool::BufferPoolExtManual,
384        child_proxy::ChildProxyExtManual,
385        clock::ClockExtManual,
386        control_binding::ControlBindingExtManual,
387        control_source::ControlSourceExtManual,
388        device_monitor::DeviceMonitorExtManual,
389        device_provider::{DeviceProviderClassExt, DeviceProviderExtManual},
390        element::{ElementClassExt, ElementExtManual},
391        format::prelude::*,
392        gobject::GObjectExtManualGst,
393        log::DebugLogger,
394        memory::MemoryType,
395        message::MessageErrorDomain,
396        meta::{MetaAPI, MetaAPIExt, MetaTag},
397        miniobject::IsMiniObject,
398        object::GstObjectExtManual,
399        pad::PadExtManual,
400        param_spec::GstParamSpecBuilderExt,
401        pipeline::GstPipelineExtManual,
402        plugin_feature::PluginFeatureExtManual,
403        preset::PresetExtManual,
404        slice::ByteSliceExt,
405        tag_setter::TagSetterExtManual,
406        tags::{CustomTag, Tag},
407        task_pool::{TaskHandle, TaskPoolExtManual},
408        typefind::TypeFindImpl,
409        utils::Displayable,
410        value::GstValueExt,
411    };
412}
413
414#[macro_use]
415pub mod subclass;
gstreamer/lib.rs

gstreamer/
lib.rs
