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/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"
57 #include "renderprogress.h"
63 using namespace synfig;
65 /* === G L O B A L S ======================================================= */
70 bool print_benchmarks=false;
72 //! Allowed video codecs
73 /*! \warning This variable is linked to allowed_video_codecs_description,
74 * if you change this you must change the other acordingly.
76 const char* allowed_video_codecs[] =
78 "flv", "gif", "h263", "h263p", "huffyuv", "libtheora",
79 "libx264", "libxvid", "ljpeg", "mjpeg", "mpeg1video", "mpeg2video",
80 "mpeg4", "msmpeg4", "msmpeg4v1", "msmpeg4v2", "wmv1", "wmv2", NULL
83 //! Allowed video codecs description.
84 /*! \warning This variable is linked to allowed_video_codecs,
85 * if you change this you must change the other acordingly.
87 const char* allowed_video_codecs_description[] =
89 "Flash Video (FLV) / Sorenson Spark / Sorenson H.263.",
90 "GIF (Graphics Interchange Format).",
91 "H.263 / H.263-1996.",
92 "H.263+ / H.263-1998 / H.263 version 2.",
95 "libx264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10.",
96 "libxvidcore MPEG-4 part 2.",
98 "MJPEG (Motion JPEG).",
102 "MPEG-4 part 2 Microsoft variant version 3.",
103 "MPEG-4 part 2 Microsoft variant version 1.",
104 "MPEG-4 part 2 Microsoft variant version 2.",
105 "Windows Media Video 7.",
106 "Windows Media Video 8.",
110 /* === T Y P E D E F S ===================================================== */
112 typedef list<String> arg_list_t;
113 typedef list<Job> job_list_t;
115 /* === M E T H O D S ======================================================= */
119 cout<<"GUID Test"<<endl;
121 cout<<synfig::GUID().get_string()<<' '<<synfig::GUID().get_string()<<endl;
124 void signal_test_func()
126 cout<<"**SIGNAL CALLED**"<<endl;
131 sigc::signal<void> sig;
132 sigc::connection conn;
133 cout<<"Signal Test"<<endl;
134 conn=sig.connect(sigc::ptr_fun(signal_test_func));
135 cout<<"Next line should exclaim signal called."<<endl;
138 cout<<"Next line should NOT exclaim signal called."<<endl;
143 /* === P R O C E D U R E S ================================================= */
145 void display_help_option(const char *flag, const char *arg, string description)
147 const char spaces[]=" ";
149 cerr << strprintf(" %s %s %s", flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description << endl;
151 cerr << strprintf(" %s %s", flag, spaces+strlen(flag))+description << endl;
154 void display_help(bool full)
156 cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
160 display_help_option("-t", "<output type>", _("Specify output target (Default:unknown)"));
161 display_help_option("-w", "<pixel width>", _("Set the image width (Use zero for file default)"));
162 display_help_option("-h", "<pixel height>", _("Set the image height (Use zero for file default)"));
163 display_help_option("-s", "<image dist>", _("Set the diagonal size of image window (Span)"));
164 display_help_option("-a", "<1...30>", _("Set antialias amount for parametric renderer."));
165 display_help_option("-Q", "<0...10>", strprintf(_("Specify image quality for accelerated renderer (default=%d)"), DEFAULT_QUALITY).c_str());
166 display_help_option("-g", "<amount>", _("Gamma (default=2.2)"));
167 display_help_option("-v", NULL, _("Verbose Output (add more for more verbosity)"));
168 display_help_option("-q", NULL, _("Quiet mode (No progress/time-remaining display)"));
169 display_help_option("-c", "<canvas id>", _("Render the canvas with the given id instead of the root."));
170 display_help_option("-o", "<output file>", _("Specify output filename"));
171 display_help_option("-T", "<# of threads>", _("Enable multithreaded renderer using specified # of threads"));
172 display_help_option("-b", NULL, _("Print Benchmarks"));
173 display_help_option("--fps", "<framerate>", _("Set the frame rate"));
174 display_help_option("--time", "<time>", _("Render a single frame at <seconds>"));
175 display_help_option("--begin-time", "<time>", _("Set the starting time"));
176 display_help_option("--start-time", "<time>", _("Set the starting time"));
177 display_help_option("--end-time", "<time>", _("Set the ending time"));
178 display_help_option("--dpi", "<res>", _("Set the physical resolution (dots-per-inch)"));
179 display_help_option("--dpi-x", "<res>", _("Set the physical X resolution (dots-per-inch)"));
180 display_help_option("--dpi-y", "<res>", _("Set the physical Y resolution (dots-per-inch)"));
182 display_help_option("--list-canvases", NULL, _("List the exported canvases in the composition"));
183 display_help_option("--canvas-info", "<fields>", _("Print out specified details of the root canvas"));
184 display_help_option("--append", "<filename>", _("Append layers in <filename> to composition"));
186 display_help_option("--layer-info", "<layer>", _("Print out layer's description, parameter info, etc."));
187 display_help_option("--layers", NULL, _("Print out the list of available layers"));
188 display_help_option("--targets", NULL, _("Print out the list of available targets"));
189 display_help_option("--target-video-codecs", NULL, _("Print out the list of available target video codecs"));
190 display_help_option("--importers", NULL, _("Print out the list of available importers"));
191 display_help_option("--valuenodes", NULL, _("Print out the list of available ValueNodes"));
192 display_help_option("--modules", NULL, _("Print out the list of loaded modules"));
193 display_help_option("--version", NULL, _("Print out version information"));
194 display_help_option("--info", NULL, _("Print out misc build information"));
195 display_help_option("--license", NULL, _("Print out license information"));
198 display_help_option("--guid-test", NULL, _("Test GUID generation"));
199 display_help_option("--signal-test", NULL, _("Test signal implementation"));
203 display_help_option("--help", NULL, _("Print out usage and syntax info"));
208 void display_target_video_codecs_help ()
210 for (int i = 0; allowed_video_codecs[i] != NULL &&
211 allowed_video_codecs_description[i] != NULL; i++)
212 cout << " " << allowed_video_codecs[i] << ": \t"
213 << allowed_video_codecs_description[i]
217 int process_global_flags(arg_list_t &arg_list)
219 arg_list_t::iterator iter, next;
221 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
224 return SYNFIGTOOL_OK;
226 if(*iter == "--signal-test")
229 return SYNFIGTOOL_HELP;
232 if(*iter == "--guid-test")
235 return SYNFIGTOOL_HELP;
238 if(*iter == "--help")
241 return SYNFIGTOOL_HELP;
244 if(*iter == "--info")
246 cout<<PACKAGE"-"VERSION<<endl;
248 cout<<endl<<DEVEL_VERSION<<endl<<endl;
250 cout<<"Compiled on "__DATE__ /* " at "__TIME__ */;
252 cout<<" with GCC "<<__VERSION__;
255 cout<<" with Microsoft Visual C++ "<<(_MSC_VER>>8)<<'.'<<(_MSC_VER&255);
257 #ifdef __TCPLUSPLUS__
258 cout<<" with Borland Turbo C++ "<<(__TCPLUSPLUS__>>8)<<'.'<<((__TCPLUSPLUS__&255)>>4)<<'.'<<(__TCPLUSPLUS__&15);
260 cout<<endl<<SYNFIG_COPYRIGHT<<endl;
262 return SYNFIGTOOL_HELP;
265 if(*iter == "--layers")
268 synfig::Main synfig_main(dirname(progname),&p);
269 synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
270 for(;iter!=synfig::Layer::book().end();iter++)
271 if (iter->second.category != CATEGORY_DO_NOT_USE)
272 cout<<iter->first<<endl;
274 return SYNFIGTOOL_HELP;
277 if(*iter == "--layer-info")
280 synfig::Main synfig_main(dirname(progname),&p);
282 if (iter==arg_list.end())
284 error("The `%s' flag requires a value. Use --help for a list of options.", "--layer-info");
285 return SYNFIGTOOL_MISSINGARGUMENT;
287 Layer::Handle layer=synfig::Layer::create(*iter);
288 cout<<"Layer Name: "<<layer->get_name()<<endl;
289 cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
290 cout<<"Version: "<<layer->get_version()<<endl;
291 Layer::Vocab vocab=layer->get_param_vocab();
292 for(;!vocab.empty();vocab.pop_front())
294 cout<<"param - "<<vocab.front().get_name();
295 if(!vocab.front().get_critical())
296 cout<<" (not critical)";
297 cout<<endl<<"\tLocalized Name: "<<vocab.front().get_local_name()<<endl;
298 if(!vocab.front().get_description().empty())
299 cout<<"\tDescription: "<<vocab.front().get_description()<<endl;
300 if(!vocab.front().get_hint().empty())
301 cout<<"\tHint: "<<vocab.front().get_hint()<<endl;
304 return SYNFIGTOOL_HELP;
307 if(*iter == "--modules")
310 synfig::Main synfig_main(dirname(progname),&p);
311 synfig::Module::Book::iterator iter=synfig::Module::book().begin();
312 for(;iter!=synfig::Module::book().end();iter++)
313 cout<<iter->first<<endl;
314 return SYNFIGTOOL_HELP;
317 if(*iter == "--targets")
320 synfig::Main synfig_main(dirname(progname),&p);
321 synfig::Target::Book::iterator iter=synfig::Target::book().begin();
322 for(;iter!=synfig::Target::book().end();iter++)
323 cout<<iter->first<<endl;
324 return SYNFIGTOOL_HELP;
327 if(*iter == "--target-video-codecs")
329 display_target_video_codecs_help();
331 return SYNFIGTOOL_HELP;
334 if(*iter == "--valuenodes")
337 synfig::Main synfig_main(dirname(progname),&p);
338 synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
339 for(;iter!=synfig::LinkableValueNode::book().end();iter++)
340 cout<<iter->first<<endl;
341 return SYNFIGTOOL_HELP;
344 if(*iter == "--importers")
347 synfig::Main synfig_main(dirname(progname),&p);
348 synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
349 for(;iter!=synfig::Importer::book().end();iter++)
350 cout<<iter->first<<endl;
351 return SYNFIGTOOL_HELP;
354 if(*iter == "--version")
356 cerr<<PACKAGE<<" "<<VERSION<<endl;
357 arg_list.erase(iter);
358 return SYNFIGTOOL_HELP;
361 if(*iter == "--license")
363 cerr<<PACKAGE<<" "<<VERSION<<endl;
364 cout<<SYNFIG_COPYRIGHT<<endl<<endl;
366 ** This package is free software; you can redistribute it and/or\n\
367 ** modify it under the terms of the GNU General Public License as\n\
368 ** published by the Free Software Foundation; either version 2 of\n\
369 ** the License, or (at your option) any later version.\n\
371 ** " << endl << endl;
372 arg_list.erase(iter);
373 return SYNFIGTOOL_HELP;
379 arg_list.erase(iter);
386 arg_list.erase(iter);
391 print_benchmarks=true;
392 arg_list.erase(iter);
397 return SYNFIGTOOL_OK;
400 /* true if the given flag takes an extra parameter */
401 bool flag_requires_value(String flag)
403 return (flag=="-a" || flag=="-c" || flag=="-g" || flag=="-h" || flag=="-o" ||
404 flag=="-Q" || flag=="-s" || flag=="-t" || flag=="-T" || flag=="-w" ||
405 flag=="--append" || flag=="--begin-time" || flag=="--canvas-info"|| flag=="--dpi" || flag=="--dpi-x" ||
406 flag=="--dpi-y" || flag=="--end-time" || flag=="--fps" || flag=="--layer-info" || flag=="--start-time" ||
407 flag=="--time" || flag=="-vc" || flag=="-vb");
410 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
412 arg_list_t::iterator iter, next;
414 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
416 if(*iter->begin() != '-')
418 //cerr<<*iter->begin()<<"-----------"<<endl;
419 return SYNFIGTOOL_OK;
422 if (flag_requires_value(*iter))
424 cluster.push_back(*iter);
425 arg_list.erase(iter);
427 if (iter==arg_list.end())
429 error("The `%s' flag requires a value. Use --help for a list of options.", cluster.back().c_str());
430 return SYNFIGTOOL_MISSINGARGUMENT;
434 cluster.push_back(*iter);
435 arg_list.erase(iter);
438 return SYNFIGTOOL_OK;
441 /*! Extract a parameter from the argument list
443 * \param arg_list Argument list from wich the parameter is extracted.
444 * \param iter Iterator pointing to the argument list parameter to be
446 * \param next Iterator pointing to the next argument.
448 string extract_parameter (arg_list_t& arg_list,
449 arg_list_t::iterator& iter,
450 arg_list_t::iterator& next)
453 arg_list.erase(iter);
456 arg_list.erase(iter);
460 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
462 arg_list_t::iterator iter, next;
465 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
469 w = atoi(extract_parameter(arg_list, iter, next).c_str());
473 h = atoi(extract_parameter(arg_list, iter, next).c_str());
478 a = atoi(extract_parameter(arg_list, iter, next).c_str());
479 desc.set_antialias(a);
480 VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
484 span = atoi(extract_parameter(arg_list, iter, next).c_str());
485 VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
487 else if(*iter=="--fps")
489 float fps = atof(extract_parameter(arg_list, iter, next).c_str());
490 desc.set_frame_rate(fps);
491 VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
493 else if(*iter=="--dpi")
495 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
496 float dots_per_meter=dpi*39.3700787402;
497 desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
498 VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
500 else if(*iter=="--dpi-x")
502 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
503 float dots_per_meter=dpi*39.3700787402;
504 desc.set_x_res(dots_per_meter);
505 VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
507 else if(*iter=="--dpi-y")
509 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
510 float dots_per_meter=dpi*39.3700787402;
511 desc.set_y_res(dots_per_meter);
512 VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
514 else if(*iter=="--start-time" || *iter=="--begin-time")
516 desc.set_time_start(Time(extract_parameter(arg_list, iter, next),
517 desc.get_frame_rate()));
519 else if(*iter=="--end-time")
521 desc.set_time_end(Time(extract_parameter(arg_list, iter, next),
522 desc.get_frame_rate()));
524 else if(*iter=="--time")
526 desc.set_time(Time(extract_parameter(arg_list, iter, next),
527 desc.get_frame_rate()));
528 VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
532 synfig::warning("Gamma argument is currently ignored");
533 //desc.set_gamma(Gamma(atoi(extract_parameter(arg_list, iter, next).c_str())));
535 else if (flag_requires_value(*iter))
541 w = desc.get_w() * h / desc.get_h();
543 h = desc.get_h() * w / desc.get_w();
546 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
550 return SYNFIGTOOL_OK;
553 int extract_quality(arg_list_t &arg_list,int &quality)
555 arg_list_t::iterator iter, next;
556 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
560 quality = atoi(extract_parameter(arg_list, iter, next).c_str());
561 VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
563 else if (flag_requires_value(*iter))
567 return SYNFIGTOOL_OK;
570 int extract_threads(arg_list_t &arg_list,int &threads)
572 arg_list_t::iterator iter, next;
573 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
577 threads = atoi(extract_parameter(arg_list, iter, next).c_str());
578 VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
580 else if (flag_requires_value(*iter))
584 return SYNFIGTOOL_OK;
587 int extract_target(arg_list_t &arg_list,string &type)
589 arg_list_t::iterator iter, next;
592 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
596 type = extract_parameter(arg_list, iter, next);
597 VERBOSE_OUT(1)<<strprintf(_("Target set to %s"), type.c_str())<<endl;
599 else if (flag_requires_value(*iter))
603 return SYNFIGTOOL_OK;
606 int extract_target_params(arg_list_t& arg_list,
611 // If -vc parameter is provided, -vb parameter is needed.
612 bool need_bitrate_parameter = false;
613 arg_list_t::iterator iter, next;
615 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
619 // Target video codec
620 params.video_codec = extract_parameter(arg_list, iter, next);
622 // video_codec string to lowercase
623 transform (params.video_codec.begin(),
624 params.video_codec.end(),
625 params.video_codec.begin(),
629 local_ret = SYNFIGTOOL_UNKNOWNARGUMENT;
631 // Check if the given video codec is allowed.
632 for (int i = 0; local_ret != SYNFIGTOOL_OK &&
633 allowed_video_codecs[i] != NULL; i++)
634 if (params.video_codec == allowed_video_codecs[i])
635 local_ret = SYNFIGTOOL_OK;
639 if (ret == SYNFIGTOOL_OK)
641 VERBOSE_OUT(1)<<strprintf(_("Target video codec set to %s"), params.video_codec.c_str())<<endl;
642 need_bitrate_parameter = true;
645 else if(*iter=="-vb")
647 need_bitrate_parameter = false;
650 atoi(extract_parameter(arg_list, iter, next).c_str());
651 VERBOSE_OUT(1)<<strprintf(_("Target bitrate set to %dk"),params.bitrate)<<endl;
653 else if (flag_requires_value(*iter))
657 if (need_bitrate_parameter)
658 ret = SYNFIGTOOL_MISSINGARGUMENT;
663 int extract_append(arg_list_t &arg_list,string &filename)
665 arg_list_t::iterator iter, next;
668 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
670 if(*iter=="--append")
672 filename = extract_parameter(arg_list, iter, next);
674 else if (flag_requires_value(*iter))
678 return SYNFIGTOOL_OK;
681 int extract_outfile(arg_list_t &arg_list,string &outfile)
683 arg_list_t::iterator iter, next;
684 int ret=SYNFIGTOOL_FILENOTFOUND;
687 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
691 outfile = extract_parameter(arg_list, iter, next);
694 else if (flag_requires_value(*iter))
701 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
703 arg_list_t::iterator iter, next;
706 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
710 canvasid = extract_parameter(arg_list, iter, next);
712 else if (flag_requires_value(*iter))
716 return SYNFIGTOOL_OK;
719 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
721 arg_list_t::iterator iter, next;
723 for(next=arg_list.begin(), iter = next++; iter!=arg_list.end();
725 if(*iter=="--list-canvases")
727 list_canvases = true;
728 arg_list.erase(iter);
731 return SYNFIGTOOL_OK;
734 void extract_canvas_info(arg_list_t &arg_list, Job &job)
736 arg_list_t::iterator iter, next;
738 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
739 if(*iter=="--canvas-info")
741 job.canvas_info = true;
742 String values(extract_parameter(arg_list, iter, next)), value;
744 std::string::size_type pos;
745 while (!values.empty())
747 pos = values.find_first_of(',');
748 if (pos == std::string::npos)
755 value = values.substr(0, pos);
756 values = values.substr(pos+1);
760 job.canvas_info_all = true;
764 if (value == "time_start") job.canvas_info_time_start = true;
765 else if (value == "time_end") job.canvas_info_time_end = true;
766 else if (value == "frame_rate") job.canvas_info_frame_rate = true;
767 else if (value == "frame_start") job.canvas_info_frame_start = true;
768 else if (value == "frame_end") job.canvas_info_frame_end = true;
769 else if (value == "w") job.canvas_info_w = true;
770 else if (value == "h") job.canvas_info_h = true;
771 else if (value == "image_aspect") job.canvas_info_image_aspect = true;
772 else if (value == "pw") job.canvas_info_pw = true;
773 else if (value == "ph") job.canvas_info_ph = true;
774 else if (value == "pixel_aspect") job.canvas_info_pixel_aspect = true;
775 else if (value == "tl") job.canvas_info_tl = true;
776 else if (value == "br") job.canvas_info_br = true;
777 else if (value == "physical_w") job.canvas_info_physical_w = true;
778 else if (value == "physical_h") job.canvas_info_physical_h = true;
779 else if (value == "x_res") job.canvas_info_x_res = true;
780 else if (value == "y_res") job.canvas_info_y_res = true;
781 else if (value == "span") job.canvas_info_span = true;
782 else if (value == "interlaced") job.canvas_info_interlaced = true;
783 else if (value == "antialias") job.canvas_info_antialias = true;
784 else if (value == "clamp") job.canvas_info_clamp = true;
785 else if (value == "flags") job.canvas_info_flags = true;
786 else if (value == "focus") job.canvas_info_focus = true;
787 else if (value == "bg_color") job.canvas_info_bg_color = true;
788 else if (value == "metadata") job.canvas_info_metadata = true;
791 cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
792 cerr<<_("Recognized variables are:") << endl <<
793 " all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
794 " image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
795 " x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
796 " focus, bg_color, metadata" << endl;
799 if (pos == std::string::npos)
805 void list_child_canvases(string prefix, Canvas::Handle canvas)
807 Canvas::Children children(canvas->children());
808 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
810 cout << prefix << ":" << (*iter)->get_id() << endl;
811 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
815 void list_canvas_info(Job job)
817 Canvas::Handle canvas(job.canvas);
818 const RendDesc &rend_desc(canvas->rend_desc());
820 if (job.canvas_info_all || job.canvas_info_time_start)
822 cout << endl << "# " << _("Start Time") << endl;
823 cout << "time_start" << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
826 if (job.canvas_info_all || job.canvas_info_time_end)
828 cout << endl << "# " << _("End Time") << endl;
829 cout << "time_end" << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
832 if (job.canvas_info_all || job.canvas_info_frame_rate)
834 cout << endl << "# " << _("Frame Rate") << endl;
835 cout << "frame_rate" << "=" << rend_desc.get_frame_rate() << endl;
838 if (job.canvas_info_all || job.canvas_info_frame_start)
840 cout << endl << "# " << _("Start Frame") << endl;
841 cout << "frame_start" << "=" << rend_desc.get_frame_start() << endl;
844 if (job.canvas_info_all || job.canvas_info_frame_end)
846 cout << endl << "# " << _("End Frame") << endl;
847 cout << "frame_end" << "=" << rend_desc.get_frame_end() << endl;
850 if (job.canvas_info_all)
853 if (job.canvas_info_all || job.canvas_info_w)
855 cout << endl << "# " << _("Width") << endl;
856 cout << "w" << "=" << rend_desc.get_w() << endl;
859 if (job.canvas_info_all || job.canvas_info_h)
861 cout << endl << "# " << _("Height") << endl;
862 cout << "h" << "=" << rend_desc.get_h() << endl;
865 if (job.canvas_info_all || job.canvas_info_image_aspect)
867 cout << endl << "# " << _("Image Aspect Ratio") << endl;
868 cout << "image_aspect" << "=" << rend_desc.get_image_aspect() << endl;
871 if (job.canvas_info_all)
874 if (job.canvas_info_all || job.canvas_info_pw)
876 cout << endl << "# " << _("Pixel Width") << endl;
877 cout << "pw" << "=" << rend_desc.get_pw() << endl;
880 if (job.canvas_info_all || job.canvas_info_ph)
882 cout << endl << "# " << _("Pixel Height") << endl;
883 cout << "ph" << "=" << rend_desc.get_ph() << endl;
886 if (job.canvas_info_all || job.canvas_info_pixel_aspect)
888 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
889 cout << "pixel_aspect" << "=" << rend_desc.get_pixel_aspect() << endl;
892 if (job.canvas_info_all)
895 if (job.canvas_info_all || job.canvas_info_tl)
897 cout << endl << "# " << _("Top Left") << endl;
898 cout << "tl" << "=" << rend_desc.get_tl()[0]
899 << " " << rend_desc.get_tl()[1] << endl;
902 if (job.canvas_info_all || job.canvas_info_br)
904 cout << endl << "# " << _("Bottom Right") << endl;
905 cout << "br" << "=" << rend_desc.get_br()[0]
906 << " " << rend_desc.get_br()[1] << endl;
909 if (job.canvas_info_all || job.canvas_info_physical_w)
911 cout << endl << "# " << _("Physical Width") << endl;
912 cout << "physical_w" << "=" << rend_desc.get_physical_w() << endl;
915 if (job.canvas_info_all || job.canvas_info_physical_h)
917 cout << endl << "# " << _("Physical Height") << endl;
918 cout << "physical_h" << "=" << rend_desc.get_physical_h() << endl;
921 if (job.canvas_info_all || job.canvas_info_x_res)
923 cout << endl << "# " << _("X Resolution") << endl;
924 cout << "x_res" << "=" << rend_desc.get_x_res() << endl;
927 if (job.canvas_info_all || job.canvas_info_y_res)
929 cout << endl << "# " << _("Y Resolution") << endl;
930 cout << "y_res" << "=" << rend_desc.get_y_res() << endl;
933 if (job.canvas_info_all || job.canvas_info_span)
935 cout << endl << "# " << _("Diagonal Image Span") << endl;
936 cout << "span" << "=" << rend_desc.get_span() << endl;
939 if (job.canvas_info_all)
942 if (job.canvas_info_all || job.canvas_info_interlaced)
944 cout << endl << "# " << _("Interlaced") << endl;
945 cout << "interlaced" << "=" << rend_desc.get_interlaced() << endl;
948 if (job.canvas_info_all || job.canvas_info_antialias)
950 cout << endl << "# " << _("Antialias") << endl;
951 cout << "antialias" << "=" << rend_desc.get_antialias() << endl;
954 if (job.canvas_info_all || job.canvas_info_clamp)
956 cout << endl << "# " << _("Clamp") << endl;
957 cout << "clamp" << "=" << rend_desc.get_clamp() << endl;
960 if (job.canvas_info_all || job.canvas_info_flags)
962 cout << endl << "# " << _("Flags") << endl;
963 cout << "flags" << "=" << rend_desc.get_flags() << endl;
966 if (job.canvas_info_all || job.canvas_info_focus)
968 cout << endl << "# " << _("Focus") << endl;
969 cout << "focus" << "=" << rend_desc.get_focus()[0]
970 << " " << rend_desc.get_focus()[1] << endl;
973 if (job.canvas_info_all || job.canvas_info_bg_color)
975 cout << endl << "# " << _("Background Color") << endl;
976 cout << "bg_color" << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
979 if (job.canvas_info_all)
982 if (job.canvas_info_all || job.canvas_info_metadata)
984 std::list<String> keys(canvas->get_meta_data_keys());
985 cout << endl << "# " << _("Metadata") << endl;
986 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
987 cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
991 /* === M E T H O D S ======================================================= */
993 /* === E N T R Y P O I N T ================================================= */
995 int main(int argc, char *argv[])
1001 setlocale(LC_ALL, "");
1004 bindtextdomain("synfig", LOCALEDIR);
1005 bind_textdomain_codeset("synfig", "UTF-8");
1006 textdomain("synfig");
1010 Progress p(argv[0]);
1012 if(!SYNFIG_CHECK_VERSION())
1014 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
1015 return SYNFIGTOOL_BADVERSION;
1020 display_help(false);
1021 return SYNFIGTOOL_BLANK;
1025 arg_list.push_back(argv[i]);
1027 if((i=process_global_flags(arg_list)))
1030 VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
1031 synfig::Main synfig_main(dirname(progname),&p);
1034 arg_list_t defaults, imageargs;
1037 // Grab the defaults before the first file
1038 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
1041 while(arg_list.size())
1044 job_list.push_front(Job());
1048 job_list.front().filename=arg_list.front();
1049 arg_list.pop_front();
1051 if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
1054 // Open the composition
1055 String errors, warnings;
1058 job_list.front().root=open_canvas(job_list.front().filename, errors, warnings);
1060 catch(runtime_error x)
1062 job_list.front().root = 0;
1065 if(!job_list.front().root)
1067 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
1068 cerr<<_("Throwing out job...")<<endl;
1069 job_list.pop_front();
1073 bool list_canvases = false;
1074 extract_list_canvases(imageargs, list_canvases);
1075 job_list.front().list_canvases = list_canvases;
1077 extract_canvas_info(imageargs, job_list.front());
1079 job_list.front().root->set_time(0);
1082 extract_canvasid(imageargs,canvasid);
1083 if(!canvasid.empty())
1088 job_list.front().canvas=job_list.front().root->find_canvas(canvasid, warnings);
1090 catch(Exception::IDNotFound)
1092 cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1093 cerr<<_("Throwing out job...")<<endl;
1094 job_list.pop_front();
1098 catch(Exception::BadLinkName)
1100 cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1101 cerr<<_("Throwing out job...")<<endl;
1102 job_list.pop_front();
1107 job_list.front().canvas=job_list.front().root;
1109 extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
1110 extract_target(imageargs,target_name);
1111 extract_threads(imageargs,threads);
1112 job_list.front().quality=DEFAULT_QUALITY;
1113 extract_quality(imageargs,job_list.front().quality);
1114 VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
1115 job_list.front().desc=job_list.front().canvas->rend_desc();
1116 extract_outfile(imageargs,job_list.front().outfilename);
1118 // Extract composite
1120 string composite_file;
1121 extract_append(imageargs,composite_file);
1122 if(!composite_file.empty())
1124 String errors, warnings;
1125 Canvas::Handle composite(open_canvas(composite_file, errors, warnings));
1128 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1131 Canvas::reverse_iterator iter;
1132 for(iter=composite->rbegin();iter!=composite->rend();++iter)
1134 Layer::Handle layer(*iter);
1136 job_list.front().canvas->push_front(layer->clone());
1138 VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1142 VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1144 // If the target type is not yet defined,
1145 // try to figure it out from the outfile.
1146 if(target_name.empty() && !job_list.front().outfilename.empty())
1148 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1149 string ext = filename_extension(job_list.front().outfilename);
1150 if (ext.length()) ext = ext.substr(1);
1151 if(Target::ext_book().count(ext))
1153 target_name=Target::ext_book()[ext];
1154 info("target name not specified - using %s", target_name.c_str());
1158 string lower_ext(ext);
1160 for(unsigned int i=0;i<ext.length();i++)
1161 lower_ext[i] = tolower(ext[i]);
1163 if(Target::ext_book().count(lower_ext))
1165 target_name=Target::ext_book()[lower_ext];
1166 info("target name not specified - using %s", target_name.c_str());
1173 TargetParam target_parameters;
1174 // Extract the extra parameters for the targets that
1176 if (target_name == "ffmpeg")
1179 status = extract_target_params(imageargs, target_parameters);
1180 if (status == SYNFIGTOOL_UNKNOWNARGUMENT)
1182 cerr << strprintf(_("Unknown target video codec: %s."),
1183 target_parameters.video_codec.c_str())
1185 cerr << _("Available target video codecs are:")
1187 display_target_video_codecs_help();
1189 return SYNFIGTOOL_UNKNOWNARGUMENT;
1191 else if (status == SYNFIGTOOL_MISSINGARGUMENT)
1193 cerr << _("Missing argument: \"-vb\".") << endl;
1195 return SYNFIGTOOL_MISSINGARGUMENT;
1199 // If the target type is STILL not yet defined, then
1200 // set it to a some sort of default
1201 if(target_name.empty())
1203 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1207 // If no output filename was provided, then
1208 // create a output filename based on the
1209 // given input filename. (ie: change the extension)
1210 if(job_list.front().outfilename.empty())
1212 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1213 if(Target::book().count(target_name))
1214 job_list.front().outfilename+=Target::book()[target_name].filename;
1216 job_list.front().outfilename+=target_name;
1219 VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1220 VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1222 VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1223 job_list.front().target =
1224 synfig::Target::create(target_name,
1225 job_list.front().outfilename,
1228 if(target_name=="sif")
1229 job_list.front().sifout=true;
1232 if(!job_list.front().target)
1234 cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1235 cerr<<_("Throwing out job...")<<endl;
1236 job_list.pop_front();
1239 job_list.front().sifout=false;
1242 // Set the Canvas on the Target
1243 if(job_list.front().target)
1245 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1246 job_list.front().target->set_canvas(job_list.front().canvas);
1247 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1248 job_list.front().target->set_quality(job_list.front().quality);
1251 // Set the threads for the target
1252 if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1253 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1255 if(imageargs.size())
1257 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1258 for(;imageargs.size();imageargs.pop_front())
1259 cerr<<' '<<imageargs.front();
1261 cerr<<_("Throwing out job...")<<endl;
1262 job_list.pop_front();
1270 cerr<<_("Unidentified arguments:");
1271 for(;arg_list.size();arg_list.pop_front())
1272 cerr<<' '<<arg_list.front();
1274 return SYNFIGTOOL_UNKNOWNARGUMENT;
1277 if(!job_list.size())
1279 cerr<<_("Nothing to do!")<<endl;
1280 return SYNFIGTOOL_BORED;
1283 for(;job_list.size();job_list.pop_front())
1285 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1286 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1287 job_list.front().desc.get_w(),
1288 job_list.front().desc.get_h(),
1289 job_list.front().desc.get_antialias(),
1290 job_list.front().desc.get_pixel_aspect(),
1291 job_list.front().desc.get_image_aspect(),
1292 job_list.front().desc.get_span()
1294 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1295 job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1296 job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1297 job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1301 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1302 if(job_list.front().sifout)
1304 if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1306 cerr<<"Render Failure."<<endl;
1307 return SYNFIGTOOL_RENDERFAILURE;
1310 else if (job_list.front().list_canvases)
1312 list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1315 else if (job_list.front().canvas_info)
1317 list_canvas_info(job_list.front());
1322 VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1325 // Call the render member of the target
1326 if(!job_list.front().target->render(&p))
1328 cerr<<"Render Failure."<<endl;
1329 return SYNFIGTOOL_RENDERFAILURE;
1331 if(print_benchmarks)
1332 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1338 VERBOSE_OUT(1)<<_("Done.")<<endl;
1340 return SYNFIGTOOL_OK;