2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * <2005> Wim Taymans <wim@fluendo.com>
5 * gsttask.h: Streaming tasks
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_TASK_H__
24 #define __GST_TASK_H__
26 #include <gst/gstobject.h>
30 typedef void (*GstTaskFunction) (void *data);
32 /* --- standard type macros --- */
33 #define GST_TYPE_TASK (gst_task_get_type ())
34 #define GST_TASK(task) (G_TYPE_CHECK_INSTANCE_CAST ((task), GST_TYPE_TASK, GstTask))
35 #define GST_IS_TASK(task) (G_TYPE_CHECK_INSTANCE_TYPE ((task), GST_TYPE_TASK))
36 #define GST_TASK_CLASS(tclass) (G_TYPE_CHECK_CLASS_CAST ((tclass), GST_TYPE_TASK, GstTaskClass))
37 #define GST_IS_TASK_CLASS(tclass) (G_TYPE_CHECK_CLASS_TYPE ((tclass), GST_TYPE_TASK))
38 #define GST_TASK_GET_CLASS(task) (G_TYPE_INSTANCE_GET_CLASS ((task), GST_TYPE_TASK, GstTaskClass))
39 #define GST_TASK_CAST(task) ((GstTask*)(task))
41 typedef struct _GstTask GstTask;
42 typedef struct _GstTaskClass GstTaskClass;
46 * @GST_TASK_STARTED: the task is started and running
47 * @GST_TASK_STOPPED: the task is stopped
48 * @GST_TASK_PAUSED: the task is paused
50 * The different states a task can be in
60 * @task: Task to get the state of
62 * Get access to the state of the task.
64 #define GST_TASK_STATE(task) (GST_TASK_CAST(task)->state)
66 #define GST_TASK_GET_COND(task) (GST_TASK_CAST(task)->cond)
67 #define GST_TASK_WAIT(task) g_cond_wait(GST_TASK_GET_COND (task), GST_GET_LOCK (task))
68 #define GST_TASK_SIGNAL(task) g_cond_signal(GST_TASK_GET_COND (task))
69 #define GST_TASK_BROADCAST(task) g_cond_breadcast(GST_TASK_GET_COND (task))
71 #define GST_TASK_GET_LOCK(task) (GST_TASK_CAST(task)->lock)
75 * @state: the state of the task
76 * @cond: used to pause/resume the task
77 * @lock: The lock taken when iterating the taskfunction
78 * @func: the function executed by this task
79 * @data: data passed to the task function
80 * @running: a flag indicating that the task is running.
87 /*< public >*/ /* with LOCK */
91 GStaticRecMutex *lock;
99 gpointer _gst_reserved[GST_PADDING];
102 struct _GstTaskClass {
103 GstObjectClass parent_class;
109 gpointer _gst_reserved[GST_PADDING];
112 void gst_task_cleanup_all (void);
114 GType gst_task_get_type (void);
116 GstTask* gst_task_create (GstTaskFunction func, gpointer data);
117 void gst_task_set_lock (GstTask *task, GStaticRecMutex *mutex);
119 GstTaskState gst_task_get_state (GstTask *task);
121 gboolean gst_task_start (GstTask *task);
122 gboolean gst_task_stop (GstTask *task);
123 gboolean gst_task_pause (GstTask *task);
125 gboolean gst_task_join (GstTask *task);
129 #endif /* __GST_TASK_H__ */