Metadata-Version: 2.4
Name: opensmile
Version: 2.6.0
Summary: Python wrapper for common openSMILE feature sets
Author: Christop Hausner
Author-email: Johannes Wagner <jwagner@audeering.com>, Hagen Wierstorf <hwierstorf@audeering.com>
License:   openSMILE 
           - open-source Speech and Music Interpretation by Large-space Extraction -
        
          Copyright (c) audEERING GmbH, Gilching, Germany. All rights reserved. 
          http://www.audeering.com/
        
          Copyright (c) 2016-2020, audEERING GmbH
          Copyright (c) 2013-2015, audEERING UG (haftungsbeschraenkt)
          Copyright (c) 2008-2013, Institute for Human-Machine Communication, 
                                   Technische Universitaet Muenchen, Germany
         
        Licensing terms & your rights
        =============================
          
        ********************************************************************** 
         If you use openSMILE or any code from openSMILE in your research work,
         you are kindly asked to acknowledge the use of openSMILE in your 
         publications. See the file CITING for details.
        **********************************************************************
        
        This audEERING Research License Agreement (license, license agreement, 
        or agreement in the ongoing), is a legal agreement between you 
        and audEERING GmbH, Gilching, Germany (audEERING or we in the following) 
        for the software or data identified above, which may include source code, 
        and any associated materials, text or speech files, 
        associated media and "online" or electronic documentation 
        (together, the "Software").  
        
        By installing, copying, or otherwise using this Software, 
        you agree to be bound by the terms in this license. 
        If you do not agree, you may not install, copy or use the Software. 
        The Software is protected by copyright and other intellectual 
        property laws and is licensed, not sold.
        
        This license grants you the following rights:
        A. You may use, copy, reproduce, and distribute this Software 
           for any non-commercial purpose, subject to the restrictions 
           set out below. Some purposes which can be non-commercial are teaching, 
           academic research, public demonstrations and personal experimentation 
           or personal home use. You may also distribute this Software with 
           books or other teaching materials, or publish the Software on websites, 
           that are intended to teach the use of the Software for academic or 
           other non-commercial purposes. 
           You may NOT use or distribute this Software or any derivative works 
           in any form for commercial purposes, except those outlined in (B). 
           Examples of commercial purposes are running business operations, 
           licensing, leasing, or selling the Software, distributing the 
           Software for use with commercial products (no matter whether free or paid), 
           using the Software in the creation or use of commercial products or any 
           other activity which purpose is to procure a commercial gain to you or 
           others (except for conditions set out in (B)).
        B. Further, you may use the software for commercial research, which meets
           the following conditions: commercial research which is not directly
           associated with product development and has the primary purpose of 
           publishing and sharing results with the academic world; pre-product 
           evaluations of algorithms and methods, as long as these evaluations
           are more of an evaluatory, planning, and research nature than 
           of a product development nature. 
           Any further commercial use requires you to obtain a commercial
           license or written approval from audEERING GmbH which grants
           you extended usage rights for this software. In particular any direct 
           (software) or indirect (models, features extracted with the software)
           use of the software, parts of the software, or derivatives in a 
           product (no matter whether free or paid), is not allowed without 
           an additional commercial license.
        C. If the software includes source code or data, you may create 
           derivative works of such portions of the software and distribute the 
           modified software for non-commercial purposes, as provided herein.
           If you distribute the software or any derivative works of the Software, 
           you must distribute them under the same terms and conditions as in this
           license, and you must not grant other rights to the software or 
           derivative works that are different from those provided by this 
           license agreement. 
           If you have created derivative works of the software, and distribute 
           such derivative works, you will cause the modified files to carry 
           prominent notices so that recipients know that they are not receiving 
           the original software. Such notices must state: 
           (i) that you have altered the software; 
           and (ii) the date of any changes as well as your name.
        
        In return for the above rights, you agree:
        1. That you will not remove any copyright or other notices (authors 
           and citing information, for example) from the software.
        2. That if any of the software is in binary format, you will not attempt 
           to modify such portions of the software, or to reverse engineer or 
           decompile them, except and only to the extent authorized by applicable 
           law. 
        3. That the copyright holders (audEERING) are granted back, 
           without any restrictions or limitations, a non-exclusive, perpetual, 
           irrevocable, royalty-free, assignable and sub-licensable license, 
           to reproduce, publicly perform or display, install, use, modify, post, 
           distribute, make and have made, sell and transfer your modifications 
           to and/or derivative works of the software source code or data, 
           for any purpose.  
        4. That any feedback about the software provided by you to us is voluntarily 
           given, and audEERING shall be free to use the feedback 
           as they see fit without obligation or restriction of any kind, 
           even if the feedback is designated by you as confidential. 
        
        5. THAT THE SOFTWARE COMES "AS IS", WITH NO WARRANTIES. 
           THIS MEANS NO EXPRESS, IMPLIED OR STATUTORY WARRANTY, INCLUDING 
           WITHOUT LIMITATION, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A 
           PARTICULAR PURPOSE, ANY WARRANTY AGAINST INTERFERENCE WITH YOUR 
           ENJOYMENT OF THE SOFTWARE OR ANY WARRANTY OF TITLE OR NON-INFRINGEMENT.
           THERE IS NO WARRANTY THAT THIS SOFTWARE WILL FULFILL ANY OF YOUR 
           PARTICULAR PURPOSES OR NEEDS. ALSO, YOU MUST PASS THIS DISCLAIMER ON 
           WHENEVER YOU DISTRIBUTE THE SOFTWARE OR DERIVATIVE WORKS.
           
        6. THAT NEITHER AUDEERING NOR ANY AUTHOR OR CONTRIBUTOR TO THE 
           SOFTWARE WILL BE LIABLE FOR ANY DAMAGES RELATED TO THE SOFTWARE OR THIS 
           LICENSE, INCLUDING DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL OR INCIDENTAL 
           DAMAGES, TO THE MAXIMUM EXTENT THE LAW PERMITS, NO MATTER WHAT LEGAL 
           THEORY IT IS BASED ON. ALSO, YOU MUST PASS THIS LIMITATION OF LIABILITY 
           ON WHENEVER YOU DISTRIBUTE THE SOFTWARE OR DERIVATIVE WORKS.
           
        7. That we have no duty of reasonable care or lack of negligence, 
           and we are not obligated to (and will not) provide technical support for 
           the Software.
        8. That if you breach this license agreement or if you sue anyone over 
           patents that you think may apply to or read on the software or anyone's 
           use of the software, this license agreement (and your license and rights 
           obtained herein) terminate automatically. Upon any such termination, 
           you shall destroy all of your copies of the software immediately.  
           Sections 3, 4, 5, 6, 7, 10 and 11 of this license agreement shall survive 
           any termination of this license agreement.
        9. That the patent rights, if any, granted to you in this license agreement 
           only apply to the software, not to any derivative works you make.
        10.That the software may be subject to European export or import laws or such 
           laws in other places. You agree to comply with all such laws and regulations 
           that may apply to the software after the delivery of the software to you.
        11.That all rights not expressly granted to you in this license agreement 
           are reserved by audEERING.
        12.That this license agreement shall be construed and controlled by the laws 
           of the Federal Republic of Germany, without regard to conflicts of law. 
           If any provision of this license agreement shall be deemed unenforceable 
           or contrary to law, the rest of this license agreement shall remain in 
           full effect and interpreted in an enforceable manner that most closely 
           captures the intent of the original language. 
        
        
        Commercial license options
        ==========================
         
        For commercial and other licensing options, please contact us at audEERING 
        via e-mail: 
        
           info@audeering.com 
        
        
        Third-party contributions and dependencies
        ==========================================
        
        openSMILE uses a number of third-party components for which you can 
        find the licensing terms in the folder "licenses".
        
        As part of the build process, a number of third-party CMake modules
        are used. Please see the license notices in the folder "cmake".
        
Project-URL: repository, https://github.com/audeering/opensmile-python/
Project-URL: documentation, https://audeering.github.io/opensmile-python/
Keywords: audio,tools,feature,opensmile,audeering
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: audobject>=0.6.1
Requires-Dist: audinterface>=0.7.0
Dynamic: license-file

================
openSMILE Python
================

|tests| |coverage| |docs| |python-versions| |license| 

Python interface for extracting openSMILE_ features.

.. code-block::

    $ pip install opensmile

.. note:: Only 64-bit Python is supported.

Feature sets
------------

Currently, three standard sets are supported.
`ComParE 2016`_ is the largest with more than 6k features.
The smaller sets GeMAPS_ and  eGeMAPS_
come in variants ``v01a``, ``v01b`` and ``v02`` (only eGeMAPS_).
We suggest to use the latest version
unless backward compatibility with
the original papers is desired.

Each feature set can be extracted on two levels:

* Low-level descriptors (LDD)
* Functionals

For `ComParE 2016`_ a third level is available:

* LLD deltas

.. note:: Pre v2.0.0 some LLDs of the GeMAPS family were incorrectly output
    as deltas. This was corrected with v2.0.0 and these features are now
    correctly returned as LLDs. Note that with v2.0.0 deltas are no
    longer available for the GeMAPS family.

The following table lists the number of features
for each set and level.

With v2.0.0
~~~~~~~~~~~

============  ==============
Name          #features
============  ==============
ComParE_2016  65 / 65 / 6373
GeMAPSv01a    18 / - / 62
GeMAPSv01b    18 / - / 62
eGeMAPSv01a   23 / - / 88
eGeMAPSv01b   23 / - / 88
eGeMAPSv02    25 / - / 88
============  ==============

.. note:: Additional feature sets have been added by the community.
    For a full list please see the documentation of ``opensmile.FeatureSet``.

Pre v2.0.0
~~~~~~~~~~

============  ==============
Name          #features
============  ==============
ComParE_2016  65 / 65 / 6373
GeMAPSv01a    5 / 13 / 62
GeMAPSv01b    5 / 13 / 62
eGeMAPSv01a   10 / 13 / 88
eGeMAPSv01b   10 / 13 / 88
============  ==============

Code example
------------

Code example,
that extracts `ComParE 2016`_  functionals from an audio file:

.. code-block:: python

    import opensmile

    smile = opensmile.Smile(
        feature_set=opensmile.FeatureSet.ComParE_2016,
        feature_level=opensmile.FeatureLevel.Functionals,
    )
    y = smile.process_file('audio.wav')

License
-------

openSMILE follows a dual-licensing model. Since the main goal of the project
is a widespread use of the software to facilitate research in the field of
machine learning from audio-visual signals, the source code and binaries are
freely available for private, research, and educational use under an open-source license
(see LICENSE).
It is not allowed to use the open-source version of openSMILE for any sort of commercial product.
Fundamental research in companies, for example, is permitted, but if a product is the result of
the research, we require you to buy a commercial development license.
Contact us at info@audeering.com (or visit us at https://www.audeering.com) for more information.

Original authors: Florian Eyben, Felix Weninger, Martin Wöllmer, Björn Schuller

Copyright © 2008-2013, Institute for Human-Machine Communication, Technische Universität München, Germany

Copyright © 2013-2015, audEERING UG (haftungsbeschränkt)

Copyright © 2016-2020, audEERING GmbH

Citing
------

Please cite openSMILE in your publications by citing the following paper:

    Florian Eyben, Martin Wöllmer, Björn Schuller: "openSMILE - The Munich Versatile and Fast Open-Source Audio Feature Extractor", Proc. ACM Multimedia (MM), ACM, Florence, Italy, ISBN 978-1-60558-933-6, pp. 1459-1462, 25.-29.10.2010.


.. _openSMILE: https://github.com/audeering/opensmile
.. _ComParE 2016: http://www.tangsoo.de/documents/Publications/Schuller16-TI2.pdf
.. _GeMAPS: https://sail.usc.edu/publications/files/eyben-preprinttaffc-2015.pdf
.. _eGeMAPS: https://sail.usc.edu/publications/files/eyben-preprinttaffc-2015.pdf
.. _audformat: https://github.com/audeering/audformat

.. badges images and links:
.. |tests| image:: https://github.com/audeering/opensmile-python/workflows/Test/badge.svg
    :target: https://github.com/audeering/opensmile-python/actions?query=workflow%3ATest
    :alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/opensmile-python/branch/main/graph/badge.svg?token=PUA9P2UJW1
    :target: https://codecov.io/gh/audeering/opensmile-python
    :alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/opensmile?label=docs
    :target: https://audeering.github.io/opensmile-python/
    :alt: opensmile's documentation
.. |license| image:: https://img.shields.io/badge/license-audEERING-red.svg
    :target: https://github.com/audeering/opensmile-python/blob/main/LICENSE
    :alt: opensmile's audEERING license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/opensmile.svg
    :target: https://pypi.org/project/opensmile/
    :alt: opensmile's supported Python versions
