1
0

MultitrackVideoOutput.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892
  1. #include "MultitrackVideoError.hpp"
  2. #include "MultitrackVideoOutput.hpp"
  3. #include "models/multitrack-video.hpp"
  4. #include "GoLiveAPI_Network.hpp"
  5. #include "GoLiveAPI_PostData.hpp"
  6. #include <OBSApp.hpp>
  7. #include <bpm.h>
  8. #include <util/dstr.hpp>
  9. #include <libavformat/avformat.h>
  10. #include <QPushButton>
  11. #include <QMessageBox>
  12. #include <QThread>
  13. #include <QUrl>
  14. #include <QUrlQuery>
  15. #include <cinttypes>
  16. // Codec profile strings
  17. static const char *h264_main = "Main";
  18. static const char *h264_high = "High";
  19. static const char *h264_cb = "Constrained Baseline";
  20. static const char *hevc_main = "Main";
  21. static const char *hevc_main10 = "Main 10";
  22. static const char *av1_main = "Main";
  23. Qt::ConnectionType BlockingConnectionTypeFor(QObject *object)
  24. {
  25. return object->thread() == QThread::currentThread() ? Qt::DirectConnection : Qt::BlockingQueuedConnection;
  26. }
  27. bool MultitrackVideoDeveloperModeEnabled()
  28. {
  29. static bool developer_mode = [] {
  30. auto args = qApp->arguments();
  31. for (const auto &arg : args) {
  32. if (arg == "--enable-multitrack-video-dev") {
  33. return true;
  34. }
  35. }
  36. return false;
  37. }();
  38. return developer_mode;
  39. }
  40. static OBSServiceAutoRelease create_service(const GoLiveApi::Config &go_live_config,
  41. const std::optional<std::string> &rtmp_url, const QString &in_stream_key,
  42. std::optional<bool> use_rtmps)
  43. {
  44. const char *url = nullptr;
  45. QString stream_key = in_stream_key;
  46. const auto &ingest_endpoints = go_live_config.ingest_endpoints;
  47. for (auto &endpoint : ingest_endpoints) {
  48. if (qstrnicmp("RTMP", endpoint.protocol.c_str(), 4))
  49. continue;
  50. if (use_rtmps.has_value() && *use_rtmps != (qstricmp("RTMPS", endpoint.protocol.c_str()) == 0))
  51. continue;
  52. url = endpoint.url_template.c_str();
  53. if (endpoint.authentication && !endpoint.authentication->empty()) {
  54. blog(LOG_INFO, "Using stream key supplied by autoconfig");
  55. stream_key = QString::fromStdString(*endpoint.authentication);
  56. }
  57. break;
  58. }
  59. if (rtmp_url.has_value()) {
  60. // Despite being set by user, it was set to a ""
  61. if (rtmp_url->empty()) {
  62. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.NoCustomRTMPURLInSettings"));
  63. }
  64. url = rtmp_url->c_str();
  65. blog(LOG_INFO, "Using custom RTMP URL: '%s'", url);
  66. } else {
  67. if (!url) {
  68. blog(LOG_ERROR, "No RTMP URL in go live config");
  69. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.NoRTMPURLInConfig"));
  70. }
  71. blog(LOG_INFO, "Using URL template: '%s'", url);
  72. }
  73. DStr str;
  74. dstr_cat(str, url);
  75. // dstr_find does not protect against null, and dstr_cat will
  76. // not initialize str if cat'ing with a null url
  77. if (!dstr_is_empty(str)) {
  78. auto found = dstr_find(str, "/{stream_key}");
  79. if (found)
  80. dstr_remove(str, found - str->array, str->len - (found - str->array));
  81. }
  82. /* The stream key itself may contain query parameters, such as
  83. * "bandwidthtest" that need to be carried over. */
  84. QUrl parsed_user_key{in_stream_key};
  85. QUrlQuery user_key_query{parsed_user_key};
  86. QUrl parsed_key{stream_key};
  87. QUrl parsed_url{url};
  88. QUrlQuery parsed_query{parsed_url};
  89. for (const auto &[key, value] : user_key_query.queryItems())
  90. parsed_query.addQueryItem(key, value);
  91. if (!go_live_config.meta.config_id.empty()) {
  92. parsed_query.addQueryItem("clientConfigId", QString::fromStdString(go_live_config.meta.config_id));
  93. }
  94. parsed_key.setQuery(parsed_query);
  95. OBSDataAutoRelease settings = obs_data_create();
  96. obs_data_set_string(settings, "server", str->array);
  97. obs_data_set_string(settings, "key", parsed_key.toString().toUtf8().constData());
  98. auto service = obs_service_create("rtmp_custom", "multitrack video service", settings, nullptr);
  99. if (!service) {
  100. blog(LOG_WARNING, "Failed to create multitrack video service");
  101. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.FailedToCreateMultitrackVideoService"));
  102. }
  103. return service;
  104. }
  105. static OBSOutputAutoRelease create_output()
  106. {
  107. OBSOutputAutoRelease output = obs_output_create("rtmp_output", "rtmp multitrack video", nullptr, nullptr);
  108. if (!output) {
  109. blog(LOG_ERROR, "Failed to create multitrack video rtmp output");
  110. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.FailedToCreateMultitrackVideoOutput"));
  111. }
  112. return output;
  113. }
  114. static OBSOutputAutoRelease create_recording_output(obs_data_t *settings)
  115. {
  116. OBSOutputAutoRelease output;
  117. bool useMP4 = obs_data_get_bool(settings, "use_mp4");
  118. if (useMP4) {
  119. output = obs_output_create("mp4_output", "mp4 multitrack video", settings, nullptr);
  120. } else {
  121. output = obs_output_create("flv_output", "flv multitrack video", settings, nullptr);
  122. }
  123. if (!output) {
  124. blog(LOG_ERROR, "Failed to create multitrack video %s output", useMP4 ? "mp4" : "flv");
  125. }
  126. return output;
  127. }
  128. static void adjust_video_encoder_scaling(const obs_video_info &ovi, obs_encoder_t *video_encoder,
  129. const GoLiveApi::VideoEncoderConfiguration &encoder_config,
  130. size_t encoder_index)
  131. {
  132. auto requested_width = encoder_config.width;
  133. auto requested_height = encoder_config.height;
  134. if (ovi.base_width < requested_width || ovi.base_height < requested_height) {
  135. blog(LOG_WARNING,
  136. "Requested resolution exceeds canvas/available resolution for encoder %zu: %" PRIu32 "x%" PRIu32
  137. " > %" PRIu32 "x%" PRIu32,
  138. encoder_index, requested_width, requested_height, ovi.base_width, ovi.base_height);
  139. }
  140. obs_encoder_set_scaled_size(video_encoder, requested_width, requested_height);
  141. obs_encoder_set_gpu_scale_type(video_encoder, encoder_config.gpu_scale_type.value_or(OBS_SCALE_BICUBIC));
  142. obs_encoder_set_preferred_video_format(video_encoder, encoder_config.format.value_or(VIDEO_FORMAT_NV12));
  143. obs_encoder_set_preferred_color_space(video_encoder, encoder_config.colorspace.value_or(VIDEO_CS_709));
  144. obs_encoder_set_preferred_range(video_encoder, encoder_config.range.value_or(VIDEO_RANGE_PARTIAL));
  145. }
  146. static uint32_t closest_divisor(const obs_video_info &ovi, const media_frames_per_second &target_fps)
  147. {
  148. auto target = (uint64_t)target_fps.numerator * ovi.fps_den;
  149. auto source = (uint64_t)ovi.fps_num * target_fps.denominator;
  150. return std::max(1u, static_cast<uint32_t>(source / target));
  151. }
  152. static void adjust_encoder_frame_rate_divisor(const obs_video_info &ovi, obs_encoder_t *video_encoder,
  153. const GoLiveApi::VideoEncoderConfiguration &encoder_config,
  154. const size_t encoder_index)
  155. {
  156. if (!encoder_config.framerate) {
  157. blog(LOG_WARNING, "`framerate` not specified for encoder %zu", encoder_index);
  158. return;
  159. }
  160. media_frames_per_second requested_fps = *encoder_config.framerate;
  161. if (ovi.fps_num == requested_fps.numerator && ovi.fps_den == requested_fps.denominator)
  162. return;
  163. auto divisor = closest_divisor(ovi, requested_fps);
  164. if (divisor <= 1)
  165. return;
  166. blog(LOG_INFO, "Setting frame rate divisor to %u for encoder %zu", divisor, encoder_index);
  167. obs_encoder_set_frame_rate_divisor(video_encoder, divisor);
  168. }
  169. static bool encoder_available(const char *type)
  170. {
  171. const char *id = nullptr;
  172. for (size_t idx = 0; obs_enum_encoder_types(idx, &id); idx++) {
  173. if (strcmp(id, type) == 0)
  174. return true;
  175. }
  176. return false;
  177. }
  178. static OBSEncoderAutoRelease create_video_encoder(DStr &name_buffer, size_t encoder_index,
  179. const GoLiveApi::VideoEncoderConfiguration &encoder_config)
  180. {
  181. auto encoder_type = encoder_config.type.c_str();
  182. if (!encoder_available(encoder_type)) {
  183. blog(LOG_ERROR, "Encoder type '%s' not available", encoder_type);
  184. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.EncoderNotAvailable").arg(encoder_type));
  185. }
  186. dstr_printf(name_buffer, "multitrack video video encoder %zu", encoder_index);
  187. OBSDataAutoRelease encoder_settings = obs_data_create_from_json(encoder_config.settings.dump().c_str());
  188. /* VAAPI-based encoders unfortunately use an integer for "profile". Until a string-based "profile" can be used with
  189. * VAAPI, find the corresponding integer value and update the settings with an integer-based "profile".
  190. */
  191. if (strstr(encoder_type, "vaapi")) {
  192. // Move the "profile" string to "profile_str".
  193. const char *profile_str = obs_data_get_string(encoder_settings, "profile");
  194. obs_data_set_string(encoder_settings, "profile_str", profile_str);
  195. obs_data_item_t *profile_item = obs_data_item_byname(encoder_settings, "profile");
  196. obs_data_item_remove(&profile_item);
  197. obs_data_item_release(&profile_item);
  198. // Find the vaapi_profile integer based on codec type and "profile" string.
  199. int vaapi_profile;
  200. const char *codec = obs_get_encoder_codec(encoder_type);
  201. if (strcmp(codec, "h264") == 0) {
  202. if (astrcmpi(profile_str, h264_main) == 0) {
  203. vaapi_profile = AV_PROFILE_H264_MAIN;
  204. } else if (astrcmpi(profile_str, h264_high) == 0) {
  205. vaapi_profile = AV_PROFILE_H264_HIGH;
  206. } else if (astrcmpi(profile_str, h264_cb) == 0) {
  207. vaapi_profile = AV_PROFILE_H264_CONSTRAINED_BASELINE;
  208. } else {
  209. blog(LOG_WARNING, "Unsupported H264 profile '%s', setting to Main profile",
  210. profile_str);
  211. vaapi_profile = AV_PROFILE_H264_MAIN;
  212. }
  213. } else if (strcmp(codec, "hevc") == 0) {
  214. if (astrcmpi(profile_str, hevc_main) == 0) {
  215. vaapi_profile = AV_PROFILE_HEVC_MAIN;
  216. } else if (astrcmpi(profile_str, hevc_main10) == 0) {
  217. vaapi_profile = AV_PROFILE_HEVC_MAIN_10;
  218. } else {
  219. blog(LOG_WARNING, "Unsupported HEVC profile '%s', setting to Main profile",
  220. profile_str);
  221. vaapi_profile = AV_PROFILE_HEVC_MAIN;
  222. }
  223. } else if (strcmp(codec, "av1") == 0) {
  224. if (astrcmpi(profile_str, av1_main) == 0) {
  225. vaapi_profile = AV_PROFILE_AV1_MAIN;
  226. } else {
  227. blog(LOG_WARNING, "Unsupported AV1 profile '%s', setting to Main profile", profile_str);
  228. vaapi_profile = AV_PROFILE_AV1_MAIN;
  229. }
  230. } else {
  231. vaapi_profile = AV_PROFILE_UNKNOWN;
  232. blog(LOG_WARNING, "Unsupported codec '%s', setting profile to unknown", codec);
  233. }
  234. obs_data_set_int(encoder_settings, "profile", vaapi_profile);
  235. }
  236. obs_data_set_bool(encoder_settings, "disable_scenecut", true);
  237. OBSEncoderAutoRelease video_encoder =
  238. obs_video_encoder_create(encoder_type, name_buffer, encoder_settings, nullptr);
  239. if (!video_encoder) {
  240. blog(LOG_ERROR, "Failed to create video encoder '%s'", name_buffer->array);
  241. throw MultitrackVideoError::warning(
  242. QTStr("FailedToStartStream.FailedToCreateVideoEncoder").arg(name_buffer->array, encoder_type));
  243. }
  244. obs_encoder_set_video(video_encoder, obs_get_video());
  245. obs_video_info ovi;
  246. if (!obs_get_video_info(&ovi)) {
  247. blog(LOG_WARNING, "Failed to get obs_video_info while creating encoder %zu", encoder_index);
  248. throw MultitrackVideoError::warning(
  249. QTStr("FailedToStartStream.FailedToGetOBSVideoInfo").arg(name_buffer->array, encoder_type));
  250. }
  251. adjust_video_encoder_scaling(ovi, video_encoder, encoder_config, encoder_index);
  252. adjust_encoder_frame_rate_divisor(ovi, video_encoder, encoder_config, encoder_index);
  253. return video_encoder;
  254. }
  255. static OBSEncoderAutoRelease create_audio_encoder(const char *name, const char *audio_encoder_id, obs_data_t *settings,
  256. size_t mixer_idx)
  257. {
  258. OBSEncoderAutoRelease audio_encoder =
  259. obs_audio_encoder_create(audio_encoder_id, name, settings, mixer_idx, nullptr);
  260. if (!audio_encoder) {
  261. blog(LOG_ERROR, "Failed to create audio encoder");
  262. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.FailedToCreateAudioEncoder"));
  263. }
  264. obs_encoder_set_audio(audio_encoder, obs_get_audio());
  265. return audio_encoder;
  266. }
  267. struct OBSOutputs {
  268. OBSOutputAutoRelease output, recording_output;
  269. };
  270. static OBSOutputs SetupOBSOutput(QWidget *parent, const QString &multitrack_video_name,
  271. obs_data_t *dump_stream_to_file_config, const GoLiveApi::Config &go_live_config,
  272. std::vector<OBSEncoderAutoRelease> &audio_encoders,
  273. std::shared_ptr<obs_encoder_group_t> &video_encoder_group,
  274. const char *audio_encoder_id, size_t main_audio_mixer,
  275. std::optional<size_t> vod_track_mixer);
  276. static void SetupSignalHandlers(bool recording, MultitrackVideoOutput *self, obs_output_t *output, OBSSignal &start,
  277. OBSSignal &stop);
  278. void MultitrackVideoOutput::PrepareStreaming(QWidget *parent, const char *service_name, obs_service_t *service,
  279. const std::optional<std::string> &rtmp_url, const QString &stream_key,
  280. const char *audio_encoder_id,
  281. std::optional<uint32_t> maximum_aggregate_bitrate,
  282. std::optional<uint32_t> maximum_video_tracks,
  283. std::optional<std::string> custom_config,
  284. obs_data_t *dump_stream_to_file_config, size_t main_audio_mixer,
  285. std::optional<size_t> vod_track_mixer, std::optional<bool> use_rtmps)
  286. {
  287. {
  288. const std::lock_guard<std::mutex> current_lock{current_mutex};
  289. const std::lock_guard<std::mutex> current_stream_dump_lock{current_stream_dump_mutex};
  290. if (current || current_stream_dump) {
  291. blog(LOG_WARNING, "Tried to prepare multitrack video output while it's already active");
  292. return;
  293. }
  294. }
  295. restart_on_error = false;
  296. std::optional<GoLiveApi::Config> go_live_config;
  297. std::optional<GoLiveApi::Config> custom;
  298. bool is_custom_config = custom_config.has_value();
  299. auto auto_config_url = MultitrackVideoAutoConfigURL(service);
  300. OBSDataAutoRelease service_settings = obs_service_get_settings(service);
  301. auto multitrack_video_name = QTStr("Basic.Settings.Stream.MultitrackVideoLabel");
  302. if (obs_data_has_user_value(service_settings, "multitrack_video_name")) {
  303. multitrack_video_name = obs_data_get_string(service_settings, "multitrack_video_name");
  304. }
  305. auto auto_config_url_data = auto_config_url.toUtf8();
  306. DStr vod_track_info_storage;
  307. if (vod_track_mixer.has_value())
  308. dstr_printf(vod_track_info_storage, "Yes (mixer: %zu)", vod_track_mixer.value());
  309. blog(LOG_INFO,
  310. "Preparing enhanced broadcasting stream for:\n"
  311. " custom config: %s\n"
  312. " config url: %s\n"
  313. " settings:\n"
  314. " service: %s\n"
  315. " max aggregate bitrate: %s (%" PRIu32 ")\n"
  316. " max video tracks: %s (%" PRIu32 ")\n"
  317. " custom rtmp url: %s ('%s')\n"
  318. " vod track: %s",
  319. is_custom_config ? "Yes" : "No", !auto_config_url.isEmpty() ? auto_config_url_data.constData() : "(null)",
  320. service_name, maximum_aggregate_bitrate.has_value() ? "Set" : "Auto",
  321. maximum_aggregate_bitrate.value_or(0), maximum_video_tracks.has_value() ? "Set" : "Auto",
  322. maximum_video_tracks.value_or(0), rtmp_url.has_value() ? "Yes" : "No",
  323. rtmp_url.has_value() ? rtmp_url->c_str() : "",
  324. vod_track_info_storage->array ? vod_track_info_storage->array : "No");
  325. const bool custom_config_only = auto_config_url.isEmpty() && MultitrackVideoDeveloperModeEnabled() &&
  326. custom_config.has_value() &&
  327. strcmp(obs_service_get_id(service), "rtmp_custom") == 0;
  328. if (!custom_config_only) {
  329. auto go_live_post = constructGoLivePost(stream_key, maximum_aggregate_bitrate, maximum_video_tracks,
  330. vod_track_mixer.has_value());
  331. go_live_config = DownloadGoLiveConfig(parent, auto_config_url, go_live_post, multitrack_video_name);
  332. }
  333. if (custom_config.has_value()) {
  334. GoLiveApi::Config parsed_custom;
  335. try {
  336. parsed_custom = nlohmann::json::parse(*custom_config);
  337. } catch (const nlohmann::json::exception &exception) {
  338. blog(LOG_WARNING, "Failed to parse custom config: %s", exception.what());
  339. throw MultitrackVideoError::critical(QTStr("FailedToStartStream.InvalidCustomConfig"));
  340. }
  341. // copy unique ID from go live request
  342. if (go_live_config.has_value()) {
  343. parsed_custom.meta.config_id = go_live_config->meta.config_id;
  344. blog(LOG_INFO, "Using config_id from go live config with custom config: %s",
  345. parsed_custom.meta.config_id.c_str());
  346. }
  347. nlohmann::json custom_data = parsed_custom;
  348. blog(LOG_INFO, "Using custom go live config: %s", custom_data.dump(4).c_str());
  349. custom.emplace(std::move(parsed_custom));
  350. }
  351. if (go_live_config.has_value()) {
  352. blog(LOG_INFO, "Enhanced broadcasting config_id: '%s'", go_live_config->meta.config_id.c_str());
  353. }
  354. if (!go_live_config && !custom) {
  355. blog(LOG_ERROR, "MultitrackVideoOutput: no config set, this should never happen");
  356. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.NoConfig"));
  357. }
  358. const auto &output_config = custom ? *custom : *go_live_config;
  359. const auto &service_config = go_live_config ? *go_live_config : *custom;
  360. std::vector<OBSEncoderAutoRelease> audio_encoders;
  361. std::shared_ptr<obs_encoder_group_t> video_encoder_group;
  362. auto outputs = SetupOBSOutput(parent, multitrack_video_name, dump_stream_to_file_config, output_config,
  363. audio_encoders, video_encoder_group, audio_encoder_id, main_audio_mixer,
  364. vod_track_mixer);
  365. auto output = std::move(outputs.output);
  366. auto recording_output = std::move(outputs.recording_output);
  367. if (!output)
  368. throw MultitrackVideoError::warning(
  369. QTStr("FailedToStartStream.FallbackToDefault").arg(multitrack_video_name));
  370. auto multitrack_video_service = create_service(service_config, rtmp_url, stream_key, use_rtmps);
  371. if (!multitrack_video_service)
  372. throw MultitrackVideoError::warning(
  373. QTStr("FailedToStartStream.FallbackToDefault").arg(multitrack_video_name));
  374. obs_output_set_service(output, multitrack_video_service);
  375. // Register the BPM (Broadcast Performance Metrics) callback
  376. obs_output_add_packet_callback(output, bpm_inject, NULL);
  377. // Set callback to prevent reconnection attempts once the stream key has become invalid
  378. static auto reconnect_cb = [](void *, obs_output_t *, int code) -> bool {
  379. return code != OBS_OUTPUT_INVALID_STREAM;
  380. };
  381. obs_output_set_reconnect_callback(output, reconnect_cb, nullptr);
  382. OBSSignal start_streaming;
  383. OBSSignal stop_streaming;
  384. SetupSignalHandlers(false, this, output, start_streaming, stop_streaming);
  385. if (dump_stream_to_file_config && recording_output) {
  386. OBSSignal start_recording;
  387. OBSSignal stop_recording;
  388. SetupSignalHandlers(true, this, recording_output, start_recording, stop_recording);
  389. decltype(audio_encoders) recording_audio_encoders;
  390. recording_audio_encoders.reserve(audio_encoders.size());
  391. for (auto &encoder : audio_encoders) {
  392. recording_audio_encoders.emplace_back(obs_encoder_get_ref(encoder));
  393. }
  394. {
  395. const std::lock_guard current_stream_dump_lock{current_stream_dump_mutex};
  396. current_stream_dump.emplace(OBSOutputObjects{
  397. std::move(recording_output),
  398. video_encoder_group,
  399. std::move(recording_audio_encoders),
  400. nullptr,
  401. std::move(start_recording),
  402. std::move(stop_recording),
  403. });
  404. }
  405. }
  406. const std::lock_guard current_lock{current_mutex};
  407. current.emplace(OBSOutputObjects{
  408. std::move(output),
  409. video_encoder_group,
  410. std::move(audio_encoders),
  411. std::move(multitrack_video_service),
  412. std::move(start_streaming),
  413. std::move(stop_streaming),
  414. });
  415. }
  416. signal_handler_t *MultitrackVideoOutput::StreamingSignalHandler()
  417. {
  418. const std::lock_guard current_lock{current_mutex};
  419. return current.has_value() ? obs_output_get_signal_handler(current->output_) : nullptr;
  420. }
  421. void MultitrackVideoOutput::StartedStreaming()
  422. {
  423. OBSOutputAutoRelease dump_output;
  424. {
  425. const std::lock_guard current_stream_dump_lock{current_stream_dump_mutex};
  426. if (current_stream_dump && current_stream_dump->output_) {
  427. dump_output = obs_output_get_ref(current_stream_dump->output_);
  428. }
  429. }
  430. if (!dump_output)
  431. return;
  432. auto result = obs_output_start(dump_output);
  433. blog(LOG_INFO, "MultitrackVideoOutput: starting recording%s", result ? "" : " failed");
  434. }
  435. void MultitrackVideoOutput::StopStreaming()
  436. {
  437. restart_on_error = false;
  438. OBSOutputAutoRelease current_output;
  439. {
  440. const std::lock_guard current_lock{current_mutex};
  441. if (current && current->output_)
  442. current_output = obs_output_get_ref(current->output_);
  443. }
  444. if (current_output)
  445. obs_output_stop(current_output);
  446. OBSOutputAutoRelease dump_output;
  447. {
  448. const std::lock_guard current_stream_dump_lock{current_stream_dump_mutex};
  449. if (current_stream_dump && current_stream_dump->output_)
  450. dump_output = obs_output_get_ref(current_stream_dump->output_);
  451. }
  452. if (dump_output)
  453. obs_output_stop(dump_output);
  454. }
  455. bool MultitrackVideoOutput::HandleIncompatibleSettings(QWidget *parent, config_t *config, obs_service_t *service,
  456. bool &enableDynBitrate)
  457. {
  458. QString incompatible_settings;
  459. QString where_to_disable;
  460. QString incompatible_settings_list;
  461. size_t num = 1;
  462. auto check_setting = [&](bool setting, const char *name, const char *section) {
  463. if (!setting)
  464. return;
  465. incompatible_settings += QString(" %1. %2\n").arg(num).arg(QTStr(name));
  466. where_to_disable += QString(" %1. [%2 → %3 → %4]\n")
  467. .arg(num)
  468. .arg(QTStr("Settings"))
  469. .arg(QTStr("Basic.Settings.Advanced"))
  470. .arg(QTStr(section));
  471. incompatible_settings_list += QString("%1, ").arg(name);
  472. num += 1;
  473. };
  474. check_setting(enableDynBitrate, "Basic.Settings.Output.DynamicBitrate.Beta", "Basic.Settings.Advanced.Network");
  475. if (incompatible_settings.isEmpty())
  476. return true;
  477. OBSDataAutoRelease service_settings = obs_service_get_settings(service);
  478. QMessageBox mb(parent);
  479. mb.setIcon(QMessageBox::Critical);
  480. mb.setWindowTitle(QTStr("MultitrackVideo.IncompatibleSettings.Title"));
  481. mb.setText(QString(QTStr("MultitrackVideo.IncompatibleSettings.Text"))
  482. .arg(obs_data_get_string(service_settings, "multitrack_video_name"))
  483. .arg(incompatible_settings)
  484. .arg(where_to_disable));
  485. auto this_stream = mb.addButton(QTStr("MultitrackVideo.IncompatibleSettings.DisableAndStartStreaming"),
  486. QMessageBox::AcceptRole);
  487. auto all_streams = mb.addButton(QString(QTStr("MultitrackVideo.IncompatibleSettings.UpdateAndStartStreaming")),
  488. QMessageBox::AcceptRole);
  489. mb.setStandardButtons(QMessageBox::StandardButton::Cancel);
  490. mb.exec();
  491. const char *action = "cancel";
  492. if (mb.clickedButton() == this_stream) {
  493. action = "DisableAndStartStreaming";
  494. } else if (mb.clickedButton() == all_streams) {
  495. action = "UpdateAndStartStreaming";
  496. }
  497. blog(LOG_INFO,
  498. "MultitrackVideoOutput: attempted to start stream with incompatible"
  499. "settings (%s); action taken: %s",
  500. incompatible_settings_list.toUtf8().constData(), action);
  501. if (mb.clickedButton() == this_stream || mb.clickedButton() == all_streams) {
  502. enableDynBitrate = false;
  503. if (mb.clickedButton() == all_streams) {
  504. config_set_bool(config, "Output", "DynamicBitrate", false);
  505. }
  506. return true;
  507. }
  508. MultitrackVideoOutput::ReleaseOnMainThread(take_current());
  509. MultitrackVideoOutput::ReleaseOnMainThread(take_current_stream_dump());
  510. return false;
  511. }
  512. static bool create_video_encoders(const GoLiveApi::Config &go_live_config,
  513. std::shared_ptr<obs_encoder_group_t> &video_encoder_group, obs_output_t *output,
  514. obs_output_t *recording_output)
  515. {
  516. DStr video_encoder_name_buffer;
  517. if (go_live_config.encoder_configurations.empty()) {
  518. blog(LOG_WARNING, "MultitrackVideoOutput: Missing video encoder configurations");
  519. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.MissingEncoderConfigs"));
  520. }
  521. std::shared_ptr<obs_encoder_group_t> encoder_group(obs_encoder_group_create(), obs_encoder_group_destroy);
  522. if (!encoder_group)
  523. return false;
  524. for (size_t i = 0; i < go_live_config.encoder_configurations.size(); i++) {
  525. auto encoder =
  526. create_video_encoder(video_encoder_name_buffer, i, go_live_config.encoder_configurations[i]);
  527. if (!encoder)
  528. return false;
  529. if (!obs_encoder_set_group(encoder, encoder_group.get()))
  530. return false;
  531. obs_output_set_video_encoder2(output, encoder, i);
  532. if (recording_output)
  533. obs_output_set_video_encoder2(recording_output, encoder, i);
  534. }
  535. video_encoder_group = encoder_group;
  536. return true;
  537. }
  538. static void create_audio_encoders(const GoLiveApi::Config &go_live_config,
  539. std::vector<OBSEncoderAutoRelease> &audio_encoders, obs_output_t *output,
  540. obs_output_t *recording_output, const char *audio_encoder_id, size_t main_audio_mixer,
  541. std::optional<size_t> vod_track_mixer, std::vector<speaker_layout> &speaker_layouts,
  542. speaker_layout &current_layout)
  543. {
  544. speaker_layout speakers = SPEAKERS_UNKNOWN;
  545. obs_audio_info oai = {};
  546. if (obs_get_audio_info(&oai))
  547. speakers = oai.speakers;
  548. current_layout = speakers;
  549. auto sanitize_audio_channels = [&](obs_encoder_t *encoder, uint32_t channels) {
  550. speaker_layout target_speakers = SPEAKERS_UNKNOWN;
  551. for (size_t i = 0; i <= (size_t)SPEAKERS_7POINT1; i++) {
  552. if (get_audio_channels((speaker_layout)i) != channels)
  553. continue;
  554. target_speakers = (speaker_layout)i;
  555. break;
  556. }
  557. if (target_speakers == SPEAKERS_UNKNOWN) {
  558. blog(LOG_WARNING,
  559. "MultitrackVideoOutput: Could not find "
  560. "speaker layout for %" PRIu32 "channels "
  561. "while configuring encoder '%s'",
  562. channels, obs_encoder_get_name(encoder));
  563. return;
  564. }
  565. if (speakers != SPEAKERS_UNKNOWN &&
  566. (channels > get_audio_channels(speakers) || speakers == target_speakers))
  567. return;
  568. auto it = std::find(std::begin(speaker_layouts), std::end(speaker_layouts), target_speakers);
  569. if (it == std::end(speaker_layouts))
  570. speaker_layouts.push_back(target_speakers);
  571. };
  572. using encoder_configs_type = decltype(go_live_config.audio_configurations.live);
  573. DStr encoder_name_buffer;
  574. size_t output_encoder_index = 0;
  575. auto create_encoders = [&](const char *name_prefix, const encoder_configs_type &configs, size_t mixer_idx) {
  576. if (configs.empty()) {
  577. blog(LOG_WARNING, "MultitrackVideoOutput: Missing audio encoder configurations (for '%s')",
  578. name_prefix);
  579. throw MultitrackVideoError::warning(QTStr("FailedToStartStream.MissingEncoderConfigs"));
  580. }
  581. for (size_t i = 0; i < configs.size(); i++) {
  582. dstr_printf(encoder_name_buffer, "%s %zu", name_prefix, i);
  583. OBSDataAutoRelease settings = obs_data_create_from_json(configs[i].settings.dump().c_str());
  584. OBSEncoderAutoRelease audio_encoder =
  585. create_audio_encoder(encoder_name_buffer->array, audio_encoder_id, settings, mixer_idx);
  586. sanitize_audio_channels(audio_encoder, configs[i].channels);
  587. obs_output_set_audio_encoder(output, audio_encoder, output_encoder_index);
  588. if (recording_output)
  589. obs_output_set_audio_encoder(recording_output, audio_encoder, output_encoder_index);
  590. output_encoder_index += 1;
  591. audio_encoders.emplace_back(std::move(audio_encoder));
  592. }
  593. };
  594. create_encoders("multitrack video live audio", go_live_config.audio_configurations.live, main_audio_mixer);
  595. if (!vod_track_mixer.has_value())
  596. return;
  597. // we already check for empty inside of `create_encoders`
  598. encoder_configs_type empty = {};
  599. create_encoders("multitrack video vod audio", go_live_config.audio_configurations.vod.value_or(empty),
  600. *vod_track_mixer);
  601. return;
  602. }
  603. static const char *speaker_layout_to_string(speaker_layout layout)
  604. {
  605. switch (layout) {
  606. case SPEAKERS_MONO:
  607. return "Mono";
  608. case SPEAKERS_2POINT1:
  609. return "2.1";
  610. case SPEAKERS_4POINT0:
  611. return "4.0";
  612. case SPEAKERS_4POINT1:
  613. return "4.1";
  614. case SPEAKERS_5POINT1:
  615. return "5.1";
  616. case SPEAKERS_7POINT1:
  617. return "7.1";
  618. case SPEAKERS_UNKNOWN:
  619. case SPEAKERS_STEREO:
  620. return "Stereo";
  621. }
  622. return "Stereo";
  623. }
  624. static void handle_speaker_layout_issues(QWidget *parent, const QString &multitrack_video_name,
  625. const std::vector<speaker_layout> &requested_layouts, speaker_layout layout)
  626. {
  627. if (requested_layouts.empty())
  628. return;
  629. QString message;
  630. if (requested_layouts.size() == 1) {
  631. message = QTStr("MultitrackVideo.IncompatibleSettings.AudioChannelsSingle")
  632. .arg(QTStr(speaker_layout_to_string(requested_layouts.front())));
  633. } else {
  634. message =
  635. QTStr("MultitrackVideo.IncompatibleSettings.AudioChannelsMultiple").arg(multitrack_video_name);
  636. }
  637. QMetaObject::invokeMethod(
  638. parent,
  639. [&] {
  640. QMessageBox mb(parent);
  641. mb.setIcon(QMessageBox::Critical);
  642. mb.setWindowTitle(QTStr("MultitrackVideo.IncompatibleSettings.Title"));
  643. mb.setText(QTStr("MultitrackVideo.IncompatibleSettings.AudioChannels")
  644. .arg(multitrack_video_name)
  645. .arg(QTStr(speaker_layout_to_string(layout)))
  646. .arg(message));
  647. mb.setStandardButtons(QMessageBox::StandardButton::Cancel);
  648. mb.exec();
  649. },
  650. BlockingConnectionTypeFor(parent));
  651. blog(LOG_INFO, "MultitrackVideoOutput: Attempted to start stream with incompatible "
  652. "audio channel setting. Action taken: cancel");
  653. throw MultitrackVideoError::cancel();
  654. }
  655. static OBSOutputs SetupOBSOutput(QWidget *parent, const QString &multitrack_video_name,
  656. obs_data_t *dump_stream_to_file_config, const GoLiveApi::Config &go_live_config,
  657. std::vector<OBSEncoderAutoRelease> &audio_encoders,
  658. std::shared_ptr<obs_encoder_group_t> &video_encoder_group,
  659. const char *audio_encoder_id, size_t main_audio_mixer,
  660. std::optional<size_t> vod_track_mixer)
  661. {
  662. auto output = create_output();
  663. OBSOutputAutoRelease recording_output;
  664. if (dump_stream_to_file_config)
  665. recording_output = create_recording_output(dump_stream_to_file_config);
  666. if (!create_video_encoders(go_live_config, video_encoder_group, output, recording_output))
  667. return {nullptr, nullptr};
  668. std::vector<speaker_layout> requested_speaker_layouts;
  669. speaker_layout current_layout = SPEAKERS_UNKNOWN;
  670. create_audio_encoders(go_live_config, audio_encoders, output, recording_output, audio_encoder_id,
  671. main_audio_mixer, vod_track_mixer, requested_speaker_layouts, current_layout);
  672. handle_speaker_layout_issues(parent, multitrack_video_name, requested_speaker_layouts, current_layout);
  673. return {std::move(output), std::move(recording_output)};
  674. }
  675. void SetupSignalHandlers(bool recording, MultitrackVideoOutput *self, obs_output_t *output, OBSSignal &start,
  676. OBSSignal &stop)
  677. {
  678. auto handler = obs_output_get_signal_handler(output);
  679. start.Connect(handler, "start", !recording ? StreamStartHandler : RecordingStartHandler, self);
  680. stop.Connect(handler, "stop", !recording ? StreamStopHandler : RecordingStopHandler, self);
  681. }
  682. std::optional<MultitrackVideoOutput::OBSOutputObjects> MultitrackVideoOutput::take_current()
  683. {
  684. const std::lock_guard<std::mutex> current_lock{current_mutex};
  685. auto val = std::move(current);
  686. current.reset();
  687. return val;
  688. }
  689. std::optional<MultitrackVideoOutput::OBSOutputObjects> MultitrackVideoOutput::take_current_stream_dump()
  690. {
  691. const std::lock_guard<std::mutex> current_stream_dump_lock{current_stream_dump_mutex};
  692. auto val = std::move(current_stream_dump);
  693. current_stream_dump.reset();
  694. return val;
  695. }
  696. void MultitrackVideoOutput::ReleaseOnMainThread(std::optional<OBSOutputObjects> objects)
  697. {
  698. if (!objects.has_value())
  699. return;
  700. QMetaObject::invokeMethod(
  701. QApplication::instance()->thread(), [objects = std::move(objects)] {}, Qt::QueuedConnection);
  702. }
  703. void StreamStartHandler(void *arg, calldata_t *)
  704. {
  705. auto self = static_cast<MultitrackVideoOutput *>(arg);
  706. self->restart_on_error = true;
  707. }
  708. void StreamStopHandler(void *arg, calldata_t *data)
  709. {
  710. auto self = static_cast<MultitrackVideoOutput *>(arg);
  711. OBSOutputAutoRelease stream_dump_output;
  712. {
  713. const std::lock_guard<std::mutex> current_stream_dump_lock{self->current_stream_dump_mutex};
  714. if (self->current_stream_dump && self->current_stream_dump->output_)
  715. stream_dump_output = obs_output_get_ref(self->current_stream_dump->output_);
  716. }
  717. if (stream_dump_output)
  718. obs_output_stop(stream_dump_output);
  719. /* Unregister the BPM (Broadcast Performance Metrics) callback and destroy the allocated metrics data. */
  720. obs_output_remove_packet_callback(static_cast<obs_output_t *>(calldata_ptr(data, "output")), bpm_inject, NULL);
  721. bpm_destroy(static_cast<obs_output_t *>(calldata_ptr(data, "output")));
  722. MultitrackVideoOutput::ReleaseOnMainThread(self->take_current());
  723. }
  724. void RecordingStartHandler(void * /* arg */, calldata_t * /* data */)
  725. {
  726. blog(LOG_INFO, "MultitrackVideoOutput: recording started");
  727. }
  728. void RecordingStopHandler(void *arg, calldata_t *)
  729. {
  730. auto self = static_cast<MultitrackVideoOutput *>(arg);
  731. blog(LOG_INFO, "MultitrackVideoOutput: recording stopped");
  732. MultitrackVideoOutput::ReleaseOnMainThread(self->take_current_stream_dump());
  733. }