Changeset 120

Timestamp:

04/26/06 06:44:05 (2 years ago)

Author:

jordi

Message:

Added initial support for caching of page's pixmaps.

Location:

trunk

Files:

• src/IDocument.cxx (modified) (11 diffs)
• src/IDocument.h (modified) (7 diffs)
• src/MainPter.cxx (modified) (4 diffs)
• src/MainPter.h (modified) (1 diff)
• src/PDFDocument.cxx (modified) (5 diffs)
• src/PDFDocument.h (modified) (1 diff)
• tests/DumbDocument.cxx (modified) (2 diffs)
• tests/DumbDocument.h (modified) (1 diff)
• tests/MainPterTest.cxx (modified) (24 diffs)
• tests/PDFDocumentTest.cxx (modified) (1 diff)

trunk/src/IDocument.cxx

@@ -22 +22 @@
 
 // Constants.
-static const gdouble ZOOM_IN_FACTOR = 1.2F;
-static const gdouble ZOOM_IN_MAX = 4.0F;
-static const gdouble ZOOM_OUT_FACTOR = (1.0F / ZOOM_IN_FACTOR);
+static const gdouble ZOOM_IN_FACTOR = 1.2;
+static const gdouble ZOOM_IN_MAX = 4.0;
+static const gdouble ZOOM_OUT_FACTOR = (1.0 / ZOOM_IN_FACTOR);
 static const gdouble ZOOM_OUT_MAX = 0.05409;
+
+// This is the asynchronous queue for rendering.
+static guint currentCacheAge = 0;
+
+typedef struct
+{
+    guint32 age;
+    gint pageNum;
+    IDocument *document;
+    DocumentPage *page;
+    gboolean done;
+} PageRequest;
 
 /// This is the error domain that will be used to report Document's errors.
@@ -114 +126 @@
 
 ///
+/// @brief Renders the requested pages.
+///
+/// This is a working thread that waits until a request to render
+/// a page is make. Then it renders the requested page and waits
+/// for another.
+/// The IDocument class is responsable to make the requests.
+///
+gpointer
+IDocument::renderPageWorker (gpointer data)
+{
+    GAsyncQueue *renderQueue = (GAsyncQueue *)data;
+    gboolean exit = FALSE;
+    do
+    {
+        PageRequest *request = (PageRequest *)g_async_queue_pop (renderQueue);
+        if ( 0 < request->pageNum )
+        {
+            request->page = request->document->renderPage (request->pageNum);
+            request->done = TRUE;
+        }
+        else if ( -1 == request->pageNum )
+        {
+            delete request;
+            exit = TRUE;
+        }
+    }
+    while (!exit);
+
+    g_async_queue_unref (renderQueue);
+    renderQueue = NULL;
+    
+    return NULL;
+}
+
+///
 /// @brief Constructs a new IDocument object.
 ///
@@ -128 +175 @@
     m_Linearized = NULL;
     m_ModifiedDate = NULL;
+    m_PageCache = NULL;
     m_PageLayout = PageLayoutUnset;
     m_PageMode = PageModeUnset;
@@ -134 +182 @@
     m_Producer = NULL;
     m_Rotation = 0;
-    m_Scale = 0.0f;
+    m_Scale = 1.0f;
     m_Subject = NULL;
     m_Title = NULL;
+
+    if ( !g_thread_supported () )
+    {
+        g_thread_init (NULL);
+    }
+    m_RenderQueue = g_async_queue_new ();
+    g_async_queue_ref (m_RenderQueue);
+    g_thread_create (IDocument::renderPageWorker, (gpointer)m_RenderQueue, 
+                     FALSE, NULL);
 }
 
@@ -157 +214 @@
     g_free (m_Subject);
     g_free (m_Title);
+
+    // Create a page request with an invalid queue to let know the
+    // thread that we are done.
+    PageRequest *request = new PageRequest;
+    request->pageNum = -1;
+    g_async_queue_push (m_RenderQueue, (gpointer)request);
+    g_async_queue_unref (m_RenderQueue);
 }
 
@@ -598 +662 @@
 
 ///
+/// @brief Gets the document's current page image.
+///
+/// @return The rendered image of the current page.
+///
+DocumentPage *
+IDocument::getCurrentPage ()
+{
+    GList *cache = g_list_first (m_PageCache);
+    PageRequest *request = NULL;
+
+    while ( NULL != cache && NULL == request )
+    {
+        PageRequest *tmpRequest = (PageRequest *)cache->data;
+        if ( m_CurrentPage == tmpRequest->pageNum )
+        {
+            request = tmpRequest;
+        }
+        cache = g_list_next (cache);
+    }
+
+    if ( NULL == request )
+        return NULL;
+
+    while ( !request->done )
+    {
+    }
+
+    return request->page;
+}
+
+///
 /// @brief Get the document's current page number.
 ///
@@ -620 +715 @@
 {
     return m_Outline;
+}
+
+///
+/// @brief Gets the current page's unscaled size.
+///
+/// Retrieves the width and height of the current page before to scale, but
+/// after rotation.
+/// 
+/// @param width The output pointer to save the page's width.
+/// @param height The output pointer to save the page's height.
+///
+void
+IDocument::getPageSize (gdouble *width, gdouble *height)
+{
+    getPageSizeForPage (getCurrentPageNum (), width, height);
 }
 
@@ -671 +781 @@
 IDocument::goToPage (gint pageNum)
 {
-    if ( pageNum > getNumPages () )
-    {
-        pageNum = getNumPages ();
-    }
-    else if ( pageNum < 1 )
-    {
-        pageNum = 1;
-    }
-
-    m_CurrentPage = pageNum;
+    m_CurrentPage = CLAMP (pageNum, 1, getNumPages ());
+
+    if ( 1 < m_CurrentPage )
+    {
+        scheduleToRender (m_CurrentPage - 1);
+    }
+    scheduleToRender (m_CurrentPage);
+    if ( m_CurrentPage < getNumPages () )
+    {
+        scheduleToRender (m_CurrentPage);
+    }
 }
 
@@ -717 +828 @@
 {
     m_Rotation = (rotation % 360);
+    refreshCache ();
 }
 
@@ -788 +900 @@
 {
     m_Scale = zoom;
+    refreshCache ();
 }
 
@@ -864 +977 @@
     setZoom ((gdouble)width / pageWidth);
 }
+
+void
+IDocument::scheduleToRender (gint pageNum)
+{
+    PageRequest *request = NULL;
+    GList *cache = g_list_first (m_PageCache);
+
+    while ( NULL != cache && NULL == request)
+    {
+        PageRequest *tmpRequest = (PageRequest *)cache->data;
+        if ( pageNum == tmpRequest->pageNum )
+        {
+            request = tmpRequest;
+        }
+        cache = g_list_next (cache);
+    }
+
+    if ( NULL == request )
+    {
+        request = new PageRequest;
+        request->pageNum = pageNum;
+        request->page = NULL;
+        request->document = this;
+        request->done = FALSE;
+        request->age = currentCacheAge++;
+
+        g_async_queue_push (m_RenderQueue, (gpointer)request);
+
+        // Check which cached page to drop.
+        cache = g_list_first (m_PageCache);
+        PageRequest *olderRequest = NULL;
+        guint32 olderAge = G_MAXUINT32;
+        gint numCaches = 0;
+        while ( NULL != cache )
+        {
+            numCaches++;
+            PageRequest *tmpRequest = (PageRequest *)cache->data;
+            if ( tmpRequest->age < olderAge )
+            {
+                olderAge = tmpRequest->age;
+                olderRequest = tmpRequest;
+            }
+            cache = g_list_next (cache);
+        }
+
+        m_PageCache = g_list_append (m_PageCache, request);
+        if ( 3 <= numCaches )
+        {            
+            m_PageCache = g_list_remove (m_PageCache, olderRequest);
+            delete olderRequest->page;
+            delete olderRequest;
+        }
+    }
+    else
+    {
+        request->age = currentCacheAge++;
+    }
+}
+
+void
+IDocument::refreshCache ()
+{
+    GList *cache = g_list_first (m_PageCache);
+    while ( NULL != cache )
+    {
+        PageRequest *request = (PageRequest *)cache->data;
+ /*       while ( !request->done )
+        {
+        }*/
+        request->done = FALSE;
+        g_async_queue_push (m_RenderQueue, (gpointer)request);
+        cache = g_list_next (cache);
+    }
+}

trunk/src/IDocument.h

@@ -148 +148 @@
                                        GError **error) = 0;
             ///
-            /// @brief Gets the current page's unscaled size.
-            ///
-            /// Retrieves the width and height of the current page before
+            /// @brief Gets a document's page's unscaled size.
+            ///
+            /// Retrieves the width and height of a document's page before
             /// scaling, but after rotate it.
             ///
+            /// @param pageNum The page to get its size.
             /// @param width The location to save the page's width.
             /// @param height The location to save the page's height.
             ///
-            virtual void getPageSize (gdouble *width, gdouble *height) = 0;
-
-            ///
-            /// @brief Renders the current page.
-            ///
-            /// Rendering the current page means to get the pixels for the
-            /// current page image given the current rotation and scale level.
+            virtual void getPageSizeForPage (gint pageNum, gdouble *width, 
+                                             gdouble *height) = 0;
+
+            ///
+            /// @brief Renders a document's page.
+            ///
+            /// Rendering a document's page means to get the pixels for the
+            /// page image given the current rotation and scale level.
+            ///
+            /// @param pageNum The page number to render.
             ///
             /// @return A DocumentPage with the image. The returned page must
             ///         be freed by calling delete when done with it.
             ///
-            virtual DocumentPage *renderPage (void) = 0;
+            virtual DocumentPage *renderPage (gint pageNum) = 0;
 
             
@@ -198 +202 @@
             PageLayout getPageLayout (void);
             void setPageLayout (PageLayout layout);
+            void getPageSize (gdouble *width, gdouble *height);
             gint getNumPages (void);
             void setNumPages (gint numPages);
+            DocumentPage *getCurrentPage (void);
             gint getCurrentPageNum (void);
             DocumentOutline *getOutline (void);
@@ -225 +231 @@
             static GQuark getErrorQuark (void);
             static gchar *getErrorMessage (DocumentError errorCode);
+            static gpointer renderPageWorker (gpointer data); 
 
         protected:
@@ -230 +237 @@
             
             IDocument (void);
+            void scheduleToRender (gint pageNum);
+            void refreshCache (void);
 
             gchar *m_Author;
@@ -235 +244 @@
             gchar *m_Creator;
             gint m_CurrentPage;
-            DocumentOutline *m_Outline;
             gchar *m_Format;
             gchar *m_FileName;
@@ -241 +249 @@
             gchar *m_Linearized;
             gchar *m_ModifiedDate;
+            DocumentOutline *m_Outline;
+            GList *m_PageCache;
             PageLayout m_PageLayout;
             PageMode m_PageMode;
@@ -250 +260 @@
             gchar *m_Subject;
             gchar *m_Title;
+            GAsyncQueue *m_RenderQueue;
     };
 }

trunk/src/MainPter.cxx

@@ -28 +28 @@
 {
     m_Document = new PDFDocument ();
-    m_DocumentPage = NULL;
     m_View = NULL;
 }
@@ -44 +43 @@
 
     m_Document = document;
-    m_DocumentPage = NULL;
     m_View = NULL;
 }
@@ -55 +53 @@
     delete m_Document;
     delete m_View;
-    delete m_DocumentPage;
 }
 
@@ -662 +659 @@
     view.sensitiveZoomOut (m_Document->canZoomOut ());
     
-    DocumentPage *oldPage = m_DocumentPage;
-    m_DocumentPage = m_Document->renderPage ();
-    if ( NULL != m_DocumentPage )
-    {
-        getView ().showPage (m_DocumentPage, pageScroll);
-    }
-    delete oldPage;
-}
+    DocumentPage *documentPage = m_Document->getCurrentPage ();
+    if ( NULL != documentPage )
+    {
+        getView ().showPage (documentPage, pageScroll);
+    }
+}

trunk/src/MainPter.h

@@ -71 +71 @@
 
             IDocument *m_Document;
-            DocumentPage *m_DocumentPage;
             IMainView *m_View;
 

trunk/src/PDFDocument.cxx

@@ -279 +279 @@
 
 ///
-/// @brief Gets the current page's unscaled size.
-///
-/// Retrieves the width and height of the current page before to scale, but
+/// @brief Gets a document's page's unscaled size.
+///
+/// Retrieves the width and height of a document's page before to scale, but
 /// after rotation.
 /// 
+/// @param pageNum The page to get its size.
 /// @param width The output pointer to save the page's width.
 /// @param height The output pointer to save the page's height.
 ///
 void
-PDFDocument::getPageSize (gdouble *width, gdouble *height)
+PDFDocument::getPageSizeForPage (gint pageNum, gdouble *width, gdouble *height)
 {
     g_assert (NULL != m_Document && "Tried to get size of a NULL document.");
@@ -294 +295 @@
     g_assert (NULL != height && "Tried to save the page's height to NULL.");
 
-    PopplerPage *page = poppler_document_get_page (m_Document,
-                                                   getCurrentPageNum () - 1);
+    PopplerPage *page = poppler_document_get_page (m_Document, pageNum - 1);
 
     gdouble pageWidth;
@@ -316 +316 @@
 
 ///
-/// @brief Renders the current page.
-///
-/// Rendering the current page means to get the pixels for the current page,
+/// @brief Renders a document's page.
+///
+/// Rendering a document's page means to get the pixels for the page,
 /// given the current rotation level and scale.
+///
+/// @param pageNum The page to render.
 ///
 /// @return A DocumentPage with the image. The returned page must be freed
@@ -325 +327 @@
 ///
 DocumentPage *
-PDFDocument::renderPage ()
+PDFDocument::renderPage (gint pageNum)
 {
     // First create the document's page.
     gdouble pageWidth;
     gdouble pageHeight;
-    getPageSize (&pageWidth, &pageHeight);
+    getPageSizeForPage (pageNum, &pageWidth, &pageHeight);
     gint width = MAX((gint) ((pageWidth * getZoom ()) + 0.5), 1);
     gint height = MAX((gint) ((pageHeight * getZoom ()) + 0.5), 1);
@@ -344 +346 @@
                                                   renderedPage->getRowStride (),
                                                   NULL, NULL);
-    PopplerPage *page = poppler_document_get_page (m_Document, 
-                                                   getCurrentPageNum () - 1);
+    PopplerPage *page = poppler_document_get_page (m_Document, pageNum - 1);
     poppler_page_render_to_pixbuf (page, 0, 0, width, height, getZoom (),
                                    getRotation (), pixbuf);

trunk/src/PDFDocument.h

@@ -41 +41 @@
             gboolean loadFile (const gchar *filename, const gchar *password, 
                            GError **error);
-            void getPageSize (gdouble *width, gdouble *height);
-            DocumentPage *renderPage (void);
+            void getPageSizeForPage (gint pageNum, gdouble *width, 
+                                     gdouble *height);
+            DocumentPage *renderPage (gint pageNum);
 
         protected:

trunk/tests/DumbDocument.cxx

@@ -75 +75 @@
 
 void
-DumbDocument::getPageSize (gdouble *width, gdouble *height)
+DumbDocument::getPageSizeForPage (gint pageNum, gdouble *width, gdouble *height)
 {
     if ( 90 == getRotation () || 270 == getRotation () )
@@ -90 +90 @@
 
 DocumentPage *
-DumbDocument::renderPage ()
+DumbDocument::renderPage (gint pageNum)
 {
     return new DocumentPage ();

trunk/tests/DumbDocument.h

@@ -31 +31 @@
             gboolean loadFile (const gchar *filename, const gchar *password,
                                GError **error);
-            void getPageSize (gdouble *width, gdouble *height);
-            DocumentPage *renderPage (void);
+            void getPageSizeForPage (gint pageNum, gdouble *width, 
+                                     gdouble *height);
+            DocumentPage *renderPage (gint pageNum);
 
             // Test functions.

trunk/tests/MainPterTest.cxx

@@ -100 +100 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("/tmp/test.pdf", m_View->getTitle ()));
@@ -122 +122 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("Test PDF", m_View->getTitle ()));
@@ -153 +153 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("PDF Viewer", m_View->getTitle ()));
@@ -186 +186 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("PDF Viewer", m_View->getTitle ()));
@@ -221 +221 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("PDF Viewer", m_View->getTitle ()));
@@ -256 +256 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("PDF Viewer", m_View->getTitle ()));
@@ -291 +291 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT_EQUAL (0, 
             g_ascii_strcasecmp ("/tmp/test.pdf", m_View->getTitle ()));
@@ -324 +324 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT (NULL == m_View->getLastOpenFileFolder ());
 
@@ -331 +331 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT (0 == g_ascii_strcasecmp ("/tmp", 
                                              m_View->getLastOpenFileFolder ()));
@@ -337 +337 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT (0 == g_ascii_strcasecmp ("/usr", 
                                              m_View->getLastOpenFileFolder ()));
@@ -355 +355 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     // Check that sets the correct number of pages and the current page.
     CPPUNIT_ASSERT_EQUAL (4, m_View->getTotalPages ());
@@ -437 +437 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     // Check that sets the correct number of pages and the current page.
     CPPUNIT_ASSERT_EQUAL (4, m_View->getTotalPages ());
@@ -518 +518 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT (m_View->hasImagePageView ());
     CPPUNIT_ASSERT (!m_View->hasImagePageView ());
@@ -548 +548 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT (m_View->hasImagePageView ());
     CPPUNIT_ASSERT (!m_View->hasImagePageView ());
@@ -589 +589 @@
     m_MainPter->openFileActivated ();
     // Sleep to let the thread open the file.
-    sleep (1);
+    usleep (500);
     CPPUNIT_ASSERT (m_View->hasImagePageView ());