]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - glsdk/gstreamer0-10.git/blob - gst/gsttypefindfactory.h
gststructure: clarify _get docs about the returned reference
[glsdk/gstreamer0-10.git] / gst / gsttypefindfactory.h
1 /* GStreamer
2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
3  *
4  * gsttypefindfactory.h: typefinding subsystem
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
22 #ifndef __GST_TYPE_FIND_FACTORY_H__
23 #define __GST_TYPE_FIND_FACTORY_H__
25 #include <gst/gstcaps.h>
26 #include <gst/gstplugin.h>
27 #include <gst/gstpluginfeature.h>
28 #include <gst/gsttypefind.h>
30 G_BEGIN_DECLS
32 #define GST_TYPE_TYPE_FIND_FACTORY                 (gst_type_find_factory_get_type())
33 #define GST_TYPE_FIND_FACTORY(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactory))
34 #define GST_IS_TYPE_FIND_FACTORY(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_TYPE_FIND_FACTORY))
35 #define GST_TYPE_FIND_FACTORY_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactoryClass))
36 #define GST_IS_TYPE_FIND_FACTORY_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_TYPE_FIND_FACTORY))
37 #define GST_TYPE_FIND_FACTORY_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactoryClass))
39 typedef struct _GstTypeFindFactory GstTypeFindFactory;
40 typedef struct _GstTypeFindFactoryClass GstTypeFindFactoryClass;
42 /**
43  * GstTypeFindFactory:
44  *
45  * Object that stores information about a typefind function.
46  */
47 struct _GstTypeFindFactory {
48   GstPluginFeature              feature;
49   /* <private> */
51   GstTypeFindFunction           function;
52   gchar **                      extensions;
53   GstCaps *                     caps; /* FIXME: not yet saved in registry */
55   gpointer                      user_data;
56   GDestroyNotify                user_data_notify;
58   gpointer _gst_reserved[GST_PADDING];
59 };
61 struct _GstTypeFindFactoryClass {
62   GstPluginFeatureClass         parent;
63   /* <private> */
65   gpointer _gst_reserved[GST_PADDING];
66 };
68 /* typefinding interface */
70 GType           gst_type_find_factory_get_type          (void);
72 GList *         gst_type_find_factory_get_list          (void);
74 gchar **        gst_type_find_factory_get_extensions    (GstTypeFindFactory *factory);
75 GstCaps *       gst_type_find_factory_get_caps          (GstTypeFindFactory *factory);
76 void            gst_type_find_factory_call_function     (GstTypeFindFactory *factory,
77                                                          GstTypeFind *find);
79 G_END_DECLS
81 #endif /* __GST_TYPE_FIND_FACTORY_H__ */