jp9000/obs-studio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve safety for settings usage

Browse Source 
- Add 'set_default' functions to obs-data.*.  These functions ensure
  that a paramter exists and that the parameter is of a specific type.
  If not, it will create or overwrite the value with the default setting
  instead.

  These functions are meant to be explicitly called before using any of
  the 'get' functions.  The reason why it was designed this way is to
  encourage defaults to be set in a single place/function.

  For example, ideal usage is to create one function for your data,
  "set_my_defaults(obs_data_t data)", set all the default values within
  that function, and then call that function on create/update, that way
  all defaults are centralized to a single place.

- Ensure that data passed to sources/encoders/outputs/etc is always
  valid, and not a null value.

- While I'm remembering, fix a few defaults of the main program config
  file data.
This commit is contained in:
jp9000
2014-01-28 18:41:24 -07:00
parent c6300d0956
commit 9116be8d9c
9 changed files with 127 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
libobs/obs-data.h
View File

@@ -69,16 +69,31 @@ EXPORT void obs_data_setobj(obs_data_t data, const char *name, obs_data_t obj);
EXPORT void obs_data_setarray(obs_data_t data, const char *name,
obs_data_array_t array);
/*
* 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);
EXPORT void obs_data_set_default_int(obs_data_t data, const char *name,
long long val);
EXPORT void obs_data_set_default_double(obs_data_t data, const char *name,
double val);
EXPORT void obs_data_set_default_bool(obs_data_t data, const char *name,
bool val);
EXPORT void obs_data_set_default_obj(obs_data_t data, const char *name,
obs_data_t obj);
/*
* 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,
const char *def);
EXPORT long long obs_data_getint(obs_data_t data, const char *name,
long long def);
EXPORT double obs_data_getdouble(obs_data_t data, const char *name, double def);
EXPORT bool obs_data_getbool(obs_data_t data, const char *name, bool def);
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);
EXPORT double obs_data_getdouble(obs_data_t data, const char *name);
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);
@@ -115,11 +130,10 @@ 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);
/* Item get functions */
EXPORT const char *obs_data_item_getstring(obs_data_item_t item,
const char *def);
EXPORT long long obs_data_item_getint(obs_data_item_t item, long long def);
EXPORT double obs_data_item_getdouble(obs_data_item_t item, double def);
EXPORT bool obs_data_item_getbool(obs_data_item_t item, bool def);
EXPORT const char *obs_data_item_getstring(obs_data_item_t item);
EXPORT long long obs_data_item_getint(obs_data_item_t item);
EXPORT double obs_data_item_getdouble(obs_data_item_t item);
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);