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