obs-ffmpeg-mux.c 26 KB

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