textoverlay: add stride support
[gstreamer-omap:gst-plugins-base.git] / ext / pango / gsttextoverlay.h
1 #ifndef __GST_TEXT_OVERLAY_H__
2 #define __GST_TEXT_OVERLAY_H__
3
4 #include <gst/gst.h>
5 #include <gst/video/video.h>
6 #include <gst/controller/gstcontroller.h>
7 #include <pango/pangocairo.h>
8
9 G_BEGIN_DECLS
10
11 #define GST_TYPE_TEXT_OVERLAY            (gst_text_overlay_get_type())
12 #define GST_TEXT_OVERLAY(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),\
13                                          GST_TYPE_TEXT_OVERLAY, GstTextOverlay))
14 #define GST_TEXT_OVERLAY_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),\
15                                          GST_TYPE_TEXT_OVERLAY,GstTextOverlayClass))
16 #define GST_TEXT_OVERLAY_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),\
17                                          GST_TYPE_TEXT_OVERLAY, GstTextOverlayClass))
18 #define GST_IS_TEXT_OVERLAY(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),\
19                                          GST_TYPE_TEXT_OVERLAY))
20 #define GST_IS_TEXT_OVERLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),\
21                                          GST_TYPE_TEXT_OVERLAY))
22
23 typedef struct _GstTextOverlay      GstTextOverlay;
24 typedef struct _GstTextOverlayClass GstTextOverlayClass;
25
26 /**
27  * GstTextOverlayVAlign:
28  * @GST_TEXT_OVERLAY_VALIGN_BASELINE: draw text on the baseline
29  * @GST_TEXT_OVERLAY_VALIGN_BOTTOM: draw text on the bottom
30  * @GST_TEXT_OVERLAY_VALIGN_TOP: draw text on top
31  * @GST_TEXT_OVERLAY_VALIGN_POS: draw text according to the #GstTextOverlay:ypos property
32  * @GST_TEXT_OVERLAY_VALIGN_CENTER: draw text vertically centered
33  *
34  * Vertical alignment of the text.
35  */
36 typedef enum {
37     GST_TEXT_OVERLAY_VALIGN_BASELINE,
38     GST_TEXT_OVERLAY_VALIGN_BOTTOM,
39     GST_TEXT_OVERLAY_VALIGN_TOP,
40     GST_TEXT_OVERLAY_VALIGN_POS,
41     GST_TEXT_OVERLAY_VALIGN_CENTER
42 } GstTextOverlayVAlign;
43
44 /**
45  * GstTextOverlayHAlign:
46  * @GST_TEXT_OVERLAY_HALIGN_LEFT: align text left
47  * @GST_TEXT_OVERLAY_HALIGN_CENTER: align text center
48  * @GST_TEXT_OVERLAY_HALIGN_RIGHT: align text right
49  * @GST_TEXT_OVERLAY_HALIGN_POS: position text according to the #GstTextOverlay:xpos property
50  *
51  * Horizontal alignment of the text.
52  */
53 /* FIXME 0.11: remove GST_TEXT_OVERLAY_HALIGN_UNUSED */
54 typedef enum {
55     GST_TEXT_OVERLAY_HALIGN_LEFT,
56     GST_TEXT_OVERLAY_HALIGN_CENTER,
57     GST_TEXT_OVERLAY_HALIGN_RIGHT,
58     GST_TEXT_OVERLAY_HALIGN_UNUSED,
59     GST_TEXT_OVERLAY_HALIGN_POS
60 } GstTextOverlayHAlign;
61
62 /**
63  * GstTextOverlayWrapMode:
64  * @GST_TEXT_OVERLAY_WRAP_MODE_NONE: no wrapping
65  * @GST_TEXT_OVERLAY_WRAP_MODE_WORD: do word wrapping
66  * @GST_TEXT_OVERLAY_WRAP_MODE_CHAR: do char wrapping
67  * @GST_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR: do word and char wrapping
68  *
69  * Whether to wrap the text and if so how.
70  */
71 typedef enum {
72     GST_TEXT_OVERLAY_WRAP_MODE_NONE = -1,
73     GST_TEXT_OVERLAY_WRAP_MODE_WORD = PANGO_WRAP_WORD,
74     GST_TEXT_OVERLAY_WRAP_MODE_CHAR = PANGO_WRAP_CHAR,
75     GST_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR = PANGO_WRAP_WORD_CHAR
76 } GstTextOverlayWrapMode;
77
78 /**
79  * GstTextOverlayLineAlign:
80  * @GST_TEXT_OVERLAY_LINE_ALIGN_LEFT: lines are left-aligned
81  * @GST_TEXT_OVERLAY_LINE_ALIGN_CENTER: lines are center-aligned
82  * @GST_TEXT_OVERLAY_LINE_ALIGN_RIGHT: lines are right-aligned
83  *
84  * Alignment of text lines relative to each other
85  */
86 typedef enum {
87     GST_TEXT_OVERLAY_LINE_ALIGN_LEFT = PANGO_ALIGN_LEFT,
88     GST_TEXT_OVERLAY_LINE_ALIGN_CENTER = PANGO_ALIGN_CENTER,
89     GST_TEXT_OVERLAY_LINE_ALIGN_RIGHT = PANGO_ALIGN_RIGHT
90 } GstTextOverlayLineAlign;
91
92 /**
93  * GstTextOverlay:
94  *
95  * Opaque textoverlay object structure
96  */
97 struct _GstTextOverlay {
98     GstElement               element;
99
100     GstPad                  *video_sinkpad;
101     GstPad                  *text_sinkpad;
102     GstPad                  *srcpad;
103
104     GstSegment               segment;
105     GstSegment               text_segment;
106     GstBuffer               *text_buffer;
107     gboolean                text_linked;
108     gboolean                video_flushing;
109     gboolean                video_eos;
110     gboolean                text_flushing;
111     gboolean                text_eos;
112
113     GCond                   *cond;  /* to signal removal of a queued text
114                                      * buffer, arrival of a text buffer,
115                                      * a text segment update, or a change
116                                      * in status (e.g. shutdown, flushing) */
117
118     gint                     width;
119     gint                     height;
120     gint                     rowstride;
121     gint                     fps_n;
122     gint                     fps_d;
123     GstVideoFormat           format;
124
125     GstTextOverlayVAlign     valign;
126     GstTextOverlayHAlign     halign;
127     GstTextOverlayWrapMode   wrap_mode;
128     GstTextOverlayLineAlign  line_align;
129
130     gint                     xpad;
131     gint                     ypad;
132     gint                     deltax;
133     gint                     deltay;
134     gdouble                  xpos;
135     gdouble                  ypos;
136     gchar                   *default_text;
137     gboolean                 want_shading;
138     gboolean                 silent;
139     gboolean                 wait_text;
140     guint                    color;
141
142     PangoLayout             *layout;
143     gdouble                  shadow_offset;
144     gdouble                  outline_offset;
145     guchar                  *text_image;
146     gint                     image_width;
147     gint                     image_height;
148     gint                     baseline_y;
149
150     gboolean                 auto_adjust_size;
151     gboolean                 need_render;
152
153     gint                     shading_value;  /* for timeoverlay subclass */
154
155     gboolean                 have_pango_markup;
156     gboolean                 use_vertical_render;
157 };
158
159 struct _GstTextOverlayClass {
160     GstElementClass parent_class;
161
162     PangoContext *pango_context;
163     GMutex       *pango_lock;
164
165     gchar *     (*get_text) (GstTextOverlay *overlay, GstBuffer *video_frame);
166 };
167
168 GType gst_text_overlay_get_type(void) G_GNUC_CONST;
169
170 G_END_DECLS
171
172 #endif /* __GST_TEXT_OVERLAY_H */