ftl-stream.c 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174
  1. /******************************************************************************
  2. Copyright (C) 2017 by Quinn Damerell <[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 <obs-module.h>
  15. #include <obs-avc.h>
  16. #include <util/platform.h>
  17. #include <util/circlebuf.h>
  18. #include <util/dstr.h>
  19. #include <util/threading.h>
  20. #include <inttypes.h>
  21. #include "ftl.h"
  22. #include "flv-mux.h"
  23. #include "net-if.h"
  24. #ifdef _WIN32
  25. #include <Iphlpapi.h>
  26. #else
  27. #include <sys/ioctl.h>
  28. #define INFINITE 0xFFFFFFFF
  29. #endif
  30. #define do_log(level, format, ...) \
  31. blog(level, "[ftl stream: '%s'] " format, \
  32. obs_output_get_name(stream->output), ##__VA_ARGS__)
  33. #define warn(format, ...) do_log(LOG_WARNING, format, ##__VA_ARGS__)
  34. #define info(format, ...) do_log(LOG_INFO, format, ##__VA_ARGS__)
  35. #define debug(format, ...) do_log(LOG_DEBUG, format, ##__VA_ARGS__)
  36. #define OPT_DROP_THRESHOLD "drop_threshold_ms"
  37. #define OPT_MAX_SHUTDOWN_TIME_SEC "max_shutdown_time_sec"
  38. #define OPT_BIND_IP "bind_ip"
  39. #define FTL_URL_PROTOCOL "ftl://"
  40. typedef struct _nalu_t {
  41. int len;
  42. int dts_usec;
  43. int send_marker_bit;
  44. uint8_t *data;
  45. } nalu_t;
  46. typedef struct _frame_of_nalus_t {
  47. nalu_t nalus[100];
  48. int total;
  49. int complete_frame;
  50. } frame_of_nalus_t;
  51. struct ftl_stream {
  52. obs_output_t *output;
  53. pthread_mutex_t packets_mutex;
  54. struct circlebuf packets;
  55. bool sent_headers;
  56. int64_t frames_sent;
  57. volatile bool connecting;
  58. pthread_t connect_thread;
  59. pthread_t status_thread;
  60. volatile bool active;
  61. volatile bool disconnected;
  62. volatile bool encode_error;
  63. pthread_t send_thread;
  64. int max_shutdown_time_sec;
  65. os_sem_t *send_sem;
  66. os_event_t *stop_event;
  67. uint64_t stop_ts;
  68. uint64_t shutdown_timeout_ts;
  69. struct dstr path;
  70. uint32_t channel_id;
  71. struct dstr username, password;
  72. struct dstr encoder_name;
  73. struct dstr bind_ip;
  74. /* frame drop variables */
  75. int64_t drop_threshold_usec;
  76. int64_t pframe_drop_threshold_usec;
  77. int min_priority;
  78. float congestion;
  79. int64_t last_dts_usec;
  80. uint64_t total_bytes_sent;
  81. uint64_t dropped_frames;
  82. uint64_t last_nack_count;
  83. ftl_handle_t ftl_handle;
  84. ftl_ingest_params_t params;
  85. int peak_kbps;
  86. uint32_t scale_width, scale_height, width, height;
  87. frame_of_nalus_t coded_pic_buffer;
  88. };
  89. static void log_libftl_messages(ftl_log_severity_t log_level,
  90. const char *message);
  91. static int init_connect(struct ftl_stream *stream);
  92. static void *connect_thread(void *data);
  93. static void *status_thread(void *data);
  94. static int _ftl_error_to_obs_error(int status);
  95. static const char *ftl_stream_getname(void *unused)
  96. {
  97. UNUSED_PARAMETER(unused);
  98. return obs_module_text("FTLStream");
  99. }
  100. static void log_ftl(int level, const char *format, va_list args)
  101. {
  102. blogva(LOG_INFO, format, args);
  103. UNUSED_PARAMETER(level);
  104. }
  105. static inline size_t num_buffered_packets(struct ftl_stream *stream);
  106. static inline void free_packets(struct ftl_stream *stream)
  107. {
  108. size_t num_packets;
  109. pthread_mutex_lock(&stream->packets_mutex);
  110. num_packets = num_buffered_packets(stream);
  111. if (num_packets)
  112. info("Freeing %d remaining packets", (int)num_packets);
  113. while (stream->packets.size) {
  114. struct encoder_packet packet;
  115. circlebuf_pop_front(&stream->packets, &packet, sizeof(packet));
  116. obs_encoder_packet_release(&packet);
  117. }
  118. pthread_mutex_unlock(&stream->packets_mutex);
  119. }
  120. static inline bool stopping(struct ftl_stream *stream)
  121. {
  122. return os_event_try(stream->stop_event) != EAGAIN;
  123. }
  124. static inline bool connecting(struct ftl_stream *stream)
  125. {
  126. return os_atomic_load_bool(&stream->connecting);
  127. }
  128. static inline bool active(struct ftl_stream *stream)
  129. {
  130. return os_atomic_load_bool(&stream->active);
  131. }
  132. static inline bool disconnected(struct ftl_stream *stream)
  133. {
  134. return os_atomic_load_bool(&stream->disconnected);
  135. }
  136. static void ftl_stream_destroy(void *data)
  137. {
  138. struct ftl_stream *stream = data;
  139. ftl_status_t status_code;
  140. info("ftl_stream_destroy");
  141. if (stopping(stream) && !connecting(stream)) {
  142. pthread_join(stream->send_thread, NULL);
  143. } else if (connecting(stream) || active(stream)) {
  144. if (stream->connecting) {
  145. info("wait for connect_thread to terminate");
  146. pthread_join(stream->status_thread, NULL);
  147. pthread_join(stream->connect_thread, NULL);
  148. info("wait for connect_thread to terminate: done");
  149. }
  150. stream->stop_ts = 0;
  151. os_event_signal(stream->stop_event);
  152. if (active(stream)) {
  153. os_sem_post(stream->send_sem);
  154. obs_output_end_data_capture(stream->output);
  155. pthread_join(stream->send_thread, NULL);
  156. }
  157. }
  158. info("ingest destroy");
  159. status_code = ftl_ingest_destroy(&stream->ftl_handle);
  160. if (status_code != FTL_SUCCESS) {
  161. info("Failed to destroy from ingest %d", status_code);
  162. }
  163. if (stream) {
  164. free_packets(stream);
  165. dstr_free(&stream->path);
  166. dstr_free(&stream->username);
  167. dstr_free(&stream->password);
  168. dstr_free(&stream->encoder_name);
  169. dstr_free(&stream->bind_ip);
  170. os_event_destroy(stream->stop_event);
  171. os_sem_destroy(stream->send_sem);
  172. pthread_mutex_destroy(&stream->packets_mutex);
  173. circlebuf_free(&stream->packets);
  174. bfree(stream);
  175. }
  176. }
  177. static void *ftl_stream_create(obs_data_t *settings, obs_output_t *output)
  178. {
  179. struct ftl_stream *stream = bzalloc(sizeof(struct ftl_stream));
  180. info("ftl_stream_create");
  181. stream->output = output;
  182. pthread_mutex_init_value(&stream->packets_mutex);
  183. stream->peak_kbps = -1;
  184. ftl_init();
  185. if (pthread_mutex_init(&stream->packets_mutex, NULL) != 0) {
  186. goto fail;
  187. }
  188. if (os_event_init(&stream->stop_event, OS_EVENT_TYPE_MANUAL) != 0) {
  189. goto fail;
  190. }
  191. stream->coded_pic_buffer.total = 0;
  192. stream->coded_pic_buffer.complete_frame = 0;
  193. UNUSED_PARAMETER(settings);
  194. return stream;
  195. fail:
  196. return NULL;
  197. }
  198. static void ftl_stream_stop(void *data, uint64_t ts)
  199. {
  200. struct ftl_stream *stream = data;
  201. info("ftl_stream_stop");
  202. if (stopping(stream) && ts != 0) {
  203. return;
  204. }
  205. if (connecting(stream)) {
  206. pthread_join(stream->status_thread, NULL);
  207. pthread_join(stream->connect_thread, NULL);
  208. }
  209. stream->stop_ts = ts / 1000ULL;
  210. if (ts) {
  211. stream->shutdown_timeout_ts =
  212. ts +
  213. (uint64_t)stream->max_shutdown_time_sec * 1000000000ULL;
  214. }
  215. if (active(stream)) {
  216. os_event_signal(stream->stop_event);
  217. if (stream->stop_ts == 0)
  218. os_sem_post(stream->send_sem);
  219. } else {
  220. obs_output_signal_stop(stream->output, OBS_OUTPUT_SUCCESS);
  221. }
  222. }
  223. static inline bool get_next_packet(struct ftl_stream *stream,
  224. struct encoder_packet *packet)
  225. {
  226. bool new_packet = false;
  227. pthread_mutex_lock(&stream->packets_mutex);
  228. if (stream->packets.size) {
  229. circlebuf_pop_front(&stream->packets, packet,
  230. sizeof(struct encoder_packet));
  231. new_packet = true;
  232. }
  233. pthread_mutex_unlock(&stream->packets_mutex);
  234. return new_packet;
  235. }
  236. static int avc_get_video_frame(struct ftl_stream *stream,
  237. struct encoder_packet *packet, bool is_header)
  238. {
  239. int consumed = 0;
  240. int len = (int)packet->size;
  241. nalu_t *nalu;
  242. unsigned char *video_stream = packet->data;
  243. while ((size_t)consumed < packet->size) {
  244. size_t total_max = sizeof(stream->coded_pic_buffer.nalus) /
  245. sizeof(stream->coded_pic_buffer.nalus[0]);
  246. if ((size_t)stream->coded_pic_buffer.total >= total_max) {
  247. warn("ERROR: cannot continue, nalu buffers are full");
  248. return -1;
  249. }
  250. nalu = &stream->coded_pic_buffer
  251. .nalus[stream->coded_pic_buffer.total];
  252. if (is_header) {
  253. if (consumed == 0) {
  254. //first 6 bytes are some obs header with part
  255. //of the sps
  256. video_stream += 6;
  257. consumed += 6;
  258. } else {
  259. //another spacer byte of 0x1
  260. video_stream += 1;
  261. consumed += 1;
  262. }
  263. len = video_stream[0] << 8 | video_stream[1];
  264. video_stream += 2;
  265. consumed += 2;
  266. } else {
  267. len = video_stream[0] << 24 | video_stream[1] << 16 |
  268. video_stream[2] << 8 | video_stream[3];
  269. if ((size_t)len > (packet->size - (size_t)consumed)) {
  270. warn("ERROR: got len of %d but packet only "
  271. "has %d left",
  272. len, (int)(packet->size - consumed));
  273. }
  274. consumed += 4;
  275. video_stream += 4;
  276. }
  277. consumed += len;
  278. uint8_t nalu_type = video_stream[0] & 0x1F;
  279. uint8_t nri = (video_stream[0] >> 5) & 0x3;
  280. if ((nalu_type != 12 && nalu_type != 6 && nalu_type != 9) ||
  281. nri) {
  282. nalu->data = video_stream;
  283. nalu->len = len;
  284. nalu->send_marker_bit = 0;
  285. stream->coded_pic_buffer.total++;
  286. }
  287. video_stream += len;
  288. }
  289. if (!is_header) {
  290. size_t idx = stream->coded_pic_buffer.total - 1;
  291. stream->coded_pic_buffer.nalus[idx].send_marker_bit = 1;
  292. }
  293. return 0;
  294. }
  295. static int send_packet(struct ftl_stream *stream, struct encoder_packet *packet,
  296. bool is_header)
  297. {
  298. int bytes_sent = 0;
  299. int ret = 0;
  300. if (packet->type == OBS_ENCODER_VIDEO) {
  301. stream->coded_pic_buffer.total = 0;
  302. avc_get_video_frame(stream, packet, is_header);
  303. int i;
  304. for (i = 0; i < stream->coded_pic_buffer.total; i++) {
  305. nalu_t *nalu = &stream->coded_pic_buffer.nalus[i];
  306. bytes_sent += ftl_ingest_send_media_dts(
  307. &stream->ftl_handle, FTL_VIDEO_DATA,
  308. packet->dts_usec, nalu->data, nalu->len,
  309. nalu->send_marker_bit);
  310. if (nalu->send_marker_bit) {
  311. stream->frames_sent++;
  312. }
  313. }
  314. } else if (packet->type == OBS_ENCODER_AUDIO) {
  315. bytes_sent += ftl_ingest_send_media_dts(
  316. &stream->ftl_handle, FTL_AUDIO_DATA, packet->dts_usec,
  317. packet->data, (int)packet->size, 0);
  318. } else {
  319. warn("Got packet type %d", packet->type);
  320. }
  321. if (is_header) {
  322. bfree(packet->data);
  323. } else {
  324. obs_encoder_packet_release(packet);
  325. }
  326. stream->total_bytes_sent += bytes_sent;
  327. return ret;
  328. }
  329. static void set_peak_bitrate(struct ftl_stream *stream)
  330. {
  331. int speedtest_kbps = 15000;
  332. int speedtest_duration = 1000;
  333. speed_test_t results;
  334. ftl_status_t status_code;
  335. status_code = ftl_ingest_speed_test_ex(&stream->ftl_handle,
  336. speedtest_kbps,
  337. speedtest_duration, &results);
  338. float percent_lost = 0;
  339. if (status_code == FTL_SUCCESS) {
  340. percent_lost = (float)results.lost_pkts * 100.f /
  341. (float)results.pkts_sent;
  342. } else {
  343. warn("Speed test failed with: %s",
  344. ftl_status_code_to_string(status_code));
  345. }
  346. // Get what the user set the encoding bitrate to.
  347. obs_encoder_t *video_encoder =
  348. obs_output_get_video_encoder(stream->output);
  349. obs_data_t *video_settings = obs_encoder_get_settings(video_encoder);
  350. int user_desired_bitrate =
  351. (int)obs_data_get_int(video_settings, "bitrate");
  352. obs_data_release(video_settings);
  353. // Report the results.
  354. info("Speed test completed: User desired bitrate %d, Peak kbps %d, "
  355. "initial rtt %d, "
  356. "final rtt %d, %3.2f lost packets",
  357. user_desired_bitrate, results.peak_kbps, results.starting_rtt,
  358. results.ending_rtt, percent_lost);
  359. // We still want to set the peak to about 1.2x what the target bitrate is,
  360. // even if the speed test reported it should be lower. If we don't, FTL
  361. // will queue data on the client and start adding latency. If the internet
  362. // connection really can't handle the bitrate the user will see either lost frame
  363. // and recovered frame counts go up, which is reflect in the dropped_frames count.
  364. stream->peak_kbps = stream->params.peak_kbps =
  365. user_desired_bitrate * 12 / 10;
  366. ftl_ingest_update_params(&stream->ftl_handle, &stream->params);
  367. }
  368. static inline bool send_headers(struct ftl_stream *stream, int64_t dts_usec);
  369. static inline bool can_shutdown_stream(struct ftl_stream *stream,
  370. struct encoder_packet *packet)
  371. {
  372. uint64_t cur_time = os_gettime_ns();
  373. bool timeout = cur_time >= stream->shutdown_timeout_ts;
  374. if (timeout)
  375. info("Stream shutdown timeout reached (%d second(s))",
  376. stream->max_shutdown_time_sec);
  377. return timeout || packet->sys_dts_usec >= (int64_t)stream->stop_ts;
  378. }
  379. static void *send_thread(void *data)
  380. {
  381. struct ftl_stream *stream = data;
  382. ftl_status_t status_code;
  383. os_set_thread_name("ftl-stream: send_thread");
  384. while (os_sem_wait(stream->send_sem) == 0) {
  385. struct encoder_packet packet;
  386. if (stopping(stream) && stream->stop_ts == 0) {
  387. break;
  388. }
  389. if (!get_next_packet(stream, &packet))
  390. continue;
  391. if (stopping(stream)) {
  392. if (can_shutdown_stream(stream, &packet)) {
  393. obs_encoder_packet_release(&packet);
  394. break;
  395. }
  396. }
  397. /* sends sps/pps on every key frame as this is typically
  398. * required for webrtc */
  399. if (packet.keyframe) {
  400. if (!send_headers(stream, packet.dts_usec)) {
  401. os_atomic_set_bool(&stream->disconnected, true);
  402. break;
  403. }
  404. }
  405. if (send_packet(stream, &packet, false) < 0) {
  406. os_atomic_set_bool(&stream->disconnected, true);
  407. break;
  408. }
  409. }
  410. bool encode_error = os_atomic_load_bool(&stream->encode_error);
  411. if (disconnected(stream)) {
  412. info("Disconnected from %s", stream->path.array);
  413. } else if (encode_error) {
  414. info("Encoder error, disconnecting");
  415. } else {
  416. info("User stopped the stream");
  417. }
  418. if (!stopping(stream)) {
  419. pthread_detach(stream->send_thread);
  420. obs_output_signal_stop(stream->output, OBS_OUTPUT_DISCONNECTED);
  421. } else if (encode_error) {
  422. obs_output_signal_stop(stream->output, OBS_OUTPUT_ENCODE_ERROR);
  423. } else {
  424. obs_output_end_data_capture(stream->output);
  425. }
  426. info("ingest disconnect");
  427. status_code = ftl_ingest_disconnect(&stream->ftl_handle);
  428. if (status_code != FTL_SUCCESS) {
  429. printf("Failed to disconnect from ingest %d", status_code);
  430. }
  431. free_packets(stream);
  432. os_event_reset(stream->stop_event);
  433. os_atomic_set_bool(&stream->active, false);
  434. stream->sent_headers = false;
  435. return NULL;
  436. }
  437. static bool send_video_header(struct ftl_stream *stream, int64_t dts_usec)
  438. {
  439. obs_output_t *context = stream->output;
  440. obs_encoder_t *vencoder = obs_output_get_video_encoder(context);
  441. uint8_t *header;
  442. size_t size;
  443. struct encoder_packet packet = {.type = OBS_ENCODER_VIDEO,
  444. .timebase_den = 1,
  445. .keyframe = true,
  446. .dts_usec = dts_usec};
  447. obs_encoder_get_extra_data(vencoder, &header, &size);
  448. packet.size = obs_parse_avc_header(&packet.data, header, size);
  449. return send_packet(stream, &packet, true) >= 0;
  450. }
  451. static inline bool send_headers(struct ftl_stream *stream, int64_t dts_usec)
  452. {
  453. stream->sent_headers = true;
  454. if (!send_video_header(stream, dts_usec))
  455. return false;
  456. return true;
  457. }
  458. static inline bool reset_semaphore(struct ftl_stream *stream)
  459. {
  460. os_sem_destroy(stream->send_sem);
  461. return os_sem_init(&stream->send_sem, 0) == 0;
  462. }
  463. #ifdef _WIN32
  464. #define socklen_t int
  465. #endif
  466. static int init_send(struct ftl_stream *stream)
  467. {
  468. int ret;
  469. reset_semaphore(stream);
  470. ret = pthread_create(&stream->send_thread, NULL, send_thread, stream);
  471. if (ret != 0) {
  472. warn("Failed to create send thread");
  473. return OBS_OUTPUT_ERROR;
  474. }
  475. os_atomic_set_bool(&stream->active, true);
  476. obs_output_begin_data_capture(stream->output, 0);
  477. return OBS_OUTPUT_SUCCESS;
  478. }
  479. static int try_connect(struct ftl_stream *stream)
  480. {
  481. ftl_status_t status_code;
  482. if (dstr_is_empty(&stream->path)) {
  483. warn("URL is empty");
  484. return OBS_OUTPUT_BAD_PATH;
  485. }
  486. info("Connecting to FTL Ingest URL %s...", stream->path.array);
  487. stream->width = (int)obs_output_get_width(stream->output);
  488. stream->height = (int)obs_output_get_height(stream->output);
  489. status_code = ftl_ingest_connect(&stream->ftl_handle);
  490. if (status_code != FTL_SUCCESS) {
  491. if (status_code == FTL_BAD_OR_INVALID_STREAM_KEY) {
  492. blog(LOG_ERROR, "Invalid Key (%s)",
  493. ftl_status_code_to_string(status_code));
  494. return OBS_OUTPUT_INVALID_STREAM;
  495. } else {
  496. warn("Ingest connect failed with: %s (%d)",
  497. ftl_status_code_to_string(status_code),
  498. status_code);
  499. return _ftl_error_to_obs_error(status_code);
  500. }
  501. }
  502. info("Connection to %s successful", stream->path.array);
  503. // Always get the peak bitrate when we are starting.
  504. set_peak_bitrate(stream);
  505. pthread_create(&stream->status_thread, NULL, status_thread, stream);
  506. return init_send(stream);
  507. }
  508. static bool ftl_stream_start(void *data)
  509. {
  510. struct ftl_stream *stream = data;
  511. info("ftl_stream_start");
  512. // Mixer doesn't support bframes. So force them off.
  513. obs_encoder_t *video_encoder =
  514. obs_output_get_video_encoder(stream->output);
  515. obs_data_t *video_settings = obs_encoder_get_settings(video_encoder);
  516. obs_data_set_int(video_settings, "bf", 0);
  517. obs_data_release(video_settings);
  518. if (!obs_output_can_begin_data_capture(stream->output, 0)) {
  519. return false;
  520. }
  521. if (!obs_output_initialize_encoders(stream->output, 0)) {
  522. return false;
  523. }
  524. stream->frames_sent = 0;
  525. os_atomic_set_bool(&stream->connecting, true);
  526. return pthread_create(&stream->connect_thread, NULL, connect_thread,
  527. stream) == 0;
  528. }
  529. static inline bool add_packet(struct ftl_stream *stream,
  530. struct encoder_packet *packet)
  531. {
  532. circlebuf_push_back(&stream->packets, packet,
  533. sizeof(struct encoder_packet));
  534. return true;
  535. }
  536. static inline size_t num_buffered_packets(struct ftl_stream *stream)
  537. {
  538. return stream->packets.size / sizeof(struct encoder_packet);
  539. }
  540. static void drop_frames(struct ftl_stream *stream, const char *name,
  541. int highest_priority, bool pframes)
  542. {
  543. UNUSED_PARAMETER(pframes);
  544. struct circlebuf new_buf = {0};
  545. int num_frames_dropped = 0;
  546. #ifdef _DEBUG
  547. int start_packets = (int)num_buffered_packets(stream);
  548. #else
  549. UNUSED_PARAMETER(name);
  550. #endif
  551. circlebuf_reserve(&new_buf, sizeof(struct encoder_packet) * 8);
  552. while (stream->packets.size) {
  553. struct encoder_packet packet;
  554. circlebuf_pop_front(&stream->packets, &packet, sizeof(packet));
  555. /* do not drop audio data or video keyframes */
  556. if (packet.type == OBS_ENCODER_AUDIO ||
  557. packet.drop_priority >= highest_priority) {
  558. circlebuf_push_back(&new_buf, &packet, sizeof(packet));
  559. } else {
  560. num_frames_dropped++;
  561. obs_encoder_packet_release(&packet);
  562. }
  563. }
  564. circlebuf_free(&stream->packets);
  565. stream->packets = new_buf;
  566. if (stream->min_priority < highest_priority)
  567. stream->min_priority = highest_priority;
  568. if (!num_frames_dropped)
  569. return;
  570. stream->dropped_frames += num_frames_dropped;
  571. #ifdef _DEBUG
  572. debug("Dropped %s, prev packet count: %d, new packet count: %d", name,
  573. start_packets, (int)num_buffered_packets(stream));
  574. #endif
  575. }
  576. static bool find_first_video_packet(struct ftl_stream *stream,
  577. struct encoder_packet *first)
  578. {
  579. size_t count = stream->packets.size / sizeof(*first);
  580. for (size_t i = 0; i < count; i++) {
  581. struct encoder_packet *cur =
  582. circlebuf_data(&stream->packets, i * sizeof(*first));
  583. if (cur->type == OBS_ENCODER_VIDEO && !cur->keyframe) {
  584. *first = *cur;
  585. return true;
  586. }
  587. }
  588. return false;
  589. }
  590. static void check_to_drop_frames(struct ftl_stream *stream, bool pframes)
  591. {
  592. struct encoder_packet first;
  593. int64_t buffer_duration_usec;
  594. size_t num_packets = num_buffered_packets(stream);
  595. const char *name = pframes ? "p-frames" : "b-frames";
  596. int priority = pframes ? OBS_NAL_PRIORITY_HIGHEST
  597. : OBS_NAL_PRIORITY_HIGH;
  598. int64_t drop_threshold = pframes ? stream->pframe_drop_threshold_usec
  599. : stream->drop_threshold_usec;
  600. if (num_packets < 5) {
  601. if (!pframes)
  602. stream->congestion = 0.0f;
  603. return;
  604. }
  605. if (!find_first_video_packet(stream, &first))
  606. return;
  607. /* if the amount of time stored in the buffered packets waiting to be
  608. * sent is higher than threshold, drop frames */
  609. buffer_duration_usec = stream->last_dts_usec - first.dts_usec;
  610. if (!pframes) {
  611. stream->congestion =
  612. (float)buffer_duration_usec / (float)drop_threshold;
  613. }
  614. if (buffer_duration_usec > drop_threshold) {
  615. debug("buffer_duration_usec: %" PRId64, buffer_duration_usec);
  616. drop_frames(stream, name, priority, pframes);
  617. }
  618. }
  619. static bool add_video_packet(struct ftl_stream *stream,
  620. struct encoder_packet *packet)
  621. {
  622. check_to_drop_frames(stream, false);
  623. check_to_drop_frames(stream, true);
  624. /* if currently dropping frames, drop packets until it reaches the
  625. * desired priority */
  626. if (packet->priority < stream->min_priority) {
  627. stream->dropped_frames++;
  628. return false;
  629. } else {
  630. stream->min_priority = 0;
  631. }
  632. stream->last_dts_usec = packet->dts_usec;
  633. return add_packet(stream, packet);
  634. }
  635. static void ftl_stream_data(void *data, struct encoder_packet *packet)
  636. {
  637. struct ftl_stream *stream = data;
  638. struct encoder_packet new_packet;
  639. bool added_packet = false;
  640. if (disconnected(stream) || !active(stream))
  641. return;
  642. /* encoder failure */
  643. if (!packet) {
  644. os_atomic_set_bool(&stream->encode_error, true);
  645. os_sem_post(stream->send_sem);
  646. return;
  647. }
  648. if (packet->type == OBS_ENCODER_VIDEO)
  649. obs_parse_avc_packet(&new_packet, packet);
  650. else
  651. obs_encoder_packet_ref(&new_packet, packet);
  652. pthread_mutex_lock(&stream->packets_mutex);
  653. if (!disconnected(stream)) {
  654. added_packet = (packet->type == OBS_ENCODER_VIDEO)
  655. ? add_video_packet(stream, &new_packet)
  656. : add_packet(stream, &new_packet);
  657. }
  658. pthread_mutex_unlock(&stream->packets_mutex);
  659. if (added_packet)
  660. os_sem_post(stream->send_sem);
  661. else
  662. obs_encoder_packet_release(&new_packet);
  663. }
  664. static void ftl_stream_defaults(obs_data_t *defaults)
  665. {
  666. UNUSED_PARAMETER(defaults);
  667. }
  668. static obs_properties_t *ftl_stream_properties(void *unused)
  669. {
  670. UNUSED_PARAMETER(unused);
  671. obs_properties_t *props = obs_properties_create();
  672. obs_properties_add_int(props, "peak_bitrate_kbps",
  673. obs_module_text("FTLStream.PeakBitrate"), 1000,
  674. 10000, 500);
  675. return props;
  676. }
  677. static uint64_t ftl_stream_total_bytes_sent(void *data)
  678. {
  679. struct ftl_stream *stream = data;
  680. return stream->total_bytes_sent;
  681. }
  682. static int ftl_stream_dropped_frames(void *data)
  683. {
  684. struct ftl_stream *stream = data;
  685. return (int)stream->dropped_frames;
  686. }
  687. static float ftl_stream_congestion(void *data)
  688. {
  689. struct ftl_stream *stream = data;
  690. return stream->min_priority > 0 ? 1.0f : stream->congestion;
  691. }
  692. enum ret_type {
  693. RET_CONTINUE,
  694. RET_BREAK,
  695. RET_EXIT,
  696. };
  697. static enum ret_type ftl_event(struct ftl_stream *stream,
  698. ftl_status_msg_t status)
  699. {
  700. if (status.msg.event.type != FTL_STATUS_EVENT_TYPE_DISCONNECTED)
  701. return RET_CONTINUE;
  702. info("Disconnected from ingest with reason: %s",
  703. ftl_status_code_to_string(status.msg.event.error_code));
  704. if (status.msg.event.reason == FTL_STATUS_EVENT_REASON_API_REQUEST) {
  705. return RET_BREAK;
  706. }
  707. //tell OBS and it will trigger a reconnection
  708. blog(LOG_WARNING, "Reconnecting to Ingest");
  709. obs_output_signal_stop(stream->output, OBS_OUTPUT_DISCONNECTED);
  710. reset_semaphore(stream);
  711. return RET_EXIT;
  712. }
  713. static void *status_thread(void *data)
  714. {
  715. struct ftl_stream *stream = data;
  716. ftl_status_msg_t status;
  717. ftl_status_t status_code;
  718. while (!disconnected(stream)) {
  719. status_code = ftl_ingest_get_status(&stream->ftl_handle,
  720. &status, 1000);
  721. if (status_code == FTL_STATUS_TIMEOUT ||
  722. status_code == FTL_QUEUE_EMPTY) {
  723. continue;
  724. } else if (status_code == FTL_NOT_INITIALIZED) {
  725. break;
  726. }
  727. if (status.type == FTL_STATUS_EVENT) {
  728. enum ret_type ret_type = ftl_event(stream, status);
  729. if (ret_type == RET_EXIT)
  730. return NULL;
  731. else if (ret_type == RET_BREAK)
  732. break;
  733. } else if (status.type == FTL_STATUS_LOG) {
  734. blog(LOG_INFO, "[%d] %s", status.msg.log.log_level,
  735. status.msg.log.string);
  736. } else if (status.type == FTL_STATUS_VIDEO_PACKETS) {
  737. ftl_packet_stats_msg_t *p = &status.msg.pkt_stats;
  738. // Report nack requests as dropped frames
  739. stream->dropped_frames +=
  740. p->nack_reqs - stream->last_nack_count;
  741. stream->last_nack_count = p->nack_reqs;
  742. int log_level = p->nack_reqs > 0 ? LOG_INFO : LOG_DEBUG;
  743. blog(log_level,
  744. "Avg packet send per second %3.1f, "
  745. "total nack requests %d",
  746. (float)p->sent * 1000.f / p->period,
  747. (int)p->nack_reqs);
  748. } else if (status.type == FTL_STATUS_VIDEO_PACKETS_INSTANT) {
  749. ftl_packet_stats_instant_msg_t *p =
  750. &status.msg.ipkt_stats;
  751. int log_level = p->avg_rtt > 20 ? LOG_INFO : LOG_DEBUG;
  752. blog(log_level,
  753. "avg transmit delay %dms "
  754. "(min: %d, max: %d), "
  755. "avg rtt %dms (min: %d, max: %d)",
  756. p->avg_xmit_delay, p->min_xmit_delay,
  757. p->max_xmit_delay, p->avg_rtt, p->min_rtt,
  758. p->max_rtt);
  759. } else if (status.type == FTL_STATUS_VIDEO) {
  760. ftl_video_frame_stats_msg_t *v =
  761. &status.msg.video_stats;
  762. int log_level = v->queue_fullness > 0 ? LOG_INFO
  763. : LOG_DEBUG;
  764. blog(log_level,
  765. "Queue an average of %3.2f fps "
  766. "(%3.1f kbps), "
  767. "sent an average of %3.2f fps "
  768. "(%3.1f kbps), "
  769. "queue fullness %d, "
  770. "max frame size %d",
  771. (float)v->frames_queued * 1000.f / v->period,
  772. (float)v->bytes_queued / v->period * 8,
  773. (float)v->frames_sent * 1000.f / v->period,
  774. (float)v->bytes_sent / v->period * 8,
  775. v->queue_fullness, v->max_frame_size);
  776. } else {
  777. blog(LOG_DEBUG,
  778. "Status: Got Status message of type "
  779. "%d",
  780. status.type);
  781. }
  782. }
  783. blog(LOG_DEBUG, "status_thread: Exited");
  784. pthread_detach(stream->status_thread);
  785. return NULL;
  786. }
  787. static void *connect_thread(void *data)
  788. {
  789. struct ftl_stream *stream = data;
  790. int ret;
  791. os_set_thread_name("ftl-stream: connect_thread");
  792. blog(LOG_WARNING, "ftl-stream: connect thread");
  793. ret = init_connect(stream);
  794. if (ret != OBS_OUTPUT_SUCCESS) {
  795. obs_output_signal_stop(stream->output, ret);
  796. return NULL;
  797. }
  798. ret = try_connect(stream);
  799. if (ret != OBS_OUTPUT_SUCCESS) {
  800. obs_output_signal_stop(stream->output, ret);
  801. info("Connection to %s failed: %d", stream->path.array, ret);
  802. }
  803. if (!stopping(stream))
  804. pthread_detach(stream->connect_thread);
  805. os_atomic_set_bool(&stream->connecting, false);
  806. return NULL;
  807. }
  808. static void log_libftl_messages(ftl_log_severity_t log_level,
  809. const char *message)
  810. {
  811. UNUSED_PARAMETER(log_level);
  812. blog(LOG_WARNING, "[libftl] %s", message);
  813. }
  814. static int init_connect(struct ftl_stream *stream)
  815. {
  816. obs_service_t *service;
  817. obs_data_t *settings;
  818. const char *bind_ip, *key, *ingest_url;
  819. ftl_status_t status_code;
  820. info("init_connect");
  821. if (stopping(stream))
  822. pthread_join(stream->send_thread, NULL);
  823. free_packets(stream);
  824. service = obs_output_get_service(stream->output);
  825. if (!service) {
  826. return OBS_OUTPUT_ERROR;
  827. }
  828. os_atomic_set_bool(&stream->disconnected, false);
  829. os_atomic_set_bool(&stream->encode_error, false);
  830. stream->total_bytes_sent = 0;
  831. stream->dropped_frames = 0;
  832. stream->min_priority = 0;
  833. settings = obs_output_get_settings(stream->output);
  834. obs_encoder_t *video_encoder =
  835. obs_output_get_video_encoder(stream->output);
  836. obs_data_t *video_settings = obs_encoder_get_settings(video_encoder);
  837. ingest_url = obs_service_get_url(service);
  838. if (strncmp(ingest_url, FTL_URL_PROTOCOL, strlen(FTL_URL_PROTOCOL)) ==
  839. 0) {
  840. dstr_copy(&stream->path, ingest_url + strlen(FTL_URL_PROTOCOL));
  841. } else {
  842. dstr_copy(&stream->path, ingest_url);
  843. }
  844. key = obs_service_get_key(service);
  845. int target_bitrate = (int)obs_data_get_int(video_settings, "bitrate");
  846. int peak_bitrate = (int)((float)target_bitrate * 1.1f);
  847. //minimum overshoot tolerance of 10%
  848. if (peak_bitrate < target_bitrate) {
  849. peak_bitrate = target_bitrate;
  850. }
  851. stream->params.stream_key = (char *)key;
  852. stream->params.video_codec = FTL_VIDEO_H264;
  853. stream->params.audio_codec = FTL_AUDIO_OPUS;
  854. stream->params.ingest_hostname = stream->path.array;
  855. stream->params.vendor_name = "OBS Studio";
  856. stream->params.vendor_version = OBS_VERSION;
  857. stream->params.peak_kbps = stream->peak_kbps < 0 ? 0
  858. : stream->peak_kbps;
  859. //not required when using ftl_ingest_send_media_dts
  860. stream->params.fps_num = 0;
  861. stream->params.fps_den = 0;
  862. status_code = ftl_ingest_create(&stream->ftl_handle, &stream->params);
  863. if (status_code != FTL_SUCCESS) {
  864. if (status_code == FTL_BAD_OR_INVALID_STREAM_KEY) {
  865. blog(LOG_ERROR, "Invalid Key (%s)",
  866. ftl_status_code_to_string(status_code));
  867. return OBS_OUTPUT_INVALID_STREAM;
  868. } else {
  869. blog(LOG_ERROR, "Failed to create ingest handle (%s)",
  870. ftl_status_code_to_string(status_code));
  871. return OBS_OUTPUT_ERROR;
  872. }
  873. }
  874. dstr_copy(&stream->username, obs_service_get_username(service));
  875. dstr_copy(&stream->password, obs_service_get_password(service));
  876. dstr_depad(&stream->path);
  877. stream->drop_threshold_usec =
  878. (int64_t)obs_data_get_int(settings, OPT_DROP_THRESHOLD) * 1000;
  879. stream->max_shutdown_time_sec =
  880. (int)obs_data_get_int(settings, OPT_MAX_SHUTDOWN_TIME_SEC);
  881. bind_ip = obs_data_get_string(settings, OPT_BIND_IP);
  882. dstr_copy(&stream->bind_ip, bind_ip);
  883. obs_data_release(settings);
  884. obs_data_release(video_settings);
  885. return OBS_OUTPUT_SUCCESS;
  886. }
  887. // Returns 0 on success
  888. static int _ftl_error_to_obs_error(int status)
  889. {
  890. /* Map FTL errors to OBS errors */
  891. switch (status) {
  892. case FTL_SUCCESS:
  893. return OBS_OUTPUT_SUCCESS;
  894. case FTL_SOCKET_NOT_CONNECTED:
  895. case FTL_MALLOC_FAILURE:
  896. case FTL_INTERNAL_ERROR:
  897. case FTL_CONFIG_ERROR:
  898. case FTL_NOT_ACTIVE_STREAM:
  899. case FTL_NOT_CONNECTED:
  900. case FTL_ALREADY_CONNECTED:
  901. case FTL_STATUS_TIMEOUT:
  902. case FTL_QUEUE_FULL:
  903. case FTL_STATUS_WAITING_FOR_KEY_FRAME:
  904. case FTL_QUEUE_EMPTY:
  905. case FTL_NOT_INITIALIZED:
  906. return OBS_OUTPUT_ERROR;
  907. case FTL_BAD_REQUEST:
  908. case FTL_DNS_FAILURE:
  909. case FTL_CONNECT_ERROR:
  910. case FTL_UNSUPPORTED_MEDIA_TYPE:
  911. case FTL_OLD_VERSION:
  912. case FTL_UNAUTHORIZED:
  913. case FTL_AUDIO_SSRC_COLLISION:
  914. case FTL_VIDEO_SSRC_COLLISION:
  915. case FTL_STREAM_REJECTED:
  916. case FTL_BAD_OR_INVALID_STREAM_KEY:
  917. case FTL_CHANNEL_IN_USE:
  918. case FTL_REGION_UNSUPPORTED:
  919. case FTL_GAME_BLOCKED:
  920. return OBS_OUTPUT_CONNECT_FAILED;
  921. case FTL_NO_MEDIA_TIMEOUT:
  922. return OBS_OUTPUT_DISCONNECTED;
  923. case FTL_USER_DISCONNECT:
  924. return OBS_OUTPUT_SUCCESS;
  925. case FTL_UNKNOWN_ERROR_CODE:
  926. default:
  927. /* Unknown FTL error */
  928. return OBS_OUTPUT_ERROR;
  929. }
  930. }
  931. struct obs_output_info ftl_output_info = {
  932. .id = "ftl_output",
  933. .flags = OBS_OUTPUT_AV | OBS_OUTPUT_ENCODED | OBS_OUTPUT_SERVICE,
  934. .encoded_video_codecs = "h264",
  935. .encoded_audio_codecs = "opus",
  936. .get_name = ftl_stream_getname,
  937. .create = ftl_stream_create,
  938. .destroy = ftl_stream_destroy,
  939. .start = ftl_stream_start,
  940. .stop = ftl_stream_stop,
  941. .encoded_packet = ftl_stream_data,
  942. .get_defaults = ftl_stream_defaults,
  943. .get_properties = ftl_stream_properties,
  944. .get_total_bytes = ftl_stream_total_bytes_sent,
  945. .get_congestion = ftl_stream_congestion,
  946. .get_dropped_frames = ftl_stream_dropped_frames,
  947. };