1 #include "ev-pixbuf-cache.h"
2 #include "ev-job-queue.h"
3 #include "ev-page-cache.h"
4 #include "ev-selection.h"
6 typedef struct _CacheJobInfo
13 /* Selection info. If the *_points structs are unset, we put -1 in x1.
14 * selection_points are the coordinates encapsulated in selection.
15 * new_points is the target selection size. */
16 EvRectangle selection_points;
18 EvRectangle new_points;
29 /* preload_cache_size is the number of pages prior to the current
30 * visible area that we cache. It's normally 1, but could be 2 in the
33 int preload_cache_size;
34 CacheJobInfo *prev_job;
35 CacheJobInfo *job_list;
36 CacheJobInfo *next_job;
39 struct _EvPixbufCacheClass
41 GObjectClass parent_class;
43 void (* job_finished) (EvPixbufCache *pixbuf_cache);
53 static guint signals[N_SIGNALS] = {0, };
55 static void ev_pixbuf_cache_init (EvPixbufCache *pixbuf_cache);
56 static void ev_pixbuf_cache_class_init (EvPixbufCacheClass *pixbuf_cache);
57 static void ev_pixbuf_cache_finalize (GObject *object);
58 static void ev_pixbuf_cache_dispose (GObject *object);
59 static void job_finished_cb (EvJob *job,
60 EvPixbufCache *pixbuf_cache);
61 static CacheJobInfo *find_job_cache (EvPixbufCache *pixbuf_cache,
63 static void copy_job_to_job_info (EvJobRender *job_render,
64 CacheJobInfo *job_info,
65 EvPixbufCache *pixbuf_cache);
66 static gboolean new_selection_pixbuf_needed(EvPixbufCache *pixbuf_cache,
67 CacheJobInfo *job_info,
72 /* These are used for iterating through the prev and next arrays */
73 #define FIRST_VISABLE_PREV(pixbuf_cache) \
74 (MAX (0, pixbuf_cache->preload_cache_size + 1 - pixbuf_cache->start_page))
75 #define VISIBLE_NEXT_LEN(pixbuf_cache, page_cache) \
76 (MIN(pixbuf_cache->preload_cache_size, ev_page_cache_get_n_pages (page_cache) - (1 + pixbuf_cache->end_page)))
77 #define PAGE_CACHE_LEN(pixbuf_cache) \
78 ((pixbuf_cache->end_page - pixbuf_cache->start_page) + 1)
80 G_DEFINE_TYPE (EvPixbufCache, ev_pixbuf_cache, G_TYPE_OBJECT)
83 ev_pixbuf_cache_init (EvPixbufCache *pixbuf_cache)
85 pixbuf_cache->start_page = 0;
86 pixbuf_cache->end_page = 0;
87 pixbuf_cache->job_list = g_new0 (CacheJobInfo, PAGE_CACHE_LEN (pixbuf_cache));
89 pixbuf_cache->preload_cache_size = 2;
90 pixbuf_cache->prev_job = g_new0 (CacheJobInfo, pixbuf_cache->preload_cache_size);
91 pixbuf_cache->next_job = g_new0 (CacheJobInfo, pixbuf_cache->preload_cache_size);
95 ev_pixbuf_cache_class_init (EvPixbufCacheClass *class)
97 GObjectClass *object_class;
99 object_class = G_OBJECT_CLASS (class);
101 object_class->finalize = ev_pixbuf_cache_finalize;
102 object_class->dispose = ev_pixbuf_cache_dispose;
104 signals[JOB_FINISHED] = g_signal_new ("job-finished",
105 G_OBJECT_CLASS_TYPE (object_class),
106 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
107 G_STRUCT_OFFSET (EvPixbufCacheClass, job_finished),
109 g_cclosure_marshal_VOID__VOID,
114 ev_pixbuf_cache_finalize (GObject *object)
116 EvPixbufCache *pixbuf_cache;
118 pixbuf_cache = EV_PIXBUF_CACHE (object);
120 g_free (pixbuf_cache->prev_job);
121 g_free (pixbuf_cache->job_list);
122 g_free (pixbuf_cache->next_job);
126 dispose_cache_job_info (CacheJobInfo *job_info,
129 if (job_info == NULL)
132 g_signal_handlers_disconnect_by_func (job_info->job,
133 G_CALLBACK (job_finished_cb),
135 ev_job_queue_remove_job (job_info->job);
136 g_object_unref (G_OBJECT (job_info->job));
137 job_info->job = NULL;
139 if (job_info->pixbuf) {
140 g_object_unref (G_OBJECT (job_info->pixbuf));
141 job_info->pixbuf = NULL;
143 if (job_info->link_mapping) {
144 ev_link_mapping_free (job_info->link_mapping);
145 job_info->link_mapping = NULL;
147 if (job_info->selection) {
148 g_object_unref (G_OBJECT (job_info->selection));
149 job_info->selection = NULL;
152 job_info->selection_points.x1 = -1;
153 job_info->new_points.x1 = -1;
157 ev_pixbuf_cache_dispose (GObject *object)
159 EvPixbufCache *pixbuf_cache;
162 pixbuf_cache = EV_PIXBUF_CACHE (object);
164 for (i = 0; i < pixbuf_cache->preload_cache_size; i++) {
165 dispose_cache_job_info (pixbuf_cache->prev_job + i, pixbuf_cache);
166 dispose_cache_job_info (pixbuf_cache->next_job + i, pixbuf_cache);
169 for (i = 0; i < PAGE_CACHE_LEN (pixbuf_cache); i++) {
170 dispose_cache_job_info (pixbuf_cache->job_list + i, pixbuf_cache);
176 ev_pixbuf_cache_new (EvDocument *document)
178 EvPixbufCache *pixbuf_cache;
180 pixbuf_cache = (EvPixbufCache *) g_object_new (EV_TYPE_PIXBUF_CACHE, NULL);
181 pixbuf_cache->document = document;
187 job_finished_cb (EvJob *job,
188 EvPixbufCache *pixbuf_cache)
190 CacheJobInfo *job_info;
191 EvJobRender *job_render = EV_JOB_RENDER (job);
194 /* If the job is outside of our interest, we silently discard it */
195 if ((job_render->rc->page < (pixbuf_cache->start_page - pixbuf_cache->preload_cache_size)) ||
196 (job_render->rc->page > (pixbuf_cache->end_page + pixbuf_cache->preload_cache_size))) {
197 g_object_unref (job);
201 job_info = find_job_cache (pixbuf_cache, job_render->rc->page);
203 pixbuf = g_object_ref (job_render->pixbuf);
204 if (job_info->pixbuf)
205 g_object_unref (job_info->pixbuf);
206 job_info->pixbuf = pixbuf;
208 if (job_render->link_mapping) {
209 if (job_info->link_mapping)
210 ev_link_mapping_free (job_info->link_mapping);
211 job_info->link_mapping = job_render->link_mapping;
213 if (job_render->include_selection) {
214 if (job_info->selection)
215 g_object_unref (job_info->selection);
216 job_info->selection_points = job_render->selection_points;
217 job_info->selection = job_render->selection;
218 g_assert (job_info->selection_points.x1 >= 0);
221 if (job_info->job == job)
222 job_info->job = NULL;
223 g_object_unref (job);
225 g_signal_emit (pixbuf_cache, signals[JOB_FINISHED], 0);
228 /* This checks a job to see if the job would generate the right sized pixbuf
229 * given a scale. If it won't, it removes the job and clears it to NULL.
232 check_job_size_and_unref (CacheJobInfo *job_info,
233 EvPageCache *page_cache,
241 if (job_info->job == NULL)
244 ev_page_cache_get_size (page_cache,
245 EV_JOB_RENDER (job_info->job)->rc->page,
249 if (width == EV_JOB_RENDER (job_info->job)->target_width &&
250 height == EV_JOB_RENDER (job_info->job)->target_height)
253 /* Try to remove the job. If we can't, then the thread has already
254 * picked it up and we are going get a signal when it's done. If we
255 * can, then the job is fully dead and will never rnu.. */
256 if (ev_job_queue_remove_job (job_info->job))
257 g_object_unref (job_info->job);
259 job_info->job = NULL;
262 /* Do all function that copies a job from an older cache to it's position in the
263 * new cache. It clears the old job if it doesn't have a place.
266 move_one_job (CacheJobInfo *job_info,
267 EvPixbufCache *pixbuf_cache,
269 CacheJobInfo *new_job_list,
270 CacheJobInfo *new_prev_job,
271 CacheJobInfo *new_next_job,
274 EvJobPriority priority)
276 CacheJobInfo *target_page = NULL;
278 EvJobPriority new_priority;
280 if (page < (start_page - pixbuf_cache->preload_cache_size) ||
281 page > (end_page + pixbuf_cache->preload_cache_size)) {
282 dispose_cache_job_info (job_info, pixbuf_cache);
286 /* find the target page to copy it over to. */
287 if (page < start_page) {
288 page_offset = (page - (start_page - pixbuf_cache->preload_cache_size));
290 g_assert (page_offset >= 0 &&
291 page_offset < pixbuf_cache->preload_cache_size);
292 target_page = new_prev_job + page_offset;
293 new_priority = EV_JOB_PRIORITY_LOW;
294 } else if (page > end_page) {
295 page_offset = (page - (end_page + 1));
297 g_assert (page_offset >= 0 &&
298 page_offset < pixbuf_cache->preload_cache_size);
299 target_page = new_next_job + page_offset;
300 new_priority = EV_JOB_PRIORITY_LOW;
302 page_offset = page - start_page;
303 g_assert (page_offset >= 0 &&
304 page_offset <= ((end_page - start_page) + 1));
305 new_priority = EV_JOB_PRIORITY_HIGH;
306 target_page = new_job_list + page_offset;
309 *target_page = *job_info;
310 job_info->job = NULL;
311 job_info->pixbuf = NULL;
312 job_info->link_mapping = NULL;
314 if (new_priority != priority && target_page->job) {
315 ev_job_queue_update_job (target_page->job, new_priority);
322 ev_pixbuf_cache_update_range (EvPixbufCache *pixbuf_cache,
326 CacheJobInfo *new_job_list;
327 CacheJobInfo *new_prev_job;
328 CacheJobInfo *new_next_job;
329 EvPageCache *page_cache;
332 if (pixbuf_cache->start_page == start_page &&
333 pixbuf_cache->end_page == end_page)
336 page_cache = ev_page_cache_get (pixbuf_cache->document);
338 new_job_list = g_new0 (CacheJobInfo, (end_page - start_page) + 1);
339 new_prev_job = g_new0 (CacheJobInfo, pixbuf_cache->preload_cache_size);
340 new_next_job = g_new0 (CacheJobInfo, pixbuf_cache->preload_cache_size);
342 /* We go through each job in the old cache and either clear it or move
343 * it to a new location. */
345 /* Start with the prev cache. */
346 page = pixbuf_cache->start_page - pixbuf_cache->preload_cache_size;
347 for (i = 0; i < pixbuf_cache->preload_cache_size; i++) {
349 dispose_cache_job_info (pixbuf_cache->prev_job + i, pixbuf_cache);
351 move_one_job (pixbuf_cache->prev_job + i,
353 new_job_list, new_prev_job, new_next_job,
354 start_page, end_page, EV_JOB_PRIORITY_LOW);
359 page = pixbuf_cache->start_page;
360 for (i = 0; i < PAGE_CACHE_LEN (pixbuf_cache); i++) {
361 move_one_job (pixbuf_cache->job_list + i,
363 new_job_list, new_prev_job, new_next_job,
364 start_page, end_page, EV_JOB_PRIORITY_HIGH);
368 for (i = 0; i < pixbuf_cache->preload_cache_size; i++) {
369 if (page >= ev_page_cache_get_n_pages (page_cache)) {
370 dispose_cache_job_info (pixbuf_cache->next_job + i, pixbuf_cache);
372 move_one_job (pixbuf_cache->next_job + i,
374 new_job_list, new_prev_job, new_next_job,
375 start_page, end_page, EV_JOB_PRIORITY_LOW);
380 g_free (pixbuf_cache->job_list);
381 g_free (pixbuf_cache->prev_job);
382 g_free (pixbuf_cache->next_job);
384 pixbuf_cache->job_list = new_job_list;
385 pixbuf_cache->prev_job = new_prev_job;
386 pixbuf_cache->next_job = new_next_job;
388 pixbuf_cache->start_page = start_page;
389 pixbuf_cache->end_page = end_page;
393 copy_job_to_job_info (EvJobRender *job_render,
394 CacheJobInfo *job_info,
395 EvPixbufCache *pixbuf_cache)
399 pixbuf = g_object_ref (job_render->pixbuf);
401 dispose_cache_job_info (job_info, pixbuf_cache);
403 job_info->pixbuf = pixbuf;
404 if (job_render->link_mapping)
405 job_info->link_mapping = job_render->link_mapping;
408 static CacheJobInfo *
409 find_job_cache (EvPixbufCache *pixbuf_cache,
414 if (page < (pixbuf_cache->start_page - pixbuf_cache->preload_cache_size) ||
415 page > (pixbuf_cache->end_page + pixbuf_cache->preload_cache_size))
418 if (page < pixbuf_cache->start_page) {
419 page_offset = (page - (pixbuf_cache->start_page - pixbuf_cache->preload_cache_size));
421 g_assert (page_offset >= 0 &&
422 page_offset < pixbuf_cache->preload_cache_size);
423 return pixbuf_cache->prev_job + page_offset;
426 if (page > pixbuf_cache->end_page) {
427 page_offset = (page - (pixbuf_cache->end_page + 1));
429 g_assert (page_offset >= 0 &&
430 page_offset < pixbuf_cache->preload_cache_size);
431 return pixbuf_cache->next_job + page_offset;
434 page_offset = page - pixbuf_cache->start_page;
435 g_assert (page_offset >= 0 &&
436 page_offset <= PAGE_CACHE_LEN(pixbuf_cache));
437 return pixbuf_cache->job_list + page_offset;
441 ev_pixbuf_cache_clear_job_sizes (EvPixbufCache *pixbuf_cache,
444 EvPageCache *page_cache;
447 page_cache = ev_page_cache_get (pixbuf_cache->document);
449 for (i = 0; i < PAGE_CACHE_LEN (pixbuf_cache); i++) {
450 check_job_size_and_unref (pixbuf_cache->job_list + i, page_cache, scale);
453 for (i = 0; i < pixbuf_cache->preload_cache_size; i++) {
454 check_job_size_and_unref (pixbuf_cache->prev_job + i, page_cache, scale);
455 check_job_size_and_unref (pixbuf_cache->next_job + i, page_cache, scale);
459 #define FIRST_VISABLE_PREV(pixbuf_cache) \
460 (MAX (0, pixbuf_cache->preload_cache_size + 1 - pixbuf_cache->start_page))
463 add_job_if_needed (EvPixbufCache *pixbuf_cache,
464 CacheJobInfo *job_info,
465 EvPageCache *page_cache,
468 EvJobPriority priority)
470 gboolean include_links = FALSE;
471 gboolean include_selection = FALSE;
477 ev_page_cache_get_size (page_cache,
481 if (job_info->pixbuf &&
482 gdk_pixbuf_get_width (job_info->pixbuf) == width &&
483 gdk_pixbuf_get_height (job_info->pixbuf) == height)
486 /* make a new job now */
487 if (job_info->rc == NULL) {
488 job_info->rc = ev_render_context_new (EV_ORIENTATION_PORTRAIT,
491 ev_render_context_set_page (job_info->rc, page);
492 ev_render_context_set_scale (job_info->rc, scale);
495 /* Figure out what else we need for this job */
496 if (job_info->link_mapping == NULL)
497 include_links = TRUE;
498 if (new_selection_pixbuf_needed (pixbuf_cache, job_info, page, scale)) {
499 include_selection = TRUE;
502 job_info->job = ev_job_render_new (pixbuf_cache->document,
505 &(job_info->new_points),
508 ev_job_queue_add_job (job_info->job, priority);
509 g_signal_connect (job_info->job, "finished", G_CALLBACK (job_finished_cb), pixbuf_cache);
514 ev_pixbuf_cache_add_jobs_if_needed (EvPixbufCache *pixbuf_cache,
517 EvPageCache *page_cache;
518 CacheJobInfo *job_info;
522 page_cache = ev_page_cache_get (pixbuf_cache->document);
524 for (i = 0; i < PAGE_CACHE_LEN (pixbuf_cache); i++) {
525 job_info = (pixbuf_cache->job_list + i);
526 page = pixbuf_cache->start_page + i;
528 add_job_if_needed (pixbuf_cache, job_info,
529 page_cache, page, scale,
530 EV_JOB_PRIORITY_HIGH);
533 for (i = FIRST_VISABLE_PREV(pixbuf_cache); i < pixbuf_cache->preload_cache_size; i++) {
534 job_info = (pixbuf_cache->prev_job + i);
535 page = pixbuf_cache->start_page - pixbuf_cache->preload_cache_size + i;
537 add_job_if_needed (pixbuf_cache, job_info,
538 page_cache, page, scale,
539 EV_JOB_PRIORITY_LOW);
542 for (i = 0; i < VISIBLE_NEXT_LEN(pixbuf_cache, page_cache); i++) {
543 job_info = (pixbuf_cache->next_job + i);
544 page = pixbuf_cache->end_page + 1 + i;
546 add_job_if_needed (pixbuf_cache, job_info,
547 page_cache, page, scale,
548 EV_JOB_PRIORITY_LOW);
554 ev_pixbuf_cache_set_page_range (EvPixbufCache *pixbuf_cache,
558 GList *selection_list)
560 EvPageCache *page_cache;
562 g_return_if_fail (EV_IS_PIXBUF_CACHE (pixbuf_cache));
564 page_cache = ev_page_cache_get (pixbuf_cache->document);
566 g_return_if_fail (start_page >= 0 && start_page < ev_page_cache_get_n_pages (page_cache));
567 g_return_if_fail (end_page >= 0 && end_page < ev_page_cache_get_n_pages (page_cache));
568 g_return_if_fail (end_page >= start_page);
570 /* First, resize the page_range as needed. We cull old pages
572 ev_pixbuf_cache_update_range (pixbuf_cache, start_page, end_page);
574 /* Then, we update the current jobs to see if any of them are the wrong
575 * size, we remove them if we need to. */
576 ev_pixbuf_cache_clear_job_sizes (pixbuf_cache, scale);
578 /* Next, we update the target selection for our pages */
579 ev_pixbuf_cache_set_selection_list (pixbuf_cache, selection_list);
581 /* Finally, we add the new jobs for all the sizes that don't have a
583 ev_pixbuf_cache_add_jobs_if_needed (pixbuf_cache, scale);
587 ev_pixbuf_cache_get_pixbuf (EvPixbufCache *pixbuf_cache,
590 CacheJobInfo *job_info;
592 job_info = find_job_cache (pixbuf_cache, page);
593 if (job_info == NULL)
596 /* We don't need to wait for the idle to handle the callback */
598 EV_JOB (job_info->job)->finished) {
599 copy_job_to_job_info (EV_JOB_RENDER (job_info->job), job_info, pixbuf_cache);
602 return job_info->pixbuf;
606 ev_pixbuf_cache_get_link_mapping (EvPixbufCache *pixbuf_cache,
609 CacheJobInfo *job_info;
611 job_info = find_job_cache (pixbuf_cache, page);
612 if (job_info == NULL)
615 /* We don't need to wait for the idle to handle the callback */
617 EV_JOB (job_info->job)->finished) {
618 copy_job_to_job_info (EV_JOB_RENDER (job_info->job), job_info, pixbuf_cache);
621 return job_info->link_mapping;
626 new_selection_pixbuf_needed (EvPixbufCache *pixbuf_cache,
627 CacheJobInfo *job_info,
631 EvPageCache *page_cache;
634 if (job_info->selection) {
635 page_cache = ev_page_cache_get (pixbuf_cache->document);
636 ev_page_cache_get_size (page_cache, page, scale,
639 if (width != gdk_pixbuf_get_width (job_info->selection) ||
640 height != gdk_pixbuf_get_height (job_info->selection))
643 if (job_info->new_points.x1 >= 0)
650 clear_selection_if_needed (EvPixbufCache *pixbuf_cache,
651 CacheJobInfo *job_info,
655 if (new_selection_pixbuf_needed (pixbuf_cache, job_info, page, scale)) {
656 if (job_info->selection)
657 g_object_unref (job_info->selection);
658 job_info->selection = NULL;
659 job_info->selection_points.x1 = -1;
664 ev_pixbuf_cach_get_text_mapping (EvPixbufCache *pixbuf_cache,
671 ev_pixbuf_cache_get_selection_pixbuf (EvPixbufCache *pixbuf_cache,
675 CacheJobInfo *job_info;
677 job_info = find_job_cache (pixbuf_cache, page);
678 if (job_info == NULL)
681 /* No selection on this page */
682 if (job_info->new_points.x1 < 0)
685 /* If we have a running job, we just return what we have under the
686 * assumption that it'll be updated later and we can scale it as need
688 if (job_info->job && EV_JOB_RENDER (job_info->job)->include_selection)
689 return job_info->selection;
691 /* Now, lets see if we need to resize the image. If we do, we clear the
693 clear_selection_if_needed (pixbuf_cache, job_info, page, scale);
695 /* Finally, we see if the two scales are the same, and get a new pixbuf
696 * if needed. We do this synchronously for now. At some point, we
697 * _should_ be able to get rid of the doc_mutex, so the synchronicity
698 * doesn't kill us. Rendering a few glyphs should really be fast.
700 if (ev_rect_cmp (&(job_info->new_points), &(job_info->selection_points))) {
703 rc = ev_render_context_new (EV_ORIENTATION_PORTRAIT,
707 /* we need to get a new selection pixbuf */
708 ev_document_doc_mutex_lock ();
709 if (job_info->selection_points.x1 < 0) {
710 g_assert (job_info->selection == NULL);
711 ev_selection_render_selection (EV_SELECTION (pixbuf_cache->document),
712 rc, &(job_info->selection),
713 &(job_info->new_points),
716 g_assert (job_info->selection != NULL);
717 ev_selection_render_selection (EV_SELECTION (pixbuf_cache->document),
718 rc, &(job_info->selection),
719 &(job_info->new_points),
720 &(job_info->selection_points));
722 job_info->selection_points = job_info->new_points;
723 ev_document_doc_mutex_unlock ();
726 return job_info->selection;
731 update_job_selection (CacheJobInfo *job_info,
732 EvViewSelection *selection)
734 if (job_info->selection == NULL)
735 job_info->selection_points.x1 = -1;
736 job_info->new_points = selection->rect;
740 clear_job_selection (CacheJobInfo *job_info)
742 job_info->selection_points.x1 = -1;
743 job_info->new_points.x1 = -1;
745 if (job_info->selection) {
746 g_object_unref (job_info->selection);
747 job_info->selection = NULL;
751 /* This function will reset the selection on pages that no longer have them, and
752 * will update the target_selection on those that need it.
755 ev_pixbuf_cache_set_selection_list (EvPixbufCache *pixbuf_cache,
756 GList *selection_list)
758 EvPageCache *page_cache;
759 EvViewSelection *selection;
760 GList *list = selection_list;
764 g_return_if_fail (EV_IS_PIXBUF_CACHE (pixbuf_cache));
766 page_cache = ev_page_cache_get (pixbuf_cache->document);
768 /* We check each area to see what needs updating, and what needs freeing; */
769 page = pixbuf_cache->start_page - pixbuf_cache->preload_cache_size;
770 for (i = 0; i < pixbuf_cache->preload_cache_size; i++) {
778 if (((EvViewSelection *)list->data)->page == page) {
779 selection = list->data;
781 } else if (((EvViewSelection *)list->data)->page > page)
787 update_job_selection (pixbuf_cache->prev_job + i, selection);
789 clear_job_selection (pixbuf_cache->prev_job + i);
793 page = pixbuf_cache->start_page;
794 for (i = 0; i < PAGE_CACHE_LEN (pixbuf_cache); i++) {
797 if (((EvViewSelection *)list->data)->page == page) {
798 selection = list->data;
800 } else if (((EvViewSelection *)list->data)->page > page)
806 update_job_selection (pixbuf_cache->job_list + i, selection);
808 clear_job_selection (pixbuf_cache->job_list + i);
812 for (i = 0; i < pixbuf_cache->preload_cache_size; i++) {
813 if (page >= ev_page_cache_get_n_pages (page_cache))
818 if (((EvViewSelection *)list->data)->page == page) {
819 selection = list->data;
821 } else if (((EvViewSelection *)list->data)->page > page)
827 update_job_selection (pixbuf_cache->next_job + i, selection);
829 clear_job_selection (pixbuf_cache->next_job + i);