Change semantics of obs-data default values

Default values are now permanently stored in the obs_data_items and
can be accessed via the new get_default functions

Also default values are no longer serialized to JSON to ease transition
to new default values

libobs/obs-data.c

@@ -33,6 +33,8 @@ struct obs_data_item {
 	enum obs_data_type   type;
 	size_t               name_len;
 	size_t               data_len;
+	size_t               data_size;
+	size_t               default_size;
 	size_t               capacity;
 };
 
@@ -58,6 +60,12 @@ struct obs_data_number {
 /* ------------------------------------------------------------------------- */
 /* Item structure, designed to be one allocation only */
 
+static inline size_t get_align_size(size_t size)
+{
+	const size_t alignment = base_get_alignment();
+	return (size + alignment - 1) & ~(alignment - 1);
+}
+
 /* ensures data after the name has alignment (in case of SSE) */
 static inline size_t get_name_align_size(const char *name)
 {
@@ -76,14 +84,32 @@ static inline char *get_item_name(struct obs_data_item *item)
 	return (char*)item + sizeof(struct obs_data_item);
 }
 
-static inline void *get_item_data(struct obs_data_item *item)
+static inline void *get_data_ptr(obs_data_item_t item)
 {
 	return (uint8_t*)get_item_name(item) + item->name_len;
 }
 
+static inline void *get_item_data(struct obs_data_item *item)
+{
+	if (!item->data_size && !item->default_size)
+		return NULL;
+	return get_data_ptr(item);
+}
+
+static inline void *get_default_data_ptr(obs_data_item_t item)
+{
+	return (uint8_t*)get_data_ptr(item) + item->data_len;
+}
+
+static inline void *get_item_default_data(struct obs_data_item *item)
+{
+	return item->default_size ? get_default_data_ptr(item) : NULL;
+}
+
 static inline size_t obs_data_item_total_size(struct obs_data_item *item)
 {
-	return sizeof(struct obs_data_item) + item->data_len + item->name_len;
+	return sizeof(struct obs_data_item) + item->name_len +
+		item->data_len + item->default_size;
 }
 
 static inline obs_data_t get_item_obj(struct obs_data_item *item)
@@ -94,6 +120,14 @@ static inline obs_data_t get_item_obj(struct obs_data_item *item)
 	return *(obs_data_t*)get_item_data(item);
 }
 
+static inline obs_data_t get_item_default_obj(struct obs_data_item *item)
+{
+	if (!item || !item->default_size)
+		return NULL;
+
+	return *(obs_data_t*)get_item_data(item);
+}
+
 static inline obs_data_array_t get_item_array(struct obs_data_item *item)
 {
 	if (!item)
@@ -102,8 +136,20 @@ static inline obs_data_array_t get_item_array(struct obs_data_item *item)
 	return *(obs_data_array_t*)get_item_data(item);
 }
 
+static inline obs_data_array_t get_item_default_array(
+		struct obs_data_item *item)
+{
+	if (!item || !item->default_size)
+		return NULL;
+
+	return *(obs_data_array_t*)get_item_data(item);
+}
+
 static inline void item_data_release(struct obs_data_item *item)
 {
+	if (!obs_data_item_has_user_value(item))
+		return;
+
 	if (item->type == OBS_DATA_OBJECT) {
 		obs_data_t obj = get_item_obj(item);
 		obs_data_release(obj);
@@ -114,6 +160,18 @@ static inline void item_data_release(struct obs_data_item *item)
 	}
 }
 
+static inline void item_default_data_release(struct obs_data_item *item)
+{
+	if (item->type == OBS_DATA_OBJECT) {
+		obs_data_t obj = get_item_default_obj(item);
+		obs_data_release(obj);
+
+	} else if (item->type == OBS_DATA_ARRAY) {
+		obs_data_array_t array = get_item_default_array(item);
+		obs_data_array_release(array);
+	}
+}
+
 static inline void item_data_addref(struct obs_data_item *item)
 {
 	if (item->type == OBS_DATA_OBJECT) {
@@ -126,8 +184,24 @@ static inline void item_data_addref(struct obs_data_item *item)
 	}
 }
 
+static inline void item_default_data_addref(struct obs_data_item *item)
+{
+	if (!item->data_size)
+		return;
+
+	if (item->type == OBS_DATA_OBJECT) {
+		obs_data_t obj = get_item_default_obj(item);
+		obs_data_addref(obj);
+
+	} else if (item->type == OBS_DATA_ARRAY) {
+		obs_data_array_t array = get_item_default_array(item);
+		obs_data_array_addref(array);
+	}
+}
+
 static struct obs_data_item *obs_data_item_create(const char *name,
-		const void *data, size_t size, enum obs_data_type type)
+		const void *data, size_t size, enum obs_data_type type,
+		bool default_data)
 {
 	struct obs_data_item *item;
 	size_t name_size, total_size;
@@ -143,9 +217,16 @@ static struct obs_data_item *obs_data_item_create(const char *name,
 	item->capacity = total_size;
 	item->type     = type;
 	item->name_len = name_size;
-	item->data_len = size;
 	item->ref      = 1;
 
+	if (default_data) {
+		item->default_size = size;
+
+	} else {
+		item->data_len = size;
+		item->data_size = size;
+	}
+
 	strcpy(get_item_name(item), name);
 	memcpy(get_item_data(item), data, size);
 
@@ -213,10 +294,23 @@ static struct obs_data_item *obs_data_item_ensure_capacity(
 static inline void obs_data_item_destroy(struct obs_data_item *item)
 {
 	item_data_release(item);
+	item_default_data_release(item);
 	obs_data_item_detach(item);
 	bfree(item);
 }
 
+static inline void move_data(obs_data_item_t old_item, void *old_data,
+		obs_data_item_t item, void *data, size_t len)
+{
+	ptrdiff_t old_offset = (uint8_t*)old_data - (uint8_t*)old_item;
+	ptrdiff_t new_offset = (uint8_t*)data - (uint8_t*)item;
+
+	if (!old_data)
+		return;
+
+	memmove((uint8_t*)item + new_offset, (uint8_t*)item + old_offset, len);
+}
+
 static inline void obs_data_item_setdata(
 		struct obs_data_item **p_item, const void *data, size_t size,
 		enum obs_data_type type)
@@ -225,12 +319,20 @@ static inline void obs_data_item_setdata(
 		return;
 
 	struct obs_data_item *item = *p_item;
+	void *old_non_user_data = get_default_data_ptr(item);
 	item_data_release(item);
 
-	item->data_len = size;
-	item->type     = type;
+	item->data_size = size;
+	item->type      = type;
+	item->data_len  = item->default_size ? 
+		get_align_size(size) : size;
 	item = obs_data_item_ensure_capacity(item);
 
+	if (item->default_size)
+		move_data(*p_item, old_non_user_data, item,
+				get_default_data_ptr(item),
+				item->default_len + item->autoselect_size);
+
 	if (size) {
 		memcpy(get_item_data(item), data, size);
 		item_data_addref(item);
@@ -239,6 +341,30 @@ static inline void obs_data_item_setdata(
 	*p_item = item;
 }
 
+static inline void obs_data_item_set_default_data(
+		struct obs_data_item **p_item, const void *data, size_t size,
+		enum obs_data_type type)
+{
+	if (!p_item || !*p_item)
+		return;
+
+	struct obs_data_item *item = *p_item;
+	item_default_data_release(item);
+
+	item->type         = type;
+	item->default_size = size;
+	item->data_len     = item->data_size ?
+				get_align_size(item->data_size) : 0;
+	item = obs_data_item_ensure_capacity(item);
+
+	if (size) {
+		memcpy(get_item_default_data(item), data, size);
+		item_default_data_addref(item);
+	}
+
+	*p_item = item;
+}
+
 /* ------------------------------------------------------------------------- */
 
 static void obs_data_add_json_item(obs_data_t data, const char *key,
@@ -367,12 +493,15 @@ static inline void set_json_array(json_t *json, const char *name,
 static json_t *obs_data_to_json(obs_data_t data)
 {
 	json_t *json = json_object();
-	obs_data_item_t item = obs_data_first(data);
+	obs_data_item_t item = NULL;
 
-	while (item) {
+	for (item = obs_data_first(data); item; obs_data_item_next(&item)) {
 		enum obs_data_type type = obs_data_item_gettype(item);
 		const char *name        = get_item_name(item);
 
+		if (!obs_data_item_has_user_value(item))
+			continue;
+
 		if (type == OBS_DATA_STRING)
 			set_json_string(json, name, item);
 		else if (type == OBS_DATA_NUMBER)
@@ -383,8 +512,6 @@ static json_t *obs_data_to_json(obs_data_t data)
 			set_json_obj(json, name, item);
 		else if (type == OBS_DATA_ARRAY)
 			set_json_array(json, name, item);
-
-		obs_data_item_next(&item);
 	}
 
 	return json;
@@ -481,17 +608,21 @@ static struct obs_data_item *get_item(struct obs_data *data, const char *name)
 
 static void set_item_data(struct obs_data *data, struct obs_data_item **item,
 		const char *name, const void *ptr, size_t size,
-		enum obs_data_type type)
+		enum obs_data_type type,
+		bool default_data)
 {
 	obs_data_item_t new_item = NULL;
 
 	if ((!item || (item && !*item)) && data) {
-		new_item = obs_data_item_create(name, ptr, size, type);
+		new_item = obs_data_item_create(name, ptr, size, type,
+				default_data);
 		new_item->next = data->first_item;
 		new_item->parent = data;
 
 		data->first_item = new_item;
 
+	} else if (default_data) {
+		obs_data_item_set_default_data(item, ptr, size, type);
 	} else {
 		obs_data_item_setdata(item, ptr, size, type);
 	}
@@ -511,7 +642,7 @@ static inline void set_item(struct obs_data *data, obs_data_item_t *item,
 		item = &actual_item;
 	}
 
-	set_item_data(data, item, name, ptr, size, type);
+	set_item_data(data, item, name, ptr, size, type, false);
 }
 
 static inline void set_item_def(struct obs_data *data, obs_data_item_t *item,
@@ -531,7 +662,7 @@ static inline void set_item_def(struct obs_data *data, obs_data_item_t *item,
 	if (item && *item && (*item)->type == type)
 		return;
 
-	set_item_data(data, item, name, ptr, size, type);
+	set_item_data(data, item, name, ptr, size, type, true);
 }
 
 static inline void copy_item(struct obs_data *data, struct obs_data_item *item)
@@ -708,6 +839,36 @@ obs_data_array_t obs_data_getarray(obs_data_t data, const char *name)
 	return obs_data_item_getarray(get_item(data, name));
 }
 
+const char *obs_data_get_default_string(obs_data_t data, const char *name)
+{
+	return obs_data_item_get_default_string(get_item(data, name));
+}
+
+long long obs_data_get_default_int(obs_data_t data, const char *name)
+{
+	return obs_data_item_get_default_int(get_item(data, name));
+}
+
+double obs_data_get_default_double(obs_data_t data, const char *name)
+{
+	return obs_data_item_get_default_double(get_item(data, name));
+}
+
+bool obs_data_get_default_bool(obs_data_t data, const char *name)
+{
+	return obs_data_item_get_default_bool(get_item(data, name));
+}
+
+obs_data_t obs_data_get_default_obj(obs_data_t data, const char *name)
+{
+	return obs_data_item_get_default_obj(get_item(data, name));
+}
+
+obs_data_array_t obs_data_get_default_array(obs_data_t data, const char *name)
+{
+	return obs_data_item_get_default_array(get_item(data, name));
+}
+
 obs_data_array_t obs_data_array_create()
 {
 	struct obs_data_array *array = bzalloc(sizeof(struct obs_data_array));
@@ -786,6 +947,69 @@ void obs_data_array_erase(obs_data_array_t array, size_t idx)
 	}
 }
 
+/* ------------------------------------------------------------------------- */
+/* Item status inspection */
+
+bool obs_data_has_user_value(obs_data_t data, const char *name)
+{
+	return data && obs_data_item_has_user_value(get_item(data, name));
+}
+
+bool obs_data_has_default(obs_data_t data, const char *name)
+{
+	return data && obs_data_item_has_default(get_item(data, name));
+}
+
+bool obs_data_item_has_user_value(obs_data_item_t item)
+{
+	return item && item->data_size;
+}
+
+bool obs_data_item_has_default(obs_data_item_t item)
+{
+	return item && item->default_size;
+}
+
+/* ------------------------------------------------------------------------- */
+/* Clearing data values */
+
+void obs_data_unset_user_value(obs_data_t data, const char *name)
+{
+	obs_data_item_unset_user_value(get_item(data, name));
+}
+
+void obs_data_unset_default_value(obs_data_t data, const char *name)
+{
+	obs_data_item_unset_default_value(get_item(data, name));
+}
+
+void obs_data_item_unset_user_value(obs_data_item_t item)
+{
+	if (!item || !item->data_size)
+		return;
+
+	void *old_non_user_data = get_default_data_ptr(item);
+
+	item_data_release(item);
+	item->data_size = 0;
+	item->data_len = 0;
+
+	if (item->default_size)
+		move_data(item, old_non_user_data, item,
+				get_default_data_ptr(item),
+				item->default_len);
+}
+
+void obs_data_item_unset_default_value(obs_data_item_t item)
+{
+	if (!item || !item->default_size)
+		return;
+
+	item_default_data_release(item);
+	item->default_size = 0;
+
+}
+
 /* ------------------------------------------------------------------------- */
 /* Item iteration */
 
@@ -892,6 +1116,37 @@ void obs_data_item_setarray(obs_data_item_t *item, obs_data_array_t val)
 	obs_set_array(NULL, item, NULL, val, set_item);
 }
 
+void obs_data_item_set_default_string(obs_data_item_t *item, const char *val)
+{
+	obs_set_string(NULL, item, NULL, val, set_item_def);
+}
+
+void obs_data_item_set_default_int(obs_data_item_t *item, long long val)
+{
+	obs_set_int(NULL, item, NULL, val, set_item_def);
+}
+
+void obs_data_item_set_default_double(obs_data_item_t *item, double val)
+{
+	obs_set_double(NULL, item, NULL, val, set_item_def);
+}
+
+void obs_data_item_set_default_bool(obs_data_item_t *item, bool val)
+{
+	obs_set_bool(NULL, item, NULL, val, set_item_def);
+}
+
+void obs_data_item_set_default_obj(obs_data_item_t *item, obs_data_t val)
+{
+	obs_set_obj(NULL, item, NULL, val, set_item_def);
+}
+
+void obs_data_item_set_default_array(obs_data_item_t *item,
+		obs_data_array_t val)
+{
+	obs_set_array(NULL, item, NULL, val, set_item_def);
+}
+
 static inline bool item_valid(struct obs_data_item *item,
 		enum obs_data_type type)
 {
@@ -1002,6 +1257,41 @@ obs_data_t obs_data_item_getobj(obs_data_item_t item)
 	return data_item_get_obj(item, get_item_obj);
 }
 
+obs_data_array_t obs_data_item_getarray(obs_data_item_t item)
+{
+	return data_item_get_array(item, get_item_array);
+}
+
+const char *obs_data_item_get_default_string(obs_data_item_t item)
+{
+	return data_item_get_string(item, get_item_default_data);
+}
+
+long long obs_data_item_get_default_int(obs_data_item_t item)
+{
+	return data_item_get_int(item, get_item_default_data);
+}
+
+double obs_data_item_get_default_double(obs_data_item_t item)
+{
+	return data_item_get_double(item, get_item_default_data);
+}
+
+bool obs_data_item_get_default_bool(obs_data_item_t item)
+{
+	return data_item_get_bool(item, get_item_default_data);
+}
+
+obs_data_t obs_data_item_get_default_obj(obs_data_item_t item)
+{
+	return data_item_get_obj(item, get_item_obj);
+}
+
+obs_data_array_t obs_data_item_get_default_array(obs_data_item_t item)
+{
+	return data_item_get_array(item, get_item_array);
+}
+
 /* ------------------------------------------------------------------------- */
 /* Helper functions for certain structures */
 
@@ -1166,3 +1456,21 @@ void obs_data_get_default_vec2(obs_data_t data, const char *name,
 {
 	get_vec2(obs_data_get_default_obj(data, name), val);
 }
+
+void obs_data_get_default_vec3(obs_data_t data, const char *name,
+		struct vec3 *val)
+{
+	get_vec3(obs_data_get_default_obj(data, name), val);
+}
+
+void obs_data_get_default_vec4(obs_data_t data, const char *name,
+		struct vec4 *val)
+{
+	get_vec4(obs_data_get_default_obj(data, name), val);
+}
+
+void obs_data_get_default_quat(obs_data_t data, const char *name,
+		struct quat *val)
+{
+	get_quat(obs_data_get_default_obj(data, name), val);
+}

libobs/obs-data.h

@@ -84,9 +84,6 @@ EXPORT void obs_data_setarray(obs_data_t data, const char *name,
 
 /*
  * Default value functions.
- *
- * These functions check to ensure the value exists, and is of a specific type.
- * If not, it sets the default value instead.
  */
 EXPORT void obs_data_set_default_string(obs_data_t data, const char *name,
 		const char *val);
@@ -101,7 +98,6 @@ EXPORT void obs_data_set_default_obj(obs_data_t data, const char *name,
 
 /*
  * Get functions
- * NOTE: use a macro if you use 'defaults' in more than one place
  */
 EXPORT const char *obs_data_getstring(obs_data_t data, const char *name);
 EXPORT long long obs_data_getint(obs_data_t data, const char *name);
@@ -110,6 +106,15 @@ EXPORT bool obs_data_getbool(obs_data_t data, const char *name);
 EXPORT obs_data_t obs_data_getobj(obs_data_t data, const char *name);
 EXPORT obs_data_array_t obs_data_getarray(obs_data_t data, const char *name);
 
+EXPORT const char *obs_data_get_default_string(obs_data_t data,
+		const char *name);
+EXPORT long long obs_data_get_default_int(obs_data_t data, const char *name);
+EXPORT double obs_data_get_default_double(obs_data_t data, const char *name);
+EXPORT bool obs_data_get_default_bool(obs_data_t data, const char *name);
+EXPORT obs_data_t obs_data_get_default_obj(obs_data_t data, const char *name);
+EXPORT obs_data_array_t obs_data_get_default_array(obs_data_t data,
+		const char *name);
+
 /* Array functions */
 EXPORT obs_data_array_t obs_data_array_create();
 EXPORT void obs_data_array_addref(obs_data_array_t array);
@@ -122,6 +127,24 @@ EXPORT void obs_data_array_insert(obs_data_array_t array, size_t idx,
 		obs_data_t obj);
 EXPORT void obs_data_array_erase(obs_data_array_t array, size_t idx);
 
+/* ------------------------------------------------------------------------- */
+/* Item status inspection */
+
+EXPORT bool obs_data_has_user_value(obs_data_t data, const char *name);
+EXPORT bool obs_data_has_default(obs_data_t data, const char *name);
+
+EXPORT bool obs_data_item_has_user_value(obs_data_item_t data);
+EXPORT bool obs_data_item_has_default(obs_data_item_t data);
+
+/* ------------------------------------------------------------------------- */
+/* Clearing data values */
+
+EXPORT void obs_data_unset_user_value(obs_data_t data, const char *name);
+EXPORT void obs_data_unset_default_value(obs_data_t data, const char *name);
+
+EXPORT void obs_data_item_unset_user_value(obs_data_item_t data);
+EXPORT void obs_data_item_unset_default_value(obs_data_item_t data);
+
 /* ------------------------------------------------------------------------- */
 /* Item iteration */
 
@@ -143,6 +166,16 @@ EXPORT void obs_data_item_setbool(obs_data_item_t *item, bool val);
 EXPORT void obs_data_item_setobj(obs_data_item_t *item, obs_data_t val);
 EXPORT void obs_data_item_setarray(obs_data_item_t *item, obs_data_array_t val);
 
+EXPORT void obs_data_item_set_default_string(obs_data_item_t *item,
+		const char *val);
+EXPORT void obs_data_item_set_default_int(obs_data_item_t *item, long long val);
+EXPORT void obs_data_item_set_default_double(obs_data_item_t *item, double val);
+EXPORT void obs_data_item_set_default_bool(obs_data_item_t *item, bool val);
+EXPORT void obs_data_item_set_default_obj(obs_data_item_t *item,
+		obs_data_t val);
+EXPORT void obs_data_item_set_default_array(obs_data_item_t *item,
+		obs_data_array_t val);
+
 /* Item get functions */
 EXPORT const char *obs_data_item_getstring(obs_data_item_t item);
 EXPORT long long obs_data_item_getint(obs_data_item_t item);
@@ -151,6 +184,13 @@ EXPORT bool obs_data_item_getbool(obs_data_item_t item);
 EXPORT obs_data_t obs_data_item_getobj(obs_data_item_t item);
 EXPORT obs_data_array_t obs_data_item_getarray(obs_data_item_t item);
 
+EXPORT const char *obs_data_item_get_default_string(obs_data_item_t item);
+EXPORT long long obs_data_item_get_default_int(obs_data_item_t item);
+EXPORT double obs_data_item_get_default_double(obs_data_item_t item);
+EXPORT bool obs_data_item_get_default_bool(obs_data_item_t item);
+EXPORT obs_data_t obs_data_item_get_default_obj(obs_data_item_t item);
+EXPORT obs_data_array_t obs_data_item_get_default_array(obs_data_item_t item);
+
 /* ------------------------------------------------------------------------- */
 /* Helper functions for certain structures */
 EXPORT void obs_data_set_vec2(obs_data_t data, const char *name,
@@ -180,6 +220,15 @@ EXPORT void obs_data_get_vec4(obs_data_t data, const char *name,
 EXPORT void obs_data_get_quat(obs_data_t data, const char *name,
 		struct quat *val);
 
+EXPORT void obs_data_get_default_vec2(obs_data_t data, const char *name,
+		struct vec2 *val);
+EXPORT void obs_data_get_default_vec3(obs_data_t data, const char *name,
+		struct vec3 *val);
+EXPORT void obs_data_get_default_vec4(obs_data_t data, const char *name,
+		struct vec4 *val);
+EXPORT void obs_data_get_default_quat(obs_data_t data, const char *name,
+		struct quat *val);
+
 /* ------------------------------------------------------------------------- */
 /* OBS-specific functions */