*
* 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.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#ifndef __GST_TYPE_FIND_H__
#define __GST_TYPE_FIND_H__
-#include <gst/gstbuffer.h>
-#include <gst/gstcaps2.h>
+#include <gst/gstcaps.h>
#include <gst/gstplugin.h>
#include <gst/gstpluginfeature.h>
-#include <gst/gsttypes.h>
G_BEGIN_DECLS
-#define GST_TYPE_TYPE_FIND_FACTORY (gst_type_find_factory_get_type())
-#define GST_TYPE_FIND_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactory))
-#define GST_IS_TYPE_FIND_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_TYPE_FIND_FACTORY))
-#define GST_TYPE_FIND_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactoryClass))
-#define GST_IS_TYPE_FIND_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_TYPE_FIND_FACTORY))
-#define GST_TYPE_FIND_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactoryClass))
+#define GST_TYPE_TYPE_FIND (gst_type_find_get_type())
typedef struct _GstTypeFind GstTypeFind;
-typedef struct _GstTypeFindFactory GstTypeFindFactory;
-typedef struct _GstTypeFindFactoryClass GstTypeFindFactoryClass;
-
-typedef void (* GstTypeFindFunction) (GstTypeFind *find, gpointer data);
+/**
+ * GstTypeFindFunction:
+ * @find: A #GstTypeFind structure
+ * @user_data: optional data to pass to the function
+ *
+ * A function that will be called by typefinding.
+ */
+typedef void (* GstTypeFindFunction) (GstTypeFind *find, gpointer user_data);
+
+/**
+ * GstTypeFindProbability:
+ * @GST_TYPE_FIND_NONE: type undetected.
+ * @GST_TYPE_FIND_MINIMUM: unlikely typefind.
+ * @GST_TYPE_FIND_POSSIBLE: possible type detected.
+ * @GST_TYPE_FIND_LIKELY: likely a type was detected.
+ * @GST_TYPE_FIND_NEARLY_CERTAIN: nearly certain that a type was detected.
+ * @GST_TYPE_FIND_MAXIMUM: very certain a type was detected.
+ *
+ * The probability of the typefind function. Higher values have more certainty
+ * in doing a reliable typefind.
+ */
typedef enum {
+ GST_TYPE_FIND_NONE = 0,
GST_TYPE_FIND_MINIMUM = 1,
GST_TYPE_FIND_POSSIBLE = 50,
GST_TYPE_FIND_LIKELY = 80,
GST_TYPE_FIND_NEARLY_CERTAIN = 99,
- GST_TYPE_FIND_MAXIMUM = 100,
+ GST_TYPE_FIND_MAXIMUM = 100
} GstTypeFindProbability;
+/**
+ * GstTypeFind:
+ * @peek: Method to peek data.
+ * @suggest: Method to suggest #GstCaps with a given probability.
+ * @data: The data used by the caller of the typefinding function.
+ * @get_length: Returns the length of current data.
+ *
+ * Object that stores typefind callbacks. To use with #GstTypeFindFactory.
+ */
struct _GstTypeFind {
/* private to the caller of the typefind function */
- guint8 * (* peek) (gpointer data,
- gint64 offset,
- guint size);
- void (* suggest) (gpointer data,
- guint probability,
- const GstCaps * caps);
-
- gpointer data;
-
- /* optional */
- guint64 (* get_length) (gpointer data);
+ const guint8 * (* peek) (gpointer data,
+ gint64 offset,
+ guint size);
- /* <private> */
- gpointer _gst_reserved[GST_PADDING];
-};
+ void (* suggest) (gpointer data,
+ guint probability,
+ GstCaps *caps);
-struct _GstTypeFindFactory {
- GstPluginFeature feature;
- /* <private> */
+ gpointer data;
+
+ /* optional */
+ guint64 (* get_length) (gpointer data);
- GstTypeFindFunction function;
- gchar ** extensions;
- GstCaps * caps; /* FIXME: not yet saved in registry */
-
- gpointer user_data;
-
- gpointer _gst_reserved[GST_PADDING];
-};
-
-struct _GstTypeFindFactoryClass {
- GstPluginFeatureClass parent;
/* <private> */
-
gpointer _gst_reserved[GST_PADDING];
};
-/* typefind function interface */
-guint8 * gst_type_find_peek (GstTypeFind * find,
- gint64 offset,
- guint size);
-void gst_type_find_suggest (GstTypeFind * find,
- guint probability,
- const GstCaps * caps);
-guint64 gst_type_find_get_length (GstTypeFind * find);
-
-/* registration interface */
-gboolean gst_type_find_register (GstPlugin * plugin,
- const gchar * name,
- guint rank,
- GstTypeFindFunction func,
- gchar ** extensions,
- const GstCaps * possible_caps,
- gpointer data);
+GST_API
+GType gst_type_find_get_type (void);
-/* typefinding interface */
+/* typefind function interface */
-GType gst_type_find_factory_get_type (void);
-
-GList * gst_type_find_factory_get_list (void);
+GST_API
+const guint8 * gst_type_find_peek (GstTypeFind * find,
+ gint64 offset,
+ guint size);
+GST_API
+void gst_type_find_suggest (GstTypeFind * find,
+ guint probability,
+ GstCaps * caps);
+GST_API
+void gst_type_find_suggest_simple (GstTypeFind * find,
+ guint probability,
+ const char * media_type,
+ const char * fieldname, ...);
+GST_API
+guint64 gst_type_find_get_length (GstTypeFind * find);
-gchar ** gst_type_find_factory_get_extensions (const GstTypeFindFactory *factory);
-const GstCaps * gst_type_find_factory_get_caps (const GstTypeFindFactory *factory);
-void gst_type_find_factory_call_function (const GstTypeFindFactory *factory,
- GstTypeFind *find);
+/* registration interface */
+GST_API
+gboolean gst_type_find_register (GstPlugin * plugin,
+ const gchar * name,
+ guint rank,
+ GstTypeFindFunction func,
+ const gchar * extensions,
+ GstCaps * possible_caps,
+ gpointer data,
+ GDestroyNotify data_notify);
G_END_DECLS
projects / platform / upstream / gstreamer.git / blobdiff