mirror of
https://github.com/obsproject/obs-studio.git
synced 2026-01-20 04:08:54 -05:00
e2712f097e
The autoselect functionality was meant to enable user feedback for when data was selected, but something else actually used, for example in case the value "Auto" was chosen, or an incompatible one. However, it has a few problems: 1. It was not really used, the only places in OBS were the legacy Video Capture Device on macOS and the Video Capture Device on Windows. 2. It was never even fully implemented in the UI. In fact, the properties view *only* supports it for obs_property_list, despite the API theoretically allowing any data/property type. 3. The core obs_data seems like the wrong place for this kind of interaction between plugins and UI. obs_data should carry data from one place to another, some built-in feedback mechanism for the other direction doesn't make too much sense. If the functionality is desired, I think this should be rearchitectured as some place of explicit data transfer. Let's mark it as deprecated for future removal.
315 lines
17 KiB
C
315 lines
17 KiB
C
/******************************************************************************
|
|
Copyright (C) 2023 by Lain Bailey <lain@obsproject.com>
|
|
|
|
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, see <http://www.gnu.org/licenses/>.
|
|
******************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "util/c99defs.h"
|
|
#include "media-io/frame-rate.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct vec2;
|
|
struct vec3;
|
|
struct vec4;
|
|
struct quat;
|
|
|
|
/*
|
|
* OBS data settings storage
|
|
*
|
|
* This is used for retrieving or setting the data settings for things such
|
|
* as sources, encoders, etc. This is designed for JSON serialization.
|
|
*/
|
|
|
|
struct obs_data;
|
|
struct obs_data_item;
|
|
struct obs_data_array;
|
|
typedef struct obs_data obs_data_t;
|
|
typedef struct obs_data_item obs_data_item_t;
|
|
typedef struct obs_data_array obs_data_array_t;
|
|
|
|
enum obs_data_type {
|
|
OBS_DATA_NULL,
|
|
OBS_DATA_STRING,
|
|
OBS_DATA_NUMBER,
|
|
OBS_DATA_BOOLEAN,
|
|
OBS_DATA_OBJECT,
|
|
OBS_DATA_ARRAY
|
|
};
|
|
|
|
enum obs_data_number_type { OBS_DATA_NUM_INVALID, OBS_DATA_NUM_INT, OBS_DATA_NUM_DOUBLE };
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Main usage functions */
|
|
|
|
EXPORT obs_data_t *obs_data_create();
|
|
EXPORT obs_data_t *obs_data_create_from_json(const char *json_string);
|
|
EXPORT obs_data_t *obs_data_create_from_json_file(const char *json_file);
|
|
EXPORT obs_data_t *obs_data_create_from_json_file_safe(const char *json_file, const char *backup_ext);
|
|
EXPORT void obs_data_addref(obs_data_t *data);
|
|
EXPORT void obs_data_release(obs_data_t *data);
|
|
|
|
EXPORT const char *obs_data_get_json(obs_data_t *data);
|
|
EXPORT const char *obs_data_get_json_with_defaults(obs_data_t *data);
|
|
EXPORT const char *obs_data_get_json_pretty(obs_data_t *data);
|
|
EXPORT const char *obs_data_get_json_pretty_with_defaults(obs_data_t *data);
|
|
EXPORT const char *obs_data_get_last_json(obs_data_t *data);
|
|
EXPORT bool obs_data_save_json(obs_data_t *data, const char *file);
|
|
EXPORT bool obs_data_save_json_safe(obs_data_t *data, const char *file, const char *temp_ext, const char *backup_ext);
|
|
EXPORT bool obs_data_save_json_pretty_safe(obs_data_t *data, const char *file, const char *temp_ext,
|
|
const char *backup_ext);
|
|
|
|
EXPORT void obs_data_apply(obs_data_t *target, obs_data_t *apply_data);
|
|
|
|
EXPORT void obs_data_erase(obs_data_t *data, const char *name);
|
|
EXPORT void obs_data_clear(obs_data_t *data);
|
|
|
|
/* Set functions */
|
|
EXPORT void obs_data_set_string(obs_data_t *data, const char *name, const char *val);
|
|
EXPORT void obs_data_set_int(obs_data_t *data, const char *name, long long val);
|
|
EXPORT void obs_data_set_double(obs_data_t *data, const char *name, double val);
|
|
EXPORT void obs_data_set_bool(obs_data_t *data, const char *name, bool val);
|
|
EXPORT void obs_data_set_obj(obs_data_t *data, const char *name, obs_data_t *obj);
|
|
EXPORT void obs_data_set_array(obs_data_t *data, const char *name, obs_data_array_t *array);
|
|
|
|
/*
|
|
* Creates an obs_data_t * filled with all default values.
|
|
*/
|
|
EXPORT obs_data_t *obs_data_get_defaults(obs_data_t *data);
|
|
|
|
/*
|
|
* Default value functions.
|
|
*/
|
|
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);
|
|
EXPORT void obs_data_set_default_array(obs_data_t *data, const char *name, obs_data_array_t *arr);
|
|
|
|
/*
|
|
* Application overrides
|
|
* Use these to communicate the actual values of settings in case the user
|
|
* settings aren't appropriate
|
|
*/
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_string(obs_data_t *data, const char *name, const char *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_int(obs_data_t *data, const char *name, long long val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_double(obs_data_t *data, const char *name, double val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_bool(obs_data_t *data, const char *name, bool val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_obj(obs_data_t *data, const char *name, obs_data_t *obj);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_array(obs_data_t *data, const char *name, obs_data_array_t *arr);
|
|
|
|
/*
|
|
* Get functions
|
|
*/
|
|
EXPORT const char *obs_data_get_string(obs_data_t *data, const char *name);
|
|
EXPORT long long obs_data_get_int(obs_data_t *data, const char *name);
|
|
EXPORT double obs_data_get_double(obs_data_t *data, const char *name);
|
|
EXPORT bool obs_data_get_bool(obs_data_t *data, const char *name);
|
|
EXPORT obs_data_t *obs_data_get_obj(obs_data_t *data, const char *name);
|
|
EXPORT obs_data_array_t *obs_data_get_array(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);
|
|
|
|
OBS_DEPRECATED EXPORT const char *obs_data_get_autoselect_string(obs_data_t *data, const char *name);
|
|
OBS_DEPRECATED EXPORT long long obs_data_get_autoselect_int(obs_data_t *data, const char *name);
|
|
OBS_DEPRECATED EXPORT double obs_data_get_autoselect_double(obs_data_t *data, const char *name);
|
|
OBS_DEPRECATED EXPORT bool obs_data_get_autoselect_bool(obs_data_t *data, const char *name);
|
|
OBS_DEPRECATED EXPORT obs_data_t *obs_data_get_autoselect_obj(obs_data_t *data, const char *name);
|
|
OBS_DEPRECATED EXPORT obs_data_array_t *obs_data_get_autoselect_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);
|
|
EXPORT void obs_data_array_release(obs_data_array_t *array);
|
|
|
|
EXPORT size_t obs_data_array_count(obs_data_array_t *array);
|
|
EXPORT obs_data_t *obs_data_array_item(obs_data_array_t *array, size_t idx);
|
|
EXPORT size_t obs_data_array_push_back(obs_data_array_t *array, obs_data_t *obj);
|
|
EXPORT void obs_data_array_insert(obs_data_array_t *array, size_t idx, obs_data_t *obj);
|
|
EXPORT void obs_data_array_push_back_array(obs_data_array_t *array, obs_data_array_t *array2);
|
|
EXPORT void obs_data_array_erase(obs_data_array_t *array, size_t idx);
|
|
EXPORT void obs_data_array_enum(obs_data_array_t *array, void (*cb)(obs_data_t *data, void *param), void *param);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Item status inspection */
|
|
|
|
EXPORT bool obs_data_has_user_value(obs_data_t *data, const char *name);
|
|
EXPORT bool obs_data_has_default_value(obs_data_t *data, const char *name);
|
|
OBS_DEPRECATED EXPORT bool obs_data_has_autoselect_value(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_value(obs_data_item_t *data);
|
|
OBS_DEPRECATED EXPORT bool obs_data_item_has_autoselect_value(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);
|
|
OBS_DEPRECATED EXPORT void obs_data_unset_autoselect_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);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_unset_autoselect_value(obs_data_item_t *data);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Item iteration */
|
|
|
|
EXPORT obs_data_item_t *obs_data_first(obs_data_t *data);
|
|
EXPORT obs_data_item_t *obs_data_item_byname(obs_data_t *data, const char *name);
|
|
EXPORT bool obs_data_item_next(obs_data_item_t **item);
|
|
EXPORT void obs_data_item_release(obs_data_item_t **item);
|
|
EXPORT void obs_data_item_remove(obs_data_item_t **item);
|
|
|
|
/* Gets Item type */
|
|
EXPORT enum obs_data_type obs_data_item_gettype(obs_data_item_t *item);
|
|
EXPORT enum obs_data_number_type obs_data_item_numtype(obs_data_item_t *item);
|
|
EXPORT const char *obs_data_item_get_name(obs_data_item_t *item);
|
|
|
|
/* Item set functions */
|
|
EXPORT void obs_data_item_set_string(obs_data_item_t **item, const char *val);
|
|
EXPORT void obs_data_item_set_int(obs_data_item_t **item, long long val);
|
|
EXPORT void obs_data_item_set_double(obs_data_item_t **item, double val);
|
|
EXPORT void obs_data_item_set_bool(obs_data_item_t **item, bool val);
|
|
EXPORT void obs_data_item_set_obj(obs_data_item_t **item, obs_data_t *val);
|
|
EXPORT void obs_data_item_set_array(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);
|
|
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_string(obs_data_item_t **item, const char *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_int(obs_data_item_t **item, long long val);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_double(obs_data_item_t **item, double val);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_bool(obs_data_item_t **item, bool val);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_obj(obs_data_item_t **item, obs_data_t *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_array(obs_data_item_t **item, obs_data_array_t *val);
|
|
|
|
/* Item get functions */
|
|
EXPORT const char *obs_data_item_get_string(obs_data_item_t *item);
|
|
EXPORT long long obs_data_item_get_int(obs_data_item_t *item);
|
|
EXPORT double obs_data_item_get_double(obs_data_item_t *item);
|
|
EXPORT bool obs_data_item_get_bool(obs_data_item_t *item);
|
|
EXPORT obs_data_t *obs_data_item_get_obj(obs_data_item_t *item);
|
|
EXPORT obs_data_array_t *obs_data_item_get_array(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);
|
|
|
|
OBS_DEPRECATED EXPORT const char *obs_data_item_get_autoselect_string(obs_data_item_t *item);
|
|
OBS_DEPRECATED EXPORT long long obs_data_item_get_autoselect_int(obs_data_item_t *item);
|
|
OBS_DEPRECATED EXPORT double obs_data_item_get_autoselect_double(obs_data_item_t *item);
|
|
OBS_DEPRECATED EXPORT bool obs_data_item_get_autoselect_bool(obs_data_item_t *item);
|
|
OBS_DEPRECATED EXPORT obs_data_t *obs_data_item_get_autoselect_obj(obs_data_item_t *item);
|
|
OBS_DEPRECATED EXPORT obs_data_array_t *obs_data_item_get_autoselect_array(obs_data_item_t *item);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Helper functions for certain structures */
|
|
EXPORT void obs_data_set_vec2(obs_data_t *data, const char *name, const struct vec2 *val);
|
|
EXPORT void obs_data_set_vec3(obs_data_t *data, const char *name, const struct vec3 *val);
|
|
EXPORT void obs_data_set_vec4(obs_data_t *data, const char *name, const struct vec4 *val);
|
|
EXPORT void obs_data_set_quat(obs_data_t *data, const char *name, const struct quat *val);
|
|
|
|
EXPORT void obs_data_set_default_vec2(obs_data_t *data, const char *name, const struct vec2 *val);
|
|
EXPORT void obs_data_set_default_vec3(obs_data_t *data, const char *name, const struct vec3 *val);
|
|
EXPORT void obs_data_set_default_vec4(obs_data_t *data, const char *name, const struct vec4 *val);
|
|
EXPORT void obs_data_set_default_quat(obs_data_t *data, const char *name, const struct quat *val);
|
|
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_vec2(obs_data_t *data, const char *name, const struct vec2 *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_vec3(obs_data_t *data, const char *name, const struct vec3 *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_vec4(obs_data_t *data, const char *name, const struct vec4 *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_quat(obs_data_t *data, const char *name, const struct quat *val);
|
|
|
|
EXPORT void obs_data_get_vec2(obs_data_t *data, const char *name, struct vec2 *val);
|
|
EXPORT void obs_data_get_vec3(obs_data_t *data, const char *name, struct vec3 *val);
|
|
EXPORT void obs_data_get_vec4(obs_data_t *data, const char *name, struct vec4 *val);
|
|
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_DEPRECATED EXPORT void obs_data_get_autoselect_vec2(obs_data_t *data, const char *name, struct vec2 *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_get_autoselect_vec3(obs_data_t *data, const char *name, struct vec3 *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_get_autoselect_vec4(obs_data_t *data, const char *name, struct vec4 *val);
|
|
OBS_DEPRECATED EXPORT void obs_data_get_autoselect_quat(obs_data_t *data, const char *name, struct quat *val);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Helper functions for media_frames_per_second/OBS_PROPERTY_FRAME_RATE */
|
|
EXPORT void obs_data_set_frames_per_second(obs_data_t *data, const char *name, struct media_frames_per_second fps,
|
|
const char *option);
|
|
EXPORT void obs_data_set_default_frames_per_second(obs_data_t *data, const char *name,
|
|
struct media_frames_per_second fps, const char *option);
|
|
OBS_DEPRECATED EXPORT void obs_data_set_autoselect_frames_per_second(obs_data_t *data, const char *name,
|
|
struct media_frames_per_second fps,
|
|
const char *option);
|
|
|
|
EXPORT bool obs_data_get_frames_per_second(obs_data_t *data, const char *name, struct media_frames_per_second *fps,
|
|
const char **option);
|
|
EXPORT bool obs_data_get_default_frames_per_second(obs_data_t *data, const char *name,
|
|
struct media_frames_per_second *fps, const char **option);
|
|
EXPORT bool obs_data_get_autoselect_frames_per_second(obs_data_t *data, const char *name,
|
|
struct media_frames_per_second *fps, const char **option);
|
|
|
|
EXPORT void obs_data_item_set_frames_per_second(obs_data_item_t **item, struct media_frames_per_second fps,
|
|
const char *option);
|
|
EXPORT void obs_data_item_set_default_frames_per_second(obs_data_item_t **item, struct media_frames_per_second fps,
|
|
const char *option);
|
|
OBS_DEPRECATED EXPORT void obs_data_item_set_autoselect_frames_per_second(obs_data_item_t **item,
|
|
struct media_frames_per_second fps,
|
|
const char *option);
|
|
|
|
EXPORT bool obs_data_item_get_frames_per_second(obs_data_item_t *item, struct media_frames_per_second *fps,
|
|
const char **option);
|
|
EXPORT bool obs_data_item_get_default_frames_per_second(obs_data_item_t *item, struct media_frames_per_second *fps,
|
|
const char **option);
|
|
OBS_DEPRECATED EXPORT bool obs_data_item_get_autoselect_frames_per_second(obs_data_item_t *item,
|
|
struct media_frames_per_second *fps,
|
|
const char **option);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* OBS-specific functions */
|
|
|
|
static inline obs_data_t *obs_data_newref(obs_data_t *data)
|
|
{
|
|
if (data)
|
|
obs_data_addref(data);
|
|
else
|
|
data = obs_data_create();
|
|
|
|
return data;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|