synfig-core/src/tool/main.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file tool/main.cpp
   3 **      \brief SYNFIG Tool
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007, 2008 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include <iostream>
  34 #include <ETL/stringf>
  35 #include <list>
  36 #include <ETL/clock>
  37 #include <algorithm>
  38 #include <cstring>
  39
  40 #include <synfig/loadcanvas.h>
  41 #include <synfig/savecanvas.h>
  42 #include <synfig/target_scanline.h>
  43 #include <synfig/module.h>
  44 #include <synfig/importer.h>
  45 #include <synfig/layer.h>
  46 #include <synfig/canvas.h>
  47 #include <synfig/target.h>
  48 #include <synfig/time.h>
  49 #include <synfig/string.h>
  50 #include <synfig/paramdesc.h>
  51 #include <synfig/main.h>
  52 #include <synfig/guid.h>
  53 #include <autorevision.h>
  54 #include "definitions.h"
  55 #include "progress.h"
  56 #include "renderprogress.h"
  57 #include "job.h"
  58 #endif
  59
  60 using namespace std;
  61 using namespace etl;
  62 using namespace synfig;
  63
  64 /* === G L O B A L S ======================================================= */
  65
  66 const char *progname;
  67 int verbosity=0;
  68 bool be_quiet=false;
  69 bool print_benchmarks=false;
  70
  71 /* === T Y P E D E F S ===================================================== */
  72
  73 typedef list<String> arg_list_t;
  74 typedef list<Job> job_list_t;
  75
  76 /* === M E T H O D S ======================================================= */
  77
  78 void guid_test()
  79 {
  80         cout<<"GUID Test"<<endl;
  81         for(int i=20;i;i--)
  82                 cout<<synfig::GUID().get_string()<<' '<<synfig::GUID().get_string()<<endl;
  83 }
  84
  85 void signal_test_func()
  86 {
  87         cout<<"**SIGNAL CALLED**"<<endl;
  88 }
  89
  90 void signal_test()
  91 {
  92         sigc::signal<void> sig;
  93         sigc::connection conn;
  94         cout<<"Signal Test"<<endl;
  95         conn=sig.connect(sigc::ptr_fun(signal_test_func));
  96         cout<<"Next line should exclaim signal called."<<endl;
  97         sig();
  98         conn.disconnect();
  99         cout<<"Next line should NOT exclaim signal called."<<endl;
 100         sig();
 101         cout<<"done."<<endl;
 102 }
 103
 104 /* === P R O C E D U R E S ================================================= */
 105
 106 void display_help_option(const char *flag, const char *arg, string description)
 107 {
 108         const char spaces[]="                      ";
 109         if(arg)
 110                 cerr << strprintf(" %s %s %s", flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description << endl;
 111         else
 112                 cerr << strprintf(" %s %s", flag, spaces+strlen(flag))+description << endl;
 113 }
 114
 115 void display_help(bool full)
 116 {
 117         cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
 118
 119         if(full)
 120         {
 121                 display_help_option("-t", "<output type>", _("Specify output target (Default:unknown)"));
 122                 display_help_option("-w", "<pixel width>", _("Set the image width (Use zero for file default)"));
 123                 display_help_option("-h", "<pixel height>", _("Set the image height (Use zero for file default)"));
 124                 display_help_option("-s", "<image dist>", _("Set the diagonal size of image window (Span)"));
 125                 display_help_option("-a", "<1...30>", _("Set antialias amount for parametric renderer."));
 126                 display_help_option("-Q", "<0...10>", strprintf(_("Specify image quality for accelerated renderer (default=%d)"), DEFAULT_QUALITY).c_str());
 127                 display_help_option("-g", "<amount>", _("Gamma (default=2.2)"));
 128                 display_help_option("-v", NULL, _("Verbose Output (add more for more verbosity)"));
 129                 display_help_option("-q", NULL, _("Quiet mode (No progress/time-remaining display)"));
 130                 display_help_option("-c", "<canvas id>", _("Render the canvas with the given id instead of the root."));
 131                 display_help_option("-o", "<output file>", _("Specify output filename"));
 132                 display_help_option("-T", "<# of threads>", _("Enable multithreaded renderer using specified # of threads"));
 133                 display_help_option("-b", NULL, _("Print Benchmarks"));
 134                 display_help_option("--fps", "<framerate>", _("Set the frame rate"));
 135                 display_help_option("--time", "<time>", _("Render a single frame at <seconds>"));
 136                 display_help_option("--begin-time", "<time>", _("Set the starting time"));
 137                 display_help_option("--start-time", "<time>", _("Set the starting time"));
 138                 display_help_option("--end-time", "<time>", _("Set the ending time"));
 139                 display_help_option("--dpi", "<res>", _("Set the physical resolution (dots-per-inch)"));
 140                 display_help_option("--dpi-x", "<res>", _("Set the physical X resolution (dots-per-inch)"));
 141                 display_help_option("--dpi-y", "<res>", _("Set the physical Y resolution (dots-per-inch)"));
 142
 143                 display_help_option("--list-canvases", NULL, _("List the exported canvases in the composition"));
 144                 display_help_option("--canvas-info", "<fields>", _("Print out specified details of the root canvas"));
 145                 display_help_option("--append", "<filename>", _("Append layers in <filename> to composition"));
 146
 147                 display_help_option("--layer-info", "<layer>", _("Print out layer's description, parameter info, etc."));
 148                 display_help_option("--layers", NULL, _("Print out the list of available layers"));
 149                 display_help_option("--targets", NULL, _("Print out the list of available targets"));
 150                 display_help_option("--importers", NULL, _("Print out the list of available importers"));
 151                 display_help_option("--valuenodes", NULL, _("Print out the list of available ValueNodes"));
 152                 display_help_option("--modules", NULL, _("Print out the list of loaded modules"));
 153                 display_help_option("--version", NULL, _("Print out version information"));
 154                 display_help_option("--info", NULL, _("Print out misc build information"));
 155                 display_help_option("--license", NULL, _("Print out license information"));
 156
 157 #ifdef _DEBUG
 158                 display_help_option("--guid-test", NULL, _("Test GUID generation"));
 159                 display_help_option("--signal-test", NULL, _("Test signal implementation"));
 160 #endif
 161         }
 162         else
 163                 display_help_option("--help", NULL, _("Print out usage and syntax info"));
 164
 165         cerr << endl;
 166 }
 167
 168 int process_global_flags(arg_list_t &arg_list)
 169 {
 170         arg_list_t::iterator iter, next;
 171
 172         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 173         {
 174                 if(*iter == "--")
 175                         return SYNFIGTOOL_OK;
 176
 177                 if(*iter == "--signal-test")
 178                 {
 179                         signal_test();
 180                         return SYNFIGTOOL_HELP;
 181                 }
 182
 183                 if(*iter == "--guid-test")
 184                 {
 185                         guid_test();
 186                         return SYNFIGTOOL_HELP;
 187                 }
 188
 189                 if(*iter == "--help")
 190                 {
 191                         display_help(true);
 192                         return SYNFIGTOOL_HELP;
 193                 }
 194
 195                 if(*iter == "--info")
 196                 {
 197                         cout<<PACKAGE"-"VERSION<<endl;
 198                         #ifdef DEVEL_VERSION
 199                                 cout<<endl<<DEVEL_VERSION<<endl<<endl;
 200                         #endif
 201                         cout<<"Compiled on "__DATE__ /* " at "__TIME__ */;
 202 #ifdef __GNUC__
 203                         cout<<" with GCC "<<__VERSION__;
 204 #endif
 205 #ifdef _MSC_VER
 206                         cout<<" with Microsoft Visual C++ "<<(_MSC_VER>>8)<<'.'<<(_MSC_VER&255);
 207 #endif
 208 #ifdef __TCPLUSPLUS__
 209                         cout<<" with Borland Turbo C++ "<<(__TCPLUSPLUS__>>8)<<'.'<<((__TCPLUSPLUS__&255)>>4)<<'.'<<(__TCPLUSPLUS__&15);
 210 #endif
 211                         cout<<endl<<SYNFIG_COPYRIGHT<<endl;
 212                         cout<<endl;
 213                         return SYNFIGTOOL_HELP;
 214                 }
 215
 216                 if(*iter == "--layers")
 217                 {
 218                         Progress p(PACKAGE);
 219                         synfig::Main synfig_main(dirname(progname),&p);
 220                         synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
 221                         for(;iter!=synfig::Layer::book().end();iter++)
 222                                 if (iter->second.category != CATEGORY_DO_NOT_USE)
 223                                         cout<<iter->first<<endl;
 224
 225                         return SYNFIGTOOL_HELP;
 226                 }
 227
 228                 if(*iter == "--layer-info")
 229                 {
 230                         Progress p(PACKAGE);
 231                         synfig::Main synfig_main(dirname(progname),&p);
 232                         iter=next++;
 233                         if (iter==arg_list.end())
 234                         {
 235                                 error("The `%s' flag requires a value.  Use --help for a list of options.", "--layer-info");
 236                                 return SYNFIGTOOL_MISSINGARGUMENT;
 237                         }
 238                         Layer::Handle layer=synfig::Layer::create(*iter);
 239                         cout<<"Layer Name: "<<layer->get_name()<<endl;
 240                         cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
 241                         cout<<"Version: "<<layer->get_version()<<endl;
 242                         Layer::Vocab vocab=layer->get_param_vocab();
 243                         for(;!vocab.empty();vocab.pop_front())
 244                         {
 245                                 cout<<"param - "<<vocab.front().get_name();
 246                                 if(!vocab.front().get_critical())
 247                                         cout<<" (not critical)";
 248                                 cout<<endl<<"\tLocalized Name: "<<vocab.front().get_local_name()<<endl;
 249                                 if(!vocab.front().get_description().empty())
 250                                         cout<<"\tDescription: "<<vocab.front().get_description()<<endl;
 251                                 if(!vocab.front().get_hint().empty())
 252                                         cout<<"\tHint: "<<vocab.front().get_hint()<<endl;
 253                         }
 254
 255                         return SYNFIGTOOL_HELP;
 256                 }
 257
 258                 if(*iter == "--modules")
 259                 {
 260                         Progress p(PACKAGE);
 261                         synfig::Main synfig_main(dirname(progname),&p);
 262                         synfig::Module::Book::iterator iter=synfig::Module::book().begin();
 263                         for(;iter!=synfig::Module::book().end();iter++)
 264                                 cout<<iter->first<<endl;
 265                         return SYNFIGTOOL_HELP;
 266                 }
 267
 268                 if(*iter == "--targets")
 269                 {
 270                         Progress p(PACKAGE);
 271                         synfig::Main synfig_main(dirname(progname),&p);
 272                         synfig::Target::Book::iterator iter=synfig::Target::book().begin();
 273                         for(;iter!=synfig::Target::book().end();iter++)
 274                                 cout<<iter->first<<endl;
 275                         return SYNFIGTOOL_HELP;
 276                 }
 277
 278                 if(*iter == "--valuenodes")
 279                 {
 280                         Progress p(PACKAGE);
 281                         synfig::Main synfig_main(dirname(progname),&p);
 282                         synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
 283                         for(;iter!=synfig::LinkableValueNode::book().end();iter++)
 284                                 cout<<iter->first<<endl;
 285                         return SYNFIGTOOL_HELP;
 286                 }
 287
 288                 if(*iter == "--importers")
 289                 {
 290                         Progress p(PACKAGE);
 291                         synfig::Main synfig_main(dirname(progname),&p);
 292                         synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
 293                         for(;iter!=synfig::Importer::book().end();iter++)
 294                                 cout<<iter->first<<endl;
 295                         return SYNFIGTOOL_HELP;
 296                 }
 297
 298                 if(*iter == "--version")
 299                 {
 300                         cerr<<PACKAGE<<" "<<VERSION<<endl;
 301                         arg_list.erase(iter);
 302                         return SYNFIGTOOL_HELP;
 303                 }
 304
 305                 if(*iter == "--license")
 306                 {
 307                         cerr<<PACKAGE<<" "<<VERSION<<endl;
 308                         cout<<SYNFIG_COPYRIGHT<<endl<<endl;
 309                         cerr<<"\
 310 **      This package is free software; you can redistribute it and/or\n\
 311 **      modify it under the terms of the GNU General Public License as\n\
 312 **      published by the Free Software Foundation; either version 2 of\n\
 313 **      the License, or (at your option) any later version.\n\
 314 **\n\
 315 **      " << endl << endl;
 316                         arg_list.erase(iter);
 317                         return SYNFIGTOOL_HELP;
 318                 }
 319
 320                 if(*iter == "-v")
 321                 {
 322                         verbosity++;
 323                         arg_list.erase(iter);
 324                         continue;
 325                 }
 326
 327                 if(*iter == "-q")
 328                 {
 329                         be_quiet=true;
 330                         arg_list.erase(iter);
 331                         continue;
 332                 }
 333                 if(*iter == "-b")
 334                 {
 335                         print_benchmarks=true;
 336                         arg_list.erase(iter);
 337                         continue;
 338                 }
 339         }
 340
 341         return SYNFIGTOOL_OK;
 342 }
 343
 344 /* true if the given flag takes an extra parameter */
 345 bool flag_requires_value(String flag)
 346 {
 347         return (flag=="-a"                      || flag=="-c"                   || flag=="-g"                   || flag=="-h"                   || flag=="-o"                   ||
 348                         flag=="-Q"                      || flag=="-s"                   || flag=="-t"                   || flag=="-T"                   || flag=="-w"                   ||
 349                         flag=="--append"        || flag=="--begin-time" || flag=="--canvas-info"|| flag=="--dpi"                || flag=="--dpi-x"              ||
 350                         flag=="--dpi-y"         || flag=="--end-time"   || flag=="--fps"                || flag=="--layer-info" || flag=="--start-time" ||
 351                         flag=="--time"          );
 352 }
 353
 354 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
 355 {
 356         arg_list_t::iterator iter, next;
 357
 358         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 359         {
 360                 if(*iter->begin() != '-')
 361                 {
 362                         //cerr<<*iter->begin()<<"-----------"<<endl;
 363                         return SYNFIGTOOL_OK;
 364                 }
 365
 366                 if (flag_requires_value(*iter))
 367                 {
 368                         cluster.push_back(*iter);
 369                         arg_list.erase(iter);
 370                         iter=next++;
 371                         if (iter==arg_list.end())
 372                         {
 373                                 error("The `%s' flag requires a value.  Use --help for a list of options.", cluster.back().c_str());
 374                                 return SYNFIGTOOL_MISSINGARGUMENT;
 375                         }
 376                 }
 377
 378                 cluster.push_back(*iter);
 379                 arg_list.erase(iter);
 380         }
 381
 382         return SYNFIGTOOL_OK;
 383 }
 384
 385 /*! Extract a parameter from the argument list
 386  *
 387  * \param arg_list Argument list from wich the parameter is extracted.
 388  * \param iter Iterator pointing to the argument list parameter to be
 389  * extracted.
 390  */
 391 string extract_parameter (arg_list_t& arg_list,
 392                                                   arg_list_t::iterator& iter)
 393 {
 394         string parameter;
 395         arg_list.erase(iter);
 396         iter++;
 397         parameter = *iter;
 398         arg_list.erase(iter);
 399         return parameter;
 400 }
 401
 402 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
 403 {
 404         arg_list_t::iterator iter;
 405         int w=0,h=0;
 406         float span=0;
 407         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 408         {
 409                 if(*iter=="-w")
 410                 {
 411                         w = atoi(extract_parameter(arg_list, iter).c_str());
 412                 }
 413                 else if(*iter=="-h")
 414                 {
 415                         h = atoi(extract_parameter(arg_list, iter).c_str());
 416                 }
 417                 else if(*iter=="-a")
 418                 {
 419             int a;
 420                         a = atoi(extract_parameter(arg_list, iter).c_str());
 421                         desc.set_antialias(a);
 422                         VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
 423                 }
 424                 else if(*iter=="-s")
 425                 {
 426                         span = atoi(extract_parameter(arg_list, iter).c_str());
 427                         VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
 428                 }
 429                 else if(*iter=="--fps")
 430                 {
 431                         float fps = atof(extract_parameter(arg_list, iter).c_str());
 432                         desc.set_frame_rate(fps);
 433                         VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
 434                 }
 435                 else if(*iter=="--dpi")
 436                 {
 437                         float dpi = atof(extract_parameter(arg_list, iter).c_str());
 438                         float dots_per_meter=dpi*39.3700787402;
 439                         desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
 440                         VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
 441                 }
 442                 else if(*iter=="--dpi-x")
 443                 {
 444                         float dpi = atof(extract_parameter(arg_list, iter).c_str());
 445                         float dots_per_meter=dpi*39.3700787402;
 446                         desc.set_x_res(dots_per_meter);
 447                         VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
 448                 }
 449                 else if(*iter=="--dpi-y")
 450                 {
 451                         float dpi = atof(extract_parameter(arg_list, iter).c_str());
 452                         float dots_per_meter=dpi*39.3700787402;
 453                         desc.set_y_res(dots_per_meter);
 454                         VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
 455                 }
 456                 else if(*iter=="--start-time" || *iter=="--begin-time")
 457                 {
 458                         desc.set_time_start(Time(extract_parameter(arg_list, iter),
 459                                                                 desc.get_frame_rate()));
 460                 }
 461                 else if(*iter=="--end-time")
 462                 {
 463                         desc.set_time_end(Time(extract_parameter(arg_list, iter),
 464                                                                    desc.get_frame_rate()));
 465                 }
 466                 else if(*iter=="--time")
 467                 {
 468                         desc.set_time(Time(extract_parameter(arg_list, iter),
 469                                                            desc.get_frame_rate()));
 470                         VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
 471                 }
 472                 else if(*iter=="-g")
 473                 {
 474                         synfig::warning("Gamma argument is currently ignored");
 475                         //desc.set_gamma(Gamma(atoi(extract_parameter(arg_list, iter).c_str())));
 476                 }
 477                 else if (flag_requires_value(*iter))
 478                         iter++;
 479         }
 480         if (w||h)
 481         {
 482                 if (!w)
 483                         w = desc.get_w() * h / desc.get_h();
 484                 else if (!h)
 485                         h = desc.get_h() * w / desc.get_w();
 486
 487                 desc.set_wh(w,h);
 488                 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
 489         }
 490         if(span)
 491                 desc.set_span(span);
 492         return SYNFIGTOOL_OK;
 493 }
 494
 495 int extract_quality(arg_list_t &arg_list,int &quality)
 496 {
 497         arg_list_t::iterator iter;
 498         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 499         {
 500                 if(*iter=="-Q")
 501                 {
 502                         quality = atoi(extract_parameter(arg_list, iter).c_str());
 503                         VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
 504                 }
 505                 else if (flag_requires_value(*iter))
 506                         iter++;
 507         }
 508
 509         return SYNFIGTOOL_OK;
 510 }
 511
 512 int extract_threads(arg_list_t &arg_list,int &threads)
 513 {
 514         arg_list_t::iterator iter;
 515         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 516         {
 517                 if(*iter=="-T")
 518                 {
 519                         threads = atoi(extract_parameter(arg_list, iter).c_str());
 520                         VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
 521                 }
 522                 else if (flag_requires_value(*iter))
 523                         iter++;
 524         }
 525
 526         return SYNFIGTOOL_OK;
 527 }
 528
 529 int extract_target(arg_list_t &arg_list,string &type)
 530 {
 531         arg_list_t::iterator iter;
 532         type.clear();
 533
 534         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 535         {
 536                 if(*iter=="-t")
 537                 {
 538                         type = extract_parameter(arg_list, iter);
 539                 }
 540                 else if (flag_requires_value(*iter))
 541                         iter++;
 542         }
 543
 544         return SYNFIGTOOL_OK;
 545 }
 546
 547 int extract_append(arg_list_t &arg_list,string &filename)
 548 {
 549         arg_list_t::iterator iter;
 550         filename.clear();
 551
 552         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 553         {
 554                 if(*iter=="--append")
 555                 {
 556                         filename = extract_parameter(arg_list, iter);
 557                 }
 558                 else if (flag_requires_value(*iter))
 559                         iter++;
 560         }
 561
 562         return SYNFIGTOOL_OK;
 563 }
 564
 565 int extract_outfile(arg_list_t &arg_list,string &outfile)
 566 {
 567         arg_list_t::iterator iter;
 568         int ret=SYNFIGTOOL_FILENOTFOUND;
 569         outfile.clear();
 570
 571         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 572         {
 573                 if(*iter=="-o")
 574                 {
 575                         outfile = extract_parameter(arg_list, iter);
 576                         ret=SYNFIGTOOL_OK;
 577                 }
 578                 else if (flag_requires_value(*iter))
 579                         iter++;
 580         }
 581
 582         return ret;
 583 }
 584
 585 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
 586 {
 587         arg_list_t::iterator iter;
 588         //canvasid.clear();
 589
 590         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 591         {
 592                 if(*iter=="-c")
 593                 {
 594                         canvasid = extract_parameter(arg_list, iter);
 595                 }
 596                 else if (flag_requires_value(*iter))
 597                         iter++;
 598         }
 599
 600         return SYNFIGTOOL_OK;
 601 }
 602
 603 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
 604 {
 605         arg_list_t::iterator iter;
 606
 607         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 608                 if(*iter=="--list-canvases")
 609                 {
 610                         list_canvases = true;
 611                         arg_list.erase(iter);
 612                 }
 613
 614         return SYNFIGTOOL_OK;
 615 }
 616
 617 void extract_canvas_info(arg_list_t &arg_list, Job &job)
 618 {
 619         arg_list_t::iterator iter;
 620
 621         for(iter=arg_list.begin(); iter!=arg_list.end(); iter++)
 622                 if(*iter=="--canvas-info")
 623                 {
 624                         job.canvas_info = true;
 625                         String values(extract_parameter(arg_list, iter)), value;
 626
 627                         std::string::size_type pos;
 628                         while (!values.empty())
 629                         {
 630                                 pos = values.find_first_of(',');
 631                                 if (pos == std::string::npos)
 632                                 {
 633                                         value = values;
 634                                         values = "";
 635                                 }
 636                                 else
 637                                 {
 638                                         value = values.substr(0, pos);
 639                                         values = values.substr(pos+1);
 640                                 }
 641                                 if (value == "all")
 642                                 {
 643                                         job.canvas_info_all = true;
 644                                         return;
 645                                 }
 646
 647                                 if (value == "time_start")                      job.canvas_info_time_start              = true;
 648                                 else if (value == "time_end")           job.canvas_info_time_end                = true;
 649                                 else if (value == "frame_rate")         job.canvas_info_frame_rate              = true;
 650                                 else if (value == "frame_start")        job.canvas_info_frame_start             = true;
 651                                 else if (value == "frame_end")          job.canvas_info_frame_end               = true;
 652                                 else if (value == "w")                          job.canvas_info_w                               = true;
 653                                 else if (value == "h")                          job.canvas_info_h                               = true;
 654                                 else if (value == "image_aspect")       job.canvas_info_image_aspect    = true;
 655                                 else if (value == "pw")                         job.canvas_info_pw                              = true;
 656                                 else if (value == "ph")                         job.canvas_info_ph                              = true;
 657                                 else if (value == "pixel_aspect")       job.canvas_info_pixel_aspect    = true;
 658                                 else if (value == "tl")                         job.canvas_info_tl                              = true;
 659                                 else if (value == "br")                         job.canvas_info_br                              = true;
 660                                 else if (value == "physical_w")         job.canvas_info_physical_w              = true;
 661                                 else if (value == "physical_h")         job.canvas_info_physical_h              = true;
 662                                 else if (value == "x_res")                      job.canvas_info_x_res                   = true;
 663                                 else if (value == "y_res")                      job.canvas_info_y_res                   = true;
 664                                 else if (value == "span")                       job.canvas_info_span                    = true;
 665                                 else if (value == "interlaced")         job.canvas_info_interlaced              = true;
 666                                 else if (value == "antialias")          job.canvas_info_antialias               = true;
 667                                 else if (value == "clamp")                      job.canvas_info_clamp                   = true;
 668                                 else if (value == "flags")                      job.canvas_info_flags                   = true;
 669                                 else if (value == "focus")                      job.canvas_info_focus                   = true;
 670                                 else if (value == "bg_color")           job.canvas_info_bg_color                = true;
 671                                 else if (value == "metadata")           job.canvas_info_metadata                = true;
 672                                 else
 673                                 {
 674                                         cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
 675                                         cerr<<_("Recognized variables are:") << endl <<
 676                                                 "  all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
 677                                                 "  image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
 678                                                 "  x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
 679                                                 "  focus, bg_color, metadata" << endl;
 680                                 }
 681
 682                                 if (pos == std::string::npos)
 683                                         break;
 684                         };
 685                 }
 686 }
 687
 688 void list_child_canvases(string prefix, Canvas::Handle canvas)
 689 {
 690         Canvas::Children children(canvas->children());
 691         for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
 692         {
 693                 cout << prefix << ":" << (*iter)->get_id() << endl;
 694                 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
 695         }
 696 }
 697
 698 void list_canvas_info(Job job)
 699 {
 700         Canvas::Handle canvas(job.canvas);
 701         const RendDesc &rend_desc(canvas->rend_desc());
 702
 703         if (job.canvas_info_all || job.canvas_info_time_start)
 704         {
 705                 cout << endl << "# " << _("Start Time") << endl;
 706                 cout << "time_start"    << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
 707         }
 708
 709         if (job.canvas_info_all || job.canvas_info_time_end)
 710         {
 711                 cout << endl << "# " << _("End Time") << endl;
 712                 cout << "time_end"              << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
 713         }
 714
 715         if (job.canvas_info_all || job.canvas_info_frame_rate)
 716         {
 717                 cout << endl << "# " << _("Frame Rate") << endl;
 718                 cout << "frame_rate"    << "=" << rend_desc.get_frame_rate() << endl;
 719         }
 720
 721         if (job.canvas_info_all || job.canvas_info_frame_start)
 722         {
 723                 cout << endl << "# " << _("Start Frame") << endl;
 724                 cout << "frame_start"   << "=" << rend_desc.get_frame_start() << endl;
 725         }
 726
 727         if (job.canvas_info_all || job.canvas_info_frame_end)
 728         {
 729                 cout << endl << "# " << _("End Frame") << endl;
 730                 cout << "frame_end"             << "=" << rend_desc.get_frame_end() << endl;
 731         }
 732
 733         if (job.canvas_info_all)
 734                 cout << endl;
 735
 736         if (job.canvas_info_all || job.canvas_info_w)
 737         {
 738                 cout << endl << "# " << _("Width") << endl;
 739                 cout << "w"                             << "=" << rend_desc.get_w() << endl;
 740         }
 741
 742         if (job.canvas_info_all || job.canvas_info_h)
 743         {
 744                 cout << endl << "# " << _("Height") << endl;
 745                 cout << "h"                             << "=" << rend_desc.get_h() << endl;
 746         }
 747
 748         if (job.canvas_info_all || job.canvas_info_image_aspect)
 749         {
 750                 cout << endl << "# " << _("Image Aspect Ratio") << endl;
 751                 cout << "image_aspect"  << "=" << rend_desc.get_image_aspect() << endl;
 752         }
 753
 754         if (job.canvas_info_all)
 755                 cout << endl;
 756
 757         if (job.canvas_info_all || job.canvas_info_pw)
 758         {
 759                 cout << endl << "# " << _("Pixel Width") << endl;
 760                 cout << "pw"                    << "=" << rend_desc.get_pw() << endl;
 761         }
 762
 763         if (job.canvas_info_all || job.canvas_info_ph)
 764         {
 765                 cout << endl << "# " << _("Pixel Height") << endl;
 766                 cout << "ph"                    << "=" << rend_desc.get_ph() << endl;
 767         }
 768
 769         if (job.canvas_info_all || job.canvas_info_pixel_aspect)
 770         {
 771                 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
 772                 cout << "pixel_aspect"  << "=" << rend_desc.get_pixel_aspect() << endl;
 773         }
 774
 775         if (job.canvas_info_all)
 776                 cout << endl;
 777
 778         if (job.canvas_info_all || job.canvas_info_tl)
 779         {
 780                 cout << endl << "# " << _("Top Left") << endl;
 781                 cout << "tl"                    << "=" << rend_desc.get_tl()[0]
 782                          << " " << rend_desc.get_tl()[1] << endl;
 783         }
 784
 785         if (job.canvas_info_all || job.canvas_info_br)
 786         {
 787                 cout << endl << "# " << _("Bottom Right") << endl;
 788                 cout << "br"                    << "=" << rend_desc.get_br()[0]
 789                          << " " << rend_desc.get_br()[1] << endl;
 790         }
 791
 792         if (job.canvas_info_all || job.canvas_info_physical_w)
 793         {
 794                 cout << endl << "# " << _("Physical Width") << endl;
 795                 cout << "physical_w"    << "=" << rend_desc.get_physical_w() << endl;
 796         }
 797
 798         if (job.canvas_info_all || job.canvas_info_physical_h)
 799         {
 800                 cout << endl << "# " << _("Physical Height") << endl;
 801                 cout << "physical_h"    << "=" << rend_desc.get_physical_h() << endl;
 802         }
 803
 804         if (job.canvas_info_all || job.canvas_info_x_res)
 805         {
 806                 cout << endl << "# " << _("X Resolution") << endl;
 807                 cout << "x_res"                 << "=" << rend_desc.get_x_res() << endl;
 808         }
 809
 810         if (job.canvas_info_all || job.canvas_info_y_res)
 811         {
 812                 cout << endl << "# " << _("Y Resolution") << endl;
 813                 cout << "y_res"                 << "=" << rend_desc.get_y_res() << endl;
 814         }
 815
 816         if (job.canvas_info_all || job.canvas_info_span)
 817         {
 818                 cout << endl << "# " << _("Diagonal Image Span") << endl;
 819                 cout << "span"                  << "=" << rend_desc.get_span() << endl;
 820         }
 821
 822         if (job.canvas_info_all)
 823                 cout << endl;
 824
 825         if (job.canvas_info_all || job.canvas_info_interlaced)
 826         {
 827                 cout << endl << "# " << _("Interlaced") << endl;
 828                 cout << "interlaced"    << "=" << rend_desc.get_interlaced() << endl;
 829         }
 830
 831         if (job.canvas_info_all || job.canvas_info_antialias)
 832         {
 833                 cout << endl << "# " << _("Antialias") << endl;
 834                 cout << "antialias"             << "=" << rend_desc.get_antialias() << endl;
 835         }
 836
 837         if (job.canvas_info_all || job.canvas_info_clamp)
 838         {
 839                 cout << endl << "# " << _("Clamp") << endl;
 840                 cout << "clamp"                 << "=" << rend_desc.get_clamp() << endl;
 841         }
 842
 843         if (job.canvas_info_all || job.canvas_info_flags)
 844         {
 845                 cout << endl << "# " << _("Flags") << endl;
 846                 cout << "flags"                 << "=" << rend_desc.get_flags() << endl;
 847         }
 848
 849         if (job.canvas_info_all || job.canvas_info_focus)
 850         {
 851                 cout << endl << "# " << _("Focus") << endl;
 852                 cout << "focus"                 << "=" << rend_desc.get_focus()[0]
 853                          << " " << rend_desc.get_focus()[1] << endl;
 854         }
 855
 856         if (job.canvas_info_all || job.canvas_info_bg_color)
 857         {
 858                 cout << endl << "# " << _("Background Color") << endl;
 859                 cout << "bg_color"              << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
 860         }
 861
 862         if (job.canvas_info_all)
 863                 cout << endl;
 864
 865         if (job.canvas_info_all || job.canvas_info_metadata)
 866         {
 867                 std::list<String> keys(canvas->get_meta_data_keys());
 868                 cout << endl << "# " << _("Metadata") << endl;
 869                 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
 870                         cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
 871         }
 872 }
 873
 874 /* === M E T H O D S ======================================================= */
 875
 876 /* === E N T R Y P O I N T ================================================= */
 877
 878 int main(int argc, char *argv[])
 879 {
 880         int i;
 881         arg_list_t arg_list;
 882         job_list_t job_list;
 883
 884         setlocale(LC_ALL, "");
 885
 886 #ifdef ENABLE_NLS
 887         bindtextdomain("synfig", LOCALEDIR);
 888         bind_textdomain_codeset("synfig", "UTF-8");
 889         textdomain("synfig");
 890 #endif
 891
 892         progname=argv[0];
 893         Progress p(argv[0]);
 894
 895         if(!SYNFIG_CHECK_VERSION())
 896         {
 897                 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
 898                 return SYNFIGTOOL_BADVERSION;
 899         }
 900
 901         if(argc==1)
 902         {
 903                 display_help(false);
 904                 return SYNFIGTOOL_BLANK;
 905         }
 906
 907         for(i=1;i<argc;i++)
 908                 arg_list.push_back(argv[i]);
 909
 910         if((i=process_global_flags(arg_list)))
 911                 return i;
 912
 913         VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
 914         synfig::Main synfig_main(dirname(progname),&p);
 915
 916         {
 917                 arg_list_t defaults, imageargs;
 918                 int ret;
 919
 920                 // Grab the defaults before the first file
 921                 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
 922                   return ret;
 923
 924                 while(arg_list.size())
 925                 {
 926                         string target_name;
 927                         job_list.push_front(Job());
 928                         int threads=0;
 929
 930                         imageargs=defaults;
 931                         job_list.front().filename=arg_list.front();
 932                         arg_list.pop_front();
 933
 934                         if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
 935                           return ret;
 936
 937                         // Open the composition
 938                         String errors, warnings;
 939                         try
 940                         {
 941                                 job_list.front().root=open_canvas(job_list.front().filename, errors, warnings);
 942                         }
 943                         catch(runtime_error x)
 944                         {
 945                                 job_list.front().root = 0;
 946                         }
 947
 948                         if(!job_list.front().root)
 949                         {
 950                                 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
 951                                 cerr<<_("Throwing out job...")<<endl;
 952                                 job_list.pop_front();
 953                                 continue;
 954                         }
 955
 956                         bool list_canvases = false;
 957                         extract_list_canvases(imageargs, list_canvases);
 958                         job_list.front().list_canvases = list_canvases;
 959
 960                         extract_canvas_info(imageargs, job_list.front());
 961
 962                         job_list.front().root->set_time(0);
 963
 964                         string canvasid;
 965                         extract_canvasid(imageargs,canvasid);
 966                         if(!canvasid.empty())
 967                         {
 968                                 try
 969                                 {
 970                                         String warnings;
 971                                         job_list.front().canvas=job_list.front().root->find_canvas(canvasid, warnings);
 972                                 }
 973                                 catch(Exception::IDNotFound)
 974                                 {
 975                                         cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
 976                                         cerr<<_("Throwing out job...")<<endl;
 977                                         job_list.pop_front();
 978                                         continue;
 979
 980                                 }
 981                                 catch(Exception::BadLinkName)
 982                                 {
 983                                         cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
 984                                         cerr<<_("Throwing out job...")<<endl;
 985                                         job_list.pop_front();
 986                                         continue;
 987                                 }
 988                         }
 989                         else
 990                                 job_list.front().canvas=job_list.front().root;
 991
 992                         extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
 993                         extract_target(imageargs,target_name);
 994                         extract_threads(imageargs,threads);
 995                         job_list.front().quality=DEFAULT_QUALITY;
 996                         extract_quality(imageargs,job_list.front().quality);
 997                         VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
 998                         job_list.front().desc=job_list.front().canvas->rend_desc();
 999                         extract_outfile(imageargs,job_list.front().outfilename);
1000
1001                         // Extract composite
1002                         do{
1003                                 string composite_file;
1004                                 extract_append(imageargs,composite_file);
1005                                 if(!composite_file.empty())
1006                                 {
1007                                         String errors, warnings;
1008                                         Canvas::Handle composite(open_canvas(composite_file, errors, warnings));
1009                                         if(!composite)
1010                                         {
1011                                                 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1012                                                 break;
1013                                         }
1014                                         Canvas::reverse_iterator iter;
1015                                         for(iter=composite->rbegin();iter!=composite->rend();++iter)
1016                                         {
1017                                                 Layer::Handle layer(*iter);
1018                                                 if(layer->active())
1019                                                         job_list.front().canvas->push_front(layer->clone());
1020                                         }
1021                                         VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1022                                 }
1023                         } while(false);
1024
1025                         VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1026
1027                         // If the target type is not yet defined,
1028                         // try to figure it out from the outfile.
1029                         if(target_name.empty() && !job_list.front().outfilename.empty())
1030                         {
1031                                 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1032                                 string ext = filename_extension(job_list.front().outfilename);
1033                                 if (ext.length()) ext = ext.substr(1);
1034                                 if(Target::ext_book().count(ext))
1035                                 {
1036                                         target_name=Target::ext_book()[ext];
1037                                         info("target name not specified - using %s", target_name.c_str());
1038                                 }
1039                                 else
1040                                 {
1041                                         string lower_ext(ext);
1042
1043                                         for(unsigned int i=0;i<ext.length();i++)
1044                                                 lower_ext[i] = tolower(ext[i]);
1045
1046                                         if(Target::ext_book().count(lower_ext))
1047                                         {
1048                                                 target_name=Target::ext_book()[lower_ext];
1049                                                 info("target name not specified - using %s", target_name.c_str());
1050                                         }
1051                                         else
1052                                                 target_name=ext;
1053                                 }
1054                         }
1055
1056                         // If the target type is STILL not yet defined, then
1057                         // set it to a some sort of default
1058                         if(target_name.empty())
1059                         {
1060                                 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1061                                 target_name="png";
1062                         }
1063
1064                         // If no output filename was provided, then
1065                         // create a output filename based on the
1066                         // given input filename. (ie: change the extension)
1067                         if(job_list.front().outfilename.empty())
1068                         {
1069                                 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1070                                 if(Target::book().count(target_name))
1071                                         job_list.front().outfilename+=Target::book()[target_name].filename;
1072                                 else
1073                                         job_list.front().outfilename+=target_name;
1074                         }
1075
1076                         VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1077                         VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1078
1079                         VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1080                         job_list.front().target=synfig::Target::create(target_name,job_list.front().outfilename);
1081
1082                         if(target_name=="sif")
1083                                 job_list.front().sifout=true;
1084                         else
1085                         {
1086                                 if(!job_list.front().target)
1087                                 {
1088                                         cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1089                                         cerr<<_("Throwing out job...")<<endl;
1090                                         job_list.pop_front();
1091                                         continue;
1092                                 }
1093                                 job_list.front().sifout=false;
1094                         }
1095
1096                         // Set the Canvas on the Target
1097                         if(job_list.front().target)
1098                         {
1099                                 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1100                                 job_list.front().target->set_canvas(job_list.front().canvas);
1101                                 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1102                                 job_list.front().target->set_quality(job_list.front().quality);
1103                         }
1104
1105                         // Set the threads for the target
1106                         if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1107                                 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1108
1109                         if(imageargs.size())
1110                         {
1111                                 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1112                                 for(;imageargs.size();imageargs.pop_front())
1113                                         cerr<<' '<<imageargs.front();
1114                                 cerr<<endl;
1115                                 cerr<<_("Throwing out job...")<<endl;
1116                                 job_list.pop_front();
1117                                 continue;
1118                         }
1119                 }
1120         }
1121
1122         if(arg_list.size())
1123         {
1124                 cerr<<_("Unidentified arguments:");
1125                 for(;arg_list.size();arg_list.pop_front())
1126                         cerr<<' '<<arg_list.front();
1127                 cerr<<endl;
1128                 return SYNFIGTOOL_UNKNOWNARGUMENT;
1129         }
1130
1131         if(!job_list.size())
1132         {
1133                 cerr<<_("Nothing to do!")<<endl;
1134                 return SYNFIGTOOL_BORED;
1135         }
1136
1137         for(;job_list.size();job_list.pop_front())
1138         {
1139                 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1140                 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1141                         job_list.front().desc.get_w(),
1142                         job_list.front().desc.get_h(),
1143                         job_list.front().desc.get_antialias(),
1144                         job_list.front().desc.get_pixel_aspect(),
1145                         job_list.front().desc.get_image_aspect(),
1146                         job_list.front().desc.get_span()
1147                         )<<endl<<'\t'<<
1148                 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1149                         job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1150                         job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1151                         job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1152                         )<<endl;
1153
1154                 RenderProgress p;
1155                 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1156                 if(job_list.front().sifout)
1157                 {
1158                         if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1159                         {
1160                                 cerr<<"Render Failure."<<endl;
1161                                 return SYNFIGTOOL_RENDERFAILURE;
1162                         }
1163                 }
1164                 else if (job_list.front().list_canvases)
1165                 {
1166                         list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1167                         cerr << endl;
1168                 }
1169                 else if (job_list.front().canvas_info)
1170                 {
1171                         list_canvas_info(job_list.front());
1172                         cerr << endl;
1173                 }
1174                 else
1175                 {
1176                         VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1177                         etl::clock timer;
1178                         timer.reset();
1179                         // Call the render member of the target
1180                         if(!job_list.front().target->render(&p))
1181                         {
1182                                 cerr<<"Render Failure."<<endl;
1183                                 return SYNFIGTOOL_RENDERFAILURE;
1184                         }
1185                         if(print_benchmarks)
1186                                 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1187                 }
1188         }
1189
1190         job_list.clear();
1191
1192         VERBOSE_OUT(1)<<_("Done.")<<endl;
1193
1194         return SYNFIGTOOL_OK;
1195 }