From 005f93c590cdac01a55b3fd41032fd9795d161a1 Mon Sep 17 00:00:00 2001 From: yomguy Date: Mon, 12 Nov 2012 11:56:46 +0100 Subject: [PATCH] cleanup --- README.rst | 2 +- timeside/api.py | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 2af8a54..861719b 100644 --- a/README.rst +++ b/README.rst @@ -7,7 +7,7 @@ TimeSide : open and fast web audio components TimeSide is a set of python components enabling easy audio processing, transcoding, imaging and streaming. Its simple architecture and high-level API have been design to process serial pipelines. -It includes a powerfull HTM5 interactive player which can be embedded in any web application to provide fancy waveforms, various analyzer results, synced time metadata display during playback and remote indexing. +It includes a powerfull HTM5 interactive player which can be embedded in any web application to provide fancy waveforms, various analyzer results, synced time metadata display during playback (time-marking) and remote indexing. The engine (server side) is fully written in Python, the player (client side) in HTML, CSS and JavaScript. diff --git a/timeside/api.py b/timeside/api.py index 9832360..6185286 100644 --- a/timeside/api.py +++ b/timeside/api.py @@ -19,8 +19,10 @@ # You should have received a copy of the GNU General Public License # along with TimeSide. If not, see . + from timeside.component import Interface + class IProcessor(Interface): """Common processor interface""" @@ -79,6 +81,7 @@ class IProcessor(Interface): # implementations should always call the parent method + class IEncoder(IProcessor): """Encoder driver interface. Each encoder is expected to support a specific format.""" @@ -125,6 +128,7 @@ class IEncoder(IProcessor): It isn't required to call this method, but if called, it must be before process().""" + class IDecoder(IProcessor): """Decoder driver interface. Decoders are different of encoders in that a given driver may support several input formats, hence this interface doesn't @@ -172,6 +176,7 @@ class IGrapher(IProcessor): """Return a PIL Image object visually representing all of the data passed by repeatedly calling process() and write the image to the output if specified""" + class IAnalyzer(IProcessor): """Media item analyzer driver interface. This interface is abstract, it doesn't describe a particular type of analyzer but is rather meant to group analyzers. @@ -194,6 +199,7 @@ class IAnalyzer(IProcessor): def unit(): """Return the unit of the data such as "dB", "seconds", etc... """ + class IValueAnalyzer(IAnalyzer): """Interface for analyzers which return a single numeric value from result()""" @@ -205,6 +211,7 @@ class IValueAnalyzer(IAnalyzer): """Return a human readable string containing both result and unit ('5.30dB', '4.2s', etc...)""" + class IEffect(IProcessor): """Effect processor interface""" -- 2.39.5