2 * Copyright (C) <2005> Julien Moutte <julien@moutte.net>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #ifndef __GST_XIMAGESINK_H__
21 #define __GST_XIMAGESINK_H__
23 #include <gst/video/gstvideosink.h>
26 #include <sys/types.h>
29 #endif /* HAVE_XSHM */
32 #include <X11/Xutil.h>
35 #include <X11/extensions/XShm.h>
36 #endif /* HAVE_XSHM */
42 #define GST_TYPE_XIMAGESINK \
43 (gst_ximagesink_get_type())
44 #define GST_XIMAGESINK(obj) \
45 (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_XIMAGESINK, GstXImageSink))
46 #define GST_XIMAGESINK_CLASS(klass) \
47 (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_XIMAGESINK, GstXImageSinkClass))
48 #define GST_IS_XIMAGESINK(obj) \
49 (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_XIMAGESINK))
50 #define GST_IS_XIMAGESINK_CLASS(klass) \
51 (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_XIMAGESINK))
53 typedef struct _GstXContext GstXContext;
54 typedef struct _GstXWindow GstXWindow;
56 typedef struct _GstXImageSink GstXImageSink;
57 typedef struct _GstXImageSinkClass GstXImageSinkClass;
59 #include "ximagepool.h"
63 * @disp: the X11 Display of this context
64 * @screen: the default Screen of Display @disp
65 * @screen_num: the Screen number of @screen
66 * @visual: the default Visual of Screen @screen
67 * @root: the root Window of Display @disp
68 * @white: the value of a white pixel on Screen @screen
69 * @black: the value of a black pixel on Screen @screen
70 * @depth: the color depth of Display @disp
71 * @bpp: the number of bits per pixel on Display @disp
72 * @endianness: the endianness of image bytes on Display @disp
73 * @width: the width in pixels of Display @disp
74 * @height: the height in pixels of Display @disp
75 * @widthmm: the width in millimeters of Display @disp
76 * @heightmm: the height in millimeters of Display @disp
77 * @par: the pixel aspect ratio calculated from @width, @widthmm and @height,
79 * @use_xshm: used to known wether of not XShm extension is usable or not even
80 * if the Extension is present
81 * @caps: the #GstCaps that Display @disp can accept
83 * Structure used to store various informations collected/calculated for a
104 gint widthmm, heightmm;
105 GValue *par; /* calculated pixel aspect ratio */
115 * @win: the Window ID of this X11 window
116 * @width: the width in pixels of Window @win
117 * @height: the height in pixels of Window @win
118 * @internal: used to remember if Window @win was created internally or passed
119 * through the #GstXOverlay interface
120 * @gc: the Graphical Context of Window @win
122 * Structure used to store informations about a Window.
134 * @display_name: the name of the Display we want to render to
135 * @xcontext: our instance's #GstXContext
136 * @xwindow: the #GstXWindow we are rendering to
137 * @ximage: internal #GstXImage used to store incoming buffers and render when
138 * not using the buffer_alloc optimization mechanism
139 * @cur_image: a reference to the last #GstXImage that was put to @xwindow. It
140 * is used when Expose events are received to redraw the latest video frame
141 * @event_thread: a thread listening for events on @xwindow and handling them
142 * @running: used to inform @event_thread if it should run/shutdown
143 * @fps_n: the framerate fraction numerator
144 * @fps_d: the framerate fraction denominator
145 * @x_lock: used to protect X calls as we are not using the XLib in threaded
147 * @flow_lock: used to protect data flow routines from external calls such as
148 * events from @event_thread or methods from the #GstXOverlay interface
149 * @par: used to override calculated pixel aspect ratio from @xcontext
150 * @pool_lock: used to protect the buffer pool
151 * @buffer_pool: a list of #GstXImageBuffer that could be reused at next buffer
153 * @synchronous: used to store if XSynchronous should be used or not (for
154 * debugging purpose only)
155 * @keep_aspect: used to remember if reverse negotiation scaling should respect
157 * @handle_events: used to know if we should handle select XEvents or not
159 * The #GstXImageSink data structure.
161 struct _GstXImageSink
163 /* Our element stuff */
164 GstVideoSink videosink;
168 GstXContext *xcontext;
170 GstBuffer *cur_image;
172 GThread *event_thread;
175 /* Framerate numerator and denominator */
182 /* object-set pixel aspect ratio */
185 /* the buffer pool */
188 gboolean synchronous;
189 gboolean keep_aspect;
190 gboolean handle_events;
191 gboolean handle_expose;
192 gboolean draw_border;
194 /* stream metadata */
198 struct _GstXImageSinkClass
200 GstVideoSinkClass parent_class;
203 GType gst_ximagesink_get_type (void);
206 #endif /* __GST_XIMAGESINK_H__ */