mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-22 17:51:16 +00:00
168e31f2e0
Original commit message from CVS: * gst/gstpad.h: (GST_PAD_LINK_SUCCESSFUL): * gst/gstpluginfeature.h: (GstPluginFeatureClass): Some minor docs fixes: fix typo, mention that GST_FLOW_RESEND is unused and unimplemented; finally, it is plugin features, not plugins, that have ranks.
150 lines
4.9 KiB
C
150 lines
4.9 KiB
C
/* GStreamer
|
|
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
|
|
* 2000 Wim Taymans <wtay@chello.be>
|
|
*
|
|
* gstpluginfeature.h: Header for base GstPluginFeature
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
|
|
#ifndef __GST_PLUGIN_FEATURE_H__
|
|
#define __GST_PLUGIN_FEATURE_H__
|
|
|
|
#include <glib-object.h>
|
|
#include <gst/gstobject.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define GST_TYPE_PLUGIN_FEATURE (gst_plugin_feature_get_type())
|
|
#define GST_PLUGIN_FEATURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeature))
|
|
#define GST_IS_PLUGIN_FEATURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLUGIN_FEATURE))
|
|
#define GST_PLUGIN_FEATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
|
|
#define GST_IS_PLUGIN_FEATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLUGIN_FEATURE))
|
|
#define GST_PLUGIN_FEATURE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
|
|
#define GST_PLUGIN_FEATURE_CAST(obj) ((GstPluginFeature*)(obj))
|
|
|
|
/**
|
|
* GST_PLUGIN_FEATURE_NAME:
|
|
* @feature: The feature to query
|
|
*
|
|
* Get the name of the feature
|
|
*/
|
|
#define GST_PLUGIN_FEATURE_NAME(feature) (GST_PLUGIN_FEATURE (feature)->name)
|
|
|
|
typedef struct _GstPluginFeature GstPluginFeature;
|
|
typedef struct _GstPluginFeatureClass GstPluginFeatureClass;
|
|
|
|
/**
|
|
* GstRank:
|
|
* @GST_RANK_NONE: will be chosen last or not at all
|
|
* @GST_RANK_MARGINAL: unlikly to be chosen
|
|
* @GST_RANK_SECONDARY: likely to be chosen
|
|
* @GST_RANK_PRIMARY: will be chosen first
|
|
*
|
|
* Element priority ranks. Defines the order in which the autoplugger (or
|
|
* similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri())
|
|
* will choose this element over an alternative one with the same function.
|
|
*
|
|
* These constants serve as a rough guidance for defining the rank of a
|
|
* #GstPluginFeature. Any value is valid, including values bigger than
|
|
* @GST_RANK_PRIMARY.
|
|
*/
|
|
typedef enum {
|
|
GST_RANK_NONE = 0,
|
|
GST_RANK_MARGINAL = 64,
|
|
GST_RANK_SECONDARY = 128,
|
|
GST_RANK_PRIMARY = 256
|
|
} GstRank;
|
|
|
|
/**
|
|
* GstPluginFeature:
|
|
*
|
|
* Opaque #GstPluginFeature structure.
|
|
*/
|
|
struct _GstPluginFeature {
|
|
GstObject object;
|
|
|
|
/*< private >*/
|
|
gboolean loaded;
|
|
gchar *name;
|
|
guint rank;
|
|
|
|
const gchar *plugin_name;
|
|
|
|
/*< private >*/
|
|
gpointer _gst_reserved[GST_PADDING];
|
|
};
|
|
|
|
struct _GstPluginFeatureClass {
|
|
GstObjectClass parent_class;
|
|
|
|
/*< private >*/
|
|
gpointer _gst_reserved[GST_PADDING];
|
|
};
|
|
|
|
/**
|
|
* GstTypeNameData:
|
|
* @name: a name
|
|
* @type: a GType
|
|
*
|
|
* Structure used for filtering based on @name and @type.
|
|
*/
|
|
typedef struct {
|
|
const gchar *name;
|
|
GType type;
|
|
} GstTypeNameData;
|
|
|
|
/**
|
|
* GstPluginFeatureFilter:
|
|
* @feature: the pluginfeature to check
|
|
* @user_data: the user_data that has been passed on e.g.
|
|
* gst_registry_feature_filter()
|
|
*
|
|
* A function that can be used with e.g. gst_registry_feature_filter()
|
|
* to get a list of pluginfeature that match certain criteria.
|
|
*
|
|
* Returns: %TRUE for a positive match, %FALSE otherwise
|
|
*/
|
|
typedef gboolean (*GstPluginFeatureFilter) (GstPluginFeature *feature,
|
|
gpointer user_data);
|
|
|
|
/* normal GObject stuff */
|
|
GType gst_plugin_feature_get_type (void);
|
|
|
|
GstPluginFeature *
|
|
gst_plugin_feature_load (GstPluginFeature *feature);
|
|
|
|
gboolean gst_plugin_feature_type_name_filter (GstPluginFeature *feature,
|
|
GstTypeNameData *data);
|
|
|
|
void gst_plugin_feature_set_rank (GstPluginFeature *feature, guint rank);
|
|
void gst_plugin_feature_set_name (GstPluginFeature *feature, const gchar *name);
|
|
guint gst_plugin_feature_get_rank (GstPluginFeature *feature);
|
|
G_CONST_RETURN gchar *gst_plugin_feature_get_name (GstPluginFeature *feature);
|
|
|
|
void gst_plugin_feature_list_free (GList *list);
|
|
|
|
gboolean gst_plugin_feature_check_version (GstPluginFeature *feature,
|
|
guint min_major,
|
|
guint min_minor,
|
|
guint min_micro);
|
|
|
|
G_END_DECLS
|
|
|
|
|
|
#endif /* __GST_PLUGIN_FEATURE_H__ */
|
|
|