git.sesse.net Git - mlt/blob - src/modules/frei0r/factory.c

   1 /*
   2  * factory.c -- the factory method interfaces
   3  * Copyright (c) 2008 Marco Gittler <g.marco@freenet.de>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 #include <string.h>
  21 #include <framework/mlt.h>
  22 #include <frei0r.h>
  23
  24 #include <stddef.h>
  25 #include <stdio.h>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28 #include <dirent.h>
  29 #include <dlfcn.h>
  30 #include <stdlib.h>
  31 #include <limits.h>
  32 #include <math.h>
  33
  34
  35 #if defined(WIN32)
  36 #define LIBSUF ".dll"
  37 #define FREI0R_PLUGIN_PATH "\\lib\\frei0r-1"
  38 #elif defined(__DARWIN__) && defined(RELOCATABLE)
  39 #define LIBSUF ".so"
  40 #define FREI0R_PLUGIN_PATH "/lib/frei0r-1"
  41 #else
  42 #define LIBSUF ".so"
  43 #define FREI0R_PLUGIN_PATH "/usr/lib/frei0r-1:/usr/lib64/frei0r-1:/opt/local/lib/frei0r-1:/usr/local/lib/frei0r-1:$HOME/.frei0r-1/lib"
  44 #endif
  45
  46 #define GET_FREI0R_PATH (getenv("FREI0R_PATH") ? getenv("FREI0R_PATH") : getenv("MLT_FREI0R_PLUGIN_PATH") ? getenv("MLT_FREI0R_PLUGIN_PATH") : FREI0R_PLUGIN_PATH)
  47
  48 #define CLAMP( x, min, max ) ((x) < (min) ? (min) : (x) > (max) ? (max) : (x))
  49
  50 extern mlt_filter filter_frei0r_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg );
  51 extern mlt_frame filter_process( mlt_filter this, mlt_frame frame );
  52 extern void filter_close( mlt_filter this );
  53 extern int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index );
  54 extern void producer_close( mlt_producer this );
  55 extern void transition_close( mlt_transition this );
  56 extern mlt_frame transition_process( mlt_transition transition, mlt_frame a_frame, mlt_frame b_frame );
  57
  58 static char* get_frei0r_path()
  59 {
  60 #ifdef WIN32
  61         char *dirname = malloc( strlen( mlt_environment( "MLT_APPDIR" ) ) + strlen( FREI0R_PLUGIN_PATH ) + 1 );
  62         strcpy( dirname, mlt_environment( "MLT_APPDIR" ) );
  63         strcat( dirname, FREI0R_PLUGIN_PATH );
  64         return dirname;
  65 #elif defined(__DARWIN__) && defined(RELOCATABLE)
  66         char *dirname = malloc( strlen( mlt_environment( "MLT_APPDIR" ) ) + strlen( FREI0R_PLUGIN_PATH ) + 1 );
  67         strcpy( dirname, mlt_environment( "MLT_APPDIR" ) );
  68         strcat( dirname, FREI0R_PLUGIN_PATH );
  69         return dirname;
  70 #else
  71         return strdup( GET_FREI0R_PATH );
  72 #endif
  73 }
  74
  75 static void check_thread_safe( mlt_properties properties, const char *name )
  76 {
  77         char dirname[PATH_MAX];
  78         snprintf( dirname, PATH_MAX, "%s/frei0r/not_thread_safe.txt", mlt_environment( "MLT_DATA" ) );
  79         mlt_properties not_thread_safe = mlt_properties_load( dirname );
  80         int i;
  81
  82         for ( i = 0; i < mlt_properties_count( not_thread_safe ); i++ )
  83         {
  84                 if ( strcmp( name, mlt_properties_get_name( not_thread_safe, i ) ) == 0 )
  85                 {
  86                         mlt_properties_set_int( properties, "_not_thread_safe", 1 );
  87                         break;
  88                 }
  89         }
  90         mlt_properties_close( not_thread_safe );
  91 }
  92
  93 static mlt_properties fill_param_info ( mlt_service_type type, const char *service_name, char *name )
  94 {
  95         char file[ PATH_MAX ];
  96         char servicetype[ 1024 ]="";
  97         struct stat stat_buff;
  98
  99         switch ( type ) {
 100                 case producer_type:
 101                         strcpy ( servicetype , "producer" );
 102                         break;
 103                 case filter_type:
 104                         strcpy ( servicetype , "filter" );
 105                         break;
 106                 case transition_type:
 107                         strcpy ( servicetype , "transition" ) ;
 108                         break;
 109                 default:
 110                         strcpy ( servicetype , "" );
 111         };
 112
 113         snprintf( file, PATH_MAX, "%s/frei0r/%s_%s.yml", mlt_environment( "MLT_DATA" ), servicetype, service_name );
 114         memset(&stat_buff, 0, sizeof(stat_buff));
 115         stat(file,&stat_buff);
 116
 117         if (S_ISREG(stat_buff.st_mode)){
 118                 return mlt_properties_parse_yaml( file );
 119         }
 120
 121         void* handle=dlopen(name,RTLD_LAZY);
 122         if (!handle) return NULL;
 123         void (*plginfo)(f0r_plugin_info_t*)=dlsym(handle,"f0r_get_plugin_info");
 124         void (*param_info)(f0r_param_info_t*,int param_index)=dlsym(handle,"f0r_get_param_info");
 125         void (*f0r_init)(void)=dlsym(handle,"f0r_init");
 126         void (*f0r_deinit)(void)=dlsym(handle,"f0r_deinit");
 127         f0r_instance_t (*f0r_construct)(unsigned int , unsigned int)=dlsym(handle, "f0r_construct");
 128         void (*f0r_destruct)(f0r_instance_t)=dlsym(handle, "f0r_destruct");
 129         void (*f0r_get_param_value)(f0r_instance_t instance, f0r_param_t param, int param_index)=dlsym(handle,"f0r_get_param_value" );
 130         if (!plginfo || !param_info) {
 131                 dlclose(handle);
 132                 return NULL;
 133         }
 134         mlt_properties metadata = mlt_properties_new();
 135         f0r_plugin_info_t info;
 136         char string[48];
 137         int j=0;
 138
 139         f0r_init();
 140         f0r_instance_t instance = f0r_construct(720, 576);
 141         if (!instance) {
 142                 f0r_deinit();
 143                 dlclose(handle);
 144                 return NULL;
 145         }
 146         plginfo(&info);
 147         snprintf ( string, sizeof(string) , "%d" , info.minor_version );
 148         mlt_properties_set_double ( metadata, "schema_version" , 0.1 );
 149         mlt_properties_set ( metadata, "title" , info.name );
 150         mlt_properties_set_double ( metadata, "version",
 151                 info.major_version +  info.minor_version / pow( 10, strlen( string ) ) );
 152         mlt_properties_set ( metadata, "identifier" , service_name );
 153         mlt_properties_set ( metadata, "description" , info.explanation );
 154         mlt_properties_set ( metadata, "creator" , info.author );
 155         switch (type){
 156                 case producer_type:
 157                         mlt_properties_set ( metadata, "type" , "producer" );
 158                         break;
 159                 case filter_type:
 160                         mlt_properties_set ( metadata, "type" , "filter" );
 161                         break;
 162                 case transition_type:
 163                         mlt_properties_set ( metadata, "type" , "transition" );
 164                         break;
 165                 default:
 166                         break;
 167         }
 168
 169         mlt_properties tags = mlt_properties_new ( );
 170         mlt_properties_set_data ( metadata , "tags" , tags , 0 , ( mlt_destructor )mlt_properties_close, NULL );
 171         mlt_properties_set ( tags , "0" , "Video" );
 172
 173         mlt_properties parameter = mlt_properties_new ( );
 174         mlt_properties_set_data ( metadata , "parameters" , parameter , 0 , ( mlt_destructor )mlt_properties_close, NULL );
 175
 176         for (j=0;j<info.num_params;j++){
 177                 snprintf ( string , sizeof(string), "%d" , j );
 178                 mlt_properties pnum = mlt_properties_new ( );
 179                 mlt_properties_set_data ( parameter , string , pnum , 0 , ( mlt_destructor )mlt_properties_close, NULL );
 180                 f0r_param_info_t paraminfo;
 181                 param_info(&paraminfo,j);
 182                 mlt_properties_set ( pnum , "identifier" , string );
 183                 mlt_properties_set ( pnum , "title" , paraminfo.name );
 184                 mlt_properties_set ( pnum , "description" , paraminfo.explanation);
 185                 if ( paraminfo.type == F0R_PARAM_DOUBLE ){
 186                         double deflt = 0;
 187                         mlt_properties_set ( pnum , "type" , "float" );
 188                         mlt_properties_set ( pnum , "minimum" , "0" );
 189                         mlt_properties_set ( pnum , "maximum" , "1" );
 190                         f0r_get_param_value( instance, &deflt, j);
 191                         mlt_properties_set_double ( pnum, "default", CLAMP(deflt, 0.0, 1.0) );
 192                         mlt_properties_set ( pnum , "mutable" , "yes" );
 193                         mlt_properties_set ( pnum , "widget" , "spinner" );
 194                 }else
 195                 if ( paraminfo.type == F0R_PARAM_BOOL ){
 196                         double deflt = 0;
 197                         mlt_properties_set ( pnum , "type" , "boolean" );
 198                         mlt_properties_set ( pnum , "minimum" , "0" );
 199                         mlt_properties_set ( pnum , "maximum" , "1" );
 200                         f0r_get_param_value( instance, &deflt, j);
 201                         mlt_properties_set_int ( pnum, "default", deflt != 0.0 );
 202                         mlt_properties_set ( pnum , "mutable" , "yes" );
 203                         mlt_properties_set ( pnum , "widget" , "checkbox" );
 204                 }else
 205                 if ( paraminfo.type == F0R_PARAM_COLOR ){
 206                         char colorstr[8];
 207                         f0r_param_color_t deflt = {0, 0, 0};
 208
 209                         mlt_properties_set ( pnum , "type" , "color" );
 210                         f0r_get_param_value( instance, &deflt, j);
 211                         sprintf( colorstr, "#%02x%02x%02x", (unsigned) CLAMP(deflt.r * 255, 0 , 255),
 212                                 (unsigned) CLAMP(deflt.g * 255, 0 , 255), (unsigned) CLAMP(deflt.b * 255, 0 , 255));
 213                         colorstr[7] = 0;
 214                         mlt_properties_set ( pnum , "default", colorstr );
 215                         mlt_properties_set ( pnum , "mutable" , "yes" );
 216                         mlt_properties_set ( pnum , "widget" , "color" );
 217                 }else
 218                 if ( paraminfo.type == F0R_PARAM_STRING ){
 219                         char *deflt = NULL;
 220                         mlt_properties_set ( pnum , "type" , "string" );
 221                         f0r_get_param_value( instance, &deflt, j );
 222                         mlt_properties_set ( pnum , "default", deflt );
 223                         mlt_properties_set ( pnum , "mutable" , "yes" );
 224                         mlt_properties_set ( pnum , "widget" , "text" );
 225                 }
 226         }
 227         f0r_destruct(instance);
 228         f0r_deinit();
 229         dlclose(handle);
 230         free(name);
 231
 232         return metadata;
 233 }
 234
 235 static void * load_lib( mlt_profile profile, mlt_service_type type , void* handle, const char *name ){
 236
 237         int i=0;
 238         void (*f0r_get_plugin_info)(f0r_plugin_info_t*),
 239                 *f0r_construct , *f0r_update , *f0r_destruct,
 240                 (*f0r_get_param_info)(f0r_param_info_t* info, int param_index),
 241                 (*f0r_init)(void) , *f0r_deinit ,
 242                 (*f0r_set_param_value)(f0r_instance_t instance, f0r_param_t param, int param_index),
 243                 (*f0r_get_param_value)(f0r_instance_t instance, f0r_param_t param, int param_index),
 244                 (*f0r_update2) (f0r_instance_t instance, double time,   const uint32_t* inframe1,
 245                   const uint32_t* inframe2,const uint32_t* inframe3, uint32_t* outframe);
 246
 247         if ( ( f0r_construct = dlsym(handle, "f0r_construct") ) &&
 248                                 (f0r_destruct = dlsym(handle,"f0r_destruct") ) &&
 249                                 (f0r_get_plugin_info = dlsym(handle,"f0r_get_plugin_info") ) &&
 250                                 (f0r_get_param_info = dlsym(handle,"f0r_get_param_info") ) &&
 251                                 (f0r_set_param_value= dlsym(handle,"f0r_set_param_value" ) ) &&
 252                                 (f0r_get_param_value= dlsym(handle,"f0r_get_param_value" ) ) &&
 253                                 (f0r_init= dlsym(handle,"f0r_init" ) ) &&
 254                                 (f0r_deinit= dlsym(handle,"f0r_deinit" ) )
 255                 ){
 256
 257                 f0r_update=dlsym(handle,"f0r_update");
 258                 f0r_update2=dlsym(handle,"f0r_update2");
 259
 260                 f0r_plugin_info_t info;
 261                 f0r_get_plugin_info(&info);
 262
 263                 void* ret=NULL;
 264                 mlt_properties properties=NULL;
 265                 char minor[12];
 266
 267                 if (type == producer_type && info.plugin_type == F0R_PLUGIN_TYPE_SOURCE ){
 268                         mlt_producer this = mlt_producer_new( profile );
 269                         if ( this != NULL )
 270                         {
 271                                 this->get_frame = producer_get_frame;
 272                                 this->close = ( mlt_destructor )producer_close;
 273                                 f0r_init();
 274                                 properties=MLT_PRODUCER_PROPERTIES ( this );
 275
 276                                 for (i=0;i<info.num_params;i++){
 277                                         f0r_param_info_t pinfo;
 278                                         f0r_get_param_info(&pinfo,i);
 279
 280                                 }
 281
 282                                 ret=this;
 283                         }
 284                 } else if (type == filter_type && info.plugin_type == F0R_PLUGIN_TYPE_FILTER ){
 285                         mlt_filter this = mlt_filter_new( );
 286                         if ( this != NULL )
 287                         {
 288                                 this->process = filter_process;
 289                                 this->close = filter_close;
 290                                 f0r_init();
 291                                 properties=MLT_FILTER_PROPERTIES ( this );
 292
 293                                 for (i=0;i<info.num_params;i++){
 294                                         f0r_param_info_t pinfo;
 295                                         f0r_get_param_info(&pinfo,i);
 296
 297                                 }
 298
 299                                 ret=this;
 300                         }
 301                 }else if (type == transition_type && info.plugin_type == F0R_PLUGIN_TYPE_MIXER2){
 302                         mlt_transition transition = mlt_transition_new( );
 303                         if ( transition != NULL )
 304                         {
 305                                 transition->process = transition_process;
 306                                 transition->close = transition_close;
 307                                 properties=MLT_TRANSITION_PROPERTIES( transition );
 308                                 mlt_properties_set_int(properties, "_transition_type", 1 );
 309
 310                                 ret=transition;
 311                         }
 312                 }
 313                 check_thread_safe( properties, name );
 314                 mlt_properties_set_data(properties, "_dlclose_handle", handle , sizeof ( handle ) , NULL , NULL );
 315                 mlt_properties_set_data(properties, "_dlclose", dlclose , sizeof (void*) , NULL , NULL );
 316                 mlt_properties_set_data(properties, "f0r_construct", f0r_construct , sizeof( f0r_construct ),NULL,NULL);
 317                 mlt_properties_set_data(properties, "f0r_update", f0r_update , sizeof( f0r_update ),NULL,NULL);
 318                 if (f0r_update2)
 319                         mlt_properties_set_data(properties, "f0r_update2", f0r_update2 , sizeof( f0r_update2 ),NULL,NULL);
 320                 mlt_properties_set_data(properties, "f0r_destruct", f0r_destruct , sizeof( f0r_destruct ),NULL,NULL);
 321                 mlt_properties_set_data(properties, "f0r_get_plugin_info", f0r_get_plugin_info , sizeof(void*),NULL,NULL);
 322                 mlt_properties_set_data(properties, "f0r_get_param_info", f0r_get_param_info , sizeof(void*),NULL,NULL);
 323                 mlt_properties_set_data(properties, "f0r_set_param_value", f0r_set_param_value , sizeof(void*),NULL,NULL);
 324                 mlt_properties_set_data(properties, "f0r_get_param_value", f0r_get_param_value , sizeof(void*),NULL,NULL);
 325
 326                 // Let frei0r plugin version be serialized using same format as metadata
 327                 snprintf( minor, sizeof( minor ), "%d", info.minor_version );
 328                 mlt_properties_set_double( properties, "version", info.major_version +  info.minor_version / pow( 10, strlen( minor ) ) );
 329
 330                 // Use the global param name map for backwards compatibility when
 331                 // param names change and setting frei0r params by name instead of index.
 332                 mlt_properties param_name_map = mlt_properties_get_data( mlt_global_properties(), "frei0r.param_name_map", NULL );
 333                 if ( param_name_map ) {
 334                         // Lookup my plugin in the map
 335                         param_name_map = mlt_properties_get_data( param_name_map, name, NULL );
 336                         mlt_properties_set_data( properties, "_param_name_map", param_name_map, 0, NULL, NULL );
 337                 }
 338
 339                 return ret;
 340         }else{
 341                 mlt_log_error( NULL, "frei0r plugin \"%s\" is missing a function\n", name );
 342                 dlerror();
 343         }
 344         return NULL;
 345 }
 346
 347 static void * create_frei0r_item ( mlt_profile profile, mlt_service_type type, const char *id, void *arg){
 348
 349         mlt_tokeniser tokeniser = mlt_tokeniser_init ( );
 350         char *frei0r_path = get_frei0r_path();
 351         int dircount=mlt_tokeniser_parse_new (
 352                 tokeniser,
 353                 frei0r_path,
 354                  ":"
 355         );
 356         void* ret=NULL;
 357         while (dircount--){
 358                 char soname[PATH_MAX];
 359                 char *myid = strdup( id );
 360
 361 #ifdef WIN32
 362                 char *firstname = strtok( myid, "." );
 363 #else
 364                 char *save_firstptr = NULL;
 365                 char *firstname = strtok_r( myid, ".", &save_firstptr );
 366 #endif
 367                 char* directory = mlt_tokeniser_get_string (tokeniser, dircount);
 368
 369 #ifdef WIN32
 370                 firstname = strtok( NULL, "." );
 371 #else
 372                 firstname = strtok_r( NULL, ".", &save_firstptr );
 373 #endif
 374                 if (strncmp(directory, "$HOME", 5))
 375                         snprintf(soname, PATH_MAX, "%s/%s" LIBSUF, directory, firstname );
 376                 else
 377                         snprintf(soname, PATH_MAX, "%s%s/%s" LIBSUF, getenv("HOME"), strchr(directory, '/'), firstname );
 378
 379                 if (firstname){
 380
 381                         void* handle=dlopen(soname,RTLD_LAZY);
 382
 383                         if (handle ){
 384                                 ret=load_lib ( profile , type , handle, firstname );
 385                         }else{
 386                                 dlerror();
 387                         }
 388                 }
 389                 free( myid );
 390         }
 391         mlt_tokeniser_close ( tokeniser );
 392         free( frei0r_path );
 393         return ret;
 394 }
 395
 396
 397 MLT_REPOSITORY
 398 {
 399         int i=0;
 400         mlt_tokeniser tokeniser = mlt_tokeniser_init ( );
 401         char *frei0r_path = get_frei0r_path();
 402         int dircount=mlt_tokeniser_parse_new (
 403                 tokeniser ,
 404                 frei0r_path,
 405                 ":"
 406         );
 407         char dirname[PATH_MAX];
 408         snprintf( dirname, PATH_MAX, "%s/frei0r/blacklist.txt", mlt_environment( "MLT_DATA" ) );
 409         mlt_properties blacklist = mlt_properties_load( dirname );
 410
 411         // Load a param name map into global properties for backwards compatibility when
 412         // param names change and setting frei0r params by name instead of index.
 413         snprintf( dirname, PATH_MAX, "%s/frei0r/param_name_map.yml", mlt_environment( "MLT_DATA" ) );
 414         mlt_properties_set_data( mlt_global_properties(), "frei0r.param_name_map",
 415                 mlt_properties_parse_yaml( dirname ), 0, (mlt_destructor) mlt_properties_close, NULL );
 416
 417         while (dircount--){
 418
 419                 mlt_properties direntries = mlt_properties_new();
 420                 char* directory = mlt_tokeniser_get_string (tokeniser, dircount);
 421
 422                 if (strncmp(directory, "$HOME", 5))
 423                         snprintf(dirname, PATH_MAX, "%s", directory);
 424                 else
 425                         snprintf(dirname, PATH_MAX, "%s%s", getenv("HOME"), strchr(directory, '/'));
 426                 mlt_properties_dir_list(direntries, dirname ,"*" LIBSUF, 1);
 427
 428                 for (i=0; i<mlt_properties_count(direntries);i++){
 429                         char* name=mlt_properties_get_value(direntries,i);
 430                         char* shortname=name+strlen(dirname)+1;
 431 #ifdef WIN32
 432                         char* firstname = strtok( shortname, "." );
 433 #else
 434                         char *save_firstptr = NULL;
 435                         char* firstname = strtok_r( shortname, ".", &save_firstptr );
 436 #endif
 437                         char pluginname[1024]="frei0r.";
 438                         if ( firstname )
 439                                 strncat( pluginname, firstname, sizeof( pluginname ) - strlen( pluginname ) -1 );
 440
 441                         if ( firstname && mlt_properties_get( blacklist, firstname ) )
 442                                 continue;
 443
 444                         void* handle=dlopen(strcat(name, LIBSUF),RTLD_LAZY);
 445                         if (handle){
 446                                 void (*plginfo)(f0r_plugin_info_t*)=dlsym(handle,"f0r_get_plugin_info");
 447
 448                                 if (plginfo){
 449                                         f0r_plugin_info_t info;
 450                                         plginfo(&info);
 451                                         if (firstname && info.plugin_type==F0R_PLUGIN_TYPE_SOURCE){
 452                                                 if (mlt_properties_get(mlt_repository_producers(repository), pluginname))
 453                                                 {
 454                                                         dlclose(handle);
 455                                                         continue;
 456                                                 }
 457                                                 MLT_REGISTER( producer_type, pluginname, create_frei0r_item );
 458                                                 MLT_REGISTER_METADATA( producer_type, pluginname, fill_param_info, strdup(name) );
 459                                         }
 460                                         else if (firstname && info.plugin_type==F0R_PLUGIN_TYPE_FILTER){
 461                                                 if (mlt_properties_get(mlt_repository_filters(repository), pluginname))
 462                                                 {
 463                                                         dlclose(handle);
 464                                                         continue;
 465                                                 }
 466                                                 MLT_REGISTER( filter_type, pluginname, create_frei0r_item );
 467                                                 MLT_REGISTER_METADATA( filter_type, pluginname, fill_param_info, strdup(name) );
 468                                         }
 469                                         else if (firstname && info.plugin_type==F0R_PLUGIN_TYPE_MIXER2 ){
 470                                                 if (mlt_properties_get(mlt_repository_transitions(repository), pluginname))
 471                                                 {
 472                                                         dlclose(handle);
 473                                                         continue;
 474                                                 }
 475                                                 MLT_REGISTER( transition_type, pluginname, create_frei0r_item );
 476                                                 MLT_REGISTER_METADATA( transition_type, pluginname, fill_param_info, strdup(name) );
 477                                         }
 478                                 }
 479                                 dlclose(handle);
 480                         }
 481                 }
 482                 mlt_properties_close(direntries);
 483         }
 484         mlt_tokeniser_close ( tokeniser );
 485         mlt_properties_close( blacklist );
 486         free( frei0r_path );
 487 }