obs-ffmpeg-mux.c 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  1. /******************************************************************************
  2. Copyright (C) 2015 by Hugh Bailey <[email protected]>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. ******************************************************************************/
  14. #include "ffmpeg-mux/ffmpeg-mux.h"
  15. #include "obs-ffmpeg-mux.h"
  16. #ifdef _WIN32
  17. #include "util/windows/win-version.h"
  18. #endif
  19. #include <libavformat/avformat.h>
  20. #define do_log(level, format, ...) \
  21. blog(level, "[ffmpeg muxer: '%s'] " format, \
  22. obs_output_get_name(stream->output), ##__VA_ARGS__)
  23. #define warn(format, ...) do_log(LOG_WARNING, format, ##__VA_ARGS__)
  24. #define info(format, ...) do_log(LOG_INFO, format, ##__VA_ARGS__)
  25. static const char *ffmpeg_mux_getname(void *type)
  26. {
  27. UNUSED_PARAMETER(type);
  28. return obs_module_text("FFmpegMuxer");
  29. }
  30. static const char *ffmpeg_mpegts_mux_getname(void *type)
  31. {
  32. UNUSED_PARAMETER(type);
  33. return obs_module_text("FFmpegMpegtsMuxer");
  34. }
  35. static inline void replay_buffer_clear(struct ffmpeg_muxer *stream)
  36. {
  37. while (stream->packets.size > 0) {
  38. struct encoder_packet pkt;
  39. circlebuf_pop_front(&stream->packets, &pkt, sizeof(pkt));
  40. obs_encoder_packet_release(&pkt);
  41. }
  42. circlebuf_free(&stream->packets);
  43. stream->cur_size = 0;
  44. stream->cur_time = 0;
  45. stream->max_size = 0;
  46. stream->max_time = 0;
  47. stream->save_ts = 0;
  48. stream->keyframes = 0;
  49. }
  50. static void ffmpeg_mux_destroy(void *data)
  51. {
  52. struct ffmpeg_muxer *stream = data;
  53. replay_buffer_clear(stream);
  54. if (stream->mux_thread_joinable)
  55. pthread_join(stream->mux_thread, NULL);
  56. for (size_t i = 0; i < stream->mux_packets.num; i++)
  57. obs_encoder_packet_release(&stream->mux_packets.array[i]);
  58. da_free(stream->mux_packets);
  59. circlebuf_free(&stream->packets);
  60. os_process_pipe_destroy(stream->pipe);
  61. dstr_free(&stream->path);
  62. dstr_free(&stream->printable_path);
  63. dstr_free(&stream->stream_key);
  64. dstr_free(&stream->muxer_settings);
  65. bfree(stream);
  66. }
  67. static void *ffmpeg_mux_create(obs_data_t *settings, obs_output_t *output)
  68. {
  69. struct ffmpeg_muxer *stream = bzalloc(sizeof(*stream));
  70. stream->output = output;
  71. if (obs_output_get_flags(output) & OBS_OUTPUT_SERVICE)
  72. stream->is_network = true;
  73. UNUSED_PARAMETER(settings);
  74. return stream;
  75. }
  76. #ifdef _WIN32
  77. #define FFMPEG_MUX "obs-ffmpeg-mux.exe"
  78. #else
  79. #define FFMPEG_MUX "obs-ffmpeg-mux"
  80. #endif
  81. static inline bool capturing(struct ffmpeg_muxer *stream)
  82. {
  83. return os_atomic_load_bool(&stream->capturing);
  84. }
  85. bool stopping(struct ffmpeg_muxer *stream)
  86. {
  87. return os_atomic_load_bool(&stream->stopping);
  88. }
  89. bool active(struct ffmpeg_muxer *stream)
  90. {
  91. return os_atomic_load_bool(&stream->active);
  92. }
  93. /* TODO: allow codecs other than h264 whenever we start using them */
  94. static void add_video_encoder_params(struct ffmpeg_muxer *stream,
  95. struct dstr *cmd, obs_encoder_t *vencoder)
  96. {
  97. obs_data_t *settings = obs_encoder_get_settings(vencoder);
  98. int bitrate = (int)obs_data_get_int(settings, "bitrate");
  99. video_t *video = obs_get_video();
  100. const struct video_output_info *info = video_output_get_info(video);
  101. obs_data_release(settings);
  102. enum AVColorPrimaries pri = AVCOL_PRI_UNSPECIFIED;
  103. enum AVColorTransferCharacteristic trc = AVCOL_TRC_UNSPECIFIED;
  104. enum AVColorSpace spc = AVCOL_SPC_UNSPECIFIED;
  105. switch (info->colorspace) {
  106. case VIDEO_CS_601:
  107. pri = AVCOL_PRI_SMPTE170M;
  108. trc = AVCOL_TRC_SMPTE170M;
  109. spc = AVCOL_SPC_SMPTE170M;
  110. break;
  111. case VIDEO_CS_DEFAULT:
  112. case VIDEO_CS_709:
  113. pri = AVCOL_PRI_BT709;
  114. trc = AVCOL_TRC_BT709;
  115. spc = AVCOL_SPC_BT709;
  116. break;
  117. case VIDEO_CS_SRGB:
  118. pri = AVCOL_PRI_BT709;
  119. trc = AVCOL_TRC_IEC61966_2_1;
  120. spc = AVCOL_SPC_BT709;
  121. break;
  122. case VIDEO_CS_2100_PQ:
  123. pri = AVCOL_PRI_BT2020;
  124. trc = AVCOL_TRC_SMPTE2084;
  125. spc = AVCOL_SPC_BT2020_NCL;
  126. break;
  127. case VIDEO_CS_2100_HLG:
  128. pri = AVCOL_PRI_BT2020;
  129. trc = AVCOL_TRC_ARIB_STD_B67;
  130. spc = AVCOL_SPC_BT2020_NCL;
  131. }
  132. const enum AVColorRange range = (info->range == VIDEO_RANGE_FULL)
  133. ? AVCOL_RANGE_JPEG
  134. : AVCOL_RANGE_MPEG;
  135. dstr_catf(cmd, "%s %d %d %d %d %d %d %d %d %d ",
  136. obs_encoder_get_codec(vencoder), bitrate,
  137. obs_output_get_width(stream->output),
  138. obs_output_get_height(stream->output), (int)pri, (int)trc,
  139. (int)spc, (int)range, (int)info->fps_num, (int)info->fps_den);
  140. }
  141. static void add_audio_encoder_params(struct dstr *cmd, obs_encoder_t *aencoder)
  142. {
  143. obs_data_t *settings = obs_encoder_get_settings(aencoder);
  144. int bitrate = (int)obs_data_get_int(settings, "bitrate");
  145. audio_t *audio = obs_get_audio();
  146. struct dstr name = {0};
  147. obs_data_release(settings);
  148. dstr_copy(&name, obs_encoder_get_name(aencoder));
  149. dstr_replace(&name, "\"", "\"\"");
  150. dstr_catf(cmd, "\"%s\" %d %d %d %d ", name.array, bitrate,
  151. (int)obs_encoder_get_sample_rate(aencoder),
  152. (int)obs_encoder_get_frame_size(aencoder),
  153. (int)audio_output_get_channels(audio));
  154. dstr_free(&name);
  155. }
  156. static void log_muxer_params(struct ffmpeg_muxer *stream, const char *settings)
  157. {
  158. int ret;
  159. AVDictionary *dict = NULL;
  160. if ((ret = av_dict_parse_string(&dict, settings, "=", " ", 0))) {
  161. warn("Failed to parse muxer settings: %s\n%s", av_err2str(ret),
  162. settings);
  163. av_dict_free(&dict);
  164. return;
  165. }
  166. if (av_dict_count(dict) > 0) {
  167. struct dstr str = {0};
  168. AVDictionaryEntry *entry = NULL;
  169. while ((entry = av_dict_get(dict, "", entry,
  170. AV_DICT_IGNORE_SUFFIX)))
  171. dstr_catf(&str, "\n\t%s=%s", entry->key, entry->value);
  172. info("Using muxer settings:%s", str.array);
  173. dstr_free(&str);
  174. }
  175. av_dict_free(&dict);
  176. }
  177. static void add_stream_key(struct dstr *cmd, struct ffmpeg_muxer *stream)
  178. {
  179. dstr_catf(cmd, "\"%s\" ",
  180. dstr_is_empty(&stream->stream_key)
  181. ? ""
  182. : stream->stream_key.array);
  183. }
  184. static void add_muxer_params(struct dstr *cmd, struct ffmpeg_muxer *stream)
  185. {
  186. struct dstr mux = {0};
  187. if (dstr_is_empty(&stream->muxer_settings)) {
  188. obs_data_t *settings = obs_output_get_settings(stream->output);
  189. dstr_copy(&mux,
  190. obs_data_get_string(settings, "muxer_settings"));
  191. obs_data_release(settings);
  192. } else {
  193. dstr_copy(&mux, stream->muxer_settings.array);
  194. }
  195. log_muxer_params(stream, mux.array);
  196. dstr_replace(&mux, "\"", "\\\"");
  197. dstr_catf(cmd, "\"%s\" ", mux.array ? mux.array : "");
  198. dstr_free(&mux);
  199. }
  200. static void build_command_line(struct ffmpeg_muxer *stream, struct dstr *cmd,
  201. const char *path)
  202. {
  203. obs_encoder_t *vencoder = obs_output_get_video_encoder(stream->output);
  204. obs_encoder_t *aencoders[MAX_AUDIO_MIXES];
  205. int num_tracks = 0;
  206. for (;;) {
  207. obs_encoder_t *aencoder = obs_output_get_audio_encoder(
  208. stream->output, num_tracks);
  209. if (!aencoder)
  210. break;
  211. aencoders[num_tracks] = aencoder;
  212. num_tracks++;
  213. }
  214. dstr_init_move_array(cmd, os_get_executable_path_ptr(FFMPEG_MUX));
  215. dstr_insert_ch(cmd, 0, '\"');
  216. dstr_cat(cmd, "\" \"");
  217. dstr_copy(&stream->path, path);
  218. dstr_replace(&stream->path, "\"", "\"\"");
  219. dstr_cat_dstr(cmd, &stream->path);
  220. dstr_catf(cmd, "\" %d %d ", vencoder ? 1 : 0, num_tracks);
  221. if (vencoder)
  222. add_video_encoder_params(stream, cmd, vencoder);
  223. if (num_tracks) {
  224. dstr_cat(cmd, "aac ");
  225. for (int i = 0; i < num_tracks; i++) {
  226. add_audio_encoder_params(cmd, aencoders[i]);
  227. }
  228. }
  229. add_stream_key(cmd, stream);
  230. add_muxer_params(cmd, stream);
  231. }
  232. void start_pipe(struct ffmpeg_muxer *stream, const char *path)
  233. {
  234. struct dstr cmd;
  235. build_command_line(stream, &cmd, path);
  236. stream->pipe = os_process_pipe_create(cmd.array, "w");
  237. dstr_free(&cmd);
  238. }
  239. static void set_file_not_readable_error(struct ffmpeg_muxer *stream,
  240. obs_data_t *settings, const char *path)
  241. {
  242. struct dstr error_message;
  243. dstr_init_copy(&error_message, obs_module_text("UnableToWritePath"));
  244. #ifdef _WIN32
  245. /* special warning for Windows 10 users about Defender */
  246. struct win_version_info ver;
  247. get_win_ver(&ver);
  248. if (ver.major >= 10) {
  249. dstr_cat(&error_message, "\n\n");
  250. dstr_cat(&error_message,
  251. obs_module_text("WarnWindowsDefender"));
  252. }
  253. #endif
  254. dstr_replace(&error_message, "%1", path);
  255. obs_output_set_last_error(stream->output, error_message.array);
  256. dstr_free(&error_message);
  257. obs_data_release(settings);
  258. }
  259. static bool ffmpeg_mux_start(void *data)
  260. {
  261. struct ffmpeg_muxer *stream = data;
  262. obs_data_t *settings;
  263. const char *path;
  264. if (!obs_output_can_begin_data_capture(stream->output, 0))
  265. return false;
  266. if (!obs_output_initialize_encoders(stream->output, 0))
  267. return false;
  268. settings = obs_output_get_settings(stream->output);
  269. if (stream->is_network) {
  270. obs_service_t *service;
  271. service = obs_output_get_service(stream->output);
  272. if (!service)
  273. return false;
  274. path = obs_service_get_url(service);
  275. } else {
  276. path = obs_data_get_string(settings, "path");
  277. }
  278. if (!stream->is_network) {
  279. /* ensure output path is writable to avoid generic error
  280. * message.
  281. *
  282. * TODO: remove once ffmpeg-mux is refactored to pass
  283. * errors back */
  284. FILE *test_file = os_fopen(path, "wb");
  285. if (!test_file) {
  286. set_file_not_readable_error(stream, settings, path);
  287. return false;
  288. }
  289. fclose(test_file);
  290. os_unlink(path);
  291. }
  292. start_pipe(stream, path);
  293. obs_data_release(settings);
  294. if (!stream->pipe) {
  295. obs_output_set_last_error(
  296. stream->output, obs_module_text("HelperProcessFailed"));
  297. warn("Failed to create process pipe");
  298. return false;
  299. }
  300. /* write headers and start capture */
  301. os_atomic_set_bool(&stream->active, true);
  302. os_atomic_set_bool(&stream->capturing, true);
  303. stream->total_bytes = 0;
  304. obs_output_begin_data_capture(stream->output, 0);
  305. info("Writing file '%s'...", stream->path.array);
  306. return true;
  307. }
  308. int deactivate(struct ffmpeg_muxer *stream, int code)
  309. {
  310. int ret = -1;
  311. if (stream->is_hls) {
  312. if (stream->mux_thread_joinable) {
  313. os_event_signal(stream->stop_event);
  314. os_sem_post(stream->write_sem);
  315. pthread_join(stream->mux_thread, NULL);
  316. stream->mux_thread_joinable = false;
  317. }
  318. }
  319. if (active(stream)) {
  320. ret = os_process_pipe_destroy(stream->pipe);
  321. stream->pipe = NULL;
  322. os_atomic_set_bool(&stream->active, false);
  323. os_atomic_set_bool(&stream->sent_headers, false);
  324. info("Output of file '%s' stopped",
  325. dstr_is_empty(&stream->printable_path)
  326. ? stream->path.array
  327. : stream->printable_path.array);
  328. }
  329. if (code) {
  330. obs_output_signal_stop(stream->output, code);
  331. } else if (stopping(stream)) {
  332. obs_output_end_data_capture(stream->output);
  333. }
  334. if (stream->is_hls) {
  335. pthread_mutex_lock(&stream->write_mutex);
  336. while (stream->packets.size) {
  337. struct encoder_packet packet;
  338. circlebuf_pop_front(&stream->packets, &packet,
  339. sizeof(packet));
  340. obs_encoder_packet_release(&packet);
  341. }
  342. pthread_mutex_unlock(&stream->write_mutex);
  343. }
  344. os_atomic_set_bool(&stream->stopping, false);
  345. return ret;
  346. }
  347. void ffmpeg_mux_stop(void *data, uint64_t ts)
  348. {
  349. struct ffmpeg_muxer *stream = data;
  350. if (capturing(stream) || ts == 0) {
  351. stream->stop_ts = (int64_t)ts / 1000LL;
  352. os_atomic_set_bool(&stream->stopping, true);
  353. os_atomic_set_bool(&stream->capturing, false);
  354. }
  355. }
  356. static void signal_failure(struct ffmpeg_muxer *stream)
  357. {
  358. char error[1024];
  359. int ret;
  360. int code;
  361. size_t len;
  362. len = os_process_pipe_read_err(stream->pipe, (uint8_t *)error,
  363. sizeof(error) - 1);
  364. if (len > 0) {
  365. error[len] = 0;
  366. warn("ffmpeg-mux: %s", error);
  367. obs_output_set_last_error(stream->output, error);
  368. }
  369. ret = deactivate(stream, 0);
  370. switch (ret) {
  371. case FFM_UNSUPPORTED:
  372. code = OBS_OUTPUT_UNSUPPORTED;
  373. break;
  374. default:
  375. if (stream->is_network) {
  376. code = OBS_OUTPUT_DISCONNECTED;
  377. } else {
  378. code = OBS_OUTPUT_ENCODE_ERROR;
  379. }
  380. }
  381. obs_output_signal_stop(stream->output, code);
  382. os_atomic_set_bool(&stream->capturing, false);
  383. }
  384. bool write_packet(struct ffmpeg_muxer *stream, struct encoder_packet *packet)
  385. {
  386. bool is_video = packet->type == OBS_ENCODER_VIDEO;
  387. size_t ret;
  388. struct ffm_packet_info info = {.pts = packet->pts,
  389. .dts = packet->dts,
  390. .size = (uint32_t)packet->size,
  391. .index = (int)packet->track_idx,
  392. .type = is_video ? FFM_PACKET_VIDEO
  393. : FFM_PACKET_AUDIO,
  394. .keyframe = packet->keyframe};
  395. ret = os_process_pipe_write(stream->pipe, (const uint8_t *)&info,
  396. sizeof(info));
  397. if (ret != sizeof(info)) {
  398. warn("os_process_pipe_write for info structure failed");
  399. signal_failure(stream);
  400. return false;
  401. }
  402. ret = os_process_pipe_write(stream->pipe, packet->data, packet->size);
  403. if (ret != packet->size) {
  404. warn("os_process_pipe_write for packet data failed");
  405. signal_failure(stream);
  406. return false;
  407. }
  408. stream->total_bytes += packet->size;
  409. return true;
  410. }
  411. static bool send_audio_headers(struct ffmpeg_muxer *stream,
  412. obs_encoder_t *aencoder, size_t idx)
  413. {
  414. struct encoder_packet packet = {
  415. .type = OBS_ENCODER_AUDIO, .timebase_den = 1, .track_idx = idx};
  416. obs_encoder_get_extra_data(aencoder, &packet.data, &packet.size);
  417. return write_packet(stream, &packet);
  418. }
  419. static bool send_video_headers(struct ffmpeg_muxer *stream)
  420. {
  421. obs_encoder_t *vencoder = obs_output_get_video_encoder(stream->output);
  422. struct encoder_packet packet = {.type = OBS_ENCODER_VIDEO,
  423. .timebase_den = 1};
  424. obs_encoder_get_extra_data(vencoder, &packet.data, &packet.size);
  425. return write_packet(stream, &packet);
  426. }
  427. bool send_headers(struct ffmpeg_muxer *stream)
  428. {
  429. obs_encoder_t *aencoder;
  430. size_t idx = 0;
  431. if (!send_video_headers(stream))
  432. return false;
  433. do {
  434. aencoder = obs_output_get_audio_encoder(stream->output, idx);
  435. if (aencoder) {
  436. if (!send_audio_headers(stream, aencoder, idx)) {
  437. return false;
  438. }
  439. idx++;
  440. }
  441. } while (aencoder);
  442. return true;
  443. }
  444. static void ffmpeg_mux_data(void *data, struct encoder_packet *packet)
  445. {
  446. struct ffmpeg_muxer *stream = data;
  447. if (!active(stream))
  448. return;
  449. /* encoder failure */
  450. if (!packet) {
  451. deactivate(stream, OBS_OUTPUT_ENCODE_ERROR);
  452. return;
  453. }
  454. if (!stream->sent_headers) {
  455. if (!send_headers(stream))
  456. return;
  457. stream->sent_headers = true;
  458. }
  459. if (stopping(stream)) {
  460. if (packet->sys_dts_usec >= stream->stop_ts) {
  461. deactivate(stream, 0);
  462. return;
  463. }
  464. }
  465. write_packet(stream, packet);
  466. }
  467. static obs_properties_t *ffmpeg_mux_properties(void *unused)
  468. {
  469. UNUSED_PARAMETER(unused);
  470. obs_properties_t *props = obs_properties_create();
  471. obs_properties_add_text(props, "path", obs_module_text("FilePath"),
  472. OBS_TEXT_DEFAULT);
  473. return props;
  474. }
  475. uint64_t ffmpeg_mux_total_bytes(void *data)
  476. {
  477. struct ffmpeg_muxer *stream = data;
  478. return stream->total_bytes;
  479. }
  480. struct obs_output_info ffmpeg_muxer = {
  481. .id = "ffmpeg_muxer",
  482. .flags = OBS_OUTPUT_AV | OBS_OUTPUT_ENCODED | OBS_OUTPUT_MULTI_TRACK |
  483. OBS_OUTPUT_CAN_PAUSE,
  484. .get_name = ffmpeg_mux_getname,
  485. .create = ffmpeg_mux_create,
  486. .destroy = ffmpeg_mux_destroy,
  487. .start = ffmpeg_mux_start,
  488. .stop = ffmpeg_mux_stop,
  489. .encoded_packet = ffmpeg_mux_data,
  490. .get_total_bytes = ffmpeg_mux_total_bytes,
  491. .get_properties = ffmpeg_mux_properties,
  492. };
  493. static int connect_time(struct ffmpeg_muxer *stream)
  494. {
  495. UNUSED_PARAMETER(stream);
  496. /* TODO */
  497. return 0;
  498. }
  499. static int ffmpeg_mpegts_mux_connect_time(void *data)
  500. {
  501. struct ffmpeg_muxer *stream = data;
  502. /* TODO */
  503. return connect_time(stream);
  504. }
  505. struct obs_output_info ffmpeg_mpegts_muxer = {
  506. .id = "ffmpeg_mpegts_muxer",
  507. .flags = OBS_OUTPUT_AV | OBS_OUTPUT_ENCODED | OBS_OUTPUT_MULTI_TRACK |
  508. OBS_OUTPUT_SERVICE,
  509. .encoded_video_codecs = "h264;av1",
  510. .encoded_audio_codecs = "aac",
  511. .get_name = ffmpeg_mpegts_mux_getname,
  512. .create = ffmpeg_mux_create,
  513. .destroy = ffmpeg_mux_destroy,
  514. .start = ffmpeg_mux_start,
  515. .stop = ffmpeg_mux_stop,
  516. .encoded_packet = ffmpeg_mux_data,
  517. .get_total_bytes = ffmpeg_mux_total_bytes,
  518. .get_properties = ffmpeg_mux_properties,
  519. .get_connect_time_ms = ffmpeg_mpegts_mux_connect_time,
  520. };
  521. /* ------------------------------------------------------------------------ */
  522. static const char *replay_buffer_getname(void *type)
  523. {
  524. UNUSED_PARAMETER(type);
  525. return obs_module_text("ReplayBuffer");
  526. }
  527. static void replay_buffer_hotkey(void *data, obs_hotkey_id id,
  528. obs_hotkey_t *hotkey, bool pressed)
  529. {
  530. UNUSED_PARAMETER(id);
  531. UNUSED_PARAMETER(hotkey);
  532. UNUSED_PARAMETER(pressed);
  533. if (!pressed)
  534. return;
  535. struct ffmpeg_muxer *stream = data;
  536. if (os_atomic_load_bool(&stream->active)) {
  537. obs_encoder_t *vencoder =
  538. obs_output_get_video_encoder(stream->output);
  539. if (obs_encoder_paused(vencoder)) {
  540. info("Could not save buffer because encoders paused");
  541. return;
  542. }
  543. stream->save_ts = os_gettime_ns() / 1000LL;
  544. }
  545. }
  546. static void save_replay_proc(void *data, calldata_t *cd)
  547. {
  548. replay_buffer_hotkey(data, 0, NULL, true);
  549. UNUSED_PARAMETER(cd);
  550. }
  551. static void get_last_replay(void *data, calldata_t *cd)
  552. {
  553. struct ffmpeg_muxer *stream = data;
  554. if (!os_atomic_load_bool(&stream->muxing))
  555. calldata_set_string(cd, "path", stream->path.array);
  556. }
  557. static void *replay_buffer_create(obs_data_t *settings, obs_output_t *output)
  558. {
  559. UNUSED_PARAMETER(settings);
  560. struct ffmpeg_muxer *stream = bzalloc(sizeof(*stream));
  561. stream->output = output;
  562. stream->hotkey =
  563. obs_hotkey_register_output(output, "ReplayBuffer.Save",
  564. obs_module_text("ReplayBuffer.Save"),
  565. replay_buffer_hotkey, stream);
  566. proc_handler_t *ph = obs_output_get_proc_handler(output);
  567. proc_handler_add(ph, "void save()", save_replay_proc, stream);
  568. proc_handler_add(ph, "void get_last_replay(out string path)",
  569. get_last_replay, stream);
  570. signal_handler_t *sh = obs_output_get_signal_handler(output);
  571. signal_handler_add(sh, "void saved()");
  572. return stream;
  573. }
  574. static void replay_buffer_destroy(void *data)
  575. {
  576. struct ffmpeg_muxer *stream = data;
  577. if (stream->hotkey)
  578. obs_hotkey_unregister(stream->hotkey);
  579. ffmpeg_mux_destroy(data);
  580. }
  581. static bool replay_buffer_start(void *data)
  582. {
  583. struct ffmpeg_muxer *stream = data;
  584. if (!obs_output_can_begin_data_capture(stream->output, 0))
  585. return false;
  586. if (!obs_output_initialize_encoders(stream->output, 0))
  587. return false;
  588. obs_data_t *s = obs_output_get_settings(stream->output);
  589. stream->max_time = obs_data_get_int(s, "max_time_sec") * 1000000LL;
  590. stream->max_size = obs_data_get_int(s, "max_size_mb") * (1024 * 1024);
  591. obs_data_release(s);
  592. os_atomic_set_bool(&stream->active, true);
  593. os_atomic_set_bool(&stream->capturing, true);
  594. stream->total_bytes = 0;
  595. obs_output_begin_data_capture(stream->output, 0);
  596. return true;
  597. }
  598. static bool purge_front(struct ffmpeg_muxer *stream)
  599. {
  600. struct encoder_packet pkt;
  601. bool keyframe;
  602. if (!stream->packets.size)
  603. return false;
  604. circlebuf_pop_front(&stream->packets, &pkt, sizeof(pkt));
  605. keyframe = pkt.type == OBS_ENCODER_VIDEO && pkt.keyframe;
  606. if (keyframe)
  607. stream->keyframes--;
  608. if (!stream->packets.size) {
  609. stream->cur_size = 0;
  610. stream->cur_time = 0;
  611. } else {
  612. struct encoder_packet first;
  613. circlebuf_peek_front(&stream->packets, &first, sizeof(first));
  614. stream->cur_time = first.dts_usec;
  615. stream->cur_size -= (int64_t)pkt.size;
  616. }
  617. obs_encoder_packet_release(&pkt);
  618. return keyframe;
  619. }
  620. static inline void purge(struct ffmpeg_muxer *stream)
  621. {
  622. if (purge_front(stream)) {
  623. struct encoder_packet pkt;
  624. for (;;) {
  625. if (!stream->packets.size)
  626. return;
  627. circlebuf_peek_front(&stream->packets, &pkt,
  628. sizeof(pkt));
  629. if (pkt.type == OBS_ENCODER_VIDEO && pkt.keyframe)
  630. return;
  631. purge_front(stream);
  632. }
  633. }
  634. }
  635. static inline void replay_buffer_purge(struct ffmpeg_muxer *stream,
  636. struct encoder_packet *pkt)
  637. {
  638. if (stream->max_size) {
  639. if (!stream->packets.size || stream->keyframes <= 2)
  640. return;
  641. while ((stream->cur_size + (int64_t)pkt->size) >
  642. stream->max_size)
  643. purge(stream);
  644. }
  645. if (!stream->packets.size || stream->keyframes <= 2)
  646. return;
  647. while ((pkt->dts_usec - stream->cur_time) > stream->max_time)
  648. purge(stream);
  649. }
  650. static void insert_packet(struct darray *array, struct encoder_packet *packet,
  651. int64_t video_offset, int64_t *audio_offsets,
  652. int64_t video_pts_offset, int64_t *audio_dts_offsets)
  653. {
  654. struct encoder_packet pkt;
  655. DARRAY(struct encoder_packet) packets;
  656. packets.da = *array;
  657. size_t idx;
  658. obs_encoder_packet_ref(&pkt, packet);
  659. if (pkt.type == OBS_ENCODER_VIDEO) {
  660. pkt.dts_usec -= video_offset;
  661. pkt.dts -= video_pts_offset;
  662. pkt.pts -= video_pts_offset;
  663. } else {
  664. pkt.dts_usec -= audio_offsets[pkt.track_idx];
  665. pkt.dts -= audio_dts_offsets[pkt.track_idx];
  666. pkt.pts -= audio_dts_offsets[pkt.track_idx];
  667. }
  668. for (idx = packets.num; idx > 0; idx--) {
  669. struct encoder_packet *p = packets.array + (idx - 1);
  670. if (p->dts_usec < pkt.dts_usec)
  671. break;
  672. }
  673. da_insert(packets, idx, &pkt);
  674. *array = packets.da;
  675. }
  676. static void *replay_buffer_mux_thread(void *data)
  677. {
  678. struct ffmpeg_muxer *stream = data;
  679. bool error = false;
  680. start_pipe(stream, stream->path.array);
  681. if (!stream->pipe) {
  682. warn("Failed to create process pipe");
  683. error = true;
  684. goto error;
  685. }
  686. if (!send_headers(stream)) {
  687. warn("Could not write headers for file '%s'",
  688. stream->path.array);
  689. error = true;
  690. goto error;
  691. }
  692. for (size_t i = 0; i < stream->mux_packets.num; i++) {
  693. struct encoder_packet *pkt = &stream->mux_packets.array[i];
  694. write_packet(stream, pkt);
  695. obs_encoder_packet_release(pkt);
  696. }
  697. info("Wrote replay buffer to '%s'", stream->path.array);
  698. error:
  699. os_process_pipe_destroy(stream->pipe);
  700. stream->pipe = NULL;
  701. if (error) {
  702. for (size_t i = 0; i < stream->mux_packets.num; i++)
  703. obs_encoder_packet_release(
  704. &stream->mux_packets.array[i]);
  705. }
  706. da_free(stream->mux_packets);
  707. os_atomic_set_bool(&stream->muxing, false);
  708. if (!error) {
  709. calldata_t cd = {0};
  710. signal_handler_t *sh =
  711. obs_output_get_signal_handler(stream->output);
  712. signal_handler_signal(sh, "saved", &cd);
  713. }
  714. return NULL;
  715. }
  716. static void replay_buffer_save(struct ffmpeg_muxer *stream)
  717. {
  718. const size_t size = sizeof(struct encoder_packet);
  719. size_t num_packets = stream->packets.size / size;
  720. da_reserve(stream->mux_packets, num_packets);
  721. /* ---------------------------- */
  722. /* reorder packets */
  723. bool found_video = false;
  724. bool found_audio[MAX_AUDIO_MIXES] = {0};
  725. int64_t video_offset = 0;
  726. int64_t video_pts_offset = 0;
  727. int64_t audio_offsets[MAX_AUDIO_MIXES] = {0};
  728. int64_t audio_dts_offsets[MAX_AUDIO_MIXES] = {0};
  729. for (size_t i = 0; i < num_packets; i++) {
  730. struct encoder_packet *pkt;
  731. pkt = circlebuf_data(&stream->packets, i * size);
  732. if (pkt->type == OBS_ENCODER_VIDEO) {
  733. if (!found_video) {
  734. video_pts_offset = pkt->pts;
  735. video_offset = video_pts_offset * 1000000 /
  736. pkt->timebase_den;
  737. found_video = true;
  738. }
  739. } else {
  740. if (!found_audio[pkt->track_idx]) {
  741. found_audio[pkt->track_idx] = true;
  742. audio_offsets[pkt->track_idx] = pkt->dts_usec;
  743. audio_dts_offsets[pkt->track_idx] = pkt->dts;
  744. }
  745. }
  746. insert_packet(&stream->mux_packets.da, pkt, video_offset,
  747. audio_offsets, video_pts_offset,
  748. audio_dts_offsets);
  749. }
  750. /* ---------------------------- */
  751. /* generate filename */
  752. obs_data_t *settings = obs_output_get_settings(stream->output);
  753. const char *dir = obs_data_get_string(settings, "directory");
  754. const char *fmt = obs_data_get_string(settings, "format");
  755. const char *ext = obs_data_get_string(settings, "extension");
  756. bool space = obs_data_get_bool(settings, "allow_spaces");
  757. char *filename = os_generate_formatted_filename(ext, space, fmt);
  758. dstr_copy(&stream->path, dir);
  759. dstr_replace(&stream->path, "\\", "/");
  760. if (dstr_end(&stream->path) != '/')
  761. dstr_cat_ch(&stream->path, '/');
  762. dstr_cat(&stream->path, filename);
  763. char *slash = strrchr(stream->path.array, '/');
  764. if (slash) {
  765. *slash = 0;
  766. os_mkdirs(stream->path.array);
  767. *slash = '/';
  768. }
  769. bfree(filename);
  770. obs_data_release(settings);
  771. /* ---------------------------- */
  772. os_atomic_set_bool(&stream->muxing, true);
  773. stream->mux_thread_joinable = pthread_create(&stream->mux_thread, NULL,
  774. replay_buffer_mux_thread,
  775. stream) == 0;
  776. if (!stream->mux_thread_joinable) {
  777. warn("Failed to create muxer thread");
  778. os_atomic_set_bool(&stream->muxing, false);
  779. }
  780. }
  781. static void deactivate_replay_buffer(struct ffmpeg_muxer *stream, int code)
  782. {
  783. if (code) {
  784. obs_output_signal_stop(stream->output, code);
  785. } else if (stopping(stream)) {
  786. obs_output_end_data_capture(stream->output);
  787. }
  788. os_atomic_set_bool(&stream->active, false);
  789. os_atomic_set_bool(&stream->sent_headers, false);
  790. os_atomic_set_bool(&stream->stopping, false);
  791. replay_buffer_clear(stream);
  792. }
  793. static void replay_buffer_data(void *data, struct encoder_packet *packet)
  794. {
  795. struct ffmpeg_muxer *stream = data;
  796. struct encoder_packet pkt;
  797. if (!active(stream))
  798. return;
  799. /* encoder failure */
  800. if (!packet) {
  801. deactivate_replay_buffer(stream, OBS_OUTPUT_ENCODE_ERROR);
  802. return;
  803. }
  804. if (stopping(stream)) {
  805. if (packet->sys_dts_usec >= stream->stop_ts) {
  806. deactivate_replay_buffer(stream, 0);
  807. return;
  808. }
  809. }
  810. obs_encoder_packet_ref(&pkt, packet);
  811. replay_buffer_purge(stream, &pkt);
  812. if (!stream->packets.size)
  813. stream->cur_time = pkt.dts_usec;
  814. stream->cur_size += pkt.size;
  815. circlebuf_push_back(&stream->packets, packet, sizeof(*packet));
  816. if (packet->type == OBS_ENCODER_VIDEO && packet->keyframe)
  817. stream->keyframes++;
  818. if (stream->save_ts && packet->sys_dts_usec >= stream->save_ts) {
  819. if (os_atomic_load_bool(&stream->muxing))
  820. return;
  821. if (stream->mux_thread_joinable) {
  822. pthread_join(stream->mux_thread, NULL);
  823. stream->mux_thread_joinable = false;
  824. }
  825. stream->save_ts = 0;
  826. replay_buffer_save(stream);
  827. }
  828. }
  829. static void replay_buffer_defaults(obs_data_t *s)
  830. {
  831. obs_data_set_default_int(s, "max_time_sec", 15);
  832. obs_data_set_default_int(s, "max_size_mb", 500);
  833. obs_data_set_default_string(s, "format", "%CCYY-%MM-%DD %hh-%mm-%ss");
  834. obs_data_set_default_string(s, "extension", "mp4");
  835. obs_data_set_default_bool(s, "allow_spaces", true);
  836. }
  837. struct obs_output_info replay_buffer = {
  838. .id = "replay_buffer",
  839. .flags = OBS_OUTPUT_AV | OBS_OUTPUT_ENCODED | OBS_OUTPUT_MULTI_TRACK |
  840. OBS_OUTPUT_CAN_PAUSE,
  841. .get_name = replay_buffer_getname,
  842. .create = replay_buffer_create,
  843. .destroy = replay_buffer_destroy,
  844. .start = replay_buffer_start,
  845. .stop = ffmpeg_mux_stop,
  846. .encoded_packet = replay_buffer_data,
  847. .get_total_bytes = ffmpeg_mux_total_bytes,
  848. .get_defaults = replay_buffer_defaults,
  849. };