1 /* === S Y N F I G ========================================================= */
3 ** \brief Preview implementation file
5 ** $Id: preview.cpp,v 1.2 2005/01/10 08:13:44 darco Exp $
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package is distributed in the hope that it will be useful,
16 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === H E A D E R S ======================================================= */
34 #include "audiocontainer.h"
35 #include <gtkmm/stock.h>
36 #include <gtkmm/separator.h>
38 #include <synfig/target_scanline.h>
39 #include <synfig/surface.h>
42 #include "asyncrenderer.h"
45 /* === U S I N G =========================================================== */
49 using namespace synfig;
50 using namespace studio;
52 /* === M A C R O S ========================================================= */
54 /* === G L O B A L S ======================================================= */
56 /* === P R O C E D U R E S ================================================= */
58 /* === M E T H O D S ======================================================= */
60 /* === E N T R Y P O I N T ================================================= */
62 class studio::Preview::Preview_Target : public Target_Scanline
66 sigc::signal<void, const Preview_Target *> signal_frame_done_;
81 nframes = curframe = 0;
84 const RendDesc &get_rend_desc() const { return desc; }
86 virtual bool set_rend_desc(RendDesc *r)
88 if(Target_Scanline::set_rend_desc(r))
90 /*synfig::warning("Succeeded in setting the desc to new one: %d x %d, %.2f fps [%.2f,%.2f]",
91 desc.get_w(),desc.get_h(),desc.get_frame_rate(),
92 (float)desc.get_time_start(),(float)desc.get_time_end());*/
94 surface.set_wh(desc.get_w(),desc.get_h());
97 nframes = (int)floor((desc.get_time_end() - desc.get_time_start())*desc.get_frame_rate());
99 tbegin = desc.get_time_start();
100 tend = tbegin + nframes/desc.get_frame_rate();
107 virtual bool start_frame(ProgressCallback *cb=NULL)
112 virtual void end_frame()
114 //ok... notify our subscribers...
115 signal_frame_done_(this);
117 //synfig::warning("Finished the frame stuff, and changed time to %.3f",t);
120 virtual Color * start_scanline(int scanline)
122 return surface[scanline];
125 virtual bool end_scanline() {return true;}
127 sigc::signal<void, const Preview_Target *> &signal_frame_done() {return signal_frame_done_;}
129 const Surface &get_surface() const {return surface;}
131 float get_time() const
133 double time = ((nframes-curframe)/(double)nframes)*tbegin
134 + ((curframe)/(double)nframes)*tend;
139 studio::Preview::Preview(const studio::CanvasView::LooseHandle &h, float zoom, float f)
140 :canvasview(h),zoom(zoom),fps(f)
146 void studio::Preview::set_canvasview(const studio::CanvasView::LooseHandle &h)
152 //perhaps reset override values...
153 const RendDesc &r = canvasview->get_canvas()->rend_desc();
154 if(r.get_frame_rate())
156 float rate = 1/r.get_frame_rate();
157 overbegin = false; begintime = r.get_time_start() + r.get_frame_start()*rate;
158 overend = false; endtime = r.get_time_start() + r.get_frame_end()*rate;
163 studio::Preview::~Preview()
165 signal_destroyed_(this); //tell anything that attached to us, we're dying
168 void studio::Preview::render()
172 //render using the preview target
173 etl::handle<Preview_Target> target = new Preview_Target;
175 //connect our information to his...
176 //synfig::warning("Connecting to the end frame function...");
177 target->signal_frame_done().connect(sigc::mem_fun(*this,&Preview::frame_finish));
180 //synfig::warning("Setting Canvas");
181 target->set_canvas(get_canvas());
182 target->set_quality(quality);
185 RendDesc desc = get_canvas()->rend_desc();
187 //set the global fps of the preview
188 set_global_fps(desc.get_frame_rate());
192 int neww = (int)floor(desc.get_w()*zoom+0.5),
193 newh = (int)floor(desc.get_h()*zoom+0.5);
196 /*synfig::warning("Setting the render description: %d x %d, %f fps, [%f,%f]",
197 neww,newh,newfps, overbegin?begintime:(float)desc.get_time_start(),
198 overend?endtime:(float)desc.get_time_end());*/
202 desc.set_frame_rate(newfps);
206 desc.set_time_start(std::max(begintime,(float)desc.get_time_start()));
207 //synfig::warning("Set start time to %.2f...",(float)desc.get_time_start());
211 desc.set_time_end(std::min(endtime,(float)desc.get_time_end()));
212 //synfig::warning("Set end time to %.2f...",(float)desc.get_time_end());
215 //setting the description
217 //HACK - BECAUSE THE RENDERER CAN'T RENDER INCLUDING THE LAST FRAME
218 desc.set_time_end(desc.get_time_end() + 1.3/fps);
220 target->set_rend_desc(&desc);
222 //... first we must clear our current selves of space
225 //now tell it to go... with inherited prog. reporting...
226 //synfig::info("Rendering Asynchronously...");
227 if(renderer) renderer->stop();
228 renderer = new AsyncRenderer(target);
233 static void free_guint8(const guint8 *mem)
238 void studio::Preview::frame_finish(const Preview_Target *targ)
240 //copy image with time to next frame (can just push back)
242 float time = targ->get_time();
243 const Surface &surf = targ->get_surface();
244 const RendDesc& r = targ->get_rend_desc();
246 //synfig::warning("Finished a frame at %f s",time);
249 PixelFormat pf(PF_RGB);
250 const int total_bytes(r.get_w()*r.get_h()*synfig::channels(pf));
252 //synfig::warning("Creating a buffer");
253 unsigned char *buffer((unsigned char*)malloc(total_bytes));
258 //convert all the pixles to the pixbuf... buffer... thing...
259 //synfig::warning("Converting...");
260 convert_color_format(buffer, surf[0], surf.get_w()*surf.get_h(), pf, App::gamma);
264 //uses and manages the memory for the buffer...
265 //synfig::warning("Create a pixmap...");
267 Gdk::Pixbuf::create_from_data(
268 buffer, // pointer to the data
269 Gdk::COLORSPACE_RGB, // the colorspace
270 ((pf&PF_A)==PF_A), // has alpha?
271 8, // bits per sample
272 surf.get_w(), // width
273 surf.get_h(), // height
274 surf.get_w()*synfig::channels(pf), // stride (pitch)
275 sigc::ptr_fun(free_guint8)
278 //add the flipbook element to the list (assume time is correct)
279 //synfig::info("Prev: Adding %f s to the list", time);
280 frames.push_back(fe);
285 #define IMAGIFY_BUTTON(button,stockid) \
286 icon=manage(new Gtk::Image(Gtk::StockID(stockid),Gtk::ICON_SIZE_BUTTON)); \
287 button->add(*icon); \
288 icon->set_padding(0,0);\
291 Widget_Preview::Widget_Preview()
292 :Gtk::Table(5,5,false),
293 adj_time_scrub(0,0,1000,1,10,0),
294 scr_time_scrub(adj_time_scrub),
295 b_loop(/*_("Loop")*/),
302 //connect to expose events
303 //signal_expose_event().connect(sigc::mem_fun(*this, &studio::Widget_Preview::redraw));
305 //manage all the change in values etc...
306 adj_time_scrub.signal_value_changed().connect(sigc::mem_fun(*this,&Widget_Preview::slider_move));
307 scr_time_scrub.signal_event().connect(sigc::mem_fun(*this,&Widget_Preview::scroll_move_event));
308 draw_area.signal_expose_event().connect(sigc::mem_fun(*this,&Widget_Preview::redraw));
310 disp_sound.set_time_adjustment(&adj_sound);
313 //Set up signals to modify time value as it should be...
314 disp_sound.signal_start_scrubbing().connect(sigc::mem_fun(*this,&Widget_Preview::scrub_updated));
315 disp_sound.signal_scrub().connect(sigc::mem_fun(*this,&Widget_Preview::scrub_updated));
318 ---------------------------------
326 ---------------------------------
327 |loop|play|stop | hbox
328 |lastl|lastt|rerender|haltrend | hbox
334 Gtk::Button *button = 0;
335 Gtk::Image *icon = 0;
337 //should set up the dialog using attach etc.
338 attach(draw_area, 0, 1, 0, 1);
339 attach(scr_time_scrub, 0, 1, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::SHRINK);
344 hbox = manage(new Gtk::HBox);
347 IMAGIFY_BUTTON(button,Gtk::Stock::REFRESH);
348 hbox->pack_start(b_loop,Gtk::PACK_SHRINK,0);
349 //attach(b_loop,0,1,2,3,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
351 button = manage(new Gtk::Button(/*_("Play")*/));
352 button->signal_clicked().connect(sigc::mem_fun(*this,&Widget_Preview::play));
353 IMAGIFY_BUTTON(button,Gtk::Stock::GO_FORWARD);
354 hbox->pack_start(*button,Gtk::PACK_SHRINK,0);
355 //attach(*button,1,2,2,3,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
357 button = manage(new Gtk::Button(/*_("Stop")*/));
358 button->signal_clicked().connect(sigc::mem_fun(*this,&Widget_Preview::stop));
359 IMAGIFY_BUTTON(button,Gtk::Stock::NO);
360 hbox->pack_start(*button,Gtk::PACK_SHRINK,0);
361 //attach(*button,2,3,2,3,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
363 //attack the stop render and erase all buttons to same line...
365 Gtk::VSeparator *vsep = manage(new Gtk::VSeparator);
366 hbox->pack_start(*vsep,Gtk::PACK_SHRINK,0);
369 button = manage(new Gtk::Button(/*_("Halt Render")*/));
370 button->signal_clicked().connect(sigc::mem_fun(*this,&Widget_Preview::stoprender));
371 IMAGIFY_BUTTON(button,Gtk::Stock::STOP);
372 hbox->pack_start(*button,Gtk::PACK_SHRINK,0);
373 //attach(*button,2,3,3,4,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
375 button = manage(new Gtk::Button(/*_("Re-Preview")*/));
376 button->signal_clicked().connect(sigc::mem_fun(*this,&Widget_Preview::repreview));
377 IMAGIFY_BUTTON(button,Gtk::Stock::CONVERT);
378 hbox->pack_start(*button,Gtk::PACK_SHRINK,0);
379 //attach(*button,0,2,4,5,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
381 button = manage(new Gtk::Button(/*_("Erase All")*/));
382 button->signal_clicked().connect(sigc::mem_fun(*this,&Widget_Preview::eraseall));
383 //IMAGIFY_BUTTON(button,Gtk::Stock::DELETE);
384 hbox->pack_start(*button,Gtk::PACK_SHRINK,0);
385 //attach(*button,2,3,4,5,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
388 attach(*hbox,0,1,2,3,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK|Gtk::FILL);
391 hbox = manage(new Gtk::HBox);
393 Gtk::Label *label = manage(new Gtk::Label("Last Rendered: "));
395 hbox->pack_start(*label,Gtk::PACK_SHRINK,10);
396 //attach(*manage(new Gtk::Label("Last Rendered: ")),0,1,3,4,Gtk::SHRINK,Gtk::SHRINK);
399 hbox->pack_start(l_lasttime,Gtk::PACK_SHRINK,0);
401 attach(*hbox,0,1,3,4,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
402 //attach(l_lasttime,0,1,3,4,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
405 disp_sound.set_size_request(-1,32);
406 attach(disp_sound,0,1,4,5,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK);
410 //if(draw_area.get_window()) gc_area = Gdk::GC::create(draw_area.get_window());
414 studio::Widget_Preview::~Widget_Preview()
418 void studio::Widget_Preview::update()
420 //the meat goes in this locker...
421 double time = adj_time_scrub.get_value();
423 //find the frame and display it...
426 //synfig::warning("Updating at %.3f s",time);
428 //use time to find closest frame...
429 studio::Preview::FlipBook::const_iterator beg = preview->begin(),end = preview->end();
430 studio::Preview::FlipBook::const_iterator i;
434 //go to current hint if need be...
435 if(currentindex >= 0 && currentindex < (int)preview->numframes())
437 i = beg+currentindex;
440 //we can't have a picture if there are none to get
443 //don't bother with binary search it will just be slower...
445 //synfig::info("Search for time %f",time);
447 //incrementally go in either direction
448 //(bias downward towards beg, because that's what we want)
451 //synfig::info("Look at %f",i->t);
452 if(i->t > time) break;
453 //synfig::info("Go past...");
458 //bias down, so we can't be at end... and it still is valid...
462 //synfig::info("Look at %f",i->t);
463 if(i->t <= time) break;
464 //synfig::info("Go past...");
467 /*i = preview->begin(); end = preview->end();
471 for(;i != end; j = i++)
473 if(i->t > time) break;
476 //we should be at a valid edge since we biased downward
478 //don't get the closest, round down... (if we can)
481 synfig::error("i == end....");
489 currentindex = i-beg;
493 //synfig::warning("Update at: %f seconds (%f s)",time,timedisp);
495 //synfig::warning("success!");
501 if(disp_sound.get_profile() && adj_sound.get_value() != time)
505 //Set the position of the sound (short circuited for sound modifying the time)
507 disp_sound.set_position(time);
508 disp_sound.queue_draw();
511 void studio::Widget_Preview::preview_draw()
513 draw_area.queue_draw();//on_expose_event();
516 bool studio::Widget_Preview::redraw(GdkEventExpose *heh)
518 //And render the drawing area
519 Glib::RefPtr<Gdk::Pixbuf> pxnew, px = currentbuf;
521 if(!px || draw_area.get_height() == 0
522 || px->get_height() == 0 || px->get_width() == 0 /*|| is_visible()*/) //made not need this line
525 //figure out the scaling factors...
529 sx = draw_area.get_width() / (float)px->get_width();
530 sy = draw_area.get_height() / (float)px->get_height();
532 //synfig::info("widget_preview redraw: now to scale the bitmap: %.3f x %.3f",sx,sy);
534 //round to smallest scale (fit entire thing in window without distortion)
538 //scale to a new pixmap and then copy over to the window
539 nw = (int)(px->get_width()*sx);
540 nh = (int)(px->get_height()*sx);
542 if(nw == 0 || nh == 0)return true;
544 pxnew = px->scale_simple(nw,nh,Gdk::INTERP_NEAREST);
546 //synfig::info("Now to draw to the window...");
548 Glib::RefPtr<Gdk::Window> wind = draw_area.get_window();
549 Glib::RefPtr<Gdk::Drawable> surf = Glib::RefPtr<Gdk::Drawable>::cast_static(wind);
550 Glib::RefPtr<Gdk::GC> gc = Gdk::GC::create(wind);
553 Gdk::Rectangle r(0,0,draw_area.get_width(),draw_area.get_height());
554 draw_area.get_window()->begin_paint_rect(r);
557 if(!wind) synfig::warning("The destination window is broken...");
558 if(!surf) synfig::warning("The destination is not drawable...");
562 /* Options for drawing...
563 1) store with alpha, then clear and render with alpha every frame
564 - more time consuming
566 2) store with just pixel info
569 + better memory footprint
571 //px->composite(const Glib::RefPtr<Gdk::Pixbuf>& dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, InterpType interp_type, int overall_alpha) const
576 0, 0, // Source X and Y
577 0, 0, // Dest X and Y
578 -1,-1, // Width and Height
579 Gdk::RGB_DITHER_NONE, // RgbDither
580 0, 0 // Dither offset X and Y
585 Glib::RefPtr<Pango::Layout> layout(Pango::Layout::create(get_pango_context()));
586 Glib::ustring timecode(Time((double)timedisp).round(preview->get_global_fps())
587 .get_string(preview->get_global_fps(),
588 App::get_time_format()));
589 //synfig::info("Time for preview draw is: %s for time %g", timecode.c_str(), adj_time_scrub.get_value());
591 gc->set_rgb_fg_color(Gdk::Color("#FF0000"));
592 layout->set_text(timecode);
593 surf->draw_layout(gc,4,4,layout);
597 draw_area.get_window()->end_paint();
599 //synfig::warning("Refresh the draw area");
600 //make sure the widget refreshes
605 bool studio::Widget_Preview::play_update()
607 float diff = timer.pop_time();
608 //synfig::info("Play update: diff = %.2f",diff);
612 //we go to the next one...
613 double time = adj_time_scrub.get_value() + diff;
615 //adjust it to be synced with the audio if it can...
617 double newtime = audiotime;
618 if(audio && audio->is_playing()) audio->get_current_time(newtime);
620 if(newtime != audiotime)
622 //synfig::info("Adjusted time from %.3lf to %.3lf", time,newtime);
623 time = audiotime = newtime;
627 //Looping conditions...
628 if(time >= adj_time_scrub.get_upper())
632 time = adj_time_scrub.get_lower();// + time-adj_time_scrub.get_upper();
636 time = adj_time_scrub.get_upper();
637 adj_time_scrub.set_value(time);
641 //synfig::info("Play Stopped: time set to %f",adj_time_scrub.get_value());
646 //set the new time...
647 adj_time_scrub.set_value(time);
648 adj_time_scrub.value_changed();
650 //update the window to the correct image we might want to do this later...
652 //synfig::warning("Did update pu");
657 void studio::Widget_Preview::slider_move()
662 //synfig::warning("Did update sm");
666 //for other things updating the value changed signal...
667 void studio::Widget_Preview::scrub_updated(double t)
671 //Attempt at being more accurate... the time is adjusted to be exactly where the sound says it is
675 if(!audio->isPaused())
677 audio->get_current_time(t);
681 //synfig::info("Scrubbing to %.3f, setting adj to %.3f",oldt,t);
683 if(adj_time_scrub.get_value() != t)
685 adj_time_scrub.set_value(t);
686 adj_time_scrub.value_changed();
690 void studio::Widget_Preview::disconnect_preview(Preview *prev)
695 prevchanged.disconnect();
699 void studio::Widget_Preview::set_preview(handle<Preview> prev)
703 synfig::info("Setting preview");
705 //stop playing the mini animation...
710 //set the internal values
711 float rate = preview->get_fps();
712 synfig::info(" FPS = %f",rate);
715 float start = preview->get_begintime();
716 float end = preview->get_endtime();
720 adj_time_scrub.set_lower(start);
721 adj_time_scrub.set_upper(end);
722 adj_time_scrub.set_value(start);
723 adj_time_scrub.set_step_increment(rate);
724 adj_time_scrub.set_page_increment(10*rate);
726 //if the begin time and the end time are the same there is only a single frame
727 singleframe = end==start;
730 adj_time_scrub.set_lower(0);
731 adj_time_scrub.set_upper(0);
732 adj_time_scrub.set_value(0);
733 adj_time_scrub.set_step_increment(0);
734 adj_time_scrub.set_page_increment(0);
738 //connect so future information will be found...
739 prevchanged = prev->signal_changed().connect(sigc::mem_fun(*this,&Widget_Preview::whenupdated));
740 prev->signal_destroyed().connect(sigc::mem_fun(*this,&Widget_Preview::disconnect_preview));
742 //synfig::warning("Did update sp");
747 void studio::Widget_Preview::whenupdated()
749 l_lasttime.set_text((Time((double)(--preview->end())->t)
750 .round(preview->get_global_fps())
751 .get_string(preview->get_global_fps(),App::get_time_format())));
755 void studio::Widget_Preview::clear()
758 prevchanged.disconnect();
761 void studio::Widget_Preview::play()
763 if(preview && !playing)
765 //synfig::info("Playing at %lf",adj_time_scrub.get_value());
766 //audiotime = adj_time_scrub.get_value();
769 //adj_time_scrub.set_value(adj_time_scrub.get_lower());
770 update(); //we don't want to call play update because that will try to advance the timer
771 //synfig::warning("Did update p");
773 //approximate length of time in seconds, right?
774 double rate = /*std::min(*/adj_time_scrub.get_step_increment()/*,1/30.0)*/;
775 int timeout = (int)floor(1000*rate);
777 //synfig::info(" rate = %.3lfs = %d ms",rate,timeout);
779 signal_play_(adj_time_scrub.get_value());
782 if(audio) audio->play(adj_time_scrub.get_value());
784 timecon = Glib::signal_timeout().connect(sigc::mem_fun(*this,&Widget_Preview::play_update),timeout);
790 void studio::Widget_Preview::play_stop()
794 if(audio) audio->stop(); //!< stop the audio
795 //synfig::info("Stopping...");
798 void studio::Widget_Preview::stop()
800 //synfig::warning("stopping");
802 timecon.disconnect();
805 bool studio::Widget_Preview::scroll_move_event(GdkEvent *event)
809 case GDK_BUTTON_PRESS:
811 if(event->button.button == 1 || event->button.button == 3)
823 void studio::Widget_Preview::set_audioprofile(etl::handle<AudioProfile> p)
825 disp_sound.set_profile(p);
828 void studio::Widget_Preview::set_audio(etl::handle<AudioContainer> a)
832 //disconnect any previous signals
833 scrstartcon.disconnect(); scrstopcon.disconnect(); scrubcon.disconnect();
835 //connect the new signals
836 scrstartcon = disp_sound.signal_start_scrubbing().connect(sigc::mem_fun(*a,&AudioContainer::start_scrubbing));
837 scrstopcon = disp_sound.signal_stop_scrubbing().connect(sigc::mem_fun(*a,&AudioContainer::stop_scrubbing));
838 scrubcon = disp_sound.signal_scrub().connect(sigc::mem_fun(*a,&AudioContainer::scrub));
841 void studio::Widget_Preview::seek(float t)
844 adj_time_scrub.set_value(t);
847 void studio::Widget_Preview::repreview()
853 preview->get_canvasview()->preview_option();
857 void studio::Widget_Preview::stoprender()
861 preview->renderer.detach();
865 void studio::Widget_Preview::eraseall()