mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-09-20 13:08:50 +02:00
f53df7da64
Code submissions have continually suffered from formatting inconsistencies that constantly have to be addressed. Using clang-format simplifies this by making code formatting more consistent, and allows automation of the code formatting so that maintainers can focus more on the code itself instead of code formatting.
405 lines
14 KiB
C
405 lines
14 KiB
C
/******************************************************************************
|
|
Copyright (C) 2014 by Hugh Bailey <obs.jim@gmail.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 "obs-data.h"
|
|
#include "media-io/frame-rate.h"
|
|
|
|
/**
|
|
* @file
|
|
* @brief libobs header for the properties system used in libobs
|
|
*
|
|
* @page properties Properties
|
|
* @brief Platform and Toolkit independent settings implementation
|
|
*
|
|
* @section prop_overview_sec Overview
|
|
*
|
|
* libobs uses a property system which lets for example sources specify
|
|
* settings that can be displayed to the user by the UI.
|
|
*
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Only update when the user presses OK or Apply */
|
|
#define OBS_PROPERTIES_DEFER_UPDATE (1 << 0)
|
|
|
|
enum obs_property_type {
|
|
OBS_PROPERTY_INVALID,
|
|
OBS_PROPERTY_BOOL,
|
|
OBS_PROPERTY_INT,
|
|
OBS_PROPERTY_FLOAT,
|
|
OBS_PROPERTY_TEXT,
|
|
OBS_PROPERTY_PATH,
|
|
OBS_PROPERTY_LIST,
|
|
OBS_PROPERTY_COLOR,
|
|
OBS_PROPERTY_BUTTON,
|
|
OBS_PROPERTY_FONT,
|
|
OBS_PROPERTY_EDITABLE_LIST,
|
|
OBS_PROPERTY_FRAME_RATE,
|
|
OBS_PROPERTY_GROUP,
|
|
};
|
|
|
|
enum obs_combo_format {
|
|
OBS_COMBO_FORMAT_INVALID,
|
|
OBS_COMBO_FORMAT_INT,
|
|
OBS_COMBO_FORMAT_FLOAT,
|
|
OBS_COMBO_FORMAT_STRING,
|
|
};
|
|
|
|
enum obs_combo_type {
|
|
OBS_COMBO_TYPE_INVALID,
|
|
OBS_COMBO_TYPE_EDITABLE,
|
|
OBS_COMBO_TYPE_LIST,
|
|
};
|
|
|
|
enum obs_editable_list_type {
|
|
OBS_EDITABLE_LIST_TYPE_STRINGS,
|
|
OBS_EDITABLE_LIST_TYPE_FILES,
|
|
OBS_EDITABLE_LIST_TYPE_FILES_AND_URLS,
|
|
};
|
|
|
|
enum obs_path_type {
|
|
OBS_PATH_FILE,
|
|
OBS_PATH_FILE_SAVE,
|
|
OBS_PATH_DIRECTORY,
|
|
};
|
|
|
|
enum obs_text_type {
|
|
OBS_TEXT_DEFAULT,
|
|
OBS_TEXT_PASSWORD,
|
|
OBS_TEXT_MULTILINE,
|
|
};
|
|
|
|
enum obs_number_type {
|
|
OBS_NUMBER_SCROLLER,
|
|
OBS_NUMBER_SLIDER,
|
|
};
|
|
|
|
enum obs_group_type {
|
|
OBS_COMBO_INVALID,
|
|
OBS_GROUP_NORMAL,
|
|
OBS_GROUP_CHECKABLE,
|
|
};
|
|
|
|
#define OBS_FONT_BOLD (1 << 0)
|
|
#define OBS_FONT_ITALIC (1 << 1)
|
|
#define OBS_FONT_UNDERLINE (1 << 2)
|
|
#define OBS_FONT_STRIKEOUT (1 << 3)
|
|
|
|
struct obs_properties;
|
|
struct obs_property;
|
|
typedef struct obs_properties obs_properties_t;
|
|
typedef struct obs_property obs_property_t;
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
EXPORT obs_properties_t *obs_properties_create(void);
|
|
EXPORT obs_properties_t *
|
|
obs_properties_create_param(void *param, void (*destroy)(void *param));
|
|
EXPORT void obs_properties_destroy(obs_properties_t *props);
|
|
|
|
EXPORT void obs_properties_set_flags(obs_properties_t *props, uint32_t flags);
|
|
EXPORT uint32_t obs_properties_get_flags(obs_properties_t *props);
|
|
|
|
EXPORT void obs_properties_set_param(obs_properties_t *props, void *param,
|
|
void (*destroy)(void *param));
|
|
EXPORT void *obs_properties_get_param(obs_properties_t *props);
|
|
|
|
EXPORT obs_property_t *obs_properties_first(obs_properties_t *props);
|
|
|
|
EXPORT obs_property_t *obs_properties_get(obs_properties_t *props,
|
|
const char *property);
|
|
|
|
EXPORT obs_properties_t *obs_properties_get_parent(obs_properties_t *props);
|
|
|
|
/** Remove a property from a properties list.
|
|
*
|
|
* Removes a property from a properties list. Only valid in either
|
|
* get_properties or modified_callback(2). modified_callback(2) must return
|
|
* true so that all UI properties are rebuilt and returning false is undefined
|
|
* behavior.
|
|
*
|
|
* @param props Properties to remove from.
|
|
* @param property Name of the property to remove.
|
|
*/
|
|
EXPORT void obs_properties_remove_by_name(obs_properties_t *props,
|
|
const char *property);
|
|
|
|
/**
|
|
* Applies settings to the properties by calling all the necessary
|
|
* modification callbacks
|
|
*/
|
|
EXPORT void obs_properties_apply_settings(obs_properties_t *props,
|
|
obs_data_t *settings);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Callback for when a button property is clicked. If the properties
|
|
* need to be refreshed due to changes to the property layout, return true,
|
|
* otherwise return false.
|
|
*/
|
|
typedef bool (*obs_property_clicked_t)(obs_properties_t *props,
|
|
obs_property_t *property, void *data);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_bool(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_int(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description, int min,
|
|
int max, int step);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_float(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description,
|
|
double min, double max,
|
|
double step);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_int_slider(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description,
|
|
int min, int max,
|
|
int step);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_float_slider(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description,
|
|
double min, double max,
|
|
double step);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_text(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description,
|
|
enum obs_text_type type);
|
|
|
|
/**
|
|
* Adds a 'path' property. Can be a directory or a file.
|
|
*
|
|
* If target is a file path, the filters should be this format, separated by
|
|
* double semi-colens, and extensions separated by space:
|
|
* "Example types 1 and 2 (*.ex1 *.ex2);;Example type 3 (*.ex3)"
|
|
*
|
|
* @param props Properties object
|
|
* @param name Settings name
|
|
* @param description Description (display name) of the property
|
|
* @param type Type of path (directory or file)
|
|
* @param filter If type is a file path, then describes the file filter
|
|
* that the user can browse. Items are separated via
|
|
* double semi-colens. If multiple file types in a
|
|
* filter, separate with space.
|
|
*/
|
|
EXPORT obs_property_t *
|
|
obs_properties_add_path(obs_properties_t *props, const char *name,
|
|
const char *description, enum obs_path_type type,
|
|
const char *filter, const char *default_path);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_list(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description,
|
|
enum obs_combo_type type,
|
|
enum obs_combo_format format);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_color(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description);
|
|
|
|
EXPORT obs_property_t *
|
|
obs_properties_add_button(obs_properties_t *props, const char *name,
|
|
const char *text, obs_property_clicked_t callback);
|
|
|
|
EXPORT obs_property_t *
|
|
obs_properties_add_button2(obs_properties_t *props, const char *name,
|
|
const char *text, obs_property_clicked_t callback,
|
|
void *priv);
|
|
|
|
/**
|
|
* Adds a font selection property.
|
|
*
|
|
* A font is an obs_data sub-object which contains the following items:
|
|
* face: face name string
|
|
* style: style name string
|
|
* size: size integer
|
|
* flags: font flags integer (OBS_FONT_* defined above)
|
|
*/
|
|
EXPORT obs_property_t *obs_properties_add_font(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description);
|
|
|
|
EXPORT obs_property_t *
|
|
obs_properties_add_editable_list(obs_properties_t *props, const char *name,
|
|
const char *description,
|
|
enum obs_editable_list_type type,
|
|
const char *filter, const char *default_path);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_frame_rate(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description);
|
|
|
|
EXPORT obs_property_t *obs_properties_add_group(obs_properties_t *props,
|
|
const char *name,
|
|
const char *description,
|
|
enum obs_group_type type,
|
|
obs_properties_t *group);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Optional callback for when a property is modified. If the properties
|
|
* need to be refreshed due to changes to the property layout, return true,
|
|
* otherwise return false.
|
|
*/
|
|
typedef bool (*obs_property_modified_t)(obs_properties_t *props,
|
|
obs_property_t *property,
|
|
obs_data_t *settings);
|
|
typedef bool (*obs_property_modified2_t)(void *priv, obs_properties_t *props,
|
|
obs_property_t *property,
|
|
obs_data_t *settings);
|
|
|
|
EXPORT void
|
|
obs_property_set_modified_callback(obs_property_t *p,
|
|
obs_property_modified_t modified);
|
|
EXPORT void obs_property_set_modified_callback2(
|
|
obs_property_t *p, obs_property_modified2_t modified, void *priv);
|
|
|
|
EXPORT bool obs_property_modified(obs_property_t *p, obs_data_t *settings);
|
|
EXPORT bool obs_property_button_clicked(obs_property_t *p, void *obj);
|
|
|
|
EXPORT void obs_property_set_visible(obs_property_t *p, bool visible);
|
|
EXPORT void obs_property_set_enabled(obs_property_t *p, bool enabled);
|
|
|
|
EXPORT void obs_property_set_description(obs_property_t *p,
|
|
const char *description);
|
|
EXPORT void obs_property_set_long_description(obs_property_t *p,
|
|
const char *long_description);
|
|
|
|
EXPORT const char *obs_property_name(obs_property_t *p);
|
|
EXPORT const char *obs_property_description(obs_property_t *p);
|
|
EXPORT const char *obs_property_long_description(obs_property_t *p);
|
|
EXPORT enum obs_property_type obs_property_get_type(obs_property_t *p);
|
|
EXPORT bool obs_property_enabled(obs_property_t *p);
|
|
EXPORT bool obs_property_visible(obs_property_t *p);
|
|
|
|
EXPORT bool obs_property_next(obs_property_t **p);
|
|
|
|
EXPORT int obs_property_int_min(obs_property_t *p);
|
|
EXPORT int obs_property_int_max(obs_property_t *p);
|
|
EXPORT int obs_property_int_step(obs_property_t *p);
|
|
EXPORT enum obs_number_type obs_property_int_type(obs_property_t *p);
|
|
EXPORT const char *obs_property_int_suffix(obs_property_t *p);
|
|
EXPORT double obs_property_float_min(obs_property_t *p);
|
|
EXPORT double obs_property_float_max(obs_property_t *p);
|
|
EXPORT double obs_property_float_step(obs_property_t *p);
|
|
EXPORT enum obs_number_type obs_property_float_type(obs_property_t *p);
|
|
EXPORT const char *obs_property_float_suffix(obs_property_t *p);
|
|
EXPORT enum obs_text_type obs_property_text_type(obs_property_t *p);
|
|
EXPORT enum obs_path_type obs_property_path_type(obs_property_t *p);
|
|
EXPORT const char *obs_property_path_filter(obs_property_t *p);
|
|
EXPORT const char *obs_property_path_default_path(obs_property_t *p);
|
|
EXPORT enum obs_combo_type obs_property_list_type(obs_property_t *p);
|
|
EXPORT enum obs_combo_format obs_property_list_format(obs_property_t *p);
|
|
|
|
EXPORT void obs_property_int_set_limits(obs_property_t *p, int min, int max,
|
|
int step);
|
|
EXPORT void obs_property_float_set_limits(obs_property_t *p, double min,
|
|
double max, double step);
|
|
EXPORT void obs_property_int_set_suffix(obs_property_t *p, const char *suffix);
|
|
EXPORT void obs_property_float_set_suffix(obs_property_t *p,
|
|
const char *suffix);
|
|
|
|
EXPORT void obs_property_list_clear(obs_property_t *p);
|
|
|
|
EXPORT size_t obs_property_list_add_string(obs_property_t *p, const char *name,
|
|
const char *val);
|
|
EXPORT size_t obs_property_list_add_int(obs_property_t *p, const char *name,
|
|
long long val);
|
|
EXPORT size_t obs_property_list_add_float(obs_property_t *p, const char *name,
|
|
double val);
|
|
|
|
EXPORT void obs_property_list_insert_string(obs_property_t *p, size_t idx,
|
|
const char *name, const char *val);
|
|
EXPORT void obs_property_list_insert_int(obs_property_t *p, size_t idx,
|
|
const char *name, long long val);
|
|
EXPORT void obs_property_list_insert_float(obs_property_t *p, size_t idx,
|
|
const char *name, double val);
|
|
|
|
EXPORT void obs_property_list_item_disable(obs_property_t *p, size_t idx,
|
|
bool disabled);
|
|
EXPORT bool obs_property_list_item_disabled(obs_property_t *p, size_t idx);
|
|
|
|
EXPORT void obs_property_list_item_remove(obs_property_t *p, size_t idx);
|
|
|
|
EXPORT size_t obs_property_list_item_count(obs_property_t *p);
|
|
EXPORT const char *obs_property_list_item_name(obs_property_t *p, size_t idx);
|
|
EXPORT const char *obs_property_list_item_string(obs_property_t *p, size_t idx);
|
|
EXPORT long long obs_property_list_item_int(obs_property_t *p, size_t idx);
|
|
EXPORT double obs_property_list_item_float(obs_property_t *p, size_t idx);
|
|
|
|
EXPORT enum obs_editable_list_type
|
|
obs_property_editable_list_type(obs_property_t *p);
|
|
EXPORT const char *obs_property_editable_list_filter(obs_property_t *p);
|
|
EXPORT const char *obs_property_editable_list_default_path(obs_property_t *p);
|
|
|
|
EXPORT void obs_property_frame_rate_clear(obs_property_t *p);
|
|
EXPORT void obs_property_frame_rate_options_clear(obs_property_t *p);
|
|
EXPORT void obs_property_frame_rate_fps_ranges_clear(obs_property_t *p);
|
|
|
|
EXPORT size_t obs_property_frame_rate_option_add(obs_property_t *p,
|
|
const char *name,
|
|
const char *description);
|
|
EXPORT size_t obs_property_frame_rate_fps_range_add(
|
|
obs_property_t *p, struct media_frames_per_second min,
|
|
struct media_frames_per_second max);
|
|
|
|
EXPORT void obs_property_frame_rate_option_insert(obs_property_t *p, size_t idx,
|
|
const char *name,
|
|
const char *description);
|
|
EXPORT void
|
|
obs_property_frame_rate_fps_range_insert(obs_property_t *p, size_t idx,
|
|
struct media_frames_per_second min,
|
|
struct media_frames_per_second max);
|
|
|
|
EXPORT size_t obs_property_frame_rate_options_count(obs_property_t *p);
|
|
EXPORT const char *obs_property_frame_rate_option_name(obs_property_t *p,
|
|
size_t idx);
|
|
EXPORT const char *obs_property_frame_rate_option_description(obs_property_t *p,
|
|
size_t idx);
|
|
|
|
EXPORT size_t obs_property_frame_rate_fps_ranges_count(obs_property_t *p);
|
|
EXPORT struct media_frames_per_second
|
|
obs_property_frame_rate_fps_range_min(obs_property_t *p, size_t idx);
|
|
EXPORT struct media_frames_per_second
|
|
obs_property_frame_rate_fps_range_max(obs_property_t *p, size_t idx);
|
|
|
|
EXPORT enum obs_group_type obs_property_group_type(obs_property_t *p);
|
|
EXPORT obs_properties_t *obs_property_group_content(obs_property_t *p);
|
|
|
|
#ifndef SWIG
|
|
DEPRECATED
|
|
EXPORT enum obs_text_type obs_proprety_text_type(obs_property_t *p);
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|