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