Settings Class Reference

#include <settings.hpp>

Collaboration diagram for Settings:

Public Member Functions
	Settings ()
Option &	addOption (std::string name, Option::OptType type, const std::string &param, const std::string &value="", bool enabled=true, const std::string &parent="", const std::string &limit="")
void	changedAll ()
std::string	getControlPort () const
std::string	getLaunchParams () const
Option &	getOption (const std::string &opt)
const Option &	getOption (const std::string &opt) const
const std::map< std::string, std::unique_ptr< Option > > &	getOptionMap () const
std::string	getPreviewParams () const
const std::string &	getSessRndKey () const
bool	isAdvancedMode ()
void	populateSettingsFromCapabilities (AvailableSettings *availSettings)

Private Member Functions
void	populateDeviceSettings (AvailableSettings *availSettings)
void	populateVideoCompressSettings (AvailableSettings *availSettings)

Private Attributes
const Option	dummy
std::map< std::string, std::unique_ptr< Option > >	options
std::string	sessRndKey

Detailed Description

Definition at line 91 of file settings.hpp.

Constructor & Destructor Documentation

Settings()

Settings::Settings

(

)

Definition at line 258 of file settings.cpp.

                   : dummy(this){
        std::random_device rd;
        std::mt19937 gen(rd());
        std::uniform_int_distribution<> bounds(0, ('9' - '0') + ('z' - 'a'));
        for(int i = 0; i < 8; i++){
                int rand = bounds(gen);
                if(rand <= 9)
                        sessRndKey += '0' + rand;
                else
                        sessRndKey += 'a' + (rand - 9);
        }
 
        for(const auto &i : optionList){
                auto &opt = addOption(i.name,
                                i.type,
                                i.param,
                                i.defaultVal,
                                i.enabled,
                                i.parent,
                                i.limit);
#ifdef DEBUG
                if(!i.parent[0])
                        opt.addOnChangeCallback(Option::Callback(test_callback, nullptr));
#endif
                (void) opt; //suppress unused warning
        }
 
        for(const auto &i : optionCallbacks){
                getOption(i.name).addOnChangeCallback(Option::Callback(i.callback, nullptr));
        }
 
        std::cout << getLaunchParams() << std::endl;
}

References Option::addOnChangeCallback(), addOption(), getLaunchParams(), getOption(), optionCallbacks, optionList, and sessRndKey.

Here is the call graph for this function:

Member Function Documentation

addOption()

Option & Settings::addOption	(	std::string	name,
		Option::OptType	type,
		const std::string &	param,
		const std::string &	value = "",
		bool	enabled = true,
		const std::string &	parent = "",
		const std::string &	limit = "" )

Definition at line 397 of file settings.cpp.

{
        if(!parent.empty())
                name = parent + "." + name;
 
        auto search = options.find(name);
 
        Option *opt;
 
        if(search == options.end()){
                std::unique_ptr<Option> newOption(new Option(this, name));
                opt = newOption.get();
                options[name] = std::move(newOption);
        } else {
                opt = search->second.get();
        }
 
        opt->setParam(param);
        opt->setType(type);
        opt->setValue(value);
        opt->setDefaultValue(value);
        opt->setEnabled(enabled);
 
        if(!parent.empty()){
                getOption(parent).addSuboption(opt, limit);
        }
 
        return *opt;
}

References Option::addSuboption(), enabled, getOption(), limit, name, param, parent, Option::setDefaultValue(), Option::setEnabled(), Option::setParam(), Option::setType(), Option::setValue(), and type.

Referenced by Settings(), addDevOpt(), populateDeviceSettings(), and populateVideoCompressSettings().

Here is the call graph for this function:

changedAll()

void Settings::changedAll

(

)

Definition at line 437 of file settings.cpp.

                         {
        for(auto &i : options){
                i.second->changed();
        }
}

Referenced by UltragridWindow::loadSettingsFile().

getControlPort()

std::string Settings::getControlPort

(

)

const

Definition at line 292 of file settings.cpp.

                                        {
        if(getOption("network.control_port.random").isEnabled())
                return "0";
 
        return getOption("network.control_port").getValue();
}

References getOption(), and Option::getValue().

Referenced by getLaunchParams(), and getPreviewParams().

Here is the call graph for this function:

getLaunchParams()

std::string Settings::getLaunchParams

(

)

const

Definition at line 299 of file settings.cpp.

                                         {
        std::string out;
 
        out += getOption("extraOpts").getLaunchOption();
 
        if(getOption("preview").isEnabled()){
                out += " --capture-filter preview";
                out += ":key=" + getSessRndKey();
        }
 
        out += getOption("video.source").getLaunchOption();
        out += getOption("video.compress").getLaunchOption();
        const auto &dispOpt = getOption("video.display");
        if(dispOpt.isEnabled()){
                if(getOption("preview").isEnabled()){
                        out += dispOpt.getParam();
                        out += "multiplier:" + dispOpt.getValue() + dispOpt.getSubVals();
                        out += "#preview";
                        out += ":key=" + getSessRndKey();
                } else {
                        out += getOption("video.display").getLaunchOption();
                }
        } else {
                if(getOption("preview").isEnabled()){
                        out += dispOpt.getParam();
                        out += "preview";
                        out += ":key=" + getSessRndKey();
                }
        }
 
        out += " --audio-filter controlport_stats";
        out += getOption("audio.source").getLaunchOption();
        out += getOption("audio.source.channels").getLaunchOption();
        out += getOption("audio.compress").getLaunchOption();
        std::string audioPlay = getOption("audio.playback").getLaunchOption();
        if(audioPlay.empty() && getOption("preview").isEnabled()){
                audioPlay = " -r dummy";
        }
        out += audioPlay;
        out += getOption("network.fec").getLaunchOption();
        out += getOption("encryption").getLaunchOption();
        out += getOption("network.port").getLaunchOption();
        out += getOption("network.control_port").getParam();
        out += getControlPort();
        out += getOption("network.destination").getLaunchOption();
        out += getOption("decode.hwaccel").getLaunchOption();
        out += getOption("errors_fatal").getLaunchOption();
        return out;
}

References getControlPort(), Option::getLaunchOption(), getOption(), Option::getParam(), and getSessRndKey().

Referenced by Settings(), UltragridWindow::setArgs(), and SettingsUi::test().

Here is the call graph for this function:

getOption() [1/2]

Option & Settings::getOption

(

const std::string &

opt

)

Definition at line 371 of file settings.cpp.

                                               {
        auto search = options.find(opt);
 
        if(search == options.end()){
                std::unique_ptr<Option> newOption(new Option(this, opt));
                auto p = newOption.get();
                options[opt] = std::move(newOption);
                return *p;
        }
 
        return *search->second;
}

getOption() [2/2]

const Option & Settings::getOption

(

const std::string &

opt

)

const

Definition at line 384 of file settings.cpp.

                                                           {
        auto search = options.find(opt);
 
        if(search == options.end())
                return dummy;
 
        return *search->second;
}

References dummy.

Referenced by Settings(), WidgetUi::~WidgetUi(), SettingsUi::addCallbacks(), addOption(), audioCompressionCallback(), CheckableUi::boxClicked(), RadioButtonUi::btnClicked(), UltragridWindow::checkPreview(), conditionsSatisfied(), fec_auto_callback(), fec_builder_callback(), getControlPort(), getLaunchParams(), CheckableUi::getOptValue(), TextOptUi::getOptValue(), getPreviewParams(), isAdvancedMode(), ComboBoxUi::itemSelected(), UltragridWindow::loadSettingsFile(), RadioButtonUi::optChangeCallback(), WidgetUi::registerCustomCallback(), ComboBoxUi::selectOption(), UltragridWindow::setupPreviewCallbacks(), TextOptUi::textEdited(), RadioButtonUi::updateUiState(), and videoCompressBitrateCallback().

getOptionMap()

const std::map< std::string, std::unique_ptr< Option > > & Settings::getOptionMap

(

)

const

Definition at line 393 of file settings.cpp.

                                                                            {
        return options;
}

References options.

Referenced by UltragridWindow::saveSettings().

getPreviewParams()

std::string Settings::getPreviewParams

(

)

const

Definition at line 349 of file settings.cpp.

                                          {
        std::string out;
 
        out += getOption("extraOpts").getLaunchOption();
 
        out += " --capture-filter preview";
        out += ":key=" + getSessRndKey();
        out += ",every:0";
        out += getOption("video.source").getLaunchOption();
        out += " -d preview";
        out += ":key=" + getSessRndKey();
        out += " --audio-filter controlport_stats#discard";
        out += getOption("audio.source").getLaunchOption();
        out += getOption("audio.source.channels").getLaunchOption();
        out += " -r dummy";
        out += getOption("network.control_port").getParam();
        out += getControlPort();
        out += getOption("encryption").getLaunchOption();
 
        return out;
}

References getControlPort(), Option::getLaunchOption(), getOption(), Option::getParam(), and getSessRndKey().

Referenced by UltragridWindow::launchPreview().

Here is the call graph for this function:

getSessRndKey()

const std::string & Settings::getSessRndKey ( ) const

inline

Definition at line 117 of file settings.hpp.

{ return sessRndKey; }

References sessRndKey.

Referenced by getLaunchParams(), getPreviewParams(), and UltragridWindow::initializeUgOpts().

isAdvancedMode()

bool Settings::isAdvancedMode

(

)

Definition at line 433 of file settings.cpp.

                             {
        return getOption("advanced").getValue() == "t";
}

References getOption(), and Option::getValue().

Here is the call graph for this function:

populateDeviceSettings()

void Settings::populateDeviceSettings ( AvailableSettings * availSettings )

private

Definition at line 453 of file settings.cpp.

                                                                     {
        struct{
                SettingType type;
                const char *optPrefix;
        } devTypes[] = {
                {VIDEO_SRC, "video.source"},
                {VIDEO_DISPLAY, "video.display"},
                {AUDIO_SRC, "audio.source"},
                {AUDIO_PLAYBACK, "audio.playback"},
        };
 
        for(const auto& devType : devTypes){
                for(const auto& dev : availSettings->getDevices(devType.type)){
                        addDevOpt(this, dev, devType.optPrefix);
 
                        for(const auto& devOpt : dev.opts){
                                addOption(dev.deviceOpt + "." + devOpt.key,
                                                devOpt.booleanOpt ? Option::BoolOpt : Option::StringOpt,
                                                devOpt.optStr,
                                                "",
                                                false,
                                                std::string(devType.optPrefix) + "." + dev.type + ".device",
                                                dev.deviceOpt);
                        }
                }
        }
}

References addDevOpt(), addOption(), Option::BoolOpt, AvailableSettings::getDevices(), Option::StringOpt, and type.

Referenced by populateSettingsFromCapabilities().

Here is the call graph for this function:

populateSettingsFromCapabilities()

void Settings::populateSettingsFromCapabilities

(

AvailableSettings *

availSettings

)

Definition at line 518 of file settings.cpp.

                                                                               {
        populateDeviceSettings(availSettings);
        populateVideoCompressSettings(availSettings);
}

References populateDeviceSettings(), and populateVideoCompressSettings().

Here is the call graph for this function:

populateVideoCompressSettings()

void Settings::populateVideoCompressSettings ( AvailableSettings * availSettings )

private

Definition at line 481 of file settings.cpp.

                                                                            {
        for(const auto& mod : availSettings->getVideoCompressModules()){
                addOption(mod.name + ".codec",
                                Option::SilentOpt,
                                "",
                                "",
                                false,
                                "video.compress",
                                mod.name);
 
                for(const auto& modOption: mod.opts){
                        addOption(mod.name + "." + modOption.key,
                                        modOption.booleanOpt ? Option::BoolOpt : Option::StringOpt,
                                        modOption.optStr,
                                        "",
                                        false,
                                        "video.compress",
                                        mod.name
                                        );
                }
        }
 
        for(const auto& codec : availSettings->getVideoCompressCodecs()){
                std::string optName = "video.compress.";
                optName += codec.module_name;
                optName += ".codec";
 
                addOption(codec.name + ".encoder",
                                Option::StringOpt,
                                "",
                                codec.encoders[0].optStr,
                                true,
                                optName,
                                codec.name);
        }
}

References addOption(), Option::BoolOpt, codec::encoders, AvailableSettings::getVideoCompressCodecs(), AvailableSettings::getVideoCompressModules(), codec::name, Option::SilentOpt, and Option::StringOpt.

Referenced by populateSettingsFromCapabilities().

Here is the call graph for this function:

Member Data Documentation

dummy

const Option Settings::dummy

private

Definition at line 128 of file settings.hpp.

Referenced by getOption().

options

std::map<std::string, std::unique_ptr<Option> > Settings::options

private

Definition at line 124 of file settings.hpp.

Referenced by getOptionMap().

sessRndKey

std::string Settings::sessRndKey

private

Definition at line 126 of file settings.hpp.

Referenced by Settings(), and getSessRndKey().

---

The documentation for this class was generated from the following files:

• gui/QT/option/settings.hpp
• gui/QT/option/settings.cpp