Consolidate set_config and set_settings into update()

Consolidate set_config and set_settings into a single method and rename
it 'update' to match the naming used by OBS studio sources for
configuration management.

Signed-off-by: Grant Likely <grant.likely@secretlab.ca>

Author: glikely

src/ptz-device.cpp

@@ -256,7 +256,7 @@ void PTZDevice::getDefaults(OBSData config) const
 	obs_data_set_default_bool(config, "focus_invert", false);
 }
 
-void PTZDevice::set_config(OBSData config)
+void PTZDevice::update(OBSData config)
 {
 	getDefaults(config);
 
@@ -265,6 +265,7 @@ void PTZDevice::set_config(OBSData config)
 	OBSDataArrayAutoRelease preset_array = obs_data_get_array(config, "presets");
 	m_presetsModel.loadPresets(preset_array.Get());
 
+	setObjectName(obs_data_get_string(config, "name"));
 	pantilt_speed_max = obs_data_get_double(config, "pantilt_speed_max");
 	zoom_speed_max = obs_data_get_double(config, "zoom_speed_max");
 	focus_speed_max = obs_data_get_double(config, "focus_speed_max");
@@ -292,28 +293,6 @@ void PTZDevice::save(OBSData config) const
 	obs_data_set_array(config, "presets", preset_array);
 }
 
-void PTZDevice::set_settings(OBSData config)
-{
-	if (obs_data_has_user_value(config, "name"))
-		setObjectName(obs_data_get_string(config, "name"));
-	if (obs_data_has_user_value(config, "pantilt_speed_max"))
-		pantilt_speed_max = obs_data_get_double(config, "pantilt_speed_max");
-	if (obs_data_has_user_value(config, "zoom_speed_max"))
-		zoom_speed_max = obs_data_get_double(config, "zoom_speed_max");
-	if (obs_data_has_user_value(config, "focus_speed_max"))
-		focus_speed_max = obs_data_get_double(config, "focus_speed_max");
-	if (obs_data_has_user_value(config, "pan_invert"))
-		pan_invert = obs_data_get_bool(config, "pan_invert");
-	if (obs_data_has_user_value(config, "tilt_invert"))
-		tilt_invert = obs_data_get_bool(config, "tilt_invert");
-	if (obs_data_has_user_value(config, "zoom_invert"))
-		zoom_invert = obs_data_get_bool(config, "zoom_invert");
-	if (obs_data_has_user_value(config, "focus_invert"))
-		focus_invert = obs_data_get_bool(config, "focus_invert");
-	if (obs_data_has_user_value(config, "preset_max"))
-		m_presetsModel.setMaxPresets((int)obs_data_get_int(config, "preset_max"));
-}
-
 obs_properties_t *PTZDevice::get_obs_properties()
 {
 	obs_properties_t *rtn_props = obs_properties_create();

src/ptz-device.hpp

@@ -164,16 +164,15 @@ protected slots:
 	bool zoomChanged() const { return zoom_changed; }
 	bool focusChanged() const { return focus_changed; }
 
-	/* `config` is the device configuration, saved to the config file
-	 * `settings` are the dynamic state of the device which includes the
-	 * config.  Most of the data in settings is not saved in the config
-	 * file. `set_config()` is used to change saved config values, and
-	 * `set_settings()` is used to send commands to the camera to change
-	 * the state */
+	/* Device configuration methods
+	 * These match the pattern used by sources in OBS studio with the following methods:
+	 * `getDefaults()`: loads OBSData with default values for the device
+	 * `update()`: which informs the device of changes to the configuration
+	 * `save()`: Make sure device configuration is written to an OBSData
+	 */
 	virtual void getDefaults(OBSData defaults) const;
-	virtual void set_config(OBSData ptz_config);
+	virtual void update(OBSData ptz_config);
 	virtual void save(OBSData ptz_config) const;
-	virtual void set_settings(OBSData setting);
 
 	/* Properties describe how to display the settings in a GUI dialog */
 	virtual obs_properties_t *get_obs_properties();

src/ptz-onvif.cpp

@@ -747,7 +747,7 @@ PTZOnvif::PTZOnvif(OBSData config) : PTZDevice(config)
 	});
 	m_statusTimer.start();
 	getDefaults(config);
-	set_config(config);
+	update(config);
 }
 
 QString PTZOnvif::description()
@@ -822,9 +822,9 @@ void PTZOnvif::getDefaults(OBSData config) const
 	obs_data_set_default_double(config, "speed_boost", 1.0);
 }
 
-void PTZOnvif::set_config(OBSData config)
+void PTZOnvif::update(OBSData config)
 {
-	PTZDevice::set_config(config);
+	PTZDevice::update(config);
 	host = obs_data_get_string(config, "host");
 	port = (int)obs_data_get_int(config, "port");
 	username = obs_data_get_string(config, "username");

src/ptz-onvif.hpp

@@ -117,7 +117,7 @@ private slots:
 	QString description() override;
 
 	void getDefaults(OBSData config) const override;
-	void set_config(OBSData ptz_data) override;
+	void update(OBSData ptz_data) override;
 	void save(OBSData ptz_data) const override;
 
 	obs_properties_t *get_obs_properties() override;

src/ptz-pelco.cpp

@@ -141,7 +141,7 @@ void PTZPelco::zoom_speed_set(double speed)
 PTZPelco::PTZPelco(OBSData data) : PTZDevice(data), iface(NULL)
 {
 	getDefaults(data);
-	set_config(data);
+	update(data);
 	ptz_debug("pelco device created");
 }
 
@@ -156,9 +156,9 @@ void PTZPelco::getDefaults(OBSData config) const
 	obs_data_set_default_bool(config, "use_pelco_d", false);
 }
 
-void PTZPelco::set_config(OBSData config)
+void PTZPelco::update(OBSData config)
 {
-	PTZDevice::set_config(config);
+	PTZDevice::update(config);
 	const char *uartt = obs_data_get_string(config, "port");
 	use_pelco_d = obs_data_get_bool(config, "use_pelco_d");
 	address = (unsigned int)obs_data_get_int(config, "address");

src/ptz-pelco.hpp

@@ -57,7 +57,7 @@ class PTZPelco : public PTZDevice {
 	QString description() override;
 
 	void getDefaults(OBSData config) const override;
-	void set_config(OBSData ptz_data) override;
+	void update(OBSData ptz_data) override;
 	void save(OBSData config) const override;
 	obs_properties_t *get_obs_properties() override;
 

src/ptz-usb-cam.cpp

@@ -294,7 +294,7 @@ void PTZUSBCam::ptz_tick_callback(void *param, float seconds)
 PTZUSBCam::PTZUSBCam(OBSData config) : PTZDevice(config)
 {
 	getDefaults(config);
-	set_config(config);
+	update(config);
 	obs_add_tick_callback(ptz_tick_callback, this);
 }
 
@@ -308,9 +308,9 @@ QString PTZUSBCam::description()
 	return QString(obs_module_text("PTZ.UVC.Name"));
 }
 
-void PTZUSBCam::set_config(OBSData config)
+void PTZUSBCam::update(OBSData config)
 {
-	PTZDevice::set_config(config);
+	PTZDevice::update(config);
 	OBSDataArrayAutoRelease presetArray = obs_data_get_array(config, "presets_memory");
 	size_t count = obs_data_array_count(presetArray);
 	for (size_t i = 0; i < count; ++i) {

src/ptz-usb-cam.hpp

@@ -98,7 +98,7 @@ class PTZUSBCam : public PTZDevice {
 	void save(obs_data_t *settings) const;
 	QString description() override;
 
-	void set_config(OBSData ptz_data) override;
+	void update(OBSData ptz_data) override;
 	void save(OBSData ptz_data) const override;
 	obs_properties_t *get_obs_properties() override;
 

src/ptz-visca-tcp.cpp

@@ -12,7 +12,7 @@ PTZViscaOverTCP::PTZViscaOverTCP(OBSData config) : PTZVisca(config)
 {
 	address = 1;
 	getDefaults(config);
-	set_config(config);
+	update(config);
 	visca_socket.setSocketOption(QAbstractSocket::KeepAliveOption, 1);
 	connect(&visca_socket, &QTcpSocket::readyRead, this, &PTZViscaOverTCP::poll);
 	connect(&visca_socket, &QTcpSocket::stateChanged, this, &PTZViscaOverTCP::on_socket_stateChanged);
@@ -99,9 +99,9 @@ void PTZViscaOverTCP::getDefaults(OBSData config) const
 	obs_data_set_default_int(config, "port", 5678);
 }
 
-void PTZViscaOverTCP::set_config(OBSData config)
+void PTZViscaOverTCP::update(OBSData config)
 {
-	PTZVisca::set_config(config);
+	PTZVisca::update(config);
 	host = obs_data_get_string(config, "host");
 	port = (int)obs_data_get_int(config, "port");
 	connectSocket();

src/ptz-visca-tcp.hpp

@@ -34,7 +34,7 @@ private slots:
 	QString description() override;
 
 	void getDefaults(OBSData ptz_data) const override;
-	void set_config(OBSData ptz_data) override;
+	void update(OBSData ptz_data) override;
 	void save(OBSData config) const override;
 	obs_properties_t *get_obs_properties() override;
 };