8 #include "gsttextoverlay.h"
9 /*#include "gsttexttestsrc.h"*/
10 /*#include "gstsubparse.h"*/
11 /*#include "SDL_blit.h"*/
13 static GstElementDetails textoverlay_details = {
15 "Filter/Editor/Video",
16 "Adds text strings on top of a video buffer",
17 "Gustavo J. A. M. Carneiro <gjc@inescporto.pt>"
31 static GstStaticPadTemplate textoverlay_src_template_factory =
32 GST_STATIC_PAD_TEMPLATE (
36 GST_STATIC_CAPS ("video/x-raw-yuv, "
37 "format = (fourcc) I420, "
38 "width = (int) [ 1, MAX ], "
39 "height = (int) [ 1, MAX ]")
42 static GstStaticPadTemplate video_sink_template_factory =
43 GST_STATIC_PAD_TEMPLATE (
47 GST_STATIC_CAPS ("video/x-raw-yuv, "
48 "format = (fourcc) I420, "
49 "width = (int) [ 1, MAX ], "
50 "height = (int) [ 1, MAX ]")
53 static GstStaticPadTemplate text_sink_template_factory =
54 GST_STATIC_PAD_TEMPLATE (
58 GST_STATIC_CAPS ("text/x-pango-markup; text/plain")
61 static void gst_textoverlay_base_init (gpointer g_class);
62 static void gst_textoverlay_class_init(GstTextOverlayClass *klass);
63 static void gst_textoverlay_init(GstTextOverlay *overlay);
64 static void gst_textoverlay_set_property(GObject *object,
68 static void gst_textoverlay_get_property(GObject *object,
72 static GstElementStateReturn gst_textoverlay_change_state(GstElement *element);
73 static void gst_textoverlay_finalize(GObject *object);
76 static GstElementClass *parent_class = NULL;
77 /*static guint gst_textoverlay_signals[LAST_SIGNAL] = { 0 }; */
81 gst_textoverlay_get_type(void)
83 static GType textoverlay_type = 0;
85 if (!textoverlay_type) {
86 static const GTypeInfo textoverlay_info = {
87 sizeof(GstTextOverlayClass),
88 gst_textoverlay_base_init,
90 (GClassInitFunc)gst_textoverlay_class_init,
93 sizeof(GstTextOverlay),
95 (GInstanceInitFunc)gst_textoverlay_init,
97 textoverlay_type = g_type_register_static(GST_TYPE_ELEMENT, "GstTextOverlay",
98 &textoverlay_info, 0);
100 return textoverlay_type;
104 gst_textoverlay_base_init (gpointer g_class)
106 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
108 gst_element_class_add_pad_template (element_class,
109 gst_static_pad_template_get (&textoverlay_src_template_factory));
110 gst_element_class_add_pad_template (element_class,
111 gst_static_pad_template_get (&video_sink_template_factory));
112 gst_element_class_add_pad_template (element_class,
113 gst_static_pad_template_get (&text_sink_template_factory));
115 gst_element_class_set_details (element_class, &textoverlay_details);
119 gst_textoverlay_class_init(GstTextOverlayClass *klass)
121 GObjectClass *gobject_class;
122 GstElementClass *gstelement_class;
124 gobject_class = (GObjectClass*)klass;
125 gstelement_class = (GstElementClass*)klass;
127 parent_class = g_type_class_peek_parent(klass);
129 gobject_class->finalize = gst_textoverlay_finalize;
130 gobject_class->set_property = gst_textoverlay_set_property;
131 gobject_class->get_property = gst_textoverlay_get_property;
133 gstelement_class->change_state = gst_textoverlay_change_state;
134 klass->pango_context = pango_ft2_get_context(72, 72);
135 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_TEXT,
136 g_param_spec_string("text", "text",
137 "Text to be display,"
138 " in pango markup format.",
139 "", G_PARAM_WRITABLE));
140 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_VALIGN,
141 g_param_spec_string("valign", "vertical alignment",
142 "Vertical alignment of the text. "
143 "Can be either 'baseline', 'bottom', or 'top'",
144 "baseline", G_PARAM_WRITABLE));
145 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_HALIGN,
146 g_param_spec_string("halign", "horizontal alignment",
147 "Horizontal alignment of the text. "
148 "Can be either 'left', 'right', or 'center'",
149 "center", G_PARAM_WRITABLE));
150 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_X0,
151 g_param_spec_int("x0", "X position",
152 "Initial X position."
153 " Horizontal aligment takes this point"
155 G_MININT, G_MAXINT, 0, G_PARAM_WRITABLE));
156 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_Y0,
157 g_param_spec_int("y0", "Y position",
158 "Initial Y position."
159 " Vertical aligment takes this point"
161 G_MININT, G_MAXINT, 0, G_PARAM_WRITABLE));
162 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FONT_DESC,
163 g_param_spec_string("font-desc", "font description",
164 "Pango font description of font "
165 "to be used for rendering. "
166 "See documentation of "
167 "pango_font_description_from_string"
169 "", G_PARAM_WRITABLE));
174 resize_bitmap(GstTextOverlay *overlay, int width, int height)
176 FT_Bitmap *bitmap = &overlay->bitmap;
177 int pitch = (width|3) + 1;
178 int size = pitch*height;
180 /* no need to keep reallocating; just keep the maximum size so far */
181 if (size <= overlay->bitmap_buffer_size) {
182 bitmap->rows = height;
183 bitmap->width = width;
184 bitmap->pitch = pitch;
185 memset(bitmap->buffer, 0, overlay->bitmap_buffer_size);
188 if (!bitmap->buffer) {
190 bitmap->pixel_mode = ft_pixel_mode_grays;
191 bitmap->num_grays = 256;
194 bitmap->buffer = g_realloc(bitmap->buffer, size);
196 bitmap->buffer = g_malloc(size);
197 bitmap->rows = height;
198 bitmap->width = width;
199 bitmap->pitch = pitch;
200 memset(bitmap->buffer, 0, size);
201 overlay->bitmap_buffer_size = size;
205 render_text(GstTextOverlay *overlay)
207 PangoRectangle ink_rect, logical_rect;
209 pango_layout_get_pixel_extents(overlay->layout, &ink_rect, &logical_rect);
210 resize_bitmap(overlay, ink_rect.width, ink_rect.height + ink_rect.y);
211 pango_ft2_render_layout(&overlay->bitmap, overlay->layout, 0, 0);
212 overlay->baseline_y = ink_rect.y;
215 /* static GstPadLinkReturn */
216 /* gst_textoverlay_text_sinkconnect (GstPad *pad, GstCaps *caps) */
218 /* return GST_PAD_LINK_DONE; */
222 static GstPadLinkReturn
223 gst_textoverlay_video_sinkconnect(GstPad *pad, const GstCaps *caps)
225 GstTextOverlay *overlay;
226 GstStructure *structure;
228 overlay = GST_TEXTOVERLAY(gst_pad_get_parent(pad));
230 structure = gst_caps_get_structure (caps, 0);
231 overlay->width = overlay->height = 0;
232 gst_structure_get_int (structure, "width", &overlay->width);
233 gst_structure_get_int (structure, "height", &overlay->height);
235 return gst_pad_try_set_caps(overlay->srcpad, caps);
240 gst_text_overlay_blit_yuv420(GstTextOverlay *overlay, FT_Bitmap *bitmap,
241 guchar *pixbuf, int x0, int y0)
243 int y; /* text bitmap coordinates */
244 int x1, y1; /* video buffer coordinates */
245 int rowinc, bit_rowinc, uv_rowinc;
246 guchar *p, *bitp, *u_p;
247 int video_width = overlay->width, video_height = overlay->height;
248 int bitmap_x0 = x0 < 1? -(x0 - 1) : 1; /* 1 pixel border */
249 int bitmap_y0 = y0 < 1? -(y0 - 1) : 1; /* 1 pixel border */
250 int bitmap_width = bitmap->width - bitmap_x0;
251 int bitmap_height = bitmap->rows - bitmap_y0;
256 if (x0 + bitmap_x0 + bitmap_width > video_width - 1) /* 1 pixel border */
257 bitmap_width -= x0 + bitmap_x0 + bitmap_width - video_width + 1;
258 if (y0 + bitmap_y0 + bitmap_height > video_height - 1) /* 1 pixel border */
259 bitmap_height -= y0 + bitmap_y0 + bitmap_height - video_height + 1;
261 rowinc = video_width - bitmap_width;
262 uv_rowinc = video_width / 2 - bitmap_width / 2;
263 bit_rowinc = bitmap->pitch - bitmap_width;
264 u_plane_size = (video_width / 2)*(video_height / 2);
268 p = pixbuf + video_width*y1 + x1;
269 bitp = bitmap->buffer + bitmap->pitch*bitmap_y0 + bitmap_x0;
270 for (y = bitmap_y0; y < bitmap_height; y++){
272 for(n=bitmap_width; n>0; --n){
275 p[-1] = CLAMP(p[-1] - v, 0, 255);
276 p[ 1] = CLAMP(p[ 1] - v, 0, 255);
277 p[-video_width] = CLAMP(p[-video_width] - v, 0, 255);
278 p[ video_width] = CLAMP(p[ video_width] - v, 0, 255);
290 bitp = bitmap->buffer + bitmap->pitch*bitmap_y0 + bitmap_x0;
291 p = pixbuf + video_width*y1 + x1;
292 u_p = pixbuf + video_width*video_height + (video_width >> 1)*(y1 >> 1) + (x1 >> 1);
296 for ( ; y < bitmap_height; y++){
300 for(n = bitmap_width; n>0; --n){
305 u_p[0] = u_p[u_plane_size] = 0x80;
315 /*if (!skip_x && !skip_y) u_p--; */
319 u_p += skip_y? uv_rowinc : 0;
325 gst_textoverlay_video_chain(GstPad *pad, GstData *_data)
327 GstBuffer *buf = GST_BUFFER (_data);
328 GstTextOverlay *overlay;
332 g_return_if_fail(pad != NULL);
333 g_return_if_fail(GST_IS_PAD(pad));
334 g_return_if_fail(buf != NULL);
335 overlay = GST_TEXTOVERLAY(gst_pad_get_parent(pad));
336 g_return_if_fail(overlay != NULL);
337 g_return_if_fail(GST_IS_TEXTOVERLAY(overlay));
339 pixbuf = GST_BUFFER_DATA(buf);
343 switch (overlay->valign)
345 case GST_TEXT_OVERLAY_VALIGN_BOTTOM:
346 y0 += overlay->bitmap.rows;
348 case GST_TEXT_OVERLAY_VALIGN_BASELINE:
349 y0 -= (overlay->bitmap.rows - overlay->baseline_y);
351 case GST_TEXT_OVERLAY_VALIGN_TOP:
355 switch (overlay->halign)
357 case GST_TEXT_OVERLAY_HALIGN_LEFT:
359 case GST_TEXT_OVERLAY_HALIGN_RIGHT:
360 x0 -= overlay->bitmap.width;
362 case GST_TEXT_OVERLAY_HALIGN_CENTER:
363 x0 -= overlay->bitmap.width / 2;
367 if (overlay->bitmap.buffer)
368 gst_text_overlay_blit_yuv420(overlay, &overlay->bitmap, pixbuf, x0, y0);
370 gst_pad_push(overlay->srcpad, GST_DATA (buf));
373 #define PAST_END(buffer, time) \
374 (GST_BUFFER_TIMESTAMP (buffer) != GST_CLOCK_TIME_NONE && \
375 GST_BUFFER_DURATION (buffer) != GST_CLOCK_TIME_NONE && \
376 GST_BUFFER_TIMESTAMP (buffer) + GST_BUFFER_DURATION (buffer) \
380 gst_textoverlay_loop(GstElement *element)
382 GstTextOverlay *overlay;
383 GstBuffer *video_frame;
386 g_return_if_fail(element != NULL);
387 g_return_if_fail(GST_IS_TEXTOVERLAY(element));
388 overlay = GST_TEXTOVERLAY(element);
390 video_frame = GST_BUFFER (gst_pad_pull(overlay->video_sinkpad));
391 now = GST_BUFFER_TIMESTAMP(video_frame);
394 * This state machine has a bug that can't be resolved easily.
395 * (Needs a more complicated state machine.) Basically, if the
396 * text that came from a buffer from the sink pad is being
397 * displayed, and the default text is changed by set_parameter,
398 * we'll incorrectly display the default text.
400 * Otherwise, this is a pretty decent state machine that handles
401 * buffer timestamps and durations correctly. (I think)
404 while (overlay->next_buffer == NULL){
405 GST_DEBUG("attempting to pull a buffer");
407 /* read all text buffers until we get one "in the future" */
408 if(!GST_PAD_IS_USABLE(overlay->text_sinkpad)){
411 overlay->next_buffer = GST_BUFFER (gst_pad_pull(overlay->text_sinkpad));
412 if (!overlay->next_buffer)
415 if (PAST_END(overlay->next_buffer, now)){
416 gst_buffer_unref(overlay->next_buffer);
417 overlay->next_buffer = NULL;
421 if (overlay->next_buffer &&
422 (GST_BUFFER_TIMESTAMP(overlay->next_buffer) <= now ||
423 GST_BUFFER_TIMESTAMP(overlay->next_buffer) == GST_CLOCK_TIME_NONE)){
424 GST_DEBUG("using new buffer");
426 if (overlay->current_buffer){
427 gst_buffer_unref (overlay->current_buffer);
429 overlay->current_buffer = overlay->next_buffer;
430 overlay->next_buffer = NULL;
432 GST_DEBUG ( "rendering '%*s'",
433 GST_BUFFER_SIZE(overlay->current_buffer),
434 GST_BUFFER_DATA(overlay->current_buffer));
435 pango_layout_set_markup(overlay->layout,
436 GST_BUFFER_DATA(overlay->current_buffer),
437 GST_BUFFER_SIZE(overlay->current_buffer));
438 render_text(overlay);
439 overlay->need_render = FALSE;
442 if (overlay->current_buffer && PAST_END(overlay->current_buffer, now)){
443 GST_DEBUG("dropping old buffer");
445 gst_buffer_unref(overlay->current_buffer);
446 overlay->current_buffer = NULL;
448 overlay->need_render = TRUE;
451 if(overlay->need_render){
452 GST_DEBUG ( "rendering '%s'", overlay->default_text);
453 pango_layout_set_markup(overlay->layout,
454 overlay->default_text, strlen(overlay->default_text));
455 render_text(overlay);
457 overlay->need_render = FALSE;
460 gst_textoverlay_video_chain(overlay->srcpad, GST_DATA (video_frame));
464 static GstElementStateReturn
465 gst_textoverlay_change_state(GstElement *element)
467 GstTextOverlay *overlay;
469 overlay = GST_TEXTOVERLAY(element);
471 switch (GST_STATE_TRANSITION(element))
473 case GST_STATE_PAUSED_TO_PLAYING:
475 case GST_STATE_PLAYING_TO_PAUSED:
477 case GST_STATE_PAUSED_TO_READY:
481 parent_class->change_state(element);
483 return GST_STATE_SUCCESS;
487 gst_textoverlay_finalize(GObject *object)
489 GstTextOverlay *overlay = GST_TEXTOVERLAY(object);
491 if (overlay->layout) {
492 g_object_unref(overlay->layout);
493 overlay->layout = NULL;
495 if (overlay->bitmap.buffer) {
496 g_free(overlay->bitmap.buffer);
497 overlay->bitmap.buffer = NULL;
500 G_OBJECT_CLASS(parent_class)->finalize(object);
504 gst_textoverlay_init(GstTextOverlay *overlay)
507 overlay->video_sinkpad = gst_pad_new_from_template(
508 gst_static_pad_template_get (&video_sink_template_factory), "video_sink");
509 /* gst_pad_set_chain_function(overlay->video_sinkpad, gst_textoverlay_video_chain); */
510 gst_pad_set_link_function(overlay->video_sinkpad, gst_textoverlay_video_sinkconnect);
511 gst_element_add_pad(GST_ELEMENT(overlay), overlay->video_sinkpad);
514 overlay->text_sinkpad = gst_pad_new_from_template(
515 gst_static_pad_template_get (&text_sink_template_factory), "text_sink");
516 /* gst_pad_set_link_function(overlay->text_sinkpad, gst_textoverlay_text_sinkconnect); */
517 gst_element_add_pad(GST_ELEMENT(overlay), overlay->text_sinkpad);
520 overlay->srcpad = gst_pad_new_from_template(
521 gst_static_pad_template_get (&textoverlay_src_template_factory), "src");
522 gst_element_add_pad(GST_ELEMENT(overlay), overlay->srcpad);
524 overlay->layout = pango_layout_new(GST_TEXTOVERLAY_GET_CLASS(overlay)->pango_context);
525 memset(&overlay->bitmap, 0, sizeof(overlay->bitmap));
527 overlay->halign = GST_TEXT_OVERLAY_HALIGN_CENTER;
528 overlay->valign = GST_TEXT_OVERLAY_VALIGN_BASELINE;
529 overlay->x0 = overlay->y0 = 0;
531 overlay->default_text = g_strdup("");
532 overlay->need_render = TRUE;
534 gst_element_set_loop_function(GST_ELEMENT(overlay), gst_textoverlay_loop);
539 gst_textoverlay_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
541 GstTextOverlay *overlay;
543 /* it's not null if we got it, but it might not be ours */
544 g_return_if_fail(GST_IS_TEXTOVERLAY(object));
545 overlay = GST_TEXTOVERLAY(object);
551 if(overlay->default_text){
552 g_free(overlay->default_text);
554 overlay->default_text = g_strdup(g_value_get_string(value));
555 overlay->need_render = TRUE;
559 if (strcasecmp(g_value_get_string(value), "baseline") == 0)
560 overlay->valign = GST_TEXT_OVERLAY_VALIGN_BASELINE;
561 else if (strcasecmp(g_value_get_string(value), "bottom") == 0)
562 overlay->valign = GST_TEXT_OVERLAY_VALIGN_BOTTOM;
563 else if (strcasecmp(g_value_get_string(value), "top") == 0)
564 overlay->valign = GST_TEXT_OVERLAY_VALIGN_TOP;
566 g_warning("Invalid 'valign' property value: %s",
567 g_value_get_string(value));
571 if (strcasecmp(g_value_get_string(value), "left") == 0)
572 overlay->halign = GST_TEXT_OVERLAY_HALIGN_LEFT;
573 else if (strcasecmp(g_value_get_string(value), "right") == 0)
574 overlay->halign = GST_TEXT_OVERLAY_HALIGN_RIGHT;
575 else if (strcasecmp(g_value_get_string(value), "center") == 0)
576 overlay->halign = GST_TEXT_OVERLAY_HALIGN_CENTER;
578 g_warning("Invalid 'halign' property value: %s",
579 g_value_get_string(value));
583 overlay->x0 = g_value_get_int(value);
587 overlay->y0 = g_value_get_int(value);
592 PangoFontDescription *desc;
593 desc = pango_font_description_from_string(g_value_get_string(value));
595 g_message("font description set: %s", g_value_get_string(value));
596 pango_layout_set_font_description(overlay->layout, desc);
597 pango_font_description_free(desc);
598 render_text(overlay);
600 g_warning("font description parse failed: %s", g_value_get_string(value));
610 gst_textoverlay_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
612 GstTextOverlay *overlay;
614 /* it's not null if we got it, but it might not be ours */
615 g_return_if_fail(GST_IS_TEXTOVERLAY(object));
616 overlay = GST_TEXTOVERLAY(object);
620 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
626 plugin_init(GstPlugin *plugin)
628 if (!gst_element_register (plugin, "textoverlay", GST_RANK_PRIMARY, GST_TYPE_TEXTOVERLAY))
631 /*texttestsrc_plugin_init(module, plugin);*/
632 /*subparse_plugin_init(module, plugin);*/