noiz/README.md
2026-07-09 16:05:06 +02:00

39 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# noiz://
![Logo](./noizmainlogo.png)
A browser-based 100%-local audio player with real-time spectrum visualization, VU metering, and comprehensive playlist management. Loaded entirely from a single `index.html` file - no build step, no server, no dependencies. Plays files from your local machine. That's it.
## Obligatory Screenshot
![Screenshot](./noizshot.png)
## Demo
There is a live demo available at [bsd.pm/noiz](https://bsd.pm/noiz/).
## Features
- **Real-time FFT spectrum analyzer** - smooth animated frequency bars with configurable window function (Hanning / Blackman-Harris) and adjustable peak decay
- **VU meter** - per-channel level display with peak indicators
- **Metadata parsing** - reads ID3v1 and ID3v2 tags (title, artist, album, genre, year), plus inline codec info for MP3 and FLAC
- **Playlist** - sortable by title, artist, filename, length, or genre; supports shuffle and repeat (off / all / one)
- **Crossfade** - optional gapless transition between tracks (1s5s)
- **Drag & drop** - drop folders or individual files; handles nested directories via the File System Access API (with `webkitdirectory` fallback)
- **Keyboard shortcuts** - Space (play/pause), ← (previous), → (next)
## Usage
Open `index.html` in any modern browser. Click **+Folder**, **+Files**, or drag audio files onto the window.
## Known Limitations
- **File path display** — When adding individual files via **+Files** or drag-and-drop, browsers do not expose the full filesystem path for security reasons. Only the filename is shown in the tag editor. Using **+Folder** (which reads directory structure) provides the relative path within the selected folder.
- **Playback interruption on +Folder** — Opening the native directory picker suspends the browser's `AudioContext`, causing playback to stop. This is a browser-level security restriction (user gesture required for audio resume). Simply press play again after adding files.
## noizapp
There is a simple PoC Electron available to make noiz a stand-alone desktop "app":
https://codeberg.org/armin/noizapp
## License
noiz is released under the MIT license; see LICENSE file.