Metadata-Version: 2.3
Name: depthflow
Version: 0.8.0
Summary: 🌊 Images to → 2.5D Parallax Effect Video. A Free and Open Source ImmersityAI alternative
Project-URL: GitHub, https://github.com/BrokenSource/DepthFlow
Project-URL: Changelog, https://brokensrc.dev/about/changelog
Project-URL: Funding, https://brokensrc.dev/about/sponsors
Project-URL: Contact, https://brokensrc.dev/about/contact
Project-URL: Download, https://brokensrc.dev/get/releases
Project-URL: Docs, https://brokensrc.dev/depthflow
Project-URL: Homepage, https://brokensrc.dev
Author-email: Tremeschin <29046864+Tremeschin@users.noreply.github.com>
License-Expression: AGPL-3.0
Requires-Python: >=3.10
Requires-Dist: broken-source[gradio]==0.8.0
Requires-Dist: shaderflow==0.8.0
Description-Content-Type: text/markdown


<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 style="margin-top: 0">DepthFlow</h1>
  <b>Images 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>
  <br>
  <br>
  <b>
    Links:
    <a target="_blank" href="https://brokensrc.dev/depthflow/quick/">Quick Start</a> •
    <a target="_blank" href="https://brokensrc.dev/get/releases/">Releases</a> •
    <a target="_blank" href="https://brokensrc.dev/get/pypi/">PyPI</a> •
    <a target="_blank" href="https://github.com/akatz-ai/ComfyUI-Depthflow-Nodes">ComfyUI</a> •
    <a target="_blank" href="https://brokensrc.dev/get/source/">Cloning</a> •
    <a target="_blank" href="https://brokensrc.dev/depthflow/learn/">Documentation</a>
  </b>
  <br>
  <sub><small>⭐️ Consider starring the project to help it grow! ⭐️</small></sub>
</div>

<br>

## 🔥 Description

> **DepthFlow** is a heavily customizable **steep parallax shader** for animating your images.

- **🌐 Web interface** made with [**Gradio**](https://gradio.app), get quick feedback on animations.
- **🚀 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.
- **📈 Upscaler:** built-in pipeline, 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).
- **📦 Executables:** double click and run, automated complexity.
- **🔱 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.
- **🌀 Self hosted:** Unlimited usage.

<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>

🌐 Powerfull **WebUI** built with [**Gradio**](https://gradio.app)

<img src="https://github.com/user-attachments/assets/05b81504-d736-4c95-8e6f-9b4901c9eebd">

<br>

## 📦 Installation

Find the many installation methods here: https://brokensrc.dev/get/

<br>

## ♻️ Community

Check out amazing community work built on top of DepthFlow:

- ⭐️ [**ComfyUI Integration**](https://github.com/akatz-ai/ComfyUI-Depthflow-Nodes) by [@akatz-ai](https://github.com/akatz-ai/), also in [**CivitAI**](https://civitai.com/models/855031)

<sup>Also give them a star and support!</sup>

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

<!-- License -->
<br><br><div align="center"><sup>
This project is dual-licensed under an [Open Source](License-oss.txt) (AGPLv3) or [Commercial](License-com.txt) (MIT) license. Refer to the [Website](https://brokensrc.dev/about/license/) for information.
</sup></div>
