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 typedef void         (*GstTaskFunction)          (void *data);
  31
  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))
  40
  41 typedef struct _GstTask GstTask;
  42 typedef struct _GstTaskClass GstTaskClass;
  43
  44 typedef enum {
  45   GST_TASK_STARTED,
  46   GST_TASK_STOPPED,
  47   GST_TASK_PAUSED,
  48 } GstTaskState;
  49
  50 #define GST_TASK_STATE(task)            (GST_TASK_CAST(task)->state)
  51
  52 #define GST_TASK_GET_COND(task)         (GST_TASK_CAST(task)->cond)
  53 #define GST_TASK_WAIT(task)             g_cond_wait(GST_TASK_GET_COND (task), GST_GET_LOCK (task))
  54 #define GST_TASK_SIGNAL(task)           g_cond_signal(GST_TASK_GET_COND (task))
  55 #define GST_TASK_BROADCAST(task)        g_cond_breadcast(GST_TASK_GET_COND (task))
  56
  57 #define GST_TASK_GET_LOCK(task)         (GST_TASK_CAST(task)->lock)
  58 #define GST_TASK_LOCK(task)             g_static_rec_mutex_lock(GST_TASK_GET_LOCK(task))
  59 #define GST_TASK_UNLOCK(task)           g_static_rec_mutex_unlock(GST_TASK_GET_LOCK(task))
  60
  61 struct _GstTask {
  62   GstObject      object;
  63
  64
  65   /*< public >*/ /* with LOCK */
  66   GstTaskState     state;
  67   GCond           *cond;
  68
  69   GStaticRecMutex *lock;
  70
  71   GstTaskFunction func;
  72   gpointer       data;
  73
  74   /*< private >*/
  75   gpointer _gst_reserved[GST_PADDING];
  76 };
  77
  78 struct _GstTaskClass {
  79   GstObjectClass parent_class;
  80
  81   /*< protected >*/
  82   gboolean (*start) (GstTask *task);
  83   gboolean (*stop)  (GstTask *task);
  84   gboolean (*pause) (GstTask *task);
  85
  86   /*< private >*/
  87   gpointer _gst_reserved[GST_PADDING];
  88 };
  89
  90 GType           gst_task_get_type       (void);
  91
  92 GstTask*        gst_task_create         (GstTaskFunction func, gpointer data);
  93 void            gst_task_set_lock       (GstTask *task, GStaticRecMutex *mutex);
  94
  95 GstTaskState    gst_task_get_state      (GstTask *task);
  96
  97 gboolean        gst_task_start          (GstTask *task);
  98 gboolean        gst_task_stop           (GstTask *task);
  99 gboolean        gst_task_pause          (GstTask *task);
 100
 101 G_END_DECLS
 102
 103 #endif /* __GST_TASK_H__ */
 104