plugins_manager.cpp 13.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/* ALTA --- Analysis of Bidirectional Reflectance Distribution Functions

   Copyright (C) 2014, 2015 CNRS
   Copyright (C) 2013, 2014 Inria

   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 98 99 100
	std::list<std::string> basename;
	get_library_dirs(basename);

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

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 154 155 156 157 158 159 160
//! \brief load a function from the ALTA input file.
function* plugins_manager::get_function(const std::string& filename)
{
	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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
	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;
	}

	// 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 ;
196 197 198 199 200 201 202 203 204 205 206 207 208
		}
		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);
209 210
		}
		else if(comment == std::string("CMD"))
211
      {
212 213 214 215 216 217 218 219
			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);
220 221 222 223
  if(f->input_parametrization() == params::UNKNOWN_INPUT)
  {
    f->setParametrization(param_in);
  }
224
	f->setParametrization(param_out);
225 226

	// Load the function part from the file object
227
    f->load(file);
228 229 230 231

	return f;
}

232
//! Get an instance of the function selected based on the name <em>n</em>.
233
//! Return NULL if none exists.
234
function* plugins_manager::get_function(const arguments& args)
235
{
236 237 238 239 240 241 242
  #ifdef DEBUG
  std::cout << __FILE__ << " " << __LINE__ << std::endl;
  std::cout << " INitial args = " << args << std::endl;
  #endif

  if(!args.is_defined("func"))
  {
243
#ifdef DEBUG
244
      std::cout << "<<DEBUG>> no function plugin specified, returning a rational function" << std::endl;
245
#endif
246 247 248 249 250 251 252 253 254 255 256
      return new rational_function();
  }

  // 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 
257

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

260 261
    // Treating the case []
    if(args_vec.size() == 0)
262
    {
263 264
        return NULL;
    }
265

266 267 268
    //! create a <em>compound</em> class to store multiple
    //! functions in it.
    compound_function* compound = new compound_function();
269

270 271 272 273 274 275 276 277 278 279 280 281
    //! 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]);
#ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl
                << " at i=" << i << " n=" << n << std::endl;
      std::cout << "<<DEBUG>> load function with args: " << n << std::endl;
#endif
      arguments temp_args = arguments::create_arguments(n);
282

283 284 285 286 287 288 289 290 291 292 293
      //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);
      }
    }
294

295
		  //! return the compound class 
296
		  func = compound;
297 298 299
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << " WE HAVE A COMPOUND " << std::endl;
      #endif
300
    }
301
    else //Here we check if the argument provided with --func is file describing a function
302
    {
303
        const std::string filename = args["func"];
304 305 306 307 308
        FunctionPrototype myFunction = open_library<FunctionPrototype>(filename, "provide_function");
        if(myFunction != NULL)
        {
#ifdef DEBUG
            std::cout << "<<DEBUG>> using function provider in file \"" << filename << "\"" << std::endl;
309
#endif
310
            func =  myFunction();
311 312 313 314 315 316
        }
        else
        {
            std::cerr << "<<ERROR>> no function provider found in file \"" << filename << "\"" << std::endl;
            return new rational_function() ;
        }
317 318
    }

319 320 321
    // Treat the case of the Fresnel
    if(args.is_defined("fresnel"))
    {
322 323 324 325 326
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " INSIDE fresnel args = " << args << std::endl;
      #endif

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
327 328 329 330 331 332 333 334 335 336
      // 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;
337

PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
      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);
       }
      }

359 360 361 362 363
      #ifdef DEBUG
      std::cout << __FILE__ << " " << __LINE__ << std::endl;
      std::cout << " n = " << n << std::endl;
      #endif
       
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
364 365 366
      nonlinear_function* func_fres = dynamic_cast<nonlinear_function*>(get_function(arguments::create_arguments(n)));
      if(func_fres != NULL)
      {
367
        return new product_function(nl_func, func_fres);
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
368 369 370
      }
      else
      {
371 372
        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
373
      }
374
	 }
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
375 376

   
377
/*
378 379 380 381 382 383 384
	 // 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
385
*/
PACANOWSKI Romain's avatar
PACANOWSKI Romain committed
386 387


388
    return func;
389
}
390
ptr<data> plugins_manager::get_data(const std::string& n)
391
{
392 393
    if(n.empty())
    {
394
#ifdef DEBUG
395
        std::cout << "<<DEBUG>> no data plugin specified, returning a vertial_segment loader" << std::endl;
396
#endif
397 398 399
        return new vertical_segment();
    }

400
	 DataPrototype myData = open_library<DataPrototype>(n, "provide_data");
401 402
    if(myData != NULL)
    {
403
#ifdef DEBUG
404 405 406 407 408 409 410 411 412
        std::cout << "<<DEBUG>> using function provider in file \"" << n << "\"" << std::endl;
#endif
        return myData();
    }
    else
    {
        std::cerr << "<<ERROR>> no data provider found in file \"" << n << "\"" << std::endl;
        return new vertical_segment() ;
    }
413
}
414
ptr<fitter> plugins_manager::get_fitter(const std::string& n)
415
{
Laurent Belcour's avatar
Laurent Belcour committed
416 417 418 419 420
    if(n.empty())
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> no fitter plugin specified, returning null" << std::endl;
#endif
421
        return NULL;
Laurent Belcour's avatar
Laurent Belcour committed
422 423
    }

424
    FitterPrototype myFitter = open_library<FitterPrototype>(n, "provide_fitter");
Laurent Belcour's avatar
Laurent Belcour committed
425 426 427 428 429
    if(myFitter != NULL)
    {
#ifdef DEBUG
        std::cout << "<<DEBUG>> using function provider in file \"" << n << "\"" << std::endl;
#endif
430
        return myFitter();
Laurent Belcour's avatar
Laurent Belcour committed
431 432 433
    }
    else
    {
434
        std::cerr << "<<ERROR>> no fitter provider found in file \"" << n << "\"" << std::endl;
435
        return NULL ;
Laurent Belcour's avatar
Laurent Belcour committed
436
    }
437
}
438

439
void plugins_manager::check_compatibility(ptr<data>& d, const ptr<function>& f,
440
                                          const arguments& args)
Laurent Belcour's avatar
Laurent Belcour committed
441
{
442 443
	if(d->input_parametrization() == params::UNKNOWN_INPUT &&
		f->input_parametrization() == params::UNKNOWN_INPUT)
Laurent Belcour's avatar
Laurent Belcour committed
444
	{
445
		std::cout << "<<WARNING>> both function and data objects have no parametrization" << std::endl;
Laurent Belcour's avatar
Laurent Belcour committed
446 447 448
	}
	else
	{
449 450 451 452 453 454 455 456 457 458
		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());
		}
459
		else if(d->input_parametrization() != f->input_parametrization() && args.is_defined("change-param"))
460
		{
461
			std::cout << "<<INFO>> has to change the parametrization of the input data " << params::get_name(d->input_parametrization()) << std::endl;
462
            std::cout << "<<INFO>> to " << params::get_name(f->input_parametrization()) << std::endl;
463 464
			ptr<data_params> dd = new data_params(d, f->input_parametrization());
			d = dynamic_pointer_cast<data>(dd) ;
465 466 467 468 469
		}
		else
		{
			std::cout << "<<DEBUG>> no change was made to the parametrization" << std::endl;
		}
Laurent Belcour's avatar
Laurent Belcour committed
470 471 472 473
	}

	if(f->dimY() != d->dimY())
	{
Laurent Belcour's avatar
Laurent Belcour committed
474
        f->setDimY(d->dimY());
Laurent Belcour's avatar
Laurent Belcour committed
475 476 477 478 479 480 481 482 483 484 485
	}

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

487 488 489
// \todo implement the Darwin (MACOS) version.
#ifdef WIN32
#include <windows.h>
490
size_t plugins_manager::get_system_memory()
491 492 493 494 495 496
{
	MEMORYSTATUSEX status;
	status.dwLength = sizeof(status);
	GlobalMemoryStatusEx(&status);
	return status.ullTotalPhys;
}
497 498 499 500 501
#elif __APPLE__
size_t plugins_manager::get_system_memory()
{
	return 0;
}
502 503
#else
#include <unistd.h>
504
size_t plugins_manager::get_system_memory()
505 506 507 508 509 510
{
	long pages = sysconf(_SC_PHYS_PAGES);
	long page_size = sysconf(_SC_PAGE_SIZE);
	return pages * page_size;
}
#endif