Metadata-Version: 1.1
Name: TimeSide
Version: 0.5.1
Summary: open web audio processing framework
Home-page: https://github.com/yomguy/TimeSide/
Author: Guillaume Pellerin, Paul Brossier, Thomas Fillon, Riccardo Zaccarelli, Olivier Guilyardi
Author-email: yomguy@parisson.com, piem@piem.org, thomas@parisson.com, riccardo.zaccarelli@gmail.com, olivier@samalyse.com
License: Gnu Public License V2
Description: ==============================================
        TimeSide : open web audio processing framework
        ==============================================
        
        .. image:: https://secure.travis-ci.org/yomguy/TimeSide.png?branch=master
            :target: http://travis-ci.org/yomguy/TimeSide/
        
        TimeSide is a set of python components enabling audio analysis, imaging, transcoding and streaming. Its high-level API has been designed to enable complex processing on big media data corpus. Its simple plugin architecture can be adapted to various usecases.
        
        It also includes a smart HTML5 interactive user interface embeddable in any web application to provide various media format playback, on the fly transcoding and streaming, fancy waveforms and spectrograms, various low and high level audio analyzers, semantic labelling and segmentation.
        
        
        Goals
        =====
        
        We just **need** a python library to:
        
        * **Do** asynchronous and fast audio processing with Python,
        * **Decode** audio frames from ANY format into numpy arrays,
        * **Analyze** audio content with some state-of-the-art audio feature extraction libraries,
        * **Organize**, serialize and save analysis metadata through various formats,
        * **Draw** various fancy waveforms, spectrograms and other cool graphers,
        * **Transcode** audio data in various media formats and stream them through web apps,
        * **Playback** and **interact** **on demand** through a smart high-level HTML5 extensible player,
        * **Index**, **tag** and **organize semantic metadata** (see `Telemeta <http://telemeta.org>`_ which embed TimeSide).
        
        Here is a schematic diagram of the TimeSide engine architecture:
        
        .. image:: https://raw.github.com/yomguy/TimeSide/master/doc/slides/img/timeside_schema.png
        
        
        Processors
        ==========
        
        IEncoder
        ---------
        
          * VorbisEncoder [gst_vorbis_enc]
          * WavEncoder [gst_wav_enc]
          * Mp3Encoder [gst_mp3_enc]
          * FlacEncoder [gst_flac_enc]
          * AacEncoder [gst_aac_enc]
          * WebMEncoder [gst_webm_enc]
        
        IDecoder
        ---------
        
          * FileDecoder [gst_dec]
        
        IGrapher
        ---------
        
          * Waveform [waveform_simple]
          * WaveformCentroid [waveform_centroid]
          * WaveformTransparent [waveform_transparent]
          * WaveformContourBlack [waveform_contour_black]
          * WaveformContourWhite [waveform_contour_white]
          * SpectrogramLog [spectrogram_log]
          * SpectrogramLinear [spectrogram_linear]
        
        IAnalyzer
        ---------
        
          * IValueAnalyzer
            - Level [level]
            - MeanDCShift [mean_dc_shift]
          * AubioTemporal [aubio_temporal]
          * AubioPitch [aubio_pitch]
          * AubioMfcc [aubio_mfcc]
          * AubioMelEnergy [aubio_melenergy]
          * AubioSpecdesc [aubio_specdesc]
          * Yaafe [yaafe]
          * Spectrogram [spectrogram_analyzer]
          * Waveform [waveform_analyzer]
          * VampSimpleHost [vamp_simple_host]
          * IRITSpeechEntropy [irit_speech_entropy]
          * IRITSpeech4Hz [irit_speech_4hz]
          * OnsetDetectionFunction [odf]
        
        News
        =====
        
        0.5.1
        
         * Add *parent* procesor 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 toold)
         * 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
        
        0.4.5
        
         * (re)fix Pillow support (#12)
         * fix some Python package rules
         * add a Debian package directory (thanks to piem, in git repo only)
        
        0.4.4
        
         * Only setup bugfixes
         * Last compatible version with Python 2.6
         * Next version 0.5 will integrate serious new analyzer features (aubio, yaafe and more)
        
        0.4.3
        
         * finally fix decoder leaks and de-synchronizations (thanks to piem)
         * this also fixes bad variable encoder file lengths
         * fix OGG and FLAC encoders (closes: #8)
         * fix multi-channels streaming (closes: #13)
         * add support for Pillow (closes: #12)
         * temporally desactivate AAC and WebM encoders (need to add some limits for them)
         * WARNING : we now need to add overwrite=True to encoder kwargs instances in order to overwrite the destination file, i.e. e=Mp3Encoder(path, overwrite=True)
        
        0.4.2
        
         * many releases these days, but there are some patches which are really worth to be HOT released : we just need them in production..
         * finally fix FFT window border leaks in the streaming spectrum process for *really* better spectrograms and *smoother* spectral centroid waveforms
         * *mv* gstutils to timeside.gstutils
         * cleanup various processes
         * Ogg, Aac and Flac encoders not really working now (some frames missing) :( Will be fixed in next release.
        
        0.4.1
        
         * move UI static files from ui/ to static/timeside/ (for better django compatibility)
         * upgrade js scripts from telemeta 1.4.4
         * upgrade SoundManager2 to v297a-20120916
        
        0.4.0
        
         * finally fixed an old decoder bug to prevent memory leaks during hard process (thanks to piem)
         * add blocksize property to the processor API
         * add many unit tests (check tests/alltests.py)
         * re-add UI files (sorry, was missing in the last packages)
         * various bugfixes
         * encoders not all much tested on big files, please test!
         * piem is now preparing some aubio analyzers :P
        
        0.3.3
        
         * mostly a transitional developer and mantainer version, no new cool features
         * but add "ts-waveforms" script for waveform batching
         * fix some tests
         * removed but download audio samples
         * fix setup
         * update README
        
        0.3.2
        
         * move mainloop to its own thread to avoid memory hogging on large files
         * add condition values to prepare running gst mainloop in a thread
         * add experimental WebM encoder
         * duration analysis goes to decoder.duration property
         * bugfixes
        
        Dive in
        ========
        
        Define some processors::
        
         >>> import timeside
         >>> decoder  =  timeside.decoder.FileDecoder('sweep.wav')
         >>> grapher  =  timeside.grapher.Waveform()
         >>> analyzer =  timeside.analyzer.Level()
         >>> encoder  =  timeside.encoder.VorbisEncoder('sweep.ogg')
        
        then, the *magic* pipeline::
        
         >>> (decoder | grapher | analyzer | encoder).run()
        
        get the results::
        
         >>> grapher.render(output='waveform.png')
         >>> print 'Level:', analyzer.results
        
        
        API / Documentation
        ====================
        
        * General : http://files.parisson.com/timeside/doc/
        * Tutorial : http://files.parisson.com/timeside/doc/examples/index.html
        * API : http://files.parisson.com/timeside/doc/api/index.html
        
        Install
        =======
        
        TimeSide needs some other python modules to run. The following methods explain how to install all dependencies on various Linux based systems.
        
        On Debian, Ubuntu, etc:
        
        .. code-block:: bash
        
         $ echo "deb http://debian.parisson.com/debian/ stable main" | sudo tee -a /etc/apt/sources.list
         $ sudo apt-get update
         $ sudo apt-get install python-timeside
        
        On Fedora and Red-Hat:
        
        .. code-block:: bash
        
         $ sudo yum install gcc python python-devel gstreamer pygobject2 \
                           gstreamer-python gstreamer gstreamer-plugins-bad-free \
                           gstreamer-plugins-bad-free-extras \
                           gstreamer-plugins-base gstreamer-plugins-good
        
         $ sudo pip install timeside
        
        On other system, you'll need to install all dependencies and then::
        
         $ sudo pip install timeside
        
        
        Dependencies
        ============
        
        python (>=2.7), python-setuptools, python-gst0.10, gstreamer0.10-plugins-good, gstreamer0.10-gnonlin,
        gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py,
        python-scipy
        
        
        Platforms
        ==========
        
        The TimeSide engine is intended to work on all Unix / Linux platforms.
        MacOS X and Windows versions will soon be explorated.
        The player should work on any modern HTML5 enabled browser.
        Flash is needed for MP3 if the browser doesn't support it.
        
        User Interface
        ===============
        
        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
        
        Screenshot:
         .. image:: https://raw.github.com/yomguy/TimeSide/master/doc/slides/img/timeside_player_01.png
        
        Examples of the player embeded in the Telemeta open web audio CMS:
            * http://parisson.telemeta.org/archives/items/PRS_07_01_03/
            * http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/
        
        Development documentation:
            * https://github.com/yomguy/TimeSide/wiki/Ui-Guide
        
        TODO list:
            * embed a light http server to get commands through something like JSON RPC
            * zoom
            * layers
        
        Development
        ===========
        
        For versions >=0.5 on Debian Stable 7.0 Wheezy:
        
        .. code-block:: bash
        
         $ echo "deb http://debian.parisson.com/debian/ stable main" | sudo tee -a /etc/apt/sources.list
         $ echo "deb-src http://debian.parisson.com/debian/ stable main" | sudo tee -a /etc/apt/sources.list
         $ sudo apt-get update
         $ sudo apt-get install git
         $ sudo apt-get build-dep python-timeside
        
         $ git clone https://github.com/yomguy/TimeSide.git
         $ cd TimeSide
         $ git checkout dev
         $ export PYTHONPATH=$PYTHONPATH:`pwd`
         $ python tests/run_all_tests
        
        Sponsors and Patners
        ====================
        
            * `Parisson <http://parisson.com>`_
            * `CNRS <http://www.cnrs.fr>`_ (National Center of Science Research, France)
            * `Huma-Num <http://www.huma-num.fr/>`_ (big data equipment for digital humanities, ex TGE Adonis)
            * `CREM <http://www.crem-cnrs.fr>`_ (french National Center of Ethomusicology Research, France)
            * `Université Pierre et Marie Curie <http://www-upmc.fr>`_ (UPMC Paris, France)
            * `ANR <http://www.agence-nationale-recherche.fr/>`_ (CONTINT 2012 project : DIADEMS)
            * `MNHN <http://www.mnhn.fr>`_ : Museum National d'Histoire Naturelle (Paris, France)
        
        
        Related projects
        =================
        
            * `Telemeta <http://telemeta.org>`_ : open source web audio CMS
            * `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
        ==========
        
        * Copyright (c) 2006, 2013 Parisson SARL
        * Copyright (c) 2006, 2013 Guillaume Pellerin
        * Copyright (c) 2010, 2013 Paul Brossier
        * Copyright (c) 2013 Thomas Fillon
        * Copyright (c) 2006, 2010 Samalyse SARL
        
        
        License
        =======
        
        TimeSide is free software: you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 2 of the License, or
        (at your option) any later version.
        
        TimeSide is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.
        
        See LICENSE for more details.
        
Keywords: audio analysis features extraction transcoding graph plot HTML5 player metadata
Platform: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Topic :: Multimedia :: Sound/Audio :: Players
Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries :: Python Modules
