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",
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 "MJPEG (Motion JPEG).",
99 "MPEG-4 part 2. (XviD/DivX)",
100 "MPEG-4 part 2 Microsoft variant version 3.",
101 "MPEG-4 part 2 Microsoft variant version 1.",
102 "MPEG-4 part 2 Microsoft variant version 2.",
103 "Windows Media Video 7.",
104 "Windows Media Video 8.",
108 /* === T Y P E D E F S ===================================================== */
110 typedef list<String> arg_list_t;
111 typedef list<Job> job_list_t;
113 /* === M E T H O D S ======================================================= */
117 cout<<"GUID Test"<<endl;
119 cout<<synfig::GUID().get_string()<<' '<<synfig::GUID().get_string()<<endl;
122 void signal_test_func()
124 cout<<"**SIGNAL CALLED**"<<endl;
129 sigc::signal<void> sig;
130 sigc::connection conn;
131 cout<<"Signal Test"<<endl;
132 conn=sig.connect(sigc::ptr_fun(signal_test_func));
133 cout<<"Next line should exclaim signal called."<<endl;
136 cout<<"Next line should NOT exclaim signal called."<<endl;
141 /* === P R O C E D U R E S ================================================= */
143 void display_help_option(const char *flag, const char *arg, string description)
145 const char spaces[]=" ";
147 cerr << strprintf(" %s %s %s", flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description << endl;
149 cerr << strprintf(" %s %s", flag, spaces+strlen(flag))+description << endl;
152 void display_help(bool full)
154 cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
158 display_help_option("-t", "<output type>", _("Specify output target (Default:unknown)"));
159 display_help_option("-w", "<pixel width>", _("Set the image width (Use zero for file default)"));
160 display_help_option("-h", "<pixel height>", _("Set the image height (Use zero for file default)"));
161 display_help_option("-s", "<image dist>", _("Set the diagonal size of image window (Span)"));
162 display_help_option("-a", "<1...30>", _("Set antialias amount for parametric renderer."));
163 display_help_option("-Q", "<0...10>", strprintf(_("Specify image quality for accelerated renderer (default=%d)"), DEFAULT_QUALITY).c_str());
164 display_help_option("-g", "<amount>", _("Gamma (default=2.2)"));
165 display_help_option("-v", NULL, _("Verbose Output (add more for more verbosity)"));
166 display_help_option("-q", NULL, _("Quiet mode (No progress/time-remaining display)"));
167 display_help_option("-c", "<canvas id>", _("Render the canvas with the given id instead of the root."));
168 display_help_option("-o", "<output file>", _("Specify output filename"));
169 display_help_option("-T", "<# of threads>", _("Enable multithreaded renderer using specified # of threads"));
170 display_help_option("-b", NULL, _("Print Benchmarks"));
171 display_help_option("--fps", "<framerate>", _("Set the frame rate"));
172 display_help_option("--time", "<time>", _("Render a single frame at <seconds>"));
173 display_help_option("--begin-time", "<time>", _("Set the starting time"));
174 display_help_option("--start-time", "<time>", _("Set the starting time"));
175 display_help_option("--end-time", "<time>", _("Set the ending time"));
176 display_help_option("--dpi", "<res>", _("Set the physical resolution (dots-per-inch)"));
177 display_help_option("--dpi-x", "<res>", _("Set the physical X resolution (dots-per-inch)"));
178 display_help_option("--dpi-y", "<res>", _("Set the physical Y resolution (dots-per-inch)"));
180 display_help_option("--list-canvases", NULL, _("List the exported canvases in the composition"));
181 display_help_option("--canvas-info", "<fields>", _("Print out specified details of the root canvas"));
182 display_help_option("--append", "<filename>", _("Append layers in <filename> to composition"));
184 display_help_option("--layer-info", "<layer>", _("Print out layer's description, parameter info, etc."));
185 display_help_option("--layers", NULL, _("Print out the list of available layers"));
186 display_help_option("--targets", NULL, _("Print out the list of available targets"));
187 display_help_option("--target-video-codecs", NULL, _("Print out the list of available target video codecs"));
188 display_help_option("--importers", NULL, _("Print out the list of available importers"));
189 display_help_option("--valuenodes", NULL, _("Print out the list of available ValueNodes"));
190 display_help_option("--modules", NULL, _("Print out the list of loaded modules"));
191 display_help_option("--version", NULL, _("Print out version information"));
192 display_help_option("--info", NULL, _("Print out misc build information"));
193 display_help_option("--license", NULL, _("Print out license information"));
196 display_help_option("--guid-test", NULL, _("Test GUID generation"));
197 display_help_option("--signal-test", NULL, _("Test signal implementation"));
201 display_help_option("--help", NULL, _("Print out usage and syntax info"));
206 void display_target_video_codecs_help ()
208 for (int i = 0; allowed_video_codecs[i] != NULL &&
209 allowed_video_codecs_description[i] != NULL; i++)
210 cout << " " << allowed_video_codecs[i] << ": \t"
211 << allowed_video_codecs_description[i]
215 int process_global_flags(arg_list_t &arg_list)
217 arg_list_t::iterator iter, next;
219 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
222 return SYNFIGTOOL_OK;
224 if(*iter == "--signal-test")
227 return SYNFIGTOOL_HELP;
230 if(*iter == "--guid-test")
233 return SYNFIGTOOL_HELP;
236 if(*iter == "--help")
239 return SYNFIGTOOL_HELP;
242 if(*iter == "--info")
244 cout<<PACKAGE"-"VERSION<<endl;
246 cout<<endl<<DEVEL_VERSION<<endl<<endl;
248 cout<<"Compiled on "__DATE__ /* " at "__TIME__ */;
250 cout<<" with GCC "<<__VERSION__;
253 cout<<" with Microsoft Visual C++ "<<(_MSC_VER>>8)<<'.'<<(_MSC_VER&255);
255 #ifdef __TCPLUSPLUS__
256 cout<<" with Borland Turbo C++ "<<(__TCPLUSPLUS__>>8)<<'.'<<((__TCPLUSPLUS__&255)>>4)<<'.'<<(__TCPLUSPLUS__&15);
258 cout<<endl<<SYNFIG_COPYRIGHT<<endl;
260 return SYNFIGTOOL_HELP;
263 if(*iter == "--layers")
266 synfig::Main synfig_main(dirname(progname),&p);
267 synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
268 for(;iter!=synfig::Layer::book().end();iter++)
269 if (iter->second.category != CATEGORY_DO_NOT_USE)
270 cout<<iter->first<<endl;
272 return SYNFIGTOOL_HELP;
275 if(*iter == "--layer-info")
278 synfig::Main synfig_main(dirname(progname),&p);
280 if (iter==arg_list.end())
282 error("The `%s' flag requires a value. Use --help for a list of options.", "--layer-info");
283 return SYNFIGTOOL_MISSINGARGUMENT;
285 Layer::Handle layer=synfig::Layer::create(*iter);
286 cout<<"Layer Name: "<<layer->get_name()<<endl;
287 cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
288 cout<<"Version: "<<layer->get_version()<<endl;
289 Layer::Vocab vocab=layer->get_param_vocab();
290 for(;!vocab.empty();vocab.pop_front())
292 cout<<"param - "<<vocab.front().get_name();
293 if(!vocab.front().get_critical())
294 cout<<" (not critical)";
295 cout<<endl<<"\tLocalized Name: "<<vocab.front().get_local_name()<<endl;
296 if(!vocab.front().get_description().empty())
297 cout<<"\tDescription: "<<vocab.front().get_description()<<endl;
298 if(!vocab.front().get_hint().empty())
299 cout<<"\tHint: "<<vocab.front().get_hint()<<endl;
302 return SYNFIGTOOL_HELP;
305 if(*iter == "--modules")
308 synfig::Main synfig_main(dirname(progname),&p);
309 synfig::Module::Book::iterator iter=synfig::Module::book().begin();
310 for(;iter!=synfig::Module::book().end();iter++)
311 cout<<iter->first<<endl;
312 return SYNFIGTOOL_HELP;
315 if(*iter == "--targets")
318 synfig::Main synfig_main(dirname(progname),&p);
319 synfig::Target::Book::iterator iter=synfig::Target::book().begin();
320 for(;iter!=synfig::Target::book().end();iter++)
321 cout<<iter->first<<endl;
322 return SYNFIGTOOL_HELP;
325 if(*iter == "--target-video-codecs")
327 display_target_video_codecs_help();
329 return SYNFIGTOOL_HELP;
332 if(*iter == "--valuenodes")
335 synfig::Main synfig_main(dirname(progname),&p);
336 synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
337 for(;iter!=synfig::LinkableValueNode::book().end();iter++)
338 cout<<iter->first<<endl;
339 return SYNFIGTOOL_HELP;
342 if(*iter == "--importers")
345 synfig::Main synfig_main(dirname(progname),&p);
346 synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
347 for(;iter!=synfig::Importer::book().end();iter++)
348 cout<<iter->first<<endl;
349 return SYNFIGTOOL_HELP;
352 if(*iter == "--version")
354 cerr<<PACKAGE<<" "<<VERSION<<endl;
355 arg_list.erase(iter);
356 return SYNFIGTOOL_HELP;
359 if(*iter == "--license")
361 cerr<<PACKAGE<<" "<<VERSION<<endl;
362 cout<<SYNFIG_COPYRIGHT<<endl<<endl;
364 ** This package is free software; you can redistribute it and/or\n\
365 ** modify it under the terms of the GNU General Public License as\n\
366 ** published by the Free Software Foundation; either version 2 of\n\
367 ** the License, or (at your option) any later version.\n\
369 ** " << endl << endl;
370 arg_list.erase(iter);
371 return SYNFIGTOOL_HELP;
377 arg_list.erase(iter);
384 arg_list.erase(iter);
389 print_benchmarks=true;
390 arg_list.erase(iter);
395 return SYNFIGTOOL_OK;
398 /* true if the given flag takes an extra parameter */
399 bool flag_requires_value(String flag)
401 return (flag=="-a" || flag=="-c" || flag=="-g" || flag=="-h" || flag=="-o" ||
402 flag=="-Q" || flag=="-s" || flag=="-t" || flag=="-T" || flag=="-w" ||
403 flag=="--append" || flag=="--begin-time" || flag=="--canvas-info"|| flag=="--dpi" || flag=="--dpi-x" ||
404 flag=="--dpi-y" || flag=="--end-time" || flag=="--fps" || flag=="--layer-info" || flag=="--start-time" ||
405 flag=="--time" || flag=="-vc" || flag=="-vb");
408 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
410 arg_list_t::iterator iter, next;
412 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
414 if(*iter->begin() != '-')
416 //cerr<<*iter->begin()<<"-----------"<<endl;
417 return SYNFIGTOOL_OK;
420 if (flag_requires_value(*iter))
422 cluster.push_back(*iter);
423 arg_list.erase(iter);
425 if (iter==arg_list.end())
427 error("The `%s' flag requires a value. Use --help for a list of options.", cluster.back().c_str());
428 return SYNFIGTOOL_MISSINGARGUMENT;
432 cluster.push_back(*iter);
433 arg_list.erase(iter);
436 return SYNFIGTOOL_OK;
439 /*! Extract a parameter from the argument list
441 * \param arg_list Argument list from wich the parameter is extracted.
442 * \param iter Iterator pointing to the argument list parameter to be
444 * \param next Iterator pointing to the next argument.
446 string extract_parameter (arg_list_t& arg_list,
447 arg_list_t::iterator& iter,
448 arg_list_t::iterator& next)
451 arg_list.erase(iter);
454 arg_list.erase(iter);
458 int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
460 arg_list_t::iterator iter, next;
463 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
467 w = atoi(extract_parameter(arg_list, iter, next).c_str());
471 h = atoi(extract_parameter(arg_list, iter, next).c_str());
476 a = atoi(extract_parameter(arg_list, iter, next).c_str());
477 desc.set_antialias(a);
478 VERBOSE_OUT(1)<<strprintf(_("Antialiasing set to %d, (%d samples per pixel)"),a,a*a)<<endl;
482 span = atoi(extract_parameter(arg_list, iter, next).c_str());
483 VERBOSE_OUT(1)<<strprintf(_("Span set to %d units"),span)<<endl;
485 else if(*iter=="--fps")
487 float fps = atof(extract_parameter(arg_list, iter, next).c_str());
488 desc.set_frame_rate(fps);
489 VERBOSE_OUT(1)<<strprintf(_("Frame rate set to %d frames per second"),fps)<<endl;
491 else if(*iter=="--dpi")
493 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
494 float dots_per_meter=dpi*39.3700787402;
495 desc.set_x_res(dots_per_meter).set_y_res(dots_per_meter);
496 VERBOSE_OUT(1)<<strprintf(_("Physical resolution set to %f dpi"),dpi)<<endl;
498 else if(*iter=="--dpi-x")
500 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
501 float dots_per_meter=dpi*39.3700787402;
502 desc.set_x_res(dots_per_meter);
503 VERBOSE_OUT(1)<<strprintf(_("Physical X resolution set to %f dpi"),dpi)<<endl;
505 else if(*iter=="--dpi-y")
507 float dpi = atof(extract_parameter(arg_list, iter, next).c_str());
508 float dots_per_meter=dpi*39.3700787402;
509 desc.set_y_res(dots_per_meter);
510 VERBOSE_OUT(1)<<strprintf(_("Physical Y resolution set to %f dpi"),dpi)<<endl;
512 else if(*iter=="--start-time" || *iter=="--begin-time")
514 desc.set_time_start(Time(extract_parameter(arg_list, iter, next),
515 desc.get_frame_rate()));
517 else if(*iter=="--end-time")
519 desc.set_time_end(Time(extract_parameter(arg_list, iter, next),
520 desc.get_frame_rate()));
522 else if(*iter=="--time")
524 desc.set_time(Time(extract_parameter(arg_list, iter, next),
525 desc.get_frame_rate()));
526 VERBOSE_OUT(1)<<_("Rendering frame at ")<<desc.get_time_start().get_string(desc.get_frame_rate())<<endl;
530 synfig::warning("Gamma argument is currently ignored");
531 //desc.set_gamma(Gamma(atoi(extract_parameter(arg_list, iter, next).c_str())));
533 else if (flag_requires_value(*iter))
539 w = desc.get_w() * h / desc.get_h();
541 h = desc.get_h() * w / desc.get_w();
544 VERBOSE_OUT(1)<<strprintf(_("Resolution set to %dx%d"),w,h)<<endl;
548 return SYNFIGTOOL_OK;
551 int extract_quality(arg_list_t &arg_list,int &quality)
553 arg_list_t::iterator iter, next;
554 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
558 quality = atoi(extract_parameter(arg_list, iter, next).c_str());
559 VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
561 else if (flag_requires_value(*iter))
565 return SYNFIGTOOL_OK;
568 int extract_threads(arg_list_t &arg_list,int &threads)
570 arg_list_t::iterator iter, next;
571 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
575 threads = atoi(extract_parameter(arg_list, iter, next).c_str());
576 VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
578 else if (flag_requires_value(*iter))
582 return SYNFIGTOOL_OK;
585 int extract_target(arg_list_t &arg_list,string &type)
587 arg_list_t::iterator iter, next;
590 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
594 type = extract_parameter(arg_list, iter, next);
595 VERBOSE_OUT(1)<<strprintf(_("Target set to %s"), type.c_str())<<endl;
597 else if (flag_requires_value(*iter))
601 return SYNFIGTOOL_OK;
604 int extract_target_params(arg_list_t& arg_list,
609 // If -vc parameter is provided, -vb parameter is needed.
610 bool need_bitrate_parameter = false;
611 arg_list_t::iterator iter, next;
613 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
617 // Target video codec
618 params.video_codec = extract_parameter(arg_list, iter, next);
620 // video_codec string to lowercase
621 transform (params.video_codec.begin(),
622 params.video_codec.end(),
623 params.video_codec.begin(),
627 local_ret = SYNFIGTOOL_UNKNOWNARGUMENT;
629 // Check if the given video codec is allowed.
630 for (int i = 0; local_ret != SYNFIGTOOL_OK &&
631 allowed_video_codecs[i] != NULL; i++)
632 if (params.video_codec == allowed_video_codecs[i])
633 local_ret = SYNFIGTOOL_OK;
637 if (ret == SYNFIGTOOL_OK)
639 VERBOSE_OUT(1)<<strprintf(_("Target video codec set to %s"), params.video_codec.c_str())<<endl;
640 need_bitrate_parameter = true;
643 else if(*iter=="-vb")
645 need_bitrate_parameter = false;
648 atoi(extract_parameter(arg_list, iter, next).c_str());
649 VERBOSE_OUT(1)<<strprintf(_("Target bitrate set to %dk"),params.bitrate)<<endl;
651 else if (flag_requires_value(*iter))
655 if (need_bitrate_parameter)
656 ret = SYNFIGTOOL_MISSINGARGUMENT;
661 int extract_append(arg_list_t &arg_list,string &filename)
663 arg_list_t::iterator iter, next;
666 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
668 if(*iter=="--append")
670 filename = extract_parameter(arg_list, iter, next);
672 else if (flag_requires_value(*iter))
676 return SYNFIGTOOL_OK;
679 int extract_outfile(arg_list_t &arg_list,string &outfile)
681 arg_list_t::iterator iter, next;
682 int ret=SYNFIGTOOL_FILENOTFOUND;
685 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
689 outfile = extract_parameter(arg_list, iter, next);
692 else if (flag_requires_value(*iter))
699 int extract_canvasid(arg_list_t &arg_list,string &canvasid)
701 arg_list_t::iterator iter, next;
704 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
708 canvasid = extract_parameter(arg_list, iter, next);
710 else if (flag_requires_value(*iter))
714 return SYNFIGTOOL_OK;
717 int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
719 arg_list_t::iterator iter, next;
721 for(next=arg_list.begin(), iter = next++; iter!=arg_list.end();
723 if(*iter=="--list-canvases")
725 list_canvases = true;
726 arg_list.erase(iter);
729 return SYNFIGTOOL_OK;
732 void extract_canvas_info(arg_list_t &arg_list, Job &job)
734 arg_list_t::iterator iter, next;
736 for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
737 if(*iter=="--canvas-info")
739 job.canvas_info = true;
740 String values(extract_parameter(arg_list, iter, next)), value;
742 std::string::size_type pos;
743 while (!values.empty())
745 pos = values.find_first_of(',');
746 if (pos == std::string::npos)
753 value = values.substr(0, pos);
754 values = values.substr(pos+1);
758 job.canvas_info_all = true;
762 if (value == "time_start") job.canvas_info_time_start = true;
763 else if (value == "time_end") job.canvas_info_time_end = true;
764 else if (value == "frame_rate") job.canvas_info_frame_rate = true;
765 else if (value == "frame_start") job.canvas_info_frame_start = true;
766 else if (value == "frame_end") job.canvas_info_frame_end = true;
767 else if (value == "w") job.canvas_info_w = true;
768 else if (value == "h") job.canvas_info_h = true;
769 else if (value == "image_aspect") job.canvas_info_image_aspect = true;
770 else if (value == "pw") job.canvas_info_pw = true;
771 else if (value == "ph") job.canvas_info_ph = true;
772 else if (value == "pixel_aspect") job.canvas_info_pixel_aspect = true;
773 else if (value == "tl") job.canvas_info_tl = true;
774 else if (value == "br") job.canvas_info_br = true;
775 else if (value == "physical_w") job.canvas_info_physical_w = true;
776 else if (value == "physical_h") job.canvas_info_physical_h = true;
777 else if (value == "x_res") job.canvas_info_x_res = true;
778 else if (value == "y_res") job.canvas_info_y_res = true;
779 else if (value == "span") job.canvas_info_span = true;
780 else if (value == "interlaced") job.canvas_info_interlaced = true;
781 else if (value == "antialias") job.canvas_info_antialias = true;
782 else if (value == "clamp") job.canvas_info_clamp = true;
783 else if (value == "flags") job.canvas_info_flags = true;
784 else if (value == "focus") job.canvas_info_focus = true;
785 else if (value == "bg_color") job.canvas_info_bg_color = true;
786 else if (value == "metadata") job.canvas_info_metadata = true;
789 cerr<<_("Unrecognised canvas variable: ") << "'" << value << "'" << endl;
790 cerr<<_("Recognized variables are:") << endl <<
791 " all, time_start, time_end, frame_rate, frame_start, frame_end, w, h," << endl <<
792 " image_aspect, pw, ph, pixel_aspect, tl, br, physical_w, physical_h," << endl <<
793 " x_res, y_res, span, interlaced, antialias, clamp, flags," << endl <<
794 " focus, bg_color, metadata" << endl;
797 if (pos == std::string::npos)
803 void list_child_canvases(string prefix, Canvas::Handle canvas)
805 Canvas::Children children(canvas->children());
806 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
808 cout << prefix << ":" << (*iter)->get_id() << endl;
809 list_child_canvases(prefix + ":" + (*iter)->get_id(), *iter);
813 void list_canvas_info(Job job)
815 Canvas::Handle canvas(job.canvas);
816 const RendDesc &rend_desc(canvas->rend_desc());
818 if (job.canvas_info_all || job.canvas_info_time_start)
820 cout << endl << "# " << _("Start Time") << endl;
821 cout << "time_start" << "=" << rend_desc.get_time_start().get_string().c_str() << endl;
824 if (job.canvas_info_all || job.canvas_info_time_end)
826 cout << endl << "# " << _("End Time") << endl;
827 cout << "time_end" << "=" << rend_desc.get_time_end().get_string().c_str() << endl;
830 if (job.canvas_info_all || job.canvas_info_frame_rate)
832 cout << endl << "# " << _("Frame Rate") << endl;
833 cout << "frame_rate" << "=" << rend_desc.get_frame_rate() << endl;
836 if (job.canvas_info_all || job.canvas_info_frame_start)
838 cout << endl << "# " << _("Start Frame") << endl;
839 cout << "frame_start" << "=" << rend_desc.get_frame_start() << endl;
842 if (job.canvas_info_all || job.canvas_info_frame_end)
844 cout << endl << "# " << _("End Frame") << endl;
845 cout << "frame_end" << "=" << rend_desc.get_frame_end() << endl;
848 if (job.canvas_info_all)
851 if (job.canvas_info_all || job.canvas_info_w)
853 cout << endl << "# " << _("Width") << endl;
854 cout << "w" << "=" << rend_desc.get_w() << endl;
857 if (job.canvas_info_all || job.canvas_info_h)
859 cout << endl << "# " << _("Height") << endl;
860 cout << "h" << "=" << rend_desc.get_h() << endl;
863 if (job.canvas_info_all || job.canvas_info_image_aspect)
865 cout << endl << "# " << _("Image Aspect Ratio") << endl;
866 cout << "image_aspect" << "=" << rend_desc.get_image_aspect() << endl;
869 if (job.canvas_info_all)
872 if (job.canvas_info_all || job.canvas_info_pw)
874 cout << endl << "# " << _("Pixel Width") << endl;
875 cout << "pw" << "=" << rend_desc.get_pw() << endl;
878 if (job.canvas_info_all || job.canvas_info_ph)
880 cout << endl << "# " << _("Pixel Height") << endl;
881 cout << "ph" << "=" << rend_desc.get_ph() << endl;
884 if (job.canvas_info_all || job.canvas_info_pixel_aspect)
886 cout << endl << "# " << _("Pixel Aspect Ratio") << endl;
887 cout << "pixel_aspect" << "=" << rend_desc.get_pixel_aspect() << endl;
890 if (job.canvas_info_all)
893 if (job.canvas_info_all || job.canvas_info_tl)
895 cout << endl << "# " << _("Top Left") << endl;
896 cout << "tl" << "=" << rend_desc.get_tl()[0]
897 << " " << rend_desc.get_tl()[1] << endl;
900 if (job.canvas_info_all || job.canvas_info_br)
902 cout << endl << "# " << _("Bottom Right") << endl;
903 cout << "br" << "=" << rend_desc.get_br()[0]
904 << " " << rend_desc.get_br()[1] << endl;
907 if (job.canvas_info_all || job.canvas_info_physical_w)
909 cout << endl << "# " << _("Physical Width") << endl;
910 cout << "physical_w" << "=" << rend_desc.get_physical_w() << endl;
913 if (job.canvas_info_all || job.canvas_info_physical_h)
915 cout << endl << "# " << _("Physical Height") << endl;
916 cout << "physical_h" << "=" << rend_desc.get_physical_h() << endl;
919 if (job.canvas_info_all || job.canvas_info_x_res)
921 cout << endl << "# " << _("X Resolution") << endl;
922 cout << "x_res" << "=" << rend_desc.get_x_res() << endl;
925 if (job.canvas_info_all || job.canvas_info_y_res)
927 cout << endl << "# " << _("Y Resolution") << endl;
928 cout << "y_res" << "=" << rend_desc.get_y_res() << endl;
931 if (job.canvas_info_all || job.canvas_info_span)
933 cout << endl << "# " << _("Diagonal Image Span") << endl;
934 cout << "span" << "=" << rend_desc.get_span() << endl;
937 if (job.canvas_info_all)
940 if (job.canvas_info_all || job.canvas_info_interlaced)
942 cout << endl << "# " << _("Interlaced") << endl;
943 cout << "interlaced" << "=" << rend_desc.get_interlaced() << endl;
946 if (job.canvas_info_all || job.canvas_info_antialias)
948 cout << endl << "# " << _("Antialias") << endl;
949 cout << "antialias" << "=" << rend_desc.get_antialias() << endl;
952 if (job.canvas_info_all || job.canvas_info_clamp)
954 cout << endl << "# " << _("Clamp") << endl;
955 cout << "clamp" << "=" << rend_desc.get_clamp() << endl;
958 if (job.canvas_info_all || job.canvas_info_flags)
960 cout << endl << "# " << _("Flags") << endl;
961 cout << "flags" << "=" << rend_desc.get_flags() << endl;
964 if (job.canvas_info_all || job.canvas_info_focus)
966 cout << endl << "# " << _("Focus") << endl;
967 cout << "focus" << "=" << rend_desc.get_focus()[0]
968 << " " << rend_desc.get_focus()[1] << endl;
971 if (job.canvas_info_all || job.canvas_info_bg_color)
973 cout << endl << "# " << _("Background Color") << endl;
974 cout << "bg_color" << "=" << rend_desc.get_bg_color().get_string().c_str() << endl;
977 if (job.canvas_info_all)
980 if (job.canvas_info_all || job.canvas_info_metadata)
982 std::list<String> keys(canvas->get_meta_data_keys());
983 cout << endl << "# " << _("Metadata") << endl;
984 for (std::list<String>::iterator iter = keys.begin(); iter != keys.end(); iter++)
985 cout << *iter << "=" << canvas->get_meta_data(*iter) << endl;
989 /* === M E T H O D S ======================================================= */
991 /* === E N T R Y P O I N T ================================================= */
993 int main(int argc, char *argv[])
999 setlocale(LC_ALL, "");
1002 bindtextdomain("synfig", LOCALEDIR);
1003 bind_textdomain_codeset("synfig", "UTF-8");
1004 textdomain("synfig");
1008 Progress p(argv[0]);
1010 if(!SYNFIG_CHECK_VERSION())
1012 cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
1013 return SYNFIGTOOL_BADVERSION;
1018 display_help(false);
1019 return SYNFIGTOOL_BLANK;
1023 arg_list.push_back(argv[i]);
1025 if((i=process_global_flags(arg_list)))
1028 VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
1029 synfig::Main synfig_main(dirname(progname),&p);
1032 arg_list_t defaults, imageargs;
1035 // Grab the defaults before the first file
1036 if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
1039 while(arg_list.size())
1042 job_list.push_front(Job());
1046 job_list.front().filename=arg_list.front();
1047 arg_list.pop_front();
1049 if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
1052 // Open the composition
1053 String errors, warnings;
1056 job_list.front().root=open_canvas(job_list.front().filename, errors, warnings);
1058 catch(runtime_error x)
1060 job_list.front().root = 0;
1063 if(!job_list.front().root)
1065 cerr<<_("Unable to load '")<<job_list.front().filename<<"'."<<endl;
1066 cerr<<_("Throwing out job...")<<endl;
1067 job_list.pop_front();
1071 bool list_canvases = false;
1072 extract_list_canvases(imageargs, list_canvases);
1073 job_list.front().list_canvases = list_canvases;
1075 extract_canvas_info(imageargs, job_list.front());
1077 job_list.front().root->set_time(0);
1080 extract_canvasid(imageargs,canvasid);
1081 if(!canvasid.empty())
1086 job_list.front().canvas=job_list.front().root->find_canvas(canvasid, warnings);
1088 catch(Exception::IDNotFound)
1090 cerr<<_("Unable to find canvas with ID \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1091 cerr<<_("Throwing out job...")<<endl;
1092 job_list.pop_front();
1096 catch(Exception::BadLinkName)
1098 cerr<<_("Invalid canvas name \"")<<canvasid<<_("\" in ")<<job_list.front().filename<<"."<<endl;
1099 cerr<<_("Throwing out job...")<<endl;
1100 job_list.pop_front();
1105 job_list.front().canvas=job_list.front().root;
1107 extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
1108 extract_target(imageargs,target_name);
1109 extract_threads(imageargs,threads);
1110 job_list.front().quality=DEFAULT_QUALITY;
1111 extract_quality(imageargs,job_list.front().quality);
1112 VERBOSE_OUT(2)<<_("Quality set to ")<<job_list.front().quality<<endl;
1113 job_list.front().desc=job_list.front().canvas->rend_desc();
1114 extract_outfile(imageargs,job_list.front().outfilename);
1116 // Extract composite
1118 string composite_file;
1119 extract_append(imageargs,composite_file);
1120 if(!composite_file.empty())
1122 String errors, warnings;
1123 Canvas::Handle composite(open_canvas(composite_file, errors, warnings));
1126 cerr<<_("Unable to append '")<<composite_file<<"'."<<endl;
1129 Canvas::reverse_iterator iter;
1130 for(iter=composite->rbegin();iter!=composite->rend();++iter)
1132 Layer::Handle layer(*iter);
1134 job_list.front().canvas->push_front(layer->clone());
1136 VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
1140 VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
1142 // If the target type is not yet defined,
1143 // try to figure it out from the outfile.
1144 if(target_name.empty() && !job_list.front().outfilename.empty())
1146 VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
1147 string ext = filename_extension(job_list.front().outfilename);
1148 if (ext.length()) ext = ext.substr(1);
1149 if(Target::ext_book().count(ext))
1151 target_name=Target::ext_book()[ext];
1152 info("target name not specified - using %s", target_name.c_str());
1156 string lower_ext(ext);
1158 for(unsigned int i=0;i<ext.length();i++)
1159 lower_ext[i] = tolower(ext[i]);
1161 if(Target::ext_book().count(lower_ext))
1163 target_name=Target::ext_book()[lower_ext];
1164 info("target name not specified - using %s", target_name.c_str());
1171 TargetParam target_parameters;
1172 // Extract the extra parameters for the targets that
1174 if (target_name == "ffmpeg")
1177 status = extract_target_params(imageargs, target_parameters);
1178 if (status == SYNFIGTOOL_UNKNOWNARGUMENT)
1180 cerr << strprintf(_("Unknown target video codec: %s."),
1181 target_parameters.video_codec.c_str())
1183 cerr << _("Available target video codecs are:")
1185 display_target_video_codecs_help();
1187 return SYNFIGTOOL_UNKNOWNARGUMENT;
1189 else if (status == SYNFIGTOOL_MISSINGARGUMENT)
1191 cerr << _("Missing argument: \"-vb\".") << endl;
1193 return SYNFIGTOOL_MISSINGARGUMENT;
1197 // If the target type is STILL not yet defined, then
1198 // set it to a some sort of default
1199 if(target_name.empty())
1201 VERBOSE_OUT(2)<<_("Defaulting to PNG target...")<<endl;
1205 // If no output filename was provided, then
1206 // create a output filename based on the
1207 // given input filename. (ie: change the extension)
1208 if(job_list.front().outfilename.empty())
1210 job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
1211 if(Target::book().count(target_name))
1212 job_list.front().outfilename+=Target::book()[target_name].filename;
1214 job_list.front().outfilename+=target_name;
1217 VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
1218 VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
1220 VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
1221 job_list.front().target =
1222 synfig::Target::create(target_name,
1223 job_list.front().outfilename,
1226 if(target_name=="sif")
1227 job_list.front().sifout=true;
1230 if(!job_list.front().target)
1232 cerr<<_("Unknown target for ")<<job_list.front().filename<<": "<<target_name<<endl;
1233 cerr<<_("Throwing out job...")<<endl;
1234 job_list.pop_front();
1237 job_list.front().sifout=false;
1240 // Set the Canvas on the Target
1241 if(job_list.front().target)
1243 VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
1244 job_list.front().target->set_canvas(job_list.front().canvas);
1245 VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
1246 job_list.front().target->set_quality(job_list.front().quality);
1249 // Set the threads for the target
1250 if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
1251 Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
1253 if(imageargs.size())
1255 cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
1256 for(;imageargs.size();imageargs.pop_front())
1257 cerr<<' '<<imageargs.front();
1259 cerr<<_("Throwing out job...")<<endl;
1260 job_list.pop_front();
1268 cerr<<_("Unidentified arguments:");
1269 for(;arg_list.size();arg_list.pop_front())
1270 cerr<<' '<<arg_list.front();
1272 return SYNFIGTOOL_UNKNOWNARGUMENT;
1275 if(!job_list.size())
1277 cerr<<_("Nothing to do!")<<endl;
1278 return SYNFIGTOOL_BORED;
1281 for(;job_list.size();job_list.pop_front())
1283 VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
1284 strprintf("w:%d, h:%d, a:%d, pxaspect:%f, imaspect:%f, span:%f",
1285 job_list.front().desc.get_w(),
1286 job_list.front().desc.get_h(),
1287 job_list.front().desc.get_antialias(),
1288 job_list.front().desc.get_pixel_aspect(),
1289 job_list.front().desc.get_image_aspect(),
1290 job_list.front().desc.get_span()
1292 strprintf("tl:[%f,%f], br:[%f,%f], focus:[%f,%f]",
1293 job_list.front().desc.get_tl()[0],job_list.front().desc.get_tl()[1],
1294 job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
1295 job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
1299 p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
1300 if(job_list.front().sifout)
1302 if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
1304 cerr<<"Render Failure."<<endl;
1305 return SYNFIGTOOL_RENDERFAILURE;
1308 else if (job_list.front().list_canvases)
1310 list_child_canvases(job_list.front().filename + "#", job_list.front().canvas);
1313 else if (job_list.front().canvas_info)
1315 list_canvas_info(job_list.front());
1320 VERBOSE_OUT(1)<<_("Rendering...")<<endl;
1323 // Call the render member of the target
1324 if(!job_list.front().target->render(&p))
1326 cerr<<"Render Failure."<<endl;
1327 return SYNFIGTOOL_RENDERFAILURE;
1329 if(print_benchmarks)
1330 cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
1336 VERBOSE_OUT(1)<<_("Done.")<<endl;
1338 return SYNFIGTOOL_OK;