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