gstreamer-rs/gstreamer/src/lib.rs

383 lines
9.8 KiB
Rust
Raw Normal View History

2017-07-07 11:47:28 +00:00
// Copyright (C) 2017 Sebastian Dröge <sebastian@centricular.com>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#![recursion_limit = "256"]
#[macro_use]
extern crate bitflags;
#[cfg(any(feature = "v1_14", feature = "dox"))]
#[macro_use]
extern crate cfg_if;
extern crate libc;
extern crate once_cell;
extern crate thiserror;
// Re-exported for the subclass gst_plugin_define! macro
#[doc(hidden)]
2019-03-19 07:58:20 +00:00
pub extern crate glib_sys;
#[doc(hidden)]
2019-03-19 07:58:20 +00:00
pub extern crate gobject_sys;
#[doc(hidden)]
2019-03-19 07:58:20 +00:00
pub extern crate gstreamer_sys as gst_sys;
#[doc(hidden)]
pub extern crate paste;
#[macro_use]
#[doc(hidden)]
pub extern crate glib;
2017-07-12 10:25:11 +00:00
extern crate num_rational;
extern crate futures_channel;
2018-04-23 14:55:31 +00:00
extern crate futures_core;
extern crate futures_util;
extern crate muldiv;
2019-12-23 09:44:11 +00:00
extern crate pretty_hex;
2018-06-20 19:38:49 +00:00
#[cfg(feature = "ser_de")]
extern crate serde;
#[cfg(feature = "ser_de")]
2018-07-05 18:42:28 +00:00
extern crate serde_bytes;
#[cfg(feature = "ser_de")]
2018-06-20 19:38:49 +00:00
#[macro_use]
extern crate serde_derive;
use glib::translate::{from_glib, from_glib_full};
macro_rules! assert_initialized_main_thread {
2018-04-01 08:30:03 +00:00
() => {
2019-03-19 07:58:20 +00:00
if unsafe { ::gst_sys::gst_is_initialized() } != ::glib_sys::GTRUE {
panic!("GStreamer has not been initialized. Call `gst::init` first.");
}
2018-04-01 08:30:03 +00:00
};
}
macro_rules! skip_assert_initialized {
2018-04-01 08:30:03 +00:00
() => {};
}
#[allow(clippy::unreadable_literal)]
#[allow(clippy::too_many_arguments)]
#[allow(clippy::match_same_arms)]
#[allow(clippy::type_complexity)]
mod auto;
2017-08-17 12:31:00 +00:00
pub use auto::functions::*;
2018-04-01 08:30:03 +00:00
pub use auto::*;
#[macro_use]
mod log;
pub use log::*;
#[macro_use]
mod error;
pub use error::*;
#[macro_use]
pub mod miniobject;
pub use miniobject::{GstRc, MiniObject};
pub mod message;
pub use message::{Message, MessageErrorDomain, MessageRef, MessageView};
2018-06-21 18:44:51 +00:00
mod value;
pub use value::*;
#[cfg(feature = "ser_de")]
#[macro_use]
2018-07-30 19:10:34 +00:00
mod value_serde;
2017-07-07 13:04:54 +00:00
pub mod structure;
2017-07-24 22:17:50 +00:00
pub use structure::{Structure, StructureRef};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod structure_serde;
2017-07-10 21:02:08 +00:00
pub mod caps;
2017-07-24 22:17:50 +00:00
pub use caps::{Caps, CapsRef};
2018-09-28 09:01:14 +00:00
mod caps_features;
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod caps_serde;
2018-09-28 09:01:14 +00:00
pub use caps_features::{
CapsFeatures, CapsFeaturesRef, CAPS_FEATURES_MEMORY_SYSTEM_MEMORY,
CAPS_FEATURE_MEMORY_SYSTEM_MEMORY,
};
#[cfg(feature = "ser_de")]
mod caps_features_serde;
2017-07-12 07:27:43 +00:00
pub mod tags;
pub use tags::{
tag_exists, tag_get_description, tag_get_flag, tag_get_nick, tag_get_type, Tag, TagList,
TagListRef,
};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod tags_serde;
pub mod meta;
#[cfg(any(feature = "v1_16", feature = "dox"))]
pub use meta::MetaSeqnum;
#[cfg(any(feature = "v1_14", feature = "dox"))]
pub use meta::ReferenceTimestampMeta;
pub use meta::{Meta, MetaAPI, MetaRef, MetaRefMut, ParentBufferMeta};
2017-07-25 12:01:24 +00:00
pub mod buffer;
2018-07-27 10:36:40 +00:00
pub use buffer::{
Buffer, BufferMap, BufferRef, MappedBuffer, BUFFER_COPY_ALL, BUFFER_COPY_METADATA,
};
pub mod memory;
pub use memory::{MappedMemory, Memory, MemoryMap, MemoryRef};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod buffer_serde;
2017-07-28 17:04:15 +00:00
pub mod sample;
pub use sample::{Sample, SampleRef};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod sample_serde;
2017-07-28 17:20:11 +00:00
pub mod bufferlist;
pub use bufferlist::{BufferList, BufferListRef};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod bufferlist_serde;
2017-07-29 11:58:54 +00:00
pub mod query;
pub use query::{Query, QueryRef, QueryView};
pub mod event;
pub use event::{Event, EventRef, EventView, GroupId, Seqnum};
2017-08-02 17:34:37 +00:00
pub mod context;
pub use context::{Context, ContextRef};
mod static_caps;
pub use static_caps::*;
mod static_pad_template;
pub use static_pad_template::*;
2018-03-15 09:43:35 +00:00
#[cfg(any(feature = "v1_14", feature = "dox"))]
mod promise;
#[cfg(any(feature = "v1_14", feature = "dox"))]
pub use promise::*;
mod bus;
2018-04-01 08:30:03 +00:00
mod element;
2018-11-19 16:37:00 +00:00
mod bin;
2018-11-19 23:22:22 +00:00
2019-05-12 13:38:40 +00:00
mod allocator;
pub use allocator::AllocatorExtManual;
2019-05-12 13:38:16 +00:00
mod pipeline;
pub use pipeline::GstPipelineExtManual;
2019-05-12 13:38:16 +00:00
mod allocation_params;
pub use self::allocation_params::AllocationParams;
// OS dependent Bus extensions (also import the other plateform mod for doc)
#[cfg(any(feature = "v1_14", feature = "dox"))]
cfg_if! {
if #[cfg(unix)] {
mod bus_unix;
#[cfg(feature = "dox")]
mod bus_windows;
} else {
mod bus_windows;
#[cfg(feature = "dox")]
mod bus_unix;
}
}
2017-07-29 14:10:10 +00:00
mod child_proxy;
mod clock_time;
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod clock_time_serde;
mod date_time;
#[cfg(feature = "ser_de")]
mod date_time_serde;
mod device_monitor;
2018-04-01 08:30:03 +00:00
mod device_provider;
mod enums;
pub use enums::MessageType;
2018-04-01 08:30:03 +00:00
mod ghost_pad;
mod gobject;
mod iterator;
mod object;
mod pad;
mod parse_context;
mod proxy_pad;
pub use proxy_pad::ProxyPadExtManual;
2018-04-01 08:30:03 +00:00
mod tag_setter;
pub use bin::GstBinExtManual;
2018-04-25 08:10:06 +00:00
pub use element::{ElementExtManual, ElementMessageType, NotifyWatchId};
2018-07-27 10:36:40 +00:00
pub use element::{
ELEMENT_METADATA_AUTHOR, ELEMENT_METADATA_DESCRIPTION, ELEMENT_METADATA_DOC_URI,
ELEMENT_METADATA_ICON_NAME, ELEMENT_METADATA_KLASS, ELEMENT_METADATA_LONGNAME,
};
2018-04-01 08:30:03 +00:00
pub use object::GstObjectExtManual;
// OS dependent Bus extensions (also import the other plateform trait for doc)
#[cfg(any(feature = "v1_14", feature = "dox"))]
cfg_if! {
if #[cfg(unix)] {
pub use bus_unix::UnixBusExtManual;
#[cfg(feature = "dox")]
pub use bus_windows::WindowsBusExtManual;
} else {
pub use bus_windows::WindowsBusExtManual;
#[cfg(feature = "dox")]
pub use bus_unix::UnixBusExtManual;
}
}
pub use self::iterator::{Iterator, IteratorError, IteratorImpl, StdIterator};
2018-04-01 08:30:03 +00:00
pub use child_proxy::ChildProxyExtManual;
pub use clock_time::ClockTime;
pub use device_monitor::{DeviceMonitorExtManual, DeviceMonitorFilterId};
2018-04-01 08:30:03 +00:00
pub use device_provider::DeviceProviderExtManual;
2018-07-27 10:36:40 +00:00
pub use enums::{
ClockError, ClockSuccess, FlowError, FlowSuccess, PadLinkError, PadLinkSuccess,
StateChangeError, StateChangeSuccess, TagError,
};
2018-04-01 08:30:03 +00:00
pub use gobject::GObjectExtManualGst;
pub use pad::{PadExtManual, PadProbeData, PadProbeId, PadProbeInfo};
pub use parse_context::ParseContext;
mod plugin_feature;
pub use plugin_feature::PluginFeatureExtManual;
2018-04-01 08:30:03 +00:00
pub use tag_setter::TagSetterExtManual;
mod plugin;
pub use plugin::GstPluginExtManual;
2017-12-20 16:54:56 +00:00
#[cfg(any(feature = "v1_10", feature = "dox"))]
mod stream;
2018-07-27 10:36:40 +00:00
#[cfg(any(feature = "v1_10", feature = "dox"))]
pub mod stream_collection;
mod typefind;
pub use typefind::*;
pub mod format;
pub use format::{FormattedValue, GenericFormattedValue, SpecificFormattedValue};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod format_serde;
mod segment;
pub use segment::*;
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod segment_serde;
pub mod toc;
pub use toc::{Toc, TocEntry, TocEntryRef, TocRef};
#[cfg(feature = "ser_de")]
2018-07-30 19:10:34 +00:00
mod toc_serde;
mod clock;
pub use clock::{AtomicClockReturn, ClockExtManual, ClockId};
2018-03-07 09:07:30 +00:00
mod buffer_pool;
pub use buffer_pool::*;
2018-03-15 08:46:49 +00:00
mod pad_template;
mod param_spec;
pub use param_spec::*;
pub mod functions;
pub use functions::*;
use std::ptr;
pub fn init() -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
2019-03-19 07:58:20 +00:00
if from_glib(gst_sys::gst_init_check(
2017-07-10 21:33:24 +00:00
ptr::null_mut(),
ptr::null_mut(),
&mut error,
)) {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Deinitialize GStreamer
///
/// # Safety
///
/// This must only be called once during the lifetime of the process, once no GStreamer threads
/// are running anymore and all GStreamer resources are released.
pub unsafe fn deinit() {
2019-03-19 07:58:20 +00:00
gst_sys::gst_deinit();
}
2019-03-19 07:58:20 +00:00
pub const BUFFER_OFFSET_NONE: u64 = gst_sys::GST_BUFFER_OFFSET_NONE;
pub const CLOCK_TIME_NONE: ClockTime = ClockTime(None);
pub const SECOND: ClockTime = ClockTime(Some(1_000_000_000));
pub const MSECOND: ClockTime = ClockTime(Some(1_000_000));
pub const USECOND: ClockTime = ClockTime(Some(1_000));
pub const NSECOND: ClockTime = ClockTime(Some(1));
2017-11-11 12:00:50 +00:00
pub const SECOND_VAL: u64 = 1_000_000_000;
pub const MSECOND_VAL: u64 = 1_000_000;
pub const USECOND_VAL: u64 = 1_000;
pub const NSECOND_VAL: u64 = 1;
2019-03-19 07:58:20 +00:00
pub const FORMAT_PERCENT_MAX: u32 = gst_sys::GST_FORMAT_PERCENT_MAX as u32;
pub const FORMAT_PERCENT_SCALE: u32 = gst_sys::GST_FORMAT_PERCENT_SCALE as u32;
// Re-export all the traits in a prelude module, so that applications
// can always "use gst::prelude::*" without getting conflicts
pub mod prelude {
pub use glib::prelude::*;
pub use auto::traits::*;
pub use meta::MetaAPI;
pub use allocator::AllocatorExtManual;
pub use bin::GstBinExtManual;
2018-04-01 08:30:03 +00:00
pub use element::ElementExtManual;
// OS dependent Bus extensions (also import the other plateform trait for doc)
#[cfg(any(feature = "v1_14", feature = "dox"))]
cfg_if! {
if #[cfg(unix)] {
pub use bus_unix::UnixBusExtManual;
#[cfg(feature = "dox")]
pub use bus_windows::WindowsBusExtManual;
} else {
pub use bus_windows::WindowsBusExtManual;
#[cfg(feature = "dox")]
pub use bus_unix::UnixBusExtManual;
}
}
2018-04-01 08:30:03 +00:00
pub use buffer_pool::BufferPoolExtManual;
pub use child_proxy::ChildProxyExtManual;
pub use clock::ClockExtManual;
pub use device_monitor::DeviceMonitorExtManual;
2018-04-01 08:30:03 +00:00
pub use device_provider::DeviceProviderExtManual;
pub use gobject::GObjectExtManualGst;
pub use message::MessageErrorDomain;
2018-04-01 08:30:03 +00:00
pub use object::GstObjectExtManual;
pub use pad::PadExtManual;
pub use param_spec::GstParamSpecExt;
pub use pipeline::GstPipelineExtManual;
pub use plugin::GstPluginExtManual;
pub use plugin_feature::PluginFeatureExtManual;
pub use proxy_pad::ProxyPadExtManual;
2018-04-01 08:30:03 +00:00
pub use tag_setter::TagSetterExtManual;
pub use typefind::TypeFindImpl;
pub use value::GstValueExt;
pub use miniobject::MiniObject;
2019-01-23 13:42:46 +00:00
pub use tags::{CustomTag, Tag};
pub use muldiv::MulDiv;
pub use format::{FormattedValue, SpecificFormattedValue};
}
mod utils;
#[macro_use]
pub mod subclass;