ftl-stream.c 30 KB

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