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