git.sesse.net Git - mlt/blob - src/modules/gtk2/filter_dynamictext.c

   1 /*
   2  * filter_dynamictext.c -- dynamic text overlay filter
   3  * Copyright (C) 2011 Ushodaya Enterprises Limited
   4  * Author: Brian Matherly <pez4brian@yahoo.com>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #include <framework/mlt.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <math.h>
  25 #include <sys/types.h> // for stat()
  26 #include <sys/stat.h>  // for stat()
  27 #include <unistd.h>    // for stat()
  28 #include <time.h>      // for strftime() and gtime()
  29
  30 #define MAX_TEXT_LEN 512
  31
  32 /** Get the next token and indicate whether it is enclosed in "# #".
  33 */
  34 static int get_next_token(char* str, int* pos, char* token, int* is_keyword)
  35 {
  36         int token_pos = 0;
  37         int str_len = strlen(str);
  38
  39         if( (*pos) >= str_len || str[*pos] == '\0' )
  40         {
  41                 return 0;
  42         }
  43
  44         if( str[*pos] == '#' )
  45         {
  46                 *is_keyword = 1;
  47                 (*pos)++;
  48         }
  49         else
  50         {
  51                 *is_keyword = 0;
  52         }
  53
  54         while( *pos < str_len && token_pos < MAX_TEXT_LEN - 1)
  55         {
  56                 if( str[*pos] == '\\' && str[(*pos) + 1] == '#' )
  57                 {
  58                         // Escape Sequence - "#" preceeded by "\" - copy the # into the token.
  59                         token[token_pos] = '#';
  60                         token_pos++;
  61                         (*pos)++; // skip "\"
  62                         (*pos)++; // skip "#"
  63                 }
  64                 else if( str[*pos] == '#' )
  65                 {
  66                         if( *is_keyword )
  67                         {
  68                                 // Found the end of the keyword
  69                                 (*pos)++;
  70                         }
  71                         break;
  72                 }
  73                 else
  74                 {
  75                         token[token_pos] = str[*pos];
  76                         token_pos++;
  77                         (*pos)++;
  78                 }
  79         }
  80
  81         token[token_pos] = '\0';
  82
  83         return 1;
  84 }
  85
  86 static void get_timecode_str( mlt_filter filter, mlt_frame frame, char* text )
  87 {
  88         int frames = mlt_frame_get_position( frame );
  89         double fps = mlt_profile_fps( mlt_service_profile( MLT_FILTER_SERVICE( filter ) ) );
  90         char tc[12] = "";
  91         if (fps == 0)
  92         {
  93                 strncat( text, "-", MAX_TEXT_LEN - strlen(text) - 1 );
  94         }
  95         else
  96         {
  97                 int seconds = frames / fps;
  98                 frames = frames % lrint( fps );
  99                 int minutes = seconds / 60;
 100                 seconds = seconds % 60;
 101                 int hours = minutes / 60;
 102                 minutes = minutes % 60;
 103                 sprintf(tc, "%.2d:%.2d:%.2d:%.2d", hours, minutes, seconds, frames);
 104                 strncat( text, tc, MAX_TEXT_LEN - strlen(text) - 1 );
 105         }
 106 }
 107
 108 static void get_frame_str( mlt_filter filter, mlt_frame frame, char* text )
 109 {
 110         int pos = mlt_frame_get_position( frame );
 111         char s[12];
 112         snprintf( s, sizeof(s) - 1, "%d", pos );
 113         strncat( text, s, MAX_TEXT_LEN - strlen(text) - 1 );
 114 }
 115
 116 static void get_filedate_str( mlt_filter filter, mlt_frame frame, char* text )
 117 {
 118         mlt_producer producer = mlt_producer_cut_parent(mlt_frame_get_original_producer( frame ));
 119         mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES(producer);
 120         char* filename = mlt_properties_get( producer_properties, "resource");
 121         struct stat file_info;
 122
 123         if( !stat(filename, &file_info))
 124         {
 125                 struct tm* time_info = gmtime( &(file_info.st_mtime) );
 126                 char date[11] = "";
 127                 strftime( date, 11, "%Y/%m/%d", time_info );
 128                 strncat( text, date, MAX_TEXT_LEN - strlen(text) - 1);
 129         }
 130 }
 131
 132
 133 /** Perform substitution for keywords that are enclosed in "# #".
 134 */
 135
 136 static void substitute_keywords(mlt_filter filter, char* result, char* value, mlt_frame frame)
 137 {
 138         char keyword[MAX_TEXT_LEN] = "";
 139         int pos = 0;
 140         int is_keyword = 0;
 141
 142         while ( get_next_token(value, &pos, keyword, &is_keyword) )
 143         {
 144                 if(!is_keyword)
 145                 {
 146                         strncat( result, keyword, MAX_TEXT_LEN - strlen(result) - 1 );
 147                 }
 148                 else if ( !strcmp( keyword, "timecode" ) )
 149                 {
 150                         get_timecode_str(filter, frame, result);
 151                 }
 152                 else if ( !strcmp( keyword, "frame" ) )
 153                 {
 154                         get_frame_str(filter, frame, result);
 155                 }
 156                 else if ( !strcmp( keyword, "filedate" ) )
 157                 {
 158                         get_filedate_str(filter, frame, result);
 159                 }
 160                 else if ( !strcmp( keyword, "resource" ) )
 161                 {
 162                         // special case: replace #resource# with cut parent resource name
 163                         mlt_producer producer = mlt_producer_cut_parent(mlt_frame_get_original_producer( frame ));
 164                         mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES(producer);
 165                         strncat( result, mlt_properties_get( producer_properties, "resource"), MAX_TEXT_LEN - strlen(result) - 1 );
 166                 }
 167                 else
 168                 {
 169                         // replace keyword with property value from this frame
 170                         mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
 171                         char *frame_value = mlt_properties_get( frame_properties, keyword );
 172                         if( frame_value )
 173                         {
 174                                 strncat( result, frame_value, MAX_TEXT_LEN - strlen(result) - 1 );
 175                         }
 176                 }
 177         }
 178 }
 179
 180 static void apply_filter(mlt_filter filter, mlt_frame frame )
 181 {
 182         mlt_properties my_properties = MLT_FILTER_PROPERTIES( filter );
 183         mlt_filter watermark = mlt_properties_get_data( my_properties, "_watermark", NULL );
 184         mlt_properties watermark_properties = MLT_FILTER_PROPERTIES( watermark );
 185         char* dynamic_text = mlt_properties_get( my_properties, "argument");
 186
 187         // Check for keywords in dynamic text
 188         if ( dynamic_text )
 189         {
 190                 // Apply keyword substitution before passing the text to the filter.
 191                 char result[MAX_TEXT_LEN] = "";
 192                 substitute_keywords( filter, result, dynamic_text, frame );
 193                 mlt_properties_set( watermark_properties, "producer.markup", (char*) result );
 194         }
 195
 196         // Pass the properties to the watermark filter composite transition
 197         mlt_properties_set( watermark_properties, "composite.geometry", mlt_properties_get( my_properties, "geometry" ) );
 198         mlt_properties_set( watermark_properties, "composite.halign", mlt_properties_get( my_properties, "halign" ) );
 199         mlt_properties_set( watermark_properties, "composite.valign", mlt_properties_get( my_properties, "valign" ) );
 200
 201         // Pass the properties to the watermark filter pango producer
 202         mlt_properties_set( watermark_properties, "producer.family", mlt_properties_get( my_properties, "family" ) );
 203         mlt_properties_set( watermark_properties, "producer.size", mlt_properties_get( my_properties, "size" ) );
 204         mlt_properties_set( watermark_properties, "producer.weight", mlt_properties_get( my_properties, "weight" ) );
 205         mlt_properties_set( watermark_properties, "producer.fgcolour", mlt_properties_get( my_properties, "fgcolour" ) );
 206         mlt_properties_set( watermark_properties, "producer.bgcolour", mlt_properties_get( my_properties, "bgcolour" ) );
 207         mlt_properties_set( watermark_properties, "producer.olcolour", mlt_properties_get( my_properties, "olcolour" ) );
 208         mlt_properties_set( watermark_properties, "producer.pad", mlt_properties_get( my_properties, "pad" ) );
 209         mlt_properties_set( watermark_properties, "producer.outline", mlt_properties_get( my_properties, "outline" ) );
 210
 211         // Process the filter
 212         mlt_filter_process( watermark, frame );
 213 }
 214
 215 /** Get the image.
 216 */
 217
 218 static int filter_get_image( mlt_frame frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
 219 {
 220         // Pop the service
 221         mlt_filter filter = mlt_frame_pop_service( frame );
 222
 223         mlt_service_lock( MLT_FILTER_SERVICE( filter ) );
 224
 225         apply_filter(filter, frame);
 226
 227         mlt_service_unlock( MLT_FILTER_SERVICE( filter ) );
 228
 229         // Need to get the image
 230         return mlt_frame_get_image( frame, image, format, width, height, 1 );
 231 }
 232
 233
 234 /** Filter processing.
 235 */
 236
 237 static mlt_frame filter_process( mlt_filter filter, mlt_frame frame )
 238 {
 239         // Push the filter
 240         mlt_frame_push_service( frame, filter );
 241
 242         // Register the get image method
 243         mlt_frame_push_get_image( frame, filter_get_image );
 244
 245         // Return the frame
 246         return frame;
 247 }
 248
 249 /** Constructor for the filter.
 250 */
 251
 252 mlt_filter filter_dynamictext_init( mlt_profile profile, mlt_service_type type, const char *id, void *arg )
 253 {
 254         // Create the filter
 255         mlt_filter filter = mlt_filter_new( );
 256         mlt_filter watermark = mlt_factory_filter( profile, "watermark", "pango:" );
 257
 258         // Initialise it
 259         if ( filter && watermark )
 260         {
 261                 // Get the properties
 262                 mlt_properties properties = MLT_FILTER_PROPERTIES( filter );
 263
 264                 // Store the watermark filter for future use
 265                 mlt_properties_set_data( properties, "_watermark", watermark, 0, ( mlt_destructor )mlt_filter_close, NULL );
 266
 267                 // Assign default values
 268                 mlt_properties_set( properties, "argument", arg ? arg: "#timecode#" );
 269                 mlt_properties_set( properties, "geometry", "0%/0%:100%x100%:100" );
 270                 mlt_properties_set( properties, "family", "Sans" );
 271                 mlt_properties_set( properties, "size", "48" );
 272                 mlt_properties_set( properties, "weight", "400" );
 273                 mlt_properties_set( properties, "fgcolour", "0x000000ff" );
 274                 mlt_properties_set( properties, "bgcolour", "0x00000020" );
 275                 mlt_properties_set( properties, "olcolour", "0x00000000" );
 276                 mlt_properties_set( properties, "pad", "0" );
 277                 mlt_properties_set( properties, "halign", "left" );
 278                 mlt_properties_set( properties, "valign", "top" );
 279                 mlt_properties_set( properties, "outline", "0" );
 280
 281                 // Specify the processing method
 282                 filter->process = filter_process;
 283         }
 284         else // filter or watermark failed for some reason
 285         {
 286                 if( filter )
 287                 {
 288                         mlt_filter_close(filter);
 289                 }
 290
 291                 if( watermark )
 292                 {
 293                         mlt_filter_close(watermark);
 294                 }
 295
 296                 filter = NULL;
 297         }
 298
 299         return filter;
 300 }