User Interfaces

Ipython

To run the ipython shell, just do it through the docker composition:

docker-compose run app ipython

Notebook

You can also run your code in the wonderful Jupyter Notebook which gives you a web interface to run your own code and share the results with your collaborators:

docker-compose -f docker-compose.yml -f env/notebook.yml up

and then browse http://localhost:8888 to access the Jupyter notebook interface. Use the token given in the docker logs of the notebook container to login.

Warning

Running a Jupyter notebook server with this setup in a non-secured network is not safe. See Running a notebook server for a documented solution to this security problem.

Use you own data

The var/media directory is mounted in /srv/media inside the container so you can use it to exchange data between the host and the app container.

Web Server

TimeSide now includes an experimental web service with a REST API:

git clone https://github.com/Parisson/TimeSide.git
cd TimeSide
docker-compose up db

This will pull all needed images for running the server and then initialize the database. Leave the session with CTRL+C and then finally do:

docker-compose up

This will initialize everything and create a bunch a test sample boilerplate. You can browse the TimeSide API at:

and the admin interface (login: admin, password: admin) at:

Note

A documentation about using the objects and processors from the webserver will be written soon. We need help on this!

All (raw, still experimental) results are accessible at :

Tip

On MacOS or Windows, replace “localhost” by the virtual machine IP given by docker-machine ip timeside

To process some data by hand in the web environment context, just start a django shell session:

docker-compose run app manage.py shell

To run the webserver in background as a daemon, just add the -d option:

docker-compose up -d

Batch

A shell script is provided to enable preset based and recursive processing through your command line interface:

timeside-launch -h
Usage: bin/timeside-launch [options] -c file.conf file1.wav [file2.wav ...]
 help: bin/timeside-launch -h

Options:
 -h, --help            show this help message and exit
 -v, --verbose         be verbose
 -q, --quiet           be quiet
 -C <config_file>, --conf=<config_file>
                       configuration file
 -s <samplerate>, --samplerate=<samplerate>
                       samplerate at which to run the pipeline
 -c <channels>, --channels=<channels>
                       number of channels to run the pipeline with
 -b <blocksize>, --blocksize=<blocksize>
                       blocksize at which to run the pipeline
 -a <analyzers>, --analyzers=<analyzers>
                       analyzers in the pipeline
 -g <graphers>, --graphers=<graphers>
                       graphers in the pipeline
 -e <encoders>, --encoders=<encoders>
                       encoders in the pipeline
 -R <formats>, --results-formats=<formats>
                       list of results output formats for the analyzers
                       results
 -I <formats>, --images-formats=<formats>
                       list of graph output formats for the analyzers results
 -o <outputdir>, --ouput-directory=<outputdir>
                       output directory

Find some preset examples in examples/presets/

Web player

TimeSide comes with a smart and pure HTML5 audio player.

Features:

  • embed it in any audio web application

  • stream, playback and download various audio formats on the fly

  • synchronize sound with text, bitmap and vectorial events

  • seek through various semantic, analytic and time synced data

  • fully skinnable with CSS style

TimeSide player

Examples of the player embeded in the Telemeta open web audio CMS:

Development documentation: