obs-studio/plugins/mac-capture/window-utils.h

#import <CoreGraphics/CGWindow.h>
#import <Cocoa/Cocoa.h>

#include <util/threading.h>
#include <obs-module.h>

struct cocoa_window {
    CGWindowID window_id;
    int owner_pid;

    pthread_mutex_t name_lock;
    NSString *owner_name;
    NSString *window_name;

    uint64_t next_search_time;
};
typedef struct cocoa_window *cocoa_window_t;

NSArray *enumerate_cocoa_windows(void);

bool find_window(cocoa_window_t cw, obs_data_t *settings, bool force);

void init_window(cocoa_window_t cw, obs_data_t *settings);

void destroy_window(cocoa_window_t cw);

void update_window(cocoa_window_t cw, obs_data_t *settings);

void window_defaults(obs_data_t *settings);

void add_window_properties(obs_properties_t *props);

void show_window_properties(obs_properties_t *props, bool show);

/** Get the display ID of a display and simultaneously migrate pre-30.0 display IDs to 30.0 UUIDs.
 - Parameter settings: Pointer to `obs_data_t` object containing `display` int and/or `display_uuid` string
 - Returns: `CGDirectDisplayID` of the display the user selected. May be 0 if the display cannot be found. */
CGDirectDisplayID get_display_migrate_settings(obs_data_t *settings);
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00			`#import <CoreGraphics/CGWindow.h>`
			`#import <Cocoa/Cocoa.h>`

			`#include <util/threading.h>`
			`#include <obs-module.h>`

			`struct cocoa_window {`
Apply clang-format to objective c code 2019-07-09 13:29:39 -05:00			`CGWindowID window_id;`
mac-capture: Use int in place of NSNumber for owner_pid 2020-04-07 13:26:46 -04:00			`int owner_pid;`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
Revert "mac-capture: Improve window capture performance" This reverts commit 257715d31f300aa4838784954a8caf567a04855d. Was merged prematurely by mistake (clicked the merge button on the wrong tab). 2021-12-20 14:02:58 -08:00			`pthread_mutex_t name_lock;`
Apply clang-format to objective c code 2019-07-09 13:29:39 -05:00			`NSString *owner_name;`
			`NSString *window_name;`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
Revert "mac-capture: Improve window capture performance" This reverts commit 257715d31f300aa4838784954a8caf567a04855d. Was merged prematurely by mistake (clicked the merge button on the wrong tab). 2021-12-20 14:02:58 -08:00			`uint64_t next_search_time;`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00			`};`
			`typedef struct cocoa_window *cocoa_window_t;`

Revert "mac-capture: Improve window capture performance" This reverts commit 257715d31f300aa4838784954a8caf567a04855d. Was merged prematurely by mistake (clicked the merge button on the wrong tab). 2021-12-20 14:02:58 -08:00			`NSArray *enumerate_cocoa_windows(void);`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
Revert "mac-capture: Improve window capture performance" This reverts commit 257715d31f300aa4838784954a8caf567a04855d. Was merged prematurely by mistake (clicked the merge button on the wrong tab). 2021-12-20 14:02:58 -08:00			`bool find_window(cocoa_window_t cw, obs_data_t *settings, bool force);`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
(API Change) Remove pointers from all typedefs Typedef pointers are unsafe. If you do: typedef struct bla *bla_t; then you cannot use it as a constant, such as: const bla_t, because that constant will be to the pointer itself rather than to the underlying data. I admit this was a fundamental mistake that must be corrected. All typedefs that were pointer types will now have their pointers removed from the type itself, and the pointers will be used when they are actually used as variables/parameters/returns instead. This does not break ABI though, which is pretty nice. 2014-09-25 17:44:05 -07:00			`void init_window(cocoa_window_t cw, obs_data_t *settings);`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
			`void destroy_window(cocoa_window_t cw);`

(API Change) Remove pointers from all typedefs Typedef pointers are unsafe. If you do: typedef struct bla *bla_t; then you cannot use it as a constant, such as: const bla_t, because that constant will be to the pointer itself rather than to the underlying data. I admit this was a fundamental mistake that must be corrected. All typedefs that were pointer types will now have their pointers removed from the type itself, and the pointers will be used when they are actually used as variables/parameters/returns instead. This does not break ABI though, which is pretty nice. 2014-09-25 17:44:05 -07:00			`void update_window(cocoa_window_t cw, obs_data_t *settings);`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
(API Change) Remove pointers from all typedefs Typedef pointers are unsafe. If you do: typedef struct bla *bla_t; then you cannot use it as a constant, such as: const bla_t, because that constant will be to the pointer itself rather than to the underlying data. I admit this was a fundamental mistake that must be corrected. All typedefs that were pointer types will now have their pointers removed from the type itself, and the pointers will be used when they are actually used as variables/parameters/returns instead. This does not break ABI though, which is pretty nice. 2014-09-25 17:44:05 -07:00			`void window_defaults(obs_data_t *settings);`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
(API Change) Remove pointers from all typedefs Typedef pointers are unsafe. If you do: typedef struct bla *bla_t; then you cannot use it as a constant, such as: const bla_t, because that constant will be to the pointer itself rather than to the underlying data. I admit this was a fundamental mistake that must be corrected. All typedefs that were pointer types will now have their pointers removed from the type itself, and the pointers will be used when they are actually used as variables/parameters/returns instead. This does not break ABI though, which is pretty nice. 2014-09-25 17:44:05 -07:00			`void add_window_properties(obs_properties_t *props);`
Add CoreGraphics window utilities 2014-08-20 00:36:24 +02:00
(API Change) Remove pointers from all typedefs Typedef pointers are unsafe. If you do: typedef struct bla *bla_t; then you cannot use it as a constant, such as: const bla_t, because that constant will be to the pointer itself rather than to the underlying data. I admit this was a fundamental mistake that must be corrected. All typedefs that were pointer types will now have their pointers removed from the type itself, and the pointers will be used when they are actually used as variables/parameters/returns instead. This does not break ABI though, which is pretty nice. 2014-09-25 17:44:05 -07:00			`void show_window_properties(obs_properties_t *props, bool show);`
mac-capture: Don't crash when migrating unknown display IDs The current code assumes that a display UUID can be created with the stored ID, but that's not always the case, e.g. when the user doesn't have the display connected. As such, we need to null check this, and fall back to the invalid ID (0) when the ID cannot be migrated. The current code also only migrates on source creation, which yields weird behaviour where if the user opens properties and then cancels it would still show the first display, but only for the session. This is why the code was factored out of the creation function and now is always used when an ID needs to be acquired from OBS Data settings, including when the source is updated. 2023-09-25 21:36:26 +02:00
			`/** Get the display ID of a display and simultaneously migrate pre-30.0 display IDs to 30.0 UUIDs.`
			- Parameter settings: Pointer to `obs_data_t` object containing `display` int and/or `display_uuid` string
			- Returns: `CGDirectDisplayID` of the display the user selected. May be 0 if the display cannot be found. */
			`CGDirectDisplayID get_display_migrate_settings(obs_data_t *settings);`