images::ImagesRenderer Class Reference

#include <images_renderer.h>

Collaboration diagram for images::ImagesRenderer:

[legend]

Public Member Functions
	ImagesRenderer (ImagesDocument *document)
	~ImagesRenderer (void)
ImageRenderStatus	render (const std::string &anchor, const ImagePageAttrs &attrs, int ref_id, void *user_data)
void	notify_page_ready (ImagePage *page, int ref_id, ImageRenderStatus status, void *user_data)
ImagePage *	get_page (const std::string &anchor, const ImagePageAttrs &attrs)
void	add_page (ImagePage *page)
ImageRenderStatus	can_render (const std::string &anchor, const ImagePageAttrs &attrs)
bool	set_memory_limit (const int bytes)
void	stop (void)
Data Fields
utils::Signal< ImagePage *, const unsigned int, ImageRenderStatus, void * >	sig_page_ready

---

Detailed Description

Definition at line 51 of file images_renderer.h.

---

Constructor & Destructor Documentation

images::ImagesRenderer::ImagesRenderer

(

ImagesDocument *

document

)

Definition at line 39 of file images_renderer.cpp.

References LOGPRINTF, and common::Thread::start().

: doc(document)
, render_thread()
, pages_cache()
, last_render_page(0)    
{
    LOGPRINTF("%p", document);

    render_thread.start();
    
    //  Pre-render policy
    set_prerender_policy(2, 2);
}

Here is the call graph for this function:

images::ImagesRenderer::~ImagesRenderer

(

void

)

Definition at line 53 of file images_renderer.cpp.

References LOGPRINTF, and common::Thread::stop().

{
    LOGPRINTF("entry");

    render_thread.stop();
    // pages_cache.clear();
}

Here is the call graph for this function:

---

Member Function Documentation

void images::ImagesRenderer::add_page

(

ImagePage *

page

)

Definition at line 136 of file images_renderer.cpp.

References images::PagesCache::add_page(), and LOGPRINTF.

Referenced by images::ImageRenderTask::execute().

{
    LOGPRINTF("%p", page);
    
    if (page)
    {
        pages_cache.add_page(page);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ImageRenderStatus images::ImagesRenderer::can_render	(	const std::string &	anchor,
		const ImagePageAttrs &	attrs
	)

Definition at line 148 of file images_renderer.cpp.

References images::ImagePage::estimate_length(), images::IMG_RENDER_FAIL, images::IMG_RENDER_INVALID, images::IMG_RENDER_OK, images::IMG_RENDER_OOM, LOGPRINTF, images::PagesCache::make_enough_memory(), images::MAX_ORIGINAL_IMAGE, images::ImagePageAttrs::original_height, images::ImagePageAttrs::original_width, and WARNPRINTF.

Referenced by images::ImageRenderTask::execute(), and render().

{
    bool is_valid_image = false;
    if ((attrs.original_width > 0) && (attrs.original_height > 0))
    {
        is_valid_image = true;
    }        

    // Check whether the image is valid or not.
    if (!is_valid_image)
    {
        WARNPRINTF("Invalid image page %s.", anchor.c_str());            
        return IMG_RENDER_INVALID;
    }

    // Check for maximum image size.
    // The temporary memory used by gdk_pixbuf_load_at_scale() during rendering
    // cannot be estimated correctly but it depends partly on the image size.
    // To prevent memory overflows we accept images up to a maximum size only.
    if (attrs.original_width * attrs.original_height > MAX_ORIGINAL_IMAGE)
    {
        WARNPRINTF("Image too big: w [%d] h [%d] max [%d]", attrs.original_width, attrs.original_height, MAX_ORIGINAL_IMAGE);
        return IMG_RENDER_FAIL;
    }

    // Check whether there is enough memory to render.
    gint64 size = ImagePage::estimate_length(attrs);
    if (!pages_cache.make_enough_memory(size))
    {
        LOGPRINTF("Not enough memory to render page [%s]", anchor.c_str());
        return IMG_RENDER_OOM;
    }
    
    return IMG_RENDER_OK;
    
}

Here is the call graph for this function:

Here is the caller graph for this function:

ImagePage * images::ImagesRenderer::get_page	(	const std::string &	anchor,
		const ImagePageAttrs &	attrs
	)

Definition at line 117 of file images_renderer.cpp.

References images::ImagePage::calc_key(), images::ImagePageAttrs::desired_height, images::ImagePageAttrs::desired_width, images::PagesCache::get_page(), LOGPRINTF, images::ImagePageAttrs::rotation, and images::ImagePageAttrs::zoom.

Referenced by images::ImageRenderTask::execute(), and render().

{
    LOGPRINTF("%s zoom[%f] rotation[%d]", 
              anchor.c_str(), attrs.zoom, attrs.rotation);

    size_t key = ImagePage::calc_key(anchor, 
                                     attrs.desired_width, 
                                     attrs.desired_height,
                                     attrs.zoom,
                                     attrs.rotation);
    
    ImagePage * page = pages_cache.get_page(key);
   
    LOGPRINTF("return %p", page);

    return page;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void images::ImagesRenderer::notify_page_ready	(	ImagePage *	page,
		int	ref_id,
		ImageRenderStatus	status,
		void *	user_data
	)

Definition at line 280 of file images_renderer.cpp.

References utils::Signal< A1, A2, A3, A4, A5 >::broadcast(), images::PagesCache::lock(), LOGPRINTF, sig_page_ready, images::PagesCache::unlock(), and images::ImagePage::update_timestamp().

Referenced by images::ImageRenderTask::execute(), and render().

{
    LOGPRINTF("%p %d", page, ref_id);

    pages_cache.lock();

    if (page)
    {
        page->update_timestamp();
    }
    
    if (ref_id != -1)
    {
        sig_page_ready.broadcast(page, ref_id, status, user_data);
    }

    pages_cache.unlock();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ImageRenderStatus images::ImagesRenderer::render	(	const std::string &	anchor,
		const ImagePageAttrs &	attrs,
		int	ref_id,
		void *	user_data
	)

Definition at line 61 of file images_renderer.cpp.

References can_render(), common::Thread::clear_all(), get_page(), images::ImagesDocument::get_position(), images::IMG_RENDER_OK, LOGPRINTF, notify_page_ready(), common::Thread::prepend_task(), images::ImagePageAttrs::rotation, WARNPRINTF, and images::ImagePageAttrs::zoom.

Referenced by main().

{
    LOGPRINTF("%s, zoom[%f], rotation[%d], ref_id[%d]",
              anchor.c_str(), attrs.zoom, attrs.rotation, ref_id);
    
    // Return code.
    ImageRenderStatus ret = IMG_RENDER_OK;
    
    // Clear the old tasks.
    render_thread.clear_all();

    ImageRenderTask * task = 0;
    
    // Get the render result from 'pages cache'
    ImagePage * page = get_page(anchor, attrs);
    if (!page)
    {
        ret = can_render(anchor, attrs);
        if (ret == IMG_RENDER_OK)
        {
            // Prepend 'render task' to 'render_thread'
            task = new ImageRenderTask(anchor, attrs, ref_id, this, user_data);
            // Notes, The flag 'true' means aborting the current task.
            // But for images, the implementation of the task 
            // doesn't support aborting feature.
            render_thread.prepend_task(task, true);
        }
        else
        {
            // Notify renderer this page is not ready because of what. e.g OOM.
            notify_page_ready(0, ref_id, ret, user_data);
        }
    }
    else
    {
        WARNPRINTF("Page %s already in pages_cache!", anchor.c_str());

        // This requested page is already in 'pages_cache'.
        // Notify page is ready now.
        notify_page_ready(page, ref_id, IMG_RENDER_OK, user_data);
    }

    // Do pre_rendering.
    assert(doc);
    int page_num = doc->get_position(anchor);

    bool page_down = (last_render_page <= page_num) ? true : false;
    last_render_page = page_num;
    pre_render(page_num, attrs, page_down);
    
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool images::ImagesRenderer::set_memory_limit

(

const int

bytes

)

Definition at line 310 of file images_renderer.cpp.

References LOGPRINTF, and images::PagesCache::set_memory_limit().

{
    LOGPRINTF("entry");

    return pages_cache.set_memory_limit(bytes);
}

Here is the call graph for this function:

void images::ImagesRenderer::stop

(

void

)

Definition at line 317 of file images_renderer.cpp.

References common::Thread::stop().

Referenced by images::PluginViewImpl::stop_renderer().

{
    render_thread.stop();    
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

utils::Signal<ImagePage *, const unsigned int, ImageRenderStatus, void *> images::ImagesRenderer::sig_page_ready

Definition at line 94 of file images_renderer.h.

Referenced by notify_page_ready(), and images::PluginViewImpl::PluginViewImpl().

---

The documentation for this class was generated from the following files:

• images_renderer.h
• images_renderer.cpp