Skip to main content

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::{ClockTime, GenericFormattedValue, GenericSignedFormattedValue, Signed};
271
272mod segment;
273pub use crate::segment::*;
274#[cfg(feature = "serde")]
275mod segment_serde;
276
277mod timed_value;
278pub use crate::timed_value::TimedValue;
279
280pub mod toc;
281pub use crate::toc::{Toc, TocEntry, TocEntryRef, TocRef};
282#[cfg(feature = "serde")]
283mod toc_serde;
284
285mod clock;
286pub use crate::clock::{AtomicClockReturn, ClockId, PeriodicClockId, SingleShotClockId};
287
288mod buffer_pool;
289pub use crate::buffer_pool::{BufferPoolAcquireParams, BufferPoolConfig, BufferPoolConfigRef};
290
291mod pad_template;
292pub use pad_template::PadTemplateBuilder;
293
294pub mod param_spec;
295pub use crate::param_spec::{ParamSpecArray, ParamSpecFraction};
296
297mod functions;
298pub use crate::functions::*;
299
300mod utils;
301pub use crate::utils::ObjectLockGuard;
302
303pub mod parse;
304
305#[cfg(feature = "v1_28")]
306#[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
307pub mod cpuid;
308
309#[cfg(feature = "v1_18")]
310mod gtype;
311
312use std::ptr;
313
314#[doc(alias = "gst_init_check")]
315pub fn init() -> Result<(), glib::Error> {
316    unsafe {
317        use glib::translate::*;
318
319        let mut error = ptr::null_mut();
320        if from_glib(ffi::gst_init_check(
321            ptr::null_mut(),
322            ptr::null_mut(),
323            &mut error,
324        )) {
325            crate::INITIALIZED.store(true, std::sync::atomic::Ordering::SeqCst);
326            Ok(())
327        } else {
328            Err(from_glib_full(error))
329        }
330    }
331}
332
333// rustdoc-stripper-ignore-next
334/// Deinitialize GStreamer
335///
336/// # Safety
337///
338/// This must only be called once during the lifetime of the process, once no GStreamer threads
339/// are running anymore and all GStreamer resources are released.
340pub unsafe fn deinit() {
341    unsafe {
342        crate::INITIALIZED.store(false, std::sync::atomic::Ordering::SeqCst);
343        ffi::gst_deinit();
344    }
345}
346
347pub const PARAM_FLAG_CONTROLLABLE: glib::ParamFlags = glib::ParamFlags::USER_1;
348pub const PARAM_FLAG_MUTABLE_READY: glib::ParamFlags = glib::ParamFlags::USER_2;
349pub const PARAM_FLAG_MUTABLE_PAUSED: glib::ParamFlags = glib::ParamFlags::USER_3;
350pub const PARAM_FLAG_MUTABLE_PLAYING: glib::ParamFlags = glib::ParamFlags::USER_4;
351#[cfg(feature = "v1_18")]
352pub const PARAM_FLAG_DOC_SHOW_DEFAULT: glib::ParamFlags = glib::ParamFlags::USER_5;
353#[cfg(feature = "v1_18")]
354pub const PARAM_FLAG_CONDITIONALLY_AVAILABLE: glib::ParamFlags = glib::ParamFlags::USER_6;
355
356// Re-export all the traits in a prelude module, so that applications
357// can always "use gst::prelude::*" without getting conflicts
358pub mod prelude {
359    #[doc(hidden)]
360    pub use glib::prelude::*;
361    pub use muldiv::MulDiv;
362    pub use opt_ops::prelude::*;
363
364    // OS dependent Bus extensions (also import the other platform trait for doc)
365    #[cfg(any(unix, docsrs))]
366    pub use crate::bus_unix::UnixBusExtManual;
367    #[cfg(any(windows, docsrs))]
368    pub use crate::bus_windows::WindowsBusExtManual;
369    #[cfg(feature = "v1_18")]
370    pub use crate::gtype::PluginApiExt;
371    pub use crate::{
372        auto::traits::*,
373        bin::GstBinExtManual,
374        buffer_pool::BufferPoolExtManual,
375        child_proxy::ChildProxyExtManual,
376        clock::ClockExtManual,
377        control_binding::ControlBindingExtManual,
378        control_source::ControlSourceExtManual,
379        device_monitor::DeviceMonitorExtManual,
380        device_provider::{DeviceProviderClassExt, DeviceProviderExtManual},
381        element::{ElementClassExt, ElementExtManual},
382        format::prelude::*,
383        gobject::GObjectExtManualGst,
384        log::DebugLogger,
385        memory::MemoryType,
386        message::MessageErrorDomain,
387        meta::{MetaAPI, MetaAPIExt, MetaTag},
388        miniobject::IsMiniObject,
389        object::GstObjectExtManual,
390        pad::PadExtManual,
391        param_spec::GstParamSpecBuilderExt,
392        pipeline::GstPipelineExtManual,
393        plugin_feature::PluginFeatureExtManual,
394        preset::PresetExtManual,
395        slice::ByteSliceExt,
396        tag_setter::TagSetterExtManual,
397        tags::{CustomTag, Tag},
398        task_pool::{TaskHandle, TaskPoolExtManual},
399        typefind::TypeFindImpl,
400        utils::Displayable,
401        value::GstValueExt,
402    };
403}
404
405#[macro_use]
406pub mod subclass;