UmsciAppConfiguration.h

Go to the documentation of this file.

/* Copyright (c) 2026, Christian Ahrens
 *
 * This file is part of Umsci <https://github.com/ChristianAhrens/Umsci>
 *
 * This tool is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This tool 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 this tool; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <JuceHeader.h>
 
#include <AppConfigurationBase.h>
 
 
#define Umsci_CONFIG_VERSION "1.0.0"
 
 
class UmsciAppConfiguration : public JUCEAppBasics::AppConfigurationBase
{
 
public:
    enum TagID
    {
        CONNECTIONCONFIG,   
        VISUCONFIG,         
        CONTROLCOLOUR,      
        LOOKANDFEEL,        
        CONTROLCONFIG,      
        CONTROLFORMAT,      
        UPMIXCONFIG,        
        CONTROLSIZE,        
        EXTERNALCONTROLCONFIG,  
        MIDIINPUTDEVICE,        
        MIDI_UPMIXROT,          
        MIDI_UPMIXSCALE,        
        MIDI_UPMIXHEIGHTSCALE,  
        MIDI_UPMIXANGLESTRETCH, 
        MIDI_UPMIXOFFSETX,      
        MIDI_UPMIXOFFSETY,      
        UPMIXSNAPSHOTCONFIG,    
        OSCINPUTPORT,           
        OSC_UPMIXROT,           
        OSC_UPMIXSCALE,         
        OSC_UPMIXHEIGHTSCALE,   
        OSC_UPMIXANGLESTRETCH,  
        OSC_UPMIXOFFSETX,       
        OSC_UPMIXOFFSETY        
    };
    static juce::String getTagName(TagID ID)
    {
        switch(ID)
        {
        case CONNECTIONCONFIG:
            return "CONNECTIONCONFIG";
        case VISUCONFIG:
            return "VISUCONFIG";
        case CONTROLCOLOUR:
            return "CONTROLCOLOUR";
        case LOOKANDFEEL:
            return "LOOKANDFEEL";
        case CONTROLCONFIG:
            return "CONTROLCONFIG";
        case CONTROLFORMAT:
            return "CONTROLFORMAT";
        case UPMIXCONFIG:
            return "UPMIXCONFIG";
        case CONTROLSIZE:
            return "CONTROLSIZE";
        case EXTERNALCONTROLCONFIG:
            return "EXTERNALCONTROLCONFIG";
        case MIDIINPUTDEVICE:
            return "MIDIINPUTDEVICE";
        case MIDI_UPMIXROT:
            return "MIDI_UPMIXROT";
        case MIDI_UPMIXSCALE:
            return "MIDI_UPMIXSCALE";
        case MIDI_UPMIXHEIGHTSCALE:
            return "MIDI_UPMIXHEIGHTSCALE";
        case MIDI_UPMIXANGLESTRETCH:
            return "MIDI_UPMIXANGLESTRETCH";
        case MIDI_UPMIXOFFSETX:
            return "MIDI_UPMIXOFFSETX";
        case MIDI_UPMIXOFFSETY:
            return "MIDI_UPMIXOFFSETY";
        case UPMIXSNAPSHOTCONFIG:
            return "UPMIXSNAPSHOTCONFIG";
        case OSCINPUTPORT:
            return "OSCINPUTPORT";
        case OSC_UPMIXROT:
            return "OSC_UPMIXROT";
        case OSC_UPMIXSCALE:
            return "OSC_UPMIXSCALE";
        case OSC_UPMIXHEIGHTSCALE:
            return "OSC_UPMIXHEIGHTSCALE";
        case OSC_UPMIXANGLESTRETCH:
            return "OSC_UPMIXANGLESTRETCH";
        case OSC_UPMIXOFFSETX:
            return "OSC_UPMIXOFFSETX";
        case OSC_UPMIXOFFSETY:
            return "OSC_UPMIXOFFSETY";
        default:
            return "INVALID";
        }
    };
 
    enum AttributeID
    {
        ENABLED,             
        IP,                  
        PORT,                
        IOSIZE,              
        UPMIXSOURCESTARTID,  
        UPMIXLIVEMODE,       
        UPMIXSHAPE,          
        UPMIXSHOWALLSOURCES  
    };
    static juce::String getAttributeName(AttributeID ID)
    {
        switch (ID)
        {
        case ENABLED:
            return "ENABLED";
        case IP:
            return "IP";
        case PORT:
            return "PORT";
        case IOSIZE:
            return "IOSIZE";
        case UPMIXSOURCESTARTID:
            return "UPMIXSOURCESTARTID";
        case UPMIXLIVEMODE:
            return "UPMIXLIVEMODE";
        case UPMIXSHAPE:
            return "UPMIXSHAPE";
        case UPMIXSHOWALLSOURCES:
            return "UPMIXSHOWALLSOURCES";
        default:
            return "-";
        }
    };
 
public:
    explicit UmsciAppConfiguration(const File &file);
    ~UmsciAppConfiguration() override;
 
    bool isValid() override;
    static bool isValid(const std::unique_ptr<juce::XmlElement>& xmlConfig);
 
    bool ResetToDefault();
 
protected:
    bool HandleConfigVersionConflict(const Version& configVersionFound) override;
 
private:
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(UmsciAppConfiguration)
};