/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = GstElementFactory.html
 * outPack = gstreamer
 * outFile = ElementFactory
 * strct   = GstElementFactory
 * realStrct=
 * ctorStrct=
 * clss    = ElementFactory
 * interf  = 
 * class Code: Yes
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- gst_element_factory_
 * 	- gst_element_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.Str
 * 	- glib.ListG
 * 	- gstreamer.Caps
 * 	- gstreamer.Element
 * 	- gstreamer.Plugin
 * structWrap:
 * 	- GList* -> ListG
 * 	- GstCaps* -> Caps
 * 	- GstElement* -> Element
 * 	- GstElementFactory* -> ElementFactory
 * 	- GstPlugin* -> Plugin
 * module aliases:
 * local aliases:
 * overrides:
 */

module gstreamer.ElementFactory;

public  import gstreamerc.gstreamertypes;

private import gstreamerc.gstreamer;
private import glib.ConstructionException;
private import gobject.ObjectG;

private import glib.Str;
private import glib.ListG;
private import gstreamer.Caps;
private import gstreamer.Element;
private import gstreamer.Plugin;


private import gstreamer.PluginFeature;

/**
 * GstElementFactory is used to create instances of elements. A
 * GstElementfactory can be added to a GstPlugin as it is also a
 * GstPluginFeature.
 *
 * Use the gst_element_factory_find() and gst_element_factory_create()
 * functions to create element instances or use gst_element_factory_make() as a
 * convenient shortcut.
 *
 * The following code example shows you how to create a GstFileSrc element.
 *
 * $(DDOC_COMMENT example)
 *
 * Last reviewed on 2005-11-23 (0.9.5)
 */
public class ElementFactory : PluginFeature
{
	
	/** the main Gtk struct */
	protected GstElementFactory* gstElementFactory;
	
	
	/** Get the main Gtk struct */
	public GstElementFactory* getElementFactoryStruct()
	{
		return gstElementFactory;
	}
	
	
	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gstElementFactory;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GstElementFactory* gstElementFactory)
	{
		super(cast(GstPluginFeature*)gstElementFactory);
		this.gstElementFactory = gstElementFactory;
	}
	
	protected override void setStruct(GObject* obj)
	{
		super.setStruct(obj);
		gstElementFactory = cast(GstElementFactory*)obj;
	}
	
	/**
	 * Create a new element of the type defined by the given element factory.
	 * The element will receive a guaranteed unique name,
	 * consisting of the element factory name and a number.
	 * Params:
	 *  factoryname = a named factory to instantiate
	 * Returns:
	 *  new GstElement or NULL if unable to create element
	 */
	public static Element make( string factoryname )
	{
		// GstElement* gst_element_factory_make (const gchar *factoryname,  const gchar *name);
		auto p = gst_element_factory_make(Str.toStringz(factoryname), null );
		
		if(p is null)
		{
			throw new ConstructionException("null returned by gst_element_factory_make");
		}
		
		return new Element( p );
	}
	
	/**
	 */
	
	/**
	 * Create a new elementfactory capable of instantiating objects of the
	 * type and add the factory to plugin.
	 * Params:
	 * plugin = GstPlugin to register the element with, or NULL for
	 * a static element. [allow-none]
	 * name = name of elements of this type
	 * rank = rank of element (higher rank means more importance when autoplugging)
	 * type = GType of element to register
	 * Returns: TRUE, if the registering succeeded, FALSE on error
	 */
	public static int register(Plugin plugin, string name, uint rank, GType type)
	{
		// gboolean gst_element_register (GstPlugin *plugin,  const gchar *name,  guint rank,  GType type);
		return gst_element_register((plugin is null) ? null : plugin.getPluginStruct(), Str.toStringz(name), rank, type);
	}
	
	/**
	 * Search for an element factory of the given name. Refs the returned
	 * element factory; caller is responsible for unreffing.
	 * Params:
	 * name = name of factory to find
	 * Returns: GstElementFactory if found, NULL otherwise. [transfer full]
	 */
	public static ElementFactory find(string name)
	{
		// GstElementFactory * gst_element_factory_find (const gchar *name);
		auto p = gst_element_factory_find(Str.toStringz(name));
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ElementFactory)(cast(GstElementFactory*) p);
	}
	
	/**
	 * Get the GType for elements managed by this factory. The type can
	 * only be retrieved if the element factory is loaded, which can be
	 * assured with gst_plugin_feature_load().
	 * Returns: the GType for elements managed by this factory or 0 if the factory is not loaded.
	 */
	public GType getElementType()
	{
		// GType gst_element_factory_get_element_type  (GstElementFactory *factory);
		return gst_element_factory_get_element_type(gstElementFactory);
	}
	
	/**
	 * Get the metadata on factory with key.
	 * Params:
	 * key = a key
	 * Returns: the metadata with key on factory or NULL when there was no metadata with the given key.
	 */
	public string getMetadata(string key)
	{
		// const gchar * gst_element_factory_get_metadata (GstElementFactory *factory,  const gchar *key);
		return Str.toString(gst_element_factory_get_metadata(gstElementFactory, Str.toStringz(key)));
	}
	
	/**
	 * Get the available keys for the metadata on factory.
	 * Returns: a NULL-terminated array of key strings, or NULL when there is no metadata. Free with g_strfreev() when no longer needed. [transfer full][element-type utf8][array zero-terminated=1]
	 */
	public string[] getMetadataKeys()
	{
		// gchar ** gst_element_factory_get_metadata_keys  (GstElementFactory *factory);
		return Str.toStringArray(gst_element_factory_get_metadata_keys(gstElementFactory));
	}
	
	/**
	 * Gets the number of pad_templates in this factory.
	 * Returns: the number of pad_templates
	 */
	public uint getNumPadTemplates()
	{
		// guint gst_element_factory_get_num_pad_templates  (GstElementFactory *factory);
		return gst_element_factory_get_num_pad_templates(gstElementFactory);
	}
	
	/**
	 * Gets the type of URIs the element supports or GST_URI_UNKNOWN if none.
	 * Returns: type of URIs this element supports
	 */
	public GstURIType getUriType()
	{
		// GstURIType gst_element_factory_get_uri_type (GstElementFactory *factory);
		return gst_element_factory_get_uri_type(gstElementFactory);
	}
	
	/**
	 * Gets a NULL-terminated array of protocols this element supports or NULL if
	 * no protocols are supported. You may not change the contents of the returned
	 * array, as it is still owned by the element factory. Use g_strdupv() to
	 * make a copy of the protocol string array if you need to.
	 * Returns: the supported protocols or NULL. [transfer none][array zero-terminated=1]
	 */
	public string[] getUriProtocols()
	{
		// const gchar * const * gst_element_factory_get_uri_protocols  (GstElementFactory *factory);
		return Str.toStringArray(gst_element_factory_get_uri_protocols(gstElementFactory));
	}
	
	/**
	 * Check if factory implements the interface with name interfacename.
	 * Params:
	 * interfacename = an interface name
	 * Returns: TRUE when factory implement the interface.
	 */
	public int hasInterface(string interfacename)
	{
		// gboolean gst_element_factory_has_interface (GstElementFactory *factory,  const gchar *interfacename);
		return gst_element_factory_has_interface(gstElementFactory, Str.toStringz(interfacename));
	}
	
	/**
	 * Create a new element of the type defined by the given elementfactory.
	 * It will be given the name supplied, since all elements require a name as
	 * their first argument.
	 * Params:
	 * name = name of new element, or NULL to automatically create
	 * a unique name. [allow-none]
	 * Returns: new GstElement or NULL if the element couldn't be created. [transfer floating]
	 */
	public Element create(string name)
	{
		// GstElement * gst_element_factory_create (GstElementFactory *factory,  const gchar *name);
		auto p = gst_element_factory_create(gstElementFactory, Str.toStringz(name));
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Element)(cast(GstElement*) p);
	}
	
	/**
	 * Create a new element of the type defined by the given element factory.
	 * If name is NULL, then the element will receive a guaranteed unique name,
	 * consisting of the element factory name and a number.
	 * If name is given, it will be given the name supplied.
	 * Params:
	 * factoryname = a named factory to instantiate
	 * name = name of new element, or NULL to automatically create
	 * a unique name. [allow-none]
	 * Returns: new GstElement or NULL if unable to create element. [transfer floating]
	 */
	public static Element make(string factoryname, string name)
	{
		// GstElement * gst_element_factory_make (const gchar *factoryname,  const gchar *name);
		auto p = gst_element_factory_make(Str.toStringz(factoryname), Str.toStringz(name));
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Element)(cast(GstElement*) p);
	}
	
	/**
	 * Checks if the factory can sink all possible capabilities.
	 * Params:
	 * caps = the caps to check
	 * Returns: TRUE if the caps are fully compatible.
	 */
	public int canSinkAllCaps(Caps caps)
	{
		// gboolean gst_element_factory_can_sink_all_caps  (GstElementFactory *factory,  const GstCaps *caps);
		return gst_element_factory_can_sink_all_caps(gstElementFactory, (caps is null) ? null : caps.getCapsStruct());
	}
	
	/**
	 * Checks if the factory can src all possible capabilities.
	 * Params:
	 * caps = the caps to check
	 * Returns: TRUE if the caps are fully compatible.
	 */
	public int canSrcAllCaps(Caps caps)
	{
		// gboolean gst_element_factory_can_src_all_caps  (GstElementFactory *factory,  const GstCaps *caps);
		return gst_element_factory_can_src_all_caps(gstElementFactory, (caps is null) ? null : caps.getCapsStruct());
	}
	
	/**
	 * Checks if the factory can sink any possible capability.
	 * Params:
	 * caps = the caps to check
	 * Returns: TRUE if the caps have a common subset.
	 */
	public int canSinkAnyCaps(Caps caps)
	{
		// gboolean gst_element_factory_can_sink_any_caps  (GstElementFactory *factory,  const GstCaps *caps);
		return gst_element_factory_can_sink_any_caps(gstElementFactory, (caps is null) ? null : caps.getCapsStruct());
	}
	
	/**
	 * Checks if the factory can src any possible capability.
	 * Params:
	 * caps = the caps to check
	 * Returns: TRUE if the caps have a common subset.
	 */
	public int canSrcAnyCaps(Caps caps)
	{
		// gboolean gst_element_factory_can_src_any_caps  (GstElementFactory *factory,  const GstCaps *caps);
		return gst_element_factory_can_src_any_caps(gstElementFactory, (caps is null) ? null : caps.getCapsStruct());
	}
	
	/**
	 * Gets the GList of GstStaticPadTemplate for this factory.
	 * Returns: the static pad templates. [transfer none][element-type Gst.StaticPadTemplate]
	 */
	public ListG getStaticPadTemplates()
	{
		// const GList * gst_element_factory_get_static_pad_templates  (GstElementFactory *factory);
		auto p = gst_element_factory_get_static_pad_templates(gstElementFactory);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ListG)(cast(GList*) p);
	}
	
	/**
	 * Filter out all the elementfactories in list that can handle caps in
	 * the given direction.
	 * If subsetonly is TRUE, then only the elements whose pads templates
	 * are a complete superset of caps will be returned. Else any element
	 * whose pad templates caps can intersect with caps will be returned.
	 * Params:
	 * list = a GList of
	 * GstElementFactory to filter. [transfer none][element-type Gst.ElementFactory]
	 * caps = a GstCaps
	 * direction = a GstPadDirection to filter on
	 * subsetonly = whether to filter on caps subsets or not.
	 * Returns: a GList of GstElementFactory elements that match the given requisits. Use gst_plugin_feature_list_free after usage. [transfer full][element-type Gst.ElementFactory]
	 */
	public static ListG listFilter(ListG list, Caps caps, GstPadDirection direction, int subsetonly)
	{
		// GList * gst_element_factory_list_filter (GList *list,  const GstCaps *caps,  GstPadDirection direction,  gboolean subsetonly);
		auto p = gst_element_factory_list_filter((list is null) ? null : list.getListGStruct(), (caps is null) ? null : caps.getCapsStruct(), direction, subsetonly);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ListG)(cast(GList*) p);
	}
	
	/**
	 * Get a list of factories that match the given type. Only elements
	 * with a rank greater or equal to minrank will be returned.
	 * The list of factories is returned by decreasing rank.
	 * Params:
	 * type = a GstElementFactoryListType
	 * minrank = Minimum rank
	 * Returns: a GList of GstElementFactory elements. Use gst_plugin_feature_list_free() after usage. [transfer full][element-type Gst.ElementFactory]
	 */
	public static ListG listGetElements(GstElementFactoryListType type, GstRank minrank)
	{
		// GList * gst_element_factory_list_get_elements  (GstElementFactoryListType type,  GstRank minrank);
		auto p = gst_element_factory_list_get_elements(type, minrank);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ListG)(cast(GList*) p);
	}
	
	/**
	 * Check if factory is of the given types.
	 * Params:
	 * type = a GstElementFactoryListType
	 * Returns: TRUE if factory is of type.
	 */
	public int listIsType(GstElementFactoryListType type)
	{
		// gboolean gst_element_factory_list_is_type (GstElementFactory *factory,  GstElementFactoryListType type);
		return gst_element_factory_list_is_type(gstElementFactory, type);
	}
}