2 * producer_pango.c -- a pango-based titler
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <framework/mlt_producer.h>
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_geometry.h>
26 #include <gdk-pixbuf/gdk-pixbuf.h>
27 #include <pango/pangoft2.h>
28 #include <freetype/freetype.h>
33 typedef struct producer_pango_s *producer_pango;
42 static pthread_mutex_t pango_mutex = PTHREAD_MUTEX_INITIALIZER;
44 struct producer_pango_s
46 struct mlt_producer_s parent;
60 // special color type used by internal pango routines
66 // Forward declarations
67 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int index );
68 static void producer_close( mlt_producer parent );
69 static void pango_draw_background( GdkPixbuf *pixbuf, rgba_color bg );
70 static GdkPixbuf *pango_get_pixbuf( const char *markup, const char *text, const char *font,
71 rgba_color fg, rgba_color bg, int pad, int align, int weight, int size );
73 /** Return nonzero if the two strings are equal, ignoring case, up to
74 the first n characters.
76 int strncaseeq(const char *s1, const char *s2, size_t n)
80 if (tolower(*s1++) != tolower(*s2++))
86 /** Parse the alignment property.
89 static int alignment_parse( char* align )
91 int ret = pango_align_left;
94 else if ( isdigit( align[ 0 ] ) )
96 else if ( align[ 0 ] == 'c' || align[ 0 ] == 'm' )
97 ret = pango_align_center;
98 else if ( align[ 0 ] == 'r' )
99 ret = pango_align_right;
104 static PangoFT2FontMap *fontmap = NULL;
106 mlt_producer producer_pango_init( const char *filename )
108 producer_pango this = calloc( sizeof( struct producer_pango_s ), 1 );
109 if ( this != NULL && mlt_producer_init( &this->parent, this ) == 0 )
111 mlt_producer producer = &this->parent;
113 pthread_mutex_lock( &pango_mutex );
114 if ( fontmap == NULL )
115 fontmap = (PangoFT2FontMap*) pango_ft2_font_map_new();
117 pthread_mutex_unlock( &pango_mutex );
119 producer->get_frame = producer_get_frame;
120 producer->close = ( mlt_destructor )producer_close;
122 // Get the properties interface
123 mlt_properties properties = MLT_PRODUCER_PROPERTIES( &this->parent );
125 // Set the default properties
126 mlt_properties_set( properties, "fgcolour", "0xffffffff" );
127 mlt_properties_set( properties, "bgcolour", "0x00000000" );
128 mlt_properties_set_int( properties, "align", pango_align_left );
129 mlt_properties_set_int( properties, "pad", 0 );
130 mlt_properties_set( properties, "text", "" );
131 mlt_properties_set( properties, "font", "Sans 48" );
132 mlt_properties_set( properties, "encoding", "UTF-8" );
133 mlt_properties_set_int( properties, "weight", PANGO_WEIGHT_NORMAL );
135 if ( filename == NULL || ( filename && ( !strcmp( filename, "" )
136 // workaround for old kdenlive countdown generator
137 || strstr( filename, "<producer>" ) ) ) )
139 mlt_properties_set( properties, "markup", "" );
141 else if ( filename[ 0 ] == '+' || strstr( filename, "/+" ) )
143 char *copy = strdup( filename + 1 );
145 if ( strstr( markup, "/+" ) )
146 markup = strstr( markup, "/+" ) + 2;
147 ( *strrchr( markup, '.' ) ) = '\0';
148 while ( strchr( markup, '~' ) )
149 ( *strchr( markup, '~' ) ) = '\n';
150 mlt_properties_set( properties, "resource", filename );
151 mlt_properties_set( properties, "markup", markup );
154 else if ( strstr( filename, ".mpl" ) )
157 mlt_properties contents = mlt_properties_load( filename );
158 mlt_geometry key_frames = mlt_geometry_init( );
159 struct mlt_geometry_item_s item;
160 mlt_properties_set( properties, "resource", filename );
161 mlt_properties_set_data( properties, "contents", contents, 0, ( mlt_destructor )mlt_properties_close, NULL );
162 mlt_properties_set_data( properties, "key_frames", key_frames, 0, ( mlt_destructor )mlt_geometry_close, NULL );
164 // Make sure we have at least one entry
165 if ( mlt_properties_get( contents, "0" ) == NULL )
166 mlt_properties_set( contents, "0", "" );
168 for ( i = 0; i < mlt_properties_count( contents ); i ++ )
170 char *name = mlt_properties_get_name( contents, i );
171 char *value = mlt_properties_get_value( contents, i );
172 while ( value != NULL && strchr( value, '~' ) )
173 ( *strchr( value, '~' ) ) = '\n';
174 item.frame = atoi( name );
175 mlt_geometry_insert( key_frames, &item );
177 mlt_geometry_interpolate( key_frames );
181 FILE *f = fopen( filename, "r" );
189 while ( fgets( line, 80, f ) )
191 size += strlen( line ) + 1;
194 markup = realloc( markup, size );
195 strcat( markup, line );
199 markup = strdup( line );
204 if ( markup[ strlen( markup ) - 1 ] == '\n' )
205 markup[ strlen( markup ) - 1 ] = '\0';
207 mlt_properties_set( properties, "resource", filename );
208 mlt_properties_set( properties, "markup", ( markup == NULL ? "" : markup ) );
213 producer->close = NULL;
214 mlt_producer_close( producer );
226 static void set_string( char **string, const char *value, const char *fallback )
231 *string = strdup( value );
233 else if ( *string == NULL && fallback != NULL )
235 *string = strdup( fallback );
237 else if ( *string != NULL && fallback == NULL )
244 rgba_color parse_color( char *color )
246 rgba_color result = { 0xff, 0xff, 0xff, 0xff };
248 if ( !strncmp( color, "0x", 2 ) )
250 unsigned int temp = 0;
251 sscanf( color + 2, "%x", &temp );
252 result.r = ( temp >> 24 ) & 0xff;
253 result.g = ( temp >> 16 ) & 0xff;
254 result.b = ( temp >> 8 ) & 0xff;
255 result.a = ( temp ) & 0xff;
257 else if ( !strcmp( color, "red" ) )
263 else if ( !strcmp( color, "green" ) )
269 else if ( !strcmp( color, "blue" ) )
277 unsigned int temp = 0;
278 sscanf( color, "%d", &temp );
279 result.r = ( temp >> 24 ) & 0xff;
280 result.g = ( temp >> 16 ) & 0xff;
281 result.b = ( temp >> 8 ) & 0xff;
282 result.a = ( temp ) & 0xff;
288 /** Convert a string property to UTF-8
290 static int iconv_utf8( mlt_properties properties, const char *prop_name, const char* encoding )
292 char *text = mlt_properties_get( properties, prop_name );
295 iconv_t cd = iconv_open( "UTF-8", encoding );
296 if ( cd != ( iconv_t )-1 )
298 char *inbuf_p = text;
299 size_t inbuf_n = strlen( text );
300 size_t outbuf_n = inbuf_n * 6;
301 char *outbuf = mlt_pool_alloc( outbuf_n );
302 char *outbuf_p = outbuf;
304 memset( outbuf, 0, outbuf_n );
306 if ( text != NULL && strcmp( text, "" ) && iconv( cd, &inbuf_p, &inbuf_n, &outbuf_p, &outbuf_n ) != -1 )
307 mlt_properties_set( properties, prop_name, outbuf );
309 mlt_properties_set( properties, prop_name, "" );
311 mlt_pool_release( outbuf );
318 static void refresh_image( mlt_frame frame, int width, int height )
321 GdkPixbuf *pixbuf = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "pixbuf", NULL );
323 // Obtain properties of frame
324 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
326 // Obtain the producer pango for this frame
327 producer_pango this = mlt_properties_get_data( properties, "producer_pango", NULL );
329 // Obtain the producer
330 mlt_producer producer = &this->parent;
332 // Obtain the producer properties
333 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
335 // Get producer properties
336 char *fg = mlt_properties_get( producer_props, "fgcolour" );
337 char *bg = mlt_properties_get( producer_props, "bgcolour" );
338 int align = alignment_parse( mlt_properties_get( producer_props, "align" ) );
339 int pad = mlt_properties_get_int( producer_props, "pad" );
340 char *markup = mlt_properties_get( producer_props, "markup" );
341 char *text = mlt_properties_get( producer_props, "text" );
342 char *font = mlt_properties_get( producer_props, "font" );
343 char *encoding = mlt_properties_get( producer_props, "encoding" );
344 int weight = mlt_properties_get_int( producer_props, "weight" );
345 int size = mlt_properties_get_int( producer_props, "size" );
346 int property_changed = 0;
348 if ( pixbuf == NULL )
350 // Check for file support
351 int position = mlt_properties_get_position( properties, "pango_position" );
352 mlt_properties contents = mlt_properties_get_data( producer_props, "contents", NULL );
353 mlt_geometry key_frames = mlt_properties_get_data( producer_props, "key_frames", NULL );
354 struct mlt_geometry_item_s item;
355 if ( contents != NULL )
358 mlt_geometry_prev_key( key_frames, &item, position );
359 sprintf( temp, "%d", item.frame );
360 markup = mlt_properties_get( contents, temp );
363 // See if any properties changed
364 property_changed = ( align != this->align );
365 property_changed = property_changed || ( this->fgcolor == NULL || ( fg && strcmp( fg, this->fgcolor ) ) );
366 property_changed = property_changed || ( this->bgcolor == NULL || ( bg && strcmp( bg, this->bgcolor ) ) );
367 property_changed = property_changed || ( pad != this->pad );
368 property_changed = property_changed || ( markup && this->markup && strcmp( markup, this->markup ) );
369 property_changed = property_changed || ( text && this->text && strcmp( text, this->text ) );
370 property_changed = property_changed || ( font && this->font && strcmp( font, this->font ) );
371 property_changed = property_changed || ( weight != this->weight );
373 // Save the properties for next comparison
376 set_string( &this->fgcolor, fg, "0xffffffff" );
377 set_string( &this->bgcolor, bg, "0x00000000" );
378 set_string( &this->markup, markup, NULL );
379 set_string( &this->text, text, NULL );
380 set_string( &this->font, font, "Sans 48" );
381 this->weight = weight;
384 if ( pixbuf == NULL && property_changed )
386 rgba_color fgcolor = parse_color( this->fgcolor );
387 rgba_color bgcolor = parse_color( this->bgcolor );
390 g_object_unref( this->pixbuf );
393 // Convert from specified encoding to UTF-8
394 if ( encoding != NULL && !strncaseeq( encoding, "utf-8", 5 ) && !strncaseeq( encoding, "utf8", 4 ) )
396 if ( markup != NULL && iconv_utf8( producer_props, "markup", encoding ) != -1 )
398 markup = mlt_properties_get( producer_props, "markup" );
399 set_string( &this->markup, markup, NULL );
401 if ( text != NULL && iconv_utf8( producer_props, "text", encoding ) != -1 )
403 text = mlt_properties_get( producer_props, "text" );
404 set_string( &this->text, text, NULL );
409 pixbuf = pango_get_pixbuf( markup, text, font, fgcolor, bgcolor, pad, align, weight, size );
411 if ( pixbuf != NULL )
413 // Register this pixbuf for destruction and reuse
414 mlt_properties_set_data( producer_props, "pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
415 g_object_ref( pixbuf );
416 mlt_properties_set_data( MLT_FRAME_PROPERTIES( frame ), "pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
418 mlt_properties_set_int( producer_props, "real_width", gdk_pixbuf_get_width( pixbuf ) );
419 mlt_properties_set_int( producer_props, "real_height", gdk_pixbuf_get_height( pixbuf ) );
421 // Store the width/height of the pixbuf temporarily
422 this->width = gdk_pixbuf_get_width( pixbuf );
423 this->height = gdk_pixbuf_get_height( pixbuf );
426 else if ( pixbuf == NULL && width > 0 && ( this->pixbuf == NULL || width != this->width || height != this->height ) )
429 g_object_unref( this->pixbuf );
431 pixbuf = mlt_properties_get_data( producer_props, "pixbuf", NULL );
434 // If we have a pixbuf and a valid width
435 if ( pixbuf && width > 0 )
437 char *interps = mlt_properties_get( properties, "rescale.interp" );
438 int interp = GDK_INTERP_BILINEAR;
440 if ( strcmp( interps, "nearest" ) == 0 )
441 interp = GDK_INTERP_NEAREST;
442 else if ( strcmp( interps, "tiles" ) == 0 )
443 interp = GDK_INTERP_TILES;
444 else if ( strcmp( interps, "hyper" ) == 0 || strcmp( interps, "bicubic" ) == 0 )
445 interp = GDK_INTERP_HYPER;
447 // fprintf(stderr,"%s: scaling from %dx%d to %dx%d\n", __FILE__, this->width, this->height, width, height);
449 // Note - the original pixbuf is already safe and ready for destruction
450 this->pixbuf = gdk_pixbuf_scale_simple( pixbuf, width, height, interp );
452 // Store width and height
454 this->height = height;
458 mlt_properties_set_int( properties, "width", this->width );
459 mlt_properties_set_int( properties, "height", this->height );
460 mlt_properties_set_int( properties, "real_width", mlt_properties_get_int( producer_props, "real_width" ) );
461 mlt_properties_set_int( properties, "real_height", mlt_properties_get_int( producer_props, "real_height" ) );
464 static int producer_get_image( mlt_frame frame, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
467 producer_pango this = ( producer_pango ) mlt_frame_pop_service( frame );
469 // Obtain properties of frame
470 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
472 *width = mlt_properties_get_int( properties, "rescale_width" );
473 *height = mlt_properties_get_int( properties, "rescale_height" );
475 mlt_service_lock( MLT_PRODUCER_SERVICE( &this->parent ) );
478 pthread_mutex_lock( &pango_mutex );
479 refresh_image( frame, *width, *height );
481 // Get width and height
482 *width = this->width;
483 *height = this->height;
485 // Always clone here to allow 'animated' text
489 int image_size = this->width * this->height * 4;
490 *buffer = mlt_pool_alloc( image_size );
491 memcpy( *buffer, gdk_pixbuf_get_pixels( this->pixbuf ), image_size );
493 // Now update properties so we free the copy after
494 mlt_frame_set_image( frame, *buffer, image_size, mlt_pool_release );
495 *format = mlt_image_rgb24a;
502 pthread_mutex_unlock( &pango_mutex );
503 mlt_service_unlock( MLT_PRODUCER_SERVICE( &this->parent ) );
508 static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index )
510 producer_pango this = producer->child;
513 *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
515 // Obtain properties of frame and producer
516 mlt_properties properties = MLT_FRAME_PROPERTIES( *frame );
518 // Set the producer on the frame properties
519 mlt_properties_set_data( properties, "producer_pango", this, 0, NULL, NULL );
521 // Update timecode on the frame we're creating
522 mlt_frame_set_position( *frame, mlt_producer_position( producer ) );
523 mlt_properties_set_position( properties, "pango_position", mlt_producer_frame( producer ) );
525 // Refresh the pango image
526 pthread_mutex_lock( &pango_mutex );
527 refresh_image( *frame, 0, 0 );
528 pthread_mutex_unlock( &pango_mutex );
530 // Set producer-specific frame properties
531 mlt_properties_set_int( properties, "progressive", 1 );
532 mlt_properties_set_double( properties, "aspect_ratio", 1 );
534 // Stack the get image callback
535 mlt_frame_push_service( *frame, this );
536 mlt_frame_push_get_image( *frame, producer_get_image );
538 // Calculate the next timecode
539 mlt_producer_prepare_next( producer );
544 static void producer_close( mlt_producer parent )
546 producer_pango this = parent->child;
548 g_object_unref( this->pixbuf );
549 free( this->fgcolor );
550 free( this->bgcolor );
551 free( this->markup );
554 parent->close = NULL;
555 mlt_producer_close( parent );
559 static void pango_draw_background( GdkPixbuf *pixbuf, rgba_color bg )
561 int ww = gdk_pixbuf_get_width( pixbuf );
562 int hh = gdk_pixbuf_get_height( pixbuf );
563 uint8_t *p = gdk_pixbuf_get_pixels( pixbuf );
566 for ( j = 0; j < hh; j++ )
568 for ( i = 0; i < ww; i++ )
578 static GdkPixbuf *pango_get_pixbuf( const char *markup, const char *text, const char *font, rgba_color fg, rgba_color bg, int pad, int align, int weight, int size )
580 PangoContext *context = pango_ft2_font_map_create_context( fontmap );
581 PangoLayout *layout = pango_layout_new( context );
584 GdkPixbuf *pixbuf = NULL;
587 uint8_t* dest = NULL;
590 PangoFontDescription *desc = pango_font_description_from_string( font );
592 pango_ft2_font_map_set_resolution( fontmap, 72, 72 );
593 pango_layout_set_width( layout, -1 ); // set wrapping constraints
594 pango_font_description_set_weight( desc, ( PangoWeight ) weight );
596 pango_font_description_set_absolute_size( desc, PANGO_SCALE * size );
597 pango_layout_set_font_description( layout, desc );
598 // pango_layout_set_spacing( layout, space );
599 pango_layout_set_alignment( layout, ( PangoAlignment ) align );
600 if ( markup != NULL && strcmp( markup, "" ) != 0 )
602 pango_layout_set_markup( layout, markup, strlen( markup ) );
604 else if ( text != NULL && strcmp( text, "" ) != 0 )
606 // Replace all ~'s with a line feed (silly convention, but handy)
607 char *copy = strdup( text );
608 while ( strchr( copy, '~' ) )
609 ( *strchr( copy, '~' ) ) = '\n';
610 pango_layout_set_text( layout, copy, strlen( copy ) );
615 // Pango doesn't like empty strings
616 pango_layout_set_text( layout, " ", 2 );
618 pango_layout_get_pixel_size( layout, &w, &h );
620 // Interpret size property as an absolute pixel height and compensate for
621 // freetype's "interpretation" of our absolute size request. This gives
622 // precise control over compositing and better quality by reducing scaling
623 // artifacts with composite geometries that constrain the dimensions.
624 // If you do not want this, then put the size in the font property or in
628 pango_font_description_set_absolute_size( desc, PANGO_SCALE * size * size/h );
629 pango_layout_set_font_description( layout, desc );
630 pango_layout_get_pixel_size( layout, &w, &h );
636 pixbuf = gdk_pixbuf_new( GDK_COLORSPACE_RGB, TRUE /* has alpha */, 8, w + 2 * pad, h + 2 * pad );
637 pango_draw_background( pixbuf, bg );
639 stride = gdk_pixbuf_get_rowstride( pixbuf );
642 bitmap.pitch = 32 * ( ( w + 31 ) / 31 );
644 bitmap.buffer = mlt_pool_alloc( h * bitmap.pitch );
645 bitmap.num_grays = 256;
646 bitmap.pixel_mode = ft_pixel_mode_grays;
648 memset( bitmap.buffer, 0, h * bitmap.pitch );
650 pango_ft2_render_layout( &bitmap, layout, 0, 0 );
653 x = ( gdk_pixbuf_get_width( pixbuf ) - w - 2 * pad ) * align / 2 + pad;
654 dest = gdk_pixbuf_get_pixels( pixbuf ) + 4 * x + pad * stride;
665 *d++ = ( a * fg.r + ( 255 - a ) * bg.r ) >> 8;
666 *d++ = ( a * fg.g + ( 255 - a ) * bg.g ) >> 8;
667 *d++ = ( a * fg.b + ( 255 - a ) * bg.b ) >> 8;
668 *d++ = ( a * fg.a + ( 255 - a ) * bg.a ) >> 8;
673 mlt_pool_release( bitmap.buffer );
674 pango_font_description_free( desc );
675 g_object_unref( layout );
676 g_object_unref( context );