Skip to content

Commit

Permalink
update README and NEWS
Browse files Browse the repository at this point in the history
  • Loading branch information
yomguy committed Oct 6, 2014
1 parent 791e08a commit 6604885
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 89 deletions.
File renamed without changes.
File renamed without changes.
8 changes: 5 additions & 3 deletions MANIFEST.in
@@ -1,11 +1,13 @@
include AUTHORS
include LICENSE
include AUTHORS.txt
include LICENSE.txt
include README.rst
include NEWS.rst
include requirements.txt
recursive-include doc *
recursive-include timeside *
recursive-exclude timeside/server/sandbox/media *
recursive-include examples *
recursive-include tests *
recursive-exclude examples/sandbox/media *
recursive-exclude tests/sandbox *
recursive-exclude * *.pyc
recursive-exclude * *.swp
Expand Down
86 changes: 86 additions & 0 deletions NEWS.rst
@@ -0,0 +1,86 @@
News
=====

0.5.6

* Bugfix release
* Fix analyzer instanciation as parent for some graphers

0.5.5

* All processor folders (decoder, analyzer, grapher, encoder) are now real plugin repositories : you can just drop processors in it and play!
* TimeSide can be installed without Aubio, Yaafe nor Vamp : it should be easier to install on old distributions for which those librairies are difficult or impossible to compile
* Encoder : add an Opus encoder
* Experimental : add a django web server with a REST API (see "Web server")
* AubioPitch: prevent NaN in result by converting them to zero
* Yaafe analyzer: simplify adaptation of process frames from TimeSide to Yaafe
* LimsiSad: add a default value for parameter sad_model
* Fix various NaN and Inf and PEP8 issues also many PyFlake warnings
* Full `Travis integration <https://travis-ci.org/yomguy/TimeSide/>`_ with tests and test coverage through `coveralls.io <https://coveralls.io/r/yomguy/TimeSide>`_
* Thanks to all contributors!
* WARNING: some of the processor paths used in your app could have moved between 0.5.4 and 0.5.5. Check them with timeside.core.processors(). Note that it is now advised to use the timeside.core.get_processor() method to instantiate the processors with their respective id as argument.
* UPGRADING from the sources: please remove all .pyc files from your repository.

0.5.4

* Encoder : transcoded streams where broken. Now fixed with some smart thread controls.
* Analyzer : update VAMP plugin example in sandbox
* Analyzer : new *experimental* plugin : Limsi Speech Activity Detection Systems (limsi_sad)
* Decoder : process any media in streaming mode giving its URL
* Install : fix some setup requirements

0.5.3

* Make Analyzer rendering more generic and easy to implement
* Analyzer : implement rendering capability for event and segment + add some more analyzer graphers
* Analyzer : refactoring the results rendering method. + Capability to use matplotlib in environnement with no display
* Decoder : Add a Live decoder to get data from the soundcard
* Decoder : add support for 96kHz sampling rate
* Encoder: live AudioSink encoder, encoder that plays the audio stream through the soundcard
* Grapher : add a generic Class to display Analyzers through their 'render' method. Add the new grapher file
* Grapher : add a generic Class to display Analyzers through their 'render' method. For now, it only support FrameValueResult analyzer
* Core : add a condition to catch signal only if a LiveDecoder source is used
* Various bugfixes

0.5.2

* Add a general launch script "timeside-launch" (see "Shell interface")
* Add some decorators to filter the inputs of processes (see analyzer.waveform for ex)
* Add a "stack" option to the FileDecoder to accumulate audio data allowing multipass processes
* Add beat confidence to aubio_temporal
* Add AAC encoder (gstreamer voaacenc plugin needed)
* Add UUIDs to the file URI and to all processors
* Add a Debian repository with all dependencies for i386 and amd64 architectures
* Fix buggy WebM encoder
* Fix buggy MP3 muxing
* Fix various minor bugs

0.5.1

* Add *parent* processor list to Processor
* Simplify and optimize the grapher system
* Add Grapher abstract generic class
* Add a UUID property to Processor
* Add a SpectrogramLinear grapher
* Add WaveformTransparent grapher
* Fix some assignment issues regarding immutable type in for Analyzer Result
* Simplify analyzer results implementation by introducing a Factory and multiple classes and subclasses to handle the 8 different kinds of results
* Add doctests and improve the unit tests
* Add a OnsetDetectionFunction analyzer
* Update documentation
* Various cleanups
* Various bugfixes

0.5.0

* Deep refactoring of the analyzer API to handle various new usecases, specifically audio feature extraction
* Add serializable global result container (NEW dependency to h5py, json, yaml)
* Add new audio feature extraction analyzers thanks to the Aubio library providing beat & BPM detection, pitch dectection and other cool stuff (NEW dependency on aubio)
* Add new audio feature extraction analyzers thanks to the Yaafe library (NEW dependency on yaafe)
* Add new IRIT speech detection analyzers (NEW dependency on scipy)
* EXPERIMENTAL : add new audio feature extraction thanks to the VAMP plugin library (NEW dependency on some vamp tools)
* Add new documentation : http://files.parisson.com/timeside/doc/
* New Debian repository for instant install
* Various bugfixes
* Comptatible with Python >=2.7
* WARNING : no longer compatible with Telemeta 1.4.5
100 changes: 14 additions & 86 deletions README.rst
Expand Up @@ -111,90 +111,19 @@ IEncoder
News
=====

0.5.7

* Add a Docker development box
* Add a Vagrant development box
* Add a Debian package installation procedure
* Fix parent and child analyzers both using yaafe (fix #60)

0.5.6

* Bugfix release
* Fix analyzer instanciation as parent for some graphers

0.5.5

* All processor folders (decoder, analyzer, grapher, encoder) are now real plugin repositories : you can just drop processors in it and play!
* TimeSide can be installed without Aubio, Yaafe nor Vamp : it should be easier to install on old distributions for which those librairies are difficult or impossible to compile
* Encoder : add an Opus encoder
* Experimental : add a django web server with a REST API (see "Web server")
* AubioPitch: prevent NaN in result by converting them to zero
* Yaafe analyzer: simplify adaptation of process frames from TimeSide to Yaafe
* LimsiSad: add a default value for parameter sad_model
* Fix various NaN and Inf and PEP8 issues also many PyFlake warnings
* Full `Travis integration <https://travis-ci.org/yomguy/TimeSide/>`_ with tests and test coverage through `coveralls.io <https://coveralls.io/r/yomguy/TimeSide>`_
* Thanks to all contributors!
* WARNING: some of the processor paths used in your app could have moved between 0.5.4 and 0.5.5. Check them with timeside.core.processors(). Note that it is now advised to use the timeside.core.get_processor() method to instantiate the processors with their respective id as argument.
* UPGRADING from the sources: please remove all .pyc files from your repository.

0.5.4

* Encoder : transcoded streams where broken. Now fixed with some smart thread controls.
* Analyzer : update VAMP plugin example in sandbox
* Analyzer : new *experimental* plugin : Limsi Speech Activity Detection Systems (limsi_sad)
* Decoder : process any media in streaming mode giving its URL
* Install : fix some setup requirements

0.5.3

* Make Analyzer rendering more generic and easy to implement
* Analyzer : implement rendering capability for event and segment + add some more analyzer graphers
* Analyzer : refactoring the results rendering method. + Capability to use matplotlib in environnement with no display
* Decoder : Add a Live decoder to get data from the soundcard
* Decoder : add support for 96kHz sampling rate
* Encoder: live AudioSink encoder, encoder that plays the audio stream through the soundcard
* Grapher : add a generic Class to display Analyzers through their 'render' method. Add the new grapher file
* Grapher : add a generic Class to display Analyzers through their 'render' method. For now, it only support FrameValueResult analyzer
* Core : add a condition to catch signal only if a LiveDecoder source is used
* Various bugfixes

0.5.2

* Add a general launch script "timeside-launch" (see "Shell interface")
* Add some decorators to filter the inputs of processes (see analyzer.waveform for ex)
* Add a "stack" option to the FileDecoder to accumulate audio data allowing multipass processes
* Add beat confidence to aubio_temporal
* Add AAC encoder (gstreamer voaacenc plugin needed)
* Add UUIDs to the file URI and to all processors
* Add a Debian repository with all dependencies for i386 and amd64 architectures
* Fix buggy WebM encoder
* Fix buggy MP3 muxing
* Fix various minor bugs

0.5.1

* Add *parent* processor list to Processor
* Simplify and optimize the grapher system
* Add Grapher abstract generic class
* Add a UUID property to Processor
* Add a SpectrogramLinear grapher
* Add WaveformTransparent grapher
* Fix some assignment issues regarding immutable type in for Analyzer Result
* Simplify analyzer results implementation by introducing a Factory and multiple classes and subclasses to handle the 8 different kinds of results
* Add doctests and improve the unit tests
* Add a OnsetDetectionFunction analyzer
* Update documentation
* Various cleanups
* Various bugfixes

0.5.0

* Deep refactoring of the analyzer API to handle various new usecases, specifically audio feature extraction
* Add serializable global result container (NEW dependency to h5py, json, yaml)
* Add new audio feature extraction analyzers thanks to the Aubio library providing beat & BPM detection, pitch dectection and other cool stuff (NEW dependency on aubio)
* Add new audio feature extraction analyzers thanks to the Yaafe library (NEW dependency on yaafe)
* Add new IRIT speech detection analyzers (NEW dependency on scipy)
* EXPERIMENTAL : add new audio feature extraction thanks to the VAMP plugin library (NEW dependency on some vamp tools)
* Add new documentation : http://files.parisson.com/timeside/doc/
* New Debian repository for instant install
* Various bugfixes
* Comptatible with Python >=2.7
* WARNING : no longer compatible with Telemeta 1.4.5

For older news, please visit: https://github.com/yomguy/TimeSide/blob/master/NEWS.rst

Dive in
========
Expand Down Expand Up @@ -292,7 +221,6 @@ Optional:
aubio (>=0.4.1) yaafe python-aubio python-yaafe vamp-examples
django (>=1.4) django-south djangorestframework django-extensions


User Interfaces
===============

Expand Down Expand Up @@ -342,6 +270,10 @@ Of course, TimeSide can be used in any python environment. But, a shell script i
-o <outputdir>, --ouput-directory=<outputdir>
output directory


Find some preset examples in examples/presets/


Web player
-----------

Expand Down Expand Up @@ -376,7 +308,7 @@ An EXPERIMENTAL web server based on Django has been added to the package from ve

A sandbox is provided in timeside/server/sandbox and you can initialize it and test it like this::

cd timeside/server/sandbox
cd examples/sandbox
./manage.py syncdb
./manage.py migrate
./manage.py runserver
Expand All @@ -385,7 +317,6 @@ and browse http://localhost:8000/api/

At the moment, this server is NOT connected to the player using TimeSide alone. Please use Telemeta.


Development
===========

Expand Down Expand Up @@ -458,7 +389,6 @@ To start a new development, it is advised to checkout the dev branch and build y
git checkout dev
sudo docker build .


Sponsors and Partners
=====================

Expand All @@ -478,8 +408,6 @@ Related projects
* `Sound archives <http://archives.crem-cnrs.fr/>`_ of the CNRS, CREM and the "Musée de l'Homme" in Paris, France.
* The `DIADEMS project <http://www.irit.fr/recherches/SAMOVA/DIADEMS/en/welcome/>`_ sponsored by the ANR.



Copyrights
==========

Expand All @@ -489,7 +417,7 @@ Copyrights
* Copyright (c) 2013, 2014 Thomas Fillon
* Copyright (c) 2013, 2014 Maxime Lecoz
* Copyright (c) 2013, 2014 David Doukhan
* Copyright (c) 2006, 2010 Samalyse SARL
* Copyright (c) 2006, 2010 Olivier Guilyardi


License
Expand Down

0 comments on commit 6604885

Please sign in to comment.