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