Source.h

Go to the documentation of this file.

/*
 * Copyright 2014 Martin Hansen
 *
 * This file is part of SPAOP (Spatial Audio Object Positioner).
 * 
 * SPAOP 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.
 * 
 * SPAOP 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 SPAOP.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SOURCE_H_INCLUDED
#define SOURCE_H_INCLUDED

#include <iostream>
#include <sstream>
#include <iomanip>
#include <stdint.h>
#include "Colours.h"
#include "WonderHeader.h"

#define ANGLE_MAX 360.0
#define ANGLE_MIN 0.0

#define NORMALIZE(min, max, val) ((val)-(min)) / ((max)-(min))
#define DENORMALIZE(min, max, val) ((val) * ((max)-(min))) + (min)

#define SATURATE(x) ((x) < 0.0) ? 0.0 : (((x) > 1.0) ? 1.0 : (x)) 

#define COORD_NORM(x)   NORMALIZE(COORD_MIN, COORD_MAX, (x))
#define COORD_DENORM(x) DENORMALIZE(COORD_MIN, COORD_MAX, (x))

namespace wonder {

class Source
{
public:
    
    Source(int id=0);
    
    virtual ~Source();
    
    //==============================================================================
    // Enums:
    
    enum AutomatedParameters
    {
        typeParam = 0,  
        xPosParam,      
        yPosParam,      
        angleParam,     
        dopplParam,     
        totalNumParams  
    };
    
    enum SourceTypes
    {
        plane = 0,      
        point           
    };
    
    //==============================================================================
    // Methods for (automated) parameters by index:
    
    int getNumParameters() const;
    
    float getParameter (int index) const;
    
    void setParameter (int index, float newValue);
    
    void setParameterUnnormalized(int index, float newUnnormalizedValue);
    
    const std::string getParameterName (int index) const;
    
    const std::string getParameterText (int index) const;
    
    static std::string getParameterTextByValue (int index, float value);
    
    float getParameterByText(int index, const std::string& parameterText) const;
    
    static float getParameterDefaultValue (int index);
    
    static float normalizeParameter (int index, float unnormalized);
    
    static float denormalizeParameter (int index, float normalized);
    
    float getDenormalizedParameter (int index) const;
    
    bool getBooleanizedParameter (int index) const;
    
    //==============================================================================
    // For convenience: getters on the same parameters by name (denormalized):
    
    int getType() const;
    
    float getXPos() const;

    float getYPos() const;
    
    float getAngle() const;
    
    bool dopplerIsEnabled() const;

    
    //==============================================================================
    // Methods for other parameters:
    
    int getID() const;
    
    bool setID(int id);
    
    std::string getName() const;
    
    void setName(const std::string& name);
    
    const Colour getCoulour() const;
    
    void setColour(uint8_t red, uint8_t green, uint8_t blue);
    
    void setColour(Colour colour);
    
    uint8_t getRed() const;

    void setRed(uint8_t red);
    
    uint8_t getGreen() const;
    
    void setGreen(uint8_t green);
    
    uint8_t getBlue() const;
    
    void setBlue(uint8_t blue);
    
    bool isActive() const;
    
    void setIsActive(bool isActive);
    
private:
    float params_[totalNumParams];      // the (normalized) parameters
    int id_;                            // the WONDER-specific source ID
    std::string name_;                  // the source's name in WONDER
    Colour colour_;                     // the colour the source is displayed in
    bool active_;                       // source has been activated
    
    static std::string floatString(float f);
};

}

#endif  // SOURCE_H_INCLUDED