<img src="resources/readme/logo.png" alt="PAG Logo" width="553"/>
[](https://github.com/Tencent/libpag/blob/master/LICENSE.txt)
[](https://github.com/Tencent/libpag/pulls)
[](https://codecov.io/gh/Tencent/libpag)
[](https://github.com/Tencent/libpag/actions/workflows/autotest.yml)
[](https://github.com/Tencent/libpag/actions/workflows/build.yml)
[](https://github.com/Tencent/libpag/releases)
[](https://cloudstudio.net/a/20987965736472576?channel=share&sharetype=Markdown)
English | [简体中文](./README.zh_CN.md) | [Homepage](https://pag.io)
## Introduction
libpag is a real-time rendering library for PAG (Portable Animated Graphics) files, capable of
rendering both vector-based and raster-based animations across various platforms, including iOS,
Android, OpenHarmony, macOS, Windows, Linux, and the Web.
PAG is an open-source file format designed for recording animations. You can create and export PAG
files from Adobe After Effects using the PAGExporter plugin and preview them in the PAGViewer app,
both available on macOS and Windows.
PAG is widely used in major Tencent apps like WeChat, Mobile QQ, Honor of Kings, Tencent Video, and
QQ Music, as well as in thousands of third-party apps, reaching hundreds of millions of users.
## Advantages
- **Highly efficient file format**
<img src="resources/readme/intro_1.png" alt="intro_1" width="282"/>
Benefiting from its highly efficient binary format, PAG files decode 10 times faster than JSON files
and are about 50% smaller in file size for the same animations. Designers can also easily include
beautiful animations with bitmaps or audiovisual media in a single file without needing additional
attachments.
- **All AE features supported**
<img src="resources/readme/intro_2.png" alt="intro_2" width="282"/>
While other solutions may only support exporting limited vector-based AE features, PAG combines
vector-based and raster-based exporting techniques to support all AE animations in a single file.
This means third-party plugin effects in AE can also be exported.
- **Measurable performance**
<img src="resources/readme/intro_4.png" alt="intro_4" width="282"/>
PAG provides a monitoring panel in PAGViewer that displays normalized performance data for PAG files,
making it easy for designers to review and optimize performance without needing developers. With
numerous automatic optimization techniques from the PAGExporter plugin, you can create animations
with impressive visual effects and excellent performance more efficiently.
PAGViewer includes a monitoring panel
- **Runtime editable animations**
<img src="resources/readme/intro_5.png" alt="intro_5" width="282"/>
With the flexible editing APIs from the PAG SDK, developers can easily modify the layer structure of
a single PAG file, combine multiple PAG files into one composition, or replace text and images with
all pre-designed animation effects applied at runtime. This significantly reduces the coding work
required for features like video templates.
## System Requirements
- iOS 15.0+
- Android 5.0+
- HarmonyOS Next 5.0.0(12)+
- macOS 12.0+
- Windows 7.0+
- Chrome 69.0+ (Web)
- Safari 15.0+ (Web)
## Getting Started
We currently only publish precompiled libraries for iOS, Android, macOS, Web, and OpenHarmony. You
can build libraries of other platforms from the source code. The latest releases can be downloaded
from [here](https://github.com/Tencent/libpag/releases).
### iOS Integration
You can download the framework from the release page or add `libpag` to your project using CocoaPods.
To add the pod to your Podfile, include:
```
pod 'libpag'
```
And then run:
```
pod install
```
After installing the CocoaPod, import `libpag` into your project with:
```
#import <libpag/xxx.h>
```
### Android Integration
You can download the AAR from the release page or add `libpag` to your project using Maven:
Edit the `build.gradle` file in the root of your project and add `mavenCentral()` to the `repositories` section:
```
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.2.1'
}
}
```
Add libpag to `app/build.gradle` (*`4.0.5.10` should be replaced with the latest release version*):
```
dependencies {
implementation 'com.tencent.tav:libpag:4.0.5.10'
}
```
Add the following rule to your proguard rules to prevent incorrect obfuscation:
```
-keep class org.libpag.** {*;}
-keep class androidx.exifinterface.** {*;}
```
Finally, run gradle sync and build your project.
### OpenHarmony Integration
You can download the HAR file from the [release](https://github.com/Tencent/libpag/releases) page,
or add `libpag` to your project using OHPM:
```
ohpm install @tencent/libpag
```
Alternatively, you can add it to your project manually. Add the following lines to `oh-package.json5`
in your app module.
```
"dependencies": {
"@tencent/libpag": "^1.0.1",
}
```
Then run:
```
ohpm install
```
### Web Integration
Copy the following code into an HTML file and open it in your browser:
```html
<canvas class="canvas" id="pag"></canvas>
<script src="https://unpkg.com/libpag@latest/lib/libpag.min.js"></script>
<script>
window.libpag.PAGInit().then((PAG) => {
const url = 'https://pag.io/file/like.pag';
fetch(url)
.then((response) => response.blob())
.then(async (blob) => {
const file = new window.File([blob], url.replace(/(.*\/)*([^.]+)/i, '$2'));
// Do Something.
});
});
</script>
```
More information：[Web SDK Guide](./web/README.md)
### Example
Explore these projects to learn how to use the libpag APIs:
- [https://github.com/libpag/pag-ios](https://github.com/libpag/pag-ios)
- [https://github.com/libpag/pag-android](https://github.com/libpag/pag-android)
- [https://github.com/libpag/pag-web](https://github.com/libpag/pag-web)
### Documentation
- [iOS API Reference](https://pag.io/apis/ios/index.html)
- [Android API Reference](https://pag.io/apis/android/index.html)
- [Web API Reference](https://pag.io/apis/web/index.html)
You can find additional documentation on [pag.io](https://pag.io/docs/home.html)
## Development
We recommend using the CLion IDE on macOS for development.
### Branch Management
- The `main` branch is our active development branch, containing the latest features and bug fixes.
- The `release/` branches are our stable milestone branches, fully tested. We periodically create a
`release/{version}` branch from the `main` branch. After a `release/{version}` branch is created,
only high-priority fixes are checked into it.
**Note: This repository only contains the latest code since PAG 4.0. For legacy PAG 3.0 versions,
you can download the precompiled libraries from [here](https://github.com/Tencent/libpag/releases).**
### Build Prerequisites
- Xcode 13.0+
- GCC 9.0+
- Visual Studio 2019+
- NodeJS 14.14.0+
- Ninja 1.9.0+
- CMake 3.13.0+
- QT 6.2.0+
- NDK 28+ (**28.0.13004108 recommended**)
- Emscripten 3.1.58+
### Dependency Management
libpag uses the [depsync](https://github.com/domchen/depsync) tool to manage third-party dependencies.
**For macOS platform：**
Run the script located in the root directory of the project:
```
./sync_deps.sh
```
This script will automatically install the necessary tools and sync all third-party repositories.
**For other platforms：**
First, ensure you have the latest version of Node.js installed (you may need to restart your
computer afterward). Then, run the following command to install the depsync tool:
```
npm install -g depsync
```
Then, run `depsync` in the root directory of the project.
```
depsync
```
You might need to enter your Git account and password during synchronization. Ensure you have
enabled the `git-credential-store` so that `CMakeList.txt` can automatically trigger synchronization
next time.
### Build
After synchronization, you can open the project with CLion and build the PAG library.
**For macOS:**
No additional CLion configuration is needed.
**For Windows:**
Follow these steps to configure CLion correctly:
- Ensure you have installed the **[Desktop development with C++]** and **[Universal Windows Platform development]** components for VS2019.
- Open the **File->Settings** panel, go to **Build, Execution, Deployment->Toolchains**, and set the toolchain to **Visual Studio** with **amd64 (Recommended)** or **x86** architecture.
**Note: If you encounter issues during the CMake build, update to the latest version of the CMake
command-line tool and try again.**
## Support Us
If you find libpag helpful, please give us a **Star**. We truly appreciate your support :)
[](https://star-history.dera.page/#Tencent/libpag&Date)
## License
libpag is licensed under the [Apache Version 2.0 License](./LICENSE.txt)
The copyright notice pertaining to the Tencent code in this repo was previously in the name of "THL
A29 Limited". That entity has now been de-registered. You should treat all previously distributed
copies of the code as if the copyright notice was in the name of "Tencent".
## Privacy Policy
Please refer to the [PAG SDK Personal Information Processing Rules](https://privacy.qq.com/document/preview/01e79d0cc7a2427ba774b88c6beff0fd) when using the libpag SDK.
### Data Collection
- **Binaries built from this repository collect no data.** They contain no network requests or usage reporting, and the bundled privacy manifest (`PrivacyInfo.xcprivacy`) declares no data collection.
- **Official prebuilt releases** distributed through pag.io and CocoaPods contain an additional anonymous usage statistics module on iOS and Android, which reports the following data to the Tencent Beacon analytics service (`otheve.beacon.qq.com`), at most once per SDK version per month: host app name and bundle identifier, operating system version and device model, GPU version and vendor, and the libpag SDK version. No user IDs, advertising identifiers, or other personal data are collected, and the data is used solely for SDK usage statistics. The privacy manifest bundled in the official releases declares this data collection accordingly.
## Contribution
If you have any ideas or suggestions to improve libpag, feel free to submit an
[issue](https://github.com/Tencent/libpag/issues/new/choose) or a [pull request](https://github.com/Tencent/libpag/pulls).
Before doing so, please read our [Contributing Guide](./CONTRIBUTING.md).