https://github.com/readium/readium-sdk
A C++ ePub renderer SDK
https://github.com/readium/readium-sdk
c-plus-plus epub
Last synced: about 1 month ago
JSON representation
A C++ ePub renderer SDK
- Host: GitHub
- URL: https://github.com/readium/readium-sdk
- Owner: readium
- License: bsd-3-clause
- Archived: true
- Created: 2013-01-06T17:44:23.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2020-01-29T11:49:44.000Z (over 5 years ago)
- Last Synced: 2025-06-27T08:44:30.686Z (4 months ago)
- Topics: c-plus-plus, epub
- Language: C
- Homepage:
- Size: 131 MB
- Stars: 396
- Watchers: 78
- Forks: 163
- Open Issues: 81
-
Metadata Files:
- Readme: Readme.markdown
- Contributing: .github/CONTRIBUTING.md
- License: license.txt
Awesome Lists containing this project
README
# Readium SDK
#### Copyright (c) 2012–2014 The Readium Foundation and contributors.
### Release Notes
Version 0.14 includes support for building a shared or static library for Android devices
using the Android NDK r8e. See the [Platform Support](#platform-support) section for more information.
## About
The Readium SDK is an ePub reader SDK of similar scope and capability to
Adobe's Reader Mobile SDK (RMSDK). As such, it is designed to implement an ePub3-
compliant Reading System, although its initial form will concentrate solely on the
core [ePub3 specification][ePub3] and [fixed-layout metadata][fxl], expanding later
to cover associated standards such as [Page Templates][pt].
[ePub3]: http://idpf.org/epub/30
[fxl]: http://idpf.org/epub/fxl/
[pt]: http://idpf.org/epub/pgt/csspgt-20120808.html
The project's aim is to develop a productized, high-performance, cross-platform
rendering engine for EPUB 3 content, optimized for use in native applications
(mobile/tablet and secondarily desktop systems). Simplistic test applications for
Android, iOS, OS X and Windows are part of the SDK, along with unit tests. The SDK
is designed to be extensible in various areas, including in support for pluggable
encryption and digital signature modules which might be used to implement a form
of DRM.
### Licensing info
Licensing information can be found in the file license.txt in the root of the repo, as well as in the source code itself.
At present, the project compiles for OS X and iOS using the version of Clang in Xcode 4.6
and the LLVM C++ standard library, `libc++`.
On Android, the project is build using GCC 4.7 and release 8e of the Android NDK. See
[Platform/Android/README.markdown](Platform/Android/README.markdown) for more information.
Build support for Windows using Visual Studio 2012 is due in release 0.5.
### Headers And Libraries
The SDK is built into a single library on all platforms. Headers are placed into an `include` folder by the build process for each platform, located within the appropriate `Platform` subfolder. For instance, OS X and iOS headers are within `Platform/Apple/include`, Windows headers are within `Platform/Windows/include`.
This folder is designed to be passed directly to the compiler using the `-I` argument or similar.
### Architecture
The SDK consists of three major components, corresponding roughly to *Model*, *View*,
and *Controller*. The majority of the ePub3 data handling takes place inside the
*Model* component, which provides parsing and generation of ePub-related data
structures. The *View* component is a browser engine; this engine may be a customized
form of WebKit developed as part of this project, but any CSS3-compliant browser
engine may be used. The *Controller* component is a small interface between the data
and renderer components; this part is ultimately what Reading System vendors will
extend to create their own reading system.
The project is written in cross-platform C++ and JavaScript code, and is designed
to be combined with platform-specific glue code and a modern browser rendering
engine to instantiate an ePub3-compliant rendering engine within a platform-native
Reading System application. The SDK constitutes a capable, high-performance ePub
engine, not an overall application (other than per platform test applications).
The general architecture is that the browser engine (headlessly) handles content
rendering with some features like pagination being implemented in Readium SDK
JavaScript code that has been “injected” into the browser context. The C++ code
handles tasks/features that can’t be efficiently performed in JS, such as
incrementally fetching (and, as necessary, decrypting/de-obfuscating) resources
from an .epub ZIP package. Certain UX affordances are supported within the browser
context (e.g. text highlighting) but application-level UX affordances would
generally be done in the reading system application via platform-specific code
(e.g. Java on Android, Obj-C on iOS). Integration glue is provided in the Readium
SDK to facilitate this, and usage illustrated by the test applications (which
however are not product-level reading systems). Handling of XML Encryption and
Digital Signature files is provided to simplify implementation of DRM or content
protection/validation that is compatible with the ePub3 specification.
The Readium SDK is designed to potentially work with multiple browser engines but
the #1 priority for initial development is WebKit, including platform-bundled
instantiations (e.g. via UIWebView on iOS). #2 priority browser engine will be
Trident/IE10 (needed for apps to be able to support screen readers on Windows).
## Build status
### Android
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Android-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Android-Develop/)
### iOS
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-iOS-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-iOS-Develop/)
### Mac OS X
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Mac-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Mac-Develop/)
## Windows 32
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Windows-32-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Windows-32-Develop/)
## Windows 64
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Windows-64-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-Windows-64-Develop/)
## WinRT 32
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-WinRT-32-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-WinRT-32-Develop/)
## WinRT 64
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-WinRT-64-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-WinRT-64-Develop/)
## WinRT ARM
- master - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-WinRT-ARM-Master/)
- develop - [](http://jenkinsmaster.datalogics-cloud.com:8080/job/Readium-SDK-WinRT-ARM-Develop/)