> [!IMPORTANT]
> <sub>This repository is part of a [**monorepo**](https://github.com/BrokenSource/BrokenSource) and [**shouldn't be cloned alone**](https://brokensrc.dev/get/source)</sub>
<!-- PyPI -->
<div align="center">
  <a href="https://brokensrc.dev/depthflow"><img src="https://raw.githubusercontent.com/BrokenSource/DepthFlow/main/DepthFlow/Resources/Images/DepthFlow.png" width="200"></a>
  <h1>DepthFlow</h1>
  <b>Image to → 2.5D Parallax</b> Effect Video. A <b>Free and Open Source</b> <a href="https://www.immersity.ai/" target="_blank"><b>ImmersityAI</b></a> Alternative
  <br>
  <br>
  <a href="https://pypi.org/project/depthflow/"><img src="https://img.shields.io/pypi/v/depthflow?label=PyPI&color=blue"></a>
  <a href="https://pypi.org/project/depthflow/"><img src="https://img.shields.io/pypi/dw/depthflow?label=Installs&color=blue"></a>
  <a href="https://github.com/BrokenSource/DepthFlow/"><img src="https://img.shields.io/github/v/tag/BrokenSource/BrokenSource?label=GitHub&color=orange"></a>
  <a href="https://github.com/BrokenSource/DepthFlow/stargazers"><img src="https://img.shields.io/github/stars/BrokenSource/DepthFlow?label=Stars&style=flat&color=orange"></a>
  <a href="https://github.com/BrokenSource/DepthFlow/releases/"><img src="https://img.shields.io/github/v/release/BrokenSource/DepthFlow?label=Release&color=light-green"></a>
  <a href="https://github.com/BrokenSource/DepthFlow/releases/"><img src="https://img.shields.io/github/downloads/BrokenSource/DepthFlow/total?label=Downloads&color=light-green"></a>
  <a href="https://discord.gg/KjqvcYwRHm"><img src="https://img.shields.io/discord/1184696441298485370?label=Discord&style=flat&color=purple"></a>
</div>

<br>

# 🔥 Description

> **DepthFlow** is a heavily customizable **parallax shader** for adding soul to your images.

- **🛡️ Open Source**, trust and transparency, cross platform, configurable
- **🚀 Fast:** heavily optimized shader, render at 8k50 with an RTX 3060
- **🎨 Post Processing**: easy vignette, depth of field, lens distortion
- **⚙️ Flexible**: multiple parameters to tweak and create movement
- **🎥 Presets**: quality built-in extensively configurable animations `(soon)`
- **📈 Upscaler** pipeline built-in, powered by [**RealESR**](https://github.com/xinntao/Real-ESRGAN) `(optional)`
- **♻️ Seamless loops**: perfect for backgrounds, wallpapers, fillers
- **📔 Video Codecs**: easily export to H264, HEVC, AV1, (+NVENC)
- **🔱 High Quality**, any resolution, framerate, bitrate, SSAA
- **⭐️ Smooth borders**: no artifacts, _petite_ step size
- **🎨 No Watermarks**, user first experience
- **🌵 Fastest** rendering times in the west

<br>

# 📸 Showcase

👇 Right click and **loop me**!

<video src="https://github.com/BrokenSource/DepthFlow/assets/29046864/aac0b531-83e4-4847-98d8-25d396dfec17" loop controls autoplay></video>

<sup><b>Note:</b> Yes, the only input to DepthFlow was the Original Image</sup>

<details>
<summary>🎩 <b>Click</b> to see the Original Image </summary>
  <br>
  <a href="https://wallhaven.cc/w/pkz5r9">
    <img src="https://github.com/BrokenSource/DepthFlow/assets/29046864/1975fdc9-9517-4700-88dd-ed8175ab813f" alt="Original Image">
  </a>
  <br>
  <b>Source:</b> <a href="https://wallhaven.cc/w/pkz5r9">Wallhaven</a>. All images remain property of their original owners. ⚖️
  <br>
  <br>
</details>

<details>
<summary>🪄 <b>Click</b> to see the Estimated Depth map </summary>
  <br>
  <img src="https://github.com/BrokenSource/DepthFlow/assets/29046864/bace7072-5437-4ffd-96f2-91b9be3a4fed" alt="Depth Map">
  <br>
  The Depth Map was estimated with <a href="https://github.com/LiheYoung/Depth-Anything"><b>DepthAnything</b></a> 🚀
  <br>
  <br>
</details>

<br>
<br>

<div align="center">
  <h2>🍁 Learn More 🍁</h2>
  <h3>✨ Check out my <a href="https://brokensrc.dev/depthflow/get"><b>Awesome Website</b></a> instead of a boring Readme ✨</h3>
  <h5>Installation Guides, Usage, Tips, Code Reference and More!</h5>
</div>
