semvec/pypi-packages huggingface dataset:
stv-ascii-art 0.1.5
Ascii Art 生成工具
License: MIT
Requires Python: >=3.7

# ASCII Art 转换工具 🎨⇄⌨️

[Github链接](https://github.com/StarWindv/STv_ASCII_ART/)

将图片/视频实时转换为高性能ASCII艺术，支持终端预览与文件导出，提供GPU加速和增强模式！

---

<table>
  <tr>
    <td><img src="https://github.com/StarWindv/STv_ASCII_ART/blob/main/demo/herta2_ascii.png?raw=true" width="100%" /></td>
    <td><img src="https://github.com/StarWindv/STv_ASCII_ART/blob/main/demo/details-1.png?raw=true" width="100%" /></td>
  </tr>
</table>

<table >
  <tr>
    <td align="center"><img src="https://github.com/StarWindv/STv_ASCII_ART/blob/main/demo/generating.gif?raw=true" width="75%" /></td>
  </tr>
</table>

## ✨ 功能亮点

- **双模式支持**：基础模式(`▄`字符) / 增强模式(`@%#*+=-:. `渐变字符)
- **硬件加速**：自动检测CUDA，通过将图片转为torch张量来支持GPU加速处理（需安装PyTorch）
- **智能适配**：根据终端尺寸自适应缩放并居中显示
- **多媒体支持**：
  - 图片：即时预览+保存处理后的PNG
  - 视频：实时播放（30FPS+）或导出MP4文件
- **ANSI真彩色**：精确还原原始色彩空间

---

## 🛠️ 安装依赖

```bash
pip install stv_ascii_art
```

---

## 🚀 使用指南

### 基本命令

```bash
stv_art [输入路径] [选项]
```

### 选项说明

| 参数           | 缩写   | 说明            |
| ------------ | ---- | ------------- |
| `--output`   | `-o` | 自定义输出路径       |
| `--video`    | `-v` | 视频模式          |
| `--enhanced` | `-e` | 启用增强字符集       |
| `--export`   | `-x` | 导出视频文件（仅视频模式） |
| `--gpu`      | `-g` | 启用GPU加速       |

### 使用示例

1. **图片转ASCII**（终端预览+保存）
   
   ```bash
   stv_art input.jpg -e -g
   ```
   
   注意，此模式下会自动生成一份`filename_ansi.txt`，存储在`ASCII_PIC/ANSI`下，你可以使用`with open`方法将它输出到想要的地方，比如终端。
   
   <table >
   <tr>
    <td align="center">
   <img src="https://github.com/StarWindv/STv_ASCII_ART/blob/main/demo/ansi_test.png?raw=true" width="75%" /></td>
   </tr>
   </table>

2. **视频实时播放**
   
   ```bash
   stv_art input.mp4 -v -e
   ```
   
   注意，这个功能受电脑性能和终端字体大小影响，当清晰度过高时，将无法保证播放流畅。

3. **高质量导出ASCII视频**
   
   ```bash
   stv_art input.mp4 -v -x -e -o output.mp4
   ```
   
   注意，当处在导出模式时将不会播放艺术帧。
   注意，当导出开始后，请不要调整当前标签页的字体大小。

---

## 📝 已知不足

1. **终端依赖**  
   实时预览效果受终端模拟器性能及ANSI支持程度影响

2. **分辨率限制**  
   输出尺寸固定为当前终端窗口大小（可手动调整终端后重试）

3. **GPU兼容性**  
   如果你想启用GPU加速，则需要正确安装支持CUDA的torch与torchvision，核显与AMD显卡无法进行加速。

4. **大文件处理**  
   4K以上视频建议使用导出模式而非实时播放

5. **字符精度**  
   增强模式仅支持10级灰度，极端暗光场景可能丢失细节

---

## 🤝 参与贡献

欢迎提交PR或Issue！  
推荐方向：更多字符集支持、自动调整字符大小、音频支持

**[📜 MIT许可证](LICENSE)**