// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use glib;
use glib::translate::*;
use glib::GString;
use gst_sys;
use std;
use std::ptr;
use Object;
use PluginDependencyFlags;

glib_wrapper! {
    /// GStreamer is extensible, so `Element` instances can be loaded at runtime.
    /// A plugin system can provide one or more of the basic GStreamer
    /// `PluginFeature` subclasses.
    ///
    /// A plugin should export a symbol `gst_plugin_desc` that is a
    /// struct of type `PluginDesc`.
    /// the plugin loader will check the version of the core library the plugin was
    /// linked against and will create a new `Plugin`. It will then call the
    /// `GstPluginInitFunc` function that was provided in the
    /// `gst_plugin_desc`.
    ///
    /// Once you have a handle to a `Plugin` (e.g. from the `Registry`), you
    /// can add any object that subclasses `PluginFeature`.
    ///
    /// Usually plugins are always automatically loaded so you don't need to call
    /// `Plugin::load` explicitly to bring it into memory. There are options to
    /// statically link plugins to an app or even use GStreamer without a plugin
    /// repository in which case `Plugin::load` can be needed to bring the plugin
    /// into memory.
    ///
    /// # Implements
    ///
    /// [`GstObjectExt`](trait.GstObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
    pub struct Plugin(Object<gst_sys::GstPlugin, gst_sys::GstPluginClass, PluginClass>) @extends Object;

    match fn {
        get_type => || gst_sys::gst_plugin_get_type(),
    }
}

impl Plugin {
    /// Make GStreamer aware of external dependencies which affect the feature
    /// set of this plugin (ie. the elements or typefinders associated with it).
    ///
    /// GStreamer will re-inspect plugins with external dependencies whenever any
    /// of the external dependencies change. This is useful for plugins which wrap
    /// other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
    /// library and makes visualisations available as GStreamer elements, or a
    /// codec loader which exposes elements and/or caps dependent on what external
    /// codec libraries are currently installed.
    /// ## `env_vars`
    /// `None`-terminated array of environment variables affecting the
    ///  feature set of the plugin (e.g. an environment variable containing
    ///  paths where to look for additional modules/plugins of a library),
    ///  or `None`. Environment variable names may be followed by a path component
    ///  which will be added to the content of the environment variable, e.g.
    ///  "HOME/.mystuff/plugins".
    /// ## `paths`
    /// `None`-terminated array of directories/paths where dependent files
    ///  may be, or `None`.
    /// ## `names`
    /// `None`-terminated array of file names (or file name suffixes,
    ///  depending on `flags`) to be used in combination with the paths from
    ///  `paths` and/or the paths extracted from the environment variables in
    ///  `env_vars`, or `None`.
    /// ## `flags`
    /// optional flags, or `PluginDependencyFlags::None`
    pub fn add_dependency(
        &self,
        env_vars: &[&str],
        paths: &[&str],
        names: &[&str],
        flags: PluginDependencyFlags,
    ) {
        unsafe {
            gst_sys::gst_plugin_add_dependency(
                self.to_glib_none().0,
                env_vars.to_glib_none().0,
                paths.to_glib_none().0,
                names.to_glib_none().0,
                flags.to_glib(),
            );
        }
    }

    /// Make GStreamer aware of external dependencies which affect the feature
    /// set of this plugin (ie. the elements or typefinders associated with it).
    ///
    /// GStreamer will re-inspect plugins with external dependencies whenever any
    /// of the external dependencies change. This is useful for plugins which wrap
    /// other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
    /// library and makes visualisations available as GStreamer elements, or a
    /// codec loader which exposes elements and/or caps dependent on what external
    /// codec libraries are currently installed.
    ///
    /// Convenience wrapper function for `Plugin::add_dependency` which
    /// takes simple strings as arguments instead of string arrays, with multiple
    /// arguments separated by predefined delimiters (see above).
    /// ## `env_vars`
    /// one or more environment variables (separated by ':', ';' or ','),
    ///  or `None`. Environment variable names may be followed by a path component
    ///  which will be added to the content of the environment variable, e.g.
    ///  "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"
    /// ## `paths`
    /// one ore more directory paths (separated by ':' or ';' or ','),
    ///  or `None`. Example: "/usr/lib/mystuff/plugins"
    /// ## `names`
    /// one or more file names or file name suffixes (separated by commas),
    ///  or `None`
    /// ## `flags`
    /// optional flags, or `PluginDependencyFlags::None`
    pub fn add_dependency_simple(
        &self,
        env_vars: Option<&str>,
        paths: Option<&str>,
        names: Option<&str>,
        flags: PluginDependencyFlags,
    ) {
        unsafe {
            gst_sys::gst_plugin_add_dependency_simple(
                self.to_glib_none().0,
                env_vars.to_glib_none().0,
                paths.to_glib_none().0,
                names.to_glib_none().0,
                flags.to_glib(),
            );
        }
    }

    /// Get the long descriptive name of the plugin
    ///
    /// # Returns
    ///
    /// the long name of the plugin
    pub fn get_description(&self) -> GString {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_description(self.to_glib_none().0)) }
    }

    /// get the filename of the plugin
    ///
    /// # Returns
    ///
    /// the filename of the plugin
    pub fn get_filename(&self) -> Option<std::path::PathBuf> {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_filename(self.to_glib_none().0)) }
    }

    /// get the license of the plugin
    ///
    /// # Returns
    ///
    /// the license of the plugin
    pub fn get_license(&self) -> GString {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_license(self.to_glib_none().0)) }
    }

    /// get the URL where the plugin comes from
    ///
    /// # Returns
    ///
    /// the origin of the plugin
    pub fn get_origin(&self) -> GString {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_origin(self.to_glib_none().0)) }
    }

    /// get the package the plugin belongs to.
    ///
    /// # Returns
    ///
    /// the package of the plugin
    pub fn get_package(&self) -> GString {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_package(self.to_glib_none().0)) }
    }

    /// Get the release date (and possibly time) in form of a string, if available.
    ///
    /// For normal GStreamer plugin releases this will usually just be a date in
    /// the form of "YYYY-MM-DD", while pre-releases and builds from git may contain
    /// a time component after the date as well, in which case the string will be
    /// formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").
    ///
    /// There may be plugins that do not have a valid release date set on them.
    ///
    /// # Returns
    ///
    /// the date string of the plugin, or `None` if not
    /// available.
    pub fn get_release_date_string(&self) -> Option<GString> {
        unsafe {
            from_glib_none(gst_sys::gst_plugin_get_release_date_string(
                self.to_glib_none().0,
            ))
        }
    }

    /// get the source module the plugin belongs to.
    ///
    /// # Returns
    ///
    /// the source of the plugin
    pub fn get_source(&self) -> GString {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_source(self.to_glib_none().0)) }
    }

    /// get the version of the plugin
    ///
    /// # Returns
    ///
    /// the version of the plugin
    pub fn get_version(&self) -> GString {
        unsafe { from_glib_none(gst_sys::gst_plugin_get_version(self.to_glib_none().0)) }
    }

    /// queries if the plugin is loaded into memory
    ///
    /// # Returns
    ///
    /// `true` is loaded, `false` otherwise
    pub fn is_loaded(&self) -> bool {
        unsafe { from_glib(gst_sys::gst_plugin_is_loaded(self.to_glib_none().0)) }
    }

    /// Loads `self`. Note that the *return value* is the loaded plugin; `self` is
    /// untouched. The normal use pattern of this function goes like this:
    ///
    ///
    /// ```text
    /// GstPlugin *loaded_plugin;
    /// loaded_plugin = gst_plugin_load (plugin);
    /// // presumably, we're no longer interested in the potentially-unloaded plugin
    /// gst_object_unref (plugin);
    /// plugin = loaded_plugin;
    /// ```
    ///
    /// # Returns
    ///
    /// a reference to a loaded plugin, or
    /// `None` on error.
    pub fn load(&self) -> Result<Plugin, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_plugin_load(self.to_glib_none().0))
                .ok_or_else(|| glib_bool_error!("Failed to load plugin"))
        }
    }

    /// Load the named plugin. Refs the plugin.
    /// ## `name`
    /// name of plugin to load
    ///
    /// # Returns
    ///
    /// a reference to a loaded plugin, or
    /// `None` on error.
    pub fn load_by_name(name: &str) -> Result<Plugin, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_plugin_load_by_name(name.to_glib_none().0))
                .ok_or_else(|| glib_bool_error!("Failed to load plugin"))
        }
    }

    /// Loads the given plugin and refs it. Caller needs to unref after use.
    /// ## `filename`
    /// the plugin filename to load
    ///
    /// # Returns
    ///
    /// a reference to the existing loaded GstPlugin, a
    /// reference to the newly-loaded GstPlugin, or `None` if an error occurred.
    pub fn load_file<P: AsRef<std::path::Path>>(filename: P) -> Result<Plugin, glib::Error> {
        assert_initialized_main_thread!();
        unsafe {
            let mut error = ptr::null_mut();
            let ret = gst_sys::gst_plugin_load_file(filename.as_ref().to_glib_none().0, &mut error);
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

unsafe impl Send for Plugin {}
unsafe impl Sync for Plugin {}