gst/gsttask.h

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *               <2005> Wim Taymans <wim@fluendo.com>
   4  *
   5  * gsttask.h: Streaming tasks
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #ifndef __GST_TASK_H__
  24 #define __GST_TASK_H__
  25
  26 #include <gst/gstobject.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /**
  31  * GstTaskFunction:
  32  * @data: user data passed to the function
  33  *
  34  * A function that will repeatedly be called in the thread created by
  35  * a #GstTask.
  36  */
  37 typedef void         (*GstTaskFunction)          (void *data);
  38
  39 /* --- standard type macros --- */
  40 #define GST_TYPE_TASK                   (gst_task_get_type ())
  41 #define GST_TASK(task)                  (G_TYPE_CHECK_INSTANCE_CAST ((task), GST_TYPE_TASK, GstTask))
  42 #define GST_IS_TASK(task)               (G_TYPE_CHECK_INSTANCE_TYPE ((task), GST_TYPE_TASK))
  43 #define GST_TASK_CLASS(tclass)          (G_TYPE_CHECK_CLASS_CAST ((tclass), GST_TYPE_TASK, GstTaskClass))
  44 #define GST_IS_TASK_CLASS(tclass)       (G_TYPE_CHECK_CLASS_TYPE ((tclass), GST_TYPE_TASK))
  45 #define GST_TASK_GET_CLASS(task)        (G_TYPE_INSTANCE_GET_CLASS ((task), GST_TYPE_TASK, GstTaskClass))
  46 #define GST_TASK_CAST(task)             ((GstTask*)(task))
  47
  48 typedef struct _GstTask GstTask;
  49 typedef struct _GstTaskClass GstTaskClass;
  50 typedef struct _GstTaskPrivate GstTaskPrivate;
  51
  52 /**
  53  * GstTaskState:
  54  * @GST_TASK_STARTED: the task is started and running
  55  * @GST_TASK_STOPPED: the task is stopped
  56  * @GST_TASK_PAUSED: the task is paused
  57  *
  58  * The different states a task can be in
  59  */
  60 typedef enum {
  61   GST_TASK_STARTED,
  62   GST_TASK_STOPPED,
  63   GST_TASK_PAUSED
  64 } GstTaskState;
  65
  66 /**
  67  * GST_TASK_STATE:
  68  * @task: Task to get the state of
  69  *
  70  * Get access to the state of the task.
  71  */
  72 #define GST_TASK_STATE(task)            (GST_TASK_CAST(task)->state)
  73
  74 /**
  75  * GST_TASK_GET_COND:
  76  * @task: Task to get the cond of
  77  *
  78  * Get access to the cond of the task.
  79  */
  80 #define GST_TASK_GET_COND(task)         (GST_TASK_CAST(task)->cond)
  81 /**
  82  * GST_TASK_WAIT:
  83  * @task: Task to wait for
  84  *
  85  * Wait for the task cond to be signalled
  86  */
  87 #define GST_TASK_WAIT(task)             g_cond_wait(GST_TASK_GET_COND (task), GST_OBJECT_GET_LOCK (task))
  88 /**
  89  * GST_TASK_SIGNAL:
  90  * @task: Task to signal
  91  *
  92  * Signal the task cond
  93  */
  94 #define GST_TASK_SIGNAL(task)           g_cond_signal(GST_TASK_GET_COND (task))
  95 /**
  96  * GST_TASK_BROADCAST:
  97  * @task: Task to broadcast
  98  *
  99  * Send a broadcast signal to all waiting task conds
 100  */
 101 #define GST_TASK_BROADCAST(task)        g_cond_breadcast(GST_TASK_GET_COND (task))
 102
 103 /**
 104  * GST_TASK_GET_LOCK:
 105  * @task: Task to get the lock of
 106  *
 107  * Get access to the task lock.
 108  */
 109 #define GST_TASK_GET_LOCK(task)         (GST_TASK_CAST(task)->lock)
 110
 111 /**
 112  * GstTaskThreadCallbacks:
 113  * @enter_thread: a thread is entered, this callback is called when the new
 114  *   thread enters its function.
 115  * @leave_thread: a thread is exiting, this is called when the thread is about
 116  *   to leave its function
 117  *
 118  * Custom GstTask thread callback functions that can be installed.
 119  *
 120  * Since: 0.10.24
 121  */
 122 typedef struct {
 123   /* manage the lifetime of the thread */
 124   void      (*enter_thread)     (GstTask *task, GThread *thread, gpointer user_data);
 125   void      (*leave_thread)     (GstTask *task, GThread *thread, gpointer user_data);
 126   /*< private >*/
 127   gpointer     _gst_reserved[GST_PADDING];
 128 } GstTaskThreadCallbacks;
 129
 130 /**
 131  * GstTask:
 132  * @state: the state of the task
 133  * @cond: used to pause/resume the task
 134  * @lock: The lock taken when iterating the task function
 135  * @func: the function executed by this task
 136  * @data: data passed to the task function
 137  * @running: a flag indicating that the task is running
 138  *
 139  * The #GstTask object.
 140  */
 141 struct _GstTask {
 142   GstObject      object;
 143
 144   /*< public >*/ /* with LOCK */
 145   GstTaskState     state;
 146   GCond           *cond;
 147
 148   GStaticRecMutex *lock;
 149
 150   GstTaskFunction  func;
 151   gpointer         data;
 152
 153   gboolean         running;
 154
 155   /*< private >*/
 156   union {
 157     struct {
 158       /* thread this task is currently running in */
 159       GThread  *thread;
 160     } ABI;
 161     gpointer _gst_reserved[GST_PADDING - 1];
 162   } abidata;
 163
 164   GstTaskPrivate *priv;
 165 };
 166
 167 struct _GstTaskClass {
 168   GstObjectClass parent_class;
 169
 170   /*< private >*/
 171   GThreadPool *pool;
 172
 173   /*< private >*/
 174   gpointer _gst_reserved[GST_PADDING];
 175 };
 176
 177 void            gst_task_cleanup_all    (void);
 178
 179 GType           gst_task_get_type       (void);
 180
 181 GstTask*        gst_task_create         (GstTaskFunction func, gpointer data);
 182 void            gst_task_set_lock       (GstTask *task, GStaticRecMutex *mutex);
 183 void            gst_task_set_priority   (GstTask *task, GThreadPriority priority);
 184
 185 void            gst_task_set_thread_callbacks  (GstTask *task,
 186                                                 GstTaskThreadCallbacks *callbacks,
 187                                                 gpointer user_data,
 188                                                 GDestroyNotify notify);
 189
 190 GstTaskState    gst_task_get_state      (GstTask *task);
 191 gboolean        gst_task_set_state      (GstTask *task, GstTaskState state);
 192
 193 gboolean        gst_task_start          (GstTask *task);
 194 gboolean        gst_task_stop           (GstTask *task);
 195 gboolean        gst_task_pause          (GstTask *task);
 196
 197 gboolean        gst_task_join           (GstTask *task);
 198
 199 G_END_DECLS
 200
 201 #endif /* __GST_TASK_H__ */