/* === S Y N F I G ========================================================= */
/*! \file target_scanline.cpp
** \brief Template File
**
** $Id$
**
** \legal
** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
** Copyright (c) 2008 Chris Moore
** Copyright (c) 2012-2013 Carlos López
**
** This package is free software; you can redistribute it and/or
** modify it under the terms of the GNU General Public License as
** published by the Free Software Foundation; either version 2 of
** the License, or (at your option) any later version.
**
** This package is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** General Public License for more details.
** \endlegal
*/
/* ========================================================================= */
/* === H E A D E R S ======================================================= */
#ifdef USING_PCH
# include "pch.h"
#else
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include "target_scanline.h"
#include "general.h"
#include <synfig/localization.h>
#include "canvas.h"
#include "context.h"
#include "render.h"
#include "string.h"
#include "surface.h"
#include "rendering/renderer.h"
#include "rendering/surface.h"
#include "rendering/software/surfacesw.h"
#include "rendering/common/task/tasktransformation.h"
#endif
/* === U S I N G =========================================================== */
using namespace std;
using namespace etl;
using namespace synfig;
using namespace rendering;
/* === M A C R O S ========================================================= */
#define PIXEL_RENDERING_LIMIT 1500000
#define USE_PIXELRENDERING_LIMIT 1
/* === G L O B A L S ======================================================= */
/* === P R O C E D U R E S ================================================= */
/* === M E T H O D S ======================================================= */
Target_Scanline::Target_Scanline():
threads_(2)
{
curr_frame_=0;
if (const char *s = getenv("SYNFIG_TARGET_DEFAULT_ENGINE"))
set_engine(s);
}
int
Target_Scanline::next_frame(Time& time)
{
return Target::next_frame(time);
}
bool
synfig::Target_Scanline::call_renderer(
const etl::handle<rendering::SurfaceResource> &surface,
Canvas &canvas,
const ContextParams &context_params,
const RendDesc &renddesc )
{
surface->create(renddesc.get_w(), renddesc.get_h());
rendering::Task::Handle task = canvas.build_rendering_task(context_params);
if (task)
{
rendering::Renderer::Handle renderer = rendering::Renderer::get_renderer(get_engine());
if (!renderer)
throw "Renderer '" + get_engine() + "' not found";
Vector p0 = renddesc.get_tl();
Vector p1 = renddesc.get_br();
if (p0[0] > p1[0] || p0[1] > p1[1]) {
Matrix m;
if (p0[0] > p1[0]) { m.m00 = -1.0; m.m20 = p0[0] + p1[0]; std::swap(p0[0], p1[0]); }
if (p0[1] > p1[1]) { m.m11 = -1.0; m.m21 = p0[1] + p1[1]; std::swap(p0[1], p1[1]); }
TaskTransformationAffine::Handle t = new TaskTransformationAffine();
t->transformation->matrix = m;
t->sub_task() = task;
task = t;
}
task->target_surface = surface;
task->target_rect = RectInt( VectorInt(), surface->get_size() );
task->source_rect = Rect(p0, p1);
rendering::Task::List list;
list.push_back(task);
renderer->run(list);
}
return true;
}
bool
synfig::Target_Scanline::render(ProgressCallback *cb)
{
SuperCallback super_cb;
int
frames=0,
total_frames,
frame_start,
frame_end;
Time
t=0;
assert(canvas);
curr_frame_=0;
if( !init() ){
if(cb) cb->error(_("Target initialization failure"));
return false;
}
frame_start=desc.get_frame_start();
frame_end=desc.get_frame_end();
ContextParams context_params(desc.get_render_excluded_contexts());
// Calculate the number of frames
total_frames=frame_end-frame_start+1;
if(total_frames<=0)total_frames=1;
try {
//synfig::info("1time_set_to %s",t.get_string().c_str());
if(total_frames>=1)
{
do{
// Grab the time
frames=next_frame(t);
// If we have a callback, and it returns
// false, go ahead and bail. (it may be a user cancel)
if(cb && !cb->amount_complete(total_frames-frames,total_frames))
return false;
// Set the time that we wish to render
if(!get_avoid_time_sync() || canvas->get_time()!=t) {
canvas->set_time(t);
canvas->load_resources(t);
}
canvas->set_outline_grow(desc.get_outline_grow());
// If quality is set otherwise, then we use the accelerated renderer
{
#if USE_PIXELRENDERING_LIMIT
if(desc.get_w()*desc.get_h() > PIXEL_RENDERING_LIMIT)
{
SurfaceResource::Handle surface = new SurfaceResource();
int rowheight = PIXEL_RENDERING_LIMIT/desc.get_w();
if (!rowheight) rowheight = 1; // TODO: render partial lines to stay within the limit?
int rows = desc.get_h()/rowheight;
int lastrowheight = desc.get_h() - rows*rowheight;
rows++;
synfig::info("Render split to %d block%s %d pixels tall, and a final block %d pixels tall",
rows-1, rows==2?"":"s", rowheight, lastrowheight);
// loop through all the full rows
if(!start_frame())
{
throw(string("add_frame(): target panic on start_frame()"));
return false;
}
for(int i=0; i < rows; ++i)
{
surface->reset();
RendDesc blockrd = desc;
//render the strip at the normal size unless it's the last one...
if(i == rows-1)
{
if(!lastrowheight) break;
blockrd.set_subwindow(0,i*rowheight,desc.get_w(),lastrowheight);
}
else
{
blockrd.set_subwindow(0,i*rowheight,desc.get_w(),rowheight);
}
//synfig::info( " -- block %d/%d left, top, width, height: %d, %d, %d, %d",
// i+1, rows, 0, i*rowheight, blockrd.get_w(), blockrd.get_h() );
if (!call_renderer(surface, *canvas, context_params, blockrd))
{
if(cb)cb->error(_("Accelerated Renderer Failure"));
return false;
} else {
SurfaceResource::LockRead<SurfaceSW> lock(surface);
if (!lock) {
if(cb)cb->error(_("Accelerated Renderer Failure: cannot read surface"));
return false;
}
const synfig::Surface &s = lock->get_surface();
int y;
int rowspan=sizeof(Color)*s.get_w();
Surface::const_pen pen = s.begin();
int yoff = i*rowheight;
for(y = 0; y < blockrd.get_h(); y++, pen.inc_y())
{
Color *colordata= start_scanline(y + yoff);
if(!colordata)
{
throw(string("add_frame(): call to start_scanline(y) returned NULL"));
return false;
}
switch(get_alpha_mode())
{
case TARGET_ALPHA_MODE_FILL:
for(int i = 0; i < s.get_w(); i++)
colordata[i] = Color::blend(s[y][i], desc.get_bg_color(), 1.0f);
break;
case TARGET_ALPHA_MODE_EXTRACT:
for(int i = 0; i < s.get_w(); i++)
{
float a=s[y][i].get_a();
colordata[i] = Color(a,a,a,a);
}
break;
case TARGET_ALPHA_MODE_REDUCE:
for(int i = 0; i < s.get_w(); i++)
colordata[i] = Color(s[y][i].get_r(), s[y][i].get_g(), s[y][i].get_b(), 1.f);
break;
case TARGET_ALPHA_MODE_KEEP:
memcpy(colordata, s[y], rowspan);
break;
}
if(!end_scanline())
{
throw(string("add_frame(): target panic on end_scanline()"));
return false;
}
}
}
}
surface->reset();
end_frame();
}else //use normal rendering...
{
#endif
SurfaceResource::Handle surface = new SurfaceResource();
if (!call_renderer(surface, *canvas, context_params, desc))
{
// For some reason, the accelerated renderer failed.
if(cb)cb->error(_("Accelerated Renderer Failure"));
return false;
}
SurfaceResource::LockRead<SurfaceSW> lock(surface);
if(!lock)
{
if(cb)cb->error(_("Bad surface"));
return false;
}
// Put the surface we renderer
// onto the target.
if(!add_frame(&lock->get_surface()))
{
if(cb)cb->error(_("Unable to put surface on target"));
return false;
}
#if USE_PIXELRENDERING_LIMIT
}
#endif
}
}while(frames);
}
else
{
// Set the time that we wish to render
if(!get_avoid_time_sync() || canvas->get_time()!=t) {
canvas->set_time(t);
canvas->load_resources(t);
}
canvas->set_outline_grow(desc.get_outline_grow());
// If quality is set otherwise, then we use the accelerated renderer
{
#if USE_PIXELRENDERING_LIMIT
if(desc.get_w()*desc.get_h() > PIXEL_RENDERING_LIMIT)
{
SurfaceResource::Handle surface(new SurfaceResource());
int totalheight = desc.get_h();
int rowheight = PIXEL_RENDERING_LIMIT/desc.get_w();
if (!rowheight) rowheight = 1; // TODO: render partial lines to stay within the limit?
int rows = desc.get_h()/rowheight;
int lastrowheight = desc.get_h() - rows*rowheight;
rows++;
synfig::info("Render split to %d block%s %d pixels tall, and a final block %d pixels tall",
rows-1, rows==2?"":"s", rowheight, lastrowheight);
// loop through all the full rows
if(!start_frame())
{
throw(string("add_frame(): target panic on start_frame()"));
return false;
}
for(int i=0; i < rows; ++i)
{
surface->reset();
RendDesc blockrd = desc;
//render the strip at the normal size unless it's the last one...
if(i == rows-1)
{
if(!lastrowheight) break;
blockrd.set_subwindow(0,i*rowheight,desc.get_w(),lastrowheight);
}
else
{
blockrd.set_subwindow(0,i*rowheight,desc.get_w(),rowheight);
}
//synfig::info( " -- block %d/%d left, top, width, height: %d, %d, %d, %d",
// i+1, rows, 0, i*rowheight, blockrd.get_w(), blockrd.get_h() );
if (!call_renderer(surface, *canvas, context_params, blockrd))
{
if(cb)cb->error(_("Accelerated Renderer Failure"));
return false;
}
SurfaceResource::LockRead<SurfaceSW> lock(surface);
if(!lock)
{
if(cb)cb->error(_("Bad surface"));
return false;
}
const synfig::Surface &s = lock->get_surface();
int y;
int rowspan=sizeof(Color)*s.get_w();
Surface::const_pen pen = s.begin();
int yoff = i*rowheight;
for(y = 0; y < blockrd.get_h(); y++, pen.inc_y())
{
Color *colordata= start_scanline(y + yoff);
if(!colordata)
{
throw(string("add_frame(): call to start_scanline(y) returned NULL"));
return false;
}
switch(get_alpha_mode())
{
case TARGET_ALPHA_MODE_FILL:
for(int i = 0; i < s.get_w(); i++)
colordata[i] = Color::blend(s[y][i], desc.get_bg_color(), 1.0f);
break;
case TARGET_ALPHA_MODE_EXTRACT:
for(int i = 0; i < s.get_w(); i++)
{
float a=s[y][i].get_a();
colordata[i] = Color(a,a,a,a);
}
break;
case TARGET_ALPHA_MODE_REDUCE:
for(int i = 0; i < s.get_w(); i++)
colordata[i] = Color(s[y][i].get_r(), s[y][i].get_g(), s[y][i].get_b(), 1.0f);
break;
case TARGET_ALPHA_MODE_KEEP:
memcpy(colordata,s[y], rowspan);
break;
}
if(!end_scanline())
{
throw(string("add_frame(): target panic on end_scanline()"));
return false;
}
}
//I'm done with this part
if (cb) cb->amount_complete((i+1)*rowheight, totalheight);
}
surface->reset();
end_frame();
}else
{
#endif
SurfaceResource::Handle surface = new SurfaceResource();
if (!call_renderer(surface, *canvas, context_params, desc))
{
if(cb)cb->error(_("Accelerated Renderer Failure"));
return false;
}
SurfaceResource::LockRead<SurfaceSW> lock(surface);
if(!lock)
{
if(cb)cb->error(_("Bad surface"));
return false;
}
// Put the surface we renderer
// onto the target.
if(!add_frame(&lock->get_surface()))
{
if(cb)cb->error(_("Unable to put surface on target"));
return false;
}
#if USE_PIXELRENDERING_LIMIT
}
#endif
}
}
}
catch(const String& str)
{
if (cb) cb->error(_("Caught string: ")+str);
return false;
}
catch (std::bad_alloc&)
{
if (cb) cb->error(_("Ran out of memory (Probably a bug)"));
return false;
}
catch (...)
{
if(cb)cb->error(_("Caught unknown error, rethrowing..."));
throw;
}
return true;
}
bool
Target_Scanline::add_frame(const Surface *surface)
{
assert(surface);
int y;
int rowspan=sizeof(Color)*surface->get_w();
Surface::const_pen pen=surface->begin();
if(!start_frame())
{
throw(string("add_frame(): target panic on start_frame()"));
return false;
}
for(y=0;y<surface->get_h();y++,pen.inc_y())
{
Color *colordata= start_scanline(y);
if(!colordata)
{
throw(string("add_frame(): call to start_scanline(y) returned NULL"));
return false;
}
switch(get_alpha_mode())
{
case TARGET_ALPHA_MODE_FILL:
for(int i=0;i<surface->get_w();i++)
colordata[i]=Color::blend((*surface)[y][i],desc.get_bg_color(),1.0f);
break;
case TARGET_ALPHA_MODE_EXTRACT:
for(int i=0;i<surface->get_w();i++)
{
float a=(*surface)[y][i].get_a();
colordata[i] = Color(a,a,a,a);
}
break;
case TARGET_ALPHA_MODE_REDUCE:
for(int i = 0; i < surface->get_w(); i++)
colordata[i] = Color((*surface)[y][i].get_r(),(*surface)[y][i].get_g(),(*surface)[y][i].get_b(),1.0f);
break;
case TARGET_ALPHA_MODE_KEEP:
memcpy(colordata,(*surface)[y],rowspan);
break;
}
if(!end_scanline())
{
throw(string("add_frame(): target panic on end_scanline()"));
return false;
}
}
end_frame();
return true;
}