Metadata-Version: 2.4
Name: projectpulsewire
Version: 2.0.0
Summary: Premium CLI to install and manage professionally-tuned EasyEffects presets, IRS files, and Linux audio dependencies
Author-email: roshellwett <roshhellwett@zenithopensourceprojects.vercel.app>
License-Expression: MIT
Project-URL: Homepage, https://github.com/roshhellwett/projectpulsewire
Project-URL: Repository, https://github.com/roshhellwett/projectpulsewire.git
Project-URL: Issues, https://github.com/roshhellwett/projectpulsewire/issues
Keywords: easyeffects,pipewire,pulseaudio,audio,eq,presets,linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: license
Requires-Dist: typer>=0.12.0
Requires-Dist: rich>=13.0.0
Dynamic: license-file

[![License](https://img.shields.io/badge/License-MIT-45b7d1?style=flat-square)](LICENSE)
[![PyPI](https://img.shields.io/badge/PyPI-2.0.0-4ecdc4?style=flat-square)](https://pypi.org/project/projectpulsewire/)
[![Platform](https://img.shields.io/badge/Platform-Linux-FCC624?style=flat-square&logo=linux)](https://github.com/roshhellwett/projectpulsewire)

# PROJECT PULSEWIRE

Premium EasyEffects presets for PipeWire/PulseAudio on Linux. Transform your Linux audio experience with one command!

![SAMPLE](https://github.com/roshhellwett/projectpulsewire/blob/9b142db104c4f05d19cbabf78b11ae46ce332a1d/sample/samplezero.png)

![SAMPLE](https://github.com/roshhellwett/projectpulsewire/blob/9b142db104c4f05d19cbabf78b11ae46ce332a1d/sample/sampleone.png)

---

## 🚀 Quick Install (For Everyone)

### Step 1: Install the package

Open your terminal and run:

```bash
pip install projectpulsewire
```

### Step 2: Open the menu

```bash
python -m projectpulsewire start
```

### Step 3: Choose what to do!

```
 1   Browse & Preview Presets (EQ)        ← See all available audio profiles
 2   Browse & Preview IRS (Convolution)   ← See reverb/correction files  
 3   Install Preset(s)                    ← Install presets to EasyEffects
 4   Install IRS(s)                       ← Install IRS files
 5   View Installed (Presets + IRS)       ← See what you installed
 6   Remove Preset(s)/IRS(s)             ← Uninstall
 7   Update projectpulsewire             ← Get new versions
 8   Help & Commands                     ← Learn more
 9   IRS Guide                           ← Learn what IRS files are & how to use them
10   Setup Audio Stack                   ← Auto-detect & install audio dependencies
 0   Exit
```

### Step 4: Restart EasyEffects

After installing presets, close and reopen **EasyEffects** app. Your new presets will appear in the preset manager!

---

## 💻 Commands for Power Users

### Interactive Menu (Recommended for Beginners)
```bash
python -m projectpulsewire start
```

### List All Presets
```bash
python -m projectpulsewire list
```

### List All IRS Files  
```bash
python -m projectpulsewire list-irs
```

### Install a Specific Preset
```bash
python -m projectpulsewire install "Bass Boosted Banger"
python -m projectpulsewire install "Rock Energy Max"
python -m projectpulsewire install "LoFi Chill Max"
```

### Install an IRS File
```bash
python -m projectpulsewire install-irs "BassWaves"
python -m projectpulsewire install-irs "Dolby Headphone"
```

### View Installed Items
```bash
python -m projectpulsewire installed
```

### Remove a Preset
```bash
python -m projectpulsewire remove "Bass Boosted Banger"
```

### Setup Audio Stack (Auto-Install Dependencies)
```bash
python -m projectpulsewire setup
```

### IRS Guide (What are IRS files?)
```bash
python -m projectpulsewire irs-guide
```

### Update to Latest Version
```bash
python -m projectpulsewire update
```

### Get Help
```bash
python -m projectpulsewire --help
python -m projectpulsewire version
```

---

## 📋 System Requirements

| Requirement | Details |
|-------------|---------|
| OS | Linux (Ubuntu, Fedora, Arch, etc.) |
| Python | 3.10 or higher |
| Audio Server | PipeWire (recommended) or PulseAudio |
| Required App | [EasyEffects](https://github.com/wwmm/easyeffects) |

### How to Install EasyEffects

**Ubuntu/Debian:**
```bash
sudo apt install easyeffects
```

**Fedora:**
```bash
sudo dnf install easyeffects
```

**Arch Linux:**
```bash
sudo pacman -S easyeffects
```

**Or use the built-in auto-installer:**
```bash
python -m projectpulsewire setup
```

---

## 🔧 Audio Stack Auto-Setup (NEW in v2.0)

ProjectPulsewire can automatically detect and install all essential audio packages for your Linux distribution:

| Package | Purpose | Priority |
|---------|---------|----------|
| `pipewire` | Modern audio server | Critical |
| `pipewire-pulse` | PulseAudio compatibility | Critical |
| `pipewire-alsa` | ALSA compatibility | Critical |
| `wireplumber` | Session manager | Critical |
| `easyeffects` | Audio effects processor | Critical |
| `lsp-plugins` | Audio plugins (EQ, compressor) | Critical |
| `calf-plugins` | Audio plugins (reverb, etc.) | Recommended |
| `zam-plugins` | Maximizer and utilities | Recommended |
| `mda-lv2` | Classic LV2 plugins | Recommended |

Supports: **Ubuntu/Debian**, **Fedora**, **Arch/Manjaro**, **openSUSE**, and **Flatpak**.

---

## 🎵 What's Included?

### 47 Professionally-Tuned EQ Presets

All presets feature **proper signal chains** with compressor, EQ, bass enhancer, and limiter — not just a naked equalizer.

**Bass Category (10 presets)**
- Bass Boosted Banger, Deep Bass Sheesh, Heavy Bass Big W, Boosted AF
- Bass Enhancer + Perfect EQ God Tier, Perfect EQ God Tier
- HB-Flat NPC Mode, HB-Lite Vibe, HB-Mid Tier, V Shape Boost Rizz

**Music Genre (14 presets)**
- Rock Energy Max/Min, EDM Banger Max/Min, Classical Aura Max/Min
- LoFi Chill Max/Min, Indie Vibe Max/Min, KPop Stan Max/Min
- HiFi Drip Max/Min

**Clarity & Voice (8 presets)**
- Crystal Air Drip, Warm Vocal Clarity Rizz, Cinema Voice Main Character
- Gaming Tryhard Mode, Studio Flat IRL, Night Listener Doomer Mode
- Live Concert Moshpit, Video Binge Mode

**Device Signatures (2 presets)**
- Bose Flex, Sony Flex

**Loudness & Dynamics (13 presets)**
- Music Vibe Check, Loudness Compensator Carry
- Advanced Auto Gain Goated, Loudness+Autogain Carry
- Loudness Crystal Equalizer Default/GTK Drip
- Loudness Equalizer Boomer Gate/GTK Drip/PE Edition/Standard
- GentleDynamics Chill/Soft Era Loudness/Yapper Clarity

### 404 IRS Files
- Dolby Surround profiles
- DFX audio enhancements
- Creative X-Fi profiles
- Bass enhancement
- Room correction
- Headphone virtualization

---

## 🎓 IRS Files — What Are They?

**IRS (Impulse Response)** files capture the sonic signature of a real acoustic space or audio device. When loaded into EasyEffects' **Convolver** plugin, they shape your audio to sound like it's being played through that space/device.

### How to Use IRS Files

1. Install an IRS file using the interactive menu (option 4)
2. Open **EasyEffects** → **Output Effects**
3. Click **Add Effect** → Select **Convolver**
4. In Convolver settings, click the **import/file icon**
5. Browse to your IRS directory and select the `.irs` file
6. **Important:** Add a **Limiter** after the Convolver to prevent clipping

### IRS Categories
| Category | Best For |
|----------|----------|
| Bass | Adding deep low-end to weak speakers |
| Dolby | Surround sound on stereo headphones |
| DFX | General audio enhancement & clarity |
| Creative | Gaming 3D audio & spatial sound |

---

## 🔧 Where Do Files Go?

| Type | Native Location | Flatpak Location |
|------|-----------------|-------------------|
| JSON Presets | `~/.config/easyeffects/output/` | `~/.var/app/com.github.wwmm.easyeffects/config/easyeffects/output/` |
| IRS Files | `~/.config/easyeffects/irs/` | `~/.var/app/com.github.wwmm.easyeffects/config/easyeffects/irs/` |

*Note: `~` means your home folder (e.g., `/home/username`)*

---

## 🆘 Troubleshooting

### "Command not found" error
Make sure Python is in your PATH. Try:
```bash
python3 -m projectpulsewire start
```

### Presets not appearing
1. Make sure you restart EasyEffects after installing
2. Check if installed: `python -m projectpulsewire installed`

### Missing audio plugins
Run the auto-setup to install all required packages:
```bash
python -m projectpulsewire setup
```

### Permission denied errors
Run terminal as admin for installation:
```bash
sudo pip install projectpulsewire
```

---

## 🙏 Acknowledgments

- [EasyEffects](https://github.com/wwmm/easyeffects) - The amazing audio equalizer
- [PipeWire](https://pipewire.org/) - Modern audio server
- All preset creators in the Linux audio community

---

© 2026 [Zenith Open Source Projects](https://zenithopensourceprojects.vercel.app/). All Rights Reserved. Zenith is a Open Source Project Idea's by @roshhellwett
