Skip to content

Commit 84a26cc

Browse files
committed
Docs: audio
1 parent 9fd6cf9 commit 84a26cc

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/source/audio.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,28 @@
22
Audio
33
=====
44

5-
Write stuff
5+
We currently use pygame's mixer module for music playback.
6+
More work needs to be done to find a better alternative
7+
as depending on such a huge package should not be needed.
8+
9+
You will have to manually add pygame to your requirements
10+
and pip install the package.
11+
12+
In oder to get pygame to work you probably need sdl, sdl_mixer
13+
and libvorbis. These are binary dependencies and not python
14+
packages.
15+
16+
We need to figure out what requiremnets are actually needed.
17+
18+
As mentioned in readme, the state of audio is not in good shape.
19+
20+
The sound player an be a bit wonky at times on startup refusing to play
21+
on some platforms. We have tried a few libraries and ended up using
22+
pygame's mixer module. (Optional setup for this)
23+
24+
Audio Requirements:
25+
26+
- As the current position in the music is what all
27+
draw timers are based on, we need a library that can deliver very accurate value for this.
28+
- Efficient and accurate seeking + pause support
29+
- Some way to extract simple data from the music for visualisation

0 commit comments

Comments
 (0)