From: Thomas Fillon Date: Tue, 1 Oct 2013 12:15:36 +0000 (+0200) Subject: Create Sphinx/numpydoc documentation X-Git-Tag: 0.5.0~55 X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=3481684c38683830d2199bd63b463ba2c28b7d2e;p=timeside.git Create Sphinx/numpydoc documentation --- diff --git a/doc/Makefile b/doc/Makefile new file mode 100755 index 0000000..849b748 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/TimeSide.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TimeSide.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/TimeSide" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TimeSide" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 0000000..bd4c523 --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,65 @@ +======== + README +======== + +Installation +============ + +To build *TimeSide* documentation, you need first to install *Sphinx* and its *numpydoc* extension. + + +Installing Sphinx +----------------- +For accessing more complete instructions to install Sphinx on every platform see http://sphinx-doc.org/latest/install.html + + +Debian/Ubuntu: Install Sphinx using packaging system +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You may install using this command if you use Debian/Ubuntu. + +.. code-block:: bash + + $ apt-get install python-sphinx + +Installing Sphinx with easy_install +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you have *easy-install* on your system you can install Sphinx with : + +.. code-block:: bash + + $ easy_install sphinx + +After installation, type :command:`sphinx-build` on the command prompt. If +everything worked fine, you will get a Sphinx version number and a list of +options for this command. + + +Installing Sphinx extension Numpydoc +------------------------------------ +*Numpydoc* is a Sphinx extension to support docstrings in Numpy format +see https://pypi.python.org/pypi/numpydoc + +It can be *easilly install* with:: + +.. code-block:: bash + + $ easy_install numpydoc + + +Building the doc +================ + +From the ``doc`` directory, you need to run the following command to generate the HTML docs in the ``build`` directory:: + +.. code-block:: bash + + $ make html + + +*Doctest* can be performed by:: + +.. code-block:: bash + + $ make doctest diff --git a/doc/make.bat b/doc/make.bat new file mode 100755 index 0000000..8d7f45b --- /dev/null +++ b/doc/make.bat @@ -0,0 +1,190 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source +set I18NSPHINXOPTS=%SPHINXOPTS% source +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\TimeSide.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\TimeSide.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/doc/source/api/analyzer/analyzers.rst b/doc/source/api/analyzer/analyzers.rst new file mode 100644 index 0000000..9c15a75 --- /dev/null +++ b/doc/source/api/analyzer/analyzers.rst @@ -0,0 +1,73 @@ +=========== + Analyzers +=========== + +.. toctree:: + +Global analyzers +================ + +Mean DC Shift +------------- +.. automodule:: timeside.analyzer.dc + :members: + :undoc-members: + :show-inheritance: + +Level +----- +.. automodule:: timeside.analyzer.level + :members: + :undoc-members: + :show-inheritance: + + +Aubio +===== +**aubio** is a tool designed for the extraction of annotations from audio signals. Its features include segmenting a sound file before each of its attacks, performing pitch detection, tapping the beat and producing midi streams from live audio. +See http://aubio.org/ + +Aubio Melenergy +--------------- +.. automodule:: timeside.analyzer.aubio_melenergy + :members: + :undoc-members: + :show-inheritance: + + +aubio_mfcc +---------- +.. automodule:: timeside.analyzer.aubio_mfcc + :members: + :undoc-members: + :show-inheritance: + +aubio_pitch +----------- +.. automodule:: timeside.analyzer.aubio_pitch + :members: + :undoc-members: + :show-inheritance: + +aubio_specdesc +-------------- +.. automodule:: timeside.analyzer.aubio_specdesc + :members: + :undoc-members: + :show-inheritance: + +aubio_temporal +-------------- +.. automodule:: timeside.analyzer.aubio_temporal + :members: + :undoc-members: + :show-inheritance: + + +Yaafe +===== +.. automodule:: timeside.analyzer.yaafe + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api/analyzer/core.rst b/doc/source/api/analyzer/core.rst new file mode 100644 index 0000000..9746305 --- /dev/null +++ b/doc/source/api/analyzer/core.rst @@ -0,0 +1,21 @@ +====== + Core +====== + +.. automodule:: timeside.analyzer.core + +New analyzer Result +******************* + +.. autoclass:: newAnalyzerResult + :members: + :undoc-members: + :show-inheritance: + +AnalyzerResultContainer +*********************** + +.. autoclass:: AnalyzerResultContainer + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/analyzer/index.rst b/doc/source/api/analyzer/index.rst new file mode 100644 index 0000000..d21dd91 --- /dev/null +++ b/doc/source/api/analyzer/index.rst @@ -0,0 +1,12 @@ +================ +Analyzer package +================ + +.. toctree:: + :maxdepth: 2 + + Analyzer Core module + Analyzers processors + + + diff --git a/doc/source/api/decoder/index.rst b/doc/source/api/decoder/index.rst new file mode 100644 index 0000000..b9bcdf8 --- /dev/null +++ b/doc/source/api/decoder/index.rst @@ -0,0 +1,12 @@ +=============== +Decoder package +=============== + + +.. toctree:: + :maxdepth: 2 + +.. automodule:: timeside.decoder.core + :members: + + diff --git a/doc/source/api/encoder/index.rst b/doc/source/api/encoder/index.rst new file mode 100644 index 0000000..6ec39f3 --- /dev/null +++ b/doc/source/api/encoder/index.rst @@ -0,0 +1,55 @@ +=============== +Encoder package +=============== + + +.. toctree:: + :maxdepth: 2 + +Core module +=========== + +.. automodule:: timeside.encoder.core + :members: + :undoc-members: + +Encoders +======== + +Flac encoder +------------ + +.. automodule:: timeside.encoder.flac + :members: + +Aac encoder +----------- + +.. automodule:: timeside.encoder.m4a + :members: + +Mp3 encoder +----------- + +.. automodule:: timeside.encoder.mp3 + :members: + +Vorbis encoder +-------------- + +.. automodule:: timeside.encoder.ogg + :members: + + +Wav encoder +----------- + +.. automodule:: timeside.encoder.wav + :members: + + +WebM encoder +------------ + +.. automodule:: timeside.encoder.webm + :members: diff --git a/doc/source/api/grapher/index.rst b/doc/source/api/grapher/index.rst new file mode 100644 index 0000000..8a1d0c9 --- /dev/null +++ b/doc/source/api/grapher/index.rst @@ -0,0 +1,40 @@ +======= +Grapher +======= + + +.. toctree:: + :maxdepth: 2 + +Core module +=========== +.. automodule:: timeside.grapher.core + :members: + +Graphers +======== + +Spectrogram +----------- +.. automodule:: timeside.grapher.spectrogram + :members: + +Waveform +----------- +.. automodule:: timeside.grapher.waveform + :members: + +Simple Waveform +--------------- +.. automodule:: timeside.grapher.waveform_simple + :members: + +Contour Waveform (white) +------------------------ +.. automodule:: timeside.grapher.waveform_contour_wh + :members: + +Contour Waveform (black) +------------------------ +.. automodule:: timeside.grapher.waveform_contour_bk + :members: diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst new file mode 100644 index 0000000..7c0d095 --- /dev/null +++ b/doc/source/api/index.rst @@ -0,0 +1,14 @@ +============ +TimeSide API +============ + + +.. toctree:: + :maxdepth: 2 + + + decoder/index + analyzer/index + encoder/index + grapher/index + diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..742b182 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,297 @@ +# -*- coding: utf-8 -*- +# +# TimeSide documentation build configuration file, created by +# sphinx-quickstart on Thu Aug 22 10:49:09 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', 'numpydoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage'] + +doctest_path = os.path.abspath('../../') + + +autodoc_default_flags = 'show-inheritance' + +#autosummary_generate = True +numpydoc_show_class_members = False + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'TimeSide' +copyright = u'2013, Guillaume Pellerin, Paul Brossier, Thomas Fillon' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +from timeside import __version__ as TimeSideVersion +# The short X.Y version. +version = '.'.join(TimeSideVersion.split('.')[0:2]) +# The full version, including alpha/beta/rc tags. +release = TimeSideVersion + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +modindex_common_prefix = ['timeside.'] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True +# This is required to remove the superfluous np module index added by numpydoc +html_domain_indices = ['py-modindex'] + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'TimeSidedoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'TimeSide.tex', u'TimeSide Documentation', + u'Guillaume Pellerin, Paul Brossier, Thomas Fillon', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'timeside', u'TimeSide Documentation', + [u'Guillaume Pellerin, Paul Brossier, Thomas Fillon'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'TimeSide', u'TimeSide Documentation', + u'Guillaume Pellerin, Paul Brossier, Thomas Fillon', 'TimeSide', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'TimeSide' +epub_author = u'Guillaume Pellerin, Paul Brossier, Thomas Fillon' +epub_publisher = u'Guillaume Pellerin, Paul Brossier, Thomas Fillon' +epub_copyright = u'2013, Guillaume Pellerin, Paul Brossier, Thomas Fillon' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst new file mode 100644 index 0000000..d17df1a --- /dev/null +++ b/doc/source/examples/index.rst @@ -0,0 +1,17 @@ +.. TimeSide documentation master file, created by + sphinx-quickstart on Thu Aug 22 10:49:09 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +============================================== +TimeSide : Examples +============================================== +Contents: + +.. toctree:: + :maxdepth: 2 + + Tutorial + Usage of the 'new' AnalyzerResult + + diff --git a/doc/source/examples/newAnalyzerResult.rst b/doc/source/examples/newAnalyzerResult.rst new file mode 100644 index 0000000..7415c7a --- /dev/null +++ b/doc/source/examples/newAnalyzerResult.rst @@ -0,0 +1,117 @@ +.. This file is part of TimeSide + @author: Thomas Fillon + +============================= + New analyzer Result example +============================= + +Example of use of the new analyzerResult structure + +Usage : newAnalyzerResult(dataMode=None, timeMode=None) + +See : :class:`timeside.analyzer.core.newAnalyzerResult` + +Default +======= + +Create a new analyzer result without arguments + + >>> import timeside.analyzer.core as coreA + >>> res = coreA.newAnalyzerResult() + +This default result has all the metadata and data attribute + + >>> res.keys() + ['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'frameMetadata', 'labelMetadata', 'parameters'] + + >>> for key,value in res.items(): + ... print '%s : %s' % (key, value) + ... + dataMode : None + timeMode : None + idMetadata : {'description': '', 'author': '', 'version': '', 'date': '', 'id': '', 'unit': '', 'name': ''} + data : {'duration': array([], dtype=float64), 'time': array([], dtype=float64), 'value': None, 'label': array([], dtype=int64)} + audioMetadata : {'duration': None, 'start': 0, 'channelsManagement': '', 'uri': '', 'channels': None} + frameMetadata : {'blocksize': None, 'samplerate': None, 'stepsize': None} + labelMetadata : {'labelType': 'mono', 'description': None, 'label': None} + parameters : {} + + +Specification of timeMode +========================= +Four different timeMode can be specified : + +- 'framewise' : Data are returned on a frame basis (i.e. with specified blocksize, stepsize and framerate) +- 'global' : A global data value is return for the entire audio item +- 'segment' : Data are returned on a segmnet basis (i.e. with specified start time and duration) +- 'event' : Data are returned on a segment basis (i.e. with specified start time) + + +Framewise +--------- + +>>> res = coreA.newAnalyzerResult(timeMode='framewise') +>>> res.keys() +['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'frameMetadata', 'labelMetadata', 'parameters'] + +Global +------ + +No frame metadata information is needed for these modes. +The 'frameMetadata' key/attribute is deleted. + +>>> res = coreA.newAnalyzerResult(timeMode='global') +>>> res.keys() +['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'labelMetadata', 'parameters'] +>>> res.data +AnalyzerData(value=None, label=array([], dtype=int64)) + +Segment +------- + +>>> res = coreA.newAnalyzerResult(timeMode='segment') +>>> res.keys() +['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'labelMetadata', 'parameters'] +>>> res.data +AnalyzerData(value=None, label=array([], dtype=int64), time=array([], dtype=float64), duration=array([], dtype=float64)) + +Event +----- + +>>> res = coreA.newAnalyzerResult(timeMode='event') +>>> res.keys() +['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'labelMetadata', 'parameters'] +>>> res.data +AnalyzerData(value=None, label=array([], dtype=int64), time=array([], dtype=float64)) + +Specification of dataMode +========================= +Two different dataMode can be specified : + +- 'value' : Data are returned as numpy Array of arbitrary type +- 'label' : Data are returned as label indexes (specified by the labelMetadata key) + +Value +----- +The labelMetadata key is deleted. + +>>> res = coreA.newAnalyzerResult(dataMode='value') +>>> res.keys() +['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'frameMetadata', 'parameters'] + +In the data key, the 'value' key is kept and the 'label' key is deleted. + +>>> res.data +AnalyzerData(value=None, time=array([], dtype=float64), duration=array([], dtype=float64)) + +Label +----- +>>> res = coreA.newAnalyzerResult(dataMode='label') +>>> res.keys() +['dataMode', 'timeMode', 'idMetadata', 'data', 'audioMetadata', 'frameMetadata', 'labelMetadata', 'parameters'] + +In the data key, the 'label' key is kept and the 'value' key is deleted. + + +>>> res.data +AnalyzerData(label=array([], dtype=int64), time=array([], dtype=float64), duration=array([], dtype=float64)) diff --git a/doc/source/examples/tutorial.rst b/doc/source/examples/tutorial.rst new file mode 100644 index 0000000..2a7aeac --- /dev/null +++ b/doc/source/examples/tutorial.rst @@ -0,0 +1,4 @@ +========== + Tutorial +========== + diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..2f65eba --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,27 @@ +.. TimeSide documentation master file, created by + sphinx-quickstart on Thu Aug 22 10:49:09 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +============================================== +TimeSide : open and fast web audio components +============================================== +Contents: + +.. toctree:: + :maxdepth: 2 + + intro + news + Installation + Examples + API + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/install.rst b/doc/source/install.rst new file mode 100644 index 0000000..e05bfef --- /dev/null +++ b/doc/source/install.rst @@ -0,0 +1,26 @@ + + + +Install +======= + +TimeSide needs some other python modules to run. The following methods explain how to install all dependencies on a Debian based system like Debian, Ubuntu, etc.. On Fedora and Red-Hat you might replace 'apt-get by 'yum', on Gentoo by 'emerge', or any other package manager you like : + +.. code-block:: bash + + $ sudo apt-get update + $ sudo apt-get install python python-pip python-setuptools python-gobject \ + python-gst0.10 gstreamer0.10-plugins-base gir1.2-gstreamer-0.10 \ + gstreamer0.10-plugins-good gstreamer0.10-plugins-bad \ + gstreamer0.10-plugins-ugly gobject-introspection python-mutagen \ + python-scipy python-h5py + + $ sudo pip install timeside + +To get non-free (MP3, MP4, AAC, etc) decoding and encoding features, add Debian Multimedia repository and install the modules : + +.. code-block:: bash + + $ echo "deb http://www.deb-multimedia.org stable main non-free" | sudo tee -a /etc/apt/sources.list + $ sudo apt-get update + $ apt-get install gstreamer0.10-lame gstreamer0.10-plugins-really-bad gstreamer0.10-plugins-ugly diff --git a/doc/source/intro.rst b/doc/source/intro.rst new file mode 100644 index 0000000..cc74218 --- /dev/null +++ b/doc/source/intro.rst @@ -0,0 +1,4 @@ +============== + Introduction +============== + diff --git a/doc/source/news.rst b/doc/source/news.rst new file mode 100644 index 0000000..bace789 --- /dev/null +++ b/doc/source/news.rst @@ -0,0 +1,60 @@ +News +===== + +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 +