Merge remote main and resolve README.md conflict
This commit is contained in:
176
.gitignore
vendored
Normal file
176
.gitignore
vendored
Normal file
@@ -0,0 +1,176 @@
|
||||
# ---> Python
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
cover/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
.pybuilder/
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
# For a library or package, you might want to ignore these files since the code is
|
||||
# intended to run in multiple environments; otherwise, check them in:
|
||||
# .python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
||||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# UV
|
||||
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
#uv.lock
|
||||
|
||||
# poetry
|
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
||||
#poetry.lock
|
||||
|
||||
# pdm
|
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
||||
#pdm.lock
|
||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
||||
# in version control.
|
||||
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
||||
.pdm.toml
|
||||
.pdm-python
|
||||
.pdm-build/
|
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
celerybeat-schedule
|
||||
celerybeat.pid
|
||||
|
||||
# SageMath parsed files
|
||||
*.sage.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
|
||||
# PyCharm
|
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
|
||||
# Ruff stuff:
|
||||
.ruff_cache/
|
||||
|
||||
# PyPI configuration file
|
||||
.pypirc
|
||||
|
||||
51
README.md
51
README.md
@@ -8,19 +8,21 @@ A Python-based bridge that provides an MPRIS2 interface for Winamp/WACUP on Linu
|
||||
- **Playback Controls**: Supports Play, Pause, Next, Previous, and Stop via the Winamp Web Interface.
|
||||
- **Live Position Tracking**: Extrapolates playback position for smooth progress bars in your desktop's media widget.
|
||||
- **Robustness**: Gracefully handles Winamp being offline and automatically reconnects when it starts.
|
||||
- **Systemd Integration**: Can be run as a background user service.
|
||||
- **Systemd Integration**: Can be run as a background user service conforming to XDG standards.
|
||||
- **XDG Compliance**: Installs to `~/.local/bin`, logs to `~/.local/state/winamp-mpris/`, and stores PID in `$XDG_RUNTIME_DIR`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### 1. Winamp Web Interface Plugin
|
||||
The bridge communicates with Winamp through the **Winamp Web Interface** plugin.
|
||||
- **Download**: [Winamp Web Interface v7.5.10](https://winampheritage.com/plugin/winamp-web-interface/92511)
|
||||
- **Download**: [Winamp Web Interface v7.5.10](https://winampheritage.com/plugin/winamp-web-interface/92511) (Source included in repository).
|
||||
- **Installation**: Install the plugin in Winamp/WACUP.
|
||||
- **Configuration**:
|
||||
1. Open Winamp Preferences -> Plug-ins -> General Purpose.
|
||||
2. Configure "Winamp Web Interface".
|
||||
3. Set a **Username** (default: `winamp`) and **Password** (default: `llama`).
|
||||
4. Ensure the server is running (default port: `5666`).
|
||||
5. In the **Users** tab, ensure the user has **Play** permissions.
|
||||
|
||||
### 2. Winamp/WACUP Title Formatting
|
||||
To ensure the bridge can extract correct metadata, you must configure Winamp to show specific information in its window title.
|
||||
@@ -43,43 +45,33 @@ sudo dnf install wmctrl libnotify # or sudo apt install wmctrl libnotify
|
||||
|
||||
## Installation & Setup
|
||||
|
||||
1. **Clone or copy the script** to a local directory (e.g., `~/Scripts/winamp-mpris/`).
|
||||
2. **Configure Credentials**: If you changed the default username/password in the plugin, update the `AUTH` variable in `winamp_mpris.py`.
|
||||
The project includes an XDG-compliant installer:
|
||||
|
||||
### Running Manually
|
||||
```bash
|
||||
python3 winamp_mpris.py
|
||||
chmod +x install.sh
|
||||
./install.sh
|
||||
```
|
||||
|
||||
### Testing and Debugging
|
||||
You can use `busctl` to interact with the MPRIS interface:
|
||||
This will:
|
||||
1. Install the script to `~/.local/bin/winamp-mpris`.
|
||||
2. Install and enable the systemd user service `winamp-mpris.service`.
|
||||
3. Start the bridge immediately.
|
||||
|
||||
### Logs and Monitoring
|
||||
- **Logs**: `tail -f ~/.local/state/winamp-mpris/bridge.log`
|
||||
- **Systemd Logs**: `journalctl --user -u winamp-mpris.service -f`
|
||||
- **PID File**: `$XDG_RUNTIME_DIR/winamp-mpris.pid`
|
||||
|
||||
### Testing with busctl
|
||||
You can manually interact with the MPRIS interface:
|
||||
```bash
|
||||
# Get playback status
|
||||
busctl --user get-property org.mpris.MediaPlayer2.winamp /org/mpris/MediaPlayer2 org.mpris.MediaPlayer2.Player PlaybackStatus
|
||||
|
||||
# Get current position (in microseconds)
|
||||
busctl --user get-property org.mpris.MediaPlayer2.winamp /org/mpris/MediaPlayer2 org.mpris.MediaPlayer2.Player Position
|
||||
|
||||
# Send commands
|
||||
busctl --user call org.mpris.MediaPlayer2.winamp /org/mpris/MediaPlayer2 org.mpris.MediaPlayer2.Player PlayPause
|
||||
```
|
||||
|
||||
### Running as a systemd User Service
|
||||
1. **Install the service file**:
|
||||
```bash
|
||||
mkdir -p ~/.config/systemd/user/
|
||||
cp winamp-mpris.service ~/.config/systemd/user/
|
||||
```
|
||||
2. **Reload and Enable**:
|
||||
```bash
|
||||
systemctl --user daemon-reload
|
||||
systemctl --user enable --now winamp-mpris.service
|
||||
```
|
||||
3. **Monitor Logs**:
|
||||
```bash
|
||||
journalctl --user -u winamp-mpris.service -f
|
||||
```
|
||||
|
||||
## Technical Details
|
||||
|
||||
- **D-Bus Bus**: `org.mpris.MediaPlayer2.winamp`
|
||||
@@ -88,6 +80,7 @@ busctl --user call org.mpris.MediaPlayer2.winamp /org/mpris/MediaPlayer2 org.mpr
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Controls not working**: Ensure the Winamp Web Interface is accessible at `http://localhost:5666` and the credentials in the script match your plugin settings.
|
||||
- **401 Unauthorized**: Ensure the Winamp Web Interface credentials match those in `winamp-mpris` and that the user has "Play" permissions in the plugin's Users tab.
|
||||
- **Controls not working**: Ensure the Winamp Web Interface is accessible at `http://localhost:5666`.
|
||||
- **No Metadata**: Ensure `wmctrl -l` can see the Winamp window and the title matches the expected format.
|
||||
- **KDE Plasma 6**: If using Plasma 6 on Wayland, you may need to grant "Remote Control" permissions when prompted to allow `wmctrl` to read window titles accurately.
|
||||
- **KDE Plasma 6**: If using Plasma 6 on Wayland, you may need to grant "Remote Control" permissions when prompted.
|
||||
|
||||
Reference in New Issue
Block a user