# JoyVASA
**Repository Path**: lz98/JoyVASA
## Basic Information
- **Project Name**: JoyVASA
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-29
- **Last Updated**: 2024-12-29
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
JoyVASA: Portrait and Animal Image Animation with Diffusion-Based Audio-Driven Facial Dynamics and Head Motion Generation
Jintao Fei1
Minyu Gao1
1JD Health International Inc.β 2Zhejiang University
## π Introduction
Audio-driven portrait animation has made significant advances with diffusion-based models, improving video quality and lipsync accuracy. However, the increasing complexity of these models has led to inefficiencies in training and inference, as well as constraints on video length and inter-frame continuity. In this paper, we propose JoyVASA, a diffusion-based method for generating facial dynamics and head motion in audio-driven facial animation. Specifically, in the first stage, we introduce a decoupled facial representation framework that separates dynamic facial expressions from static 3D facial representations. This decoupling allows the system to generate longer videos by combining any static 3D facial representation with dynamic motion sequences. Then, in the second stage, a diffusion transformer is trained to generate motion sequences directly from audio cues, independent of character identity. Finally, a generator trained in the first stage uses the 3D facial representation and the generated motion sequences as inputs to render high-quality animations. With the decoupled facial representation and the identity-independent motion generation process, JoyVASA extends beyond human portraits to animate animal faces seamlessly. The model is trained on a hybrid dataset of private Chinese and public English data, enabling multilingual support. Experimental results validate the effectiveness of our approach. Future work will focus on improving real-time performance and refining expression control, further expanding the frameworkβs applications in portrait animation.
## π§³ Framework

**Inference Pipeline of the proposed JoyVASA.** Given a reference image, we first extract the 3D facial appearance feature using the appearance encoder in LivePortrait, and also a series of learned 3D keypoints using the motion encoder. For the input speech, the audio features are initially extracted using the wav2vec2 encoder. The audio-driven motion sequences are then sampled using a diffusion model trained in the second stage in a sliding window fashion. Using the 3D keypoints of reference image, and the sampled target motion sequences, the target keypoints are computed. Finally, the 3D facial appearance feature is warped based on the source and target keypoints and rendered by a generator to produce the final output video.
## βοΈ Installation
**System requirements:**
Ubuntu:
- Tested on Ubuntu 20.04, Cuda 11.3
- Tested GPUs: A100
Windows:
- Tested on Windows 11, CUDA 12.1
- Tested GPUs: RTX 4060 Laptop 8GB VRAM GPU
**Create environment:**
```bash
# 1. Create base environment
conda create -n joyvasa python=3.10 -y
conda activate joyvasa
# 2. Install requirements
pip install -r requirements.txt
# 3. Install ffmpeg
sudo apt-get update
sudo apt-get install ffmpeg -y
# 4. Install MultiScaleDeformableAttention
cd src/utils/dependencies/XPose/models/UniPose/ops
python setup.py build install
cd - # equal to cd ../../../../../../../
```
## π Prepare model checkpoints
Make sure you have [git-lfs](https://git-lfs.com) installed and download all the following checkpoints to `pretrained_weights`:
### 1. Download JoyVASA motion generator checkpoints
```bash
git lfs install
git clone https://huggingface.co/jdh-algo/JoyVASA
```
### 2. Download audio encoder checkpoints
We suport two types of audio encoders, including [wav2vec2-base](https://huggingface.co/facebook/wav2vec2-base-960h), and [hubert-chinese](https://huggingface.co/TencentGameMate/chinese-hubert-base).
Run the following commands to download [hubert-chinese](https://huggingface.co/TencentGameMate/chinese-hubert-base) pretrained weights:
```bash
git lfs install
git clone https://huggingface.co/TencentGameMate/chinese-hubert-base
```
To get the [wav2vec2-base](https://huggingface.co/facebook/wav2vec2-base-960h) pretrained weights, run the following commands:
```bash
git lfs install
git clone https://huggingface.co/facebook/wav2vec2-base-960h
```
> [!NOTE]
> The motion generation model with wav2vec2 encoder will be supported later.
### 3. Download LivePortraits checkpoints
```bash
# !pip install -U "huggingface_hub[cli]"
huggingface-cli download KwaiVGI/LivePortrait --local-dir pretrained_weights --exclude "*.git*" "README.md" "docs"
```
Refering to [Liveportrait](https://github.com/KwaiVGI/LivePortrait/tree/main) for more download methods.
### 4. `pretrained_weights` contents
The final `pretrained_weights` directory should look like this:
```text
./pretrained_weights/
βββ insightface
β βββ models
β βββ buffalo_l
β βββ 2d106det.onnx
β βββ det_10g.onnx
βββ JoyVASA
β βββ motion_generator
β β βββ iter_0020000.pt
β βββ motion_template
β βββ motion_template.pkl
βββ liveportrait
β βββ base_models
β β βββ appearance_feature_extractor.pth
β β βββ motion_extractor.pth
β β βββ spade_generator.pth
β β βββ warping_module.pth
β βββ landmark.onnx
β βββ retargeting_models
β βββ stitching_retargeting_module.pth
βββ liveportrait_animals
β βββ base_models
β β βββ appearance_feature_extractor.pth
β β βββ motion_extractor.pth
β β βββ spade_generator.pth
β β βββ warping_module.pth
β βββ retargeting_models
β β βββ stitching_retargeting_module.pth
β βββ xpose.pth
βββ TencentGameMate:chinese-hubert-base
β βββ chinese-hubert-base-fairseq-ckpt.pt
β βββ config.json
β βββ gitattributes
β βββ preprocessor_config.json
β βββ pytorch_model.bin
β βββ README.md
βββ wav2vec2-base-960h
βββ config.json
βββ feature_extractor_config.json
βββ model.safetensors
βββ preprocessor_config.json
βββ pytorch_model.bin
βββ README.md
βββ special_tokens_map.json
βββ tf_model.h5
βββ tokenizer_config.json
βββ vocab.json
```
> [!NOTE]
> The folder `TencentGameMate:chinese-hubert-base` in Windows should be renamed `chinese-hubert-base`.
## π Inference
### 1. Inference with command line
Animal:
```python
python inference.py -r assets/examples/imgs/joyvasa_001.png -a assets/examples/audios/joyvasa_001.wav --animation_mode animal --cfg_scale 2.0
```
Human:
```python
python inference.py -r assets/examples/imgs/joyvasa_003.png -a assets/examples/audios/joyvasa_003.wav --animation_mode human --cfg_scale 2.0
```
You can change cfg_scale to get results with different expressions and poses.
> [!NOTE]
> Mismatching Animation Mode and Reference Image may result in incorrect results.
### 2. Inference with web demo
Use the following command to start web demo:
```python
python app.py
```
The demo will be create at http://127.0.0.1:7862.
## π Citations
If you find our work helpful, please consider citing us:
```
@misc{cao2024joyvasaportraitanimalimage,
title={JoyVASA: Portrait and Animal Image Animation with Diffusion-Based Audio-Driven Facial Dynamics and Head Motion Generation},
author={Xuyang Cao and Guoxin Wang and Sheng Shi and Jun Zhao and Yang Yao and Jintao Fei and Minyu Gao},
year={2024},
eprint={2411.09209},
archivePrefix={arXiv},
primaryClass={cs.CV},
url={https://arxiv.org/abs/2411.09209},
}
```
## π€ Acknowledgments
We would like to thank the contributors to the [LivePortrait](https://github.com/KwaiVGI/LivePortrait), [Open Facevid2vid](https://github.com/zhanglonghao1992/One-Shot_Free-View_Neural_Talking_Head_Synthesis), [InsightFace](https://github.com/deepinsight/insightface), [X-Pose](https://github.com/IDEA-Research/X-Pose), [DiffPoseTalk](https://github.com/DiffPoseTalk/DiffPoseTalk), [Hallo](https://github.com/fudan-generative-vision/hallo), [wav2vec 2.0](https://github.com/facebookresearch/fairseq/tree/main/examples/wav2vec), [Chinese Speech Pretrain](https://github.com/TencentGameMate/chinese_speech_pretrain), [Q-Align](https://github.com/Q-Future/Q-Align), [Syncnet](https://github.com/joonson/syncnet_python), and [VBench](https://github.com/Vchitect/VBench) repositories, for their open research and extraordinary work.