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