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  * \param next Iterator pointing to the next argument.
 391  */
 392 string extract_parameter (arg_list_t& arg_list,
 393                                                   arg_list_t::iterator& iter,
 394                                                   arg_list_t::iterator& next)
 395 {
 396         string parameter;
 397         arg_list.erase(iter);
 398         iter = next++;
 399         parameter = *iter;
 400         arg_list.erase(iter);
 401         return parameter;
 402 }
 403
 404 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
 405 {
 406         arg_list_t::iterator iter, next;
 407         int w=0,h=0;
 408         float span=0;
 409         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 410         {
 411                 if(*iter=="-w")
 412                 {
 413                         w = atoi(extract_parameter(arg_list, iter, next).c_str());
 414                 }
 415                 else if(*iter=="-h")
 416                 {
 417                         h = atoi(extract_parameter(arg_list, iter, next).c_str());
 418                 }
 419                 else if(*iter=="-a")
 420                 {
 421             int a;
 422                         a = atoi(extract_parameter(arg_list, iter, next).c_str());
 423                         desc.set_antialias(a);
 424                         VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
 425                 }
 426                 else if(*iter=="-s")
 427                 {
 428                         span = atoi(extract_parameter(arg_list, iter, next).c_str());
 429                         VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
 430                 }
 431                 else if(*iter=="--fps")
 432                 {
 433                         float fps = atof(extract_parameter(arg_list, iter, next).c_str());
 434                         desc.set_frame_rate(fps);
 435                         VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
 436                 }
 437                 else if(*iter=="--dpi")
 438                 {
 439                         float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
 440                         float dots_per_meter=dpi*39.3700787402;
 441                         desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
 442                         VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
 443                 }
 444                 else if(*iter=="--dpi-x")
 445                 {
 446                         float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
 447                         float dots_per_meter=dpi*39.3700787402;
 448                         desc.set_x_res(dots_per_meter);
 449                         VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
 450                 }
 451                 else if(*iter=="--dpi-y")
 452                 {
 453                         float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
 454                         float dots_per_meter=dpi*39.3700787402;
 455                         desc.set_y_res(dots_per_meter);
 456                         VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
 457                 }
 458                 else if(*iter=="--start-time" || *iter=="--begin-time")
 459                 {
 460                         desc.set_time_start(Time(extract_parameter(arg_list, iter, next),
 461                                                                 desc.get_frame_rate()));
 462                 }
 463                 else if(*iter=="--end-time")
 464                 {
 465                         desc.set_time_end(Time(extract_parameter(arg_list, iter, next),
 466                                                                    desc.get_frame_rate()));
 467                 }
 468                 else if(*iter=="--time")
 469                 {
 470                         desc.set_time(Time(extract_parameter(arg_list, iter, next),
 471                                                            desc.get_frame_rate()));
 472                         VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
 473                 }
 474                 else if(*iter=="-g")
 475                 {
 476                         synfig::warning("Gamma argument is currently ignored");
 477                         //desc.set_gamma(Gamma(atoi(extract_parameter(arg_list, iter, next).c_str())));
 478                 }
 479                 else if (flag_requires_value(*iter))
 480                         iter++;
 481         }
 482         if (w||h)
 483         {
 484                 if (!w)
 485                         w = desc.get_w() * h / desc.get_h();
 486                 else if (!h)
 487                         h = desc.get_h() * w / desc.get_w();
 488
 489                 desc.set_wh(w,h);
 490                 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
 491         }
 492         if(span)
 493                 desc.set_span(span);
 494         return SYNFIGTOOL_OK;
 495 }
 496
 497 int extract_quality(arg_list_t &arg_list,int &quality)
 498 {
 499         arg_list_t::iterator iter, next;
 500         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 501         {
 502                 if(*iter=="-Q")
 503                 {
 504                         quality = atoi(extract_parameter(arg_list, iter, next).c_str());
 505                         VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
 506                 }
 507                 else if (flag_requires_value(*iter))
 508                         iter++;
 509         }
 510
 511         return SYNFIGTOOL_OK;
 512 }
 513
 514 int extract_threads(arg_list_t &arg_list,int &threads)
 515 {
 516         arg_list_t::iterator iter, next;
 517         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 518         {
 519                 if(*iter=="-T")
 520                 {
 521                         threads = atoi(extract_parameter(arg_list, iter, next).c_str());
 522                         VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
 523                 }
 524                 else if (flag_requires_value(*iter))
 525                         iter++;
 526         }
 527
 528         return SYNFIGTOOL_OK;
 529 }
 530
 531 int extract_target(arg_list_t &arg_list,string &type)
 532 {
 533         arg_list_t::iterator iter, next;
 534         type.clear();
 535
 536         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 537         {
 538                 if(*iter=="-t")
 539                 {
 540                         type = extract_parameter(arg_list, iter, next);
 541                 }
 542                 else if (flag_requires_value(*iter))
 543                         iter++;
 544         }
 545
 546         return SYNFIGTOOL_OK;
 547 }
 548
 549 int extract_append(arg_list_t &arg_list,string &filename)
 550 {
 551         arg_list_t::iterator iter, next;
 552         filename.clear();
 553
 554         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 555         {
 556                 if(*iter=="--append")
 557                 {
 558                         filename = extract_parameter(arg_list, iter, next);
 559                 }
 560                 else if (flag_requires_value(*iter))
 561                         iter++;
 562         }
 563
 564         return SYNFIGTOOL_OK;
 565 }
 566
 567 int extract_outfile(arg_list_t &arg_list,string &outfile)
 568 {
 569         arg_list_t::iterator iter, next;
 570         int ret=SYNFIGTOOL_FILENOTFOUND;
 571         outfile.clear();
 572
 573         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 574         {
 575                 if(*iter=="-o")
 576                 {
 577                         outfile = extract_parameter(arg_list, iter, next);
 578                         ret=SYNFIGTOOL_OK;
 579                 }
 580                 else if (flag_requires_value(*iter))
 581                         iter++;
 582         }
 583
 584         return ret;
 585 }
 586
 587 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
 588 {
 589         arg_list_t::iterator iter, next;
 590         //canvasid.clear();
 591
 592         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 593         {
 594                 if(*iter=="-c")
 595                 {
 596                         canvasid = extract_parameter(arg_list, iter, next);
 597                 }
 598                 else if (flag_requires_value(*iter))
 599                         iter++;
 600         }
 601
 602         return SYNFIGTOOL_OK;
 603 }
 604
 605 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
 606 {
 607         arg_list_t::iterator iter, next;
 608
 609         for(next=arg_list.begin(), iter = next++; iter!=arg_list.end();
 610                 iter = next++)
 611                 if(*iter=="--list-canvases")
 612                 {
 613                         list_canvases = true;
 614                         arg_list.erase(iter);
 615                 }
 616
 617         return SYNFIGTOOL_OK;
 618 }
 619
 620 void extract_canvas_info(arg_list_t &arg_list, Job &job)
 621 {
 622         arg_list_t::iterator iter, next;
 623
 624         for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
 625                 if(*iter=="--canvas-info")
 626                 {
 627                         job.canvas_info = true;
 628                         String values(extract_parameter(arg_list, iter, next)), value;
 629
 630                         std::string::size_type pos;
 631                         while (!values.empty())
 632                         {
 633                                 pos = values.find_first_of(',');
 634                                 if (pos == std::string::npos)
 635                                 {
 636                                         value = values;
 637                                         values = "";
 638                                 }
 639                                 else
 640                                 {
 641                                         value = values.substr(0, pos);
 642                                         values = values.substr(pos+1);
 643                                 }
 644                                 if (value == "all")
 645                                 {
 646                                         job.canvas_info_all = true;
 647                                         return;
 648                                 }
 649
 650                                 if (value == "time_start")                      job.canvas_info_time_start              = true;
 651                                 else if (value == "time_end")           job.canvas_info_time_end                = true;
 652                                 else if (value == "frame_rate")         job.canvas_info_frame_rate              = true;
 653                                 else if (value == "frame_start")        job.canvas_info_frame_start             = true;
 654                                 else if (value == "frame_end")          job.canvas_info_frame_end               = true;
 655                                 else if (value == "w")                          job.canvas_info_w                               = true;
 656                                 else if (value == "h")                          job.canvas_info_h                               = true;
 657                                 else if (value == "image_aspect")       job.canvas_info_image_aspect    = true;
 658                                 else if (value == "pw")                         job.canvas_info_pw                              = true;
 659                                 else if (value == "ph")                         job.canvas_info_ph                              = true;
 660                                 else if (value == "pixel_aspect")       job.canvas_info_pixel_aspect    = true;
 661                                 else if (value == "tl")                         job.canvas_info_tl                              = true;
 662                                 else if (value == "br")                         job.canvas_info_br                              = true;
 663                                 else if (value == "physical_w")         job.canvas_info_physical_w              = true;
 664                                 else if (value == "physical_h")         job.canvas_info_physical_h              = true;
 665                                 else if (value == "x_res")                      job.canvas_info_x_res                   = true;
 666                                 else if (value == "y_res")                      job.canvas_info_y_res                   = true;
 667                                 else if (value == "span")                       job.canvas_info_span                    = true;
 668                                 else if (value == "interlaced")         job.canvas_info_interlaced              = true;
 669                                 else if (value == "antialias")          job.canvas_info_antialias               = true;
 670                                 else if (value == "clamp")                      job.canvas_info_clamp                   = true;
 671                                 else if (value == "flags")                      job.canvas_info_flags                   = true;
 672                                 else if (value == "focus")                      job.canvas_info_focus                   = true;
 673                                 else if (value == "bg_color")           job.canvas_info_bg_color                = true;
 674                                 else if (value == "metadata")           job.canvas_info_metadata                = true;
 675                                 else
 676                                 {
 677                                         cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
 678                                         cerr<<_("Recognized variables are:") << endl <<
 679                                                 "  all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
 680                                                 "  image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
 681                                                 "  x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
 682                                                 "  focus, bg_color, metadata" << endl;
 683                                 }
 684
 685                                 if (pos == std::string::npos)
 686                                         break;
 687                         };
 688                 }
 689 }
 690
 691 void list_child_canvases(string prefix, Canvas::Handle canvas)
 692 {
 693         Canvas::Children children(canvas->children());
 694         for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
 695         {
 696                 cout << prefix << ":" << (*iter)->get_id() << endl;
 697                 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
 698         }
 699 }
 700
 701 void list_canvas_info(Job job)
 702 {
 703         Canvas::Handle canvas(job.canvas);
 704         const RendDesc &rend_desc(canvas->rend_desc());
 705
 706         if (job.canvas_info_all || job.canvas_info_time_start)
 707         {
 708                 cout << endl << "# " << _("Start Time") << endl;
 709                 cout << "time_start"    << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
 710         }
 711
 712         if (job.canvas_info_all || job.canvas_info_time_end)
 713         {
 714                 cout << endl << "# " << _("End Time") << endl;
 715                 cout << "time_end"              << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
 716         }
 717
 718         if (job.canvas_info_all || job.canvas_info_frame_rate)
 719         {
 720                 cout << endl << "# " << _("Frame Rate") << endl;
 721                 cout << "frame_rate"    << "=" << rend_desc.get_frame_rate() << endl;
 722         }
 723
 724         if (job.canvas_info_all || job.canvas_info_frame_start)
 725         {
 726                 cout << endl << "# " << _("Start Frame") << endl;
 727                 cout << "frame_start"   << "=" << rend_desc.get_frame_start() << endl;
 728         }
 729
 730         if (job.canvas_info_all || job.canvas_info_frame_end)
 731         {
 732                 cout << endl << "# " << _("End Frame") << endl;
 733                 cout << "frame_end"             << "=" << rend_desc.get_frame_end() << endl;
 734         }
 735
 736         if (job.canvas_info_all)
 737                 cout << endl;
 738
 739         if (job.canvas_info_all || job.canvas_info_w)
 740         {
 741                 cout << endl << "# " << _("Width") << endl;
 742                 cout << "w"                             << "=" << rend_desc.get_w() << endl;
 743         }
 744
 745         if (job.canvas_info_all || job.canvas_info_h)
 746         {
 747                 cout << endl << "# " << _("Height") << endl;
 748                 cout << "h"                             << "=" << rend_desc.get_h() << endl;
 749         }
 750
 751         if (job.canvas_info_all || job.canvas_info_image_aspect)
 752         {
 753                 cout << endl << "# " << _("Image Aspect Ratio") << endl;
 754                 cout << "image_aspect"  << "=" << rend_desc.get_image_aspect() << endl;
 755         }
 756
 757         if (job.canvas_info_all)
 758                 cout << endl;
 759
 760         if (job.canvas_info_all || job.canvas_info_pw)
 761         {
 762                 cout << endl << "# " << _("Pixel Width") << endl;
 763                 cout << "pw"                    << "=" << rend_desc.get_pw() << endl;
 764         }
 765
 766         if (job.canvas_info_all || job.canvas_info_ph)
 767         {
 768                 cout << endl << "# " << _("Pixel Height") << endl;
 769                 cout << "ph"                    << "=" << rend_desc.get_ph() << endl;
 770         }
 771
 772         if (job.canvas_info_all || job.canvas_info_pixel_aspect)
 773         {
 774                 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
 775                 cout << "pixel_aspect"  << "=" << rend_desc.get_pixel_aspect() << endl;
 776         }
 777
 778         if (job.canvas_info_all)
 779                 cout << endl;
 780
 781         if (job.canvas_info_all || job.canvas_info_tl)
 782         {
 783                 cout << endl << "# " << _("Top Left") << endl;
 784                 cout << "tl"                    << "=" << rend_desc.get_tl()[0]
 785                          << " " << rend_desc.get_tl()[1] << endl;
 786         }
 787
 788         if (job.canvas_info_all || job.canvas_info_br)
 789         {
 790                 cout << endl << "# " << _("Bottom Right") << endl;
 791                 cout << "br"                    << "=" << rend_desc.get_br()[0]
 792                          << " " << rend_desc.get_br()[1] << endl;
 793         }
 794
 795         if (job.canvas_info_all || job.canvas_info_physical_w)
 796         {
 797                 cout << endl << "# " << _("Physical Width") << endl;
 798                 cout << "physical_w"    << "=" << rend_desc.get_physical_w() << endl;
 799         }
 800
 801         if (job.canvas_info_all || job.canvas_info_physical_h)
 802         {
 803                 cout << endl << "# " << _("Physical Height") << endl;
 804                 cout << "physical_h"    << "=" << rend_desc.get_physical_h() << endl;
 805         }
 806
 807         if (job.canvas_info_all || job.canvas_info_x_res)
 808         {
 809                 cout << endl << "# " << _("X Resolution") << endl;
 810                 cout << "x_res"                 << "=" << rend_desc.get_x_res() << endl;
 811         }
 812
 813         if (job.canvas_info_all || job.canvas_info_y_res)
 814         {
 815                 cout << endl << "# " << _("Y Resolution") << endl;
 816                 cout << "y_res"                 << "=" << rend_desc.get_y_res() << endl;
 817         }
 818
 819         if (job.canvas_info_all || job.canvas_info_span)
 820         {
 821                 cout << endl << "# " << _("Diagonal Image Span") << endl;
 822                 cout << "span"                  << "=" << rend_desc.get_span() << endl;
 823         }
 824
 825         if (job.canvas_info_all)
 826                 cout << endl;
 827
 828         if (job.canvas_info_all || job.canvas_info_interlaced)
 829         {
 830                 cout << endl << "# " << _("Interlaced") << endl;
 831                 cout << "interlaced"    << "=" << rend_desc.get_interlaced() << endl;
 832         }
 833
 834         if (job.canvas_info_all || job.canvas_info_antialias)
 835         {
 836                 cout << endl << "# " << _("Antialias") << endl;
 837                 cout << "antialias"             << "=" << rend_desc.get_antialias() << endl;
 838         }
 839
 840         if (job.canvas_info_all || job.canvas_info_clamp)
 841         {
 842                 cout << endl << "# " << _("Clamp") << endl;
 843                 cout << "clamp"                 << "=" << rend_desc.get_clamp() << endl;
 844         }
 845
 846         if (job.canvas_info_all || job.canvas_info_flags)
 847         {
 848                 cout << endl << "# " << _("Flags") << endl;
 849                 cout << "flags"                 << "=" << rend_desc.get_flags() << endl;
 850         }
 851
 852         if (job.canvas_info_all || job.canvas_info_focus)
 853         {
 854                 cout << endl << "# " << _("Focus") << endl;
 855                 cout << "focus"                 << "=" << rend_desc.get_focus()[0]
 856                          << " " << rend_desc.get_focus()[1] << endl;
 857         }
 858
 859         if (job.canvas_info_all || job.canvas_info_bg_color)
 860         {
 861                 cout << endl << "# " << _("Background Color") << endl;
 862                 cout << "bg_color"              << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
 863         }
 864
 865         if (job.canvas_info_all)
 866                 cout << endl;
 867
 868         if (job.canvas_info_all || job.canvas_info_metadata)
 869         {
 870                 std::list<String> keys(canvas->get_meta_data_keys());
 871                 cout << endl << "# " << _("Metadata") << endl;
 872                 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
 873                         cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
 874         }
 875 }
 876
 877 /* === M E T H O D S ======================================================= */
 878
 879 /* === E N T R Y P O I N T ================================================= */
 880
 881 int main(int argc, char *argv[])
 882 {
 883         int i;
 884         arg_list_t arg_list;
 885         job_list_t job_list;
 886
 887         setlocale(LC_ALL, "");
 888
 889 #ifdef ENABLE_NLS
 890         bindtextdomain("synfig", LOCALEDIR);
 891         bind_textdomain_codeset("synfig", "UTF-8");
 892         textdomain("synfig");
 893 #endif
 894
 895         progname=argv[0];
 896         Progress p(argv[0]);
 897
 898         if(!SYNFIG_CHECK_VERSION())
 899         {
 900                 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
 901                 return SYNFIGTOOL_BADVERSION;
 902         }
 903
 904         if(argc==1)
 905         {
 906                 display_help(false);
 907                 return SYNFIGTOOL_BLANK;
 908         }
 909
 910         for(i=1;i<argc;i++)
 911                 arg_list.push_back(argv[i]);
 912
 913         if((i=process_global_flags(arg_list)))
 914                 return i;
 915
 916         VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
 917         synfig::Main synfig_main(dirname(progname),&p);
 918
 919         {
 920                 arg_list_t defaults, imageargs;
 921                 int ret;
 922
 923                 // Grab the defaults before the first file
 924                 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
 925                   return ret;
 926
 927                 while(arg_list.size())
 928                 {
 929                         string target_name;
 930                         job_list.push_front(Job());
 931                         int threads=0;
 932
 933                         imageargs=defaults;
 934                         job_list.front().filename=arg_list.front();
 935                         arg_list.pop_front();
 936
 937                         if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
 938                           return ret;
 939
 940                         // Open the composition
 941                         String errors, warnings;
 942                         try
 943                         {
 944                                 job_list.front().root=open_canvas(job_list.front().filename, errors, warnings);
 945                         }
 946                         catch(runtime_error x)
 947                         {
 948                                 job_list.front().root = 0;
 949                         }
 950
 951                         if(!job_list.front().root)
 952                         {
 953                                 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
 954                                 cerr<<_("Throwing out job...")<<endl;
 955                                 job_list.pop_front();
 956                                 continue;
 957                         }
 958
 959                         bool list_canvases = false;
 960                         extract_list_canvases(imageargs, list_canvases);
 961                         job_list.front().list_canvases = list_canvases;
 962
 963                         extract_canvas_info(imageargs, job_list.front());
 964
 965                         job_list.front().root->set_time(0);
 966
 967                         string canvasid;
 968                         extract_canvasid(imageargs,canvasid);
 969                         if(!canvasid.empty())
 970                         {
 971                                 try
 972                                 {
 973                                         String warnings;
 974                                         job_list.front().canvas=job_list.front().root->find_canvas(canvasid, warnings);
 975                                 }
 976                                 catch(Exception::IDNotFound)
 977                                 {
 978                                         cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
 979                                         cerr<<_("Throwing out job...")<<endl;
 980                                         job_list.pop_front();
 981                                         continue;
 982
 983                                 }
 984                                 catch(Exception::BadLinkName)
 985                                 {
 986                                         cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
 987                                         cerr<<_("Throwing out job...")<<endl;
 988                                         job_list.pop_front();
 989                                         continue;
 990                                 }
 991                         }
 992                         else
 993                                 job_list.front().canvas=job_list.front().root;
 994
 995                         extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
 996                         extract_target(imageargs,target_name);
 997                         extract_threads(imageargs,threads);
 998                         job_list.front().quality=DEFAULT_QUALITY;
 999                         extract_quality(imageargs,job_list.front().quality);
1000                         VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
1001                         job_list.front().desc=job_list.front().canvas->rend_desc();
1002                         extract_outfile(imageargs,job_list.front().outfilename);
1003
1004                         // Extract composite
1005                         do{
1006                                 string composite_file;
1007                                 extract_append(imageargs,composite_file);
1008                                 if(!composite_file.empty())
1009                                 {
1010                                         String errors, warnings;
1011                                         Canvas::Handle composite(open_canvas(composite_file, errors, warnings));
1012                                         if(!composite)
1013                                         {
1014                                                 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1015                                                 break;
1016                                         }
1017                                         Canvas::reverse_iterator iter;
1018                                         for(iter=composite->rbegin();iter!=composite->rend();++iter)
1019                                         {
1020                                                 Layer::Handle layer(*iter);
1021                                                 if(layer->active())
1022                                                         job_list.front().canvas->push_front(layer->clone());
1023                                         }
1024                                         VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1025                                 }
1026                         } while(false);
1027
1028                         VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1029
1030                         // If the target type is not yet defined,
1031                         // try to figure it out from the outfile.
1032                         if(target_name.empty() && !job_list.front().outfilename.empty())
1033                         {
1034                                 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1035                                 string ext = filename_extension(job_list.front().outfilename);
1036                                 if (ext.length()) ext = ext.substr(1);
1037                                 if(Target::ext_book().count(ext))
1038                                 {
1039                                         target_name=Target::ext_book()[ext];
1040                                         info("target name not specified - using %s", target_name.c_str());
1041                                 }
1042                                 else
1043                                 {
1044                                         string lower_ext(ext);
1045
1046                                         for(unsigned int i=0;i<ext.length();i++)
1047                                                 lower_ext[i] = tolower(ext[i]);
1048
1049                                         if(Target::ext_book().count(lower_ext))
1050                                         {
1051                                                 target_name=Target::ext_book()[lower_ext];
1052                                                 info("target name not specified - using %s", target_name.c_str());
1053                                         }
1054                                         else
1055                                                 target_name=ext;
1056                                 }
1057                         }
1058
1059                         // If the target type is STILL not yet defined, then
1060                         // set it to a some sort of default
1061                         if(target_name.empty())
1062                         {
1063                                 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1064                                 target_name="png";
1065                         }
1066
1067                         // If no output filename was provided, then
1068                         // create a output filename based on the
1069                         // given input filename. (ie: change the extension)
1070                         if(job_list.front().outfilename.empty())
1071                         {
1072                                 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1073                                 if(Target::book().count(target_name))
1074                                         job_list.front().outfilename+=Target::book()[target_name].filename;
1075                                 else
1076                                         job_list.front().outfilename+=target_name;
1077                         }
1078
1079                         VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1080                         VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1081
1082                         VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1083                         job_list.front().target=synfig::Target::create(target_name,job_list.front().outfilename);
1084
1085                         if(target_name=="sif")
1086                                 job_list.front().sifout=true;
1087                         else
1088                         {
1089                                 if(!job_list.front().target)
1090                                 {
1091                                         cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1092                                         cerr<<_("Throwing out job...")<<endl;
1093                                         job_list.pop_front();
1094                                         continue;
1095                                 }
1096                                 job_list.front().sifout=false;
1097                         }
1098
1099                         // Set the Canvas on the Target
1100                         if(job_list.front().target)
1101                         {
1102                                 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1103                                 job_list.front().target->set_canvas(job_list.front().canvas);
1104                                 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1105                                 job_list.front().target->set_quality(job_list.front().quality);
1106                         }
1107
1108                         // Set the threads for the target
1109                         if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1110                                 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1111
1112                         if(imageargs.size())
1113                         {
1114                                 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1115                                 for(;imageargs.size();imageargs.pop_front())
1116                                         cerr<<' '<<imageargs.front();
1117                                 cerr<<endl;
1118                                 cerr<<_("Throwing out job...")<<endl;
1119                                 job_list.pop_front();
1120                                 continue;
1121                         }
1122                 }
1123         }
1124
1125         if(arg_list.size())
1126         {
1127                 cerr<<_("Unidentified arguments:");
1128                 for(;arg_list.size();arg_list.pop_front())
1129                         cerr<<' '<<arg_list.front();
1130                 cerr<<endl;
1131                 return SYNFIGTOOL_UNKNOWNARGUMENT;
1132         }
1133
1134         if(!job_list.size())
1135         {
1136                 cerr<<_("Nothing to do!")<<endl;
1137                 return SYNFIGTOOL_BORED;
1138         }
1139
1140         for(;job_list.size();job_list.pop_front())
1141         {
1142                 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1143                 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1144                         job_list.front().desc.get_w(),
1145                         job_list.front().desc.get_h(),
1146                         job_list.front().desc.get_antialias(),
1147                         job_list.front().desc.get_pixel_aspect(),
1148                         job_list.front().desc.get_image_aspect(),
1149                         job_list.front().desc.get_span()
1150                         )<<endl<<'\t'<<
1151                 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1152                         job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1153                         job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1154                         job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1155                         )<<endl;
1156
1157                 RenderProgress p;
1158                 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1159                 if(job_list.front().sifout)
1160                 {
1161                         if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1162                         {
1163                                 cerr<<"Render Failure."<<endl;
1164                                 return SYNFIGTOOL_RENDERFAILURE;
1165                         }
1166                 }
1167                 else if (job_list.front().list_canvases)
1168                 {
1169                         list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1170                         cerr << endl;
1171                 }
1172                 else if (job_list.front().canvas_info)
1173                 {
1174                         list_canvas_info(job_list.front());
1175                         cerr << endl;
1176                 }
1177                 else
1178                 {
1179                         VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1180                         etl::clock timer;
1181                         timer.reset();
1182                         // Call the render member of the target
1183                         if(!job_list.front().target->render(&p))
1184                         {
1185                                 cerr<<"Render Failure."<<endl;
1186                                 return SYNFIGTOOL_RENDERFAILURE;
1187                         }
1188                         if(print_benchmarks)
1189                                 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1190                 }
1191         }
1192
1193         job_list.clear();
1194
1195         VERBOSE_OUT(1)<<_("Done.")<<endl;
1196
1197         return SYNFIGTOOL_OK;
1198 }