Documentation updates
[platform/upstream/gstreamer.git] / gst / gstthread.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstthread.h: Header for GstThread object
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
24 #ifndef __GST_THREAD_H__
25 #define __GST_THREAD_H__
26
27 #include <glib.h>
28
29 #include <gst/gstbin.h>
30
31
32 G_BEGIN_DECLS
33
34 extern GstElementDetails gst_thread_details;
35
36
37 typedef enum {
38   GST_THREAD_STATE_STARTED      = GST_BIN_FLAG_LAST,
39   GST_THREAD_STATE_SPINNING,
40   GST_THREAD_STATE_REAPING,
41
42   /* padding */
43   GST_THREAD_FLAG_LAST          = GST_BIN_FLAG_LAST + 4
44 } GstThreadState;
45
46 #define GST_TYPE_THREAD \
47   (gst_thread_get_type())
48 #define GST_THREAD(obj) \
49   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_THREAD,GstThread))
50 #define GST_THREAD_CLASS(klass) \
51   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_THREAD,GstThreadClass))
52 #define GST_IS_THREAD(obj) \
53   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_THREAD))
54 #define GST_IS_THREAD_CLASS(obj) \
55   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_THREAD))
56
57 typedef struct _GstThread       GstThread;
58 typedef struct _GstThreadClass  GstThreadClass;
59
60 struct _GstThread {
61   GstBin         bin;
62
63   GThread       *thread_id;             /* id of the thread, if any */
64   GThreadPriority priority;
65   gpointer      *stack;
66   guint          stack_size;            /* stack size */
67   gint           pid;                   /* the pid of the thread */
68   gint           ppid;                  /* the pid of the thread's parent process */
69   GMutex        *lock;                  /* thread lock/condititon pair ... */
70   GCond         *cond;                  /* .... used to control the thread */
71
72   gint           transition;            /* the current state transition */
73 };
74
75 struct _GstThreadClass {
76   GstBinClass parent_class;
77
78   /* signals */
79   void  (*shutdown)     (GstThread *thread);
80 };
81
82 GType   gst_thread_get_type     (void);
83
84 GstElement*     gst_thread_new          (const gchar *name);
85
86 void            gst_thread_set_priority (GstThread *thread, GThreadPriority priority);
87
88 G_END_DECLS
89
90
91 #endif /* __GST_THREAD_H__ */     
92