Replaces RenderingAsyncTask with RenderingHandler

cesquivias · cesquivias · commit e6cd56fca641 · 2016-12-22T15:52:17.000-08:00
AsyncTask prevents Espresso UI tests from proceeding. Using a Handler
is more natural way of handling tasks on Android.
diff --git a/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PDFView.java b/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PDFView.java
@@ -27,6 +27,7 @@
 import android.graphics.drawable.Drawable;
 import android.net.Uri;
 import android.os.AsyncTask;
+import android.os.HandlerThread;
 import android.util.AttributeSet;
 import android.util.Log;
 import android.widget.RelativeLayout;
@@ -51,7 +52,6 @@
 import com.shockwave.pdfium.PdfiumCore;
 
 import java.io.File;
-import java.io.IOException;
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.List;
@@ -190,9 +190,13 @@ enum ScrollDir {
     private DecodingAsyncTask decodingAsyncTask;
 
     /**
-     * Async task always playing in the background and proceeding rendering tasks
+     * The thread {@link #renderingHandler} will run on
      */
-    RenderingAsyncTask renderingAsyncTask;
+    private final HandlerThread renderingHandlerThread;
+    /**
+     * Handler always waiting in the background and rendering tasks
+     */
+    RenderingHandler renderingHandler;
 
     private PagesLoader pagesLoader;
 
@@ -268,6 +272,8 @@ ScrollHandle getScrollHandle() {
     public PDFView(Context context, AttributeSet set) {
         super(context, set);
 
+        renderingHandlerThread = new HandlerThread("PDF renderer");
+
         if (isInEditMode()) {
             return;
         }
@@ -445,8 +451,8 @@ public void recycle() {
         animationManager.stopAll();
 
         // Stop tasks
-        if (renderingAsyncTask != null) {
-            renderingAsyncTask.cancel(true);
+        if (renderingHandler != null) {
+            renderingHandler.removeMessages(RenderingHandler.MSG_RENDER_TASK);
         }
         if (decodingAsyncTask != null) {
             decodingAsyncTask.cancel(true);
@@ -649,7 +655,7 @@ public void loadPages() {
         }
 
         // Cancel all current tasks
-        renderingAsyncTask.removeAllTasks();
+        renderingHandler.removeMessages(RenderingHandler.MSG_RENDER_TASK);
         cacheManager.makeANewSet();
 
         pagesLoader.loadPages();
@@ -677,8 +683,10 @@ public void loadComplete(PdfDocument pdfDocument) {
 
         pagesLoader = new PagesLoader(this);
 
-        renderingAsyncTask = new RenderingAsyncTask(this, pdfiumCore, pdfDocument);
-        renderingAsyncTask.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
+        if (!renderingHandlerThread.isAlive()) {
+            renderingHandlerThread.start();
+        }
+        renderingHandler = new RenderingHandler(this, pdfiumCore, pdfDocument);
 
         if (scrollHandle != null) {
             scrollHandle.setupLayout(this);
diff --git a/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PagesLoader.java b/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PagesLoader.java
@@ -87,7 +87,7 @@ private Holder getPageAndCoordsByOffset(float offset) {
     private void loadThumbnail(int userPage, int documentPage) {
         if (!pdfView.cacheManager.containsThumbnail(userPage, documentPage,
                 thumbnailWidth, thumbnailHeight, thumbnailRect)) {
-            pdfView.renderingAsyncTask.addRenderingTask(userPage, documentPage,
+            pdfView.renderingHandler.addRenderingTask(userPage, documentPage,
                     thumbnailWidth, thumbnailHeight, thumbnailRect,
                     true, 0, pdfView.isBestQuality(), pdfView.isAnnotationRendering());
         }
@@ -218,7 +218,7 @@ private boolean loadCell(int userPage, int documentPage, int row, int col, float
 
         if (renderWidth > 0 && renderHeight > 0) {
             if (!pdfView.cacheManager.upPartIfContained(userPage, documentPage, renderWidth, renderHeight, pageRelativeBounds, cacheOrder)) {
-                pdfView.renderingAsyncTask.addRenderingTask(userPage, documentPage,
+                pdfView.renderingHandler.addRenderingTask(userPage, documentPage,
                         renderWidth, renderHeight, pageRelativeBounds, false, cacheOrder,
                         pdfView.isBestQuality(), pdfView.isAnnotationRendering());
             }
@@ -255,4 +255,4 @@ public void loadPages() {
             }
         }
     }
-}
+}
diff --git a/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/RenderingHandler.java b/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/RenderingHandler.java
@@ -19,95 +19,55 @@
 import android.graphics.Matrix;
 import android.graphics.Rect;
 import android.graphics.RectF;
-import android.os.AsyncTask;
+import android.os.Handler;
+import android.os.Message;
 
 import com.github.barteksc.pdfviewer.model.PagePart;
 import com.shockwave.pdfium.PdfDocument;
 import com.shockwave.pdfium.PdfiumCore;
 
-import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Set;
 
-class RenderingAsyncTask extends AsyncTask<Void, PagePart, Void> {
+/**
+ * A {@link Handler} that will process incoming {@link RenderingTask} messages
+ * and alert {@link PDFView#onBitmapRendered(PagePart)} when the portion of the
+ * PDF is ready to render.
+ */
+class RenderingHandler extends Handler {
+    /**
+     * {@link Message#what} kind of message this handler processes.
+     */
+    static final int MSG_RENDER_TASK = 1;
 
     private PdfiumCore pdfiumCore;
     private PdfDocument pdfDocument;
 
-    private final List<RenderingTask> renderingTasks;
     private PDFView pdfView;
 
     private RectF renderBounds = new RectF();
     private Rect roundedRenderBounds = new Rect();
     private Matrix renderMatrix = new Matrix();
     private final Set<Integer> openedPages = new HashSet<>();
 
-    public RenderingAsyncTask(PDFView pdfView, PdfiumCore pdfiumCore, PdfDocument pdfDocument) {
+    RenderingHandler(PDFView pdfView, PdfiumCore pdfiumCore, PdfDocument pdfDocument) {
         this.pdfView = pdfView;
         this.pdfiumCore = pdfiumCore;
         this.pdfDocument = pdfDocument;
-        this.renderingTasks = Collections.synchronizedList(new ArrayList<RenderingTask>());
-
     }
 
-    public void addRenderingTask(int userPage, int page, float width, float height, RectF bounds, boolean thumbnail, int cacheOrder, boolean bestQuality, boolean annotationRendering) {
+    void addRenderingTask(int userPage, int page, float width, float height, RectF bounds, boolean thumbnail, int cacheOrder, boolean bestQuality, boolean annotationRendering) {
         RenderingTask task = new RenderingTask(width, height, bounds, userPage, page, thumbnail, cacheOrder, bestQuality, annotationRendering);
-        renderingTasks.add(task);
-        wakeUp();
+        Message msg = obtainMessage(MSG_RENDER_TASK, task);
+        sendMessage(msg);
     }
 
     @Override
-    protected Void doInBackground(Void... params) {
-        while (!isCancelled()) {
-
-            // Proceed all tasks
-            while (true) {
-                RenderingTask task;
-                synchronized (renderingTasks) {
-                    if (!renderingTasks.isEmpty()) {
-                        task = renderingTasks.get(0);
-                    } else {
-                        break;
-                    }
-                }
-                //it is very rare case, but sometimes null can appear
-                if (task != null) {
-                    PagePart part = proceed(task);
-                    if (part == null) {
-                        break;
-                    } else if (renderingTasks.remove(task)) {
-                        publishProgress(part);
-                    } else {
-                        part.getRenderedBitmap().recycle();
-                    }
-                }
-            }
-
-            // Wait for new task, return if canceled
-            if (!waitForRenderingTasks() || isCancelled()) {
-                return null;
-            }
-
-        }
-        return null;
-
-    }
-
-    @Override
-    protected void onProgressUpdate(PagePart... part) {
-        pdfView.onBitmapRendered(part[0]);
-    }
-
-    private boolean waitForRenderingTasks() {
-        try {
-            synchronized (renderingTasks) {
-                renderingTasks.wait();
-            }
-            return true;
-        } catch (InterruptedException e) {
-            return false;
+    public void handleMessage(Message message) {
+        RenderingTask task = (RenderingTask) message.obj;
+        PagePart part = proceed(task);
+        if (part != null) {
+            pdfView.onBitmapRendered(part);
         }
     }
 
@@ -121,15 +81,9 @@ private PagePart proceed(RenderingTask renderingTask) {
         int h = Math.round(renderingTask.height);
         Bitmap render = Bitmap.createBitmap(w, h, Bitmap.Config.ARGB_8888);
         calculateBounds(w, h, renderingTask.bounds);
-
-        if (!isCancelled()) {
-            pdfiumCore.renderPageBitmap(pdfDocument, render, renderingTask.page,
-                    roundedRenderBounds.left, roundedRenderBounds.top,
-                    roundedRenderBounds.width(), roundedRenderBounds.height(), renderingTask.annotationRendering);
-        } else {
-            render.recycle();
-            return null;
-        }
+        pdfiumCore.renderPageBitmap(pdfDocument, render, renderingTask.page,
+                roundedRenderBounds.left, roundedRenderBounds.top,
+                roundedRenderBounds.width(), roundedRenderBounds.height(), renderingTask.annotationRendering);
 
         if (!renderingTask.bestQuality) {
             Bitmap cpy = render.copy(Bitmap.Config.RGB_565, false);
@@ -153,18 +107,6 @@ private void calculateBounds(int width, int height, RectF pageSliceBounds) {
         renderBounds.round(roundedRenderBounds);
     }
 
-    public void removeAllTasks() {
-        synchronized (renderingTasks) {
-            renderingTasks.clear();
-        }
-    }
-
-    public void wakeUp() {
-        synchronized (renderingTasks) {
-            renderingTasks.notify();
-        }
-    }
-
     private class RenderingTask {
 
         float width, height;
@@ -183,8 +125,7 @@ private class RenderingTask {
 
         boolean annotationRendering;
 
-        public RenderingTask(float width, float height, RectF bounds, int userPage, int page, boolean thumbnail, int cacheOrder, boolean bestQuality, boolean annotationRendering) {
-            super();
+        RenderingTask(float width, float height, RectF bounds, int userPage, int page, boolean thumbnail, int cacheOrder, boolean bestQuality, boolean annotationRendering) {
             this.page = page;
             this.width = width;
             this.height = height;
@@ -195,7 +136,5 @@ public RenderingTask(float width, float height, RectF bounds, int userPage, int
             this.bestQuality = bestQuality;
             this.annotationRendering = annotationRendering;
         }
-
     }
-
 }

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ private Holder getPageAndCoordsByOffset(float offset) {`
`87`	`87`	`private void loadThumbnail(int userPage, int documentPage) {`
`88`	`88`	`if (!pdfView.cacheManager.containsThumbnail(userPage, documentPage,`
`89`	`89`	`thumbnailWidth, thumbnailHeight, thumbnailRect)) {`
`90`		`- pdfView.renderingAsyncTask.addRenderingTask(userPage, documentPage,`
	`90`	`+ pdfView.renderingHandler.addRenderingTask(userPage, documentPage,`
`91`	`91`	`thumbnailWidth, thumbnailHeight, thumbnailRect,`
`92`	`92`	`true, 0, pdfView.isBestQuality(), pdfView.isAnnotationRendering());`
`93`	`93`	`}`
`@@ -218,7 +218,7 @@ private boolean loadCell(int userPage, int documentPage, int row, int col, float`
`218`	`218`
`219`	`219`	`if (renderWidth > 0 && renderHeight > 0) {`
`220`	`220`	`if (!pdfView.cacheManager.upPartIfContained(userPage, documentPage, renderWidth, renderHeight, pageRelativeBounds, cacheOrder)) {`
`221`		`- pdfView.renderingAsyncTask.addRenderingTask(userPage, documentPage,`
	`221`	`+ pdfView.renderingHandler.addRenderingTask(userPage, documentPage,`
`222`	`222`	`renderWidth, renderHeight, pageRelativeBounds, false, cacheOrder,`
`223`	`223`	`pdfView.isBestQuality(), pdfView.isAnnotationRendering());`
`224`	`224`	`}`
`@@ -255,4 +255,4 @@ public void loadPages() {`
`255`	`255`	`}`
`256`	`256`	`}`
`257`	`257`	`}`
`258`		`-}`
	`258`	`+}`