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.
75 * \warning These codecs are linked to the filename extensions for
76 * mod_ffmpeg. If you change this you must change the others acordingly.
78 const char* allowed_video_codecs[] =
80 "flv", "h263p", "huffyuv", "libtheora", "libx264", "libxvid",
81 "mjpeg", "mpeg1video", "mpeg2video", "mpeg4", "msmpeg4",
82 "msmpeg4v1", "msmpeg4v2", "wmv1", "wmv2", NULL
85 //! Allowed video codecs description.
86 /*! \warning This variable is linked to allowed_video_codecs,
87 * if you change this you must change the other acordingly.
89 const char* allowed_video_codecs_description[] =
91 "Flash Video (FLV) / Sorenson Spark / Sorenson H.263.",
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.",
97 "MJPEG (Motion JPEG).",
101 "MPEG-4 part 2 Microsoft variant version 3.",
102 "MPEG-4 part 2 Microsoft variant version 1.",
103 "MPEG-4 part 2 Microsoft variant version 2.",
104 "Windows Media Video 7.",
105 "Windows Media Video 8.",
109 /* === T Y P E D E F S ===================================================== */
111 typedef list<String> arg_list_t;
112 typedef list<Job> job_list_t;
114 /* === M E T H O D S ======================================================= */
118 cout<<"GUID Test"<<endl;
120 cout<<synfig::GUID().get_string()<<' '<<synfig::GUID().get_string()<<endl;
123 void signal_test_func()
125 cout<<"**SIGNAL CALLED**"<<endl;
130 sigc::signal<void> sig;
131 sigc::connection conn;
132 cout<<"Signal Test"<<endl;
133 conn=sig.connect(sigc::ptr_fun(signal_test_func));
134 cout<<"Next line should exclaim signal called."<<endl;
137 cout<<"Next line should NOT exclaim signal called."<<endl;
142 /* === P R O C E D U R E S ================================================= */
144 void display_help_option(const char *flag, const char *arg, string description)
146 const char spaces[]=" ";
148 cerr << strprintf(" %s %s %s", flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description << endl;
150 cerr << strprintf(" %s %s", flag, spaces+strlen(flag))+description << endl;
153 void display_help(bool full)
155 cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
159 display_help_option("-t", "<output type>", _("Specify output target (Default:unknown)"));
160 display_help_option("-w", "<pixel width>", _("Set the image width (Use zero for file default)"));
161 display_help_option("-h", "<pixel height>", _("Set the image height (Use zero for file default)"));
162 display_help_option("-s", "<image dist>", _("Set the diagonal size of image window (Span)"));
163 display_help_option("-a", "<1...30>", _("Set antialias amount for parametric renderer."));
164 display_help_option("-Q", "<0...10>", strprintf(_("Specify image quality for accelerated renderer (default=%d)"), DEFAULT_QUALITY).c_str());
165 display_help_option("-g", "<amount>", _("Gamma (default=2.2)"));
166 display_help_option("-v", NULL, _("Verbose Output (add more for more verbosity)"));
167 display_help_option("-q", NULL, _("Quiet mode (No progress/time-remaining display)"));
168 display_help_option("-c", "<canvas id>", _("Render the canvas with the given id instead of the root."));
169 display_help_option("-o", "<output file>", _("Specify output filename"));
170 display_help_option("-T", "<# of threads>", _("Enable multithreaded renderer using specified # of threads"));
171 display_help_option("-b", NULL, _("Print Benchmarks"));
172 display_help_option("--fps", "<framerate>", _("Set the frame rate"));
173 display_help_option("--time", "<time>", _("Render a single frame at <seconds>"));
174 display_help_option("--begin-time", "<time>", _("Set the starting time"));
175 display_help_option("--start-time", "<time>", _("Set the starting time"));
176 display_help_option("--end-time", "<time>", _("Set the ending time"));
177 display_help_option("--dpi", "<res>", _("Set the physical resolution (dots-per-inch)"));
178 display_help_option("--dpi-x", "<res>", _("Set the physical X resolution (dots-per-inch)"));
179 display_help_option("--dpi-y", "<res>", _("Set the physical Y resolution (dots-per-inch)"));
181 display_help_option("--list-canvases", NULL, _("List the exported canvases in the composition"));
182 display_help_option("--canvas-info", "<fields>", _("Print out specified details of the root canvas"));
183 display_help_option("--append", "<filename>", _("Append layers in <filename> to composition"));
185 display_help_option("--layer-info", "<layer>", _("Print out layer's description, parameter info, etc."));
186 display_help_option("--layers", NULL, _("Print out the list of available layers"));
187 display_help_option("--targets", NULL, _("Print out the list of available targets"));
188 display_help_option("--target-video-codecs", NULL, _("Print out the list of available target video codecs"));
189 display_help_option("--importers", NULL, _("Print out the list of available importers"));
190 display_help_option("--valuenodes", NULL, _("Print out the list of available ValueNodes"));
191 display_help_option("--modules", NULL, _("Print out the list of loaded modules"));
192 display_help_option("--version", NULL, _("Print out version information"));
193 display_help_option("--info", NULL, _("Print out misc build information"));
194 display_help_option("--license", NULL, _("Print out license information"));
197 display_help_option("--guid-test", NULL, _("Test GUID generation"));
198 display_help_option("--signal-test", NULL, _("Test signal implementation"));
202 display_help_option("--help", NULL, _("Print out usage and syntax info"));
207 void display_target_video_codecs_help ()
209 for (int i = 0; allowed_video_codecs[i] != NULL &&
210 allowed_video_codecs_description[i] != NULL; i++)
211 cout << " " << allowed_video_codecs[i] << ": \t"
212 << allowed_video_codecs_description[i]
216 int process_global_flags(arg_list_t &arg_list)
218 arg_list_t::iterator iter, next;
220 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
223 return SYNFIGTOOL_OK;
225 if(*iter == "--signal-test")
228 return SYNFIGTOOL_HELP;
231 if(*iter == "--guid-test")
234 return SYNFIGTOOL_HELP;
237 if(*iter == "--help")
240 return SYNFIGTOOL_HELP;
243 if(*iter == "--info")
245 cout<<PACKAGE"-"VERSION<<endl;
247 cout<<endl<<DEVEL_VERSION<<endl<<endl;
249 cout<<"Compiled on "__DATE__ /* " at "__TIME__ */;
251 cout<<" with GCC "<<__VERSION__;
254 cout<<" with Microsoft Visual C++ "<<(_MSC_VER>>8)<<'.'<<(_MSC_VER&255);
256 #ifdef __TCPLUSPLUS__
257 cout<<" with Borland Turbo C++ "<<(__TCPLUSPLUS__>>8)<<'.'<<((__TCPLUSPLUS__&255)>>4)<<'.'<<(__TCPLUSPLUS__&15);
259 cout<<endl<<SYNFIG_COPYRIGHT<<endl;
261 return SYNFIGTOOL_HELP;
264 if(*iter == "--layers")
267 synfig::Main synfig_main(dirname(progname),&p);
268 synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
269 for(;iter!=synfig::Layer::book().end();iter++)
270 if (iter->second.category != CATEGORY_DO_NOT_USE)
271 cout<<iter->first<<endl;
273 return SYNFIGTOOL_HELP;
276 if(*iter == "--layer-info")
279 synfig::Main synfig_main(dirname(progname),&p);
281 if (iter==arg_list.end())
283 error("The `%s' flag requires a value. Use --help for a list of options.", "--layer-info");
284 return SYNFIGTOOL_MISSINGARGUMENT;
286 Layer::Handle layer=synfig::Layer::create(*iter);
287 cout<<"Layer Name: "<<layer->get_name()<<endl;
288 cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
289 cout<<"Version: "<<layer->get_version()<<endl;
290 Layer::Vocab vocab=layer->get_param_vocab();
291 for(;!vocab.empty();vocab.pop_front())
293 cout<<"param - "<<vocab.front().get_name();
294 if(!vocab.front().get_critical())
295 cout<<" (not critical)";
296 cout<<endl<<"\tLocalized Name: "<<vocab.front().get_local_name()<<endl;
297 if(!vocab.front().get_description().empty())
298 cout<<"\tDescription: "<<vocab.front().get_description()<<endl;
299 if(!vocab.front().get_hint().empty())
300 cout<<"\tHint: "<<vocab.front().get_hint()<<endl;
303 return SYNFIGTOOL_HELP;
306 if(*iter == "--modules")
309 synfig::Main synfig_main(dirname(progname),&p);
310 synfig::Module::Book::iterator iter=synfig::Module::book().begin();
311 for(;iter!=synfig::Module::book().end();iter++)
312 cout<<iter->first<<endl;
313 return SYNFIGTOOL_HELP;
316 if(*iter == "--targets")
319 synfig::Main synfig_main(dirname(progname),&p);
320 synfig::Target::Book::iterator iter=synfig::Target::book().begin();
321 for(;iter!=synfig::Target::book().end();iter++)
322 cout<<iter->first<<endl;
323 return SYNFIGTOOL_HELP;
326 if(*iter == "--target-video-codecs")
328 display_target_video_codecs_help();
330 return SYNFIGTOOL_HELP;
333 if(*iter == "--valuenodes")
336 synfig::Main synfig_main(dirname(progname),&p);
337 synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
338 for(;iter!=synfig::LinkableValueNode::book().end();iter++)
339 cout<<iter->first<<endl;
340 return SYNFIGTOOL_HELP;
343 if(*iter == "--importers")
346 synfig::Main synfig_main(dirname(progname),&p);
347 synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
348 for(;iter!=synfig::Importer::book().end();iter++)
349 cout<<iter->first<<endl;
350 return SYNFIGTOOL_HELP;
353 if(*iter == "--version")
355 cerr<<PACKAGE<<" "<<VERSION<<endl;
356 arg_list.erase(iter);
357 return SYNFIGTOOL_HELP;
360 if(*iter == "--license")
362 cerr<<PACKAGE<<" "<<VERSION<<endl;
363 cout<<SYNFIG_COPYRIGHT<<endl<<endl;
365 ** This package is free software; you can redistribute it and/or\n\
366 ** modify it under the terms of the GNU General Public License as\n\
367 ** published by the Free Software Foundation; either version 2 of\n\
368 ** the License, or (at your option) any later version.\n\
370 ** " << endl << endl;
371 arg_list.erase(iter);
372 return SYNFIGTOOL_HELP;
378 arg_list.erase(iter);
385 arg_list.erase(iter);
390 print_benchmarks=true;
391 arg_list.erase(iter);
396 return SYNFIGTOOL_OK;
399 /* true if the given flag takes an extra parameter */
400 bool flag_requires_value(String flag)
402 return (flag=="-a" || flag=="-c" || flag=="-g" || flag=="-h" || flag=="-o" ||
403 flag=="-Q" || flag=="-s" || flag=="-t" || flag=="-T" || flag=="-w" ||
404 flag=="--append" || flag=="--begin-time" || flag=="--canvas-info"|| flag=="--dpi" || flag=="--dpi-x" ||
405 flag=="--dpi-y" || flag=="--end-time" || flag=="--fps" || flag=="--layer-info" || flag=="--start-time" ||
406 flag=="--time" || flag=="-vc" || flag=="-vb");
409 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
411 arg_list_t::iterator iter, next;
413 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
415 if(*iter->begin() != '-')
417 //cerr<<*iter->begin()<<"-----------"<<endl;
418 return SYNFIGTOOL_OK;
421 if (flag_requires_value(*iter))
423 cluster.push_back(*iter);
424 arg_list.erase(iter);
426 if (iter==arg_list.end())
428 error("The `%s' flag requires a value. Use --help for a list of options.", cluster.back().c_str());
429 return SYNFIGTOOL_MISSINGARGUMENT;
433 cluster.push_back(*iter);
434 arg_list.erase(iter);
437 return SYNFIGTOOL_OK;
440 /*! Extract a parameter from the argument list
442 * \param arg_list Argument list from wich the parameter is extracted.
443 * \param iter Iterator pointing to the argument list parameter to be
445 * \param next Iterator pointing to the next argument.
447 string extract_parameter (arg_list_t& arg_list,
448 arg_list_t::iterator& iter,
449 arg_list_t::iterator& next)
452 arg_list.erase(iter);
455 arg_list.erase(iter);
459 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
461 arg_list_t::iterator iter, next;
464 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
468 w = atoi(extract_parameter(arg_list, iter, next).c_str());
472 h = atoi(extract_parameter(arg_list, iter, next).c_str());
477 a = atoi(extract_parameter(arg_list, iter, next).c_str());
478 desc.set_antialias(a);
479 VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
483 span = atoi(extract_parameter(arg_list, iter, next).c_str());
484 VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
486 else if(*iter=="--fps")
488 float fps = atof(extract_parameter(arg_list, iter, next).c_str());
489 desc.set_frame_rate(fps);
490 VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
492 else if(*iter=="--dpi")
494 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
495 float dots_per_meter=dpi*39.3700787402;
496 desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
497 VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
499 else if(*iter=="--dpi-x")
501 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
502 float dots_per_meter=dpi*39.3700787402;
503 desc.set_x_res(dots_per_meter);
504 VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
506 else if(*iter=="--dpi-y")
508 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
509 float dots_per_meter=dpi*39.3700787402;
510 desc.set_y_res(dots_per_meter);
511 VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
513 else if(*iter=="--start-time" || *iter=="--begin-time")
515 desc.set_time_start(Time(extract_parameter(arg_list, iter, next),
516 desc.get_frame_rate()));
518 else if(*iter=="--end-time")
520 desc.set_time_end(Time(extract_parameter(arg_list, iter, next),
521 desc.get_frame_rate()));
523 else if(*iter=="--time")
525 desc.set_time(Time(extract_parameter(arg_list, iter, next),
526 desc.get_frame_rate()));
527 VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
531 synfig::warning("Gamma argument is currently ignored");
532 //desc.set_gamma(Gamma(atoi(extract_parameter(arg_list, iter, next).c_str())));
534 else if (flag_requires_value(*iter))
540 w = desc.get_w() * h / desc.get_h();
542 h = desc.get_h() * w / desc.get_w();
545 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
549 return SYNFIGTOOL_OK;
552 int extract_quality(arg_list_t &arg_list,int &quality)
554 arg_list_t::iterator iter, next;
555 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
559 quality = atoi(extract_parameter(arg_list, iter, next).c_str());
560 VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
562 else if (flag_requires_value(*iter))
566 return SYNFIGTOOL_OK;
569 int extract_threads(arg_list_t &arg_list,int &threads)
571 arg_list_t::iterator iter, next;
572 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
576 threads = atoi(extract_parameter(arg_list, iter, next).c_str());
577 VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
579 else if (flag_requires_value(*iter))
583 return SYNFIGTOOL_OK;
586 int extract_target(arg_list_t &arg_list,string &type)
588 arg_list_t::iterator iter, next;
591 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
595 type = extract_parameter(arg_list, iter, next);
596 VERBOSE_OUT(1)<<strprintf(_("Target set to %s"), type.c_str())<<endl;
598 else if (flag_requires_value(*iter))
602 return SYNFIGTOOL_OK;
605 int extract_target_params(arg_list_t& arg_list,
610 // If -vc parameter is provided, -vb parameter is needed.
611 bool need_bitrate_parameter = false;
612 arg_list_t::iterator iter, next;
614 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
618 // Target video codec
619 params.video_codec = extract_parameter(arg_list, iter, next);
621 // video_codec string to lowercase
622 transform (params.video_codec.begin(),
623 params.video_codec.end(),
624 params.video_codec.begin(),
628 local_ret = SYNFIGTOOL_UNKNOWNARGUMENT;
630 // Check if the given video codec is allowed.
631 for (int i = 0; local_ret != SYNFIGTOOL_OK &&
632 allowed_video_codecs[i] != NULL; i++)
633 if (params.video_codec == allowed_video_codecs[i])
634 local_ret = SYNFIGTOOL_OK;
638 if (ret == SYNFIGTOOL_OK)
640 VERBOSE_OUT(1)<<strprintf(_("Target video codec set to %s"), params.video_codec.c_str())<<endl;
641 need_bitrate_parameter = true;
644 else if(*iter=="-vb")
646 need_bitrate_parameter = false;
649 atoi(extract_parameter(arg_list, iter, next).c_str());
650 VERBOSE_OUT(1)<<strprintf(_("Target bitrate set to %dk"),params.bitrate)<<endl;
652 else if (flag_requires_value(*iter))
656 if (need_bitrate_parameter)
657 ret = SYNFIGTOOL_MISSINGARGUMENT;
662 int extract_append(arg_list_t &arg_list,string &filename)
664 arg_list_t::iterator iter, next;
667 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
669 if(*iter=="--append")
671 filename = extract_parameter(arg_list, iter, next);
673 else if (flag_requires_value(*iter))
677 return SYNFIGTOOL_OK;
680 int extract_outfile(arg_list_t &arg_list,string &outfile)
682 arg_list_t::iterator iter, next;
683 int ret=SYNFIGTOOL_FILENOTFOUND;
686 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
690 outfile = extract_parameter(arg_list, iter, next);
693 else if (flag_requires_value(*iter))
700 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
702 arg_list_t::iterator iter, next;
705 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
709 canvasid = extract_parameter(arg_list, iter, next);
711 else if (flag_requires_value(*iter))
715 return SYNFIGTOOL_OK;
718 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
720 arg_list_t::iterator iter, next;
722 for(next=arg_list.begin(), iter = next++; iter!=arg_list.end();
724 if(*iter=="--list-canvases")
726 list_canvases = true;
727 arg_list.erase(iter);
730 return SYNFIGTOOL_OK;
733 void extract_canvas_info(arg_list_t &arg_list, Job &job)
735 arg_list_t::iterator iter, next;
737 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
738 if(*iter=="--canvas-info")
740 job.canvas_info = true;
741 String values(extract_parameter(arg_list, iter, next)), value;
743 std::string::size_type pos;
744 while (!values.empty())
746 pos = values.find_first_of(',');
747 if (pos == std::string::npos)
754 value = values.substr(0, pos);
755 values = values.substr(pos+1);
759 job.canvas_info_all = true;
763 if (value == "time_start") job.canvas_info_time_start = true;
764 else if (value == "time_end") job.canvas_info_time_end = true;
765 else if (value == "frame_rate") job.canvas_info_frame_rate = true;
766 else if (value == "frame_start") job.canvas_info_frame_start = true;
767 else if (value == "frame_end") job.canvas_info_frame_end = true;
768 else if (value == "w") job.canvas_info_w = true;
769 else if (value == "h") job.canvas_info_h = true;
770 else if (value == "image_aspect") job.canvas_info_image_aspect = true;
771 else if (value == "pw") job.canvas_info_pw = true;
772 else if (value == "ph") job.canvas_info_ph = true;
773 else if (value == "pixel_aspect") job.canvas_info_pixel_aspect = true;
774 else if (value == "tl") job.canvas_info_tl = true;
775 else if (value == "br") job.canvas_info_br = true;
776 else if (value == "physical_w") job.canvas_info_physical_w = true;
777 else if (value == "physical_h") job.canvas_info_physical_h = true;
778 else if (value == "x_res") job.canvas_info_x_res = true;
779 else if (value == "y_res") job.canvas_info_y_res = true;
780 else if (value == "span") job.canvas_info_span = true;
781 else if (value == "interlaced") job.canvas_info_interlaced = true;
782 else if (value == "antialias") job.canvas_info_antialias = true;
783 else if (value == "clamp") job.canvas_info_clamp = true;
784 else if (value == "flags") job.canvas_info_flags = true;
785 else if (value == "focus") job.canvas_info_focus = true;
786 else if (value == "bg_color") job.canvas_info_bg_color = true;
787 else if (value == "metadata") job.canvas_info_metadata = true;
790 cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
791 cerr<<_("Recognized variables are:") << endl <<
792 " all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
793 " image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
794 " x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
795 " focus, bg_color, metadata" << endl;
798 if (pos == std::string::npos)
804 void list_child_canvases(string prefix, Canvas::Handle canvas)
806 Canvas::Children children(canvas->children());
807 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
809 cout << prefix << ":" << (*iter)->get_id() << endl;
810 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
814 void list_canvas_info(Job job)
816 Canvas::Handle canvas(job.canvas);
817 const RendDesc &rend_desc(canvas->rend_desc());
819 if (job.canvas_info_all || job.canvas_info_time_start)
821 cout << endl << "# " << _("Start Time") << endl;
822 cout << "time_start" << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
825 if (job.canvas_info_all || job.canvas_info_time_end)
827 cout << endl << "# " << _("End Time") << endl;
828 cout << "time_end" << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
831 if (job.canvas_info_all || job.canvas_info_frame_rate)
833 cout << endl << "# " << _("Frame Rate") << endl;
834 cout << "frame_rate" << "=" << rend_desc.get_frame_rate() << endl;
837 if (job.canvas_info_all || job.canvas_info_frame_start)
839 cout << endl << "# " << _("Start Frame") << endl;
840 cout << "frame_start" << "=" << rend_desc.get_frame_start() << endl;
843 if (job.canvas_info_all || job.canvas_info_frame_end)
845 cout << endl << "# " << _("End Frame") << endl;
846 cout << "frame_end" << "=" << rend_desc.get_frame_end() << endl;
849 if (job.canvas_info_all)
852 if (job.canvas_info_all || job.canvas_info_w)
854 cout << endl << "# " << _("Width") << endl;
855 cout << "w" << "=" << rend_desc.get_w() << endl;
858 if (job.canvas_info_all || job.canvas_info_h)
860 cout << endl << "# " << _("Height") << endl;
861 cout << "h" << "=" << rend_desc.get_h() << endl;
864 if (job.canvas_info_all || job.canvas_info_image_aspect)
866 cout << endl << "# " << _("Image Aspect Ratio") << endl;
867 cout << "image_aspect" << "=" << rend_desc.get_image_aspect() << endl;
870 if (job.canvas_info_all)
873 if (job.canvas_info_all || job.canvas_info_pw)
875 cout << endl << "# " << _("Pixel Width") << endl;
876 cout << "pw" << "=" << rend_desc.get_pw() << endl;
879 if (job.canvas_info_all || job.canvas_info_ph)
881 cout << endl << "# " << _("Pixel Height") << endl;
882 cout << "ph" << "=" << rend_desc.get_ph() << endl;
885 if (job.canvas_info_all || job.canvas_info_pixel_aspect)
887 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
888 cout << "pixel_aspect" << "=" << rend_desc.get_pixel_aspect() << endl;
891 if (job.canvas_info_all)
894 if (job.canvas_info_all || job.canvas_info_tl)
896 cout << endl << "# " << _("Top Left") << endl;
897 cout << "tl" << "=" << rend_desc.get_tl()[0]
898 << " " << rend_desc.get_tl()[1] << endl;
901 if (job.canvas_info_all || job.canvas_info_br)
903 cout << endl << "# " << _("Bottom Right") << endl;
904 cout << "br" << "=" << rend_desc.get_br()[0]
905 << " " << rend_desc.get_br()[1] << endl;
908 if (job.canvas_info_all || job.canvas_info_physical_w)
910 cout << endl << "# " << _("Physical Width") << endl;
911 cout << "physical_w" << "=" << rend_desc.get_physical_w() << endl;
914 if (job.canvas_info_all || job.canvas_info_physical_h)
916 cout << endl << "# " << _("Physical Height") << endl;
917 cout << "physical_h" << "=" << rend_desc.get_physical_h() << endl;
920 if (job.canvas_info_all || job.canvas_info_x_res)
922 cout << endl << "# " << _("X Resolution") << endl;
923 cout << "x_res" << "=" << rend_desc.get_x_res() << endl;
926 if (job.canvas_info_all || job.canvas_info_y_res)
928 cout << endl << "# " << _("Y Resolution") << endl;
929 cout << "y_res" << "=" << rend_desc.get_y_res() << endl;
932 if (job.canvas_info_all || job.canvas_info_span)
934 cout << endl << "# " << _("Diagonal Image Span") << endl;
935 cout << "span" << "=" << rend_desc.get_span() << endl;
938 if (job.canvas_info_all)
941 if (job.canvas_info_all || job.canvas_info_interlaced)
943 cout << endl << "# " << _("Interlaced") << endl;
944 cout << "interlaced" << "=" << rend_desc.get_interlaced() << endl;
947 if (job.canvas_info_all || job.canvas_info_antialias)
949 cout << endl << "# " << _("Antialias") << endl;
950 cout << "antialias" << "=" << rend_desc.get_antialias() << endl;
953 if (job.canvas_info_all || job.canvas_info_clamp)
955 cout << endl << "# " << _("Clamp") << endl;
956 cout << "clamp" << "=" << rend_desc.get_clamp() << endl;
959 if (job.canvas_info_all || job.canvas_info_flags)
961 cout << endl << "# " << _("Flags") << endl;
962 cout << "flags" << "=" << rend_desc.get_flags() << endl;
965 if (job.canvas_info_all || job.canvas_info_focus)
967 cout << endl << "# " << _("Focus") << endl;
968 cout << "focus" << "=" << rend_desc.get_focus()[0]
969 << " " << rend_desc.get_focus()[1] << endl;
972 if (job.canvas_info_all || job.canvas_info_bg_color)
974 cout << endl << "# " << _("Background Color") << endl;
975 cout << "bg_color" << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
978 if (job.canvas_info_all)
981 if (job.canvas_info_all || job.canvas_info_metadata)
983 std::list<String> keys(canvas->get_meta_data_keys());
984 cout << endl << "# " << _("Metadata") << endl;
985 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
986 cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
990 /* === M E T H O D S ======================================================= */
992 /* === E N T R Y P O I N T ================================================= */
994 int main(int argc, char *argv[])
1000 setlocale(LC_ALL, "");
1003 bindtextdomain("synfig", LOCALEDIR);
1004 bind_textdomain_codeset("synfig", "UTF-8");
1005 textdomain("synfig");
1009 Progress p(argv[0]);
1011 if(!SYNFIG_CHECK_VERSION())
1013 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
1014 return SYNFIGTOOL_BADVERSION;
1019 display_help(false);
1020 return SYNFIGTOOL_BLANK;
1024 arg_list.push_back(argv[i]);
1026 if((i=process_global_flags(arg_list)))
1029 VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
1030 synfig::Main synfig_main(dirname(progname),&p);
1033 arg_list_t defaults, imageargs;
1036 // Grab the defaults before the first file
1037 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
1040 while(arg_list.size())
1043 job_list.push_front(Job());
1047 job_list.front().filename=arg_list.front();
1048 arg_list.pop_front();
1050 if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
1053 // Open the composition
1054 String errors, warnings;
1057 job_list.front().root=open_canvas(job_list.front().filename, errors, warnings);
1059 catch(runtime_error x)
1061 job_list.front().root = 0;
1064 if(!job_list.front().root)
1066 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
1067 cerr<<_("Throwing out job...")<<endl;
1068 job_list.pop_front();
1072 bool list_canvases = false;
1073 extract_list_canvases(imageargs, list_canvases);
1074 job_list.front().list_canvases = list_canvases;
1076 extract_canvas_info(imageargs, job_list.front());
1078 job_list.front().root->set_time(0);
1081 extract_canvasid(imageargs,canvasid);
1082 if(!canvasid.empty())
1087 job_list.front().canvas=job_list.front().root->find_canvas(canvasid, warnings);
1089 catch(Exception::IDNotFound)
1091 cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1092 cerr<<_("Throwing out job...")<<endl;
1093 job_list.pop_front();
1097 catch(Exception::BadLinkName)
1099 cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1100 cerr<<_("Throwing out job...")<<endl;
1101 job_list.pop_front();
1106 job_list.front().canvas=job_list.front().root;
1108 extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
1109 extract_target(imageargs,target_name);
1110 extract_threads(imageargs,threads);
1111 job_list.front().quality=DEFAULT_QUALITY;
1112 extract_quality(imageargs,job_list.front().quality);
1113 VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
1114 job_list.front().desc=job_list.front().canvas->rend_desc();
1115 extract_outfile(imageargs,job_list.front().outfilename);
1117 // Extract composite
1119 string composite_file;
1120 extract_append(imageargs,composite_file);
1121 if(!composite_file.empty())
1123 String errors, warnings;
1124 Canvas::Handle composite(open_canvas(composite_file, errors, warnings));
1127 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1130 Canvas::reverse_iterator iter;
1131 for(iter=composite->rbegin();iter!=composite->rend();++iter)
1133 Layer::Handle layer(*iter);
1135 job_list.front().canvas->push_front(layer->clone());
1137 VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1141 VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1143 // If the target type is not yet defined,
1144 // try to figure it out from the outfile.
1145 if(target_name.empty() && !job_list.front().outfilename.empty())
1147 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1148 string ext = filename_extension(job_list.front().outfilename);
1149 if (ext.length()) ext = ext.substr(1);
1150 if(Target::ext_book().count(ext))
1152 target_name=Target::ext_book()[ext];
1153 info("target name not specified - using %s", target_name.c_str());
1157 string lower_ext(ext);
1159 for(unsigned int i=0;i<ext.length();i++)
1160 lower_ext[i] = tolower(ext[i]);
1162 if(Target::ext_book().count(lower_ext))
1164 target_name=Target::ext_book()[lower_ext];
1165 info("target name not specified - using %s", target_name.c_str());
1172 TargetParam target_parameters;
1173 // Extract the extra parameters for the targets that
1175 if (target_name == "ffmpeg")
1178 status = extract_target_params(imageargs, target_parameters);
1179 if (status == SYNFIGTOOL_UNKNOWNARGUMENT)
1181 cerr << strprintf(_("Unknown target video codec: %s."),
1182 target_parameters.video_codec.c_str())
1184 cerr << _("Available target video codecs are:")
1186 display_target_video_codecs_help();
1188 return SYNFIGTOOL_UNKNOWNARGUMENT;
1190 else if (status == SYNFIGTOOL_MISSINGARGUMENT)
1192 cerr << _("Missing argument: \"-vb\".") << endl;
1194 return SYNFIGTOOL_MISSINGARGUMENT;
1198 // If the target type is STILL not yet defined, then
1199 // set it to a some sort of default
1200 if(target_name.empty())
1202 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1206 // If no output filename was provided, then
1207 // create a output filename based on the
1208 // given input filename. (ie: change the extension)
1209 if(job_list.front().outfilename.empty())
1211 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1212 if(Target::book().count(target_name))
1213 job_list.front().outfilename+=Target::book()[target_name].filename;
1215 job_list.front().outfilename+=target_name;
1218 VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1219 VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1221 VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1222 job_list.front().target =
1223 synfig::Target::create(target_name,
1224 job_list.front().outfilename,
1227 if(target_name=="sif")
1228 job_list.front().sifout=true;
1231 if(!job_list.front().target)
1233 cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1234 cerr<<_("Throwing out job...")<<endl;
1235 job_list.pop_front();
1238 job_list.front().sifout=false;
1241 // Set the Canvas on the Target
1242 if(job_list.front().target)
1244 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1245 job_list.front().target->set_canvas(job_list.front().canvas);
1246 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1247 job_list.front().target->set_quality(job_list.front().quality);
1250 // Set the threads for the target
1251 if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1252 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1254 if(imageargs.size())
1256 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1257 for(;imageargs.size();imageargs.pop_front())
1258 cerr<<' '<<imageargs.front();
1260 cerr<<_("Throwing out job...")<<endl;
1261 job_list.pop_front();
1269 cerr<<_("Unidentified arguments:");
1270 for(;arg_list.size();arg_list.pop_front())
1271 cerr<<' '<<arg_list.front();
1273 return SYNFIGTOOL_UNKNOWNARGUMENT;
1276 if(!job_list.size())
1278 cerr<<_("Nothing to do!")<<endl;
1279 return SYNFIGTOOL_BORED;
1282 for(;job_list.size();job_list.pop_front())
1284 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1285 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1286 job_list.front().desc.get_w(),
1287 job_list.front().desc.get_h(),
1288 job_list.front().desc.get_antialias(),
1289 job_list.front().desc.get_pixel_aspect(),
1290 job_list.front().desc.get_image_aspect(),
1291 job_list.front().desc.get_span()
1293 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1294 job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1295 job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1296 job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1300 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1301 if(job_list.front().sifout)
1303 if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1305 cerr<<"Render Failure."<<endl;
1306 return SYNFIGTOOL_RENDERFAILURE;
1309 else if (job_list.front().list_canvases)
1311 list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1314 else if (job_list.front().canvas_info)
1316 list_canvas_info(job_list.front());
1321 VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1324 // Call the render member of the target
1325 if(!job_list.front().target->render(&p))
1327 cerr<<"Render Failure."<<endl;
1328 return SYNFIGTOOL_RENDERFAILURE;
1330 if(print_benchmarks)
1331 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1337 VERBOSE_OUT(1)<<_("Done.")<<endl;
1339 return SYNFIGTOOL_OK;