1 /* GStreamer
2 * Copyright (C) <2009> Wim Taymans <wim.taymans@gmail.com>
3 *
4 * gsttaskpool.h: Pool for creating streaming threads
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_TASK_POOL_H__
23 #define __GST_TASK_POOL_H__
25 #include <gst/gstobject.h>
27 G_BEGIN_DECLS
29 /* --- standard type macros --- */
30 #define GST_TYPE_TASK_POOL (gst_task_pool_get_type ())
31 #define GST_TASK_POOL(pool) (G_TYPE_CHECK_INSTANCE_CAST ((pool), GST_TYPE_TASK_POOL, GstTaskPool))
32 #define GST_IS_TASK_POOL(pool) (G_TYPE_CHECK_INSTANCE_TYPE ((pool), GST_TYPE_TASK_POOL))
33 #define GST_TASK_POOL_CLASS(pclass) (G_TYPE_CHECK_CLASS_CAST ((pclass), GST_TYPE_TASK_POOL, GstTaskPoolClass))
34 #define GST_IS_TASK_POOL_CLASS(pclass) (G_TYPE_CHECK_CLASS_TYPE ((pclass), GST_TYPE_TASK_POOL))
35 #define GST_TASK_POOL_GET_CLASS(pool) (G_TYPE_INSTANCE_GET_CLASS ((pool), GST_TYPE_TASK_POOL, GstTaskPoolClass))
36 #define GST_TASK_POOL_CAST(pool) ((GstTaskPool*)(pool))
38 typedef struct _GstTaskPool GstTaskPool;
39 typedef struct _GstTaskPoolClass GstTaskPoolClass;
41 /**
42 * GstTaskPoolFunction:
43 * @data: user data for the task function
44 *
45 * Task function, see gst_task_pool_push().
46 *
47 * Since: 0.10.24
48 */
49 typedef void (*GstTaskPoolFunction) (void *data);
51 /**
52 * GstTaskPool:
53 *
54 * The #GstTaskPool object.
55 */
56 struct _GstTaskPool {
57 GstObject object;
59 /*< private >*/
60 GThreadPool *pool;
62 gpointer _gst_reserved[GST_PADDING];
63 };
65 /**
66 * GstTaskPoolClass:
67 * @parent_class: the parent class structure
68 * @prepare: prepare the threadpool
69 * @cleanup: make sure all threads are stopped
70 * @push: start a new thread
71 * @join: join a thread
72 *
73 * The #GstTaskPoolClass object.
74 */
75 struct _GstTaskPoolClass {
76 GstObjectClass parent_class;
78 /*< public >*/
79 void (*prepare) (GstTaskPool *pool, GError **error);
80 void (*cleanup) (GstTaskPool *pool);
82 gpointer (*push) (GstTaskPool *pool, GstTaskPoolFunction func,
83 gpointer user_data, GError **error);
84 void (*join) (GstTaskPool *pool, gpointer id);
86 /*< private >*/
87 gpointer _gst_reserved[GST_PADDING];
88 };
90 GType gst_task_pool_get_type (void);
92 GstTaskPool * gst_task_pool_new (void);
93 void gst_task_pool_prepare (GstTaskPool *pool, GError **error);
95 gpointer gst_task_pool_push (GstTaskPool *pool, GstTaskPoolFunction func,
96 gpointer user_data, GError **error);
97 void gst_task_pool_join (GstTaskPool *pool, gpointer id);
99 void gst_task_pool_cleanup (GstTaskPool *pool);
101 G_END_DECLS
103 #endif /* __GST_TASK_POOL_H__ */