xmmPhrase.hpp

Go to the documentation of this file.

/*
 * xmmPhrase.hpp
 *
 * Multimodal data phrase
 *
 * Contact:
 * - Jules Francoise <jules.francoise@ircam.fr>
 *
 * This code has been initially authored by Jules Francoise
 * <http://julesfrancoise.com> during his PhD thesis, supervised by Frederic
 * Bevilacqua <href="http://frederic-bevilacqua.net>, in the Sound Music
 * Movement Interaction team <http://ismm.ircam.fr> of the
 * STMS Lab - IRCAM, CNRS, UPMC (2011-2015).
 *
 * Copyright (C) 2015 UPMC, Ircam-Centre Pompidou.
 *
 * This File is part of XMM.
 *
 * XMM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * XMM 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with XMM.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef xmmPhrase_h
#define xmmPhrase_h

#include "../common/xmmAttribute.hpp"
#include "../common/xmmEvents.hpp"
#include "../common/xmmJson.hpp"
#include <cmath>

namespace xmm {
enum class MemoryMode {
    OwnMemory,

    SharedMemory
};

enum class Multimodality {
    Unimodal,

    Bimodal
};

class Phrase;

class PhraseEvent {
  public:
    enum class Type {
        LabelChanged,
    };

    PhraseEvent(Phrase* phrase_, Type type_) : phrase(phrase_), type(type_) {}

    PhraseEvent(PhraseEvent const& src) : phrase(src.phrase), type(src.type) {}

    Phrase* phrase;

    Type type;
};

class Phrase : public Writable {
  public:
    friend class TrainingSet;

    Phrase(MemoryMode memoryMode = MemoryMode::OwnMemory,
           Multimodality multimodality = Multimodality::Unimodal);

    Phrase(Phrase const& src);

    explicit Phrase(Json::Value const& root);

    Phrase& operator=(Phrase const& src);

    virtual ~Phrase();


    bool ownMemory() const;

    bool bimodal() const;



    unsigned int size() const;

    unsigned int inputSize() const;

    unsigned int outputSize() const;

    bool empty() const;

    float getValue(unsigned int index, unsigned int dim) const;

    float* getPointer(unsigned int index) const;

    float* getPointer_input(unsigned int index) const;

    float* getPointer_output(unsigned int index) const;



    void connect(float* pointer_to_data, unsigned int length);

    void connect(float* pointer_to_data_input, float* pointer_to_data_output,
                 unsigned int length);

    void connect_input(float* pointer_to_data, unsigned int length);

    void connect_output(float* pointer_to_data, unsigned int length);

    void disconnect();



    void record(std::vector<float> const& observation);

    void record_input(std::vector<float> const& observation);

    void record_output(std::vector<float> const& observation);

    void clear();
    void clearInput();
    void clearOutput();



    Json::Value toJson() const;

    void fromJson(Json::Value const& root);



    std::vector<float> mean() const;

    std::vector<float> standardDeviation() const;

    std::vector<std::pair<float, float>> minmax() const;

    void rescale(std::vector<float> offset, std::vector<float> gain);


    Attribute<unsigned int> dimension;

    Attribute<unsigned int> dimension_input;

    Attribute<std::string> label;

    std::vector<std::string> column_names;

  protected:
    void trim();

    void reallocateLength();

    virtual void onAttributeChange(AttributeBase* attr_pointer);

    static const unsigned int AllocationBlockSize = 256;

    bool own_memory_;

    bool bimodal_;

    bool empty_;

    unsigned int length_;

    unsigned int input_length_;

    unsigned int output_length_;

    unsigned int max_length_;

    float** data_;

    EventGenerator<PhraseEvent> events;
};

template <typename T>
T* reallocate(T* src, unsigned int dim_src, unsigned int dim_dst) {
    T* dst = new T[dim_dst];

    if (!src) return dst;

    if (dim_dst > dim_src) {
        std::copy(src, src + dim_src, dst);
    } else {
        std::copy(src, src + dim_dst, dst);
    }
    delete[] src;
    return dst;
}
}

#endif