synfig-studio/src/gtkmm/render.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file gtkmm/render.cpp
   3 **      \brief Template File
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007, 2008 Chris Moore
  10 **
  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.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "render.h"
  34 #include "app.h"
  35 #include <gtkmm/frame.h>
  36 #include <gtkmm/alignment.h>
  37 #include <synfig/target_scanline.h>
  38 #include <synfig/canvas.h>
  39 #include "asyncrenderer.h"
  40 #include "dialog_targetparam.h"
  41
  42 #include "general.h"
  43
  44 #include <fstream>
  45
  46 #endif
  47
  48 /* === U S I N G =========================================================== */
  49
  50 using namespace std;
  51 using namespace etl;
  52 using namespace synfig;
  53 using namespace studio;
  54
  55 /* === M A C R O S ========================================================= */
  56
  57 /* === G L O B A L S ======================================================= */
  58
  59 /* === P R O C E D U R E S ================================================= */
  60
  61 /* === M E T H O D S ======================================================= */
  62
  63 RenderSettings::RenderSettings(Gtk::Window& parent, etl::handle<synfigapp::CanvasInterface> canvas_interface):
  64         Gtk::Dialog(_("Render Settings"),parent,false,true),
  65         canvas_interface_(canvas_interface),
  66         adjustment_quality(3,0,9),
  67         entry_quality(adjustment_quality,1,0),
  68         adjustment_antialias(1,1,31),
  69         entry_antialias(adjustment_antialias,1,0),
  70         toggle_single_frame(_("Use _current frame"), true),
  71         tparam("libxvid",200)
  72 {
  73         widget_rend_desc.show();
  74         widget_rend_desc.signal_changed().connect(sigc::mem_fun(*this,&studio::RenderSettings::on_rend_desc_changed));
  75         widget_rend_desc.set_rend_desc(canvas_interface_->get_canvas()->rend_desc());
  76
  77         canvas_interface->signal_rend_desc_changed().connect(sigc::mem_fun(*this,&RenderSettings::on_rend_desc_changed));
  78
  79         menu_target=manage(new class Gtk::Menu());
  80
  81         menu_target->items().push_back(Gtk::Menu_Helpers::MenuElem(_("Auto"),
  82                         sigc::bind(sigc::mem_fun(*this,&RenderSettings::set_target),String())
  83                 ));
  84
  85         synfig::Target::Book::iterator iter;
  86         synfig::Target::Book book(synfig::Target::book());
  87
  88         for(iter=book.begin();iter!=book.end();iter++)
  89         {
  90                 menu_target->items().push_back(Gtk::Menu_Helpers::MenuElem(iter->first,
  91                         sigc::bind(sigc::mem_fun(*this,&RenderSettings::set_target),iter->first)
  92                 ));
  93         }
  94         optionmenu_target.set_menu(*menu_target);
  95
  96         optionmenu_target.set_history(0);
  97
  98         Gtk::Alignment *dialogPadding = manage(new Gtk::Alignment(0, 0, 1, 1));
  99         dialogPadding->set_padding(12, 12, 12, 12);
 100         get_vbox()->pack_start(*dialogPadding, false, false, 0);
 101
 102         Gtk::VBox *dialogBox = manage(new Gtk::VBox(false, 12));
 103         dialogPadding->add(*dialogBox);
 104
 105         Gtk::Button *choose_button(manage(new class Gtk::Button(Gtk::StockID(_("Choose...")))));
 106         choose_button->show();
 107         choose_button->signal_clicked().connect(sigc::mem_fun(*this, &studio::RenderSettings::on_choose_pressed));
 108
 109         Gtk::Button *tparam_button(manage(new class Gtk::Button(Gtk::StockID(_("Parameters...")))));
 110         tparam_button->show();
 111         tparam_button->signal_clicked().connect(sigc::mem_fun(*this, &studio::RenderSettings::on_targetparam_pressed));
 112
 113         Gtk::Frame *target_frame=manage(new Gtk::Frame(_("Target")));
 114         target_frame->set_shadow_type(Gtk::SHADOW_NONE);
 115         ((Gtk::Label *) target_frame->get_label_widget())->set_markup(_("<b>Target</b>"));
 116         dialogBox->pack_start(*target_frame);
 117         Gtk::Alignment *targetPadding = manage(new Gtk::Alignment(0, 0, 1, 1));
 118         targetPadding->set_padding(6, 0, 24, 0);
 119         target_frame->add(*targetPadding);
 120
 121         Gtk::Table *target_table = manage(new Gtk::Table(2, 3, false));
 122         target_table->set_row_spacings(6);
 123         target_table->set_col_spacings(12);
 124         targetPadding->add(*target_table);
 125
 126         Gtk::Label *filenameLabel = manage(new Gtk::Label(_("_Filename"), true));
 127         filenameLabel->set_alignment(0, 0.5);
 128         filenameLabel->set_mnemonic_widget(entry_filename);
 129         target_table->attach(*filenameLabel, 0, 1, 0, 1, Gtk::SHRINK|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 130         target_table->attach(entry_filename, 1, 2, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 131         target_table->attach(*choose_button, 2, 3, 0, 1, Gtk::SHRINK|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 132
 133         Gtk::Label *targetLabel = manage(new Gtk::Label(_("_Target"), true));
 134         targetLabel->set_alignment(0, 0.5);
 135         targetLabel->set_mnemonic_widget(optionmenu_target);
 136         target_table->attach(*targetLabel, 0, 1, 1, 2, Gtk::SHRINK|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 137         target_table->attach(optionmenu_target, 1, 2, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 138         target_table->attach(*tparam_button, 2, 3, 1, 2, Gtk::SHRINK|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 139
 140         toggle_single_frame.signal_toggled().connect(sigc::mem_fun(*this, &studio::RenderSettings::on_single_frame_toggle));
 141
 142         Gtk::Frame *settings_frame=manage(new Gtk::Frame(_("Settings")));
 143         settings_frame->set_shadow_type(Gtk::SHADOW_NONE);
 144         ((Gtk::Label *) settings_frame->get_label_widget())->set_markup(_("<b>Settings</b>"));
 145         dialogBox->pack_start(*settings_frame);
 146
 147         Gtk::Alignment *settingsPadding = manage(new Gtk::Alignment(0, 0, 1, 1));
 148         settingsPadding->set_padding(6, 0, 24, 0);
 149         settings_frame->add(*settingsPadding);
 150
 151         Gtk::Table *settings_table=manage(new Gtk::Table(2,2,false));
 152         settings_table->set_row_spacings(6);
 153         settings_table->set_col_spacings(12);
 154         settingsPadding->add(*settings_table);
 155
 156         Gtk::Label *qualityLabel = manage(new Gtk::Label(_("_Quality"), true));
 157         qualityLabel->set_alignment(0, 0.5);
 158         qualityLabel->set_mnemonic_widget(entry_quality);
 159         settings_table->attach(*qualityLabel, 0, 1, 0, 1, Gtk::SHRINK|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 160         settings_table->attach(entry_quality, 1, 2, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 161
 162         Gtk::Label *antiAliasLabel = manage(new Gtk::Label(_("_Anti-Aliasing"), true));
 163         antiAliasLabel->set_alignment(0, 0.5);
 164         antiAliasLabel->set_mnemonic_widget(entry_antialias);
 165         settings_table->attach(*antiAliasLabel, 0, 1, 1, 2, Gtk::SHRINK|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 166         settings_table->attach(entry_antialias, 1, 2, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 167
 168         toggle_single_frame.set_alignment(0, 0.5);
 169         settings_table->attach(toggle_single_frame, 0, 2, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::SHRINK|Gtk::FILL, 0, 0);
 170
 171         dialogBox->pack_start(widget_rend_desc);
 172
 173
 174         Gtk::Button *render_button(manage(new class Gtk::Button(Gtk::StockID("Render"))));
 175         render_button->show();
 176         add_action_widget(*render_button,1);
 177         render_button->signal_clicked().connect(sigc::mem_fun(*this, &studio::RenderSettings::on_render_pressed));
 178
 179         Gtk::Button *cancel_button(manage(new class Gtk::Button(Gtk::StockID("gtk-cancel"))));
 180         cancel_button->show();
 181         add_action_widget(*cancel_button,0);
 182         cancel_button->signal_clicked().connect(sigc::mem_fun(*this, &studio::RenderSettings::on_cancel_pressed));
 183
 184         //set_default_response(1);
 185
 186         set_title(_("Render Settings")+String(" - ")+canvas_interface_->get_canvas()->get_name());
 187
 188         toggle_single_frame.set_active(false);
 189         widget_rend_desc.enable_time_section();
 190
 191         set_entry_filename();
 192
 193         get_vbox()->show_all();
 194 }
 195
 196 RenderSettings::~RenderSettings()
 197 {
 198 }
 199
 200 void
 201 RenderSettings::set_entry_filename()
 202 {
 203         String filename(filename_sans_extension(canvas_interface_->get_canvas()->get_file_name()));
 204
 205         // if this isn't the root canvas, append (<canvasname>) to the filename
 206         etl::handle<synfig::Canvas> canvas = canvas_interface_->get_canvas();
 207         if (!canvas->is_root())
 208         {
 209                 if(canvas->get_name().empty())
 210                         filename+=" ("+canvas->get_id()+')';
 211                 else
 212                         filename+=" ("+canvas->get_name()+')';
 213         }
 214
 215         filename += ".png";
 216
 217         try
 218         {
 219                 entry_filename.set_text((filename));
 220         }
 221         catch(...)
 222         {
 223                 synfig::warning("Averted crash!");
 224                 entry_filename.set_text("output.png");
 225         }
 226 }
 227
 228 void
 229 RenderSettings::on_rend_desc_changed()
 230 {
 231         widget_rend_desc.set_rend_desc(canvas_interface_->get_canvas()->rend_desc());
 232 }
 233
 234 void
 235 RenderSettings::set_target(synfig::String name)
 236 {
 237         target_name=name;
 238 }
 239
 240 void
 241 RenderSettings::on_choose_pressed()
 242 {
 243         String filename=entry_filename.get_text();
 244         if(App::dialog_save_file("Save Render As", filename, RENDER_DIR_PREFERENCE))
 245                 entry_filename.set_text(filename);
 246 }
 247
 248 void
 249 RenderSettings::on_targetparam_pressed()
 250 {
 251         Dialog_TargetParam *dialogtp = new Dialog_TargetParam(tparam);
 252         if(dialogtp->run()==GTK_RESPONSE_ACCEPT)
 253                 tparam=dialogtp->get_tparam();
 254         delete dialogtp;
 255 }
 256
 257 void
 258 RenderSettings::on_render_pressed()
 259 {
 260         String filename=entry_filename.get_text();
 261         synfig::String calculated_target_name(target_name);
 262
 263         if(filename.empty())
 264         {
 265                 canvas_interface_->get_ui_interface()->error(_("You must supply a filename!"));
 266                 return;
 267         }
 268
 269         // If the target type is not yet defined,
 270         // try to figure it out from the outfile.
 271         if(calculated_target_name.empty())
 272         {
 273                 try
 274                 {
 275                         String ext(filename_extension(filename));
 276                         if (ext.size()) ext=ext.substr(1); // skip initial '.'
 277                         synfig::info("render target filename: '%s'; extension: '%s'", filename.c_str(), ext.c_str());
 278                         if(Target::ext_book().count(ext))
 279                         {
 280                                 calculated_target_name=Target::ext_book()[ext];
 281                                 synfig::info("'%s' is a known extension - using target '%s'", ext.c_str(), calculated_target_name.c_str());
 282                         }
 283                         else
 284                         {
 285                                 calculated_target_name=ext;
 286                                 synfig::info("unknown extension");
 287                         }
 288                 }
 289                 catch(std::runtime_error x)
 290                 {
 291                         canvas_interface_->get_ui_interface()->error(_("Unable to determine proper target from filename."));
 292                         return;
 293                 }
 294         }
 295
 296         if(filename.empty() && calculated_target_name!="null")
 297         {
 298                 canvas_interface_->get_ui_interface()->error(_("A filename is required for this target"));
 299                 return;
 300         }
 301
 302         Target::Handle target=Target::create(calculated_target_name,filename, tparam);
 303         if(!target)
 304         {
 305                 canvas_interface_->get_ui_interface()->error(_("Unable to create target for ")+filename);
 306                 return;
 307         }
 308         // This is the only way I've found to avoid send a non writable
 309         // filename path to the renderer.
 310         fstream filetest (filename.c_str(), fstream::out);
 311         if (filetest.fail())
 312         {
 313                 canvas_interface_->get_ui_interface()->error(_("Unable to create file for ")+filename);
 314                 return;
 315         }
 316
 317         hide();
 318
 319         target->set_canvas(canvas_interface_->get_canvas());
 320         RendDesc rend_desc(widget_rend_desc.get_rend_desc());
 321         rend_desc.set_antialias((int)adjustment_antialias.get_value());
 322
 323         // If we are to only render the current frame
 324         if(toggle_single_frame.get_active())
 325                 rend_desc.set_time(canvas_interface_->get_time());
 326
 327         target->set_rend_desc(&rend_desc);
 328         target->set_quality((int)adjustment_quality.get_value());
 329         if( !target->init() ){
 330                 canvas_interface_->get_ui_interface()->error(_("Target initialization failure"));
 331                 return;
 332         }
 333
 334         canvas_interface_->get_ui_interface()->task(_("Rendering ")+filename);
 335
 336         if(async_renderer)
 337         {
 338                 async_renderer->stop();
 339                 async_renderer.detach();
 340         }
 341         async_renderer=new AsyncRenderer(target);
 342         async_renderer->signal_finished().connect( sigc::mem_fun(*this,&RenderSettings::on_finished));
 343         async_renderer->start();
 344         /*
 345         if(!target->render(canvas_interface_->get_ui_interface().get()))
 346         {
 347                 canvas_interface_->get_ui_interface()->error(_("Render Failure"));
 348                 canvas_interface_->get_ui_interface()->amount_complete(0,10000);
 349                 return;
 350         }
 351
 352         // Success!
 353         canvas_interface_->get_ui_interface()->task(filename+_(" rendered successfully"));
 354         canvas_interface_->get_ui_interface()->amount_complete(0,10000);
 355         */
 356         return;
 357 }
 358
 359 void
 360 RenderSettings::on_finished()
 361 {
 362         canvas_interface_->get_ui_interface()->task(_("File rendered successfully"));
 363         canvas_interface_->get_ui_interface()->amount_complete(0,10000);
 364 }
 365
 366 void
 367 RenderSettings::on_cancel_pressed()
 368 {
 369         hide();
 370 }
 371
 372 void
 373 RenderSettings::on_single_frame_toggle()
 374 {
 375         if(toggle_single_frame.get_active())
 376                 widget_rend_desc.disable_time_section();
 377         else
 378                 widget_rend_desc.enable_time_section();
 379 }