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

gstreamer/
lib.rs
