nvidia-greenscreen-filter.c 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079
  1. #include <obs-module.h>
  2. #include <util/threading.h>
  3. #include <dxgi.h>
  4. #include <d3d11.h>
  5. #include <d3d11_1.h>
  6. #include "nvvfx-load.h"
  7. /* -------------------------------------------------------- */
  8. #define do_log(level, format, ...) \
  9. blog(level, \
  10. "[NVIDIA AI Greenscreen (Background removal): '%s'] " format, \
  11. obs_source_get_name(filter->context), ##__VA_ARGS__)
  12. #define warn(format, ...) do_log(LOG_WARNING, format, ##__VA_ARGS__)
  13. #define info(format, ...) do_log(LOG_INFO, format, ##__VA_ARGS__)
  14. #define error(format, ...) do_log(LOG_ERROR, format, ##__VA_ARGS__)
  15. #ifdef _DEBUG
  16. #define debug(format, ...) do_log(LOG_DEBUG, format, ##__VA_ARGS__)
  17. #else
  18. #define debug(format, ...)
  19. #endif
  20. /* -------------------------------------------------------- */
  21. #define S_MODE "mode"
  22. #define S_MODE_QUALITY 0
  23. #define S_MODE_PERF 1
  24. #define S_THRESHOLDFX "threshold"
  25. #define S_THRESHOLDFX_DEFAULT 1.0
  26. #define S_PROCESSING "processing_interval"
  27. #define MT_ obs_module_text
  28. #define TEXT_MODE MT_("Greenscreen.Mode")
  29. #define TEXT_MODE_QUALITY MT_("Greenscreen.Quality")
  30. #define TEXT_MODE_PERF MT_("Greenscreen.Performance")
  31. #define TEXT_MODE_THRESHOLD MT_("Greenscreen.Threshold")
  32. #define TEXT_DEPRECATION MT_("Greenscreen.Deprecation")
  33. #define TEXT_PROCESSING MT_("Greenscreen.Processing")
  34. #define TEXT_PROCESSING_HINT MT_("Greenscreen.Processing.Hint")
  35. bool nvvfx_loaded = false;
  36. bool nvvfx_new_sdk = false;
  37. struct nv_greenscreen_data {
  38. obs_source_t *context;
  39. bool images_allocated;
  40. bool initial_render;
  41. volatile bool processing_stop;
  42. bool processed_frame;
  43. bool target_valid;
  44. bool got_new_frame;
  45. signal_handler_t *handler;
  46. /* RTX SDK vars */
  47. NvVFX_Handle handle;
  48. CUstream stream; // CUDA stream
  49. int mode; // 0 = quality, 1 = performance
  50. NvCVImage *src_img; // src img in obs format (RGBA ?) on GPU
  51. NvCVImage *BGR_src_img; // src img in BGR on GPU
  52. NvCVImage *A_dst_img; // mask img on GPU
  53. NvCVImage *dst_img; // mask texture
  54. NvCVImage *stage; // planar stage img used for transfer to texture
  55. unsigned int version;
  56. NvVFX_StateObjectHandle stateObjectHandle;
  57. /* alpha mask effect */
  58. gs_effect_t *effect;
  59. gs_texrender_t *render;
  60. gs_texrender_t *render_unorm;
  61. gs_texture_t *alpha_texture;
  62. uint32_t width; // width of texture
  63. uint32_t height; // height of texture
  64. enum gs_color_space space;
  65. gs_eparam_t *mask_param;
  66. gs_eparam_t *image_param;
  67. gs_eparam_t *threshold_param;
  68. gs_eparam_t *multiplier_param;
  69. float threshold;
  70. /* Every nth frame is processed through the FX (where n =
  71. * processing_interval) so that the same mask is used for n consecutive
  72. * frames. This is to alleviate the GPU load. Default: 1 (process every frame).
  73. */
  74. int processing_interval;
  75. int processing_counter;
  76. };
  77. static const char *nv_greenscreen_filter_name(void *unused)
  78. {
  79. UNUSED_PARAMETER(unused);
  80. return obs_module_text("NvidiaGreenscreenFilter");
  81. }
  82. static void nv_greenscreen_filter_update(void *data, obs_data_t *settings)
  83. {
  84. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  85. NvCV_Status vfxErr;
  86. int mode = (int)obs_data_get_int(settings, S_MODE);
  87. if (filter->mode != mode) {
  88. filter->mode = mode;
  89. vfxErr = NvVFX_SetU32(filter->handle, NVVFX_MODE, mode);
  90. vfxErr = NvVFX_Load(filter->handle);
  91. if (NVCV_SUCCESS != vfxErr)
  92. error("Error loading AI Greenscreen FX %i", vfxErr);
  93. }
  94. filter->threshold = (float)obs_data_get_double(settings, S_THRESHOLDFX);
  95. filter->processing_interval =
  96. (int)obs_data_get_int(settings, S_PROCESSING);
  97. }
  98. static void nv_greenscreen_filter_actual_destroy(void *data)
  99. {
  100. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  101. if (!nvvfx_loaded) {
  102. bfree(filter);
  103. return;
  104. }
  105. os_atomic_set_bool(&filter->processing_stop, true);
  106. if (filter->images_allocated) {
  107. obs_enter_graphics();
  108. gs_texture_destroy(filter->alpha_texture);
  109. gs_texrender_destroy(filter->render);
  110. gs_texrender_destroy(filter->render_unorm);
  111. obs_leave_graphics();
  112. NvCVImage_Destroy(filter->src_img);
  113. NvCVImage_Destroy(filter->BGR_src_img);
  114. NvCVImage_Destroy(filter->A_dst_img);
  115. NvCVImage_Destroy(filter->dst_img);
  116. NvCVImage_Destroy(filter->stage);
  117. }
  118. if (filter->stream) {
  119. NvVFX_CudaStreamDestroy(filter->stream);
  120. }
  121. if (filter->handle) {
  122. if (filter->stateObjectHandle) {
  123. NvVFX_DeallocateState(filter->handle,
  124. filter->stateObjectHandle);
  125. }
  126. NvVFX_DestroyEffect(filter->handle);
  127. }
  128. if (filter->effect) {
  129. obs_enter_graphics();
  130. gs_effect_destroy(filter->effect);
  131. obs_leave_graphics();
  132. }
  133. bfree(filter);
  134. }
  135. static void nv_greenscreen_filter_destroy(void *data)
  136. {
  137. obs_queue_task(OBS_TASK_GRAPHICS, nv_greenscreen_filter_actual_destroy,
  138. data, false);
  139. }
  140. static void nv_greenscreen_filter_reset(void *data, calldata_t *calldata)
  141. {
  142. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  143. NvCV_Status vfxErr;
  144. os_atomic_set_bool(&filter->processing_stop, true);
  145. // first destroy
  146. if (filter->stream) {
  147. NvVFX_CudaStreamDestroy(filter->stream);
  148. }
  149. if (filter->handle) {
  150. if (filter->stateObjectHandle) {
  151. NvVFX_DeallocateState(filter->handle,
  152. filter->stateObjectHandle);
  153. }
  154. NvVFX_DestroyEffect(filter->handle);
  155. }
  156. // recreate
  157. /* 1. Create FX */
  158. vfxErr = NvVFX_CreateEffect(NVVFX_FX_GREEN_SCREEN, &filter->handle);
  159. if (NVCV_SUCCESS != vfxErr) {
  160. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  161. error("Error recreating AI Greenscreen FX; error %i: %s",
  162. vfxErr, errString);
  163. nv_greenscreen_filter_destroy(filter);
  164. }
  165. /* 2. Set models path & initialize CudaStream */
  166. char buffer[MAX_PATH];
  167. char modelDir[MAX_PATH];
  168. nvvfx_get_sdk_path(buffer, MAX_PATH);
  169. size_t max_len = sizeof(buffer) / sizeof(char);
  170. snprintf(modelDir, max_len, "%s\\models", buffer);
  171. vfxErr = NvVFX_SetString(filter->handle, NVVFX_MODEL_DIRECTORY,
  172. modelDir);
  173. vfxErr = NvVFX_CudaStreamCreate(&filter->stream);
  174. if (NVCV_SUCCESS != vfxErr) {
  175. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  176. error("Error creating CUDA Stream; error %i: %s", vfxErr,
  177. errString);
  178. nv_greenscreen_filter_destroy(filter);
  179. }
  180. vfxErr = NvVFX_SetCudaStream(filter->handle, NVVFX_CUDA_STREAM,
  181. filter->stream);
  182. if (NVCV_SUCCESS != vfxErr) {
  183. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  184. error("Error setting CUDA Stream %i", vfxErr);
  185. nv_greenscreen_filter_destroy(filter);
  186. }
  187. /* 3. load FX */
  188. vfxErr = NvVFX_SetU32(filter->handle, NVVFX_MODE, filter->mode);
  189. vfxErr = NvVFX_Load(filter->handle);
  190. if (NVCV_SUCCESS != vfxErr)
  191. error("Error loading AI Greenscreen FX %i", vfxErr);
  192. filter->images_allocated = false;
  193. os_atomic_set_bool(&filter->processing_stop, false);
  194. }
  195. static void init_images_greenscreen(struct nv_greenscreen_data *filter)
  196. {
  197. NvCV_Status vfxErr;
  198. uint32_t width = filter->width;
  199. uint32_t height = filter->height;
  200. /* 1. create alpha texture */
  201. if (filter->alpha_texture) {
  202. gs_texture_destroy(filter->alpha_texture);
  203. }
  204. filter->alpha_texture =
  205. gs_texture_create(width, height, GS_A8, 1, NULL, 0);
  206. if (filter->alpha_texture == NULL) {
  207. error("Alpha texture couldn't be created");
  208. goto fail;
  209. }
  210. struct ID3D11Texture2D *d11texture =
  211. (struct ID3D11Texture2D *)gs_texture_get_obj(
  212. filter->alpha_texture);
  213. /* 2. Create NvCVImage which will hold final alpha texture. */
  214. if (!filter->dst_img &&
  215. (NvCVImage_Create(width, height, NVCV_A, NVCV_U8, NVCV_CHUNKY,
  216. NVCV_GPU, 1, &filter->dst_img) != NVCV_SUCCESS)) {
  217. goto fail;
  218. }
  219. vfxErr = NvCVImage_InitFromD3D11Texture(filter->dst_img, d11texture);
  220. if (vfxErr != NVCV_SUCCESS) {
  221. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  222. error("Error passing dst ID3D11Texture to img; error %i: %s",
  223. vfxErr, errString);
  224. goto fail;
  225. }
  226. /* 3. create texrenders */
  227. if (filter->render)
  228. gs_texrender_destroy(filter->render);
  229. filter->render = gs_texrender_create(
  230. gs_get_format_from_space(filter->space), GS_ZS_NONE);
  231. if (!filter->render) {
  232. error("Failed to create render texrenderer");
  233. goto fail;
  234. }
  235. if (filter->render_unorm)
  236. gs_texrender_destroy(filter->render_unorm);
  237. filter->render_unorm = gs_texrender_create(GS_BGRA_UNORM, GS_ZS_NONE);
  238. if (!filter->render_unorm) {
  239. error("Failed to create render_unorm texrenderer");
  240. goto fail;
  241. }
  242. /* 4. Create and allocate BGR NvCVImage (fx src). */
  243. if (filter->BGR_src_img) {
  244. if (NvCVImage_Realloc(filter->BGR_src_img, width, height,
  245. NVCV_BGR, NVCV_U8, NVCV_CHUNKY, NVCV_GPU,
  246. 1) != NVCV_SUCCESS) {
  247. goto fail;
  248. }
  249. } else {
  250. if (NvCVImage_Create(width, height, NVCV_BGR, NVCV_U8,
  251. NVCV_CHUNKY, NVCV_GPU, 1,
  252. &filter->BGR_src_img) != NVCV_SUCCESS) {
  253. goto fail;
  254. }
  255. if (NvCVImage_Alloc(filter->BGR_src_img, width, height,
  256. NVCV_BGR, NVCV_U8, NVCV_CHUNKY, NVCV_GPU,
  257. 1) != NVCV_SUCCESS) {
  258. goto fail;
  259. }
  260. }
  261. /* 5. Create and allocate Alpha NvCVimage (fx dst). */
  262. if (filter->A_dst_img) {
  263. if (NvCVImage_Realloc(filter->A_dst_img, width, height, NVCV_A,
  264. NVCV_U8, NVCV_CHUNKY, NVCV_GPU,
  265. 1) != NVCV_SUCCESS) {
  266. goto fail;
  267. }
  268. } else {
  269. if (NvCVImage_Create(width, height, NVCV_A, NVCV_U8,
  270. NVCV_CHUNKY, NVCV_GPU, 1,
  271. &filter->A_dst_img) != NVCV_SUCCESS) {
  272. goto fail;
  273. }
  274. if (NvCVImage_Alloc(filter->A_dst_img, width, height, NVCV_A,
  275. NVCV_U8, NVCV_CHUNKY, NVCV_GPU,
  276. 1) != NVCV_SUCCESS) {
  277. goto fail;
  278. }
  279. }
  280. /* 6. Create stage NvCVImage which will be used as buffer for transfer */
  281. if (filter->stage) {
  282. if (NvCVImage_Realloc(filter->stage, width, height, NVCV_RGBA,
  283. NVCV_U8, NVCV_PLANAR, NVCV_GPU,
  284. 1) != NVCV_SUCCESS) {
  285. goto fail;
  286. }
  287. } else {
  288. if (NvCVImage_Create(width, height, NVCV_RGBA, NVCV_U8,
  289. NVCV_PLANAR, NVCV_GPU, 1,
  290. &filter->stage) != NVCV_SUCCESS) {
  291. goto fail;
  292. }
  293. if (NvCVImage_Alloc(filter->stage, width, height, NVCV_RGBA,
  294. NVCV_U8, NVCV_PLANAR, NVCV_GPU,
  295. 1) != NVCV_SUCCESS) {
  296. goto fail;
  297. }
  298. }
  299. /* 7. Set input & output images for nv FX. */
  300. if (NvVFX_SetImage(filter->handle, NVVFX_INPUT_IMAGE,
  301. filter->BGR_src_img) != NVCV_SUCCESS) {
  302. goto fail;
  303. }
  304. if (NvVFX_SetImage(filter->handle, NVVFX_OUTPUT_IMAGE,
  305. filter->A_dst_img) != NVCV_SUCCESS) {
  306. goto fail;
  307. }
  308. filter->images_allocated = true;
  309. return;
  310. fail:
  311. error("Error during allocation of images");
  312. os_atomic_set_bool(&filter->processing_stop, true);
  313. return;
  314. }
  315. static bool process_texture_greenscreen(struct nv_greenscreen_data *filter)
  316. {
  317. /* 1. Map src img holding texture. */
  318. NvCV_Status vfxErr =
  319. NvCVImage_MapResource(filter->src_img, filter->stream);
  320. if (vfxErr != NVCV_SUCCESS) {
  321. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  322. error("Error mapping resource for source texture; error %i : %s",
  323. vfxErr, errString);
  324. goto fail;
  325. }
  326. /* 2. Convert to BGR. */
  327. vfxErr = NvCVImage_Transfer(filter->src_img, filter->BGR_src_img, 1.0f,
  328. filter->stream, filter->stage);
  329. if (vfxErr != NVCV_SUCCESS) {
  330. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  331. error("Error converting src to BGR img; error %i: %s", vfxErr,
  332. errString);
  333. goto fail;
  334. }
  335. vfxErr = NvCVImage_UnmapResource(filter->src_img, filter->stream);
  336. if (vfxErr != NVCV_SUCCESS) {
  337. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  338. error("Error unmapping resource for src texture; error %i: %s",
  339. vfxErr, errString);
  340. goto fail;
  341. }
  342. /* 3. run RTX fx */
  343. vfxErr = NvVFX_Run(filter->handle, 1);
  344. if (vfxErr != NVCV_SUCCESS) {
  345. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  346. error("Error running the FX; error %i: %s", vfxErr, errString);
  347. if (vfxErr == NVCV_ERR_CUDA)
  348. nv_greenscreen_filter_reset(filter, NULL);
  349. }
  350. /* 4. Map dst texture before transfer from dst img provided by FX */
  351. vfxErr = NvCVImage_MapResource(filter->dst_img, filter->stream);
  352. if (vfxErr != NVCV_SUCCESS) {
  353. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  354. error("Error mapping resource for dst texture; error %i: %s",
  355. vfxErr, errString);
  356. goto fail;
  357. }
  358. vfxErr = NvCVImage_Transfer(filter->A_dst_img, filter->dst_img, 1.0f,
  359. filter->stream, filter->stage);
  360. if (vfxErr != NVCV_SUCCESS) {
  361. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  362. error("Error transferring mask to alpha texture; error %i: %s ",
  363. vfxErr, errString);
  364. goto fail;
  365. }
  366. vfxErr = NvCVImage_UnmapResource(filter->dst_img, filter->stream);
  367. if (vfxErr != NVCV_SUCCESS) {
  368. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  369. error("Error unmapping resource for dst texture; error %i: %s",
  370. vfxErr, errString);
  371. goto fail;
  372. }
  373. return true;
  374. fail:
  375. os_atomic_set_bool(&filter->processing_stop, true);
  376. return false;
  377. }
  378. static void *nv_greenscreen_filter_create(obs_data_t *settings,
  379. obs_source_t *context)
  380. {
  381. struct nv_greenscreen_data *filter =
  382. (struct nv_greenscreen_data *)bzalloc(sizeof(*filter));
  383. if (!nvvfx_loaded) {
  384. nv_greenscreen_filter_destroy(filter);
  385. return NULL;
  386. }
  387. NvCV_Status vfxErr;
  388. filter->context = context;
  389. filter->mode = -1; // should be 0 or 1; -1 triggers an update
  390. filter->images_allocated = false;
  391. filter->processed_frame = true; // start processing when false
  392. filter->width = 0;
  393. filter->height = 0;
  394. filter->initial_render = false;
  395. os_atomic_set_bool(&filter->processing_stop, false);
  396. filter->handler = NULL;
  397. filter->processing_interval = 1;
  398. filter->processing_counter = 0;
  399. /* 1. Create FX */
  400. vfxErr = NvVFX_CreateEffect(NVVFX_FX_GREEN_SCREEN, &filter->handle);
  401. if (NVCV_SUCCESS != vfxErr) {
  402. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  403. error("Error creating AI Greenscreen FX; error %i: %s", vfxErr,
  404. errString);
  405. nv_greenscreen_filter_destroy(filter);
  406. return NULL;
  407. }
  408. /* 2. Set models path & initialize CudaStream */
  409. char buffer[MAX_PATH];
  410. char modelDir[MAX_PATH];
  411. nvvfx_get_sdk_path(buffer, MAX_PATH);
  412. size_t max_len = sizeof(buffer) / sizeof(char);
  413. snprintf(modelDir, max_len, "%s\\models", buffer);
  414. vfxErr = NvVFX_SetString(filter->handle, NVVFX_MODEL_DIRECTORY,
  415. modelDir);
  416. vfxErr = NvVFX_CudaStreamCreate(&filter->stream);
  417. if (NVCV_SUCCESS != vfxErr) {
  418. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  419. error("Error creating CUDA Stream; error %i: %s", vfxErr,
  420. errString);
  421. nv_greenscreen_filter_destroy(filter);
  422. return NULL;
  423. }
  424. vfxErr = NvVFX_SetCudaStream(filter->handle, NVVFX_CUDA_STREAM,
  425. filter->stream);
  426. if (NVCV_SUCCESS != vfxErr) {
  427. const char *errString = NvCV_GetErrorStringFromCode(vfxErr);
  428. error("Error setting CUDA Stream %i", vfxErr);
  429. nv_greenscreen_filter_destroy(filter);
  430. return NULL;
  431. }
  432. /* check sdk version */
  433. if (NvVFX_GetVersion(&filter->version) == NVCV_SUCCESS) {
  434. uint8_t major = (filter->version >> 24) & 0xff;
  435. uint8_t minor = (filter->version >> 16) & 0x00ff;
  436. uint8_t build = (filter->version >> 8) & 0x0000ff;
  437. uint8_t revision = (filter->version >> 0) & 0x000000ff;
  438. // sanity check
  439. nvvfx_new_sdk = filter->version >= MIN_VFX_SDK_VERSION &&
  440. nvvfx_new_sdk;
  441. }
  442. /* 3. Load alpha mask effect. */
  443. char *effect_path = obs_module_file("rtx_greenscreen.effect");
  444. obs_enter_graphics();
  445. filter->effect = gs_effect_create_from_file(effect_path, NULL);
  446. bfree(effect_path);
  447. if (filter->effect) {
  448. filter->mask_param =
  449. gs_effect_get_param_by_name(filter->effect, "mask");
  450. filter->image_param =
  451. gs_effect_get_param_by_name(filter->effect, "image");
  452. filter->threshold_param = gs_effect_get_param_by_name(
  453. filter->effect, "threshold");
  454. filter->multiplier_param = gs_effect_get_param_by_name(
  455. filter->effect, "multiplier");
  456. }
  457. obs_leave_graphics();
  458. /* 4. Allocate state for the effect */
  459. if (nvvfx_new_sdk) {
  460. vfxErr = NvVFX_AllocateState(filter->handle,
  461. &filter->stateObjectHandle);
  462. if (NVCV_SUCCESS != vfxErr) {
  463. const char *errString =
  464. NvCV_GetErrorStringFromCode(vfxErr);
  465. error("Error allocating FX state %i", vfxErr);
  466. nv_greenscreen_filter_destroy(filter);
  467. return NULL;
  468. }
  469. vfxErr = NvVFX_SetStateObjectHandleArray(
  470. filter->handle, NVVFX_STATE,
  471. &filter->stateObjectHandle);
  472. if (NVCV_SUCCESS != vfxErr) {
  473. const char *errString =
  474. NvCV_GetErrorStringFromCode(vfxErr);
  475. error("Error setting FX state %i", vfxErr);
  476. nv_greenscreen_filter_destroy(filter);
  477. return NULL;
  478. }
  479. }
  480. if (!filter->effect) {
  481. nv_greenscreen_filter_destroy(filter);
  482. return NULL;
  483. }
  484. /*---------------------------------------- */
  485. nv_greenscreen_filter_update(filter, settings);
  486. return filter;
  487. }
  488. static obs_properties_t *nv_greenscreen_filter_properties(void *data)
  489. {
  490. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  491. obs_properties_t *props = obs_properties_create();
  492. obs_property_t *mode = obs_properties_add_list(props, S_MODE, TEXT_MODE,
  493. OBS_COMBO_TYPE_LIST,
  494. OBS_COMBO_FORMAT_INT);
  495. obs_property_list_add_int(mode, TEXT_MODE_QUALITY, S_MODE_QUALITY);
  496. obs_property_list_add_int(mode, TEXT_MODE_PERF, S_MODE_PERF);
  497. obs_property_t *threshold = obs_properties_add_float_slider(
  498. props, S_THRESHOLDFX, TEXT_MODE_THRESHOLD, 0, 1, 0.05);
  499. obs_property_t *partial = obs_properties_add_int_slider(
  500. props, S_PROCESSING, TEXT_PROCESSING, 1, 4, 1);
  501. obs_property_set_long_description(partial, TEXT_PROCESSING_HINT);
  502. unsigned int version = get_lib_version();
  503. if (version && version < MIN_VFX_SDK_VERSION) {
  504. obs_property_t *warning = obs_properties_add_text(
  505. props, "deprecation", NULL, OBS_TEXT_INFO);
  506. obs_property_text_set_info_type(warning, OBS_TEXT_INFO_WARNING);
  507. obs_property_set_long_description(warning, TEXT_DEPRECATION);
  508. }
  509. return props;
  510. }
  511. static void nv_greenscreen_filter_defaults(obs_data_t *settings)
  512. {
  513. obs_data_set_default_int(settings, S_MODE, S_MODE_QUALITY);
  514. obs_data_set_default_double(settings, S_THRESHOLDFX,
  515. S_THRESHOLDFX_DEFAULT);
  516. obs_data_set_default_int(settings, S_PROCESSING, 1);
  517. }
  518. static struct obs_source_frame *
  519. nv_greenscreen_filter_video(void *data, struct obs_source_frame *frame)
  520. {
  521. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  522. filter->got_new_frame = true;
  523. return frame;
  524. }
  525. static void nv_greenscreen_filter_tick(void *data, float t)
  526. {
  527. UNUSED_PARAMETER(t);
  528. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  529. if (filter->processing_stop) {
  530. return;
  531. }
  532. if (!obs_filter_get_target(filter->context)) {
  533. return;
  534. }
  535. obs_source_t *target = obs_filter_get_target(filter->context);
  536. filter->target_valid = true;
  537. const uint32_t cx = obs_source_get_base_width(target);
  538. const uint32_t cy = obs_source_get_base_height(target);
  539. // initially the sizes are 0
  540. if (!cx && !cy) {
  541. filter->target_valid = false;
  542. return;
  543. }
  544. /* minimum size supported by SDK is (512,288) */
  545. filter->target_valid = cx >= 512 && cy >= 288;
  546. if (!filter->target_valid) {
  547. error("Size must be larger than (512,288)");
  548. return;
  549. }
  550. if (cx != filter->width && cy != filter->height) {
  551. filter->images_allocated = false;
  552. filter->width = cx;
  553. filter->height = cy;
  554. }
  555. if (!filter->images_allocated) {
  556. obs_enter_graphics();
  557. init_images_greenscreen(filter);
  558. obs_leave_graphics();
  559. filter->initial_render = false;
  560. }
  561. filter->processed_frame = false;
  562. }
  563. static const char *
  564. get_tech_name_and_multiplier(enum gs_color_space current_space,
  565. enum gs_color_space source_space,
  566. float *multiplier)
  567. {
  568. const char *tech_name = "Draw";
  569. *multiplier = 1.f;
  570. switch (source_space) {
  571. case GS_CS_SRGB:
  572. case GS_CS_SRGB_16F:
  573. if (current_space == GS_CS_709_SCRGB) {
  574. tech_name = "DrawMultiply";
  575. *multiplier = obs_get_video_sdr_white_level() / 80.0f;
  576. }
  577. break;
  578. case GS_CS_709_EXTENDED:
  579. switch (current_space) {
  580. case GS_CS_SRGB:
  581. case GS_CS_SRGB_16F:
  582. tech_name = "DrawTonemap";
  583. break;
  584. case GS_CS_709_SCRGB:
  585. tech_name = "DrawMultiply";
  586. *multiplier = obs_get_video_sdr_white_level() / 80.0f;
  587. }
  588. break;
  589. case GS_CS_709_SCRGB:
  590. switch (current_space) {
  591. case GS_CS_SRGB:
  592. case GS_CS_SRGB_16F:
  593. tech_name = "DrawMultiplyTonemap";
  594. *multiplier = 80.0f / obs_get_video_sdr_white_level();
  595. break;
  596. case GS_CS_709_EXTENDED:
  597. tech_name = "DrawMultiply";
  598. *multiplier = 80.0f / obs_get_video_sdr_white_level();
  599. }
  600. }
  601. return tech_name;
  602. }
  603. static void draw_greenscreen(struct nv_greenscreen_data *filter)
  604. {
  605. /* Render alpha mask */
  606. const enum gs_color_space source_space = filter->space;
  607. float multiplier;
  608. const char *technique = get_tech_name_and_multiplier(
  609. gs_get_color_space(), source_space, &multiplier);
  610. const enum gs_color_format format =
  611. gs_get_format_from_space(source_space);
  612. if (obs_source_process_filter_begin_with_color_space(
  613. filter->context, format, source_space,
  614. OBS_ALLOW_DIRECT_RENDERING)) {
  615. gs_effect_set_texture(filter->mask_param,
  616. filter->alpha_texture);
  617. gs_effect_set_texture_srgb(
  618. filter->image_param,
  619. gs_texrender_get_texture(filter->render));
  620. gs_effect_set_float(filter->threshold_param, filter->threshold);
  621. gs_effect_set_float(filter->multiplier_param, multiplier);
  622. gs_blend_state_push();
  623. gs_blend_function(GS_BLEND_ONE, GS_BLEND_INVSRCALPHA);
  624. obs_source_process_filter_tech_end(
  625. filter->context, filter->effect, 0, 0, technique);
  626. gs_blend_state_pop();
  627. }
  628. }
  629. static void nv_greenscreen_filter_render(void *data, gs_effect_t *effect)
  630. {
  631. NvCV_Status vfxErr;
  632. struct nv_greenscreen_data *filter = (struct nv_greenscreen_data *)data;
  633. if (filter->processing_stop) {
  634. obs_source_skip_video_filter(filter->context);
  635. return;
  636. }
  637. obs_source_t *const target = obs_filter_get_target(filter->context);
  638. obs_source_t *const parent = obs_filter_get_parent(filter->context);
  639. /* Skip if processing of a frame hasn't yet started */
  640. if (!filter->target_valid || !target || !parent) {
  641. obs_source_skip_video_filter(filter->context);
  642. return;
  643. }
  644. /* Render processed image from earlier in the frame */
  645. if (filter->processed_frame) {
  646. draw_greenscreen(filter);
  647. return;
  648. }
  649. if (parent && !filter->handler) {
  650. filter->handler = obs_source_get_signal_handler(parent);
  651. signal_handler_connect(filter->handler, "update",
  652. nv_greenscreen_filter_reset, filter);
  653. }
  654. /* 1. Render to retrieve texture. */
  655. if (!filter->render) {
  656. obs_source_skip_video_filter(filter->context);
  657. return;
  658. }
  659. const uint32_t target_flags = obs_source_get_output_flags(target);
  660. const uint32_t parent_flags = obs_source_get_output_flags(parent);
  661. bool custom_draw = (target_flags & OBS_SOURCE_CUSTOM_DRAW) != 0;
  662. bool async = (target_flags & OBS_SOURCE_ASYNC) != 0;
  663. const enum gs_color_space preferred_spaces[] = {
  664. GS_CS_SRGB,
  665. GS_CS_SRGB_16F,
  666. GS_CS_709_EXTENDED,
  667. };
  668. const enum gs_color_space source_space = obs_source_get_color_space(
  669. target, OBS_COUNTOF(preferred_spaces), preferred_spaces);
  670. if (filter->space != source_space) {
  671. filter->space = source_space;
  672. init_images_greenscreen(filter);
  673. filter->initial_render = false;
  674. }
  675. gs_texrender_t *const render = filter->render;
  676. gs_texrender_reset(render);
  677. gs_blend_state_push();
  678. gs_blend_function(GS_BLEND_ONE, GS_BLEND_ZERO);
  679. if (gs_texrender_begin_with_color_space(render, filter->width,
  680. filter->height, source_space)) {
  681. struct vec4 clear_color;
  682. vec4_zero(&clear_color);
  683. gs_clear(GS_CLEAR_COLOR, &clear_color, 0.0f, 0);
  684. gs_ortho(0.0f, (float)filter->width, 0.0f,
  685. (float)filter->height, -100.0f, 100.0f);
  686. if (target == parent && !custom_draw && !async)
  687. obs_source_default_render(target);
  688. else
  689. obs_source_video_render(target);
  690. gs_texrender_end(render);
  691. gs_texrender_t *const render_unorm = filter->render_unorm;
  692. gs_texrender_reset(render_unorm);
  693. if (gs_texrender_begin_with_color_space(
  694. render_unorm, filter->width, filter->height,
  695. GS_CS_SRGB)) {
  696. const bool previous = gs_framebuffer_srgb_enabled();
  697. gs_enable_framebuffer_srgb(true);
  698. gs_enable_blending(false);
  699. gs_ortho(0.0f, (float)filter->width, 0.0f,
  700. (float)filter->height, -100.0f, 100.0f);
  701. const char *tech_name = "ConvertUnorm";
  702. float multiplier = 1.f;
  703. switch (source_space) {
  704. case GS_CS_709_EXTENDED:
  705. tech_name = "ConvertUnormTonemap";
  706. break;
  707. case GS_CS_709_SCRGB:
  708. tech_name = "ConvertUnormMultiplyTonemap";
  709. multiplier =
  710. 80.0f / obs_get_video_sdr_white_level();
  711. }
  712. gs_effect_set_texture_srgb(
  713. filter->image_param,
  714. gs_texrender_get_texture(render));
  715. gs_effect_set_float(filter->multiplier_param,
  716. multiplier);
  717. while (gs_effect_loop(filter->effect, tech_name)) {
  718. gs_draw(GS_TRIS, 0, 3);
  719. }
  720. gs_texrender_end(render_unorm);
  721. gs_enable_blending(true);
  722. gs_enable_framebuffer_srgb(previous);
  723. }
  724. }
  725. gs_blend_state_pop();
  726. /* 2. Initialize src_texture (only at startup or reset) */
  727. if (!filter->initial_render) {
  728. struct ID3D11Texture2D *d11texture2 =
  729. (struct ID3D11Texture2D *)gs_texture_get_obj(
  730. gs_texrender_get_texture(filter->render_unorm));
  731. if (!d11texture2) {
  732. error("Couldn't retrieve d3d11texture2d.");
  733. return;
  734. }
  735. if (!filter->src_img) {
  736. vfxErr = NvCVImage_Create(filter->width, filter->height,
  737. NVCV_BGRA, NVCV_U8,
  738. NVCV_CHUNKY, NVCV_GPU, 1,
  739. &filter->src_img);
  740. if (vfxErr != NVCV_SUCCESS) {
  741. const char *errString =
  742. NvCV_GetErrorStringFromCode(vfxErr);
  743. error("Error creating src img; error %i: %s",
  744. vfxErr, errString);
  745. os_atomic_set_bool(&filter->processing_stop,
  746. true);
  747. return;
  748. }
  749. }
  750. vfxErr = NvCVImage_InitFromD3D11Texture(filter->src_img,
  751. d11texture2);
  752. if (vfxErr != NVCV_SUCCESS) {
  753. const char *errString =
  754. NvCV_GetErrorStringFromCode(vfxErr);
  755. error("Error passing src ID3D11Texture to img; error %i: %s",
  756. vfxErr, errString);
  757. os_atomic_set_bool(&filter->processing_stop, true);
  758. return;
  759. }
  760. filter->initial_render = true;
  761. }
  762. /* 3. Process FX (outputs a mask) & draw. */
  763. if (filter->initial_render && filter->images_allocated) {
  764. bool draw = true;
  765. if (!async || filter->got_new_frame) {
  766. if (filter->processing_counter %
  767. filter->processing_interval ==
  768. 0) {
  769. draw = process_texture_greenscreen(filter);
  770. filter->processing_counter = 1;
  771. } else {
  772. filter->processing_counter++;
  773. }
  774. filter->got_new_frame = false;
  775. }
  776. if (draw) {
  777. draw_greenscreen(filter);
  778. filter->processed_frame = true;
  779. }
  780. } else {
  781. obs_source_skip_video_filter(filter->context);
  782. }
  783. UNUSED_PARAMETER(effect);
  784. }
  785. bool load_nvvfx(void)
  786. {
  787. bool old_sdk_loaded = false;
  788. unsigned int version = get_lib_version();
  789. uint8_t major = (version >> 24) & 0xff;
  790. uint8_t minor = (version >> 16) & 0x00ff;
  791. uint8_t build = (version >> 8) & 0x0000ff;
  792. uint8_t revision = (version >> 0) & 0x000000ff;
  793. if (version) {
  794. blog(LOG_INFO,
  795. "[NVIDIA VIDEO FX]: NVIDIA VIDEO FX version: %i.%i.%i.%i",
  796. major, minor, build, revision);
  797. if (version < MIN_VFX_SDK_VERSION) {
  798. blog(LOG_INFO,
  799. "[NVIDIA VIDEO FX]: NVIDIA VIDEO Effects SDK is outdated. Please update both audio & video SDK.");
  800. }
  801. }
  802. if (!load_nv_vfx_libs()) {
  803. blog(LOG_INFO,
  804. "[NVIDIA VIDEO FX]: FX disabled, redistributable not found or could not be loaded.");
  805. return false;
  806. }
  807. #define LOAD_SYM_FROM_LIB(sym, lib, dll) \
  808. if (!(sym = (sym##_t)GetProcAddress(lib, #sym))) { \
  809. DWORD err = GetLastError(); \
  810. printf("[NVIDIA VIDEO FX]: Couldn't load " #sym " from " dll \
  811. ": %lu (0x%lx)", \
  812. err, err); \
  813. release_nv_vfx(); \
  814. goto unload_everything; \
  815. }
  816. #define LOAD_SYM_FROM_LIB2(sym, lib, dll) \
  817. if (!(sym = (sym##_t)GetProcAddress(lib, #sym))) { \
  818. DWORD err = GetLastError(); \
  819. printf("[NVIDIA VIDEO FX]: Couldn't load " #sym " from " dll \
  820. ": %lu (0x%lx)", \
  821. err, err); \
  822. nvvfx_new_sdk = false; \
  823. } else { \
  824. nvvfx_new_sdk = true; \
  825. }
  826. #define LOAD_SYM(sym) LOAD_SYM_FROM_LIB(sym, nv_videofx, "NVVideoEffects.dll")
  827. LOAD_SYM(NvVFX_GetVersion);
  828. LOAD_SYM(NvVFX_CreateEffect);
  829. LOAD_SYM(NvVFX_DestroyEffect);
  830. LOAD_SYM(NvVFX_SetU32);
  831. LOAD_SYM(NvVFX_SetS32);
  832. LOAD_SYM(NvVFX_SetF32);
  833. LOAD_SYM(NvVFX_SetF64);
  834. LOAD_SYM(NvVFX_SetU64);
  835. LOAD_SYM(NvVFX_SetObject);
  836. LOAD_SYM(NvVFX_SetCudaStream);
  837. LOAD_SYM(NvVFX_SetImage);
  838. LOAD_SYM(NvVFX_SetString);
  839. LOAD_SYM(NvVFX_GetU32);
  840. LOAD_SYM(NvVFX_GetS32);
  841. LOAD_SYM(NvVFX_GetF32);
  842. LOAD_SYM(NvVFX_GetF64);
  843. LOAD_SYM(NvVFX_GetU64);
  844. LOAD_SYM(NvVFX_GetObject);
  845. LOAD_SYM(NvVFX_GetCudaStream);
  846. LOAD_SYM(NvVFX_GetImage);
  847. LOAD_SYM(NvVFX_GetString);
  848. LOAD_SYM(NvVFX_Run);
  849. LOAD_SYM(NvVFX_Load);
  850. LOAD_SYM(NvVFX_CudaStreamCreate);
  851. LOAD_SYM(NvVFX_CudaStreamDestroy);
  852. old_sdk_loaded = true;
  853. #undef LOAD_SYM
  854. #define LOAD_SYM(sym) LOAD_SYM_FROM_LIB(sym, nv_cvimage, "NVCVImage.dll")
  855. LOAD_SYM(NvCV_GetErrorStringFromCode);
  856. LOAD_SYM(NvCVImage_Init);
  857. LOAD_SYM(NvCVImage_InitView);
  858. LOAD_SYM(NvCVImage_Alloc);
  859. LOAD_SYM(NvCVImage_Realloc);
  860. LOAD_SYM(NvCVImage_Dealloc);
  861. LOAD_SYM(NvCVImage_Create);
  862. LOAD_SYM(NvCVImage_Destroy);
  863. LOAD_SYM(NvCVImage_ComponentOffsets);
  864. LOAD_SYM(NvCVImage_Transfer);
  865. LOAD_SYM(NvCVImage_TransferRect);
  866. LOAD_SYM(NvCVImage_TransferFromYUV);
  867. LOAD_SYM(NvCVImage_TransferToYUV);
  868. LOAD_SYM(NvCVImage_MapResource);
  869. LOAD_SYM(NvCVImage_UnmapResource);
  870. LOAD_SYM(NvCVImage_Composite);
  871. LOAD_SYM(NvCVImage_CompositeRect);
  872. LOAD_SYM(NvCVImage_CompositeOverConstant);
  873. LOAD_SYM(NvCVImage_FlipY);
  874. LOAD_SYM(NvCVImage_GetYUVPointers);
  875. LOAD_SYM(NvCVImage_InitFromD3D11Texture);
  876. LOAD_SYM(NvCVImage_ToD3DFormat);
  877. LOAD_SYM(NvCVImage_FromD3DFormat);
  878. LOAD_SYM(NvCVImage_ToD3DColorSpace);
  879. LOAD_SYM(NvCVImage_FromD3DColorSpace);
  880. #undef LOAD_SYM
  881. #define LOAD_SYM(sym) LOAD_SYM_FROM_LIB(sym, nv_cudart, "cudart64_110.dll")
  882. LOAD_SYM(cudaMalloc);
  883. LOAD_SYM(cudaStreamSynchronize);
  884. LOAD_SYM(cudaFree);
  885. LOAD_SYM(cudaMemcpy);
  886. LOAD_SYM(cudaMemsetAsync);
  887. #undef LOAD_SYM
  888. #define LOAD_SYM(sym) LOAD_SYM_FROM_LIB2(sym, nv_videofx, "NVVideoEffects.dll")
  889. LOAD_SYM(NvVFX_SetStateObjectHandleArray);
  890. LOAD_SYM(NvVFX_AllocateState);
  891. LOAD_SYM(NvVFX_DeallocateState);
  892. LOAD_SYM(NvVFX_ResetState);
  893. if (!nvvfx_new_sdk) {
  894. blog(LOG_INFO,
  895. "[NVIDIA VIDEO FX]: sdk loaded but old redistributable detected; please upgrade.");
  896. }
  897. #undef LOAD_SYM
  898. int err;
  899. NvVFX_Handle h = NULL;
  900. /* load the effect to check if the GPU is supported */
  901. err = NvVFX_CreateEffect(NVVFX_FX_GREEN_SCREEN, &h);
  902. if (err != NVCV_SUCCESS) {
  903. if (err == NVCV_ERR_UNSUPPORTEDGPU) {
  904. blog(LOG_INFO,
  905. "[NVIDIA VIDEO FX]: disabled, unsupported GPU");
  906. } else {
  907. blog(LOG_ERROR, "[NVIDIA VIDEO FX]: disabled, error %i",
  908. err);
  909. }
  910. goto unload_everything;
  911. }
  912. NvVFX_DestroyEffect(h);
  913. nvvfx_loaded = true;
  914. blog(LOG_INFO, "[NVIDIA VIDEO FX]: enabled, redistributable found");
  915. return true;
  916. unload_everything:
  917. nvvfx_loaded = false;
  918. blog(LOG_INFO,
  919. "[NVIDIA VIDEO FX]: disabled, redistributable not found");
  920. release_nv_vfx();
  921. return false;
  922. }
  923. #ifdef LIBNVVFX_ENABLED
  924. void unload_nvvfx(void)
  925. {
  926. release_nv_vfx();
  927. }
  928. #endif
  929. static enum gs_color_space nv_greenscreen_filter_get_color_space(
  930. void *data, size_t count, const enum gs_color_space *preferred_spaces)
  931. {
  932. const enum gs_color_space potential_spaces[] = {
  933. GS_CS_SRGB,
  934. GS_CS_SRGB_16F,
  935. GS_CS_709_EXTENDED,
  936. };
  937. struct nv_greenscreen_data *const filter = data;
  938. const enum gs_color_space source_space = obs_source_get_color_space(
  939. obs_filter_get_target(filter->context),
  940. OBS_COUNTOF(potential_spaces), potential_spaces);
  941. enum gs_color_space space = source_space;
  942. for (size_t i = 0; i < count; ++i) {
  943. space = preferred_spaces[i];
  944. if (space == source_space)
  945. break;
  946. }
  947. return space;
  948. }
  949. struct obs_source_info nvidia_greenscreen_filter_info = {
  950. .id = "nv_greenscreen_filter",
  951. .type = OBS_SOURCE_TYPE_FILTER,
  952. .output_flags = OBS_SOURCE_VIDEO | OBS_SOURCE_SRGB,
  953. .get_name = nv_greenscreen_filter_name,
  954. .create = nv_greenscreen_filter_create,
  955. .destroy = nv_greenscreen_filter_destroy,
  956. .get_defaults = nv_greenscreen_filter_defaults,
  957. .get_properties = nv_greenscreen_filter_properties,
  958. .update = nv_greenscreen_filter_update,
  959. .filter_video = nv_greenscreen_filter_video,
  960. .video_render = nv_greenscreen_filter_render,
  961. .video_tick = nv_greenscreen_filter_tick,
  962. .video_get_color_space = nv_greenscreen_filter_get_color_space,
  963. };