StatServer.h

Go to the documentation of this file.

/*
        This file is part of ALIZE which is an open-source tool for 
        speaker recognition.

    ALIZE is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as 
    published by the Free Software Foundation, either version 3 of 
    the License, or any later version.

    ALIZE 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public 
    License along with ALIZE.
    If not, see <http://www.gnu.org/licenses/>.
        
        ALIZE is a development project initiated by the ELISA consortium
        [alize.univ-avignon.fr/] and funded by the French Research 
        Ministry in the framework of the TECHNOLANGUE program 
        [www.technolangue.net]

        The ALIZE project team wants to highlight the limits of voice
        authentication in a forensic context.
        The "Person  Authentification by Voice: A Need of Caution" paper 
        proposes a good overview of this point (cf. "Person  
        Authentification by Voice: A Need of Caution", Bonastre J.F., 
        Bimbot F., Boe L.J., Campbell J.P., Douglas D.A., Magrin-
        chagnolleau I., Eurospeech 2003, Genova].
        The conclusion of the paper of the paper is proposed bellow:
        [Currently, it is not possible to completely determine whether the 
        similarity between two recordings is due to the speaker or to other 
        factors, especially when: (a) the speaker does not cooperate, (b) there 
        is no control over recording equipment, (c) recording conditions are not 
        known, (d) one does not know whether the voice was disguised and, to a 
        lesser extent, (e) the linguistic content of the message is not 
        controlled. Caution and judgment must be exercised when applying speaker 
        recognition techniques, whether human or automatic, to account for these 
        uncontrolled factors. Under more constrained or calibrated situations, 
        or as an aid for investigative purposes, judicious application of these 
        techniques may be suitable, provided they are not considered as infallible.
        At the present time, there is no scientific process that enables one to 
        uniquely characterize a person=92s voice or to identify with absolute 
        certainty an individual from his or her voice.]
        Contact Jean-Francois Bonastre for more information about the licence or
        the use of ALIZE

        Copyright (C) 2003-2010
        Laboratoire d'informatique d'Avignon [lia.univ-avignon.fr]
        ALIZE admin [alize@univ-avignon.fr]
        Jean-Francois Bonastre [jean-francois.bonastre@univ-avignon.fr]
*/

#if !defined(ALIZE_StatServer_h)
#define ALIZE_StatServer_h

#if defined(_WIN32)
#if defined(ALIZE_EXPORTS)
#define ALIZE_API __declspec(dllexport)
#else
#define ALIZE_API __declspec(dllimport)
#endif
#else
#define ALIZE_API
#endif

#include "Object.h"
#include "alizeString.h"
#include "LKVector.h"
#include "ViterbiAccum.h"
#include "MixtureStat.h"

#if defined(__GNUC__)
#define DEPRECATED(func) func __attribute__ ((deprecated))
#elif defined(_MSC_VER)
#define DEPRECATED(func) __declspec(deprecated) func
#else
#pragma message("WARNING: You need to implement DEPRECATED for this compiler")
#define DEPRECATED(func) func
#endif

namespace alize
{
  class Config;
  class FrameAcc;
  class FrameAccGD;
  class FrameAccGF;
  class MixtureGDStat;
  class MixtureGFStat;
  class MixtureServer;
  class Mixture;
  class MixtureGF;
  class MixtureGD;
  class MixtureStat;


  class ALIZE_API StatServer : public Object
  {
    friend class TestStatServer;
    friend class TestMixtureGDStat;

  public :

    explicit StatServer(const Config& c);

    explicit StatServer(const Config& c, MixtureServer& ms);

    virtual ~StatServer();

    void reset();
    
    lk_t computeLLK(const Mixture& m, const Feature& f) const;
    
    lk_t computeLLK(const Mixture& m, const Feature& f, unsigned long idx) const;

    void computeAllDistribLK(const Feature& f);

    const LKVector& getTopDistribIndexVector() const;

    void setTopDistribIndexVector(const ULongVector& indexVect,
                                  real_t sumNonTopDistribWeights,
                                  real_t sumNonTopDistribLK);

    DEPRECATED(real_t getAccumulatedOccFeatureCount(const Mixture& m));

    void resetLLK(const Mixture& m);
    
    DEPRECATED(lk_t getLLK(const Mixture& m));
    
    lk_t computeAndAccumulateLLK(const Mixture& m, const Feature& f,
                     const TopDistribsAction& a = TOP_DISTRIBS_NO_ACTION);

    lk_t computeAndAccumulateLLK(const Mixture& m, const Feature& f,
             double w, const TopDistribsAction& a = TOP_DISTRIBS_NO_ACTION);

    DEPRECATED(void accumulateLLK(const Mixture& m, double l, double w = 1.0));
    
    lk_t getMeanLLK(const Mixture& m);
    
    DEPRECATED(lk_t computeAndAccumulateLLK(const Mixture& m));

    DEPRECATED(void resetOcc(const Mixture& m));

    DEPRECATED(real_t computeAndAccumulateOcc(const Mixture& m, const Feature& f));

    DEPRECATED(occ_t* getMeanOccVect(const Mixture& m));

    DEPRECATED(occ_t* getAccumulatedOccVect(const Mixture& m));

    DEPRECATED(occ_t getAccumulatedOcc(const Mixture& m));

    DEPRECATED(void resetEM(const Mixture& m));
  
    DEPRECATED(occ_t computeAndAccumulateEM(const Mixture& m, const Feature&));

    DEPRECATED(const Mixture& getEM(const Mixture& m));

    //--------------------------------------------------------------------

    MixtureStat& createAndStoreMixtureStat(const Mixture& m);

    MixtureGDStat& createAndStoreMixtureStat(MixtureGD& m);

    MixtureGFStat& createAndStoreMixtureStat(MixtureGF& m);

    MixtureGDStat& createAndStoreMixtureGDStat(Mixture& m);

    MixtureGFStat& createAndStoreMixtureGFStat(Mixture& m);

    unsigned long getMixtureStatCount() const;

    MixtureStat& getMixtureStat(unsigned long idx);

    MixtureGDStat& getMixtureGDStat(unsigned long idx);

    MixtureGFStat& getMixtureGFStat(unsigned long idx);

    void deleteMixtureStat(MixtureStat& m);

    void deleteMixtureStat(unsigned long begin, unsigned long end);

    void deleteAllMixtureStat();

    unsigned long getMixtureStatIndex(MixtureStat& m) const;
    
    //--------------------------------------------------------------------

    ViterbiAccum& createViterbiAccum();

    //--------------------------------------------------------------------

    static FrameAccGD createFrameAccGD();

    static FrameAccGF createFrameAccGF();

    //--------------------------------------------------------------------
    
    const String& getServerName() const;

    void setServerName(const String& s);

    virtual String getClassName() const;

    virtual String toString() const;

    // INTERNAL USAGE
    
    const DoubleVector& getDistribLKVector(const K&) const;
    LKVector& getTopDistribIndexVector(const K&);
    lk_t computeLLK(const K&, const Mixture&) const;
    lk_t computeLLK(const K&, const Mixture& m, const Feature& f,
                              const TopDistribsAction& a);
        // LIUM, sylvain
    lk_t computeLLK(const K&, const Mixture& m, const Feature& f,
                              const LKVector & lkVect);                                                   
  private :

    String                  _serverName;
    const Config&           _config;
    DoubleVector            _distribLKVect;
    MixtureServer*          _pMixtureServer;
    RefVector<MixtureStat>  _mixtureStatVect;
    RefVector<ViterbiAccum> _viterbiAccumVect;
    const Mixture*          _pLastMixture;
    MixtureStat*            _pLastMixtureStat;
    LKVector                _topDistribsVect; // For top distributions management
    const lk_t              _minLLK;
    const lk_t              _maxLLK;

    lk_t computeLLK(lk_t lk) const;

    MixtureStat& getMixtureStat(const Mixture& m); 
    StatServer(const StatServer&); 
    const StatServer& operator=(const StatServer&); 
    bool operator==(const StatServer&) const; 
    bool operator!=(const StatServer&) const; 
  };

} // end namespace alize

#endif // !defined(ALIZE_StatServer_h)