gstreamer/
lib.rs

Help
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(true, 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;
134#[cfg(feature = "v1_26")]
135#[cfg_attr(docsrs, doc(cfg(feature = "v1_26")))]
136pub use crate::memory::MemoryRefTrace;
137pub use crate::memory::{MappedMemory, Memory, MemoryMap, MemoryRef};
138#[cfg(feature = "serde")]
139mod buffer_serde;
140pub mod slice;
141
142pub mod sample;
143pub use crate::sample::{Sample, SampleRef};
144#[cfg(feature = "serde")]
145mod sample_serde;
146
147pub mod bufferlist;
148pub use crate::bufferlist::{BufferList, BufferListRef};
149#[cfg(feature = "serde")]
150mod bufferlist_serde;
151
152pub mod query;
153pub use crate::query::{Query, QueryRef, QueryView, QueryViewMut};
154pub mod event;
155pub use crate::event::{Event, EventRef, EventView, EventViewMut, GroupId, Seqnum};
156pub mod context;
157pub use crate::context::{Context, ContextRef};
158mod rank;
159pub use crate::rank::Rank;
160mod static_caps;
161pub use crate::static_caps::*;
162mod static_pad_template;
163pub use crate::static_pad_template::*;
164
165pub mod promise;
166pub use promise::{Promise, PromiseError};
167
168pub mod bus;
169mod element;
170pub mod element_factory;
171
172mod bin;
173pub use bin::BinBuilder;
174
175mod pipeline;
176pub use pipeline::PipelineBuilder;
177
178mod allocation_params;
179pub use self::allocation_params::AllocationParams;
180mod allocator;
181
182mod element_factory_type;
183pub use element_factory_type::*;
184
185mod tracer;
186mod tracer_factory;
187
188// OS dependent Bus extensions (also import the other platform mod for doc)
189#[cfg(any(unix, docsrs))]
190mod bus_unix;
191#[cfg(any(windows, docsrs))]
192mod bus_windows;
193
194mod child_proxy;
195mod date_time;
196#[cfg(feature = "serde")]
197mod date_time_serde;
198mod device_monitor;
199mod device_provider;
200mod device_provider_factory;
201mod enums;
202mod ghost_pad;
203mod gobject;
204mod iterator;
205mod object;
206mod pad;
207pub use pad::{
208    EventForeachAction, PadBuilder, PadGetRangeSuccess, PadProbeData, PadProbeId, PadProbeInfo,
209    StreamLock,
210};
211mod control_binding;
212mod control_source;
213mod parse_context;
214mod proxy_pad;
215mod registry;
216mod tag_setter;
217pub mod task;
218pub use task::{TaskLock, TaskLockGuard};
219mod task_pool;
220pub use self::iterator::{Iterator, IteratorError, IteratorImpl, StdIterator};
221pub use crate::{
222    device_monitor::DeviceMonitorFilterId,
223    element::{
224        ElementMessageType, NotifyWatchId, ELEMENT_METADATA_AUTHOR, ELEMENT_METADATA_DESCRIPTION,
225        ELEMENT_METADATA_DOC_URI, ELEMENT_METADATA_ICON_NAME, ELEMENT_METADATA_KLASS,
226        ELEMENT_METADATA_LONGNAME,
227    },
228    enums::{
229        ClockError, ClockSuccess, FlowError, FlowReturn, FlowSuccess, MessageType, PadLinkError,
230        PadLinkReturn, PadLinkSuccess, StateChangeError, StateChangeSuccess, TagError,
231    },
232    parse_context::ParseContext,
233    task_pool::{TaskHandle, TaskPoolTaskHandle},
234};
235mod plugin_feature;
236
237mod plugin;
238pub mod stream;
239pub mod stream_collection;
240
241mod typefind;
242pub use crate::typefind::*;
243mod typefind_factory;
244
245pub mod format;
246pub use crate::format::{ClockTime, GenericFormattedValue, GenericSignedFormattedValue, Signed};
247
248mod segment;
249pub use crate::segment::*;
250#[cfg(feature = "serde")]
251mod segment_serde;
252
253pub mod toc;
254pub use crate::toc::{Toc, TocEntry, TocEntryRef, TocRef};
255#[cfg(feature = "serde")]
256mod toc_serde;
257
258mod clock;
259pub use crate::clock::{AtomicClockReturn, ClockId, PeriodicClockId, SingleShotClockId};
260
261mod buffer_pool;
262pub use crate::buffer_pool::{BufferPoolAcquireParams, BufferPoolConfig, BufferPoolConfigRef};
263
264mod pad_template;
265pub use pad_template::PadTemplateBuilder;
266
267pub mod param_spec;
268pub use crate::param_spec::{ParamSpecArray, ParamSpecFraction};
269
270mod functions;
271pub use crate::functions::*;
272
273mod utils;
274pub use crate::utils::ObjectLockGuard;
275
276pub mod parse;
277
278#[cfg(feature = "v1_18")]
279mod gtype;
280
281use std::ptr;
282
283#[doc(alias = "gst_init_check")]
284pub fn init() -> Result<(), glib::Error> {
285    unsafe {
286        use glib::translate::*;
287
288        let mut error = ptr::null_mut();
289        if from_glib(ffi::gst_init_check(
290            ptr::null_mut(),
291            ptr::null_mut(),
292            &mut error,
293        )) {
294            crate::INITIALIZED.store(true, std::sync::atomic::Ordering::SeqCst);
295            Ok(())
296        } else {
297            Err(from_glib_full(error))
298        }
299    }
300}
301
302// rustdoc-stripper-ignore-next
303/// Deinitialize GStreamer
304///
305/// # Safety
306///
307/// This must only be called once during the lifetime of the process, once no GStreamer threads
308/// are running anymore and all GStreamer resources are released.
309pub unsafe fn deinit() {
310    crate::INITIALIZED.store(false, std::sync::atomic::Ordering::SeqCst);
311    ffi::gst_deinit();
312}
313
314pub const PARAM_FLAG_CONTROLLABLE: glib::ParamFlags = glib::ParamFlags::USER_1;
315pub const PARAM_FLAG_MUTABLE_READY: glib::ParamFlags = glib::ParamFlags::USER_2;
316pub const PARAM_FLAG_MUTABLE_PAUSED: glib::ParamFlags = glib::ParamFlags::USER_3;
317pub const PARAM_FLAG_MUTABLE_PLAYING: glib::ParamFlags = glib::ParamFlags::USER_4;
318#[cfg(feature = "v1_18")]
319pub const PARAM_FLAG_DOC_SHOW_DEFAULT: glib::ParamFlags = glib::ParamFlags::USER_5;
320#[cfg(feature = "v1_18")]
321pub const PARAM_FLAG_CONDITIONALLY_AVAILABLE: glib::ParamFlags = glib::ParamFlags::USER_6;
322
323// Re-export all the traits in a prelude module, so that applications
324// can always "use gst::prelude::*" without getting conflicts
325pub mod prelude {
326    #[doc(hidden)]
327    pub use glib::prelude::*;
328    pub use muldiv::MulDiv;
329    pub use opt_ops::prelude::*;
330
331    // OS dependent Bus extensions (also import the other platform trait for doc)
332    #[cfg(any(unix, docsrs))]
333    pub use crate::bus_unix::UnixBusExtManual;
334    #[cfg(any(windows, docsrs))]
335    pub use crate::bus_windows::WindowsBusExtManual;
336    #[cfg(feature = "v1_18")]
337    pub use crate::gtype::PluginApiExt;
338    pub use crate::{
339        auto::traits::*,
340        bin::GstBinExtManual,
341        buffer_pool::BufferPoolExtManual,
342        child_proxy::ChildProxyExtManual,
343        clock::ClockExtManual,
344        control_binding::ControlBindingExtManual,
345        control_source::ControlSourceExtManual,
346        device_monitor::DeviceMonitorExtManual,
347        device_provider::{DeviceProviderClassExt, DeviceProviderExtManual},
348        element::{ElementClassExt, ElementExtManual},
349        format::prelude::*,
350        gobject::GObjectExtManualGst,
351        memory::MemoryType,
352        message::MessageErrorDomain,
353        meta::{MetaAPI, MetaAPIExt, MetaTag},
354        miniobject::IsMiniObject,
355        object::GstObjectExtManual,
356        pad::PadExtManual,
357        param_spec::GstParamSpecBuilderExt,
358        pipeline::GstPipelineExtManual,
359        plugin_feature::PluginFeatureExtManual,
360        slice::ByteSliceExt,
361        tag_setter::TagSetterExtManual,
362        tags::{CustomTag, Tag},
363        task_pool::{TaskHandle, TaskPoolExtManual},
364        typefind::TypeFindImpl,
365        utils::Displayable,
366        value::GstValueExt,
367    };
368}
369
370#[macro_use]
371pub mod subclass;
gstreamer/lib.rs

gstreamer/
lib.rs
