rc_configuration.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2018 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2009-2010 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2009-2014 David Robillard <d@drobilla.net>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <map>
#include <string>
 
#include "temporal/types.h"
 
#include "ardour/libardour_visibility.h"
#include "ardour/types.h"
#include "ardour/utils.h"
#include "ardour/types_convert.h"
 
#include "pbd/configuration.h"
 
class XMLNode;
 
namespace ARDOUR {
 
class LIBARDOUR_API RCConfiguration : public PBD::Configuration
{
  public:
        RCConfiguration();
        ~RCConfiguration();
 
        void map_parameters (std::function<void (std::string)>&);
        int set_state (XMLNode const &, int version);
        XMLNode& get_state () const;
        XMLNode& get_variables (std::string const & nodename) const;
        void set_variables (XMLNode const &);
 
        int load_state ();
        int save_state ();
 
        void add_instant_xml (XMLNode&);
        XMLNode * instant_xml (const std::string& str);
 
        XMLNode* control_protocol_state () { return _control_protocol_state; }
        XMLNode* transport_master_state () { return _transport_master_state; }
 
        std::map<std::string,PBD::ConfigVariableBase*> _my_variables;
 
        /* define accessor methods */
 
#undef  CONFIG_VARIABLE
#undef  CONFIG_VARIABLE_SPECIAL
#define CONFIG_VARIABLE(Type,var,name,value) \
        Type get_##var () const { return var.get(); } \
        bool set_##var (Type val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret;  }
#define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) \
        Type get_##var () const { return var.get(); } \
        bool set_##var (Type val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret; }
#include "ardour/rc_configuration_vars.inc.h"
#undef  CONFIG_VARIABLE
#undef  CONFIG_VARIABLE_SPECIAL
 
  private:
 
        /* declare variables */
 
#undef  CONFIG_VARIABLE
#undef  CONFIG_VARIABLE_SPECIAL
#define CONFIG_VARIABLE(Type,var,name,value) PBD::ConfigVariable<Type> var;
#define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) PBD::ConfigVariableWithMutation<Type> var;
#include "ardour/rc_configuration_vars.inc.h"
#undef  CONFIG_VARIABLE
#undef  CONFIG_VARIABLE_SPECIAL
 
        XMLNode* _control_protocol_state;
        XMLNode* _transport_master_state;
 
        void build_metadata ();
};
 
/* XXX: rename this */
LIBARDOUR_API extern RCConfiguration *Config;
LIBARDOUR_API extern gain_t speed_quietning; /* see comment in configuration.cc */
 
} // namespace ARDOUR