Chris@37: /*
Chris@37:     jVamp
Chris@37: 
Chris@37:     A Java host interface for Vamp audio analysis plugins
Chris@37: 
Chris@37:     Centre for Digital Music, Queen Mary, University of London.
Chris@37:     Copyright 2012 Chris Cannam and QMUL.
Chris@37:   
Chris@37:     Permission is hereby granted, free of charge, to any person
Chris@37:     obtaining a copy of this software and associated documentation
Chris@37:     files (the "Software"), to deal in the Software without
Chris@37:     restriction, including without limitation the rights to use, copy,
Chris@37:     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@37:     of the Software, and to permit persons to whom the Software is
Chris@37:     furnished to do so, subject to the following conditions:
Chris@37: 
Chris@37:     The above copyright notice and this permission notice shall be
Chris@37:     included in all copies or substantial portions of the Software.
Chris@37: 
Chris@37:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@37:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@37:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@37:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@37:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@37:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@37:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@37: 
Chris@37:     Except as contained in this notice, the names of the Centre for
Chris@37:     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@37:     shall not be used in advertising or otherwise to promote the sale,
Chris@37:     use or other dealings in this Software without prior written
Chris@37:     authorization.
Chris@37: */
Chris@18: 
Chris@18: package org.vamp_plugins;
Chris@18: 
Chris@28: /**
Chris@28:  * Feature contains a single result returned from Plugin.process() or
Chris@28:  * Plugin.getRemainingFeatures().
Chris@28:  */
Chris@18: public class Feature {
Chris@28:     /**
Chris@28:      * True if an output feature has its own timestamp.  This is
Chris@28:      * mandatory if the output has VariableSampleRate, optional if
Chris@28:      * the output has FixedSampleRate, and unused if the output
Chris@28:      * has OneSamplePerStep.
Chris@28:      */
Chris@18:     public boolean hasTimestamp;
Chris@28: 
Chris@28:     /**
Chris@28:      * Timestamp of the output feature.  This is mandatory if the
Chris@28:      * output has VariableSampleRate or if the output has
Chris@28:      * FixedSampleRate and hasTimestamp is true, and unused
Chris@28:      * otherwise.
Chris@28:      */
Chris@18:     public RealTime timestamp;
Chris@28: 
Chris@28:     /**
Chris@28:      * True if an output feature has a specified duration.  This
Chris@28:      * is optional if the output has VariableSampleRate or
Chris@28:      * FixedSampleRate, and and unused if the output has
Chris@28:      * OneSamplePerStep.
Chris@28:      */
Chris@18:     public boolean hasDuration;
Chris@28: 
Chris@28:     /**
Chris@28:      * Duration of the output feature.  This is mandatory if the
Chris@28:      * output has VariableSampleRate or FixedSampleRate and
Chris@28:      * hasDuration is true, and unused otherwise.
Chris@28:      */
Chris@18:     public RealTime duration;
Chris@28: 	
Chris@28:     /**
Chris@28:      * Results for a single sample of this feature.  If the output
Chris@28:      * hasFixedBinCount, there must be the same number of values
Chris@28:      * as the output's binCount count.
Chris@28:      */
Chris@18:     public float[] values;
Chris@28: 
Chris@28:     /**
Chris@28:      * Label for the sample of this feature.
Chris@28:      */
Chris@18:     public String label;
Chris@28: 
Chris@18:     Feature() {
Chris@18: 	hasTimestamp = false; hasDuration = false;
Chris@18:     }
Chris@18: };
Chris@18: