encoder.c 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514
  1. #include <obs-module.h>
  2. #include <util/darray.h>
  3. #include <util/platform.h>
  4. #include <obs-avc.h>
  5. #include <CoreFoundation/CoreFoundation.h>
  6. #include <VideoToolbox/VideoToolbox.h>
  7. #include <VideoToolbox/VTVideoEncoderList.h>
  8. #include <CoreMedia/CoreMedia.h>
  9. #include <util/apple/cfstring-utils.h>
  10. #include <assert.h>
  11. #define VT_LOG(level, format, ...) \
  12. blog(level, "[VideoToolbox encoder]: " format, ##__VA_ARGS__)
  13. #define VT_LOG_ENCODER(encoder, codec_type, level, format, ...) \
  14. blog(level, "[VideoToolbox %s: '%s']: " format, \
  15. obs_encoder_get_name(encoder), \
  16. codec_type_to_print_fmt(codec_type), ##__VA_ARGS__)
  17. #define VT_BLOG(level, format, ...) \
  18. VT_LOG_ENCODER(enc->encoder, enc->codec_type, level, format, \
  19. ##__VA_ARGS__)
  20. struct vt_encoder_type_data {
  21. const char *disp_name;
  22. const char *id;
  23. CMVideoCodecType codec_type;
  24. bool hardware_accelerated;
  25. };
  26. struct vt_prores_encoder_data {
  27. FourCharCode codec_type;
  28. CFStringRef encoder_id;
  29. };
  30. static DARRAY(struct vt_prores_encoder_data) vt_prores_hardware_encoder_list;
  31. static DARRAY(struct vt_prores_encoder_data) vt_prores_software_encoder_list;
  32. struct vt_encoder {
  33. obs_encoder_t *encoder;
  34. const char *vt_encoder_id;
  35. uint32_t width;
  36. uint32_t height;
  37. uint32_t keyint;
  38. uint32_t fps_num;
  39. uint32_t fps_den;
  40. const char *rate_control;
  41. uint32_t bitrate;
  42. float quality;
  43. bool limit_bitrate;
  44. uint32_t rc_max_bitrate;
  45. float rc_max_bitrate_window;
  46. const char *profile;
  47. CMVideoCodecType codec_type;
  48. bool bframes;
  49. int vt_pix_fmt;
  50. enum video_colorspace colorspace;
  51. VTCompressionSessionRef session;
  52. CMSimpleQueueRef queue;
  53. bool hw_enc;
  54. DARRAY(uint8_t) packet_data;
  55. DARRAY(uint8_t) extra_data;
  56. };
  57. static const char *codec_type_to_print_fmt(CMVideoCodecType codec_type)
  58. {
  59. switch (codec_type) {
  60. case kCMVideoCodecType_H264:
  61. return "h264";
  62. case kCMVideoCodecType_HEVC:
  63. return "hevc";
  64. case kCMVideoCodecType_AppleProRes422Proxy:
  65. return "apco";
  66. case kCMVideoCodecType_AppleProRes422LT:
  67. return "apcs";
  68. case kCMVideoCodecType_AppleProRes422:
  69. return "apcn";
  70. case kCMVideoCodecType_AppleProRes422HQ:
  71. return "apch";
  72. default:
  73. return "";
  74. }
  75. }
  76. static void log_osstatus(int log_level, struct vt_encoder *enc,
  77. const char *context, OSStatus code)
  78. {
  79. char *c_str = NULL;
  80. CFErrorRef err = CFErrorCreate(kCFAllocatorDefault,
  81. kCFErrorDomainOSStatus, code, NULL);
  82. CFStringRef str = CFErrorCopyDescription(err);
  83. c_str = cfstr_copy_cstr(str, kCFStringEncodingUTF8);
  84. if (c_str) {
  85. if (enc)
  86. VT_BLOG(log_level, "Error in %s: %s", context, c_str);
  87. else
  88. VT_LOG(log_level, "Error in %s: %s", context, c_str);
  89. }
  90. bfree(c_str);
  91. CFRelease(str);
  92. CFRelease(err);
  93. }
  94. static CFStringRef obs_to_vt_profile(CMVideoCodecType codec_type,
  95. const char *profile,
  96. enum video_format format)
  97. {
  98. if (codec_type == kCMVideoCodecType_H264) {
  99. if (strcmp(profile, "baseline") == 0)
  100. return kVTProfileLevel_H264_Baseline_AutoLevel;
  101. else if (strcmp(profile, "main") == 0)
  102. return kVTProfileLevel_H264_Main_AutoLevel;
  103. else if (strcmp(profile, "high") == 0)
  104. return kVTProfileLevel_H264_High_AutoLevel;
  105. else
  106. return kVTProfileLevel_H264_Main_AutoLevel;
  107. #ifdef ENABLE_HEVC
  108. } else if (codec_type == kCMVideoCodecType_HEVC) {
  109. if (strcmp(profile, "main") == 0) {
  110. if (format == VIDEO_FORMAT_P010) {
  111. VT_LOG(LOG_WARNING, "Forcing main10 for P010");
  112. return kVTProfileLevel_HEVC_Main10_AutoLevel;
  113. } else {
  114. return kVTProfileLevel_HEVC_Main_AutoLevel;
  115. }
  116. }
  117. if (strcmp(profile, "main10") == 0)
  118. return kVTProfileLevel_HEVC_Main10_AutoLevel;
  119. #if __MAC_OS_X_VERSION_MAX_ALLOWED >= 120300 // macOS 12.3
  120. if (__builtin_available(macOS 12.3, *)) {
  121. if (strcmp(profile, "main42210") == 0)
  122. return kVTProfileLevel_HEVC_Main42210_AutoLevel;
  123. }
  124. #endif // macOS 12.3
  125. return kVTProfileLevel_HEVC_Main_AutoLevel;
  126. #endif // ENABLE_HEVC
  127. } else {
  128. return kVTProfileLevel_H264_Baseline_AutoLevel;
  129. }
  130. }
  131. static CFStringRef obs_to_vt_colorspace(enum video_colorspace cs)
  132. {
  133. switch (cs) {
  134. case VIDEO_CS_601:
  135. return kCVImageBufferYCbCrMatrix_ITU_R_601_4;
  136. case VIDEO_CS_2100_PQ:
  137. case VIDEO_CS_2100_HLG:
  138. return kCVImageBufferYCbCrMatrix_ITU_R_2020;
  139. default:
  140. return kCVImageBufferYCbCrMatrix_ITU_R_709_2;
  141. }
  142. }
  143. static CFStringRef obs_to_vt_primaries(enum video_colorspace cs)
  144. {
  145. switch (cs) {
  146. case VIDEO_CS_601:
  147. return kCVImageBufferColorPrimaries_SMPTE_C;
  148. case VIDEO_CS_2100_PQ:
  149. case VIDEO_CS_2100_HLG:
  150. return kCVImageBufferColorPrimaries_ITU_R_2020;
  151. default:
  152. return kCVImageBufferColorPrimaries_ITU_R_709_2;
  153. }
  154. }
  155. static CFStringRef obs_to_vt_transfer(enum video_colorspace cs)
  156. {
  157. switch (cs) {
  158. case VIDEO_CS_SRGB:
  159. return kCVImageBufferTransferFunction_sRGB;
  160. case VIDEO_CS_2100_PQ:
  161. return kCVImageBufferTransferFunction_SMPTE_ST_2084_PQ;
  162. case VIDEO_CS_2100_HLG:
  163. return kCVImageBufferTransferFunction_ITU_R_2100_HLG;
  164. default:
  165. return kCVImageBufferTransferFunction_ITU_R_709_2;
  166. }
  167. }
  168. #define STATUS_CHECK(c) \
  169. code = c; \
  170. if (code) { \
  171. log_osstatus(LOG_ERROR, enc, #c, code); \
  172. goto fail; \
  173. }
  174. #define SESSION_CHECK(x) \
  175. if ((code = (x)) != noErr) \
  176. return code;
  177. static OSStatus session_set_prop_float(VTCompressionSessionRef session,
  178. CFStringRef key, float val)
  179. {
  180. CFNumberRef n = CFNumberCreate(NULL, kCFNumberFloat32Type, &val);
  181. OSStatus code = VTSessionSetProperty(session, key, n);
  182. CFRelease(n);
  183. return code;
  184. }
  185. static OSStatus session_set_prop_int(VTCompressionSessionRef session,
  186. CFStringRef key, int32_t val)
  187. {
  188. CFNumberRef n = CFNumberCreate(NULL, kCFNumberSInt32Type, &val);
  189. OSStatus code = VTSessionSetProperty(session, key, n);
  190. CFRelease(n);
  191. return code;
  192. }
  193. static OSStatus session_set_prop_str(VTCompressionSessionRef session,
  194. CFStringRef key, char *val)
  195. {
  196. CFStringRef s = CFStringCreateWithFileSystemRepresentation(NULL, val);
  197. OSStatus code = VTSessionSetProperty(session, key, s);
  198. CFRelease(s);
  199. return code;
  200. }
  201. static OSStatus session_set_prop(VTCompressionSessionRef session,
  202. CFStringRef key, CFTypeRef val)
  203. {
  204. return VTSessionSetProperty(session, key, val);
  205. }
  206. static OSStatus session_set_bitrate(VTCompressionSessionRef session,
  207. const char *rate_control, int new_bitrate,
  208. float quality, bool limit_bitrate,
  209. int max_bitrate, float max_bitrate_window)
  210. {
  211. OSStatus code;
  212. bool can_limit_bitrate;
  213. CFStringRef compressionPropertyKey;
  214. if (strcmp(rate_control, "CBR") == 0) {
  215. compressionPropertyKey =
  216. kVTCompressionPropertyKey_AverageBitRate;
  217. can_limit_bitrate = true;
  218. if (__builtin_available(macOS 13.0, *)) {
  219. #if __MAC_OS_X_VERSION_MAX_ALLOWED >= 130000
  220. #ifdef __aarch64__
  221. if (true) {
  222. #else
  223. if (os_get_emulation_status() == true) {
  224. #endif
  225. compressionPropertyKey =
  226. kVTCompressionPropertyKey_ConstantBitRate;
  227. can_limit_bitrate = false;
  228. } else {
  229. VT_LOG(LOG_WARNING,
  230. "CBR support for VideoToolbox encoder requires Apple Silicon. "
  231. "Will use ABR instead.");
  232. }
  233. #else
  234. VT_LOG(LOG_WARNING,
  235. "CBR support for VideoToolbox not available in this build of OBS. "
  236. "Will use ABR instead.");
  237. #endif
  238. } else {
  239. VT_LOG(LOG_WARNING,
  240. "CBR support for VideoToolbox encoder requires macOS 13 or newer. "
  241. "Will use ABR instead.");
  242. }
  243. } else if (strcmp(rate_control, "ABR") == 0) {
  244. compressionPropertyKey =
  245. kVTCompressionPropertyKey_AverageBitRate;
  246. can_limit_bitrate = true;
  247. } else if (strcmp(rate_control, "CRF") == 0) {
  248. #ifdef __aarch64__
  249. if (true) {
  250. #else
  251. if (os_get_emulation_status() == true) {
  252. #endif
  253. compressionPropertyKey =
  254. kVTCompressionPropertyKey_Quality;
  255. SESSION_CHECK(session_set_prop_float(
  256. session, compressionPropertyKey, quality));
  257. } else {
  258. VT_LOG(LOG_WARNING,
  259. "CRF support for VideoToolbox encoder requires Apple Silicon. "
  260. "Will use ABR instead.");
  261. compressionPropertyKey =
  262. kVTCompressionPropertyKey_AverageBitRate;
  263. }
  264. can_limit_bitrate = true;
  265. } else {
  266. VT_LOG(LOG_ERROR,
  267. "Selected rate control method is not supported: %s",
  268. rate_control);
  269. return kVTParameterErr;
  270. }
  271. if (compressionPropertyKey != kVTCompressionPropertyKey_Quality) {
  272. SESSION_CHECK(session_set_prop_int(
  273. session, compressionPropertyKey, new_bitrate * 1000));
  274. }
  275. if (limit_bitrate && can_limit_bitrate) {
  276. int32_t cpb_size = max_bitrate * 125 * max_bitrate_window;
  277. CFNumberRef cf_cpb_size =
  278. CFNumberCreate(NULL, kCFNumberIntType, &cpb_size);
  279. CFNumberRef cf_cpb_window_s = CFNumberCreate(
  280. NULL, kCFNumberFloatType, &max_bitrate_window);
  281. CFMutableArrayRef rate_control = CFArrayCreateMutable(
  282. kCFAllocatorDefault, 2, &kCFTypeArrayCallBacks);
  283. CFArrayAppendValue(rate_control, cf_cpb_size);
  284. CFArrayAppendValue(rate_control, cf_cpb_window_s);
  285. code = session_set_prop(
  286. session, kVTCompressionPropertyKey_DataRateLimits,
  287. rate_control);
  288. CFRelease(cf_cpb_size);
  289. CFRelease(cf_cpb_window_s);
  290. CFRelease(rate_control);
  291. if (code == kVTPropertyNotSupportedErr) {
  292. log_osstatus(LOG_WARNING, NULL,
  293. "setting DataRateLimits on session", code);
  294. return noErr;
  295. }
  296. }
  297. return noErr;
  298. }
  299. static OSStatus session_set_colorspace(VTCompressionSessionRef session,
  300. enum video_colorspace cs)
  301. {
  302. OSStatus code;
  303. SESSION_CHECK(session_set_prop(session,
  304. kVTCompressionPropertyKey_ColorPrimaries,
  305. obs_to_vt_primaries(cs)));
  306. SESSION_CHECK(session_set_prop(
  307. session, kVTCompressionPropertyKey_TransferFunction,
  308. obs_to_vt_transfer(cs)));
  309. SESSION_CHECK(session_set_prop(session,
  310. kVTCompressionPropertyKey_YCbCrMatrix,
  311. obs_to_vt_colorspace(cs)));
  312. return noErr;
  313. }
  314. #undef SESSION_CHECK
  315. void sample_encoded_callback(void *data, void *source, OSStatus status,
  316. VTEncodeInfoFlags info_flags,
  317. CMSampleBufferRef buffer)
  318. {
  319. UNUSED_PARAMETER(status);
  320. UNUSED_PARAMETER(info_flags);
  321. CMSimpleQueueRef queue = data;
  322. CVPixelBufferRef pixbuf = source;
  323. if (buffer != NULL) {
  324. CFRetain(buffer);
  325. CMSimpleQueueEnqueue(queue, buffer);
  326. }
  327. CFRelease(pixbuf);
  328. }
  329. #define ENCODER_ID kVTVideoEncoderSpecification_EncoderID
  330. static inline CFMutableDictionaryRef
  331. create_encoder_spec(const char *vt_encoder_id)
  332. {
  333. CFMutableDictionaryRef encoder_spec = CFDictionaryCreateMutable(
  334. kCFAllocatorDefault, 3, &kCFTypeDictionaryKeyCallBacks,
  335. &kCFTypeDictionaryValueCallBacks);
  336. CFStringRef id =
  337. CFStringCreateWithFileSystemRepresentation(NULL, vt_encoder_id);
  338. CFDictionaryAddValue(encoder_spec, ENCODER_ID, id);
  339. CFRelease(id);
  340. return encoder_spec;
  341. }
  342. static inline CFMutableDictionaryRef
  343. create_prores_encoder_spec(CMVideoCodecType target_codec_type,
  344. bool hardware_accelerated)
  345. {
  346. CFStringRef encoder_id = NULL;
  347. size_t size = 0;
  348. struct vt_prores_encoder_data *encoder_list = NULL;
  349. if (hardware_accelerated) {
  350. size = vt_prores_hardware_encoder_list.num;
  351. encoder_list = vt_prores_hardware_encoder_list.array;
  352. } else {
  353. size = vt_prores_software_encoder_list.num;
  354. encoder_list = vt_prores_software_encoder_list.array;
  355. }
  356. for (size_t i = 0; i < size; ++i) {
  357. if (target_codec_type == encoder_list[i].codec_type) {
  358. encoder_id = encoder_list[i].encoder_id;
  359. }
  360. }
  361. CFMutableDictionaryRef encoder_spec = CFDictionaryCreateMutable(
  362. kCFAllocatorDefault, 1, &kCFTypeDictionaryKeyCallBacks,
  363. &kCFTypeDictionaryValueCallBacks);
  364. CFDictionaryAddValue(encoder_spec, ENCODER_ID, encoder_id);
  365. return encoder_spec;
  366. }
  367. #undef ENCODER_ID
  368. static inline CFMutableDictionaryRef create_pixbuf_spec(struct vt_encoder *enc)
  369. {
  370. CFMutableDictionaryRef pixbuf_spec = CFDictionaryCreateMutable(
  371. kCFAllocatorDefault, 3, &kCFTypeDictionaryKeyCallBacks,
  372. &kCFTypeDictionaryValueCallBacks);
  373. CFNumberRef n =
  374. CFNumberCreate(NULL, kCFNumberSInt32Type, &enc->vt_pix_fmt);
  375. CFDictionaryAddValue(pixbuf_spec, kCVPixelBufferPixelFormatTypeKey, n);
  376. CFRelease(n);
  377. n = CFNumberCreate(NULL, kCFNumberSInt32Type, &enc->width);
  378. CFDictionaryAddValue(pixbuf_spec, kCVPixelBufferWidthKey, n);
  379. CFRelease(n);
  380. n = CFNumberCreate(NULL, kCFNumberSInt32Type, &enc->height);
  381. CFDictionaryAddValue(pixbuf_spec, kCVPixelBufferHeightKey, n);
  382. CFRelease(n);
  383. return pixbuf_spec;
  384. }
  385. static bool create_encoder(struct vt_encoder *enc)
  386. {
  387. OSStatus code;
  388. VTCompressionSessionRef s;
  389. const char *codec_name = obs_encoder_get_codec(enc->encoder);
  390. CFDictionaryRef encoder_spec;
  391. if (strcmp(codec_name, "prores") == 0) {
  392. struct vt_encoder_type_data *type_data =
  393. (struct vt_encoder_type_data *)
  394. obs_encoder_get_type_data(enc->encoder);
  395. encoder_spec = create_prores_encoder_spec(
  396. enc->codec_type, type_data->hardware_accelerated);
  397. } else {
  398. encoder_spec = create_encoder_spec(enc->vt_encoder_id);
  399. }
  400. CFDictionaryRef pixbuf_spec = create_pixbuf_spec(enc);
  401. STATUS_CHECK(VTCompressionSessionCreate(
  402. kCFAllocatorDefault, enc->width, enc->height, enc->codec_type,
  403. encoder_spec, pixbuf_spec, NULL, &sample_encoded_callback,
  404. enc->queue, &s));
  405. CFRelease(encoder_spec);
  406. CFRelease(pixbuf_spec);
  407. CFBooleanRef b = NULL;
  408. code = VTSessionCopyProperty(
  409. s,
  410. kVTCompressionPropertyKey_UsingHardwareAcceleratedVideoEncoder,
  411. NULL, &b);
  412. if (code == noErr && (enc->hw_enc = CFBooleanGetValue(b)))
  413. VT_BLOG(LOG_INFO, "session created with hardware encoding");
  414. else
  415. enc->hw_enc = false;
  416. if (b != NULL)
  417. CFRelease(b);
  418. if (enc->codec_type == kCMVideoCodecType_H264 ||
  419. enc->codec_type == kCMVideoCodecType_HEVC) {
  420. // This can fail when using GPU hardware encoding
  421. code = session_set_prop_int(
  422. s,
  423. kVTCompressionPropertyKey_MaxKeyFrameIntervalDuration,
  424. enc->keyint);
  425. if (code != noErr)
  426. log_osstatus(
  427. LOG_WARNING, enc,
  428. "setting kVTCompressionPropertyKey_MaxKeyFrameIntervalDuration failed, "
  429. "keyframe interval might be incorrect",
  430. code);
  431. STATUS_CHECK(session_set_prop_int(
  432. s, kVTCompressionPropertyKey_MaxKeyFrameInterval,
  433. enc->keyint * ((float)enc->fps_num / enc->fps_den)));
  434. STATUS_CHECK(session_set_prop_float(
  435. s, kVTCompressionPropertyKey_ExpectedFrameRate,
  436. (float)enc->fps_num / enc->fps_den));
  437. STATUS_CHECK(session_set_prop(
  438. s, kVTCompressionPropertyKey_AllowFrameReordering,
  439. enc->bframes ? kCFBooleanTrue : kCFBooleanFalse));
  440. video_t *video = obs_encoder_video(enc->encoder);
  441. const struct video_output_info *voi =
  442. video_output_get_info(video);
  443. STATUS_CHECK(session_set_prop(
  444. s, kVTCompressionPropertyKey_ProfileLevel,
  445. obs_to_vt_profile(enc->codec_type, enc->profile,
  446. voi->format)));
  447. STATUS_CHECK(session_set_bitrate(
  448. s, enc->rate_control, enc->bitrate, enc->quality,
  449. enc->limit_bitrate, enc->rc_max_bitrate,
  450. enc->rc_max_bitrate_window));
  451. }
  452. // This can fail depending on hardware configuration
  453. code = session_set_prop(s, kVTCompressionPropertyKey_RealTime,
  454. kCFBooleanFalse);
  455. if (code != noErr)
  456. log_osstatus(
  457. LOG_WARNING, enc,
  458. "setting kVTCompressionPropertyKey_RealTime failed, "
  459. "frame delay might be increased",
  460. code);
  461. STATUS_CHECK(session_set_colorspace(s, enc->colorspace));
  462. STATUS_CHECK(VTCompressionSessionPrepareToEncodeFrames(s));
  463. enc->session = s;
  464. return true;
  465. fail:
  466. if (encoder_spec != NULL)
  467. CFRelease(encoder_spec);
  468. if (pixbuf_spec != NULL)
  469. CFRelease(pixbuf_spec);
  470. return false;
  471. }
  472. static void vt_destroy(void *data)
  473. {
  474. struct vt_encoder *enc = data;
  475. if (enc) {
  476. if (enc->session != NULL) {
  477. VTCompressionSessionInvalidate(enc->session);
  478. CFRelease(enc->session);
  479. }
  480. da_free(enc->packet_data);
  481. da_free(enc->extra_data);
  482. bfree(enc);
  483. }
  484. }
  485. static void dump_encoder_info(struct vt_encoder *enc)
  486. {
  487. VT_BLOG(LOG_INFO,
  488. "settings:\n"
  489. "\tvt_encoder_id %s\n"
  490. "\trate_control: %s\n"
  491. "\tbitrate: %d (kbps)\n"
  492. "\tquality: %f\n"
  493. "\tfps_num: %d\n"
  494. "\tfps_den: %d\n"
  495. "\twidth: %d\n"
  496. "\theight: %d\n"
  497. "\tkeyint: %d (s)\n"
  498. "\tlimit_bitrate: %s\n"
  499. "\trc_max_bitrate: %d (kbps)\n"
  500. "\trc_max_bitrate_window: %f (s)\n"
  501. "\thw_enc: %s\n"
  502. "\tprofile: %s\n"
  503. "\tcodec_type: %.4s\n",
  504. enc->vt_encoder_id, enc->rate_control, enc->bitrate,
  505. enc->quality, enc->fps_num, enc->fps_den, enc->width,
  506. enc->height, enc->keyint, enc->limit_bitrate ? "on" : "off",
  507. enc->rc_max_bitrate, enc->rc_max_bitrate_window,
  508. enc->hw_enc ? "on" : "off",
  509. (enc->profile != NULL && !!strlen(enc->profile)) ? enc->profile
  510. : "default",
  511. codec_type_to_print_fmt(enc->codec_type));
  512. }
  513. static bool set_video_format(struct vt_encoder *enc, enum video_format format,
  514. enum video_range_type range)
  515. {
  516. bool full_range = range == VIDEO_RANGE_FULL;
  517. switch (format) {
  518. case VIDEO_FORMAT_I420:
  519. enc->vt_pix_fmt =
  520. full_range
  521. ? kCVPixelFormatType_420YpCbCr8PlanarFullRange
  522. : kCVPixelFormatType_420YpCbCr8Planar;
  523. return true;
  524. case VIDEO_FORMAT_NV12:
  525. enc->vt_pix_fmt =
  526. full_range
  527. ? kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
  528. : kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange;
  529. return true;
  530. case VIDEO_FORMAT_P010:
  531. if (enc->codec_type == kCMVideoCodecType_HEVC) {
  532. enc->vt_pix_fmt =
  533. full_range
  534. ? kCVPixelFormatType_420YpCbCr10BiPlanarFullRange
  535. : kCVPixelFormatType_420YpCbCr10BiPlanarVideoRange;
  536. return true;
  537. } else {
  538. return false;
  539. }
  540. default:
  541. return false;
  542. }
  543. return false;
  544. }
  545. static bool update_params(struct vt_encoder *enc, obs_data_t *settings)
  546. {
  547. video_t *video = obs_encoder_video(enc->encoder);
  548. const struct video_output_info *voi = video_output_get_info(video);
  549. const char *codec = obs_encoder_get_codec(enc->encoder);
  550. if (strcmp(codec, "h264") == 0) {
  551. enc->codec_type = kCMVideoCodecType_H264;
  552. obs_data_set_int(settings, "codec_type", enc->codec_type);
  553. #ifdef ENABLE_HEVC
  554. } else if (strcmp(codec, "hevc") == 0) {
  555. enc->codec_type = kCMVideoCodecType_HEVC;
  556. obs_data_set_int(settings, "codec_type", enc->codec_type);
  557. #endif
  558. } else {
  559. enc->codec_type = (CMVideoCodecType)obs_data_get_int(
  560. settings, "codec_type");
  561. }
  562. if (!set_video_format(enc, voi->format, voi->range)) {
  563. obs_encoder_set_last_error(
  564. enc->encoder,
  565. obs_module_text("ColorFormatUnsupported"));
  566. VT_BLOG(LOG_WARNING, "Unsupported color format selected");
  567. return false;
  568. }
  569. enc->colorspace = voi->colorspace;
  570. enc->width = obs_encoder_get_width(enc->encoder);
  571. enc->height = obs_encoder_get_height(enc->encoder);
  572. enc->fps_num = voi->fps_num;
  573. enc->fps_den = voi->fps_den;
  574. enc->keyint = (uint32_t)obs_data_get_int(settings, "keyint_sec");
  575. enc->rate_control = obs_data_get_string(settings, "rate_control");
  576. enc->bitrate = (uint32_t)obs_data_get_int(settings, "bitrate");
  577. enc->quality = ((float)obs_data_get_int(settings, "quality")) / 100;
  578. enc->profile = obs_data_get_string(settings, "profile");
  579. enc->limit_bitrate = obs_data_get_bool(settings, "limit_bitrate");
  580. enc->rc_max_bitrate = obs_data_get_int(settings, "max_bitrate");
  581. enc->rc_max_bitrate_window =
  582. obs_data_get_double(settings, "max_bitrate_window");
  583. enc->bframes = obs_data_get_bool(settings, "bframes");
  584. return true;
  585. }
  586. static bool vt_update(void *data, obs_data_t *settings)
  587. {
  588. struct vt_encoder *enc = data;
  589. uint32_t old_bitrate = enc->bitrate;
  590. bool old_limit_bitrate = enc->limit_bitrate;
  591. update_params(enc, settings);
  592. if (old_bitrate == enc->bitrate &&
  593. old_limit_bitrate == enc->limit_bitrate)
  594. return true;
  595. OSStatus code = session_set_bitrate(enc->session, enc->rate_control,
  596. enc->bitrate, enc->quality,
  597. enc->limit_bitrate,
  598. enc->rc_max_bitrate,
  599. enc->rc_max_bitrate_window);
  600. if (code != noErr)
  601. VT_BLOG(LOG_WARNING, "Failed to set bitrate to session");
  602. dump_encoder_info(enc);
  603. return true;
  604. }
  605. static void *vt_create(obs_data_t *settings, obs_encoder_t *encoder)
  606. {
  607. struct vt_encoder *enc = bzalloc(sizeof(struct vt_encoder));
  608. OSStatus code;
  609. enc->encoder = encoder;
  610. enc->vt_encoder_id = obs_encoder_get_id(encoder);
  611. if (!update_params(enc, settings))
  612. goto fail;
  613. STATUS_CHECK(CMSimpleQueueCreate(NULL, 100, &enc->queue));
  614. if (!create_encoder(enc))
  615. goto fail;
  616. dump_encoder_info(enc);
  617. return enc;
  618. fail:
  619. vt_destroy(enc);
  620. return NULL;
  621. }
  622. static const uint8_t annexb_startcode[4] = {0, 0, 0, 1};
  623. static void packet_put(struct darray *packet, const uint8_t *buf, size_t size)
  624. {
  625. darray_push_back_array(sizeof(uint8_t), packet, buf, size);
  626. }
  627. static void packet_put_startcode(struct darray *packet, int size)
  628. {
  629. assert(size == 3 || size == 4);
  630. packet_put(packet, &annexb_startcode[4 - size], size);
  631. }
  632. static bool handle_prores_packet(struct vt_encoder *enc,
  633. CMSampleBufferRef buffer)
  634. {
  635. OSStatus err = 0;
  636. size_t block_size = 0;
  637. uint8_t *block_buf = NULL;
  638. CMBlockBufferRef block = CMSampleBufferGetDataBuffer(buffer);
  639. if (block == NULL) {
  640. VT_BLOG(LOG_ERROR,
  641. "Failed to get block buffer for ProRes frame.");
  642. return false;
  643. }
  644. err = CMBlockBufferGetDataPointer(block, 0, NULL, &block_size,
  645. (char **)&block_buf);
  646. if (err != 0) {
  647. VT_BLOG(LOG_ERROR,
  648. "Failed to get data buffer pointer for ProRes frame.");
  649. return false;
  650. }
  651. packet_put(&enc->packet_data.da, block_buf, block_size);
  652. return true;
  653. }
  654. static void convert_block_nals_to_annexb(struct vt_encoder *enc,
  655. struct darray *packet,
  656. CMBlockBufferRef block,
  657. int nal_length_bytes)
  658. {
  659. size_t block_size;
  660. uint8_t *block_buf;
  661. CMBlockBufferGetDataPointer(block, 0, NULL, &block_size,
  662. (char **)&block_buf);
  663. size_t bytes_remaining = block_size;
  664. while (bytes_remaining > 0) {
  665. uint32_t nal_size;
  666. if (nal_length_bytes == 1)
  667. nal_size = block_buf[0];
  668. else if (nal_length_bytes == 2)
  669. nal_size = CFSwapInt16BigToHost(
  670. ((uint16_t *)block_buf)[0]);
  671. else if (nal_length_bytes == 4)
  672. nal_size = CFSwapInt32BigToHost(
  673. ((uint32_t *)block_buf)[0]);
  674. else
  675. return;
  676. bytes_remaining -= nal_length_bytes;
  677. block_buf += nal_length_bytes;
  678. if (bytes_remaining < nal_size) {
  679. VT_BLOG(LOG_ERROR, "invalid nal block");
  680. return;
  681. }
  682. packet_put_startcode(packet, 3);
  683. packet_put(packet, block_buf, nal_size);
  684. bytes_remaining -= nal_size;
  685. block_buf += nal_size;
  686. }
  687. }
  688. static bool handle_keyframe(struct vt_encoder *enc,
  689. CMFormatDescriptionRef format_desc,
  690. size_t param_count, struct darray *packet,
  691. struct darray *extra_data)
  692. {
  693. OSStatus code;
  694. const uint8_t *param;
  695. size_t param_size;
  696. for (size_t i = 0; i < param_count; i++) {
  697. if (enc->codec_type == kCMVideoCodecType_H264) {
  698. code = CMVideoFormatDescriptionGetH264ParameterSetAtIndex(
  699. format_desc, i, &param, &param_size, NULL,
  700. NULL);
  701. #ifdef ENABLE_HEVC
  702. } else if (enc->codec_type == kCMVideoCodecType_HEVC) {
  703. code = CMVideoFormatDescriptionGetHEVCParameterSetAtIndex(
  704. format_desc, i, &param, &param_size, NULL,
  705. NULL);
  706. #endif
  707. }
  708. if (code != noErr) {
  709. log_osstatus(LOG_ERROR, enc,
  710. "getting NAL parameter "
  711. "at index",
  712. code);
  713. return false;
  714. }
  715. packet_put_startcode(packet, 4);
  716. packet_put(packet, param, param_size);
  717. }
  718. // if we were passed an extra_data array, fill it with
  719. // SPS, PPS, etc.
  720. if (extra_data != NULL)
  721. packet_put(extra_data, packet->array, packet->num);
  722. return true;
  723. }
  724. static bool convert_sample_to_annexb(struct vt_encoder *enc,
  725. struct darray *packet,
  726. struct darray *extra_data,
  727. CMSampleBufferRef buffer, bool keyframe)
  728. {
  729. OSStatus code;
  730. CMFormatDescriptionRef format_desc =
  731. CMSampleBufferGetFormatDescription(buffer);
  732. size_t param_count;
  733. int nal_length_bytes;
  734. if (enc->codec_type == kCMVideoCodecType_H264) {
  735. code = CMVideoFormatDescriptionGetH264ParameterSetAtIndex(
  736. format_desc, 0, NULL, NULL, &param_count,
  737. &nal_length_bytes);
  738. #ifdef ENABLE_HEVC
  739. } else if (enc->codec_type == kCMVideoCodecType_HEVC) {
  740. code = CMVideoFormatDescriptionGetHEVCParameterSetAtIndex(
  741. format_desc, 0, NULL, NULL, &param_count,
  742. &nal_length_bytes);
  743. #endif
  744. }
  745. // it is not clear what errors this function can return
  746. // so we check the two most reasonable
  747. if (code == kCMFormatDescriptionBridgeError_InvalidParameter ||
  748. code == kCMFormatDescriptionError_InvalidParameter) {
  749. VT_BLOG(LOG_WARNING, "assuming 2 parameter sets "
  750. "and 4 byte NAL length header");
  751. param_count = 2;
  752. nal_length_bytes = 4;
  753. } else if (code != noErr) {
  754. log_osstatus(LOG_ERROR, enc,
  755. "getting parameter count from sample", code);
  756. return false;
  757. }
  758. if (keyframe &&
  759. !handle_keyframe(enc, format_desc, param_count, packet, extra_data))
  760. return false;
  761. CMBlockBufferRef block = CMSampleBufferGetDataBuffer(buffer);
  762. convert_block_nals_to_annexb(enc, packet, block, nal_length_bytes);
  763. return true;
  764. }
  765. static bool is_sample_keyframe(CMSampleBufferRef buffer)
  766. {
  767. CFArrayRef attachments =
  768. CMSampleBufferGetSampleAttachmentsArray(buffer, false);
  769. if (attachments != NULL) {
  770. CFDictionaryRef attachment;
  771. CFBooleanRef has_dependencies;
  772. attachment =
  773. (CFDictionaryRef)CFArrayGetValueAtIndex(attachments, 0);
  774. has_dependencies = (CFBooleanRef)CFDictionaryGetValue(
  775. attachment, kCMSampleAttachmentKey_DependsOnOthers);
  776. return has_dependencies == kCFBooleanFalse;
  777. }
  778. return false;
  779. }
  780. static bool parse_sample(struct vt_encoder *enc, CMSampleBufferRef buffer,
  781. struct encoder_packet *packet, CMTime off)
  782. {
  783. int type;
  784. bool should_edit_nal = false;
  785. if (enc->codec_type == kCMVideoCodecType_H264 ||
  786. enc->codec_type == kCMVideoCodecType_HEVC) {
  787. should_edit_nal = true;
  788. }
  789. CMTime pts = CMSampleBufferGetPresentationTimeStamp(buffer);
  790. CMTime dts = CMSampleBufferGetDecodeTimeStamp(buffer);
  791. if (CMTIME_IS_INVALID(dts))
  792. dts = pts;
  793. // imitate x264's negative dts when bframes might have pts < dts
  794. else if (enc->bframes)
  795. dts = CMTimeSubtract(dts, off);
  796. pts = CMTimeMultiply(pts, enc->fps_num);
  797. dts = CMTimeMultiply(dts, enc->fps_num);
  798. // All ProRes frames are "keyframes"
  799. bool keyframe = true;
  800. if (should_edit_nal) {
  801. keyframe = is_sample_keyframe(buffer);
  802. }
  803. da_resize(enc->packet_data, 0);
  804. // If we are still looking for extra data
  805. struct darray *extra_data = NULL;
  806. if (enc->extra_data.num == 0)
  807. extra_data = &enc->extra_data.da;
  808. if (should_edit_nal) {
  809. if (!convert_sample_to_annexb(enc, &enc->packet_data.da,
  810. extra_data, buffer, keyframe))
  811. goto fail;
  812. } else {
  813. if (!handle_prores_packet(enc, buffer))
  814. goto fail;
  815. }
  816. packet->type = OBS_ENCODER_VIDEO;
  817. packet->pts = (int64_t)(CMTimeGetSeconds(pts));
  818. packet->dts = (int64_t)(CMTimeGetSeconds(dts));
  819. packet->data = enc->packet_data.array;
  820. packet->size = enc->packet_data.num;
  821. packet->keyframe = keyframe;
  822. if (should_edit_nal) {
  823. // VideoToolbox produces packets with priority lower than the RTMP code
  824. // expects, which causes it to be unable to recover from frame drops.
  825. // Fix this by manually adjusting the priority.
  826. uint8_t *start = enc->packet_data.array;
  827. uint8_t *end = start + enc->packet_data.num;
  828. start = (uint8_t *)obs_avc_find_startcode(start, end);
  829. while (true) {
  830. while (start < end && !*(start++))
  831. ;
  832. if (start == end)
  833. break;
  834. type = start[0] & 0x1F;
  835. if (type == OBS_NAL_SLICE_IDR ||
  836. type == OBS_NAL_SLICE) {
  837. uint8_t prev_type = (start[0] >> 5) & 0x3;
  838. start[0] &= ~(3 << 5);
  839. if (type == OBS_NAL_SLICE_IDR)
  840. start[0] |= OBS_NAL_PRIORITY_HIGHEST
  841. << 5;
  842. else if (type == OBS_NAL_SLICE &&
  843. prev_type !=
  844. OBS_NAL_PRIORITY_DISPOSABLE)
  845. start[0] |= OBS_NAL_PRIORITY_HIGH << 5;
  846. else
  847. start[0] |= prev_type << 5;
  848. }
  849. start = (uint8_t *)obs_avc_find_startcode(start, end);
  850. }
  851. }
  852. CFRelease(buffer);
  853. return true;
  854. fail:
  855. CFRelease(buffer);
  856. return false;
  857. }
  858. bool get_cached_pixel_buffer(struct vt_encoder *enc, CVPixelBufferRef *buf)
  859. {
  860. OSStatus code;
  861. CVPixelBufferPoolRef pool =
  862. VTCompressionSessionGetPixelBufferPool(enc->session);
  863. if (!pool)
  864. return kCVReturnError;
  865. CVPixelBufferRef pixbuf;
  866. STATUS_CHECK(CVPixelBufferPoolCreatePixelBuffer(NULL, pool, &pixbuf));
  867. // Why aren't these already set on the pixel buffer?
  868. // I would have expected pixel buffers from the session's
  869. // pool to have the correct color space stuff set
  870. CVBufferSetAttachment(pixbuf, kCVImageBufferYCbCrMatrixKey,
  871. obs_to_vt_colorspace(enc->colorspace),
  872. kCVAttachmentMode_ShouldPropagate);
  873. CVBufferSetAttachment(pixbuf, kCVImageBufferColorPrimariesKey,
  874. obs_to_vt_primaries(enc->colorspace),
  875. kCVAttachmentMode_ShouldPropagate);
  876. CVBufferSetAttachment(pixbuf, kCVImageBufferTransferFunctionKey,
  877. obs_to_vt_transfer(enc->colorspace),
  878. kCVAttachmentMode_ShouldPropagate);
  879. *buf = pixbuf;
  880. return true;
  881. fail:
  882. return false;
  883. }
  884. static bool vt_encode(void *data, struct encoder_frame *frame,
  885. struct encoder_packet *packet, bool *received_packet)
  886. {
  887. struct vt_encoder *enc = data;
  888. OSStatus code;
  889. CMTime dur = CMTimeMake(enc->fps_den, enc->fps_num);
  890. CMTime off = CMTimeMultiply(dur, 2);
  891. CMTime pts = CMTimeMake(frame->pts, enc->fps_num);
  892. CVPixelBufferRef pixbuf = NULL;
  893. if (!get_cached_pixel_buffer(enc, &pixbuf)) {
  894. VT_BLOG(LOG_ERROR, "Unable to create pixel buffer");
  895. goto fail;
  896. }
  897. STATUS_CHECK(CVPixelBufferLockBaseAddress(pixbuf, 0));
  898. for (int i = 0; i < MAX_AV_PLANES; i++) {
  899. if (frame->data[i] == NULL)
  900. break;
  901. uint8_t *p = (uint8_t *)CVPixelBufferGetBaseAddressOfPlane(
  902. pixbuf, i);
  903. uint8_t *f = frame->data[i];
  904. size_t plane_linesize =
  905. CVPixelBufferGetBytesPerRowOfPlane(pixbuf, i);
  906. size_t plane_height = CVPixelBufferGetHeightOfPlane(pixbuf, i);
  907. for (size_t j = 0; j < plane_height; j++) {
  908. memcpy(p, f, frame->linesize[i]);
  909. p += plane_linesize;
  910. f += frame->linesize[i];
  911. }
  912. }
  913. STATUS_CHECK(CVPixelBufferUnlockBaseAddress(pixbuf, 0));
  914. STATUS_CHECK(VTCompressionSessionEncodeFrame(enc->session, pixbuf, pts,
  915. dur, NULL, pixbuf, NULL));
  916. CMSampleBufferRef buffer =
  917. (CMSampleBufferRef)CMSimpleQueueDequeue(enc->queue);
  918. // No samples waiting in the queue
  919. if (buffer == NULL)
  920. return true;
  921. *received_packet = true;
  922. return parse_sample(enc, buffer, packet, off);
  923. fail:
  924. return false;
  925. }
  926. #undef STATUS_CHECK
  927. #undef CFNUM_INT
  928. static bool vt_extra_data(void *data, uint8_t **extra_data, size_t *size)
  929. {
  930. struct vt_encoder *enc = (struct vt_encoder *)data;
  931. *extra_data = enc->extra_data.array;
  932. *size = enc->extra_data.num;
  933. return true;
  934. }
  935. static const char *vt_getname(void *data)
  936. {
  937. struct vt_encoder_type_data *type_data = data;
  938. if (strcmp("Apple H.264 (HW)", type_data->disp_name) == 0) {
  939. return obs_module_text("VTH264EncHW");
  940. } else if (strcmp("Apple H.264 (SW)", type_data->disp_name) == 0) {
  941. return obs_module_text("VTH264EncSW");
  942. #ifdef ENABLE_HEVC
  943. } else if (strcmp("Apple HEVC (HW)", type_data->disp_name) == 0) {
  944. return obs_module_text("VTHEVCEncHW");
  945. } else if (strcmp("Apple HEVC (AVE)", type_data->disp_name) == 0) {
  946. return obs_module_text("VTHEVCEncT2");
  947. } else if (strcmp("Apple HEVC (SW)", type_data->disp_name) == 0) {
  948. return obs_module_text("VTHEVCEncSW");
  949. #endif
  950. } else if (strncmp("AppleProResHW", type_data->disp_name, 13) == 0) {
  951. return obs_module_text("VTProResEncHW");
  952. } else if (strncmp("Apple ProRes", type_data->disp_name, 12) == 0) {
  953. return obs_module_text("VTProResEncSW");
  954. }
  955. return type_data->disp_name;
  956. }
  957. #define TEXT_BITRATE obs_module_text("Bitrate")
  958. #define TEXT_QUALITY obs_module_text("Quality")
  959. #define TEXT_USE_MAX_BITRATE obs_module_text("UseMaxBitrate")
  960. #define TEXT_MAX_BITRATE obs_module_text("MaxBitrate")
  961. #define TEXT_MAX_BITRATE_WINDOW obs_module_text("MaxBitrateWindow")
  962. #define TEXT_KEYINT_SEC obs_module_text("KeyframeIntervalSec")
  963. #define TEXT_PROFILE obs_module_text("Profile")
  964. #define TEXT_BFRAMES obs_module_text("UseBFrames")
  965. #define TEXT_RATE_CONTROL obs_module_text("RateControl")
  966. #define TEXT_PRORES_CODEC obs_module_text("ProResCodec")
  967. static bool rate_control_limit_bitrate_modified(obs_properties_t *ppts,
  968. obs_property_t *p,
  969. obs_data_t *settings)
  970. {
  971. bool has_bitrate = true;
  972. bool can_limit_bitrate = true;
  973. bool use_limit_bitrate = obs_data_get_bool(settings, "limit_bitrate");
  974. const char *rate_control =
  975. obs_data_get_string(settings, "rate_control");
  976. if (strcmp(rate_control, "CBR") == 0) {
  977. can_limit_bitrate = false;
  978. has_bitrate = true;
  979. } else if (strcmp(rate_control, "CRF") == 0) {
  980. can_limit_bitrate = true;
  981. has_bitrate = false;
  982. } else if (strcmp(rate_control, "ABR") == 0) {
  983. can_limit_bitrate = true;
  984. has_bitrate = true;
  985. }
  986. p = obs_properties_get(ppts, "limit_bitrate");
  987. obs_property_set_visible(p, can_limit_bitrate);
  988. p = obs_properties_get(ppts, "max_bitrate");
  989. obs_property_set_visible(p, can_limit_bitrate && use_limit_bitrate);
  990. p = obs_properties_get(ppts, "max_bitrate_window");
  991. obs_property_set_visible(p, can_limit_bitrate && use_limit_bitrate);
  992. p = obs_properties_get(ppts, "bitrate");
  993. obs_property_set_visible(p, has_bitrate);
  994. p = obs_properties_get(ppts, "quality");
  995. obs_property_set_visible(p, !has_bitrate);
  996. return true;
  997. }
  998. static obs_properties_t *vt_properties_h26x(void *unused, void *data)
  999. {
  1000. UNUSED_PARAMETER(unused);
  1001. struct vt_encoder_type_data *type_data = data;
  1002. obs_properties_t *props = obs_properties_create();
  1003. obs_property_t *p;
  1004. p = obs_properties_add_list(props, "rate_control", TEXT_RATE_CONTROL,
  1005. OBS_COMBO_TYPE_LIST,
  1006. OBS_COMBO_FORMAT_STRING);
  1007. if (__builtin_available(macOS 13.0, *))
  1008. if (type_data->hardware_accelerated
  1009. #ifndef __aarch64__
  1010. && (os_get_emulation_status() == true)
  1011. #endif
  1012. )
  1013. obs_property_list_add_string(p, "CBR", "CBR");
  1014. obs_property_list_add_string(p, "ABR", "ABR");
  1015. if (type_data->hardware_accelerated
  1016. #ifndef __aarch64__
  1017. && (os_get_emulation_status() == true)
  1018. #endif
  1019. )
  1020. obs_property_list_add_string(p, "CRF", "CRF");
  1021. obs_property_set_modified_callback(p,
  1022. rate_control_limit_bitrate_modified);
  1023. p = obs_properties_add_int(props, "bitrate", TEXT_BITRATE, 50, 10000000,
  1024. 50);
  1025. obs_property_int_set_suffix(p, " Kbps");
  1026. obs_properties_add_int_slider(props, "quality", TEXT_QUALITY, 0, 100,
  1027. 1);
  1028. p = obs_properties_add_bool(props, "limit_bitrate",
  1029. TEXT_USE_MAX_BITRATE);
  1030. obs_property_set_modified_callback(p,
  1031. rate_control_limit_bitrate_modified);
  1032. p = obs_properties_add_int(props, "max_bitrate", TEXT_MAX_BITRATE, 50,
  1033. 10000000, 50);
  1034. obs_property_int_set_suffix(p, " Kbps");
  1035. p = obs_properties_add_float(props, "max_bitrate_window",
  1036. TEXT_MAX_BITRATE_WINDOW, 0.10f, 10.0f,
  1037. 0.25f);
  1038. obs_property_float_set_suffix(p, " s");
  1039. p = obs_properties_add_int(props, "keyint_sec", TEXT_KEYINT_SEC, 0, 20,
  1040. 1);
  1041. obs_property_int_set_suffix(p, " s");
  1042. p = obs_properties_add_list(props, "profile", TEXT_PROFILE,
  1043. OBS_COMBO_TYPE_LIST,
  1044. OBS_COMBO_FORMAT_STRING);
  1045. if (type_data->codec_type == kCMVideoCodecType_H264) {
  1046. obs_property_list_add_string(p, "baseline", "baseline");
  1047. obs_property_list_add_string(p, "main", "main");
  1048. obs_property_list_add_string(p, "high", "high");
  1049. #ifdef ENABLE_HEVC
  1050. } else if (type_data->codec_type == kCMVideoCodecType_HEVC) {
  1051. obs_property_list_add_string(p, "main", "main");
  1052. obs_property_list_add_string(p, "main10", "main10");
  1053. if (__builtin_available(macOS 12.3, *)) {
  1054. obs_property_list_add_string(p, "main 4:2:2 10",
  1055. "main42210");
  1056. }
  1057. #endif
  1058. }
  1059. obs_properties_add_bool(props, "bframes", TEXT_BFRAMES);
  1060. return props;
  1061. }
  1062. static obs_properties_t *vt_properties_prores(void *unused, void *data)
  1063. {
  1064. UNUSED_PARAMETER(unused);
  1065. struct vt_encoder_type_data *type_data = data;
  1066. obs_properties_t *props = obs_properties_create();
  1067. obs_property_t *p;
  1068. p = obs_properties_add_list(props, "codec_type", TEXT_PRORES_CODEC,
  1069. OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
  1070. uint32_t codec_availability_flags = 0;
  1071. size_t size = 0;
  1072. struct vt_prores_encoder_data *encoder_list = NULL;
  1073. if (type_data->hardware_accelerated) {
  1074. size = vt_prores_hardware_encoder_list.num;
  1075. encoder_list = vt_prores_hardware_encoder_list.array;
  1076. } else {
  1077. size = vt_prores_software_encoder_list.num;
  1078. encoder_list = vt_prores_software_encoder_list.array;
  1079. }
  1080. for (size_t i = 0; i < size; ++i) {
  1081. switch (encoder_list[i].codec_type) {
  1082. case kCMVideoCodecType_AppleProRes422Proxy:
  1083. codec_availability_flags |= (1 << 0);
  1084. break;
  1085. case kCMVideoCodecType_AppleProRes422LT:
  1086. codec_availability_flags |= (1 << 1);
  1087. break;
  1088. case kCMVideoCodecType_AppleProRes422:
  1089. codec_availability_flags |= (1 << 2);
  1090. break;
  1091. case kCMVideoCodecType_AppleProRes422HQ:
  1092. codec_availability_flags |= (1 << 3);
  1093. break;
  1094. }
  1095. }
  1096. if (codec_availability_flags & (1 << 0))
  1097. obs_property_list_add_int(
  1098. p, obs_module_text("ProRes422Proxy"),
  1099. kCMVideoCodecType_AppleProRes422Proxy);
  1100. if (codec_availability_flags & (1 << 1))
  1101. obs_property_list_add_int(p, obs_module_text("ProRes422LT"),
  1102. kCMVideoCodecType_AppleProRes422LT);
  1103. if (codec_availability_flags & (1 << 2))
  1104. obs_property_list_add_int(p, obs_module_text("ProRes422"),
  1105. kCMVideoCodecType_AppleProRes422);
  1106. if (codec_availability_flags & (1 << 3))
  1107. obs_property_list_add_int(p, obs_module_text("ProRes422HQ"),
  1108. kCMVideoCodecType_AppleProRes422HQ);
  1109. return props;
  1110. }
  1111. static void vt_defaults(obs_data_t *settings, void *data)
  1112. {
  1113. struct vt_encoder_type_data *type_data = data;
  1114. obs_data_set_default_string(settings, "rate_control", "ABR");
  1115. if (__builtin_available(macOS 13.0, *))
  1116. if (type_data->hardware_accelerated
  1117. #ifndef __aarch64__
  1118. && (os_get_emulation_status() == true)
  1119. #endif
  1120. )
  1121. obs_data_set_default_string(settings, "rate_control",
  1122. "CBR");
  1123. obs_data_set_default_int(settings, "bitrate", 2500);
  1124. obs_data_set_default_int(settings, "quality", 60);
  1125. obs_data_set_default_bool(settings, "limit_bitrate", false);
  1126. obs_data_set_default_int(settings, "max_bitrate", 2500);
  1127. obs_data_set_default_double(settings, "max_bitrate_window", 1.5f);
  1128. obs_data_set_default_int(settings, "keyint_sec", 0);
  1129. obs_data_set_default_string(settings, "profile", "main");
  1130. obs_data_set_default_int(settings, "codec_type",
  1131. kCMVideoCodecType_AppleProRes422);
  1132. obs_data_set_default_bool(settings, "bframes", true);
  1133. }
  1134. static void vt_free_type_data(void *data)
  1135. {
  1136. struct vt_encoder_type_data *type_data = data;
  1137. bfree((char *)type_data->disp_name);
  1138. bfree((char *)type_data->id);
  1139. bfree(type_data);
  1140. }
  1141. static inline void
  1142. vt_add_prores_encoder_data_to_list(CFDictionaryRef encoder_dict,
  1143. FourCharCode codec_type)
  1144. {
  1145. struct vt_prores_encoder_data *encoder_data = NULL;
  1146. CFBooleanRef hardware_accelerated = CFDictionaryGetValue(
  1147. encoder_dict, kVTVideoEncoderList_IsHardwareAccelerated);
  1148. if (hardware_accelerated == kCFBooleanTrue)
  1149. encoder_data =
  1150. da_push_back_new(vt_prores_hardware_encoder_list);
  1151. else
  1152. encoder_data =
  1153. da_push_back_new(vt_prores_software_encoder_list);
  1154. encoder_data->encoder_id = CFDictionaryGetValue(
  1155. encoder_dict, kVTVideoEncoderList_EncoderID);
  1156. encoder_data->codec_type = codec_type;
  1157. }
  1158. static CFComparisonResult
  1159. compare_encoder_list(const void *left_val, const void *right_val, void *unused)
  1160. {
  1161. UNUSED_PARAMETER(unused);
  1162. CFDictionaryRef left = (CFDictionaryRef)left_val;
  1163. CFDictionaryRef right = (CFDictionaryRef)right_val;
  1164. CFNumberRef left_codec_num =
  1165. CFDictionaryGetValue(left, kVTVideoEncoderList_CodecType);
  1166. CFNumberRef right_codec_num =
  1167. CFDictionaryGetValue(right, kVTVideoEncoderList_CodecType);
  1168. CFComparisonResult result =
  1169. CFNumberCompare(left_codec_num, right_codec_num, NULL);
  1170. if (result != kCFCompareEqualTo)
  1171. return result;
  1172. CFBooleanRef left_hardware_accel = CFDictionaryGetValue(
  1173. left, kVTVideoEncoderList_IsHardwareAccelerated);
  1174. CFBooleanRef right_hardware_accel = CFDictionaryGetValue(
  1175. right, kVTVideoEncoderList_IsHardwareAccelerated);
  1176. if (left_hardware_accel == right_hardware_accel)
  1177. return kCFCompareEqualTo;
  1178. else if (left_hardware_accel == kCFBooleanTrue)
  1179. return kCFCompareGreaterThan;
  1180. else
  1181. return kCFCompareLessThan;
  1182. }
  1183. OBS_DECLARE_MODULE()
  1184. OBS_MODULE_USE_DEFAULT_LOCALE("mac-videotoolbox", "en-US")
  1185. bool obs_module_load(void)
  1186. {
  1187. struct obs_encoder_info info = {
  1188. .type = OBS_ENCODER_VIDEO,
  1189. .get_name = vt_getname,
  1190. .create = vt_create,
  1191. .destroy = vt_destroy,
  1192. .encode = vt_encode,
  1193. .update = vt_update,
  1194. .get_defaults2 = vt_defaults,
  1195. .get_extra_data = vt_extra_data,
  1196. .free_type_data = vt_free_type_data,
  1197. .caps = OBS_ENCODER_CAP_DYN_BITRATE,
  1198. };
  1199. da_init(vt_prores_hardware_encoder_list);
  1200. da_init(vt_prores_software_encoder_list);
  1201. CFArrayRef encoder_list_const;
  1202. VTCopyVideoEncoderList(NULL, &encoder_list_const);
  1203. CFIndex size = CFArrayGetCount(encoder_list_const);
  1204. CFMutableArrayRef encoder_list = CFArrayCreateMutableCopy(
  1205. kCFAllocatorDefault, size, encoder_list_const);
  1206. CFRelease(encoder_list_const);
  1207. CFArraySortValues(encoder_list, CFRangeMake(0, size),
  1208. &compare_encoder_list, NULL);
  1209. for (CFIndex i = 0; i < size; i++) {
  1210. CFDictionaryRef encoder_dict =
  1211. CFArrayGetValueAtIndex(encoder_list, i);
  1212. #define VT_DICTSTR(key, name) \
  1213. CFStringRef name##_ref = CFDictionaryGetValue(encoder_dict, key); \
  1214. CFIndex name##_len = \
  1215. CFStringGetMaximumSizeOfFileSystemRepresentation(name##_ref); \
  1216. char *name = bzalloc(name##_len + 1); \
  1217. CFStringGetFileSystemRepresentation(name##_ref, name, name##_len);
  1218. CMVideoCodecType codec_type = 0;
  1219. {
  1220. CFNumberRef codec_type_num = CFDictionaryGetValue(
  1221. encoder_dict, kVTVideoEncoderList_CodecType);
  1222. CFNumberGetValue(codec_type_num, kCFNumberSInt32Type,
  1223. &codec_type);
  1224. }
  1225. switch (codec_type) {
  1226. case kCMVideoCodecType_H264:
  1227. info.get_properties2 = vt_properties_h26x;
  1228. info.codec = "h264";
  1229. break;
  1230. #ifdef ENABLE_HEVC
  1231. case kCMVideoCodecType_HEVC:
  1232. info.get_properties2 = vt_properties_h26x;
  1233. info.codec = "hevc";
  1234. break;
  1235. #endif
  1236. // 422 is used as a marker for all ProRes types,
  1237. // since the type is stored as a profile
  1238. case kCMVideoCodecType_AppleProRes422:
  1239. info.get_properties2 = vt_properties_prores;
  1240. info.codec = "prores";
  1241. vt_add_prores_encoder_data_to_list(encoder_dict,
  1242. codec_type);
  1243. break;
  1244. case kCMVideoCodecType_AppleProRes422Proxy:
  1245. case kCMVideoCodecType_AppleProRes422LT:
  1246. case kCMVideoCodecType_AppleProRes422HQ:
  1247. vt_add_prores_encoder_data_to_list(encoder_dict,
  1248. codec_type);
  1249. continue;
  1250. default:
  1251. continue;
  1252. }
  1253. VT_DICTSTR(kVTVideoEncoderList_EncoderID, id);
  1254. VT_DICTSTR(kVTVideoEncoderList_DisplayName, disp_name);
  1255. CFBooleanRef hardware_ref = CFDictionaryGetValue(
  1256. encoder_dict,
  1257. kVTVideoEncoderList_IsHardwareAccelerated);
  1258. bool hardware_accelerated =
  1259. (hardware_ref) ? CFBooleanGetValue(hardware_ref)
  1260. : false;
  1261. info.id = id;
  1262. struct vt_encoder_type_data *type_data =
  1263. bzalloc(sizeof(struct vt_encoder_type_data));
  1264. type_data->disp_name = disp_name;
  1265. type_data->id = id;
  1266. type_data->codec_type = codec_type;
  1267. type_data->hardware_accelerated = hardware_accelerated;
  1268. info.type_data = type_data;
  1269. obs_register_encoder(&info);
  1270. #undef VT_DICTSTR
  1271. }
  1272. CFRelease(encoder_list);
  1273. VT_LOG(LOG_INFO, "Adding VideoToolbox encoders");
  1274. return true;
  1275. }
  1276. void obs_module_unload(void)
  1277. {
  1278. da_free(vt_prores_hardware_encoder_list);
  1279. da_free(vt_prores_software_encoder_list);
  1280. }