1 /* === S Y N F I G ========================================================= */
2 /*! \file tool/main.cpp
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.
22 /* ========================================================================= */
24 /* === H E A D E R S ======================================================= */
34 #include <ETL/stringf>
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 #include <autorevision.h>
58 using namespace synfig;
60 /* === M A C R O S ========================================================= */
64 #define _(x) gettext(x)
73 SYNFIGTOOL_FILENOTFOUND = 1,
76 SYNFIGTOOL_UNKNOWNARGUMENT = 4,
77 SYNFIGTOOL_UNKNOWNERROR = 5,
78 SYNFIGTOOL_INVALIDTARGET = 6,
79 SYNFIGTOOL_RENDERFAILURE = 7,
81 SYNFIGTOOL_BADVERSION = 9,
82 SYNFIGTOOL_MISSINGARGUMENT =10
86 #define VERSION "unknown"
87 #define PACKAGE "synfig-tool"
90 #ifdef DEFAULT_QUALITY
91 #undef DEFAULT_QUALITY
94 #define DEFAULT_QUALITY 2
95 #define VERBOSE_OUT(x) if(verbosity>=(x))std::cerr
97 /* === G L O B A L S ======================================================= */
102 bool print_benchmarks=false;
104 /* === M E T H O D S ======================================================= */
106 class Progress : public synfig::ProgressCallback
112 Progress(const char *name):program(name) { }
115 task(const String &task)
117 VERBOSE_OUT(1)<<program<<": "<<task<<std::endl;
122 error(const String &task)
124 std::cerr<<program<<": "<<_("error")<<": "<<task<<std::endl;
129 warning(const String &task)
131 std::cerr<<program<<": "<<_("warning")<<": "<<task<<std::endl;
136 amount_complete(int /*current*/, int /*total*/)
142 class RenderProgress : public synfig::ProgressCallback
147 int clk_scanline; // The scanline at which the clock was reset
153 RenderProgress():clk_scanline(0), last_time(0) { }
156 task(const String &thetask)
163 error(const String &task)
165 std::cout<<_("error")<<": "<<task<<std::endl;
170 warning(const String &task)
172 std::cout<<_("warning")<<": "<<task<<std::endl;
177 amount_complete(int scanline, int h)
179 if(be_quiet)return true;
182 const float time(clk()*(float)(h-scanline)/(float)(scanline-clk_scanline));
183 const float delta(time-last_time);
185 int weeks=0,days=0,hours=0,minutes=0,seconds=0;
197 //cerr<<"reset"<<endl;
199 clk_scanline=scanline;
205 clk_scanline=scanline;
209 minutes++,seconds-=60;
217 cerr<<taskname<<": "<<_("Line")<<" "<<scanline<<_(" of ")<<h<<" -- ";
218 //cerr<<time/(h-clk_scanline)<<" ";
220 if(delta>=-time/(h-clk_scanline) )
223 if(delta>=0 && clk()>4.0 && scanline>clk_scanline+200)
225 //cerr<<"reset"<<endl;
227 clk_scanline=scanline;
244 cerr<<taskname<<": "<<_("DONE")<<" "<<endl;;
257 Canvas::Handle canvas;
258 Target::Handle target;
264 bool canvas_info, canvas_info_all, canvas_info_time_start, canvas_info_time_end, canvas_info_frame_rate,
265 canvas_info_frame_start, canvas_info_frame_end, canvas_info_w, canvas_info_h, canvas_info_image_aspect,
266 canvas_info_pw, canvas_info_ph, canvas_info_pixel_aspect, canvas_info_tl, canvas_info_br,
267 canvas_info_physical_w, canvas_info_physical_h, canvas_info_x_res, canvas_info_y_res, canvas_info_span,
268 canvas_info_interlaced, canvas_info_antialias, canvas_info_clamp, canvas_info_flags, canvas_info_focus,
269 canvas_info_bg_color, canvas_info_metadata;
273 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;
277 typedef list<String> arg_list_t;
278 typedef list<Job> job_list_t;
282 cout<<"GUID Test"<<endl;
284 cout<<synfig::GUID().get_string()<<' '<<synfig::GUID().get_string()<<endl;
287 void signal_test_func()
289 cout<<"**SIGNAL CALLED**"<<endl;
294 sigc::signal<void> sig;
295 sigc::connection conn;
296 cout<<"Signal Test"<<endl;
297 conn=sig.connect(sigc::ptr_fun(signal_test_func));
298 cout<<"Next line should exclaim signal called."<<endl;
301 cout<<"Next line should NOT exclaim signal called."<<endl;
306 /* === P R O C E D U R E S ================================================= */
308 void display_help_option(const char *flag, const char *arg, string description)
310 const char spaces[]=" ";
312 cerr << strprintf(" %s %s %s", flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description << endl;
314 cerr << strprintf(" %s %s", flag, spaces+strlen(flag))+description << endl;
317 void display_help(bool full)
319 cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
323 display_help_option("-t", "<output type>", _("Specify output target (Default:unknown)"));
324 display_help_option("-w", "<pixel width>", _("Set the image width (Use zero for file default)"));
325 display_help_option("-h", "<pixel height>", _("Set the image height (Use zero for file default)"));
326 display_help_option("-s", "<image dist>", _("Set the diagonal size of image window (Span)"));
327 display_help_option("-a", "<1...30>", _("Set antialias amount for parametric renderer."));
328 display_help_option("-Q", "<0...10>", strprintf(_("Specify image quality for accelerated renderer (default=%d)"), DEFAULT_QUALITY).c_str());
329 display_help_option("-g", "<amount>", _("Gamma (default=2.2)"));
330 display_help_option("-v", NULL, _("Verbose Output (add more for more verbosity)"));
331 display_help_option("-q", NULL, _("Quiet mode (No progress/time-remaining display)"));
332 display_help_option("-c", "<canvas id>", _("Render the canvas with the given id instead of the root."));
333 display_help_option("-o", "<output file>", _("Specify output filename"));
334 display_help_option("-T", "<# of threads>", _("Enable multithreaded renderer using specified # of threads"));
335 display_help_option("-b", NULL, _("Print Benchmarks"));
336 display_help_option("--fps", "<framerate>", _("Set the frame rate"));
337 display_help_option("--time", "<time>", _("Render a single frame at <seconds>"));
338 display_help_option("--begin-time", "<time>", _("Set the starting time"));
339 display_help_option("--start-time", "<time>", _("Set the starting time"));
340 display_help_option("--end-time", "<time>", _("Set the ending time"));
341 display_help_option("--dpi", "<res>", _("Set the physical resolution (dots-per-inch)"));
342 display_help_option("--dpi-x", "<res>", _("Set the physical X resolution (dots-per-inch)"));
343 display_help_option("--dpi-y", "<res>", _("Set the physical Y resolution (dots-per-inch)"));
345 display_help_option("--list-canvases", NULL, _("List the exported canvases in the composition"));
346 display_help_option("--canvas-info", "<fields>", _("Print out specified details of the root canvas"));
347 display_help_option("--append", "<filename>", _("Append layers in <filename> to composition"));
349 display_help_option("--layer-info", "<layer>", _("Print out layer's description, parameter info, etc."));
350 display_help_option("--layers", NULL, _("Print out the list of available layers"));
351 display_help_option("--targets", NULL, _("Print out the list of available targets"));
352 display_help_option("--importers", NULL, _("Print out the list of available importers"));
353 display_help_option("--valuenodes", NULL, _("Print out the list of available ValueNodes"));
354 display_help_option("--modules", NULL, _("Print out the list of loaded modules"));
355 display_help_option("--version", NULL, _("Print out version information"));
356 display_help_option("--info", NULL, _("Print out misc build information"));
357 display_help_option("--license", NULL, _("Print out license information"));
360 display_help_option("--guid-test", NULL, _("Test GUID generation"));
361 display_help_option("--signal-test", NULL, _("Test signal implementation"));
365 display_help_option("--help", NULL, _("Print out usage and syntax info"));
370 int process_global_flags(arg_list_t &arg_list)
372 arg_list_t::iterator iter, next;
374 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
377 return SYNFIGTOOL_OK;
379 if(*iter == "--signal-test")
382 return SYNFIGTOOL_HELP;
385 if(*iter == "--guid-test")
388 return SYNFIGTOOL_HELP;
391 if(*iter == "--help")
394 return SYNFIGTOOL_HELP;
397 if(*iter == "--info")
399 cout<<PACKAGE"-"VERSION<<endl;
401 cout<<endl<<DEVEL_VERSION<<endl<<endl;
403 cout<<"Compiled on "__DATE__ /* " at "__TIME__ */;
405 cout<<" with GCC "<<__VERSION__;
408 cout<<" with Microsoft Visual C++ "<<(_MSC_VER>>8)<<'.'<<(_MSC_VER&255);
410 #ifdef __TCPLUSPLUS__
411 cout<<" with Borland Turbo C++ "<<(__TCPLUSPLUS__>>8)<<'.'<<((__TCPLUSPLUS__&255)>>4)<<'.'<<(__TCPLUSPLUS__&15);
413 cout<<endl<<SYNFIG_COPYRIGHT<<endl;
415 return SYNFIGTOOL_HELP;
418 if(*iter == "--layers")
421 synfig::Main synfig_main(dirname(progname),&p);
422 synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
423 for(;iter!=synfig::Layer::book().end();iter++)
424 if (iter->second.category != CATEGORY_DO_NOT_USE)
425 cout<<iter->first<<endl;
427 return SYNFIGTOOL_HELP;
430 if(*iter == "--layer-info")
433 synfig::Main synfig_main(dirname(progname),&p);
435 if (iter==arg_list.end())
437 error("The `%s' flag requires a value. Use --help for a list of options.", "--layer-info");
438 return SYNFIGTOOL_MISSINGARGUMENT;
440 Layer::Handle layer=synfig::Layer::create(*iter);
441 cout<<"Layer Name: "<<layer->get_name()<<endl;
442 cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
443 cout<<"Version: "<<layer->get_version()<<endl;
444 Layer::Vocab vocab=layer->get_param_vocab();
445 for(;!vocab.empty();vocab.pop_front())
447 cout<<"param - "<<vocab.front().get_name();
448 if(!vocab.front().get_critical())
449 cout<<" (not critical)";
450 cout<<endl<<"\tLocalized Name: "<<vocab.front().get_local_name()<<endl;
451 if(!vocab.front().get_description().empty())
452 cout<<"\tDescription: "<<vocab.front().get_description()<<endl;
453 if(!vocab.front().get_hint().empty())
454 cout<<"\tHint: "<<vocab.front().get_hint()<<endl;
457 return SYNFIGTOOL_HELP;
460 if(*iter == "--modules")
463 synfig::Main synfig_main(dirname(progname),&p);
464 synfig::Module::Book::iterator iter=synfig::Module::book().begin();
465 for(;iter!=synfig::Module::book().end();iter++)
466 cout<<iter->first<<endl;
467 return SYNFIGTOOL_HELP;
470 if(*iter == "--targets")
473 synfig::Main synfig_main(dirname(progname),&p);
474 synfig::Target::Book::iterator iter=synfig::Target::book().begin();
475 for(;iter!=synfig::Target::book().end();iter++)
476 cout<<iter->first<<endl;
477 return SYNFIGTOOL_HELP;
480 if(*iter == "--valuenodes")
483 synfig::Main synfig_main(dirname(progname),&p);
484 synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
485 for(;iter!=synfig::LinkableValueNode::book().end();iter++)
486 cout<<iter->first<<endl;
487 return SYNFIGTOOL_HELP;
490 if(*iter == "--importers")
493 synfig::Main synfig_main(dirname(progname),&p);
494 synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
495 for(;iter!=synfig::Importer::book().end();iter++)
496 cout<<iter->first<<endl;
497 return SYNFIGTOOL_HELP;
500 if(*iter == "--version")
502 cerr<<PACKAGE<<" "<<VERSION<<endl;
503 arg_list.erase(iter);
504 return SYNFIGTOOL_HELP;
507 if(*iter == "--license")
509 cerr<<PACKAGE<<" "<<VERSION<<endl;
510 cout<<SYNFIG_COPYRIGHT<<endl<<endl;
512 ** This package is free software; you can redistribute it and/or\n\
513 ** modify it under the terms of the GNU General Public License as\n\
514 ** published by the Free Software Foundation; either version 2 of\n\
515 ** the License, or (at your option) any later version.\n\
517 ** " << endl << endl;
518 arg_list.erase(iter);
519 return SYNFIGTOOL_HELP;
525 arg_list.erase(iter);
532 arg_list.erase(iter);
537 print_benchmarks=true;
538 arg_list.erase(iter);
543 return SYNFIGTOOL_OK;
546 /* true if the given flag takes an extra parameter */
547 bool flag_requires_value(String flag)
549 return (flag=="-a" || flag=="-c" || flag=="-g" || flag=="-h" || flag=="-o" ||
550 flag=="-Q" || flag=="-s" || flag=="-t" || flag=="-T" || flag=="-w" ||
551 flag=="--append" || flag=="--begin-time" || flag=="--canvas-info"|| flag=="--dpi" || flag=="--dpi-x" ||
552 flag=="--dpi-y" || flag=="--end-time" || flag=="--fps" || flag=="--layer-info" || flag=="--start-time" ||
556 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
558 arg_list_t::iterator iter, next;
560 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
562 if(*iter->begin() != '-')
564 //cerr<<*iter->begin()<<"-----------"<<endl;
565 return SYNFIGTOOL_OK;
568 if (flag_requires_value(*iter))
570 cluster.push_back(*iter);
571 arg_list.erase(iter);
573 if (iter==arg_list.end())
575 error("The `%s' flag requires a value. Use --help for a list of options.", cluster.back().c_str());
576 return SYNFIGTOOL_MISSINGARGUMENT;
580 cluster.push_back(*iter);
581 arg_list.erase(iter);
584 return SYNFIGTOOL_OK;
587 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
589 arg_list_t::iterator iter, next;
592 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
596 arg_list.erase(iter);
598 w=atoi(iter->c_str());
599 arg_list.erase(iter);
603 arg_list.erase(iter);
605 h=atoi(iter->c_str());
606 arg_list.erase(iter);
611 arg_list.erase(iter);
613 a=atoi(iter->c_str());
614 desc.set_antialias(a);
615 VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
616 arg_list.erase(iter);
620 arg_list.erase(iter);
622 span=atof(iter->c_str());
623 VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
624 arg_list.erase(iter);
626 else if(*iter=="--fps")
628 arg_list.erase(iter);
630 float fps=atof(iter->c_str());
631 desc.set_frame_rate(fps);
632 arg_list.erase(iter);
633 VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
635 else if(*iter=="--dpi")
637 arg_list.erase(iter);
639 float dpi=atof(iter->c_str());
640 float dots_per_meter=dpi*39.3700787402;
641 desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
642 arg_list.erase(iter);
643 VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
645 else if(*iter=="--dpi-x")
647 arg_list.erase(iter);
649 float dpi=atof(iter->c_str());
650 float dots_per_meter=dpi*39.3700787402;
651 desc.set_x_res(dots_per_meter);
652 arg_list.erase(iter);
653 VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
655 else if(*iter=="--dpi-y")
657 arg_list.erase(iter);
659 float dpi=atof(iter->c_str());
660 float dots_per_meter=dpi*39.3700787402;
661 desc.set_y_res(dots_per_meter);
662 arg_list.erase(iter);
663 VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
665 else if(*iter=="--start-time" || *iter=="--begin-time")
667 arg_list.erase(iter);
669 desc.set_time_start(Time(*iter,desc.get_frame_rate()));
670 arg_list.erase(iter);
672 else if(*iter=="--end-time")
674 arg_list.erase(iter);
676 desc.set_time_end(Time(*iter,desc.get_frame_rate()));
677 arg_list.erase(iter);
679 else if(*iter=="--time")
681 arg_list.erase(iter);
683 desc.set_time(Time(*iter,desc.get_frame_rate()));
684 VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
685 arg_list.erase(iter);
689 synfig::warning("Gamma argument is currently ignored");
690 arg_list.erase(iter);
692 //desc.set_gamma(Gamma(atof(iter->c_str())));
693 arg_list.erase(iter);
695 else if (flag_requires_value(*iter))
701 w = desc.get_w() * h / desc.get_h();
703 h = desc.get_h() * w / desc.get_w();
706 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
710 return SYNFIGTOOL_OK;
713 int extract_quality(arg_list_t &arg_list,int &quality)
715 arg_list_t::iterator iter, next;
716 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
720 arg_list.erase(iter);
722 quality=atoi(iter->c_str());
723 VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
724 arg_list.erase(iter);
726 else if (flag_requires_value(*iter))
730 return SYNFIGTOOL_OK;
733 int extract_threads(arg_list_t &arg_list,int &threads)
735 arg_list_t::iterator iter, next;
736 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
740 arg_list.erase(iter);
742 threads=atoi(iter->c_str());
743 VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
744 arg_list.erase(iter);
746 else if (flag_requires_value(*iter))
750 return SYNFIGTOOL_OK;
753 int extract_target(arg_list_t &arg_list,string &type)
755 arg_list_t::iterator iter, next;
758 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
762 arg_list.erase(iter);
765 arg_list.erase(iter);
767 else if (flag_requires_value(*iter))
771 return SYNFIGTOOL_OK;
774 int extract_append(arg_list_t &arg_list,string &filename)
776 arg_list_t::iterator iter, next;
779 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
781 if(*iter=="--append")
783 arg_list.erase(iter);
786 arg_list.erase(iter);
788 else if (flag_requires_value(*iter))
792 return SYNFIGTOOL_OK;
795 int extract_outfile(arg_list_t &arg_list,string &outfile)
797 arg_list_t::iterator iter, next;
798 int ret=SYNFIGTOOL_FILENOTFOUND;
801 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
805 arg_list.erase(iter);
808 arg_list.erase(iter);
811 else if (flag_requires_value(*iter))
818 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
820 arg_list_t::iterator iter, next;
823 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
827 arg_list.erase(iter);
830 arg_list.erase(iter);
832 else if (flag_requires_value(*iter))
836 return SYNFIGTOOL_OK;
839 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
841 arg_list_t::iterator iter, next;
843 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
844 if(*iter=="--list-canvases")
846 list_canvases = true;
847 arg_list.erase(iter);
850 return SYNFIGTOOL_OK;
853 void extract_canvas_info(arg_list_t &arg_list, Job &job)
855 arg_list_t::iterator iter, next;
857 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
858 if(*iter=="--canvas-info")
860 job.canvas_info = true;
861 arg_list.erase(iter);
863 String values(*iter), value;
864 arg_list.erase(iter);
866 std::string::size_type pos;
867 while (!values.empty())
869 pos = values.find_first_of(',');
870 if (pos == std::string::npos)
877 value = values.substr(0, pos);
878 values = values.substr(pos+1);
882 job.canvas_info_all = true;
886 if (value == "time_start") job.canvas_info_time_start = true;
887 else if (value == "time_end") job.canvas_info_time_end = true;
888 else if (value == "frame_rate") job.canvas_info_frame_rate = true;
889 else if (value == "frame_start") job.canvas_info_frame_start = true;
890 else if (value == "frame_end") job.canvas_info_frame_end = true;
891 else if (value == "w") job.canvas_info_w = true;
892 else if (value == "h") job.canvas_info_h = true;
893 else if (value == "image_aspect") job.canvas_info_image_aspect = true;
894 else if (value == "pw") job.canvas_info_pw = true;
895 else if (value == "ph") job.canvas_info_ph = true;
896 else if (value == "pixel_aspect") job.canvas_info_pixel_aspect = true;
897 else if (value == "tl") job.canvas_info_tl = true;
898 else if (value == "br") job.canvas_info_br = true;
899 else if (value == "physical_w") job.canvas_info_physical_w = true;
900 else if (value == "physical_h") job.canvas_info_physical_h = true;
901 else if (value == "x_res") job.canvas_info_x_res = true;
902 else if (value == "y_res") job.canvas_info_y_res = true;
903 else if (value == "span") job.canvas_info_span = true;
904 else if (value == "interlaced") job.canvas_info_interlaced = true;
905 else if (value == "antialias") job.canvas_info_antialias = true;
906 else if (value == "clamp") job.canvas_info_clamp = true;
907 else if (value == "flags") job.canvas_info_flags = true;
908 else if (value == "focus") job.canvas_info_focus = true;
909 else if (value == "bg_color") job.canvas_info_bg_color = true;
910 else if (value == "metadata") job.canvas_info_metadata = true;
913 cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
914 cerr<<_("Recognized variables are:") << endl <<
915 " all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
916 " image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
917 " x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
918 " focus, bg_color, metadata" << endl;
921 if (pos == std::string::npos)
927 void list_child_canvases(string prefix, Canvas::Handle canvas)
929 Canvas::Children children(canvas->children());
930 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
932 cout << prefix << ":" << (*iter)->get_id() << endl;
933 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
937 void list_canvas_info(Job job)
939 Canvas::Handle canvas(job.canvas);
940 const RendDesc &rend_desc(canvas->rend_desc());
942 if (job.canvas_info_all || job.canvas_info_time_start)
944 cout << endl << "# " << _("Start Time") << endl;
945 cout << "time_start" << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
948 if (job.canvas_info_all || job.canvas_info_time_end)
950 cout << endl << "# " << _("End Time") << endl;
951 cout << "time_end" << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
954 if (job.canvas_info_all || job.canvas_info_frame_rate)
956 cout << endl << "# " << _("Frame Rate") << endl;
957 cout << "frame_rate" << "=" << rend_desc.get_frame_rate() << endl;
960 if (job.canvas_info_all || job.canvas_info_frame_start)
962 cout << endl << "# " << _("Start Frame") << endl;
963 cout << "frame_start" << "=" << rend_desc.get_frame_start() << endl;
966 if (job.canvas_info_all || job.canvas_info_frame_end)
968 cout << endl << "# " << _("End Frame") << endl;
969 cout << "frame_end" << "=" << rend_desc.get_frame_end() << endl;
972 if (job.canvas_info_all)
975 if (job.canvas_info_all || job.canvas_info_w)
977 cout << endl << "# " << _("Width") << endl;
978 cout << "w" << "=" << rend_desc.get_w() << endl;
981 if (job.canvas_info_all || job.canvas_info_h)
983 cout << endl << "# " << _("Height") << endl;
984 cout << "h" << "=" << rend_desc.get_h() << endl;
987 if (job.canvas_info_all || job.canvas_info_image_aspect)
989 cout << endl << "# " << _("Image Aspect Ratio") << endl;
990 cout << "image_aspect" << "=" << rend_desc.get_image_aspect() << endl;
993 if (job.canvas_info_all)
996 if (job.canvas_info_all || job.canvas_info_pw)
998 cout << endl << "# " << _("Pixel Width") << endl;
999 cout << "pw" << "=" << rend_desc.get_pw() << endl;
1002 if (job.canvas_info_all || job.canvas_info_ph)
1004 cout << endl << "# " << _("Pixel Height") << endl;
1005 cout << "ph" << "=" << rend_desc.get_ph() << endl;
1008 if (job.canvas_info_all || job.canvas_info_pixel_aspect)
1010 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
1011 cout << "pixel_aspect" << "=" << rend_desc.get_pixel_aspect() << endl;
1014 if (job.canvas_info_all)
1017 if (job.canvas_info_all || job.canvas_info_tl)
1019 cout << endl << "# " << _("Top Left") << endl;
1020 cout << "tl" << "=" << rend_desc.get_tl()[0]
1021 << " " << rend_desc.get_tl()[1] << endl;
1024 if (job.canvas_info_all || job.canvas_info_br)
1026 cout << endl << "# " << _("Bottom Right") << endl;
1027 cout << "br" << "=" << rend_desc.get_br()[0]
1028 << " " << rend_desc.get_br()[1] << endl;
1031 if (job.canvas_info_all || job.canvas_info_physical_w)
1033 cout << endl << "# " << _("Physical Width") << endl;
1034 cout << "physical_w" << "=" << rend_desc.get_physical_w() << endl;
1037 if (job.canvas_info_all || job.canvas_info_physical_h)
1039 cout << endl << "# " << _("Physical Height") << endl;
1040 cout << "physical_h" << "=" << rend_desc.get_physical_h() << endl;
1043 if (job.canvas_info_all || job.canvas_info_x_res)
1045 cout << endl << "# " << _("X Resolution") << endl;
1046 cout << "x_res" << "=" << rend_desc.get_x_res() << endl;
1049 if (job.canvas_info_all || job.canvas_info_y_res)
1051 cout << endl << "# " << _("Y Resolution") << endl;
1052 cout << "y_res" << "=" << rend_desc.get_y_res() << endl;
1055 if (job.canvas_info_all || job.canvas_info_span)
1057 cout << endl << "# " << _("Diagonal Image Span") << endl;
1058 cout << "span" << "=" << rend_desc.get_span() << endl;
1061 if (job.canvas_info_all)
1064 if (job.canvas_info_all || job.canvas_info_interlaced)
1066 cout << endl << "# " << _("Interlaced") << endl;
1067 cout << "interlaced" << "=" << rend_desc.get_interlaced() << endl;
1070 if (job.canvas_info_all || job.canvas_info_antialias)
1072 cout << endl << "# " << _("Antialias") << endl;
1073 cout << "antialias" << "=" << rend_desc.get_antialias() << endl;
1076 if (job.canvas_info_all || job.canvas_info_clamp)
1078 cout << endl << "# " << _("Clamp") << endl;
1079 cout << "clamp" << "=" << rend_desc.get_clamp() << endl;
1082 if (job.canvas_info_all || job.canvas_info_flags)
1084 cout << endl << "# " << _("Flags") << endl;
1085 cout << "flags" << "=" << rend_desc.get_flags() << endl;
1088 if (job.canvas_info_all || job.canvas_info_focus)
1090 cout << endl << "# " << _("Focus") << endl;
1091 cout << "focus" << "=" << rend_desc.get_focus()[0]
1092 << " " << rend_desc.get_focus()[1] << endl;
1095 if (job.canvas_info_all || job.canvas_info_bg_color)
1097 cout << endl << "# " << _("Background Color") << endl;
1098 cout << "bg_color" << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
1101 if (job.canvas_info_all)
1104 if (job.canvas_info_all || job.canvas_info_metadata)
1106 std::list<String> keys(canvas->get_meta_data_keys());
1107 cout << endl << "# " << _("Metadata") << endl;
1108 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
1109 cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
1113 /* === M E T H O D S ======================================================= */
1115 /* === E N T R Y P O I N T ================================================= */
1117 int main(int argc, char *argv[])
1120 arg_list_t arg_list;
1121 job_list_t job_list;
1123 setlocale(LC_ALL, "");
1126 bindtextdomain("synfig", LOCALEDIR);
1127 bind_textdomain_codeset("synfig", "UTF-8");
1128 textdomain("synfig");
1132 Progress p(argv[0]);
1134 if(!SYNFIG_CHECK_VERSION())
1136 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
1137 return SYNFIGTOOL_BADVERSION;
1142 display_help(false);
1143 return SYNFIGTOOL_BLANK;
1147 arg_list.push_back(argv[i]);
1149 if((i=process_global_flags(arg_list)))
1152 VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
1153 synfig::Main synfig_main(dirname(progname),&p);
1156 arg_list_t defaults, imageargs;
1159 // Grab the defaults before the first file
1160 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
1163 while(arg_list.size())
1166 job_list.push_front(Job());
1170 job_list.front().filename=arg_list.front();
1171 arg_list.pop_front();
1173 if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
1176 // Open the composition
1177 String errors, warnings;
1180 job_list.front().root=open_canvas(job_list.front().filename, errors, warnings);
1182 catch(runtime_error x)
1184 job_list.front().root = 0;
1187 if(!job_list.front().root)
1189 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
1190 cerr<<_("Throwing out job...")<<endl;
1191 job_list.pop_front();
1195 bool list_canvases = false;
1196 extract_list_canvases(imageargs, list_canvases);
1197 job_list.front().list_canvases = list_canvases;
1199 extract_canvas_info(imageargs, job_list.front());
1201 job_list.front().root->set_time(0);
1204 extract_canvasid(imageargs,canvasid);
1205 if(!canvasid.empty())
1210 job_list.front().canvas=job_list.front().root->find_canvas(canvasid, warnings);
1212 catch(Exception::IDNotFound)
1214 cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1215 cerr<<_("Throwing out job...")<<endl;
1216 job_list.pop_front();
1220 catch(Exception::BadLinkName)
1222 cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1223 cerr<<_("Throwing out job...")<<endl;
1224 job_list.pop_front();
1229 job_list.front().canvas=job_list.front().root;
1231 extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
1232 extract_target(imageargs,target_name);
1233 extract_threads(imageargs,threads);
1234 job_list.front().quality=DEFAULT_QUALITY;
1235 extract_quality(imageargs,job_list.front().quality);
1236 VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
1237 job_list.front().desc=job_list.front().canvas->rend_desc();
1238 extract_outfile(imageargs,job_list.front().outfilename);
1240 // Extract composite
1242 string composite_file;
1243 extract_append(imageargs,composite_file);
1244 if(!composite_file.empty())
1246 String errors, warnings;
1247 Canvas::Handle composite(open_canvas(composite_file, errors, warnings));
1250 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1253 Canvas::reverse_iterator iter;
1254 for(iter=composite->rbegin();iter!=composite->rend();++iter)
1256 Layer::Handle layer(*iter);
1258 job_list.front().canvas->push_front(layer->clone());
1260 VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1264 VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1266 // If the target type is not yet defined,
1267 // try to figure it out from the outfile.
1268 if(target_name.empty() && !job_list.front().outfilename.empty())
1270 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1271 string ext = filename_extension(job_list.front().outfilename);
1272 if (ext.length()) ext = ext.substr(1);
1273 if(Target::ext_book().count(ext))
1275 target_name=Target::ext_book()[ext];
1276 info("target name not specified - using %s", target_name.c_str());
1280 string lower_ext(ext);
1282 for(unsigned int i=0;i<ext.length();i++)
1283 lower_ext[i] = tolower(ext[i]);
1285 if(Target::ext_book().count(lower_ext))
1287 target_name=Target::ext_book()[lower_ext];
1288 info("target name not specified - using %s", target_name.c_str());
1295 // If the target type is STILL not yet defined, then
1296 // set it to a some sort of default
1297 if(target_name.empty())
1299 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1303 // If no output filename was provided, then
1304 // create a output filename based on the
1305 // given input filename. (ie: change the extension)
1306 if(job_list.front().outfilename.empty())
1308 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1309 if(Target::book().count(target_name))
1310 job_list.front().outfilename+=Target::book()[target_name].second;
1312 job_list.front().outfilename+=target_name;
1315 VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1316 VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1318 VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1319 job_list.front().target=synfig::Target::create(target_name,job_list.front().outfilename);
1321 if(target_name=="sif")
1322 job_list.front().sifout=true;
1325 if(!job_list.front().target)
1327 cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1328 cerr<<_("Throwing out job...")<<endl;
1329 job_list.pop_front();
1332 job_list.front().sifout=false;
1335 // Set the Canvas on the Target
1336 if(job_list.front().target)
1338 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1339 job_list.front().target->set_canvas(job_list.front().canvas);
1340 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1341 job_list.front().target->set_quality(job_list.front().quality);
1344 // Set the threads for the target
1345 if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1346 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1348 if(imageargs.size())
1350 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1351 for(;imageargs.size();imageargs.pop_front())
1352 cerr<<' '<<imageargs.front();
1354 cerr<<_("Throwing out job...")<<endl;
1355 job_list.pop_front();
1363 cerr<<_("Unidentified arguments:");
1364 for(;arg_list.size();arg_list.pop_front())
1365 cerr<<' '<<arg_list.front();
1367 return SYNFIGTOOL_UNKNOWNARGUMENT;
1370 if(!job_list.size())
1372 cerr<<_("Nothing to do!")<<endl;
1373 return SYNFIGTOOL_BORED;
1376 for(;job_list.size();job_list.pop_front())
1378 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1379 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1380 job_list.front().desc.get_w(),
1381 job_list.front().desc.get_h(),
1382 job_list.front().desc.get_antialias(),
1383 job_list.front().desc.get_pixel_aspect(),
1384 job_list.front().desc.get_image_aspect(),
1385 job_list.front().desc.get_span()
1387 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1388 job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1389 job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1390 job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1394 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1395 if(job_list.front().sifout)
1397 if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1399 cerr<<"Render Failure."<<endl;
1400 return SYNFIGTOOL_RENDERFAILURE;
1403 else if (job_list.front().list_canvases)
1405 list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1408 else if (job_list.front().canvas_info)
1410 list_canvas_info(job_list.front());
1415 VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1418 // Call the render member of the target
1419 if(!job_list.front().target->render(&p))
1421 cerr<<"Render Failure."<<endl;
1422 return SYNFIGTOOL_RENDERFAILURE;
1424 if(print_benchmarks)
1425 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1431 VERBOSE_OUT(1)<<_("Done.")<<endl;
1433 return SYNFIGTOOL_OK;