chilleverydaychill/roop

## This project has been discontinued

Yes, you can still use this software. It just won't recieve any updates now.

> The reason behind shutting the project down is that a developer with write access to the code published a [problematic video](https://github.com/s0md3v/roop/commit/cf7ba1caf932e8c9f39d972100f74022e7372c27) to the documentation of the project. This happened while I was taking a break from the project in July-Aug 2023. It went unnoticed for 2 weeks until someone reached out to me to talk about this project. It was a complete breach of trust for me and I decided that I do not have the interest or time to oversee the development of a software with such ethical issues.
> I thank all the amazing people who contributed to this project and made what it is in it's final form.

# Roop

> Take a video and replace the face in it with a face of your choice. You only need one image of the desired face. No dataset, no training.

[](https://github.com/s0md3v/roop/actions?query=workflow:ci)

## Installation

Be aware, the installation needs technical skills and is not for beginners. Please do not open platform and installation related issues on GitHub. We have a very helpful [Discord](https://discord.com/invite/Y9p4ZQ2sB9) community that will guide you to install roop.

[Basic](https://github.com/s0md3v/roop/wiki/1.-Installation) - It is more likely to work on your computer, but will be quite slow

[Acceleration](https://github.com/s0md3v/roop/wiki/2.-Acceleration) - Unleash the full potential of your CPU and GPU

## Usage

Start the program with arguments:

```
python run.py [options]

-h, --help show this help message and exit
-s SOURCE_PATH, --source SOURCE_PATH select an source image
-t TARGET_PATH, --target TARGET_PATH select an target image or video
-o OUTPUT_PATH, --output OUTPUT_PATH select output file or directory
--frame-processor FRAME_PROCESSOR [FRAME_PROCESSOR ...] frame processors (choices: face_swapper, face_enhancer, ...)
--keep-fps keep target fps
--keep-frames keep temporary frames
--skip-audio skip target audio
--many-faces process every face
--reference-face-position REFERENCE_FACE_POSITION position of the reference face
--reference-frame-number REFERENCE_FRAME_NUMBER number of the reference frame
--similar-face-distance SIMILAR_FACE_DISTANCE face distance used for recognition
--temp-frame-format {jpg,png} image format used for frame extraction
--temp-frame-quality [0-100] image quality used for frame extraction
--output-video-encoder {libx264,libx265,libvpx-vp9,h264_nvenc,hevc_nvenc} encoder used for the output video
--output-video-quality [0-100] quality used for the output video
--max-memory MAX_MEMORY maximum amount of RAM in GB
--execution-provider {cpu} [{cpu} ...] available execution provider (choices: cpu, ...)
--execution-threads EXECUTION_THREADS number of execution threads
-v, --version show program's version number and exit
```

### Headless

Using the `-s/--source`, `-t/--target` and `-o/--output` argument will run the program in headless mode.

## Disclaimer

This software is designed to contribute positively to the AI-generated media industry, assisting artists with tasks like character animation and models for clothing.

We are aware of the potential ethical issues and have implemented measures to prevent the software from being used for inappropriate content, such as nudity.

Users are expected to follow local laws and use the software responsibly. If using real faces, get consent and clearly label deepfakes when sharing. The developers aren't liable for user actions.

## Licenses

Our software uses a lot of third party libraries as well pre-trained models. The users should keep in mind that these third party components have their own license and terms, therefore our license is not being applied.

## Credits

- [deepinsight](https://github.com/deepinsight) for their [insightface](https://github.com/deepinsight/insightface) project which provided a well-made library and models.
- all developers behind the libraries used in this project

## Documentation

Read the [documentation](https://github.com/s0md3v/roop/wiki) for a deep dive.

原始信息汇总

Roop

Roop 是一个视频处理工具，可以将视频中的面部替换为用户选择的面部图像，无需数据集或训练。

安装

安装需要一定的技术技能，不适合初学者。提供了两种安装方式：

• 基本安装 - 更可能在您的计算机上运行，但速度较慢
• 加速安装 - 充分发挥您的 CPU 和 GPU 性能

使用

启动程序时可以使用以下参数：

python run.py [options]

-h, --help show this help message and exit -s SOURCE_PATH, --source SOURCE_PATH select an source image -t TARGET_PATH, --target TARGET_PATH select an target image or video -o OUTPUT_PATH, --output OUTPUT_PATH select output file or directory --frame-processor FRAME_PROCESSOR [FRAME_PROCESSOR ...] frame processors (choices: face_swapper, face_enhancer, ...) --keep-fps keep target fps --keep-frames keep temporary frames --skip-audio skip target audio --many-faces process every face --reference-face-position REFERENCE_FACE_POSITION position of the reference face --reference-frame-number REFERENCE_FRAME_NUMBER number of the reference frame --similar-face-distance SIMILAR_FACE_DISTANCE face distance used for recognition --temp-frame-format {jpg,png} image format used for frame extraction --temp-frame-quality [0-100] image quality used for frame extraction --output-video-encoder {libx264,libx265,libvpx-vp9,h264_nvenc,hevc_nvenc} encoder used for the output video --output-video-quality [0-100] quality used for the output video --max-memory MAX_MEMORY maximum amount of RAM in GB --execution-provider {cpu} [{cpu} ...] available execution provider (choices: cpu, ...) --execution-threads EXECUTION_THREADS number of execution threads -v, --version show programs version number and exit

无头模式

使用 -s/--source、-t/--target 和 -o/--output 参数将运行程序在无头模式下。

免责声明

该软件旨在积极贡献于 AI 生成媒体行业，帮助艺术家进行角色动画和服装模型等任务。我们意识到潜在的伦理问题，并采取了措施防止软件被用于不适当的内容，如裸体。用户应遵守当地法律并负责任地使用软件。如果使用真实面孔，请获取同意并在分享时明确标记深度伪造。开发者不对用户的行为负责。

许可证

我们的软件使用了许多第三方库和预训练模型。用户应记住，这些第三方组件有自己的许可证和条款，因此我们的许可证不适用。

致谢

• deepinsight 提供的 insightface 项目，提供了高质量的库和模型。
• 所有为本项目使用的库做出贡献的开发者