ambience

Ambient soundscape player: plays audio files as background ambience


License
MIT
Install
pip install ambience==1.0.12

Documentation

Ambience

Ambient soundscape player

This is a python cli program that plays audio files, looping them for a specified duration and fading between them.

It reads a directory for .ogg, .wav or .flac files. The program comes with a set of files, but can be used with any files on your computer of the supported types by using the --path parameter when invoking.

Installation with pip

pip install ambience

ambience --fetch-library

Manual Installation

  • Requires python3
  • Requires pygame

Clone this repository.

Run pip3 install --user -r requirements.txt to install pygame if not already installed

Recommended: link ambience in a directory on your path. E.g. ln -s ambience.py ~/bin/ambience

Alternate install for pygame (compile pygame from source)

To install pygame from scratch instead of using pip, you can use the following commands (assuming linux):

 # Clone source repo
sudo apt install mercurial
hg clone https://bitbucket.org/pygame/pygame
cd pygame

sudo apt install libsdl-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsmpeg-dev libportmidi-dev libavformat-dev libswscale-dev

python3 setup.py build
sudo python3 setup.py install

Usage

To run with the default settings, simply run ambience. Use "ctrl-c" to stop.

Hello from the pygame community. https://www.pygame.org/contribute.html
usage: ambience [-h] [-d DURATION] [-f] [-i] [-n] [-p PATH] [-q] [-v] [paths ...]

positional arguments:
  paths                 load given sound file(s) or path(s)

options:
  -h, --help            show this help message and exit
  -d DURATION, --duration DURATION
                        set the duration in minutes each sound will play: default=5
  -f, --fetch-library   fetch the sound library from internet
  -i, --noinit          do not pre-initialize all sounds at start
  -n, --noinput         disable the stdin input capture
  -p PATH, --path PATH  set the path where the sound files are
  -q, --quiet           produce no output
  -v, --version         show version and exit

If invoked without the -n parameter, press 'n' to skip to next sound and 'q' to quit.

The default sounds used are in the install directory (wherever you cloned/downloaded this repo) in the sub-directory sounds.

Sound credits

Credit goes to the following for the sound files included in this package: