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