jp9000
/
obs-studio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
obs-studio/plugins/obs-filters/crop-filter.c

234 lines
6.0 KiB
C
Raw Normal View History

obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
#include <obs-module.h>
#include <graphics/vec2.h>
struct crop_filter_data {
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
obs_source_t *context;
gs_effect_t *effect;
gs_eparam_t *param_mul;
gs_eparam_t *param_add;
int left;
int right;
int top;
int bottom;
int abs_cx;
int abs_cy;
int width;
int height;
bool absolute;
struct vec2 mul_val;
struct vec2 add_val;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
};
(API Change) libobs: Pass type data to get_name callbacks API changed from: obs_source_info::get_name(void) obs_output_info::get_name(void) obs_encoder_info::get_name(void) obs_service_info::get_name(void) API changed to: obs_source_info::get_name(void *type_data) obs_output_info::get_name(void *type_data) obs_encoder_info::get_name(void *type_data) obs_service_info::get_name(void *type_data) This allows the type data to be used when getting the name of the object (useful for plugin wrappers primarily). NOTE: Though a parameter was added, this is backward-compatible with older plugins due to calling convention. The new parameter will simply be ignored by older plugins, and the stack (if used) will be cleaned up by the caller.
2015-09-16 01:30:51 -07:00
static const char *crop_filter_get_name(void *unused)
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
{
(API Change) libobs: Pass type data to get_name callbacks API changed from: obs_source_info::get_name(void) obs_output_info::get_name(void) obs_encoder_info::get_name(void) obs_service_info::get_name(void) API changed to: obs_source_info::get_name(void *type_data) obs_output_info::get_name(void *type_data) obs_encoder_info::get_name(void *type_data) obs_service_info::get_name(void *type_data) This allows the type data to be used when getting the name of the object (useful for plugin wrappers primarily). NOTE: Though a parameter was added, this is backward-compatible with older plugins due to calling convention. The new parameter will simply be ignored by older plugins, and the stack (if used) will be cleaned up by the caller.
2015-09-16 01:30:51 -07:00
UNUSED_PARAMETER(unused);
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
return obs_module_text("CropFilter");
}
static void *crop_filter_create(obs_data_t *settings, obs_source_t *context)
{
struct crop_filter_data *filter = bzalloc(sizeof(*filter));
char *effect_path = obs_module_file("crop_filter.effect");
filter->context = context;
obs_enter_graphics();
filter->effect = gs_effect_create_from_file(effect_path, NULL);
obs_leave_graphics();
bfree(effect_path);
if (!filter->effect) {
bfree(filter);
return NULL;
}
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
filter->param_mul =
gs_effect_get_param_by_name(filter->effect, "mul_val");
filter->param_add =
gs_effect_get_param_by_name(filter->effect, "add_val");
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs_source_update(context, settings);
return filter;
}
static void crop_filter_destroy(void *data)
{
struct crop_filter_data *filter = data;
obs_enter_graphics();
gs_effect_destroy(filter->effect);
obs_leave_graphics();
bfree(filter);
}
static void crop_filter_update(void *data, obs_data_t *settings)
{
struct crop_filter_data *filter = data;
filter->absolute = !obs_data_get_bool(settings, "relative");
filter->left = (int)obs_data_get_int(settings, "left");
filter->top = (int)obs_data_get_int(settings, "top");
filter->right = (int)obs_data_get_int(settings, "right");
filter->bottom = (int)obs_data_get_int(settings, "bottom");
filter->abs_cx = (int)obs_data_get_int(settings, "cx");
filter->abs_cy = (int)obs_data_get_int(settings, "cy");
}
static bool relative_clicked(obs_properties_t *props, obs_property_t *p,
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
obs_data_t *settings)
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
{
bool relative = obs_data_get_bool(settings, "relative");
obs_property_set_description(obs_properties_get(props, "left"),
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
relative ? obs_module_text("Crop.Left")
: "X");
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs_property_set_description(obs_properties_get(props, "top"),
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
relative ? obs_module_text("Crop.Top")
: "Y");
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs_property_set_visible(obs_properties_get(props, "right"), relative);
obs_property_set_visible(obs_properties_get(props, "bottom"), relative);
obs_property_set_visible(obs_properties_get(props, "cx"), !relative);
obs_property_set_visible(obs_properties_get(props, "cy"), !relative);
UNUSED_PARAMETER(p);
return true;
}
static obs_properties_t *crop_filter_properties(void *data)
{
obs_properties_t *props = obs_properties_create();
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
obs_property_t *p = obs_properties_add_bool(
props, "relative", obs_module_text("Crop.Relative"));
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs_property_set_modified_callback(p, relative_clicked);
obs_properties_add_int(props, "left", obs_module_text("Crop.Left"),
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
-8192, 8192, 1);
obs_properties_add_int(props, "top", obs_module_text("Crop.Top"), -8192,
8192, 1);
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs_properties_add_int(props, "right", obs_module_text("Crop.Right"),
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
-8192, 8192, 1);
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs_properties_add_int(props, "bottom", obs_module_text("Crop.Bottom"),
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
-8192, 8192, 1);
obs_properties_add_int(props, "cx", obs_module_text("Crop.Width"), 0,
8192, 1);
obs_properties_add_int(props, "cy", obs_module_text("Crop.Height"), 0,
8192, 1);
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
UNUSED_PARAMETER(data);
return props;
}
static void crop_filter_defaults(obs_data_t *settings)
{
obs_data_set_default_bool(settings, "relative", true);
}
static void calc_crop_dimensions(struct crop_filter_data *filter,
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
struct vec2 *mul_val, struct vec2 *add_val)
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
{
obs_source_t *target = obs_filter_get_target(filter->context);
uint32_t width;
uint32_t height;
if (!target) {
width = 0;
height = 0;
obs-filters: Change 'Crop' filter to 'Crop/Pad' filter Allows the ability to pad in addition to cropping. Changes the name to Crop/Pad filter. (Additional edits by Jim: Greatly refactored/simplified filter code) Closes jp9000/obs-studio#532
2016-04-05 10:22:08 -07:00
return;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
} else {
width = obs_source_get_base_width(target);
height = obs_source_get_base_height(target);
}
if (filter->absolute) {
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
filter->width = filter->abs_cx;
obs-filters: Change 'Crop' filter to 'Crop/Pad' filter Allows the ability to pad in addition to cropping. Changes the name to Crop/Pad filter. (Additional edits by Jim: Greatly refactored/simplified filter code) Closes jp9000/obs-studio#532
2016-04-05 10:22:08 -07:00
filter->height = filter->abs_cy;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
} else {
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
filter->width = (int)width - filter->left - filter->right;
obs-filters: Change 'Crop' filter to 'Crop/Pad' filter Allows the ability to pad in addition to cropping. Changes the name to Crop/Pad filter. (Additional edits by Jim: Greatly refactored/simplified filter code) Closes jp9000/obs-studio#532
2016-04-05 10:22:08 -07:00
filter->height = (int)height - filter->top - filter->bottom;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
}
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
if (filter->width < 1)
filter->width = 1;
if (filter->height < 1)
filter->height = 1;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs-filters: Misc code cleanups detected by PVS Studio
2020-05-23 14:44:06 -07:00
if (width) {
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
mul_val->x = (float)filter->width / (float)width;
add_val->x = (float)filter->left / (float)width;
}
obs-filters: Misc code cleanups detected by PVS Studio
2020-05-23 14:44:06 -07:00
if (height) {
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
mul_val->y = (float)filter->height / (float)height;
add_val->y = (float)filter->top / (float)height;
}
}
obs-filters: Reset cx/cy/mul/add crop vals in tick, not render To first render the filter, the width/height values must be set, but currently they're only set in the render function, which means that the crop filter can never be rendered when the program first starts up. This would cause the filter to fail to render at all under those circumstances. This patch moves the calculations from render to tick to ensure that they're always called and the values are always set.
2015-11-20 11:09:32 -08:00
static void crop_filter_tick(void *data, float seconds)
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
{
struct crop_filter_data *filter = data;
obs-filters: Reset cx/cy/mul/add crop vals in tick, not render To first render the filter, the width/height values must be set, but currently they're only set in the render function, which means that the crop filter can never be rendered when the program first starts up. This would cause the filter to fail to render at all under those circumstances. This patch moves the calculations from render to tick to ensure that they're always called and the values are always set.
2015-11-20 11:09:32 -08:00
vec2_zero(&filter->mul_val);
vec2_zero(&filter->add_val);
calc_crop_dimensions(filter, &filter->mul_val, &filter->add_val);
obs-filters: Mark unused parameter
2015-11-20 14:31:01 -08:00
UNUSED_PARAMETER(seconds);
obs-filters: Reset cx/cy/mul/add crop vals in tick, not render To first render the filter, the width/height values must be set, but currently they're only set in the render function, which means that the crop filter can never be rendered when the program first starts up. This would cause the filter to fail to render at all under those circumstances. This patch moves the calculations from render to tick to ensure that they're always called and the values are always set.
2015-11-20 11:09:32 -08:00
}
static void crop_filter_render(void *data, gs_effect_t *effect)
{
struct crop_filter_data *filter = data;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
libobs: Allow filter processing function to return false (Note: this commit also modifies the obs-filters and test-input modules) Changes the obs_source_process_filter_begin return type so that it returns true/false to indicate that filter processing should or should not continue (for example if the filter is bypassed or if there's some other sort of issue that causes the filtering to fail)
2016-04-22 10:15:50 -07:00
if (!obs_source_process_filter_begin(filter->context, GS_RGBA,
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
OBS_NO_DIRECT_RENDERING))
libobs: Allow filter processing function to return false (Note: this commit also modifies the obs-filters and test-input modules) Changes the obs_source_process_filter_begin return type so that it returns true/false to indicate that filter processing should or should not continue (for example if the filter is bypassed or if there's some other sort of issue that causes the filtering to fail)
2016-04-22 10:15:50 -07:00
return;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs-filters: Reset cx/cy/mul/add crop vals in tick, not render To first render the filter, the width/height values must be set, but currently they're only set in the render function, which means that the crop filter can never be rendered when the program first starts up. This would cause the filter to fail to render at all under those circumstances. This patch moves the calculations from render to tick to ensure that they're always called and the values are always set.
2015-11-20 11:09:32 -08:00
gs_effect_set_vec2(filter->param_mul, &filter->mul_val);
gs_effect_set_vec2(filter->param_add, &filter->add_val);
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
obs-filters: Handle premultiplied alpha input Mostly by converting to straight alpha in shader when necessary.
2021-04-27 23:23:05 -07:00
gs_blend_state_push();
gs_blend_function(GS_BLEND_ONE, GS_BLEND_INVSRCALPHA);
libobs, obs-filters: SRGB backwards compatibility Add OBS_SOURCE_SRGB to indicate sources that support SRGB rendering. We can use this flag to know which sources do not know how to handle SRGB, and disable accordingly inside obs_source_main_render(). We can also use this flag to clean up the filter interface and remove the SRGB-specific functions. We also need to disable direct rendering if the filter source wants to render SRGB, but the parent source does not support it. Scenes and groups are marked as having SRGB support, and those are internal sources that we control.
2021-05-02 22:36:37 -07:00
obs_source_process_filter_end(filter->context, filter->effect,
filter->width, filter->height);
obs-filters: Handle premultiplied alpha input Mostly by converting to straight alpha in shader when necessary.
2021-04-27 23:23:05 -07:00
gs_blend_state_pop();
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
UNUSED_PARAMETER(effect);
}
static uint32_t crop_filter_width(void *data)
{
struct crop_filter_data *crop = data;
obs-filters: Change 'Crop' filter to 'Crop/Pad' filter Allows the ability to pad in addition to cropping. Changes the name to Crop/Pad filter. (Additional edits by Jim: Greatly refactored/simplified filter code) Closes jp9000/obs-studio#532
2016-04-05 10:22:08 -07:00
return (uint32_t)crop->width;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
}
static uint32_t crop_filter_height(void *data)
{
struct crop_filter_data *crop = data;
obs-filters: Change 'Crop' filter to 'Crop/Pad' filter Allows the ability to pad in addition to cropping. Changes the name to Crop/Pad filter. (Additional edits by Jim: Greatly refactored/simplified filter code) Closes jp9000/obs-studio#532
2016-04-05 10:22:08 -07:00
return (uint32_t)crop->height;
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
}
struct obs_source_info crop_filter = {
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
.id = "crop_filter",
.type = OBS_SOURCE_TYPE_FILTER,
libobs, obs-filters: SRGB backwards compatibility Add OBS_SOURCE_SRGB to indicate sources that support SRGB rendering. We can use this flag to know which sources do not know how to handle SRGB, and disable accordingly inside obs_source_main_render(). We can also use this flag to clean up the filter interface and remove the SRGB-specific functions. We also need to disable direct rendering if the filter source wants to render SRGB, but the parent source does not support it. Scenes and groups are marked as having SRGB support, and those are internal sources that we control.
2021-05-02 22:36:37 -07:00
.output_flags = OBS_SOURCE_VIDEO | OBS_SOURCE_SRGB,
clang-format: Apply formatting 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.
2019-06-22 22:13:45 -07:00
.get_name = crop_filter_get_name,
.create = crop_filter_create,
.destroy = crop_filter_destroy,
.update = crop_filter_update,
.get_properties = crop_filter_properties,
.get_defaults = crop_filter_defaults,
.video_tick = crop_filter_tick,
.video_render = crop_filter_render,
.get_width = crop_filter_width,
.get_height = crop_filter_height,
obs-filters: Add crop filter Allows any source to be cropped, though note that this renders to texture first, so for more optimal results, cropping values should probably be put in to capture sources that can be cropped as they're actually rendered by the source.
2015-03-21 18:32:06 -07:00
};