1
0

obs-ffmpeg-mux.c 26 KB

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