Show an appropriate error message when the command line --append flag fails to open...
[synfig.git] / synfig-core / trunk / src / tool / main.cpp
blob13fc4384dbed7b911a02b82983526a2af738f70d
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
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.
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
22 /* ========================================================================= */
24 /* === H E A D E R S ======================================================= */
26 #ifdef USING_PCH
27 # include "pch.h"
28 #else
29 #ifdef HAVE_CONFIG_H
30 # include <config.h>
31 #endif
33 #include <iostream>
34 #include <ETL/stringf>
35 #include <list>
36 #include <ETL/clock>
37 #include <algorithm>
38 #include <cstring>
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
55 using namespace std;
56 using namespace etl;
57 using namespace synfig;
59 /* === M A C R O S ========================================================= */
61 #ifdef ENABLE_NLS
62 #undef _
63 #define _(x) gettext(x)
64 #else
65 #undef _
66 #define _(x) (x)
67 #endif
69 enum exit_code
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
84 #ifndef VERSION
85 #define VERSION "unknown"
86 #define PACKAGE "synfig-tool"
87 #endif
89 #ifdef DEFAULT_QUALITY
90 #undef DEFAULT_QUALITY
91 #endif
93 #define DEFAULT_QUALITY 2
94 #define VERBOSE_OUT(x) if(verbosity>=(x))std::cerr
96 /* === G L O B A L S ======================================================= */
98 const char *progname;
99 int verbosity=0;
100 bool be_quiet=false;
101 bool print_benchmarks=false;
103 /* === M E T H O D S ======================================================= */
105 class Progress : public synfig::ProgressCallback
107 const char *program;
109 public:
111 Progress(const char *name):program(name) { }
113 virtual bool
114 task(const String &task)
116 VERBOSE_OUT(1)<<program<<": "<<task<<std::endl;
117 return true;
120 virtual bool
121 error(const String &task)
123 std::cerr<<program<<": "<<_("error")<<": "<<task<<std::endl;
124 return true;
127 virtual bool
128 warning(const String &task)
130 std::cerr<<program<<": "<<_("warning")<<": "<<task<<std::endl;
131 return true;
134 virtual bool
135 amount_complete(int /*current*/, int /*total*/)
137 return true;
141 class RenderProgress : public synfig::ProgressCallback
143 string taskname;
145 etl::clock clk;
146 int clk_scanline; // The scanline at which the clock was reset
147 etl::clock clk2;
149 float last_time;
150 public:
152 RenderProgress():clk_scanline(0), last_time(0) { }
154 virtual bool
155 task(const String &thetask)
157 taskname=thetask;
158 return true;
161 virtual bool
162 error(const String &task)
164 std::cout<<_("error")<<": "<<task<<std::endl;
165 return true;
168 virtual bool
169 warning(const String &task)
171 std::cout<<_("warning")<<": "<<task<<std::endl;
172 return true;
175 virtual bool
176 amount_complete(int scanline, int h)
178 if(be_quiet)return true;
179 if(scanline!=h)
181 const float time(clk()*(float)(h-scanline)/(float)(scanline-clk_scanline));
182 const float delta(time-last_time);
184 int weeks=0,days=0,hours=0,minutes=0,seconds=0;
186 last_time=time;
188 if(clk2()<0.2)
189 return true;
190 clk2.reset();
192 if(scanline)
193 seconds=(int)time+1;
194 else
196 //cerr<<"reset"<<endl;
197 clk.reset();
198 clk_scanline=scanline;
201 if(seconds<0)
203 clk.reset();
204 clk_scanline=scanline;
205 seconds=0;
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;
216 cerr<<taskname<<": "<<_("Line")<<" "<<scanline<<_(" of ")<<h<<" -- ";
217 //cerr<<time/(h-clk_scanline)<<" ";
219 if(delta>=-time/(h-clk_scanline) )
220 cerr<<">";
222 if(delta>=0 && clk()>4.0 && scanline>clk_scanline+200)
224 //cerr<<"reset"<<endl;
225 clk.reset();
226 clk_scanline=scanline;
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 ";
240 cerr<<" \r";
242 else
243 cerr<<taskname<<": "<<_("DONE")<<" "<<endl;;
244 return true;
248 struct Job
250 String filename;
251 String outfilename;
253 RendDesc desc;
255 Canvas::Handle root;
256 Canvas::Handle canvas;
257 Target::Handle target;
259 int quality;
260 bool sifout;
261 bool list_canvases;
263 bool canvas_info, canvas_info_all, canvas_info_time_start, canvas_info_time_end, canvas_info_frame_rate,
264 canvas_info_frame_start, canvas_info_frame_end, canvas_info_w, canvas_info_h, canvas_info_image_aspect,
265 canvas_info_pw, canvas_info_ph, canvas_info_pixel_aspect, canvas_info_tl, canvas_info_br,
266 canvas_info_physical_w, canvas_info_physical_h, canvas_info_x_res, canvas_info_y_res, canvas_info_span,
267 canvas_info_interlaced, canvas_info_antialias, canvas_info_clamp, canvas_info_flags, canvas_info_focus,
268 canvas_info_bg_color, canvas_info_metadata;
270 Job()
272 canvas_info = canvas_info_all = canvas_info_time_start = canvas_info_time_end = canvas_info_frame_rate = canvas_info_frame_start = canvas_info_frame_end = canvas_info_w = canvas_info_h = canvas_info_image_aspect = canvas_info_pw = canvas_info_ph = canvas_info_pixel_aspect = canvas_info_tl = canvas_info_br = canvas_info_physical_w = canvas_info_physical_h = canvas_info_x_res = canvas_info_y_res = canvas_info_span = canvas_info_interlaced = canvas_info_antialias = canvas_info_clamp = canvas_info_flags = canvas_info_focus = canvas_info_bg_color = canvas_info_metadata = false;
276 typedef list<String> arg_list_t;
277 typedef list<Job> job_list_t;
279 void guid_test()
281 cout<<"GUID Test"<<endl;
282 for(int i=20;i;i--)
283 cout<<synfig::GUID().get_string()<<' '<<synfig::GUID().get_string()<<endl;
286 void signal_test_func()
288 cout<<"**SIGNAL CALLED**"<<endl;
291 void signal_test()
293 sigc::signal<void> sig;
294 sigc::connection conn;
295 cout<<"Signal Test"<<endl;
296 conn=sig.connect(sigc::ptr_fun(signal_test_func));
297 cout<<"Next line should exclaim signal called."<<endl;
298 sig();
299 conn.disconnect();
300 cout<<"Next line should NOT exclaim signal called."<<endl;
301 sig();
302 cout<<"done."<<endl;
305 /* === P R O C E D U R E S ================================================= */
307 void display_help(int amount)
309 class Argument
311 public:
312 Argument(const char *flag,const char *arg, string description)
314 const char spaces[]=" ";
315 if(arg)
316 cerr<<strprintf(" %s %s %s",flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description<<endl;
317 else
318 cerr<<strprintf(" %s %s",flag,spaces+strlen(flag))+description<<endl;
322 cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
324 if(amount == 0)
325 Argument("--help",NULL,_("Print out usage and syntax info"));
326 else
328 Argument("-t","<output type>",_("Specify output target (Default:unknown)"));
329 Argument("-w","<pixel width>",_("Set the image width (Use zero for file default)"));
330 Argument("-h","<pixel height>",_("Set the image height (Use zero for file default)"));
331 Argument("-s","<image dist>",_("Set the diagonal size of image window (Span)"));
332 Argument("-a","<1...30>",_("Set antialias amount for parametric renderer."));
333 Argument("-Q","<0...10>",strprintf(_("Specify image quality for accelerated renderer (default=%d)"),DEFAULT_QUALITY).c_str());
334 Argument("-g","<amount>",_("Gamma (default=2.2)"));
335 Argument("-v",NULL,_("Verbose Output (add more for more verbosity)"));
336 Argument("-q",NULL,_("Quiet mode (No progress/time-remaining display)"));
337 Argument("-c","<canvas id>",_("Render the canvas with the given id instead of the root."));
338 Argument("-o","<output file>",_("Specify output filename"));
339 Argument("-T","<# of threads>",_("Enable multithreaded renderer using specified # of threads"));
340 Argument("-b",NULL,_("Print Benchmarks"));
341 Argument("--fps","<framerate>",_("Set the frame rate"));
342 Argument("--time","<time>",_("Render a single frame at <seconds>"));
343 Argument("--begin-time","<time>",_("Set the starting time"));
344 Argument("--start-time","<time>",_("Set the starting time"));
345 Argument("--end-time","<time>",_("Set the ending time"));
346 Argument("--dpi","<res>",_("Set the physical resolution (dots-per-inch)"));
347 Argument("--dpi-x","<res>",_("Set the physical X resolution (dots-per-inch)"));
348 Argument("--dpi-y","<res>",_("Set the physical Y resolution (dots-per-inch)"));
350 Argument("--list-canvases",NULL,_("List the exported canvases in the composition"));
351 Argument("--canvas-info","<fields>",_("Print out specified details of the root canvas"));
352 Argument("--append","<filename>",_("Append layers in <filename> to composition"));
354 Argument("--layer-info","<layer>",_("Print out layer's description, parameter info, etc."));
355 Argument("--layers",NULL,_("Print out the list of available layers"));
356 Argument("--targets",NULL,_("Print out the list of available targets"));
357 Argument("--importers",NULL,_("Print out the list of available importers"));
358 Argument("--valuenodes",NULL,_("Print out the list of available ValueNodes"));
359 Argument("--modules",NULL,_("Print out the list of loaded modules"));
360 Argument("--version",NULL,_("Print out version information"));
361 Argument("--info",NULL,_("Print out misc build information"));
362 Argument("--license",NULL,_("Print out license information"));
364 #ifdef _DEBUG
365 Argument("--guid-test",NULL,_("Test GUID generation"));
366 Argument("--signal-test",NULL,_("Test signal implementation"));
367 #endif
370 cerr<<endl;
373 int process_global_flags(arg_list_t &arg_list)
375 arg_list_t::iterator iter, next;
377 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
379 if(*iter == "--")
380 return SYNFIGTOOL_OK;
382 if(*iter == "--signal-test")
384 signal_test();
385 return SYNFIGTOOL_HELP;
388 if(*iter == "--guid-test")
390 guid_test();
391 return SYNFIGTOOL_HELP;
394 if(*iter == "--help")
396 display_help(1);
397 return SYNFIGTOOL_HELP;
400 if(*iter == "--info")
402 cout<<PACKAGE"-"VERSION<<endl;
403 cout<<"Compiled on "__DATE__ /* " at "__TIME__ */;
404 #ifdef __GNUC__
405 cout<<" with GCC "<<__VERSION__;
406 #endif
407 #ifdef _MSC_VER
408 cout<<" with Microsoft Visual C++ "<<(_MSC_VER>>8)<<'.'<<(_MSC_VER&255);
409 #endif
410 #ifdef __TCPLUSPLUS__
411 cout<<" with Borland Turbo C++ "<<(__TCPLUSPLUS__>>8)<<'.'<<((__TCPLUSPLUS__&255)>>4)<<'.'<<(__TCPLUSPLUS__&15);
412 #endif
414 cout<<endl<<SYNFIG_COPYRIGHT<<endl;
415 cout<<endl;
416 return SYNFIGTOOL_HELP;
419 if(*iter == "--layers")
421 Progress p(PACKAGE);
422 synfig::Main synfig_main(dirname(progname),&p);
423 synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
424 for(;iter!=synfig::Layer::book().end();iter++)
425 if (iter->second.category != CATEGORY_DO_NOT_USE)
426 cout<<iter->first<<endl;
428 return SYNFIGTOOL_HELP;
431 if(*iter == "--layer-info")
433 Progress p(PACKAGE);
434 synfig::Main synfig_main(dirname(progname),&p);
435 iter=next++;
436 if (iter==arg_list.end())
438 error("The `%s' flag requires a value. Use --help for a list of options.", "--layer-info");
439 return SYNFIGTOOL_MISSINGARGUMENT;
441 Layer::Handle layer=synfig::Layer::create(*iter);
442 cout<<"Layer Name: "<<layer->get_name()<<endl;
443 cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
444 cout<<"Version: "<<layer->get_version()<<endl;
445 Layer::Vocab vocab=layer->get_param_vocab();
446 for(;!vocab.empty();vocab.pop_front())
448 cout<<"param - "<<vocab.front().get_name();
449 if(!vocab.front().get_critical())
450 cout<<" (not critical)";
451 cout<<endl<<"\tLocalized Name: "<<vocab.front().get_local_name()<<endl;
452 if(!vocab.front().get_description().empty())
453 cout<<"\tDescription: "<<vocab.front().get_description()<<endl;
454 if(!vocab.front().get_hint().empty())
455 cout<<"\tHint: "<<vocab.front().get_hint()<<endl;
458 return SYNFIGTOOL_HELP;
461 if(*iter == "--modules")
463 Progress p(PACKAGE);
464 synfig::Main synfig_main(dirname(progname),&p);
465 synfig::Module::Book::iterator iter=synfig::Module::book().begin();
466 for(;iter!=synfig::Module::book().end();iter++)
467 cout<<iter->first<<endl;
468 return SYNFIGTOOL_HELP;
471 if(*iter == "--targets")
473 Progress p(PACKAGE);
474 synfig::Main synfig_main(dirname(progname),&p);
475 synfig::Target::Book::iterator iter=synfig::Target::book().begin();
476 for(;iter!=synfig::Target::book().end();iter++)
477 cout<<iter->first<<endl;
478 return SYNFIGTOOL_HELP;
481 if(*iter == "--valuenodes")
483 Progress p(PACKAGE);
484 synfig::Main synfig_main(dirname(progname),&p);
485 synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
486 for(;iter!=synfig::LinkableValueNode::book().end();iter++)
487 cout<<iter->first<<endl;
488 return SYNFIGTOOL_HELP;
491 if(*iter == "--importers")
493 Progress p(PACKAGE);
494 synfig::Main synfig_main(dirname(progname),&p);
495 synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
496 for(;iter!=synfig::Importer::book().end();iter++)
497 cout<<iter->first<<endl;
498 return SYNFIGTOOL_HELP;
501 if(*iter == "--version")
503 cerr<<PACKAGE<<" "<<VERSION<<endl;
504 arg_list.erase(iter);
505 return SYNFIGTOOL_HELP;
508 if(*iter == "--license")
510 cerr<<PACKAGE<<" "<<VERSION<<endl;
511 cout<<SYNFIG_COPYRIGHT<<endl<<endl;
512 cerr<<"\
513 ** This package is free software; you can redistribute it and/or\n\
514 ** modify it under the terms of the GNU General Public License as\n\
515 ** published by the Free Software Foundation; either version 2 of\n\
516 ** the License, or (at your option) any later version.\n\
517 **\n\
518 ** " << endl << endl;
519 arg_list.erase(iter);
520 return SYNFIGTOOL_HELP;
523 if(*iter == "-v")
525 verbosity++;
526 arg_list.erase(iter);
527 continue;
530 if(*iter == "-q")
532 be_quiet=true;
533 arg_list.erase(iter);
534 continue;
536 if(*iter == "-b")
538 print_benchmarks=true;
539 arg_list.erase(iter);
540 continue;
544 return SYNFIGTOOL_OK;
547 /* true if the given flag takes an extra parameter */
548 bool flag_requires_value(String flag)
550 return (flag=="-a" || flag=="-c" || flag=="-g" || flag=="-h" || flag=="-o" ||
551 flag=="-Q" || flag=="-s" || flag=="-t" || flag=="-T" || flag=="-w" ||
552 flag=="--append" || flag=="--begin-time" || flag=="--canvas-info"|| flag=="--dpi" || flag=="--dpi-x" ||
553 flag=="--dpi-y" || flag=="--end-time" || flag=="--fps" || flag=="--layer-info" || flag=="--start-time" ||
554 flag=="--time" );
557 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
559 arg_list_t::iterator iter, next;
561 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
563 if(*iter->begin() != '-')
565 //cerr<<*iter->begin()<<"-----------"<<endl;
566 return SYNFIGTOOL_OK;
569 if (flag_requires_value(*iter))
571 cluster.push_back(*iter);
572 arg_list.erase(iter);
573 iter=next++;
574 if (iter==arg_list.end())
576 error("The `%s' flag requires a value. Use --help for a list of options.", cluster.back().c_str());
577 return SYNFIGTOOL_MISSINGARGUMENT;
581 cluster.push_back(*iter);
582 arg_list.erase(iter);
585 return SYNFIGTOOL_OK;
588 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
590 arg_list_t::iterator iter, next;
591 int w=0,h=0;
592 float span=0;
593 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
595 if(*iter=="-w")
597 arg_list.erase(iter);
598 iter=next++;
599 w=atoi(iter->c_str());
600 arg_list.erase(iter);
602 else if(*iter=="-h")
604 arg_list.erase(iter);
605 iter=next++;
606 h=atoi(iter->c_str());
607 arg_list.erase(iter);
609 else if(*iter=="-a")
611 int a;
612 arg_list.erase(iter);
613 iter=next++;
614 a=atoi(iter->c_str());
615 desc.set_antialias(a);
616 VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
617 arg_list.erase(iter);
619 else if(*iter=="-s")
621 arg_list.erase(iter);
622 iter=next++;
623 span=atof(iter->c_str());
624 VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
625 arg_list.erase(iter);
627 else if(*iter=="--fps")
629 arg_list.erase(iter);
630 iter=next++;
631 float fps=atof(iter->c_str());
632 desc.set_frame_rate(fps);
633 arg_list.erase(iter);
634 VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
636 else if(*iter=="--dpi")
638 arg_list.erase(iter);
639 iter=next++;
640 float dpi=atof(iter->c_str());
641 float dots_per_meter=dpi*39.3700787402;
642 desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
643 arg_list.erase(iter);
644 VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
646 else if(*iter=="--dpi-x")
648 arg_list.erase(iter);
649 iter=next++;
650 float dpi=atof(iter->c_str());
651 float dots_per_meter=dpi*39.3700787402;
652 desc.set_x_res(dots_per_meter);
653 arg_list.erase(iter);
654 VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
656 else if(*iter=="--dpi-y")
658 arg_list.erase(iter);
659 iter=next++;
660 float dpi=atof(iter->c_str());
661 float dots_per_meter=dpi*39.3700787402;
662 desc.set_y_res(dots_per_meter);
663 arg_list.erase(iter);
664 VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
666 else if(*iter=="--start-time" || *iter=="--begin-time")
668 arg_list.erase(iter);
669 iter=next++;
670 desc.set_time_start(Time(*iter,desc.get_frame_rate()));
671 arg_list.erase(iter);
673 else if(*iter=="--end-time")
675 arg_list.erase(iter);
676 iter=next++;
677 desc.set_time_end(Time(*iter,desc.get_frame_rate()));
678 arg_list.erase(iter);
680 else if(*iter=="--time")
682 arg_list.erase(iter);
683 iter=next++;
684 desc.set_time(Time(*iter,desc.get_frame_rate()));
685 VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
686 arg_list.erase(iter);
688 else if(*iter=="-g")
690 synfig::warning("Gamma argument is currently ignored");
691 arg_list.erase(iter);
692 iter=next++;
693 //desc.set_gamma(Gamma(atof(iter->c_str())));
694 arg_list.erase(iter);
696 else if (flag_requires_value(*iter))
697 iter=next++;
699 if (w||h)
701 if (!w)
702 w = desc.get_w() * h / desc.get_h();
703 else if (!h)
704 h = desc.get_h() * w / desc.get_w();
706 desc.set_wh(w,h);
707 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
709 if(span)
710 desc.set_span(span);
711 return SYNFIGTOOL_OK;
714 int extract_quality(arg_list_t &arg_list,int &quality)
716 arg_list_t::iterator iter, next;
717 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
719 if(*iter=="-Q")
721 arg_list.erase(iter);
722 iter=next++;
723 quality=atoi(iter->c_str());
724 VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
725 arg_list.erase(iter);
727 else if (flag_requires_value(*iter))
728 iter=next++;
731 return SYNFIGTOOL_OK;
734 int extract_threads(arg_list_t &arg_list,int &threads)
736 arg_list_t::iterator iter, next;
737 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
739 if(*iter=="-T")
741 arg_list.erase(iter);
742 iter=next++;
743 threads=atoi(iter->c_str());
744 VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
745 arg_list.erase(iter);
747 else if (flag_requires_value(*iter))
748 iter=next++;
751 return SYNFIGTOOL_OK;
754 int extract_target(arg_list_t &arg_list,string &type)
756 arg_list_t::iterator iter, next;
757 type.clear();
759 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
761 if(*iter=="-t")
763 arg_list.erase(iter);
764 iter=next++;
765 type=*iter;
766 arg_list.erase(iter);
768 else if (flag_requires_value(*iter))
769 iter=next++;
772 return SYNFIGTOOL_OK;
775 int extract_append(arg_list_t &arg_list,string &filename)
777 arg_list_t::iterator iter, next;
778 filename.clear();
780 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
782 if(*iter=="--append")
784 arg_list.erase(iter);
785 iter=next++;
786 filename=*iter;
787 arg_list.erase(iter);
789 else if (flag_requires_value(*iter))
790 iter=next++;
793 return SYNFIGTOOL_OK;
796 int extract_outfile(arg_list_t &arg_list,string &outfile)
798 arg_list_t::iterator iter, next;
799 int ret=SYNFIGTOOL_FILENOTFOUND;
800 outfile.clear();
802 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
804 if(*iter=="-o")
806 arg_list.erase(iter);
807 iter=next++;
808 outfile=*iter;
809 arg_list.erase(iter);
810 ret=SYNFIGTOOL_OK;
812 else if (flag_requires_value(*iter))
813 iter=next++;
816 return ret;
819 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
821 arg_list_t::iterator iter, next;
822 //canvasid.clear();
824 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
826 if(*iter=="-c")
828 arg_list.erase(iter);
829 iter=next++;
830 canvasid=*iter;
831 arg_list.erase(iter);
833 else if (flag_requires_value(*iter))
834 iter=next++;
837 return SYNFIGTOOL_OK;
840 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
842 arg_list_t::iterator iter, next;
844 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
845 if(*iter=="--list-canvases")
847 list_canvases = true;
848 arg_list.erase(iter);
851 return SYNFIGTOOL_OK;
854 void extract_canvas_info(arg_list_t &arg_list, Job &job)
856 arg_list_t::iterator iter, next;
858 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
859 if(*iter=="--canvas-info")
861 job.canvas_info = true;
862 arg_list.erase(iter);
863 iter=next++;
864 String values(*iter), value;
865 arg_list.erase(iter);
867 std::string::size_type pos;
868 while (!values.empty())
870 pos = values.find_first_of(',');
871 if (pos == std::string::npos)
873 value = values;
874 values = "";
876 else
878 value = values.substr(0, pos);
879 values = values.substr(pos+1);
881 if (value == "all")
883 job.canvas_info_all = true;
884 return;
887 if (value == "time_start") job.canvas_info_time_start = true;
888 else if (value == "time_end") job.canvas_info_time_end = true;
889 else if (value == "frame_rate") job.canvas_info_frame_rate = true;
890 else if (value == "frame_start") job.canvas_info_frame_start = true;
891 else if (value == "frame_end") job.canvas_info_frame_end = true;
892 else if (value == "w") job.canvas_info_w = true;
893 else if (value == "h") job.canvas_info_h = true;
894 else if (value == "image_aspect") job.canvas_info_image_aspect = true;
895 else if (value == "pw") job.canvas_info_pw = true;
896 else if (value == "ph") job.canvas_info_ph = true;
897 else if (value == "pixel_aspect") job.canvas_info_pixel_aspect = true;
898 else if (value == "tl") job.canvas_info_tl = true;
899 else if (value == "br") job.canvas_info_br = true;
900 else if (value == "physical_w") job.canvas_info_physical_w = true;
901 else if (value == "physical_h") job.canvas_info_physical_h = true;
902 else if (value == "x_res") job.canvas_info_x_res = true;
903 else if (value == "y_res") job.canvas_info_y_res = true;
904 else if (value == "span") job.canvas_info_span = true;
905 else if (value == "interlaced") job.canvas_info_interlaced = true;
906 else if (value == "antialias") job.canvas_info_antialias = true;
907 else if (value == "clamp") job.canvas_info_clamp = true;
908 else if (value == "flags") job.canvas_info_flags = true;
909 else if (value == "focus") job.canvas_info_focus = true;
910 else if (value == "bg_color") job.canvas_info_bg_color = true;
911 else if (value == "metadata") job.canvas_info_metadata = true;
912 else
914 cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
915 cerr<<_("Recognized variables are:") << endl <<
916 " all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
917 " image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
918 " x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
919 " focus, bg_color, metadata" << endl;
922 if (pos == std::string::npos)
923 break;
928 void list_child_canvases(string prefix, Canvas::Handle canvas)
930 Canvas::Children children(canvas->children());
931 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
933 cout << prefix << ":" << (*iter)->get_id() << endl;
934 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
938 void list_canvas_info(Job job)
940 Canvas::Handle canvas(job.canvas);
941 const RendDesc &rend_desc(canvas->rend_desc());
943 if (job.canvas_info_all || job.canvas_info_time_start)
945 cout << endl << "# " << _("Start Time") << endl;
946 cout << "time_start" << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
949 if (job.canvas_info_all || job.canvas_info_time_end)
951 cout << endl << "# " << _("End Time") << endl;
952 cout << "time_end" << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
955 if (job.canvas_info_all || job.canvas_info_frame_rate)
957 cout << endl << "# " << _("Frame Rate") << endl;
958 cout << "frame_rate" << "=" << rend_desc.get_frame_rate() << endl;
961 if (job.canvas_info_all || job.canvas_info_frame_start)
963 cout << endl << "# " << _("Start Frame") << endl;
964 cout << "frame_start" << "=" << rend_desc.get_frame_start() << endl;
967 if (job.canvas_info_all || job.canvas_info_frame_end)
969 cout << endl << "# " << _("End Frame") << endl;
970 cout << "frame_end" << "=" << rend_desc.get_frame_end() << endl;
973 if (job.canvas_info_all)
974 cout << endl;
976 if (job.canvas_info_all || job.canvas_info_w)
978 cout << endl << "# " << _("Width") << endl;
979 cout << "w" << "=" << rend_desc.get_w() << endl;
982 if (job.canvas_info_all || job.canvas_info_h)
984 cout << endl << "# " << _("Height") << endl;
985 cout << "h" << "=" << rend_desc.get_h() << endl;
988 if (job.canvas_info_all || job.canvas_info_image_aspect)
990 cout << endl << "# " << _("Image Aspect Ratio") << endl;
991 cout << "image_aspect" << "=" << rend_desc.get_image_aspect() << endl;
994 if (job.canvas_info_all)
995 cout << endl;
997 if (job.canvas_info_all || job.canvas_info_pw)
999 cout << endl << "# " << _("Pixel Width") << endl;
1000 cout << "pw" << "=" << rend_desc.get_pw() << endl;
1003 if (job.canvas_info_all || job.canvas_info_ph)
1005 cout << endl << "# " << _("Pixel Height") << endl;
1006 cout << "ph" << "=" << rend_desc.get_ph() << endl;
1009 if (job.canvas_info_all || job.canvas_info_pixel_aspect)
1011 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
1012 cout << "pixel_aspect" << "=" << rend_desc.get_pixel_aspect() << endl;
1015 if (job.canvas_info_all)
1016 cout << endl;
1018 if (job.canvas_info_all || job.canvas_info_tl)
1020 cout << endl << "# " << _("Top Left") << endl;
1021 cout << "tl" << "=" << rend_desc.get_tl()[0]
1022 << " " << rend_desc.get_tl()[1] << endl;
1025 if (job.canvas_info_all || job.canvas_info_br)
1027 cout << endl << "# " << _("Bottom Right") << endl;
1028 cout << "br" << "=" << rend_desc.get_br()[0]
1029 << " " << rend_desc.get_br()[1] << endl;
1032 if (job.canvas_info_all || job.canvas_info_physical_w)
1034 cout << endl << "# " << _("Physical Width") << endl;
1035 cout << "physical_w" << "=" << rend_desc.get_physical_w() << endl;
1038 if (job.canvas_info_all || job.canvas_info_physical_h)
1040 cout << endl << "# " << _("Physical Height") << endl;
1041 cout << "physical_h" << "=" << rend_desc.get_physical_h() << endl;
1044 if (job.canvas_info_all || job.canvas_info_x_res)
1046 cout << endl << "# " << _("X Resolution") << endl;
1047 cout << "x_res" << "=" << rend_desc.get_x_res() << endl;
1050 if (job.canvas_info_all || job.canvas_info_y_res)
1052 cout << endl << "# " << _("Y Resolution") << endl;
1053 cout << "y_res" << "=" << rend_desc.get_y_res() << endl;
1056 if (job.canvas_info_all || job.canvas_info_span)
1058 cout << endl << "# " << _("Diagonal Image Span") << endl;
1059 cout << "span" << "=" << rend_desc.get_span() << endl;
1062 if (job.canvas_info_all)
1063 cout << endl;
1065 if (job.canvas_info_all || job.canvas_info_interlaced)
1067 cout << endl << "# " << _("Interlaced") << endl;
1068 cout << "interlaced" << "=" << rend_desc.get_interlaced() << endl;
1071 if (job.canvas_info_all || job.canvas_info_antialias)
1073 cout << endl << "# " << _("Antialias") << endl;
1074 cout << "antialias" << "=" << rend_desc.get_antialias() << endl;
1077 if (job.canvas_info_all || job.canvas_info_clamp)
1079 cout << endl << "# " << _("Clamp") << endl;
1080 cout << "clamp" << "=" << rend_desc.get_clamp() << endl;
1083 if (job.canvas_info_all || job.canvas_info_flags)
1085 cout << endl << "# " << _("Flags") << endl;
1086 cout << "flags" << "=" << rend_desc.get_flags() << endl;
1089 if (job.canvas_info_all || job.canvas_info_focus)
1091 cout << endl << "# " << _("Focus") << endl;
1092 cout << "focus" << "=" << rend_desc.get_focus()[0]
1093 << " " << rend_desc.get_focus()[1] << endl;
1096 if (job.canvas_info_all || job.canvas_info_bg_color)
1098 cout << endl << "# " << _("Background Color") << endl;
1099 cout << "bg_color" << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
1102 if (job.canvas_info_all)
1103 cout << endl;
1105 if (job.canvas_info_all || job.canvas_info_metadata)
1107 std::list<String> keys(canvas->get_meta_data_keys());
1108 cout << endl << "# " << _("Metadata") << endl;
1109 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
1110 cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
1114 /* === M E T H O D S ======================================================= */
1116 /* === E N T R Y P O I N T ================================================= */
1118 int main(int argc, char *argv[])
1120 int i;
1121 arg_list_t arg_list;
1122 job_list_t job_list;
1124 setlocale(LC_ALL, "");
1126 #ifdef ENABLE_NLS
1127 bindtextdomain("synfig", LOCALEDIR);
1128 textdomain("synfig");
1129 #endif
1131 progname=argv[0];
1132 Progress p(argv[0]);
1134 if(!SYNFIG_CHECK_VERSION())
1136 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
1137 return SYNFIGTOOL_BADVERSION;
1140 if(argc==1)
1142 display_help(0);
1143 return SYNFIGTOOL_BLANK;
1146 for(i=1;i<argc;i++)
1147 arg_list.push_back(argv[i]);
1149 if((i=process_global_flags(arg_list)))
1150 return i;
1152 VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
1153 synfig::Main synfig_main(dirname(progname),&p);
1156 arg_list_t defaults, imageargs;
1157 int ret;
1159 // Grab the defaults before the first file
1160 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
1161 return ret;
1163 while(arg_list.size())
1165 string target_name;
1166 job_list.push_front(Job());
1167 int threads=0;
1169 imageargs=defaults;
1170 job_list.front().filename=arg_list.front();
1171 arg_list.pop_front();
1173 if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
1174 return ret;
1176 // Open the composition
1177 String errors;
1178 job_list.front().root=open_canvas(job_list.front().filename, errors);
1180 if(!job_list.front().root)
1182 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
1183 cerr<<_("Throwing out job...")<<endl;
1184 job_list.pop_front();
1185 continue;
1188 bool list_canvases = false;
1189 extract_list_canvases(imageargs, list_canvases);
1190 job_list.front().list_canvases = list_canvases;
1192 extract_canvas_info(imageargs, job_list.front());
1194 job_list.front().root->set_time(0);
1196 string canvasid;
1197 extract_canvasid(imageargs,canvasid);
1198 if(!canvasid.empty())
1202 job_list.front().canvas=job_list.front().root->find_canvas(canvasid);
1204 catch(Exception::IDNotFound)
1206 cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1207 cerr<<_("Throwing out job...")<<endl;
1208 job_list.pop_front();
1209 continue;
1212 catch(Exception::BadLinkName)
1214 cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1215 cerr<<_("Throwing out job...")<<endl;
1216 job_list.pop_front();
1217 continue;
1220 else
1221 job_list.front().canvas=job_list.front().root;
1223 extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
1224 extract_target(imageargs,target_name);
1225 extract_threads(imageargs,threads);
1226 job_list.front().quality=DEFAULT_QUALITY;
1227 extract_quality(imageargs,job_list.front().quality);
1228 VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
1229 job_list.front().desc=job_list.front().canvas->rend_desc();
1230 extract_outfile(imageargs,job_list.front().outfilename);
1232 // Extract composite
1234 string composite_file;
1235 extract_append(imageargs,composite_file);
1236 if(!composite_file.empty())
1238 String errors;
1239 Canvas::Handle composite(open_canvas(composite_file, errors));
1240 if(!composite)
1242 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1243 break;
1245 Canvas::reverse_iterator iter;
1246 for(iter=composite->rbegin();iter!=composite->rend();++iter)
1248 Layer::Handle layer(*iter);
1249 if(layer->active())
1250 job_list.front().canvas->push_front(layer->clone());
1252 VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1254 } while(false);
1256 VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1258 // If the target type is not yet defined,
1259 // try to figure it out from the outfile.
1260 if(target_name.empty() && !job_list.front().outfilename.empty())
1262 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1263 string ext = filename_extension(job_list.front().outfilename);
1264 if (ext.length()) ext = ext.substr(1);
1265 if(Target::ext_book().count(ext))
1267 target_name=Target::ext_book()[ext];
1268 info("target name not specified - using %s", target_name.c_str());
1270 else
1272 string lower_ext(ext);
1274 for(unsigned int i=0;i<ext.length();i++)
1275 lower_ext[i] = tolower(ext[i]);
1277 if(Target::ext_book().count(lower_ext))
1279 target_name=Target::ext_book()[lower_ext];
1280 info("target name not specified - using %s", target_name.c_str());
1282 else
1283 target_name=ext;
1287 // If the target type is STILL not yet defined, then
1288 // set it to a some sort of default
1289 if(target_name.empty())
1291 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1292 target_name="png";
1295 // If no output filename was provided, then
1296 // create a output filename based on the
1297 // given input filename. (ie: change the extension)
1298 if(job_list.front().outfilename.empty())
1300 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1301 if(Target::book().count(target_name))
1302 job_list.front().outfilename+=Target::book()[target_name].second;
1303 else
1304 job_list.front().outfilename+=target_name;
1307 VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1308 VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1310 VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1311 job_list.front().target=synfig::Target::create(target_name,job_list.front().outfilename);
1313 if(target_name=="sif")
1314 job_list.front().sifout=true;
1315 else
1317 if(!job_list.front().target)
1319 cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1320 cerr<<_("Throwing out job...")<<endl;
1321 job_list.pop_front();
1322 continue;
1324 job_list.front().sifout=false;
1327 // Set the Canvas on the Target
1328 if(job_list.front().target)
1330 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1331 job_list.front().target->set_canvas(job_list.front().canvas);
1332 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1333 job_list.front().target->set_quality(job_list.front().quality);
1336 // Set the threads for the target
1337 if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1338 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1340 if(imageargs.size())
1342 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1343 for(;imageargs.size();imageargs.pop_front())
1344 cerr<<' '<<imageargs.front();
1345 cerr<<endl;
1346 cerr<<_("Throwing out job...")<<endl;
1347 job_list.pop_front();
1348 continue;
1353 if(arg_list.size())
1355 cerr<<_("Unidentified arguments:");
1356 for(;arg_list.size();arg_list.pop_front())
1357 cerr<<' '<<arg_list.front();
1358 cerr<<endl;
1359 return SYNFIGTOOL_UNKNOWNARGUMENT;
1362 if(!job_list.size())
1364 cerr<<_("Nothing to do!")<<endl;
1365 return SYNFIGTOOL_BORED;
1368 for(;job_list.size();job_list.pop_front())
1370 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1371 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1372 job_list.front().desc.get_w(),
1373 job_list.front().desc.get_h(),
1374 job_list.front().desc.get_antialias(),
1375 job_list.front().desc.get_pixel_aspect(),
1376 job_list.front().desc.get_image_aspect(),
1377 job_list.front().desc.get_span()
1378 )<<endl<<'\t'<<
1379 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1380 job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1381 job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1382 job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1383 )<<endl;
1385 RenderProgress p;
1386 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1387 if(job_list.front().sifout)
1389 if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1391 cerr<<"Render Failure."<<endl;
1392 return SYNFIGTOOL_RENDERFAILURE;
1395 else if (job_list.front().list_canvases)
1397 list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1398 cerr << endl;
1400 else if (job_list.front().canvas_info)
1402 list_canvas_info(job_list.front());
1403 cerr << endl;
1405 else
1407 VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1408 etl::clock timer;
1409 timer.reset();
1410 // Call the render member of the target
1411 if(!job_list.front().target->render(&p))
1413 cerr<<"Render Failure."<<endl;
1414 return SYNFIGTOOL_RENDERFAILURE;
1416 if(print_benchmarks)
1417 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1421 job_list.clear();
1423 VERBOSE_OUT(1)<<_("Done.")<<endl;
1425 return SYNFIGTOOL_OK;