How artifexsoftware/mupdf-android-viewer-old works
Project type and purpose
• This is an Android mobile application (“MuPDF Android viewer”) for viewing PDF documents.
• It combines a native PDF rendering engine (MuPDF) with an Android-Java UI that displays pages, handles user interaction (pan/zoom/search/print), and orchestrates background work.
File structure
• Top-level build files:
– build.gradle, gradlew(.bat), gradle/… → Gradle-based Android build.
– AndroidManifest.xml → app entry points and permissions.
– Makefile, jni/Android.mk, Application.mk → NDK build scripts for native code.
• Native layer:
– jni/ → C glue (mupdf.c) and Android.mk include of core, third-party.
– libmupdf (submodule) provides the MuPDF engine sources.
• Java layer:
– src/com/artifex/mupdfdemo/ → Activities, Views, Adapters, AsyncTasks, JNI wrapper (MuPDFCore.java).
• UI resources:
– res/layout/, res/drawable-*/, res/values-*/ → layouts, styles, images, translations.
• Third-party & generated content:
– README describes “generated” directory for fonts/CMAPs, and thirdparty libs via git submodule.
README for additional insights
• The README emphasizes a two-stage build:
– 1) Native host build (‘make generate’) to produce “generated” assets (fonts/CMAPs).
– 2) Android viewer build (ndk-build, ant/Gradle).
• Dependencies: Android SDK/NDK, Java JDK, Ant (historical), Android Studio recommended.
Main components & their interactions
a. Android Application (Java layer)
– Activities (MuPDFActivity, OutlineActivity, ChoosePDFActivity, PrintDialogActivity)
– Views & Adapters (MuPDFView, PageAdapter, ReaderView, ReflowView)
– AsyncTasks (SearchTask, CancellableAsyncTask) for PDF parsing, text search.
– JNI wrapper (MuPDFCore.java) exposes native functions to load documents, render pages, extract metadata.
– Resource manager loads layouts, drawables, strings.
b. Native MuPDF Engine (C/C++ layer)
– Core parsing/rendering library (libmupdf)
– JNI bridge functions (jni/mupdf.c)
– “generated” assets: compressed fonts, CMAP tables
– Third-party dependencies (jbig2, fz, pdf modules)
c. Storage and I/O
– PDF files on device storage (via file picker or intent).
– SD card/emulator push for test PDFs.
d. Build System
– Gradle + Android Studio orchestrates Java compilation, resource packaging.
– ndk-build compiles native code into .so; Android.mk maps sources.
– git submodules for thirdparty.
– Optional Ant steps (historical).
Architectural patterns & design principles
• MVC/MVP-style separation: Activities/Adapters drive Views, delegate heavy work to AsyncTasks and native layer.
• JNI boundary isolates performance-critical rendering in native code, while UI runs on Dalvik/ART.
• Asynchronous background tasks prevent UI blocking on parsing or search.
• Modular subcomponents (ChoosePDF, Outline, Print) each handled by separate Activities and layouts.