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., 51 Franklin St, Fifth Floor, 19 * Boston, MA 02110-1301, USA. 20 */ 21 22 #ifndef __GST_TASK_POOL_H__ 23 #define __GST_TASK_POOL_H__ 24 25 #include <gst/gstobject.h> 26 27 G_BEGIN_DECLS 28 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)) 37 38 typedef struct _GstTaskPool GstTaskPool; 39 typedef struct _GstTaskPoolClass GstTaskPoolClass; 40 41 /** 42 * GstTaskPoolFunction: 43 * @user_data: user data for the task function 44 * 45 * Task function, see gst_task_pool_push(). 46 */ 47 typedef void (*GstTaskPoolFunction) (void *user_data); 48 49 /** 50 * GstTaskPool: 51 * 52 * The #GstTaskPool object. 53 */ 54 struct _GstTaskPool { 55 GstObject object; 56 57 /*< private >*/ 58 GThreadPool *pool; 59 60 gpointer _gst_reserved[GST_PADDING]; 61 }; 62 63 /** 64 * GstTaskPoolClass: 65 * @parent_class: the parent class structure 66 * @prepare: prepare the threadpool 67 * @cleanup: make sure all threads are stopped 68 * @push: start a new thread 69 * @join: join a thread 70 * 71 * The #GstTaskPoolClass object. 72 */ 73 struct _GstTaskPoolClass { 74 GstObjectClass parent_class; 75 76 /*< public >*/ 77 void (*prepare) (GstTaskPool *pool, GError **error); 78 void (*cleanup) (GstTaskPool *pool); 79 80 gpointer (*push) (GstTaskPool *pool, GstTaskPoolFunction func, 81 gpointer user_data, GError **error); 82 void (*join) (GstTaskPool *pool, gpointer id); 83 84 /*< private >*/ 85 gpointer _gst_reserved[GST_PADDING]; 86 }; 87 88 GST_API 89 GType gst_task_pool_get_type (void); 90 91 GST_API 92 GstTaskPool * gst_task_pool_new (void); 93 94 GST_API 95 void gst_task_pool_prepare (GstTaskPool *pool, GError **error); 96 97 GST_API 98 gpointer gst_task_pool_push (GstTaskPool *pool, GstTaskPoolFunction func, 99 gpointer user_data, GError **error); 100 GST_API 101 void gst_task_pool_join (GstTaskPool *pool, gpointer id); 102 103 GST_API 104 void gst_task_pool_cleanup (GstTaskPool *pool); 105 106 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC 107 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstTaskPool, gst_object_unref) 108 #endif 109 110 G_END_DECLS 111 112 #endif /* __GST_TASK_POOL_H__ */ 113