MuPDFCore is a set of multiplatform .NET bindings for MuPDF. It can render PDF, XPS, EPUB and other formats to raster images returned either as raw bytes, or as image files in multiple formats (including PNG, JPEG, and PSD). It also supports multithreading.
It also includes MuPDFCore.MuPDFRenderer, an Avalonia control to display documents compatible with MuPDFCore in Avalonia windows (with multithreaded rendering).
The library is released under the AGPLv3 licence.
The MuPDFCore library targets .NET Standard 2.0, thus it can be used in projects that target .NET Standard 2.0+, .NET Core 2.0+, .NET 5.0+, .NET Framework 4.6.1 (note) and possibly others. MuPDFCore includes a pre-compiled native library, which currently supports the following platforms:
- Windows x86 (32 bit)
win-x86
- Windows x64 (64 bit)
win-x64
- Windows arm64 (ARM 64 bit)
win-arm64
- Linux x64 (64 bit)
- glibc-based
linux-x64
- musl-based
linux-musl-x64
- glibc-based
- Linux arm64/aarch64 (ARM 64 bit)
- glibc-based
linux-arm64
- musl-based
linux-musl-arm64
(see note)
- glibc-based
- macOS Intel x86_64 (64 bit)
osx-x64
- macOS Apple silicon (ARM 64 bit)
osx-arm64
To use the library in your project, you should install the MuPDFCore NuGet package and/or the MuPDFCore.PDFRenderer NuGet package. When you publish a program that uses MuPDFCore, the correct native library for the target architecture will automatically be copied to the build folder (but see the note for .NET Framework).
Note: you should make sure that end users on Windows install the Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019 and 2022 for their platform, otherwise they will get an error message stating that MuPDFWrapper.dll
could not be loaded because a module was not found.
Note for musl
-based Linux arm64: I could not find a way to ensure that the linux-musl-arm64 native artifact overwrites the linux-arm64 (glibc
) artifact. As a result, when you publish a project that uses MuPDFCore targeting linux-musl-arm64, you will find two native assets in the build directory (MuPDFWrapper.so
, which is the musl
artifact, and libMuPDFWrapper.so
, which is the glibc
artifact). Everything will work fine out of the box (because the name of the musl
artifact has higher priority), but you may want to delete libMuPDFWrapper.so
in order to reduce size. You can use e.g. a post-build target to do this.
You can find detailed descriptions of how to use MuPDFCore and some code examples in the MuPDFCore wiki. Interactive documentation for the library API can be accessed from the documentation website. A PDF reference manual is also available.
The following example shows the bare minimum code necessary to render a page of a PDF document to a PNG image using MuPDFCore:
//Initialise the MuPDF context. This is needed to open or create documents.
using MuPDFContext ctx = new MuPDFContext();
//Open a PDF document
using MuPDFDocument document = new MuPDFDocument(ctx, "path/to/document.pdf");
//Page index (page 0 is the first page of the document)
int pageIndex = 0;
//Zoom level, converting document units into pixels. For a PDF document, a 1x zoom level corresponds to a
//72dpi resolution.
double zoomLevel = 1;
//Save the first page as a PNG image with transparency, at a 1x zoom level (1pt = 1px).
document.SaveImage(pageIndex, zoomLevel, PixelFormats.RGBA, "path/to/output.png", RasterOutputFileTypes.PNG);
Look at the wiki for more information.
The Demo folder in the repository contains some examples of how the library can be used to extract pages from a PDF or XPS document, render them to a raster image, or combine them in a new document
The PDFViewerDemo folder contains a complete (though minimal) example of a PDF viewer program built around the MuPDFCore.MuPDFRenderer.PDFRenderer
control.
Note that these examples intentionally avoid any error handling code: in a production setting, you should typically make sure that calls to MuPDFCore library functions are within a try...catch
block to handle any resulting MuPDFException
s.
Building the MuPDFCore library from source requires the following steps:
- Building the
libmupdf
native library - Building the
MuPDFWrapper
native library - Creating the
MuPDFCore.NativeAssets.xxx-yyy
native assets NuGet packages - Creating the
MuPDFCore
library NuGet package
Starting from MuPDFCore 1.8.0, the native assets are split into their own NuGet packages, on which the main MuPDFCore package depends. Aside from reducing the size of individual packages, this means that if you are making changes that do not affect the native assets, you can skip steps 1-3 and go straight to step 4.
Steps 1 and 2 need to be performed on all of Windows, macOS and Linux, and on the various possible architectures (x86, x64 and arm64 for Windows, x64/Intel and arm64/Apple for macOS, and x64 and arm64 for Linux, both glibc and musl - no cross-compiling)! Otherwise, some native assets will be missing and it will not be possible to build the NuGet packages in step 3.
You can download the open-source (GNU AGPL) MuPDF source code from here. You will need to uncompress the source file and compile the library on Windows, macOS and Linux. You need the following files:
-
From Windows (x86, x64, arm64):
- libmupdf.lib
-
From macOS (Intel - x64, Apple silicon - arm64):
- libmupdf.a
- libmupdf-third.a
-
From Linux (x64, arm64):
- libmupdf.a
- libmupdf-third.a
Note that the files from macOS and Linux are different, despite sharing the same name.
For convenience, these compiled files for MuPDF 1.24.0 are included in the native/MuPDFWrapper/lib
folder of this repository.
Tips for compiling MuPDF 1.24.3
-
On all platforms:
- Delete or comment line 316 in
source/fitz/output.c
(thefz_throw
invocation within thebuffer_seek
method - this should leave thebuffer_seek
method empty). This line throws an exception when a seek operation on a buffer is attempted. The problem is that this makes it impossible to render a document as a PSD image in memory, because thefz_write_pixmap_as_psd
method performs a few seek operations. By removing this line, we turn buffer seeks into no-ops; this doesn't seem to have catastrophic side-effects and the PSD documents produced in this way appear to be fine.
- Delete or comment line 316 in
-
On Windows (x64):
- Open the
platform/win32/mupdf.sln
solution in Visual Studio 2022. You should get a prompt to retarget your projects. Accept the default settings (latest Windows SDK and v143 of the tools). - Select the
ReleaseExtra
configuration andx64
architecture. Select every project in the solution exceptjavaviewer
andjavaviewerlib
and right-click to open the project properties. Go toC/C++
>Code Generation
and set theRuntime Library
toMulti-threaded DLL (/MD)
. - Open the properties for the
libpkcs7
project, go toC/C++
>Preprocessor
and removeHAVE_LIBCRYPTO
from thePreprocessor Definitions
. Then go toLibrarian
>General
and removelibcrypto.lib
from theAdditional Dependencies
. Now, go toCustom Build Step
and clear theCommand Line
and theOutput
. - Save everything (
CTRL+SHIFT+S
) and close Visual Studio. - Download the
win64-binary
release of libarchive - I used version 3.7.4. Extract the zip file and copy thelibarchive
folder to thethirdparty
folder in the MuPDF source tree.- Open the
thirdparty\libarchive\include
folder and create a new subfolder calledlibarchive
. Move thearchive.h
andarchive_entry.h
fromthirdparty\libarchive\include
tothirdparty\libarchive\include\libarchive
. - Open the
thirdparty\libarchive\lib
folder and create a new subfolder calledx64
. Move thearchive.lib
andarchive_static.lib
files fromthirdparty\libarchive\lib
tothirdparty\libarchive\lib\x64
.
- Open the
- Download the bzip2 library (I used version 1.0.8) and extract the source code.
- Open the
x64 Native Tools Command Prompt for VS
, move to the bzip2 source code folder, and run the following commands:
cl -Zi -EHsc -c bzlib.c blocksort.c compress.c crctable.c decompress.c huffman.c randtable.c lib bzlib.obj blocksort.obj compress.obj crctable.obj decompress.obj huffman.obj randtable.obj
- This will create some files, including one called
bzlib.lib
. Copy this file into thethirdparty\libarchive\lib\x64
folder, renaming it tolibbz2-static.lib
.
- Open the
- Download the XZ Utils (I used v5.6.2) and extract the source code.
- Open the
x64 Native Tools Command Prompt for VS
, move to thewindows
subfolder of the XZ Utils source code folder, and run the following commands:
cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_NLS=OFF -DBUILD_SHARED_LIBS=OFF .. msbuild xz.sln /p:Configuration=Release
- Now go to the
Release
folder and copyliblzma.lib
to thethirdparty\libarchive\lib\x64
in the MuPDF source tree.
- Open the
- Download the Zstandard source code (I used v1.5.6) and extract it. Note that the precompiled version will not work because it was not compiled against the MSVCRT.
- Open the
zstd.sln
file located in thebuild\VS2010
folder in Visual Studio. You should get a prompt prompt to retarget your projects. Accept the default settings (latest Windows SDK and v143 of the tools). - Save everything (
CTRL+SHIFT+S
) and close Visual Studio. - Open the
x64 Native Tools Command Prompt for VS
, move to the folder with the solution file, and build it withmsbuild zstd.sln /p:Configuration=Release
. - Copy the
libzstd_static.lib
file from thebin\x64_Release
folder to thethirdparty\libarchive\lib\x64
folder in the MuPDF source tree.
- Open the
- Now, open the
x64 Native Tools Command Prompt for VS
, move to the folder with the solution file, and build it usingmsbuild mupdf.sln
- Then, build again using
msbuild mupdf.sln /p:Configuration=Release
. - Finally, build again using
msbuild mupdf.sln /p:Configuration=ReleaseExtra
. - This may still show some errors, but should produce the
libmupdf.lib
file that is required in thex64/ReleaseExtra
folder (the file should be ~524MB in size).
- Open the
-
On Windows (x86):
- You will have to use Visual Studio 2019, as Visual Studio 2022 is not supported on x86 platforms.
- Open the
platform/win32/mupdf.sln
solution in Visual Studio and select theReleaseExtra
configuration andWin32
architecture. Select every project in the solution exceptjavaviewer
andjavaviewerlib
and right-click to open the project properties. Go toC/C++
>Code Generation
and set theRuntime Library
toMulti-threaded DLL (/MD)
. - Open the properties for the
libpkcs7
project, go toC/C++
>Preprocessor
and removeHAVE_LIBCRYPTO
from thePreprocessor Definitions
. Then go toLibrarian
>General
and removelibcrypto.lib
from theAdditional Dependencies
. Now, go toCustom compilation instructions
and clear theCommand line
and theOutput
. - Save everything (
CTRL+SHIFT+S
) and close Visual Studio. - Download the source code release of libarchive (I used version 3.7.4) and extract it.
- Open the
x86 Native Tools Command Prompt for VS
, move to the source code folder, and run the following commands:
cmake . msbuild libarchive/archive_static.vcxproj /p:Configuration=Release /p:Platform="Win32"
- This will create a file called
archive_static.lib
in thelibarchive/Release
folder. - Now, go to the MuPDF source directory and open the
thirdparty
folder.- Create a new folder called
libarchive
; within this folder, create two subfolders:include
andlib
. - In the
thirdparty\libarchive\include
folder, create another subfolder, calledlibarchive
. Copyarchive.h
andarchive_entry.h
from thelibarchive
folder in the libarchive source tree, to thethirdparty\libarchive\include\libarchive
folder within the MuPDF source code. - Copy the
archive_static.lib
file from thelibarchive/Release
folder in the libarchive source tothirdparty\libarchive\lib
.
- Create a new folder called
- Open the
- Download the bzip2 library (I used version 1.0.8) and extract the source code.
- Open the
x86 Native Tools Command Prompt for VS
, move to the bzip2 source code folder, and run the following commands:
cl -Zi -EHsc -c bzlib.c blocksort.c compress.c crctable.c decompress.c huffman.c randtable.c lib bzlib.obj blocksort.obj compress.obj crctable.obj decompress.obj huffman.obj randtable.obj
- This will create some files, including one called
bzlib.lib
. Copy this file into thethirdparty\libarchive\lib
folder, renaming it tolibbz2-static.lib
.
- Open the
- Download the XZ Utils (I used v5.6.2) and extract the source code.
- Open the
x86 Native Tools Command Prompt for VS
, move to thewindows
subfolder of the XZ Utils source code folder, and run the following commands:
cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_NLS=OFF -DBUILD_SHARED_LIBS=OFF .. msbuild xz.sln /p:Configuration=Release /p:Platform=Win32
- Now go to the
Release
folder and copyliblzma.lib
to thethirdparty\libarchive\lib\x64
in the MuPDF source tree.
- Open the
- Download the Zstandard source code (I used v1.5.6) and extract it. Note that the precompiled version will not work because it was not compiled against the MSVCRT.
- Open the
zstd.sln
file located in thebuild\VS2010
folder in Visual Studio. You should get a prompt prompt to retarget your projects. Accept the default settings (latest Windows SDK and v142 of the tools). - Save everything (
CTRL+SHIFT+S
) and close Visual Studio. - Open the
x86 Native Tools Command Prompt for VS
, move to the folder with the solution file, and build it withmsbuild zstd.sln /p:Configuration=Release /p:Platform=Win32
. - Copy the
libzstd_static.lib
file from thebin\Win32_Release
folder to thethirdparty\libarchive\lib
folder in the MuPDF source tree.
- Open the
- Now, open the
x86 Native Tools Command Prompt for VS
, move to the folder with the solution file, and build it usingmsbuild mupdf.sln /p:Platform=Win32
- Then, build again using
msbuild mupdf.sln /p:Configuration=Release /p:Platform=Win32
. - Finally, build again using
msbuild mupdf.sln /p:Configuration=ReleaseExtra /p:Platform=Win32
. - This should produce the
libmupdf.lib
file that is required in theReleaseExtra
folder (the file should be ~475MB in size).
-
On Windows (arm64)
This is going to be a bit more complicated, because it appears that MuPDF is not meant to be built on ARM. These instructions will assume that you are building MuPDF on an ARM machine.
First of all, make sure that you have installed Visual Studio 2022 and have selected the C++ ARM64 build tools component of the "Desktop development with C++" workload.
-
Download and extract the MuPDF source code and follow the instructions for all platforms above.
-
Add
|| defined(_M_ARM64)
at the end of line 16 inscripts/tesseract/endianness.h
. -
Open the file
thirdparty/openjpeg/src/lib/openjp2/ht_dec.c
and add the following after line 57 (source):unsigned int __popcnt(unsigned int x) { unsigned int c = 0; for (; x; ++c) { x &= x - 1; } return c; }
-
Now we need to edit a few files in the
thirdparty/tesseract/src/arch
folder.- Comment or delete lines 183-212 (inclusive) in
simddetect.cpp
. You should now have an empty block between# elif defined(_WIN32)
and#else
. Also comment or delete lines 235-262 (inclusive) and 286-319 (inclusive). - Comment or delete lines 18-26 (inclusive) in
dotproductsse.cpp
. Delete everything from line 31 to line 142 (inclusive) and replace with:
double DotProductSSE(const double* u, const double* v, int n) { return DotProductNative(u, v, n); }
- Comment or delete lines 24-25 (inclusive) in
dotproductavx.cpp
. Delete everything from line 30 to line 82 (inclusive) and replace with:
double DotProductAVX(const double* u, const double* v, int n) { return DotProductNative(u, v, n); }
- Comment or delete lines 24-25 (inclusive) in
dotproductfma.cpp
. Delete everything from line 30 to line 86 (inclusive) and replace with:
double DotProductFMA(const double* u, const double* v, int n) { return DotProductNative(u, v, n); }
- Delete the contents of
thirdparty/tesseract/src/arch/intsimdmatrixavx2.cpp
andthirdparty/tesseract/src/arch/intsimdmatrixsse.cpp
(do not delete the files, just their contents). - Comment or delete lines 119-120 (inclusive) in
intsimdmatrix.h
- Comment or delete lines 183-212 (inclusive) in
-
Download the source code release of libarchive (I used version 3.7.4) and extract it.
- Open the
Developer Command Prompt for VS
, move to the source code folder, and run the following commands:
cmake . msbuild libarchive/archive_static.vcxproj /p:Configuration=Release
- This will create a file called
archive_static.lib
in thelibarchive/Release
folder. - Now, go to the MuPDF source directory and open the
thirdparty
folder.- Create a new folder called
libarchive
; within this folder, create two subfolders:include
andlib
. - In the
thirdparty\libarchive\include
folder, create another subfolder, calledlibarchive
. Copyarchive.h
andarchive_entry.h
from thelibarchive
folder in the libarchive source tree, to thethirdparty\libarchive\include\libarchive
folder within the MuPDF source code. - In the
thirdparty\libarchive\include
folder, create a new subfolder calledx64
and copy thearchive_static.lib
file from thelibarchive/Release
folder in the libarchive source tothirdparty\libarchive\lib\x64
.
- Create a new folder called
- Open the
-
Download the bzip2 library (I used version 1.0.8) and extract the source code.
- Open the
Developer Command Prompt for VS
, move to the bzip2 source code folder, and run the following commands:
cl -Zi -EHsc -c bzlib.c blocksort.c compress.c crctable.c decompress.c huffman.c randtable.c lib bzlib.obj blocksort.obj compress.obj crctable.obj decompress.obj huffman.obj randtable.obj
- This will create some files, including one called
bzlib.lib
. Copy this file into thethirdparty\libarchive\lib\x64
folder, renaming it tolibbz2-static.lib
.
- Open the
-
Download the XZ Utils (I used v5.6.2) and extract the source code.
- Open the
Developer Command Prompt for VS
, move to thewindows
subfolder of the XZ Utils source code folder, and run the following commands:
cmake -DENABLE_NLS=OFF -DBUILD_SHARED_LIBS=OFF .. msbuild xz.sln /p:Configuration=Release
- Now go to the
Release
folder and copyliblzma.lib
to thethirdparty\libarchive\lib\x64
in the MuPDF source tree.
- Open the
-
Download the Zstandard source code (I used v1.5.6) and extract it. Note that the precompiled version will not work because it was not compiled against the MSVCRT.
- Open the
zstd.sln
file located in thebuild\VS2010
folder in Visual Studio. You should get a prompt prompt to retarget your projects. Accept the default settings (latest Windows SDK and v142 of the tools). - In Visual Studio, click on the "Configuration Manager" item from the "Build" menu. In the new window, click on the drop down menu for the "Active solution platform" and select
<New...>
. In this new dialog, select theARM64
platform and choose to copy the settings fromx64
. Leave theCreate new project platforms
option enabled and click onOK
(this may take some time). - Save everything (
CTRL+SHIFT+S
) and close Visual Studio. - Open the
Developer Command Prompt for VS
, move to the folder with the solution file, and build it withmsbuild zstd.sln /p:Configuration=Release /p:Platform=ARM64
. - Copy the
libzstd_static.lib
file from thebin/ARM64_Release
folder to thethirdparty\libarchive\lib\x64
folder in the MuPDF source tree.
- Open the
-
Back in the MuPDF source code folder, open the
platform/win32/mupdf.sln
solution in Visual Studio. You should get a prompt to retarget your projects. Accept the default settings (latest Windows SDK and v143 of the tools). -
In Visual Studio, click on the "Configuration Manager" item from the "Build" menu. In the new window, click on the drop down menu for the "Active solution platform" and select
<New...>
. In this new dialog, select theARM64
platform and choose to copy the settings fromx64
. Leave theCreate new project platforms
option enabled and click onOK
(this may take some time). -
Close the Configuration Manager and select the
ReleaseExtra
configuration andARM64
architecture. Select every project in the solution exceptjavaviewer
andjavaviewerlib
and right-click to open the project properties. Go toC/C++
>Code Generation
and set theRuntime Library
toMulti-threaded DLL (/MD)
. -
Open the properties for the
libpkcs7
project, go toC/C++
>Preprocessor
and removeHAVE_LIBCRYPTO
from thePreprocessor Definitions
. Then go toLibrarian
>General
and removelibcrypto.lib
from theAdditional Dependencies
. Now, go toCustom Build Step
and clear theCommand Line
and theOutput
. -
Save everything (
CTRL+SHIFT+S
) and close Visual Studio. -
Create a new folder
platform/win32/Release
. Now, the problem is that thebin2coff
script included with MuPDF cannot createobj
files for ARM64 (only for x86 and x64). Since I could not find a version that can do this, I translated the source code of bin2coff to C# and added this option myself. You can download an ARM64bin2coff.exe
from here; place it in theRelease
folder that you have just created. -
Open the
Developer Command Prompt for VS
, move to the folder with the solution file (platform/win32
), and build it usingmsbuild mupdf.sln /p:Configuration=ReleaseExtra
. Some compilation errors may occur towards the end, but they should not matter. -
After a while, this should produce
libmupdf.lib
in theARM64/ReleaseExtra
folder (the file should be ~521MB in size).
-
-
On Linux (x64, for both
glibc
- andmusl
- based distros):- Edit the
Makefile
, adding the-fPIC
compiler option at the end of line 25 (which specifies theCFLAGS
). - Comment line 218 in
include/mupdf/fitz/config.h
(for some reason, this seems to disable OCR even when usingUSE_TESSERACT=yes
to build). - Make sure that you are using a recent enough version of GCC (version 7.3.1 seems to be enough).
- Compile by running
USE_TESSERACT=yes make HAVE_X11=no HAVE_GLUT=no
(this builds just the command-line libraries and tools, and enables OCR through the included Tesseract library).
- Edit the
-
On Linux (arm64, for both
glibc
- andmusl
- based distros):- Edit the
Makefile
, adding the-fPIC
compiler option at the end of line 25 (which specifies theCFLAGS
). - Make sure that you are using a recent enough version of GCC (version 7.3.1 seems to be enough).
- Compile by running
USE_TESSERACT=yes make HAVE_X11=no HAVE_GLUT=no
(this builds just the command-line libraries and tools, and enables OCR through the included Tesseract library).
- Edit the
-
On macOS (Intel - x64):
- Edit the
Makefile
, adding the-fPIC
compiler option at the end of line 25 (which specifies theCFLAGS
). Also add the-std=c++11
option at the end of line 58 (which specifies theCXX_CMD
). - Compile by running
USE_TESSERACT=yes make
(this enables OCR through the included Tesseract library).
- Edit the
-
On macOS (Apple silicon - arm64)
- Edit the
Makefile
, adding the-fPIC
compiler options at the end of line 25 (which specifies theCFLAGS
). Also add the-std=c++11
option at the end of line 58 (which specifies theCXX_CMD
). - Compile by running
USE_TESSERACT=yes make
(this enables OCR through the included Tesseract library).
- Edit the
Once you have the required static library files, you should download the MuPDFCore source code (just clone this repository) and place the library files in the appropriate subdirectories in the native/MuPDFWrapper/lib/
folder (for Linux x64, copy the library built against glibc
to the linux-x64
folder, and the library built against musl
to the linux-musl-x64
folder, and do the same for Linux arm64).
To compile MuPDFWrapper
you will need CMake (version 3.8 or higher) and (on Windows) Ninja.
On Windows, the easiest way to get all the required tools is probably to install Visual Studio. By selecting the "Desktop development with C++" workload you should get everything you need.
On macOS, you will need to install at least the Command-Line Tools for Xcode (if necessary, you should be prompted to do this while you perform the following steps) and CMake.
Once you have everything at the ready, you will have to build MuPDFWrapper on the nine platforms.
Build instructions
-
Assuming you have installed Visual Studio, you should open the "x64 Native Tools Command Prompt for VS" or the "x86 Native Tools Command Prompt for VS" (you should be able to find these in the Start menu). Take care to open the version corresponding to the architecture you are building for, otherwise you will not be able to compile the library. A normal command prompt will not work, either.
Note 1: you must build the library on two separate systems, one running a 32-bit version of Windows and the other running a 64-bit version. If you try to build the x86 library on an x64 system, the system will probably build a 64-bit library and place it in the 32-bit output folder, which will just make things very confusing.
Note 2 for Windows x86: for some reason, Visual Studio might install the 64-bit version of CMake and Ninja, even though you are on a 32-bit machine. If this happens, you will have to manually install the 32-bit CMake and compile a 32-bit version of Ninja. You will notice if this is an issue because the 64-bit programs will refuse to run.
CD
to the directory where you have downloaded the MuPDFCore source code.CD
into thenative
directory.- Type
build
. This will start thebuild.cmd
batch script that will delete any previous build and compile the library.
After this finishes, you should find a file named MuPDFWrapper.dll
in the native/out/build/win-x64/MuPDFWrapper/
directory or in the native/out/build/win-x86/MuPDFWrapper/
directory. Leave it there.
- Locate the batch file that sets up the developer command prompt environment. You can do this by finding the "Developer Command Prompt for VS" link in the start menu, then clicking on
Open file location
, opening the properties of the link and looking at theTarget
. This could be e.g.C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat
. - Open a normal command prompt and invoke the batch script with the
-arch=arm64 -host_arch=x86
arguments (add quotes if there are spaces in the path to the batch script), e.g.:"C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat" -arch=arm64 -host_arch=x86
CD
to the directory where you have downloaded the MuPDFCore source code.CD
into thenative
directory.- Type
build
. This will start thebuild.cmd
batch script that will delete any previous build and compile the library.
After this finishes, you should find a file named MuPDFWrapper.dll
in the native/out/build/win-arm64/MuPDFWrapper/
directory. Leave it there.
- Assuming you have everything ready, open a terminal in the folder where you have downloaded the MuPDFCore source code.
cd
into thenative
directory.- Type
chmod +x build.sh
. - Type
./build.sh
. This will delete any previous build and compile the library.
After this finishes, you should find a file named libMuPDFWrapper.dylib
in the native/out/build/mac-x64/MuPDFWrapper/
directory (on macOS running on an Intel x64 processor) or in the native/out/build/mac-arm64/MuPDFWrapper/
directory (on macOS running on an Apple silicon arm64 processor), and a file named libMuPDFWrapper.so
in the native/out/build/linux-XXX/MuPDFWrapper/
directory (on Linux - where XXX
can be x64
, arm64
, musl-x64
, or musl-arm64
). Leave it there.
Once you have the MuPDFWrapper.dll
(3x), libMuPDFWrapper.dylib
(2x) and libMuPDFWrapper.so
(4x) files, make sure they are in the correct folders (native/out/build/xxx-yyy/MuPDFWrapper/
), all on the same machine.
To create the native assets NuGet packages, you will need the .NET Core 2.0 SDK or higher for your platform. Once you have installed it and have everything ready, open a terminal in the folder where you have downloaded the MuPDFCore source code and type:
BuildNativeAssets
This will create the NuGet packages in the MuPDFCore.NativeAssets/NuGetPackages
folder. Once the script finishes, this folder should contain 9 files. Make sure you add this folder as a local NuGet source.
If you have made updates to the native assets, make sure to use the appropriate version numbers in MuPDFCore/MuPDFCore.csproj
. Then, to create the main MuPDFCore NuGet package, open a terminal in the folder where you have downloaded the MuPDFCore source code and type:
cd MuPDFCore
dotnet pack -c Release
This will create a NuGet package in MuPDFCore/bin/Release
. You can install this package on your projects by adding a local NuGet source.
To verify that everything is working correctly, you should build the MuPDFCore test suite and run it on all platforms. To build the test suite, you will need the .NET 7 SDK or higher. You will also need to have enabled the Windows Subsystem for Linux.
To build the test suite:
- Make sure that you have changed the version of the MuPDFCore NuGet package so that it is higher than the latest version of MuPDFCore in the NuGet repository (you should use a pre-release suffix, e.g.
1.4.0-a1
to avoid future headaches with new versions of MuPDFCore). This is set in line 9 of theMuPDFCore/MuPDFCore.csproj
file. - Add the
MuPDFCore/bin/Release
folder to your local NuGet repositories (you can do this e.g. in Visual Studio). - If you have not done so already, create the MuPDFCore NuGet package following step 4 above.
- Update line 56 of the
Tests/Tests.csproj
project file so that it refers to the version of the MuPDFCore package you have just created.
These steps ensure that you are testing the right version of MuPDFCore (i.e. your freshly built copy) and not something else that may have been cached.
Now, open a Windows command line in the folder where you have downloaded the MuPDFCore source code, type BuildTests
and press Enter
. This will create a number of files in the Release\MuPDFCoreTests
folder, where each file is an archive containing the tests for a certain platform and architecture:
MuPDFCoreTests-linux-x64.tar.gz
contains the tests for Linux environments usingglibc
on x64 processors.MuPDFCoreTests-linux-arm64.tar.gz
contains the tests for Linux environments usingglibc
on arm64 processors.MuPDFCoreTests-linux-musl-x64.tar.gz
contains the tests for Linux environments usingmusl
on x64 processors.MuPDFCoreTests-linux-musl-arm64.tar.gz
contains the tests for Linux environments usingmusl
on arm64 processors.MuPDFCoreTests-mac-x64.tar.gz
contains the tests for macOS environments on Intel processors.MuPDFCoreTests-mac-arm64.tar.gz
contains the tests for macOS environments on Apple silicon processors.MuPDFCoreTests-win-x64.tar.gz
contains the tests for Windows environments on x64 processors.MuPDFCoreTests-win-x86.tar.gz
contains the tests for Windows environments on x86 processors.MuPDFCoreTests-win-arm64.tar.gz
contains the tests for Windows environments on arm64 processors.
To run the tests, copy each archive to a machine running the corresponding operating system, and extract it (note: on Windows, the default zip file manager may struggle when extracting the text file with non-latin characters; you may need to manually extract this file). Then:
- Open a command prompt and
CD
into the folder where you have extracted the contents of the test archive. - Enter the command
MuPDFCoreTestHost
(this will run the test program).
- Open a terminal and
cd
into the folder where you have extracted the contents of the test archive. - Enter the command
chmod +x MuPDFCoreTestHost
(this will add the executable flag to the test program). - Enter the command
./MuPDFCoreTestHost
(this will run the test program). - On macOS, depending on your security settings, you may get a message saying
zsh: killed
when you try to run the program. To address this, you need to sign the executable, e.g. by runningcodesign --timestamp --sign <certificate> MuPDFCoreTestHost
, where<certificate>
is the name of a code signing certificate in your keychain (e.g.Developer ID Application: John Smith
). After this, you can try again to run the test program with./MuPDFCoreTestHost
.
The test suite will start; it will print the name of each test, followed by a green Succeeded
or a red Failed
depending on the test result. If everything went correctly, all tests should succeed.
When all the tests have been run, the program will print a summary showing how many tests have succeeded (if any) and how many have failed (if any). If any tests have failed, a list of these will be printed, and then they will be run again one at a time, waiting for a key press before running each test (this makes it easier to follow what is going on). If you wish to kill the test process early, you can do so with CTRL+C
.
If you wish to use MuPDFCore in a .NET Framework project, you will need to manually copy the native MuPDFWrapper library for the platform you are using to the executable directory (this is done automatically if you target .NET/.NET core).
One way to obtain the appropriate library files is:
- Manually download the appropriate native assets NuGet package from the table below. Note that AnyCPU builds on Windows need the
win-x86
native asset. - Rename the
.nupkg
file so that it has a.zip
extension. - Extract the zip file.
- Within the extracted folder, the library files are in the
runtimes/xxx/native/
folder, wherexxx
islinux-x64
,linux-arm64
,linux-musl-x64
,linux-musl-arm64
,osx-x64
,osx-arm64
,win-x64
,win-x86
orwin-arm64
, depending on the platform you are using. - The file you need to copy should be called
MuPDFWrapper.dll
on Windows,libMuPDFWrapper.so
orMuPDFWrapper.so
on Linux, andlibMuPDFWrapper.dylib
on macOS.
Make sure you copy the appropriate file to the same folder as the executable!
OS | Platform | NuGet package | |
Windows | x86 | win-x86 | |
x64 | win-x64 | ||
arm64 | win-arm64 | ||
Linux | x64 | glibc | linux-x64 |
musl | linux-musl-x64 | ||
arm64 | glibc | linux-arm64 | |
musl | linux-musl-arm64 | ||
macOS | x64 (Intel) | osx-x64 | |
arm64 (Apple Silicon) | osx-arm64 |