plugins_manager.cpp 15.3 KB
Newer Older
1 2 3
/* ALTA --- Analysis of Bidirectional Reflectance Distribution Functions

   Copyright (C) 2014, 2015 CNRS
4
   Copyright (C) 2013, 2014, 2015 Inria
5 6 7 8 9 10 11

   This file is part of ALTA.

   This Source Code Form is subject to the terms of the Mozilla Public
   License, v. 2.0.  If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.  */

12
#include "plugins_manager.h"
13 14
#include "rational_function.h"
#include "vertical_segment.h"
15

pacanows's avatar
pacanows committed
16
#ifdef _WIN32
17
    #include <windows.h>
18 19 20
#else
    #include <dlfcn.h>
#endif
21
#include <stdio.h>
22
#include <list>
23

24 25 26
//#define DEBUG


27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
//! Add dynamic library extension (.so or .dll) to a dynamic object as well as
//! prepending 'lib' depending on the plateform.
std::string library_name(const std::string name) 
{
	std::string filename;

	const int n = name.length();
#if defined( _WIN32)
	if(name.substr(n-4, n) != std::string("dll")) {
		filename.append(name);
		filename.append(".dll");
	}
#elif defined(__APPLE__)
	if(name.substr(n-5, n) != std::string("dylib")) {
		filename.append("lib");
		filename.append(name);
		filename.append(".dylib");
	}
#else
	if(name.substr(n-2, n) != std::string("so")) {
		filename.append("lib");
		filename.append(name);
		filename.append(".so");
	}
#endif
	else {
		filename.append(name);
	}

	return filename;
}

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
void get_library_dirs(std::list<std::string>& dirs)
{
	dirs.push_back("");

#ifndef _WIN32
	std::string obj_str ;
	const char *env_str = getenv("ALTA_LIB") ;

	if(env_str == NULL) {
		obj_str = "" ;
	} else {
		obj_str = std::string(env_str)+":" ;
	}

	while(true)	{
		int lb = obj_str.find_first_not_of(":",0) ;
		int le = obj_str.find_first_of(":",lb) ;

		if(lb < le)	{
			dirs.push_back(obj_str.substr(lb,le-lb)) ;
			obj_str = obj_str.substr(le+1,obj_str.size()) ;
		} else {
			break ;
		}
	}
#endif
}

87 88 89 90 91
//! \brief Open a dynamic library file (.so or .dll) and extract the associated
//! provide function. The template argument is used to cast the library to a
//! specific type.
template<typename T> T open_library(const std::string& filename, const char* function)
{
92 93 94 95 96 97
	std::list<std::string> basename;
	get_library_dirs(basename);

	std::list<std::string>::iterator iter;
	for(iter = basename.begin(); iter != basename.end(); ++iter)
	{
98 99
	 std::string libname = *iter;
	 libname.append(library_name(filename));
100

101

pacanows's avatar
pacanows committed
102
#ifdef _WIN32
103
    HINSTANCE handle = LoadLibraryA(libname.c_str());
104 105 106 107 108 109 110
    if(handle != NULL)
    {
        T res = (T)GetProcAddress(handle, function);

        if(res == NULL)
        {
            std::cerr << "<<ERROR>> unable to load the symbol \"" << function << "\" from " << filename << std::endl;
111
            continue;
112 113 114 115 116 117 118 119
        }
#ifdef DEBUG_CORE
        std::cout << "<<DEBUG>> will provide a " << function << " for library \"" << filename << "\"" << std::endl;
#endif
        return res;
    }
    else
    {
120
        std::cerr << "<<ERROR>> unable to load the dynamic library file \"" << libname << "\"" << std::endl;
121
        std::cerr << "          cause: \"" << GetLastError() << "\"" << std::endl;
122
        continue;
123
    }
124
#else
125
    void* handle = dlopen(libname.c_str(), RTLD_GLOBAL | RTLD_LAZY);
126

127
	 if(handle != NULL)
128 129 130
	 {
		 void (*res)();
		 *(void **)(&res) = dlsym(handle, function);
131 132 133

        if(dlerror() != NULL)
        {
134
            std::cerr << "<<ERROR>> unable to load the symbol \"" << function << "\" from " << libname << std::endl;
135
            continue;
136 137
        }
#ifdef DEBUG_CORE
138
        std::cout << "<<DEBUG>> will provide a " << function << " for library \"" << libname << "\"" << std::endl;
139 140 141 142 143
#endif
        return (T)res;
    }
    else
    {
144
        std::cerr << "<<ERROR>> unable to load the dynamic library file \"" << libname << "\"" << std::endl;
145
		  std::cerr << "          cause: \"" << dlerror() << "\"" << std::endl;
146
        continue;
147 148
    }
#endif
149 150
	}
return NULL;
151 152
}

153
//! \brief load a function from the ALTA input file.
154
function* plugins_manager::load_function(const std::string& filename)
155 156 157 158 159 160
{
	std::ifstream file;
	file.open(filename.c_str()) ;
	if(!file.is_open())
	{
		std::cerr << "<<ERROR>> unable to open file \"" << filename << "\"" << std::endl ;
161
		return NULL;
162 163
	}

164 165 166
	// Set the precision of the input
	file.precision(10);

167 168
	// Parameters of the function object
	int nX, nY;
169
	params::input param_in   = params::UNKNOWN_INPUT;
170
	params::output param_out = params::UNKNOWN_OUTPUT;
171 172 173 174 175 176 177 178
	arguments args;

	// Test for the first line of the file. Should be a ALTA FUNC HEADER
	std::string line ;
	std::getline(file, line) ;
	if(line != "#ALTA FUNC HEADER")
	{
		std::cerr << "<<ERROR>> this is not a function file" << std::endl;
179 180 181

    //RP: Returning NULL immediately now
    return NULL;
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
	}

	// Parse the header for the function command line and the dimension
	// of the function
	while(line != "#ALTA HEADER END")
	{
		std::getline(file, line) ;
		std::stringstream linestream(line) ;

		linestream.ignore(1) ;

		std::string comment ;
		linestream >> comment ;

		if(comment == std::string("DIM"))
		{
			linestream >> nX >> nY ;
199 200 201 202 203 204 205 206 207 208 209 210 211
		}
		else if(comment == std::string("PARAM_IN"))
		{
			std::string name;
			linestream >> name;
			std::cout << "<<DEBUG>> parsed input parametrization: " << name << std::endl;
			param_in = params::parse_input(name);
		}
		else if(comment == std::string("PARAM_OUT"))
		{
			std::string name;
			linestream >> name;
			param_out = params::parse_output(name);
212 213
		}
		else if(comment == std::string("CMD"))
214
      {
215 216 217 218 219 220 221 222
			args = arguments::create_arguments(line.substr(4, std::string::npos));
		}
	}

	// Create the function from the command line
	function* f = get_function(args);
	f->setDimX(nX);
	f->setDimY(nY);
223 224 225 226
  if(f->input_parametrization() == params::UNKNOWN_INPUT)
  {
    f->setParametrization(param_in);
  }
227
	f->setParametrization(param_out);
228 229

	// Load the function part from the file object
230 231 232 233
  if( f->load(file) )
  {
    return f;
  }
234

235 236
  std::cout << "<<ERROR>> COULD NOT LOAD THE BRDF from File " << filename << std::endl;
	 return NULL;
237 238
}

239
//! Get an instance of the function selected based on the name <em>n</em>.
240
//! Return NULL if none exists.
241
function* plugins_manager::get_function(const arguments& args)
242
{
243 244 245 246 247 248 249
  #ifdef DEBUG
  std::cout << __FILE__ << " " << __LINE__ << std::endl;
  std::cout << " INitial args = " << args << std::endl;
  #endif

  if(!args.is_defined("func"))
  {
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
250 251 252 253
    #ifdef DEBUG
    std::cout << "<<DEBUG>> no function plugin specified, returning a rational function" << std::endl;
    #endif
    return new rational_function();
254 255 256 257 258 259 260 261 262 263
  }

  // The function to be returned.
  function* func = NULL;

  if(args.is_vec("func")) //Checking if  the argument prodived with --func is of the form --func [ arg1, arg2, arg3]
  {
    #ifdef DEBUG
    std::cout << __FILE__ << " " << __LINE__ << " ARGUMENTS of --func are forming a VECTOR " << std::endl;
    #endif 
264

265
    std::vector<std::string> args_vec = args.get_vec("func");
Laurent Belcour's avatar
Laurent Belcour committed
266

267 268
    // Treating the case []
    if(args_vec.size() == 0)
269
    {
270 271
        return NULL;
    }
272

273 274 275
    //! create a <em>compound</em> class to store multiple
    //! functions in it.
    compound_function* compound = new compound_function();
276

277 278 279 280 281 282
    //! For each args_vec element, create a function object and add
    //! it to the compound one.
    for(unsigned int i=0; i<args_vec.size(); ++i)
    {
      std::string n("--func ");
      n.append(args_vec[i]);
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
283 284

      #ifdef DEBUG
285 286 287
      std::cout << __FILE__ << " " << __LINE__ << std::endl
                << " at i=" << i << " n=" << n << std::endl;
      std::cout << "<<DEBUG>> load function with args: " << n << std::endl;
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
288 289
      #endif
      
290
      arguments temp_args = arguments::create_arguments(n);
291

292 293 294 295 296 297 298 299 300 301 302
      //Recursive call
      function* f = get_function(temp_args);
      if(dynamic_cast<nonlinear_function*>(f) == NULL)
      {
          std::cerr << "<<ERROR>> only non-linear functions are compatible with a compound" << std::endl;
      }
      else
      {
          compound->push_back(dynamic_cast<nonlinear_function*>(f), temp_args);
      }
    }
303

304
		  //! return the compound class 
305
		  func = compound;
306 307 308
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << " WE HAVE A COMPOUND " << std::endl;
      #endif
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
309 310 311 312 313 314 315 316 317 318 319 320
  }
  else //Here we check if the argument provided with --func is file describing a function
  {
    const std::string filename = args["func"];
    FunctionPrototype myFunction = open_library<FunctionPrototype>(filename, "provide_function");
    if(myFunction != NULL)
    {
      #ifdef DEBUG
      std::cout << "<<DEBUG>> using function provider in file \"" << filename << "\"" << std::endl;
      #endif
      
      func =  myFunction();
321
    }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
322
    else
323
    {
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
324 325
      std::cerr << "<<ERROR>> no function provider found in file \"" << filename << "\"" << std::endl;
      return new rational_function() ;
326
    }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
327
  }
328

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
329 330 331
  // Treat the case of the Fresnel
  if(args.is_defined("fresnel"))
  {
332 333 334 335 336
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " INSIDE fresnel args = " << args << std::endl;
      #endif

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
337 338 339 340 341 342 343 344 345 346
      // Cast into a non linear function, only those are permitted to use
      // a Fresnel term.
      nonlinear_function* nl_func = dynamic_cast<nonlinear_function*>(func);
      if(nl_func == NULL)
      {
       std::cerr << "<<ERROR>> only non-linear function are permitted to use Fresnel" << std::endl;
       return func;
      }

      std::cout << "<<DEBUG>> multiplying by a Fresnel term" << std::endl;
347

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
      std::string n("--func ");
      if(args.is_vec("fresnel"))
      {
       std::string temp = args["fresnel"];
       n.append(temp.substr(1, temp.size()-2));
      }
      else
      {
       std::string fname = args["fresnel"];
       if(fname.empty()) // Nothing to do except print error, no plugin defined
       {
      	 std::cerr << "<<ERROR>> Fresnel plugin not defined" << std::endl;
      	 std::cerr << "<<ERROR>> using --fresnel alone is not permitted" << std::endl;
      	 return func;
       }
       else // Case where the fresnel parameters is only the plugin filename
       {
      	 n.append(fname);
       }
      }

369 370 371 372 373
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " n = " << n << std::endl;
      #endif
       
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
374 375 376
      nonlinear_function* func_fres = dynamic_cast<nonlinear_function*>(get_function(arguments::create_arguments(n)));
      if(func_fres != NULL)
      {
377 378 379 380 381 382 383 384 385 386 387 388 389
        bool const fresnel_is_fixed = (args.is_defined("fixed-fresnel")) ? (true) : (false);
        bool const lobe_is_fixed    = (args.is_defined("fixed-lobe")) ? (true) : (false);
       
        if( fresnel_is_fixed )
        {
          std::cout << "<<DEBUG>> The Fresnel term is fixed" << std::endl;
        }
        if( lobe_is_fixed )
        {
          std::cout << "<<DEBUG>> The lobe is fixed" << std::endl;
        }

        return new product_function(nl_func, func_fres, lobe_is_fixed, fresnel_is_fixed);
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
390 391 392
      }
      else
      {
393 394
        std::cerr << "<<ERROR>> the right part of the product is not a nonlinear function. Will use only the left part." << std::endl;
        return func;
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
395
      }
396
	 }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
397 398

   
399
/*
400 401 402 403 404 405 406
	 // Correction of the data by 1/cosine(theta_L)
	 if(args.is_defined("data-correct-cosine"))
	 {
		 nonlinear_function* cosine = new cosine_function();
		 func = new product_function(cosine, dynamic_cast<nonlinear_function*>(func));
	 }
	 // End of correction
407
*/
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
408 409


410
    return func;
411
}
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439


ptr<function> plugins_manager::get_function(const std::string& n)
{
    if(n.empty())
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> no function plugin specified, returning nothing" << std::endl;
#endif
        return NULL;
    }

	 FunctionPrototype myFunc = open_library<FunctionPrototype>(n, "provide_function");
    if(myFunc != NULL)
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> using function provider in file \"" << n << "\"" << std::endl;
#endif
        return myFunc();
    }
    else
    {
        std::cerr << "<<ERROR>> no function provider found in file \"" << n << "\"" << std::endl;
        return NULL;
    }
}


440
ptr<data> plugins_manager::get_data(const std::string& n)
441
{
442 443
    if(n.empty())
    {
444
#ifdef DEBUG
445
        std::cout << "<<DEBUG>> no data plugin specified, returning a vertical_segment loader" << std::endl;
446
#endif
447 448 449
        return new vertical_segment();
    }

450
	 DataPrototype myData = open_library<DataPrototype>(n, "provide_data");
451 452
    if(myData != NULL)
    {
453
#ifdef DEBUG
454
        std::cout << "<<DEBUG>> using data provider in file \"" << n << "\"" << std::endl;
455 456 457 458 459 460 461 462
#endif
        return myData();
    }
    else
    {
        std::cerr << "<<ERROR>> no data provider found in file \"" << n << "\"" << std::endl;
        return new vertical_segment() ;
    }
463
}
464
ptr<fitter> plugins_manager::get_fitter(const std::string& n)
465
{
Laurent Belcour's avatar
Laurent Belcour committed
466 467 468 469 470
    if(n.empty())
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> no fitter plugin specified, returning null" << std::endl;
#endif
471
        return NULL;
Laurent Belcour's avatar
Laurent Belcour committed
472 473
    }

474
    FitterPrototype myFitter = open_library<FitterPrototype>(n, "provide_fitter");
Laurent Belcour's avatar
Laurent Belcour committed
475 476 477
    if(myFitter != NULL)
    {
#ifdef DEBUG
478
        std::cout << "<<DEBUG>> using fitter provider in file \"" << n << "\"" << std::endl;
Laurent Belcour's avatar
Laurent Belcour committed
479
#endif
480
        return myFitter();
Laurent Belcour's avatar
Laurent Belcour committed
481 482 483
    }
    else
    {
484
        std::cerr << "<<ERROR>> no fitter provider found in file \"" << n << "\"" << std::endl;
485
        return NULL ;
Laurent Belcour's avatar
Laurent Belcour committed
486
    }
487
}
488

489 490 491
void plugins_manager::check_compatibility( ptr<data>& d, 
                                           const ptr<function>& f,
                                           const arguments& args)
Laurent Belcour's avatar
Laurent Belcour committed
492
{
493 494
	if(d->input_parametrization() == params::UNKNOWN_INPUT &&
		f->input_parametrization() == params::UNKNOWN_INPUT)
Laurent Belcour's avatar
Laurent Belcour committed
495
	{
496
		std::cout << "<<WARNING>> both function and data objects have no parametrization" << std::endl;
Laurent Belcour's avatar
Laurent Belcour committed
497 498 499
	}
	else
	{
500 501 502 503 504 505 506 507 508 509
		if(d->input_parametrization() == params::UNKNOWN_INPUT)
		{
			std::cout << "<<WARNING>> unknown parametrization for data" << std::endl;
		}

		if(f->input_parametrization() == params::UNKNOWN_INPUT)
		{
			std::cout << "<<DEBUG>> function will take the parametrization of the data" << std::endl;
			f->setParametrization(d->input_parametrization());
		}
510
		else if(d->input_parametrization() != f->input_parametrization() && args.is_defined("change-param"))
511
		{
512
			std::cout << "<<INFO>> has to change the parametrization of the input data " << params::get_name(d->input_parametrization()) << std::endl;
513
      std::cout << "<<INFO>> to " << params::get_name(f->input_parametrization()) << std::endl;
514 515
			ptr<data_params> dd = new data_params(d, f->input_parametrization());
			d = dynamic_pointer_cast<data>(dd) ;
516 517 518 519 520
		}
		else
		{
			std::cout << "<<DEBUG>> no change was made to the parametrization" << std::endl;
		}
Laurent Belcour's avatar
Laurent Belcour committed
521 522 523 524
	}

	if(f->dimY() != d->dimY())
	{
525
    f->setDimY(d->dimY());
Laurent Belcour's avatar
Laurent Belcour committed
526 527 528 529 530 531 532 533 534 535 536
	}

	/*
	// Check is the data has to be clusterized
	if(args.is_defined("cluster-dim"))
	{
	clustering* cluster = new clustering(d, args);
	d = cluster;
	}
	*/
}
537

538
// \todo implement the Darwin (MACOS) version.
539 540
// \todo : Why not move these functions to common.h ?
#ifdef _WIN32
541
#include <windows.h>
542
size_t plugins_manager::get_system_memory()
543 544 545 546 547 548
{
	MEMORYSTATUSEX status;
	status.dwLength = sizeof(status);
	GlobalMemoryStatusEx(&status);
	return status.ullTotalPhys;
}
549 550 551 552 553
#elif defined(__APPLE__)
#include <unistd.h>
#include <sys/types.h>
#include <sys/param.h>
#include <sys/sysctl.h>
554 555
size_t plugins_manager::get_system_memory()
{
556 557 558 559 560 561 562 563 564
  int mib[2];
  mib[0] = CTL_HW;
  mib[1] = HW_MEMSIZE;    
  int64_t size = 0;   
	size_t len = sizeof( size );
  if ( sysctl( mib, 2, &size, &len, NULL, 0 ) == 0 )
    return (size_t)size;
  
  return 0L;
565
}
566 567
#else
#include <unistd.h>
568
size_t plugins_manager::get_system_memory()
569 570 571 572 573 574
{
	long pages = sysconf(_SC_PHYS_PAGES);
	long page_size = sysconf(_SC_PAGE_SIZE);
	return pages * page_size;
}
#endif