FFmpeg
whip.c
Go to the documentation of this file.
1 /*
2  * WebRTC-HTTP ingestion protocol (WHIP) muxer
3  * Copyright (c) 2023 The FFmpeg Project
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include "libavcodec/h264.h"
23 #include "libavcodec/startcode.h"
24 
26 #include "libavutil/avassert.h"
27 #include "libavutil/base64.h"
28 #include "libavutil/bprint.h"
29 #include "libavutil/crc.h"
30 #include "libavutil/hmac.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/lfg.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/mem.h"
35 #include "libavutil/random_seed.h"
36 #include "libavutil/time.h"
37 #include "avc.h"
38 #include "nal.h"
39 #include "avio_internal.h"
40 #include "http.h"
41 #include "internal.h"
42 #include "mux.h"
43 #include "network.h"
44 #include "rtp.h"
45 #include "srtp.h"
46 #include "tls.h"
47 
48 /**
49  * Maximum size limit of a Session Description Protocol (SDP),
50  * be it an offer or answer.
51  */
52 #define MAX_SDP_SIZE 8192
53 
54 /**
55  * The size of the Secure Real-time Transport Protocol (SRTP) master key material
56  * that is exported by Secure Sockets Layer (SSL) after a successful Datagram
57  * Transport Layer Security (DTLS) handshake. This material consists of a key
58  * of 16 bytes and a salt of 14 bytes.
59  */
60 #define DTLS_SRTP_KEY_LEN 16
61 #define DTLS_SRTP_SALT_LEN 14
62 
63 /**
64  * The maximum size of the Secure Real-time Transport Protocol (SRTP) HMAC checksum
65  * and padding that is appended to the end of the packet. To calculate the maximum
66  * size of the User Datagram Protocol (UDP) packet that can be sent out, subtract
67  * this size from the `pkt_size`.
68  */
69 #define DTLS_SRTP_CHECKSUM_LEN 16
70 
71 #define WHIP_US_PER_MS 1000
72 
73 /**
74  * If we try to read from UDP and get EAGAIN, we sleep for 5ms and retry up to 10 times.
75  * This will limit the total duration (in milliseconds, 50ms)
76  */
77 #define ICE_DTLS_READ_MAX_RETRY 10
78 #define ICE_DTLS_READ_SLEEP_DURATION 5
79 
80 /* The magic cookie for Session Traversal Utilities for NAT (STUN) messages. */
81 #define STUN_MAGIC_COOKIE 0x2112A442
82 
83 /**
84  * Refer to RFC 8445 5.1.2
85  * priority = (2^24)*(type preference) + (2^8)*(local preference) + (2^0)*(256 - component ID)
86  * host candidate priority is 126 << 24 | 65535 << 8 | 255
87  */
88 #define STUN_HOST_CANDIDATE_PRIORITY 126 << 24 | 65535 << 8 | 255
89 
90 /**
91  * Maximum size of the buffer for sending and receiving UDP packets.
92  * Please note that this size does not limit the size of the UDP packet that can be sent.
93  * To set the limit for packet size, modify the `pkt_size` parameter.
94  * For instance, it is possible to set the UDP buffer to 4096 to send or receive packets,
95  * but please keep in mind that the `pkt_size` option limits the packet size to 1400.
96  */
97 #define MAX_UDP_BUFFER_SIZE 4096
98 
99 /* Referring to Chrome's definition of RTP payload types. */
100 #define WHIP_RTP_PAYLOAD_TYPE_H264 106
101 #define WHIP_RTP_PAYLOAD_TYPE_OPUS 111
102 #define WHIP_RTP_PAYLOAD_TYPE_VIDEO_RTX 105
103 
104 /**
105  * The STUN message header, which is 20 bytes long, comprises the
106  * STUNMessageType (1B), MessageLength (2B), MagicCookie (4B),
107  * and TransactionID (12B).
108  * See https://datatracker.ietf.org/doc/html/rfc5389#section-6
109  */
110 #define ICE_STUN_HEADER_SIZE 20
111 
112 /**
113  * The RTP header is 12 bytes long, comprising the Version(1B), PT(1B),
114  * SequenceNumber(2B), Timestamp(4B), and SSRC(4B).
115  * See https://www.rfc-editor.org/rfc/rfc3550#section-5.1
116  */
117 #define WHIP_RTP_HEADER_SIZE 12
118 
119 /**
120  * For RTCP, PT is [128, 223] (or without marker [0, 95]). Literally, RTCP starts
121  * from 64 not 0, so PT is [192, 223] (or without marker [64, 95]), see "RTCP Control
122  * Packet Types (PT)" at
123  * https://www.iana.org/assignments/rtp-parameters/rtp-parameters.xhtml#rtp-parameters-4
124  *
125  * For RTP, the PT is [96, 127], or [224, 255] with marker. See "RTP Payload Types (PT)
126  * for standard audio and video encodings" at
127  * https://www.iana.org/assignments/rtp-parameters/rtp-parameters.xhtml#rtp-parameters-1
128  */
129 #define WHIP_RTCP_PT_START 192
130 #define WHIP_RTCP_PT_END 223
131 
132 /**
133  * In the case of ICE-LITE, these fields are not used; instead, they are defined
134  * as constant values.
135  */
136 #define WHIP_SDP_SESSION_ID "4489045141692799359"
137 #define WHIP_SDP_CREATOR_IP "127.0.0.1"
138 
139 /**
140  * Refer to RFC 7675 5.1,
141  *
142  * To prevent expiry of consent, a STUN binding request can be sent periodically.
143  * Implementations SHOULD set a default interval of 5 seconds(5000ms).
144  *
145  * Consent expires after 30 seconds(30000ms).
146  */
147 #define WHIP_ICE_CONSENT_CHECK_INTERVAL 5000
148 #define WHIP_ICE_CONSENT_EXPIRED_TIMER 30000
149 
150 /**
151  * RTP history packet size.
152  * Target is buffering 1000ms of RTP history packets.
153  *
154  * bandwidth_bps = (RTP payload bytes) * (RTP history size) * 8
155  * Assumes average RTP payload is 1184 bytes (MTU - SRTP_CHECKSUM_LEN).
156  */
157 #define WHIP_RTP_HISTORY_MIN 64 /* around 0.61 Mbps */
158 #define WHIP_RTP_HISTORY_DEFAULT 512 /* around 4.85 Mbps */
159 #define WHIP_RTP_HISTORY_MAX 2048 /* around 19.40 Mbps */
160 
161 /* Calculate the elapsed time from starttime to endtime in milliseconds. */
162 #define ELAPSED(starttime, endtime) ((float)(endtime - starttime) / 1000)
163 
164 /* STUN Attribute, comprehension-required range (0x0000-0x7FFF) */
165 enum STUNAttr {
166  STUN_ATTR_USERNAME = 0x0006, /// shared secret response/bind request
167  STUN_ATTR_PRIORITY = 0x0024, /// must be included in a Binding request
168  STUN_ATTR_USE_CANDIDATE = 0x0025, /// bind request
169  STUN_ATTR_MESSAGE_INTEGRITY = 0x0008, /// bind request/response
170  STUN_ATTR_FINGERPRINT = 0x8028, /// rfc5389
171  STUN_ATTR_ICE_CONTROLLING = 0x802A, /// ICE controlling role
172 };
173 
174 enum WHIPState {
176 
177  /* The initial state. */
179  /* The muxer has sent the offer to the peer. */
181  /* The muxer has received the answer from the peer. */
183  /**
184  * After parsing the answer received from the peer, the muxer negotiates the abilities
185  * in the offer that it generated.
186  */
188  /* The muxer has connected to the peer via UDP. */
190  /* The muxer has sent the ICE request to the peer. */
192  /* The muxer has received the ICE response from the peer. */
194  /* The muxer has finished the DTLS handshake with the peer. */
196  /* The muxer has finished the SRTP setup. */
198  /* The muxer is ready to send/receive media frames. */
200  /* The muxer is failed. */
202 };
203 
204 typedef enum WHIPFlags {
205  WHIP_DTLS_ACTIVE = (1 << 0),
206 } WHIPFlags;
207 
208 typedef struct RtpHistoryItem {
209  uint16_t seq;
210  int size;
211  uint8_t *buf;
213 
214 typedef struct WHIPContext {
216 
217  uint32_t flags;
218  /* The state of the RTC connection. */
220 
221  /* Parameters for the input audio and video codecs. */
224 
225  /**
226  * The h264_mp4toannexb Bitstream Filter (BSF) bypasses the AnnexB packet;
227  * therefore, it is essential to insert the SPS and PPS before each IDR frame
228  * in such cases.
229  */
231 
232  /* The random number generator. */
234 
235  /* The ICE username and pwd fragment generated by the muxer. */
237  char ice_pwd_local[33];
238  /* The SSRC of the audio and video stream, generated by the muxer. */
239  uint32_t audio_ssrc;
240  uint32_t video_ssrc;
241  uint32_t video_rtx_ssrc;
242 
243  uint16_t audio_first_seq;
244  uint16_t video_first_seq;
245 
246  uint16_t video_rtx_seq;
247  /* The PT(Payload Type) of stream, generated by the muxer. */
251  /**
252  * This is the SDP offer generated by the muxer based on the codec parameters,
253  * DTLS, and ICE information.
254  */
255  char *sdp_offer;
256 
258  uint64_t ice_tie_breaker; // random 64 bit, for ICE-CONTROLLING
259  /* The ICE username and pwd from remote server. */
262  /**
263  * This represents the ICE candidate protocol, priority, host and port.
264  * Currently, we only support one candidate and choose the first UDP candidate.
265  * However, we plan to support multiple candidates in the future.
266  */
268  char *ice_host;
269  int ice_port;
270 
271  /* The SDP answer received from the WebRTC server. */
272  char *sdp_answer;
273  /* The resource URL returned in the Location header of WHIP HTTP response. */
275 
276  /* These variables represent timestamps used for calculating and tracking the cost. */
287 
288  /* The certificate and private key content used for DTLS handshake */
291  /* The fingerprint of certificate, used in SDP offer. */
293  /* remote DTLS cert fingerprint from SDP answer (sha-256). */
295  /**
296  * This represents the material used to build the SRTP master key. It is
297  * generated by DTLS and has the following layout:
298  * 16B 16B 14B 14B
299  * client_key | server_key | client_salt | server_salt
300  */
302 
303  /* TODO: Use AVIOContext instead of URLContext */
305 
306  /* The SRTP send context, to encrypt outgoing packets. */
311  /* The SRTP receive context, to decrypt incoming packets. */
313 
314  /* The UDP transport is used for delivering ICE, DTLS and SRTP packets. */
316  /* The buffer for UDP transmission. */
318 
319  /* The timeout in milliseconds for ICE and DTLS handshake. */
321 
322  /* The timeout in microseconds for HTTP operations. */
324  /**
325  * The size of RTP packet, should generally be set to MTU.
326  * Note that pion requires a smaller value, for example, 1200.
327  */
328  int pkt_size;
329  int ts_buffer_size;/* Underlying protocol send/receive buffer size */
330  /**
331  * The optional Bearer token for WHIP Authorization.
332  * See https://www.ietf.org/archive/id/draft-ietf-wish-whip-08.html#name-authentication-and-authoriz
333  */
335  /* The certificate and private key used for DTLS handshake. */
336  char* cert_file;
337  char* key_file;
338 
339  int hist_sz;
341  uint8_t *hist_pool;
343 } WHIPContext;
344 
345 /**
346  * Get or Generate a self-signed certificate and private key for DTLS,
347  * fingerprint for SDP
348  */
350 {
351  int ret = 0;
352  WHIPContext *whip = s->priv_data;
353 
354  if (whip->cert_file && whip->key_file) {
355  /* Read the private key and certificate from the file. */
356  if ((ret = ff_ssl_read_key_cert(whip->key_file, whip->cert_file,
357  whip->key_buf, sizeof(whip->key_buf),
358  whip->cert_buf, sizeof(whip->cert_buf),
359  &whip->dtls_fingerprint)) < 0) {
360  av_log(s, AV_LOG_ERROR, "Failed to read DTLS certificate from cert=%s, key=%s\n",
361  whip->cert_file, whip->key_file);
362  return ret;
363  }
364  } else {
365  /* Generate a private key to ctx->dtls_pkey and self-signed certificate. */
366  if ((ret = ff_ssl_gen_key_cert(whip->key_buf, sizeof(whip->key_buf),
367  whip->cert_buf, sizeof(whip->cert_buf),
368  &whip->dtls_fingerprint)) < 0) {
369  av_log(s, AV_LOG_ERROR, "Failed to generate DTLS private key and certificate\n");
370  return ret;
371  }
372  }
373 
374  return ret;
375 }
376 
378 {
379  int ret = 0;
380  WHIPContext *whip = s->priv_data;
381  int is_dtls_active = whip->flags & WHIP_DTLS_ACTIVE;
383  char buf[256];
384 
385  ff_url_join(buf, sizeof(buf), "dtls", NULL, whip->ice_host, whip->ice_port, NULL);
386  av_dict_set_int(&opts, "mtu", whip->pkt_size, 0);
387  if (whip->cert_file) {
388  av_dict_set(&opts, "cert_file", whip->cert_file, 0);
389  } else
390  av_dict_set(&opts, "cert_pem", whip->cert_buf, 0);
391 
392  if (whip->key_file) {
393  av_dict_set(&opts, "key_file", whip->key_file, 0);
394  } else
395  av_dict_set(&opts, "key_pem", whip->key_buf, 0);
396  av_dict_set_int(&opts, "external_sock", 1, 0);
397  av_dict_set_int(&opts, "use_srtp", 1, 0);
398  av_dict_set_int(&opts, "listen", is_dtls_active ? 0 : 1, 0);
399  ret = ffurl_open_whitelist(&whip->dtls_uc, buf, AVIO_FLAG_READ_WRITE, &s->interrupt_callback,
400  &opts, s->protocol_whitelist, s->protocol_blacklist, NULL);
401  av_dict_free(&opts);
402  if (ret < 0) {
403  av_log(whip, AV_LOG_ERROR, "Failed to open DTLS url:%s\n", buf);
404  goto end;
405  }
406  /* reuse the udp created by whip */
407  ff_tls_set_external_socket(whip->dtls_uc, whip->udp);
408 end:
409  return ret;
410 }
411 
412 /**
413  * Initialize and check the options for the WebRTC muxer.
414  */
416 {
417  int ret, ideal_pkt_size = 532;
418  WHIPContext *whip = s->priv_data;
419  uint32_t seed;
420 
422 
424  if (ret < 0) {
425  av_log(whip, AV_LOG_ERROR, "Failed to init certificate and key\n");
426  return ret;
427  }
428 
429  /* Initialize the random number generator. */
431  av_lfg_init(&whip->rnd, seed);
432 
433  /* 64 bit tie breaker for ICE-CONTROLLING (RFC 8445 16.1) */
434  ret = av_random_bytes((uint8_t *)&whip->ice_tie_breaker, sizeof(whip->ice_tie_breaker));
435  if (ret < 0) {
436  av_log(whip, AV_LOG_ERROR, "Couldn't generate random bytes for ICE tie breaker\n");
437  return ret;
438  }
439 
440  whip->audio_first_seq = av_lfg_get(&whip->rnd) & 0x0fff;
441  whip->video_first_seq = whip->audio_first_seq + 1;
442 
443  if (whip->pkt_size < ideal_pkt_size)
444  av_log(whip, AV_LOG_WARNING, "pkt_size=%d(<%d) is too small, may cause packet loss\n",
445  whip->pkt_size, ideal_pkt_size);
446 
447  whip->hist = av_calloc(whip->hist_sz, sizeof(*whip->hist));
448  if (!whip->hist)
449  return AVERROR(ENOMEM);
450 
452  if (!whip->hist_pool)
453  return AVERROR(ENOMEM);
454 
455  for (int i = 0; i < whip->hist_sz; i++)
456  whip->hist[i].buf = whip->hist_pool + i * (whip->pkt_size - DTLS_SRTP_CHECKSUM_LEN);
457 
458  if (whip->state < WHIP_STATE_INIT)
459  whip->state = WHIP_STATE_INIT;
461  av_log(whip, AV_LOG_VERBOSE, "Init state=%d, handshake_timeout=%dms, pkt_size=%d, seed=%d, elapsed=%.2fms\n",
463 
464  return 0;
465 }
466 
467 /**
468  * When duplicating a stream, the demuxer has already set the extradata, profile, and
469  * level of the par. Keep in mind that this function will not be invoked since the
470  * profile and level are set.
471  *
472  * When utilizing an encoder, such as libx264, to encode a stream, the extradata in
473  * par->extradata contains the SPS, which includes profile and level information.
474  * However, the profile and level of par remain unspecified. Therefore, it is necessary
475  * to extract the profile and level data from the extradata and assign it to the par's
476  * profile and level. Keep in mind that AVFMT_GLOBALHEADER must be enabled; otherwise,
477  * the extradata will remain empty.
478  */
480 {
481  int ret = 0;
482  const uint8_t *r = par->extradata, *r1, *end = par->extradata + par->extradata_size;
483  H264SPS seq, *const sps = &seq;
484  uint32_t state;
485  WHIPContext *whip = s->priv_data;
486 
487  if (par->codec_id != AV_CODEC_ID_H264)
488  return ret;
489 
490  if (par->profile != AV_PROFILE_UNKNOWN && par->level != AV_LEVEL_UNKNOWN)
491  return ret;
492 
493  if (!par->extradata || par->extradata_size <= 0) {
494  av_log(whip, AV_LOG_ERROR, "Unable to parse profile from empty extradata=%p, size=%d\n",
495  par->extradata, par->extradata_size);
496  return AVERROR(EINVAL);
497  }
498 
499  while (1) {
500  r = avpriv_find_start_code(r, end, &state);
501  if (r >= end)
502  break;
503 
504  r1 = ff_nal_find_startcode(r, end);
505  if ((state & 0x1f) == H264_NAL_SPS) {
506  ret = ff_avc_decode_sps(sps, r, r1 - r);
507  if (ret < 0) {
508  av_log(whip, AV_LOG_ERROR, "Failed to decode SPS, state=%x, size=%d\n",
509  state, (int)(r1 - r));
510  return ret;
511  }
512 
513  av_log(whip, AV_LOG_VERBOSE, "Parse profile=%d, level=%d from SPS\n",
514  sps->profile_idc, sps->level_idc);
515  par->profile = sps->profile_idc;
516  par->level = sps->level_idc;
517  }
518 
519  r = r1;
520  }
521 
522  return ret;
523 }
524 
525 /**
526  * Parses video SPS/PPS from the extradata of codecpar and checks the codec.
527  * Currently only supports video(h264) and audio(opus). Note that only baseline
528  * and constrained baseline profiles of h264 are supported.
529  *
530  * If the profile is less than 0, the function considers the profile as baseline.
531  * It may need to parse the profile from SPS/PPS. This situation occurs when ingesting
532  * desktop and transcoding.
533  *
534  * @param s Pointer to the AVFormatContext
535  * @returns Returns 0 if successful or AVERROR_xxx in case of an error.
536  *
537  * TODO: FIXME: There is an issue with the timestamp of OPUS audio, especially when
538  * the input is an MP4 file. The timestamp deviates from the expected value of 960,
539  * causing Chrome to play the audio stream with noise. This problem can be replicated
540  * by transcoding a specific file into MP4 format and publishing it using the WHIP
541  * muxer. However, when directly transcoding and publishing through the WHIP muxer,
542  * the issue is not present, and the audio timestamp remains consistent. The root
543  * cause is still unknown, and this comment has been added to address this issue
544  * in the future. Further research is needed to resolve the problem.
545  */
547 {
548  int i, ret = 0;
549  WHIPContext *whip = s->priv_data;
550 
551  for (i = 0; i < s->nb_streams; i++) {
552  AVCodecParameters *par = s->streams[i]->codecpar;
553  switch (par->codec_type) {
554  case AVMEDIA_TYPE_VIDEO:
555  whip->video_par = par;
556 
557  if (par->video_delay > 0) {
558  av_log(whip, AV_LOG_ERROR, "Unsupported B frames by RTC\n");
559  return AVERROR_PATCHWELCOME;
560  }
561 
562  if ((ret = parse_profile_level(s, par)) < 0) {
563  av_log(whip, AV_LOG_ERROR, "Failed to parse SPS/PPS from extradata\n");
564  return AVERROR(EINVAL);
565  }
566 
567  if (par->profile == AV_PROFILE_UNKNOWN) {
568  av_log(whip, AV_LOG_WARNING, "No profile found in extradata, consider baseline\n");
569  return AVERROR(EINVAL);
570  }
571  if (par->level == AV_LEVEL_UNKNOWN) {
572  av_log(whip, AV_LOG_WARNING, "No level found in extradata, consider 3.1\n");
573  return AVERROR(EINVAL);
574  }
575  break;
576  case AVMEDIA_TYPE_AUDIO:
577  whip->audio_par = par;
578 
579  if (par->ch_layout.nb_channels != 2) {
580  av_log(whip, AV_LOG_ERROR, "Unsupported audio channels %d by RTC, choose stereo\n",
581  par->ch_layout.nb_channels);
582  return AVERROR_PATCHWELCOME;
583  }
584 
585  if (par->sample_rate != 48000) {
586  av_log(whip, AV_LOG_ERROR, "Unsupported audio sample rate %d by RTC, choose 48000\n", par->sample_rate);
587  return AVERROR_PATCHWELCOME;
588  }
589  break;
590  default:
591  av_unreachable("already checked via FF_OFMT flags");
592  }
593  }
594 
595  return ret;
596 }
597 
598 /**
599  * Generate SDP offer according to the codec parameters, DTLS and ICE information.
600  *
601  * Note that we don't use av_sdp_create to generate SDP offer because it doesn't
602  * support DTLS and ICE information.
603  *
604  * @return 0 if OK, AVERROR_xxx on error
605  */
607 {
608  int ret = 0, profile_idc = 0, level, profile_iop = 0;
609  const char *acodec_name = NULL, *vcodec_name = NULL;
610  char bundle[4];
611  int bundle_index = 0;
612  AVBPrint bp;
613  WHIPContext *whip = s->priv_data;
614  int is_dtls_active = whip->flags & WHIP_DTLS_ACTIVE;
615 
616  /* To prevent a crash during cleanup, always initialize it. */
617  av_bprint_init(&bp, 1, MAX_SDP_SIZE);
618 
619  if (whip->sdp_offer) {
620  av_log(whip, AV_LOG_ERROR, "SDP offer is already set\n");
621  ret = AVERROR(EINVAL);
622  goto end;
623  }
624 
625  snprintf(whip->ice_ufrag_local, sizeof(whip->ice_ufrag_local), "%08x",
626  av_lfg_get(&whip->rnd));
627  snprintf(whip->ice_pwd_local, sizeof(whip->ice_pwd_local), "%08x%08x%08x%08x",
628  av_lfg_get(&whip->rnd), av_lfg_get(&whip->rnd), av_lfg_get(&whip->rnd),
629  av_lfg_get(&whip->rnd));
630 
631  whip->audio_ssrc = av_lfg_get(&whip->rnd);
632  whip->video_ssrc = whip->audio_ssrc + 1;
633  whip->video_rtx_ssrc = whip->video_ssrc + 1;
634 
638 
639  if (whip->audio_par) {
640  bundle[bundle_index++] = '0';
641  bundle[bundle_index++] = ' ';
642  }
643  if (whip->video_par) {
644  bundle[bundle_index++] = '1';
645  bundle[bundle_index++] = ' ';
646  }
647  bundle[bundle_index - 1] = '\0';
648 
649  av_bprintf(&bp, ""
650  "v=0\r\n"
651  "o=FFmpeg %s 2 IN IP4 %s\r\n"
652  "s=FFmpegPublishSession\r\n"
653  "t=0 0\r\n"
654  "a=group:BUNDLE %s\r\n"
655  "a=extmap-allow-mixed\r\n"
656  "a=msid-semantic: WMS\r\n",
659  bundle);
660 
661  if (whip->audio_par) {
662  if (whip->audio_par->codec_id == AV_CODEC_ID_OPUS)
663  acodec_name = "opus";
664 
665  av_bprintf(&bp, ""
666  "m=audio 9 UDP/TLS/RTP/SAVPF %u\r\n"
667  "c=IN IP4 0.0.0.0\r\n"
668  "a=ice-ufrag:%s\r\n"
669  "a=ice-pwd:%s\r\n"
670  "a=fingerprint:sha-256 %s\r\n"
671  "a=setup:%s\r\n"
672  "a=mid:0\r\n"
673  "a=sendonly\r\n"
674  "a=msid:FFmpeg audio\r\n"
675  "a=rtcp-mux\r\n"
676  "a=rtpmap:%u %s/%d/%d\r\n"
677  "a=ssrc:%u cname:FFmpeg\r\n"
678  "a=ssrc:%u msid:FFmpeg audio\r\n",
679  whip->audio_payload_type,
680  whip->ice_ufrag_local,
681  whip->ice_pwd_local,
682  whip->dtls_fingerprint,
683  is_dtls_active ? "active" : "passive",
684  whip->audio_payload_type,
685  acodec_name,
686  whip->audio_par->sample_rate,
688  whip->audio_ssrc,
689  whip->audio_ssrc);
690  }
691 
692  if (whip->video_par) {
693  level = whip->video_par->level;
694  if (whip->video_par->codec_id == AV_CODEC_ID_H264) {
695  vcodec_name = "H264";
696  profile_iop |= whip->video_par->profile & AV_PROFILE_H264_CONSTRAINED ? 1 << 6 : 0;
697  profile_iop |= whip->video_par->profile & AV_PROFILE_H264_INTRA ? 1 << 4 : 0;
698  profile_idc = whip->video_par->profile & 0x00ff;
699  }
700 
701  av_bprintf(&bp, ""
702  "m=video 9 UDP/TLS/RTP/SAVPF %u %u\r\n"
703  "c=IN IP4 0.0.0.0\r\n"
704  "a=ice-ufrag:%s\r\n"
705  "a=ice-pwd:%s\r\n"
706  "a=fingerprint:sha-256 %s\r\n"
707  "a=setup:%s\r\n"
708  "a=mid:1\r\n"
709  "a=sendonly\r\n"
710  "a=msid:FFmpeg video\r\n"
711  "a=rtcp-mux\r\n"
712  "a=rtcp-rsize\r\n"
713  "a=rtpmap:%u %s/90000\r\n"
714  "a=fmtp:%u level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=%02x%02x%02x\r\n"
715  "a=rtcp-fb:%u nack\r\n"
716  "a=rtpmap:%u rtx/90000\r\n"
717  "a=fmtp:%u apt=%u\r\n"
718  "a=ssrc-group:FID %u %u\r\n"
719  "a=ssrc:%u cname:FFmpeg\r\n"
720  "a=ssrc:%u msid:FFmpeg video\r\n",
721  whip->video_payload_type,
723  whip->ice_ufrag_local,
724  whip->ice_pwd_local,
725  whip->dtls_fingerprint,
726  is_dtls_active ? "active" : "passive",
727  whip->video_payload_type,
728  vcodec_name,
729  whip->video_payload_type,
730  profile_idc,
731  profile_iop,
732  level,
733  whip->video_payload_type,
736  whip->video_payload_type,
737  whip->video_ssrc,
738  whip->video_rtx_ssrc,
739  whip->video_ssrc,
740  whip->video_ssrc);
741  }
742 
743  if (!av_bprint_is_complete(&bp)) {
744  av_log(whip, AV_LOG_ERROR, "Offer exceed max %d, %s\n", MAX_SDP_SIZE, bp.str);
745  ret = AVERROR(EIO);
746  goto end;
747  }
748 
749  whip->sdp_offer = av_strdup(bp.str);
750  if (!whip->sdp_offer) {
751  ret = AVERROR(ENOMEM);
752  goto end;
753  }
754 
755  if (whip->state < WHIP_STATE_OFFER)
756  whip->state = WHIP_STATE_OFFER;
758  av_log(whip, AV_LOG_VERBOSE, "Generated state=%d, offer: %s\n", whip->state, whip->sdp_offer);
759 
760 end:
761  av_bprint_finalize(&bp, NULL);
762  return ret;
763 }
764 
765 /**
766  * Exchange SDP offer with WebRTC peer to get the answer.
767  *
768  * @return 0 if OK, AVERROR_xxx on error
769  */
771 {
772  int ret;
773  char buf[MAX_URL_SIZE];
774  AVBPrint bp;
775  WHIPContext *whip = s->priv_data;
776  /* The URL context is an HTTP transport layer for the WHIP protocol. */
777  URLContext *whip_uc = NULL;
779  char *hex_data = NULL;
780  const char *proto_name = avio_find_protocol_name(s->url);
781 
782  /* To prevent a crash during cleanup, always initialize it. */
783  av_bprint_init(&bp, 1, MAX_SDP_SIZE);
784 
785  if (!av_strstart(proto_name, "http", NULL)) {
786  av_log(whip, AV_LOG_ERROR, "Protocol %s is not supported by RTC, choose http, url is %s\n",
787  proto_name, s->url);
788  ret = AVERROR(EINVAL);
789  goto end;
790  }
791 
792  if (!whip->sdp_offer || !strlen(whip->sdp_offer)) {
793  av_log(whip, AV_LOG_ERROR, "No offer to exchange\n");
794  ret = AVERROR(EINVAL);
795  goto end;
796  }
797 
798  ret = snprintf(buf, sizeof(buf), "Cache-Control: no-cache\r\nContent-Type: application/sdp\r\n");
799  if (whip->authorization)
800  ret += snprintf(buf + ret, sizeof(buf) - ret, "Authorization: Bearer %s\r\n", whip->authorization);
801  if (ret <= 0 || ret >= sizeof(buf)) {
802  av_log(whip, AV_LOG_ERROR, "Failed to generate headers, size=%d, %s\n", ret, buf);
803  ret = AVERROR(EINVAL);
804  goto end;
805  }
806 
807  av_dict_set(&opts, "headers", buf, 0);
808  av_dict_set_int(&opts, "chunked_post", 0, 0);
809 
810  if (whip->timeout >= 0)
811  av_dict_set_int(&opts, "timeout", whip->timeout, 0);
812 
813  hex_data = av_mallocz(2 * strlen(whip->sdp_offer) + 1);
814  if (!hex_data) {
815  ret = AVERROR(ENOMEM);
816  goto end;
817  }
818  ff_data_to_hex(hex_data, whip->sdp_offer, strlen(whip->sdp_offer), 0);
819  av_dict_set(&opts, "post_data", hex_data, 0);
820 
821  ret = ffurl_open_whitelist(&whip_uc, s->url, AVIO_FLAG_READ_WRITE, &s->interrupt_callback,
822  &opts, s->protocol_whitelist, s->protocol_blacklist, NULL);
823  if (ret < 0) {
824  av_log(whip, AV_LOG_ERROR, "Failed to request url=%s, offer: %s\n", s->url, whip->sdp_offer);
825  goto end;
826  }
827 
828  if (ff_http_get_new_location(whip_uc)) {
830  if (!whip->whip_resource_url) {
831  ret = AVERROR(ENOMEM);
832  goto end;
833  }
834  }
835 
836  while (1) {
837  ret = ffurl_read(whip_uc, buf, sizeof(buf));
838  if (ret == AVERROR_EOF) {
839  /* Reset the error because we read all response as answer util EOF. */
840  ret = 0;
841  break;
842  }
843  if (ret <= 0) {
844  av_log(whip, AV_LOG_ERROR, "Failed to read response from url=%s, offer is %s, answer is %s\n",
845  s->url, whip->sdp_offer, whip->sdp_answer);
846  goto end;
847  }
848 
849  av_bprintf(&bp, "%.*s", ret, buf);
850  if (!av_bprint_is_complete(&bp)) {
851  av_log(whip, AV_LOG_ERROR, "Answer exceed max size %d, %.*s, %s\n", MAX_SDP_SIZE, ret, buf, bp.str);
852  ret = AVERROR(EIO);
853  goto end;
854  }
855  }
856 
857  if (!av_strstart(bp.str, "v=", NULL)) {
858  av_log(whip, AV_LOG_ERROR, "Invalid answer: %s\n", bp.str);
859  ret = AVERROR(EINVAL);
860  goto end;
861  }
862 
863  whip->sdp_answer = av_strdup(bp.str);
864  if (!whip->sdp_answer) {
865  ret = AVERROR(ENOMEM);
866  goto end;
867  }
868 
869  if (whip->state < WHIP_STATE_ANSWER)
870  whip->state = WHIP_STATE_ANSWER;
871  av_log(whip, AV_LOG_VERBOSE, "Got state=%d, answer: %s\n", whip->state, whip->sdp_answer);
872 
873 end:
874  ffurl_closep(&whip_uc);
875  av_bprint_finalize(&bp, NULL);
876  av_dict_free(&opts);
877  av_freep(&hex_data);
878  return ret;
879 }
880 
881 /**
882  * Parses the ICE ufrag, pwd, and candidates from the SDP answer.
883  *
884  * This function is used to extract the ICE ufrag, pwd, and candidates from the SDP answer.
885  * It returns an error if any of these fields is NULL. The function only uses the first
886  * candidate if there are multiple candidates. However, support for multiple candidates
887  * will be added in the future.
888  *
889  * @param s Pointer to the AVFormatContext
890  * @returns Returns 0 if successful or AVERROR_xxx if an error occurs.
891  */
893 {
894  int ret = 0;
895  AVIOContext *pb;
896  char line[MAX_URL_SIZE];
897  const char *ptr;
898  int i;
899  WHIPContext *whip = s->priv_data;
900 
901  if (!whip->sdp_answer || !strlen(whip->sdp_answer)) {
902  av_log(whip, AV_LOG_ERROR, "No answer to parse\n");
903  return AVERROR(EINVAL);
904  }
905 
906  pb = avio_alloc_context(whip->sdp_answer, strlen(whip->sdp_answer), 0, NULL, NULL, NULL, NULL);
907  if (!pb)
908  return AVERROR(ENOMEM);
909 
910  for (i = 0; !avio_feof(pb); i++) {
911  ff_get_chomp_line(pb, line, sizeof(line));
912  if (av_strstart(line, "a=ice-lite", &ptr))
913  whip->is_peer_ice_lite = 1;
914  if (av_strstart(line, "a=ice-ufrag:", &ptr) && !whip->ice_ufrag_remote) {
915  whip->ice_ufrag_remote = av_strdup(ptr);
916  if (!whip->ice_ufrag_remote) {
917  ret = AVERROR(ENOMEM);
918  goto end;
919  }
920  } else if (av_strstart(line, "a=ice-pwd:", &ptr) && !whip->ice_pwd_remote) {
921  whip->ice_pwd_remote = av_strdup(ptr);
922  if (!whip->ice_pwd_remote) {
923  ret = AVERROR(ENOMEM);
924  goto end;
925  }
926  } else if (av_strstart(line, "a=fingerprint:", &ptr) && !whip->remote_fingerprint) {
927  /* SDP a=fingerprint format is "<algo> <hex:hex:...>". Skip
928  * the algo token, store the hex string for post-handshake compare. */
929  const char *space = strchr(ptr, ' ');
930  if (space) {
931  whip->remote_fingerprint = av_strdup(space + 1);
932  if (!whip->remote_fingerprint) {
933  ret = AVERROR(ENOMEM);
934  goto end;
935  }
936  }
937  } else if (av_strstart(line, "a=candidate:", &ptr) && !whip->ice_protocol) {
938  if (ptr && av_stristr(ptr, "host")) {
939  /* Refer to RFC 5245 15.1 */
940  char foundation[33], protocol[17], host[129];
941  int component_id, priority, port;
942  ret = sscanf(ptr, "%32s %d %16s %d %128s %d typ host", foundation, &component_id, protocol, &priority, host, &port);
943  if (ret != 6) {
944  av_log(whip, AV_LOG_ERROR, "Failed %d to parse line %d %s from %s\n",
945  ret, i, line, whip->sdp_answer);
946  ret = AVERROR(EIO);
947  goto end;
948  }
949 
950  if (av_strcasecmp(protocol, "udp")) {
951  av_log(whip, AV_LOG_ERROR, "Protocol %s is not supported by RTC, choose udp, line %d %s of %s\n",
952  protocol, i, line, whip->sdp_answer);
953  ret = AVERROR(EIO);
954  goto end;
955  }
956 
957  whip->ice_protocol = av_strdup(protocol);
958  whip->ice_host = av_strdup(host);
959  whip->ice_port = port;
960  if (!whip->ice_protocol || !whip->ice_host) {
961  ret = AVERROR(ENOMEM);
962  goto end;
963  }
964  }
965  }
966  }
967 
968  if (!whip->ice_pwd_remote || !strlen(whip->ice_pwd_remote)) {
969  av_log(whip, AV_LOG_ERROR, "No remote ice pwd parsed from %s\n", whip->sdp_answer);
970  ret = AVERROR(EINVAL);
971  goto end;
972  }
973 
974  if (!whip->ice_ufrag_remote || !strlen(whip->ice_ufrag_remote)) {
975  av_log(whip, AV_LOG_ERROR, "No remote ice ufrag parsed from %s\n", whip->sdp_answer);
976  ret = AVERROR(EINVAL);
977  goto end;
978  }
979 
980  if (!whip->ice_protocol || !whip->ice_host || !whip->ice_port) {
981  av_log(whip, AV_LOG_ERROR, "No ice candidate parsed from %s\n", whip->sdp_answer);
982  ret = AVERROR(EINVAL);
983  goto end;
984  }
985 
986  /* per RFC 8829/8842, SDP answer MUST carry a=fingerprint and that
987  * fingerprint MUST match the DTLS peer certificate. Without it, an
988  * on-path attacker can complete DTLS with an arbitrary self-signed
989  * certificate and the resulting SRTP session is unauthenticated. */
990  if (!whip->remote_fingerprint || !strlen(whip->remote_fingerprint)) {
991  av_log(whip, AV_LOG_ERROR,
992  "No remote DTLS fingerprint in SDP answer; refusing unauthenticated session\n");
993  ret = AVERROR(EINVAL);
994  goto end;
995  }
996 
997  if (whip->state < WHIP_STATE_NEGOTIATED)
1000  av_log(whip, AV_LOG_VERBOSE, "SDP state=%d, offer=%zuB, answer=%zuB, ufrag=%s, pwd=%zuB, transport=%s://%s:%d, elapsed=%.2fms\n",
1001  whip->state, strlen(whip->sdp_offer), strlen(whip->sdp_answer), whip->ice_ufrag_remote, strlen(whip->ice_pwd_remote),
1002  whip->ice_protocol, whip->ice_host, whip->ice_port, ELAPSED(whip->whip_starttime, av_gettime_relative()));
1003 
1004 end:
1005  avio_context_free(&pb);
1006  return ret;
1007 }
1008 
1009 /**
1010  * Creates and marshals an ICE binding request packet.
1011  *
1012  * This function creates and marshals an ICE binding request packet. The function only
1013  * generates the username attribute and does not include goog-network-info,
1014  * use-candidate. However, some of these attributes may be added in the future.
1015  *
1016  * @param s Pointer to the AVFormatContext
1017  * @param buf Pointer to memory buffer to store the request packet
1018  * @param buf_size Size of the memory buffer
1019  * @param request_size Pointer to an integer that receives the size of the request packet
1020  * @return Returns 0 if successful or AVERROR_xxx if an error occurs.
1021  */
1022 static int ice_create_request(AVFormatContext *s, uint8_t *buf, int buf_size, int *request_size)
1023 {
1024  int ret, size, crc32;
1025  char username[128];
1026  AVIOContext *pb = NULL;
1027  AVHMAC *hmac = NULL;
1028  WHIPContext *whip = s->priv_data;
1029 
1030  pb = avio_alloc_context(buf, buf_size, 1, NULL, NULL, NULL, NULL);
1031  if (!pb)
1032  return AVERROR(ENOMEM);
1033 
1034  hmac = av_hmac_alloc(AV_HMAC_SHA1);
1035  if (!hmac) {
1036  ret = AVERROR(ENOMEM);
1037  goto end;
1038  }
1039 
1040  /* Write 20 bytes header */
1041  avio_wb16(pb, 0x0001); /* STUN binding request */
1042  avio_wb16(pb, 0); /* length */
1043  avio_wb32(pb, STUN_MAGIC_COOKIE); /* magic cookie */
1044  avio_wb32(pb, av_lfg_get(&whip->rnd)); /* transaction ID */
1045  avio_wb32(pb, av_lfg_get(&whip->rnd)); /* transaction ID */
1046  avio_wb32(pb, av_lfg_get(&whip->rnd)); /* transaction ID */
1047 
1048  /* The username is the concatenation of the two ICE ufrag */
1049  ret = snprintf(username, sizeof(username), "%s:%s", whip->ice_ufrag_remote, whip->ice_ufrag_local);
1050  if (ret <= 0 || ret >= sizeof(username)) {
1051  av_log(whip, AV_LOG_ERROR, "Failed to build username %s:%s, max=%zu, ret=%d\n",
1052  whip->ice_ufrag_remote, whip->ice_ufrag_local, sizeof(username), ret);
1053  ret = AVERROR(EIO);
1054  goto end;
1055  }
1056 
1057  /* Write the username attribute */
1058  avio_wb16(pb, STUN_ATTR_USERNAME); /* attribute type username */
1059  avio_wb16(pb, ret); /* size of username */
1060  avio_write(pb, username, ret); /* bytes of username */
1061  ffio_fill(pb, 0, (4 - (ret % 4)) % 4); /* padding */
1062 
1063  /* Write the use-candidate attribute */
1064  avio_wb16(pb, STUN_ATTR_USE_CANDIDATE); /* attribute type use-candidate */
1065  avio_wb16(pb, 0); /* size of use-candidate */
1066 
1068  avio_wb16(pb, 4);
1070 
1072  avio_wb16(pb, 8);
1073  avio_wb64(pb, whip->ice_tie_breaker);
1074 
1075  /* Build and update message integrity */
1076  avio_wb16(pb, STUN_ATTR_MESSAGE_INTEGRITY); /* attribute type message integrity */
1077  avio_wb16(pb, 20); /* size of message integrity */
1078  ffio_fill(pb, 0, 20); /* fill with zero to directly write and skip it */
1079  size = avio_tell(pb);
1080  buf[2] = (size - 20) >> 8;
1081  buf[3] = (size - 20) & 0xFF;
1082  av_hmac_init(hmac, whip->ice_pwd_remote, strlen(whip->ice_pwd_remote));
1083  av_hmac_update(hmac, buf, size - 24);
1084  av_hmac_final(hmac, buf + size - 20, 20);
1085 
1086  /* Write the fingerprint attribute */
1087  avio_wb16(pb, STUN_ATTR_FINGERPRINT); /* attribute type fingerprint */
1088  avio_wb16(pb, 4); /* size of fingerprint */
1089  ffio_fill(pb, 0, 4); /* fill with zero to directly write and skip it */
1090  size = avio_tell(pb);
1091  buf[2] = (size - 20) >> 8;
1092  buf[3] = (size - 20) & 0xFF;
1093  /* Refer to the av_hash_alloc("CRC32"), av_hash_init and av_hash_final */
1094  crc32 = av_crc(av_crc_get_table(AV_CRC_32_IEEE_LE), 0xFFFFFFFF, buf, size - 8) ^ 0xFFFFFFFF;
1095  avio_skip(pb, -4);
1096  avio_wb32(pb, crc32 ^ 0x5354554E); /* xor with "STUN" */
1097 
1098  *request_size = size;
1099 
1100 end:
1101  avio_context_free(&pb);
1102  av_hmac_free(hmac);
1103  return ret;
1104 }
1105 
1106 /**
1107  * Create an ICE binding response.
1108  *
1109  * This function generates an ICE binding response and writes it to the provided
1110  * buffer. The response is signed using the local password for message integrity.
1111  *
1112  * @param s Pointer to the AVFormatContext structure.
1113  * @param tid Pointer to the transaction ID of the binding request. The tid_size should be 12.
1114  * @param tid_size The size of the transaction ID, should be 12.
1115  * @param buf Pointer to the buffer where the response will be written.
1116  * @param buf_size The size of the buffer provided for the response.
1117  * @param response_size Pointer to an integer that will store the size of the generated response.
1118  * @return Returns 0 if successful or AVERROR_xxx if an error occurs.
1119  */
1120 static int ice_create_response(AVFormatContext *s, char *tid, int tid_size, uint8_t *buf, int buf_size, int *response_size)
1121 {
1122  int ret = 0, size, crc32;
1123  AVIOContext *pb = NULL;
1124  AVHMAC *hmac = NULL;
1125  WHIPContext *whip = s->priv_data;
1126 
1127  if (tid_size != 12) {
1128  av_log(whip, AV_LOG_ERROR, "Invalid transaction ID size. Expected 12, got %d\n", tid_size);
1129  return AVERROR(EINVAL);
1130  }
1131 
1132  pb = avio_alloc_context(buf, buf_size, 1, NULL, NULL, NULL, NULL);
1133  if (!pb)
1134  return AVERROR(ENOMEM);
1135 
1136  hmac = av_hmac_alloc(AV_HMAC_SHA1);
1137  if (!hmac) {
1138  ret = AVERROR(ENOMEM);
1139  goto end;
1140  }
1141 
1142  /* Write 20 bytes header */
1143  avio_wb16(pb, 0x0101); /* STUN binding response */
1144  avio_wb16(pb, 0); /* length */
1145  avio_wb32(pb, STUN_MAGIC_COOKIE); /* magic cookie */
1146  avio_write(pb, tid, tid_size); /* transaction ID */
1147 
1148  /* Build and update message integrity */
1149  avio_wb16(pb, STUN_ATTR_MESSAGE_INTEGRITY); /* attribute type message integrity */
1150  avio_wb16(pb, 20); /* size of message integrity */
1151  ffio_fill(pb, 0, 20); /* fill with zero to directly write and skip it */
1152  size = avio_tell(pb);
1153  buf[2] = (size - 20) >> 8;
1154  buf[3] = (size - 20) & 0xFF;
1155  av_hmac_init(hmac, whip->ice_pwd_local, strlen(whip->ice_pwd_local));
1156  av_hmac_update(hmac, buf, size - 24);
1157  av_hmac_final(hmac, buf + size - 20, 20);
1158 
1159  /* Write the fingerprint attribute */
1160  avio_wb16(pb, STUN_ATTR_FINGERPRINT); /* attribute type fingerprint */
1161  avio_wb16(pb, 4); /* size of fingerprint */
1162  ffio_fill(pb, 0, 4); /* fill with zero to directly write and skip it */
1163  size = avio_tell(pb);
1164  buf[2] = (size - 20) >> 8;
1165  buf[3] = (size - 20) & 0xFF;
1166  /* Refer to the av_hash_alloc("CRC32"), av_hash_init and av_hash_final */
1167  crc32 = av_crc(av_crc_get_table(AV_CRC_32_IEEE_LE), 0xFFFFFFFF, buf, size - 8) ^ 0xFFFFFFFF;
1168  avio_skip(pb, -4);
1169  avio_wb32(pb, crc32 ^ 0x5354554E); /* xor with "STUN" */
1170 
1171  *response_size = size;
1172 
1173 end:
1174  avio_context_free(&pb);
1175  av_hmac_free(hmac);
1176  return ret;
1177 }
1178 
1179 /**
1180  * A Binding request has class=0b00 (request) and method=0b000000000001 (Binding)
1181  * and is encoded into the first 16 bits as 0x0001.
1182  * See https://datatracker.ietf.org/doc/html/rfc5389#section-6
1183  */
1184 static int ice_is_binding_request(uint8_t *b, int size)
1185 {
1186  return size >= ICE_STUN_HEADER_SIZE && AV_RB16(&b[0]) == 0x0001;
1187 }
1188 
1189 /**
1190  * A Binding response has class=0b10 (success response) and method=0b000000000001,
1191  * and is encoded into the first 16 bits as 0x0101.
1192  */
1193 static int ice_is_binding_response(uint8_t *b, int size)
1194 {
1195  return size >= ICE_STUN_HEADER_SIZE && AV_RB16(&b[0]) == 0x0101;
1196 }
1197 
1198 /**
1199  * In RTP packets, the first byte is represented as 0b10xxxxxx, where the initial
1200  * two bits (0b10) indicate the RTP version,
1201  * see https://www.rfc-editor.org/rfc/rfc3550#section-5.1
1202  * The RTCP packet header is similar to RTP,
1203  * see https://www.rfc-editor.org/rfc/rfc3550#section-6.4.1
1204  */
1205 static int media_is_rtp_rtcp(const uint8_t *b, int size)
1206 {
1207  return size >= WHIP_RTP_HEADER_SIZE && (b[0] & 0xC0) == 0x80;
1208 }
1209 
1210 /* Whether the packet is RTCP. */
1211 static int media_is_rtcp(const uint8_t *b, int size)
1212 {
1213  return size >= WHIP_RTP_HEADER_SIZE && b[1] >= WHIP_RTCP_PT_START && b[1] <= WHIP_RTCP_PT_END;
1214 }
1215 
1216 /**
1217  * This function handles incoming binding request messages by responding to them.
1218  * If the message is not a binding request, it will be ignored.
1219  */
1220 static int ice_handle_binding_request(AVFormatContext *s, char *buf, int buf_size)
1221 {
1222  int ret = 0, size;
1223  char tid[12];
1224  WHIPContext *whip = s->priv_data;
1225 
1226  /* Ignore if not a binding request. */
1227  if (!ice_is_binding_request(buf, buf_size))
1228  return ret;
1229 
1230  if (buf_size < ICE_STUN_HEADER_SIZE) {
1231  av_log(whip, AV_LOG_ERROR, "Invalid STUN message, expected at least %d, got %d\n",
1232  ICE_STUN_HEADER_SIZE, buf_size);
1233  return AVERROR(EINVAL);
1234  }
1235 
1236  /* Parse transaction id from binding request in buf. */
1237  memcpy(tid, buf + 8, 12);
1238 
1239  /* Build the STUN binding response. */
1240  ret = ice_create_response(s, tid, sizeof(tid), whip->buf, sizeof(whip->buf), &size);
1241  if (ret < 0) {
1242  av_log(whip, AV_LOG_ERROR, "Failed to create STUN binding response, size=%d\n", size);
1243  return ret;
1244  }
1245 
1246  ret = ffurl_write(whip->udp, whip->buf, size);
1247  if (ret < 0) {
1248  av_log(whip, AV_LOG_ERROR, "Failed to send STUN binding response, size=%d\n", size);
1249  return ret;
1250  }
1251 
1252  return 0;
1253 }
1254 
1255 /**
1256  * To establish a connection with the UDP server, we utilize ICE-LITE in a Client-Server
1257  * mode. In this setup, FFmpeg acts as the UDP client, while the peer functions as the
1258  * UDP server.
1259  */
1261 {
1262  int ret = 0;
1263  char url[256];
1264  AVDictionary *opts = NULL;
1265  WHIPContext *whip = s->priv_data;
1266 
1267  /* Build UDP URL and create the UDP context as transport. */
1268  ff_url_join(url, sizeof(url), "udp", NULL, whip->ice_host, whip->ice_port, NULL);
1269 
1270  av_dict_set_int(&opts, "connect", 1, 0);
1271  av_dict_set_int(&opts, "fifo_size", 0, 0);
1272  /* Pass through the pkt_size and buffer_size to underling protocol */
1273  av_dict_set_int(&opts, "pkt_size", whip->pkt_size, 0);
1274  av_dict_set_int(&opts, "buffer_size", whip->ts_buffer_size, 0);
1275 
1276  ret = ffurl_open_whitelist(&whip->udp, url, AVIO_FLAG_WRITE, &s->interrupt_callback,
1277  &opts, s->protocol_whitelist, s->protocol_blacklist, NULL);
1278  if (ret < 0) {
1279  av_log(whip, AV_LOG_ERROR, "Failed to connect udp://%s:%d\n", whip->ice_host, whip->ice_port);
1280  goto end;
1281  }
1282 
1283  /* Make the socket non-blocking, set to READ and WRITE mode after connected */
1286 
1287  if (whip->state < WHIP_STATE_UDP_CONNECTED)
1290  av_log(whip, AV_LOG_VERBOSE, "UDP state=%d, elapsed=%.2fms, connected to udp://%s:%d\n",
1291  whip->state, ELAPSED(whip->whip_starttime, av_gettime_relative()), whip->ice_host, whip->ice_port);
1292 
1293 end:
1294  av_dict_free(&opts);
1295  return ret;
1296 }
1297 
1299 {
1300  int ret = 0, size, i;
1301  int64_t starttime = av_gettime_relative(), now;
1302  WHIPContext *whip = s->priv_data;
1303  int is_dtls_active = whip->flags & WHIP_DTLS_ACTIVE;
1304 
1305  if (whip->state < WHIP_STATE_UDP_CONNECTED || !whip->udp) {
1306  av_log(whip, AV_LOG_ERROR, "UDP not connected, state=%d, udp=%p\n", whip->state, whip->udp);
1307  return AVERROR(EINVAL);
1308  }
1309 
1310  while (1) {
1311  if (whip->state <= WHIP_STATE_ICE_CONNECTING) {
1312  /* Build the STUN binding request. */
1313  ret = ice_create_request(s, whip->buf, sizeof(whip->buf), &size);
1314  if (ret < 0) {
1315  av_log(whip, AV_LOG_ERROR, "Failed to create STUN binding request, size=%d\n", size);
1316  goto end;
1317  }
1318 
1319  ret = ffurl_write(whip->udp, whip->buf, size);
1320  if (ret < 0) {
1321  av_log(whip, AV_LOG_ERROR, "Failed to send STUN binding request, size=%d\n", size);
1322  goto end;
1323  }
1324 
1325  if (whip->state < WHIP_STATE_ICE_CONNECTING)
1327  }
1328 
1329 next_packet:
1330  if (whip->state >= WHIP_STATE_DTLS_FINISHED)
1331  /* DTLS handshake is done, exit the loop. */
1332  break;
1333 
1334  now = av_gettime_relative();
1335  if (now - starttime >= whip->handshake_timeout * WHIP_US_PER_MS) {
1336  av_log(whip, AV_LOG_ERROR, "DTLS handshake timeout=%dms, cost=%.2fms, elapsed=%.2fms, state=%d\n",
1337  whip->handshake_timeout, ELAPSED(starttime, now), ELAPSED(whip->whip_starttime, now), whip->state);
1338  ret = AVERROR(ETIMEDOUT);
1339  goto end;
1340  }
1341 
1342  /* Read the STUN or DTLS messages from peer. */
1343  for (i = 0; i < ICE_DTLS_READ_MAX_RETRY; i++) {
1344  if (whip->state > WHIP_STATE_ICE_CONNECTED)
1345  break;
1346  ret = ffurl_read(whip->udp, whip->buf, sizeof(whip->buf));
1347  if (ret > 0)
1348  break;
1349  if (ret == AVERROR(EAGAIN)) {
1351  continue;
1352  }
1353  if (is_dtls_active)
1354  break;
1355  av_log(whip, AV_LOG_ERROR, "Failed to read message\n");
1356  goto end;
1357  }
1358 
1359  /* Handle the ICE binding response. */
1360  if (ice_is_binding_response(whip->buf, ret)) {
1361  if (whip->state < WHIP_STATE_ICE_CONNECTED) {
1362  if (whip->is_peer_ice_lite)
1364  }
1365  goto next_packet;
1366  }
1367 
1368  /* When a binding request is received, it is necessary to respond immediately. */
1369  if (ice_is_binding_request(whip->buf, ret)) {
1370  if ((ret = ice_handle_binding_request(s, whip->buf, ret)) < 0)
1371  goto end;
1372  goto next_packet;
1373  }
1374 
1375  /* Handle DTLS handshake */
1376  if (ff_is_dtls_packet(whip->buf, ret) || is_dtls_active) {
1378  /* Start consent timer when ICE selected */
1381  av_log(whip, AV_LOG_VERBOSE, "ICE STUN ok, state=%d, url=udp://%s:%d, location=%s, username=%s:%s, res=%dB, elapsed=%.2fms\n",
1382  whip->state, whip->ice_host, whip->ice_port, whip->whip_resource_url ? whip->whip_resource_url : "",
1384 
1385  ret = dtls_initialize(s);
1386  if (ret < 0)
1387  goto end;
1388  ret = ffurl_handshake(whip->dtls_uc);
1389  if (ret < 0) {
1390  whip->state = WHIP_STATE_FAILED;
1391  av_log(whip, AV_LOG_ERROR, "DTLS session failed\n");
1392  goto end;
1393  }
1394  if (!ret) {
1397  av_log(whip, AV_LOG_VERBOSE, "DTLS handshake is done, elapsed=%.2fms\n",
1398  ELAPSED(whip->whip_starttime, whip->whip_dtls_time));
1399  }
1400  goto next_packet;
1401  }
1402  }
1403 
1404 end:
1405  return ret;
1406 }
1407 
1408 /**
1409  * Establish the SRTP context using the keying material exported from DTLS.
1410  *
1411  * Create separate SRTP contexts for sending video and audio, as their sequences differ
1412  * and should not share a single context. Generate a single SRTP context for receiving
1413  * RTCP only.
1414  *
1415  * @return 0 if OK, AVERROR_xxx on error
1416  */
1418 {
1419  int ret;
1420  char recv_key[DTLS_SRTP_KEY_LEN + DTLS_SRTP_SALT_LEN];
1421  char send_key[DTLS_SRTP_KEY_LEN + DTLS_SRTP_SALT_LEN];
1423  /**
1424  * The profile for OpenSSL's SRTP is SRTP_AES128_CM_SHA1_80, see ssl/d1_srtp.c.
1425  * The profile for FFmpeg's SRTP is SRTP_AES128_CM_HMAC_SHA1_80, see libavformat/srtp.c.
1426  */
1427  const char* suite = "SRTP_AES128_CM_HMAC_SHA1_80";
1428  WHIPContext *whip = s->priv_data;
1429  int is_dtls_active = whip->flags & WHIP_DTLS_ACTIVE;
1430  char *cp = is_dtls_active ? send_key : recv_key;
1431  char *sp = is_dtls_active ? recv_key : send_key;
1432 
1434  if (ret < 0)
1435  goto end;
1436  /**
1437  * This represents the material used to build the SRTP master key. It is
1438  * generated by DTLS and has the following layout:
1439  * 16B 16B 14B 14B
1440  * client_key | server_key | client_salt | server_salt
1441  */
1442  char *client_key = whip->dtls_srtp_materials;
1443  char *server_key = whip->dtls_srtp_materials + DTLS_SRTP_KEY_LEN;
1444  char *client_salt = server_key + DTLS_SRTP_KEY_LEN;
1445  char *server_salt = client_salt + DTLS_SRTP_SALT_LEN;
1446 
1447  memcpy(cp, client_key, DTLS_SRTP_KEY_LEN);
1448  memcpy(cp + DTLS_SRTP_KEY_LEN, client_salt, DTLS_SRTP_SALT_LEN);
1449 
1450  memcpy(sp, server_key, DTLS_SRTP_KEY_LEN);
1451  memcpy(sp + DTLS_SRTP_KEY_LEN, server_salt, DTLS_SRTP_SALT_LEN);
1452 
1453  /* Setup SRTP context for outgoing packets */
1454  if (!av_base64_encode(buf, sizeof(buf), send_key, sizeof(send_key))) {
1455  av_log(whip, AV_LOG_ERROR, "Failed to encode send key\n");
1456  ret = AVERROR(EIO);
1457  goto end;
1458  }
1459 
1460  ret = ff_srtp_set_crypto(&whip->srtp_audio_send, suite, buf);
1461  if (ret < 0) {
1462  av_log(whip, AV_LOG_ERROR, "Failed to set crypto for audio send\n");
1463  goto end;
1464  }
1465 
1466  ret = ff_srtp_set_crypto(&whip->srtp_video_send, suite, buf);
1467  if (ret < 0) {
1468  av_log(whip, AV_LOG_ERROR, "Failed to set crypto for video send\n");
1469  goto end;
1470  }
1471 
1473  if (ret < 0) {
1474  av_log(whip, AV_LOG_ERROR, "Failed to set crypto for video rtx send\n");
1475  goto end;
1476  }
1477 
1478  ret = ff_srtp_set_crypto(&whip->srtp_rtcp_send, suite, buf);
1479  if (ret < 0) {
1480  av_log(whip, AV_LOG_ERROR, "Failed to set crypto for rtcp send\n");
1481  goto end;
1482  }
1483 
1484  /* Setup SRTP context for incoming packets */
1485  if (!av_base64_encode(buf, sizeof(buf), recv_key, sizeof(recv_key))) {
1486  av_log(whip, AV_LOG_ERROR, "Failed to encode recv key\n");
1487  ret = AVERROR(EIO);
1488  goto end;
1489  }
1490 
1491  ret = ff_srtp_set_crypto(&whip->srtp_recv, suite, buf);
1492  if (ret < 0) {
1493  av_log(whip, AV_LOG_ERROR, "Failed to set crypto for recv\n");
1494  goto end;
1495  }
1496 
1497  if (whip->state < WHIP_STATE_SRTP_FINISHED)
1500  av_log(whip, AV_LOG_VERBOSE, "SRTP setup done, state=%d, suite=%s, key=%zuB, elapsed=%.2fms\n",
1501  whip->state, suite, sizeof(send_key), ELAPSED(whip->whip_starttime, av_gettime_relative()));
1502 
1503 end:
1504  return ret;
1505 }
1506 
1507 static int rtp_history_store(WHIPContext *whip, const uint8_t *buf, int size)
1508 {
1509  uint16_t seq = AV_RB16(buf + 2);
1510  uint32_t pos = ((uint32_t)seq - (uint32_t)whip->video_first_seq) % (uint32_t)whip->hist_sz;
1511  RtpHistoryItem *it = &whip->hist[pos];
1512  if (size > whip->pkt_size - DTLS_SRTP_CHECKSUM_LEN)
1513  return AVERROR_INVALIDDATA;
1514  memcpy(it->buf, buf, size);
1515  it->size = size;
1516  it->seq = seq;
1517 
1518  whip->hist_head = ++pos;
1519  return 0;
1520 }
1521 
1522 static const RtpHistoryItem *rtp_history_find(WHIPContext *whip, uint16_t seq)
1523 {
1524  uint32_t pos = ((uint32_t)seq - (uint32_t)whip->video_first_seq) % (uint32_t)whip->hist_sz;
1525  const RtpHistoryItem *it = &whip->hist[pos];
1526  return it->seq == seq ? it : NULL;
1527 }
1528 
1529 /**
1530  * Callback triggered by the RTP muxer when it creates and sends out an RTP packet.
1531  *
1532  * This function modifies the video STAP packet, removing the markers, and updating the
1533  * NRI of the first NALU. Additionally, it uses the corresponding SRTP context to encrypt
1534  * the RTP packet, where the video packet is handled by the video SRTP context.
1535  */
1536 static int on_rtp_write_packet(void *opaque, const uint8_t *buf, int buf_size)
1537 {
1538  int ret, cipher_size, is_rtcp, is_video;
1539  uint8_t payload_type;
1540  AVFormatContext *s = opaque;
1541  WHIPContext *whip = s->priv_data;
1542  SRTPContext *srtp;
1543 
1544  /* Ignore if not RTP or RTCP packet. */
1545  if (!media_is_rtp_rtcp(buf, buf_size))
1546  return 0;
1547 
1548  /* Only support audio, video and rtcp. */
1549  is_rtcp = media_is_rtcp(buf, buf_size);
1550  payload_type = buf[1] & 0x7f;
1551  is_video = payload_type == whip->video_payload_type;
1552  if (!is_rtcp && payload_type != whip->video_payload_type && payload_type != whip->audio_payload_type)
1553  return 0;
1554 
1555  /* Get the corresponding SRTP context. */
1556  srtp = is_rtcp ? &whip->srtp_rtcp_send : (is_video? &whip->srtp_video_send : &whip->srtp_audio_send);
1557 
1558  /* Encrypt by SRTP and send out. */
1559  cipher_size = ff_srtp_encrypt(srtp, buf, buf_size, whip->buf, sizeof(whip->buf));
1560  if (cipher_size <= 0 || cipher_size < buf_size) {
1561  av_log(whip, AV_LOG_WARNING, "Failed to encrypt packet=%dB, cipher=%dB\n", buf_size, cipher_size);
1562  return 0;
1563  }
1564 
1565  if (is_video) {
1566  ret = rtp_history_store(whip, buf, buf_size);
1567  if (ret < 0)
1568  return ret;
1569  }
1570 
1571  ret = ffurl_write(whip->udp, whip->buf, cipher_size);
1572  if (ret < 0) {
1573  av_log(whip, AV_LOG_ERROR, "Failed to write packet=%dB, ret=%d\n", cipher_size, ret);
1574  return ret;
1575  }
1576 
1577  return ret;
1578 }
1579 
1580 /**
1581  * Creates dedicated RTP muxers for each stream in the AVFormatContext to build RTP
1582  * packets from the encoded frames.
1583  *
1584  * The corresponding SRTP context is utilized to encrypt each stream's RTP packets. For
1585  * example, a video SRTP context is used for the video stream. Additionally, the
1586  * "on_rtp_write_packet" callback function is set as the write function for each RTP
1587  * muxer to send out encrypted RTP packets.
1588  *
1589  * @return 0 if OK, AVERROR_xxx on error
1590  */
1592 {
1593  int ret, i, is_video, buffer_size, max_packet_size;
1594  AVFormatContext *rtp_ctx = NULL;
1595  AVDictionary *opts = NULL;
1596  uint8_t *buffer = NULL;
1597  WHIPContext *whip = s->priv_data;
1598  whip->udp->flags |= AVIO_FLAG_NONBLOCK;
1599 
1600 
1601  /* The UDP buffer size, may greater than MTU. */
1602  buffer_size = MAX_UDP_BUFFER_SIZE;
1603  /* The RTP payload max size. Reserved some bytes for SRTP checksum and padding. */
1604  max_packet_size = whip->pkt_size - DTLS_SRTP_CHECKSUM_LEN;
1605 
1606  for (i = 0; i < s->nb_streams; i++) {
1607  rtp_ctx = avformat_alloc_context();
1608  if (!rtp_ctx) {
1609  ret = AVERROR(ENOMEM);
1610  goto end;
1611  }
1612 
1614  rtp_ctx->oformat = &ff_rtp_muxer.p;
1615  if (!avformat_new_stream(rtp_ctx, NULL)) {
1616  ret = AVERROR(ENOMEM);
1617  goto end;
1618  }
1619  /* Pass the interrupt callback on */
1620  rtp_ctx->interrupt_callback = s->interrupt_callback;
1621  /* Copy the max delay setting; the rtp muxer reads this. */
1622  rtp_ctx->max_delay = s->max_delay;
1623  /* Copy other stream parameters. */
1624  rtp_ctx->streams[0]->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
1625  rtp_ctx->flags |= s->flags & AVFMT_FLAG_BITEXACT;
1626  rtp_ctx->strict_std_compliance = s->strict_std_compliance;
1627 
1628  /* Set the synchronized start time. */
1629  rtp_ctx->start_time_realtime = s->start_time_realtime;
1630 
1631  avcodec_parameters_copy(rtp_ctx->streams[0]->codecpar, s->streams[i]->codecpar);
1632  rtp_ctx->streams[0]->time_base = s->streams[i]->time_base;
1633 
1634  /**
1635  * For H.264, consistently utilize the annexb format through the Bitstream Filter (BSF);
1636  * therefore, we deactivate the extradata detection for the RTP muxer.
1637  */
1638  if (s->streams[i]->codecpar->codec_id == AV_CODEC_ID_H264) {
1639  av_freep(&rtp_ctx->streams[0]->codecpar->extradata);
1640  rtp_ctx->streams[0]->codecpar->extradata_size = 0;
1641  }
1642 
1643  buffer = av_malloc(buffer_size);
1644  if (!buffer) {
1645  ret = AVERROR(ENOMEM);
1646  goto end;
1647  }
1648 
1649  rtp_ctx->pb = avio_alloc_context(buffer, buffer_size, 1, s, NULL, on_rtp_write_packet, NULL);
1650  if (!rtp_ctx->pb) {
1651  ret = AVERROR(ENOMEM);
1652  goto end;
1653  }
1654  rtp_ctx->pb->max_packet_size = max_packet_size;
1655  rtp_ctx->pb->av_class = &ff_avio_class;
1656 
1657  is_video = s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
1658  av_dict_set_int(&opts, "payload_type", is_video ? whip->video_payload_type : whip->audio_payload_type, 0);
1659  av_dict_set_int(&opts, "ssrc", is_video ? whip->video_ssrc : whip->audio_ssrc, 0);
1660  av_dict_set_int(&opts, "seq", is_video ? whip->video_first_seq : whip->audio_first_seq, 0);
1661 
1662  ret = avformat_write_header(rtp_ctx, &opts);
1663  if (ret < 0) {
1664  av_log(whip, AV_LOG_ERROR, "Failed to write rtp header\n");
1665  goto end;
1666  }
1667 
1668  ff_format_set_url(rtp_ctx, av_strdup(s->url));
1669  s->streams[i]->time_base = rtp_ctx->streams[0]->time_base;
1670  s->streams[i]->priv_data = rtp_ctx;
1671  rtp_ctx = NULL;
1672  }
1673 
1674  if (whip->state < WHIP_STATE_READY)
1675  whip->state = WHIP_STATE_READY;
1676  av_log(whip, AV_LOG_INFO, "Muxer state=%d, buffer_size=%d, max_packet_size=%d, "
1677  "elapsed=%.2fms(init:%.2f,offer:%.2f,answer:%.2f,udp:%.2f,ice:%.2f,dtls:%.2f,srtp:%.2f)\n",
1678  whip->state, buffer_size, max_packet_size, ELAPSED(whip->whip_starttime, av_gettime_relative()),
1679  ELAPSED(whip->whip_starttime, whip->whip_init_time),
1680  ELAPSED(whip->whip_init_time, whip->whip_offer_time),
1682  ELAPSED(whip->whip_answer_time, whip->whip_udp_time),
1683  ELAPSED(whip->whip_udp_time, whip->whip_ice_time),
1684  ELAPSED(whip->whip_ice_time, whip->whip_dtls_time),
1685  ELAPSED(whip->whip_dtls_time, whip->whip_srtp_time));
1686 
1687 end:
1688  if (rtp_ctx) {
1689  if (!rtp_ctx->pb)
1690  av_freep(&buffer);
1691  avio_context_free(&rtp_ctx->pb);
1692  }
1693  avformat_free_context(rtp_ctx);
1694  av_dict_free(&opts);
1695  return ret;
1696 }
1697 
1698 /**
1699  * RTC is connectionless, for it's based on UDP, so it check whether sesison is
1700  * timeout. In such case, publishers can't republish the stream util the session
1701  * is timeout.
1702  * This function is called to notify the server that the stream is ended, server
1703  * should expire and close the session immediately, so that publishers can republish
1704  * the stream quickly.
1705  */
1707 {
1708  int ret;
1709  char buf[MAX_URL_SIZE];
1710  URLContext *whip_uc = NULL;
1711  AVDictionary *opts = NULL;
1712  WHIPContext *whip = s->priv_data;
1713 
1714  if (!whip->whip_resource_url)
1715  return 0;
1716 
1717  ret = snprintf(buf, sizeof(buf), "Cache-Control: no-cache\r\n");
1718  if (whip->authorization)
1719  ret += snprintf(buf + ret, sizeof(buf) - ret, "Authorization: Bearer %s\r\n", whip->authorization);
1720  if (ret <= 0 || ret >= sizeof(buf)) {
1721  av_log(whip, AV_LOG_ERROR, "Failed to generate headers, size=%d, %s\n", ret, buf);
1722  ret = AVERROR(EINVAL);
1723  goto end;
1724  }
1725 
1726  av_dict_set(&opts, "headers", buf, 0);
1727  av_dict_set_int(&opts, "chunked_post", 0, 0);
1728  av_dict_set(&opts, "method", "DELETE", 0);
1729 
1730  if (whip->timeout >= 0)
1731  av_dict_set_int(&opts, "timeout", whip->timeout, 0);
1732 
1733  ret = ffurl_open_whitelist(&whip_uc, whip->whip_resource_url, AVIO_FLAG_READ_WRITE, &s->interrupt_callback,
1734  &opts, s->protocol_whitelist, s->protocol_blacklist, NULL);
1735  if (ret < 0) {
1736  av_log(whip, AV_LOG_ERROR, "Failed to DELETE url=%s\n", whip->whip_resource_url);
1737  goto end;
1738  }
1739 
1740  while (1) {
1741  ret = ffurl_read(whip_uc, buf, sizeof(buf));
1742  if (ret == AVERROR_EOF) {
1743  ret = 0;
1744  break;
1745  }
1746  if (ret < 0) {
1747  av_log(whip, AV_LOG_ERROR, "Failed to read response from DELETE url=%s\n", whip->whip_resource_url);
1748  goto end;
1749  }
1750  }
1751 
1752  av_log(whip, AV_LOG_INFO, "Dispose resource %s ok\n", whip->whip_resource_url);
1753 
1754 end:
1755  ffurl_closep(&whip_uc);
1756  av_dict_free(&opts);
1757  return ret;
1758 }
1759 
1760 /**
1761  * Since the h264_mp4toannexb filter only processes the MP4 ISOM format and bypasses
1762  * the annexb format, it is necessary to manually insert encoder metadata before each
1763  * IDR when dealing with annexb format packets. For instance, in the case of H.264,
1764  * we must insert SPS and PPS before the IDR frame.
1765  */
1767 {
1768  int ret = 0;
1769  AVPacket *in = NULL;
1770  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
1771  uint32_t nal_size = 0, out_size = par ? par->extradata_size : 0;
1772  uint8_t unit_type, sps_seen = 0, pps_seen = 0, idr_seen = 0, *out;
1773  const uint8_t *buf, *buf_end, *r1;
1774 
1775  if (!par || !par->extradata || par->extradata_size <= 0)
1776  return ret;
1777 
1778  /* Discover NALU type from packet. */
1779  buf_end = pkt->data + pkt->size;
1780  for (buf = ff_nal_find_startcode(pkt->data, buf_end); buf < buf_end; buf += nal_size) {
1781  while (!*(buf++));
1782  r1 = ff_nal_find_startcode(buf, buf_end);
1783  if ((nal_size = r1 - buf) > 0) {
1784  unit_type = *buf & 0x1f;
1785  if (unit_type == H264_NAL_SPS) {
1786  sps_seen = 1;
1787  } else if (unit_type == H264_NAL_PPS) {
1788  pps_seen = 1;
1789  } else if (unit_type == H264_NAL_IDR_SLICE) {
1790  idr_seen = 1;
1791  }
1792 
1793  out_size += 3 + nal_size;
1794  }
1795  }
1796 
1797  if (!idr_seen || (sps_seen && pps_seen))
1798  return ret;
1799 
1800  /* See av_bsf_send_packet */
1801  in = av_packet_alloc();
1802  if (!in)
1803  return AVERROR(ENOMEM);
1804 
1806  if (ret < 0)
1807  goto fail;
1808 
1809  av_packet_move_ref(in, pkt);
1810 
1811  /* Create a new packet with sps/pps inserted. */
1813  if (ret < 0)
1814  goto fail;
1815 
1816  ret = av_packet_copy_props(pkt, in);
1817  if (ret < 0)
1818  goto fail;
1819 
1820  memcpy(pkt->data, par->extradata, par->extradata_size);
1821  out = pkt->data + par->extradata_size;
1822  buf_end = in->data + in->size;
1823  for (buf = ff_nal_find_startcode(in->data, buf_end); buf < buf_end; buf += nal_size) {
1824  while (!*(buf++));
1825  r1 = ff_nal_find_startcode(buf, buf_end);
1826  if ((nal_size = r1 - buf) > 0) {
1827  AV_WB24(out, 0x00001);
1828  memcpy(out + 3, buf, nal_size);
1829  out += 3 + nal_size;
1830  }
1831  }
1832 
1833 fail:
1834  if (ret < 0)
1836  av_packet_free(&in);
1837 
1838  return ret;
1839 }
1840 
1842 {
1843  int ret;
1844  WHIPContext *whip = s->priv_data;
1845 
1846  if ((ret = initialize(s)) < 0)
1847  goto end;
1848 
1849  if ((ret = parse_codec(s)) < 0)
1850  goto end;
1851 
1852  if ((ret = generate_sdp_offer(s)) < 0)
1853  goto end;
1854 
1855  if ((ret = exchange_sdp(s)) < 0)
1856  goto end;
1857 
1858  if ((ret = parse_answer(s)) < 0)
1859  goto end;
1860 
1861  if ((ret = udp_connect(s)) < 0)
1862  goto end;
1863 
1864  if ((ret = ice_dtls_handshake(s)) < 0)
1865  goto end;
1866 
1867  if ((ret = setup_srtp(s)) < 0)
1868  goto end;
1869 
1870  if ((ret = create_rtp_muxer(s)) < 0)
1871  goto end;
1872 
1873 end:
1874  if (ret < 0)
1875  whip->state = WHIP_STATE_FAILED;
1876  return ret;
1877 }
1878 
1879 /**
1880  * See https://datatracker.ietf.org/doc/html/rfc4588#section-4
1881  * Create RTX packet and send it out.
1882  */
1883 static void handle_rtx_packet(AVFormatContext *s, uint16_t seq)
1884 {
1885  int ret = -1;
1886  WHIPContext *whip = s->priv_data;
1887  uint8_t *ori_buf, rtx_buf[MAX_UDP_BUFFER_SIZE] = { 0 };
1888  int ori_size, rtx_size, cipher_size;
1889  uint16_t ori_seq;
1890  const RtpHistoryItem *it = rtp_history_find(whip, seq);
1891  uint16_t latest_seq = whip->hist[(whip->hist_head - 1 + whip->hist_sz) % whip->hist_sz].seq;
1892 
1893  if (!it) {
1894  av_log(whip, AV_LOG_DEBUG,
1895  "RTP history packet seq=%"PRIu16" not found, latest seq=%"PRIu16"\n",
1896  seq, latest_seq);
1897  return;
1898  }
1899  av_log(whip, AV_LOG_DEBUG,
1900  "Found RTP history packet for RTX, seq=%"PRIu16", latest seq=%"PRIu16"\n",
1901  seq, latest_seq);
1902 
1903  ori_buf = it->buf;
1904  ori_size = it->size;
1905 
1906  /* A valid RTP packet must have at least a RTP header. */
1907  if (ori_size < WHIP_RTP_HEADER_SIZE) {
1908  av_log(whip, AV_LOG_WARNING, "RTX history packet too small, size=%d\n", ori_size);
1909  goto end;
1910  }
1911 
1912  /* RTX packet format: header + original seq (2 bytes) + payload */
1913  if (ori_size + 2 > sizeof(rtx_buf)) {
1914  av_log(whip, AV_LOG_WARNING, "RTX packet is too large, size=%d\n", ori_size);
1915  goto end;
1916  }
1917 
1918  memcpy(rtx_buf, ori_buf, ori_size);
1919  ori_seq = AV_RB16(rtx_buf + 2);
1920 
1921  /* rewrite RTX packet header */
1922  rtx_buf[1] = (rtx_buf[1] & 0x80) | whip->video_rtx_payload_type; /* keep M bit */
1923  AV_WB16(rtx_buf + 2, whip->video_rtx_seq++);
1924  AV_WB32(rtx_buf + 8, whip->video_rtx_ssrc);
1925 
1926  /* shift payload 2 bytes to write the original seq number */
1927  memmove(rtx_buf + 12 + 2, rtx_buf + 12, ori_size - 12);
1928  AV_WB16(rtx_buf + 12, ori_seq);
1929 
1930  rtx_size = ori_size + 2;
1931  cipher_size = ff_srtp_encrypt(&whip->srtp_video_rtx_send,
1932  rtx_buf, rtx_size,
1933  whip->buf, sizeof(whip->buf));
1934  if (cipher_size <= 0) {
1935  av_log(whip, AV_LOG_WARNING,
1936  "Failed to encrypt RTX packet, size=%d, cipher_size=%d\n",
1937  rtx_size, cipher_size);
1938  goto end;
1939  }
1940  ret = ffurl_write(whip->udp, whip->buf, cipher_size);
1941 end:
1942  if (ret < 0)
1943  av_log(whip, AV_LOG_WARNING, "Failed to send RTX packet, skip this one\n");
1944 }
1945 
1947 {
1948  int ret, i = 0;
1949  WHIPContext *whip = s->priv_data;
1950  uint8_t *buf = NULL;
1951  int rtcp_len, srtcp_len, header_len = 12/*RFC 4585 6.1*/;
1952  uint32_t ssrc;
1953 
1954  /**
1955  * Refer to RFC 3550 6.4.1
1956  * The length of this RTCP packet in 32 bit words minus one,
1957  * including the header and any padding.
1958  */
1959  rtcp_len = (AV_RB16(&whip->buf[2]) + 1) * 4;
1960  if (rtcp_len <= header_len) {
1961  av_log(whip, AV_LOG_WARNING, "NACK packet is broken, size: %d\n", rtcp_len);
1962  goto error;
1963  }
1964  /* SRTCP index(4 bytes) + HMAC(SRTP_ARS128_CM_SHA1_80) 10bytes */
1965  srtcp_len = rtcp_len + 4 + 10;
1966  if (srtcp_len != size) {
1967  av_log(whip, AV_LOG_WARNING, "NACK packet size not match, srtcp_len:%d, size:%d\n", srtcp_len, size);
1968  goto error;
1969  }
1970  buf = av_memdup(whip->buf, srtcp_len);
1971  if (!buf)
1972  goto error;
1973  if ((ret = ff_srtp_decrypt(&whip->srtp_recv, buf, &srtcp_len)) < 0) {
1974  av_log(whip, AV_LOG_WARNING, "NACK packet decrypt failed: %d\n", ret);
1975  goto error;
1976  }
1977  ssrc = AV_RB32(&buf[8]);
1978  if (ssrc != whip->video_ssrc) {
1979  av_log(whip, AV_LOG_DEBUG,
1980  "NACK packet SSRC: %"PRIu32" not match with video track SSRC: %"PRIu32"\n",
1981  ssrc, whip->video_ssrc);
1982  goto end;
1983  }
1984  while (header_len + i + 4 <= rtcp_len) {
1985  /**
1986  * See https://datatracker.ietf.org/doc/html/rfc4585#section-6.1
1987  * Handle multi NACKs in bundled packet.
1988  */
1989  uint16_t pid = AV_RB16(&buf[12 + i]);
1990  uint16_t blp = AV_RB16(&buf[14 + i]);
1991 
1992  handle_rtx_packet(s, pid);
1993  /* retransmit pid + any bit set in blp */
1994  for (int bit = 0; bit < 16; bit++) {
1995  uint16_t seq = pid + bit + 1;
1996  if (!blp)
1997  break;
1998  if (!(blp & (1 << bit)))
1999  continue;
2000 
2001  handle_rtx_packet(s, seq);
2002  }
2003  i += 4;
2004  }
2005  goto end;
2006 error:
2007  av_log(whip, AV_LOG_WARNING, "Failed to handle NACK and RTX, Skip...\n");
2008 end:
2009  av_freep(&buf);
2010 }
2011 
2013 {
2014  int ret;
2015  WHIPContext *whip = s->priv_data;
2016  AVStream *st = s->streams[pkt->stream_index];
2017  AVFormatContext *rtp_ctx = st->priv_data;
2018  int64_t now = av_gettime_relative();
2019  /**
2020  * Refer to RFC 7675
2021  * Periodically send Consent Freshness STUN Binding Request
2022  */
2024  int size;
2025  ret = ice_create_request(s, whip->buf, sizeof(whip->buf), &size);
2026  if (ret < 0) {
2027  av_log(whip, AV_LOG_ERROR, "Failed to create STUN binding request, size=%d\n", size);
2028  goto end;
2029  }
2030  ret = ffurl_write(whip->udp, whip->buf, size);
2031  if (ret < 0) {
2032  av_log(whip, AV_LOG_ERROR, "Failed to send STUN binding request, size=%d\n", size);
2033  goto end;
2034  }
2035  whip->whip_last_consent_tx_time = now;
2036  av_log(whip, AV_LOG_DEBUG, "Consent Freshness check sent\n");
2037  }
2038 
2039  /**
2040  * Receive packets from the server such as ICE binding requests, DTLS messages,
2041  * and RTCP like PLI requests, then respond to them.
2042  */
2043  ret = ffurl_read(whip->udp, whip->buf, sizeof(whip->buf));
2044  if (ret < 0) {
2045  if (ret == AVERROR(EAGAIN))
2046  goto write_packet;
2047  av_log(whip, AV_LOG_ERROR, "Failed to read from UDP socket\n");
2048  goto end;
2049  }
2050  if (!ret) {
2051  av_log(whip, AV_LOG_ERROR, "Receive EOF from UDP socket\n");
2052  goto end;
2053  }
2054  if (ice_is_binding_response(whip->buf, ret)) {
2056  av_log(whip, AV_LOG_DEBUG, "Consent Freshness check received\n");
2057  }
2058  if (ff_is_dtls_packet(whip->buf, ret)) {
2059  if ((ret = ffurl_write(whip->dtls_uc, whip->buf, ret)) < 0) {
2060  av_log(whip, AV_LOG_ERROR, "Failed to handle DTLS message\n");
2061  goto end;
2062  }
2063  }
2064  if (media_is_rtcp(whip->buf, ret)) {
2065  uint8_t fmt = whip->buf[0] & 0x1f;
2066  uint8_t pt = whip->buf[1];
2067  /**
2068  * Handle RTCP NACK packet
2069  * Refer to RFC 4585 6.2.1
2070  * The Generic NACK message is identified by PT=RTPFB and FMT=1
2071  */
2072  if (pt != RTCP_RTPFB)
2073  goto write_packet;
2074  if (fmt == 1)
2075  handle_nack_rtx(s, ret);
2076  }
2077 write_packet:
2078  now = av_gettime_relative();
2080  av_log(whip, AV_LOG_ERROR,
2081  "Consent Freshness expired after %.2fms (limited %dms), terminate session\n",
2083  ret = AVERROR(ETIMEDOUT);
2084  goto end;
2085  }
2087  if ((ret = h264_annexb_insert_sps_pps(s, pkt)) < 0) {
2088  av_log(whip, AV_LOG_ERROR, "Failed to insert SPS/PPS before IDR\n");
2089  goto end;
2090  }
2091  }
2092 
2093  ret = ff_write_chained(rtp_ctx, 0, pkt, s, 0);
2094  if (ret < 0) {
2095  if (ret == AVERROR(EINVAL)) {
2096  av_log(whip, AV_LOG_WARNING, "Ignore failed to write packet=%dB, ret=%d\n", pkt->size, ret);
2097  ret = 0;
2098  } else if (ret == AVERROR(EAGAIN)) {
2099  av_log(whip, AV_LOG_ERROR, "UDP send blocked, please increase the buffer via -ts_buffer_size\n");
2100  } else
2101  av_log(whip, AV_LOG_ERROR, "Failed to write packet, size=%d, ret=%d\n", pkt->size, ret);
2102  goto end;
2103  }
2104 
2105 end:
2106  if (ret < 0)
2107  whip->state = WHIP_STATE_FAILED;
2108  return ret;
2109 }
2110 
2112 {
2113  int i, ret;
2114  WHIPContext *whip = s->priv_data;
2115 
2116  ret = dispose_session(s);
2117  if (ret < 0)
2118  av_log(whip, AV_LOG_WARNING, "Failed to dispose resource, ret=%d\n", ret);
2119 
2120  for (i = 0; i < s->nb_streams; i++) {
2121  AVFormatContext* rtp_ctx = s->streams[i]->priv_data;
2122  if (!rtp_ctx)
2123  continue;
2124 
2125  av_write_trailer(rtp_ctx);
2126  /**
2127  * Keep in mind that it is necessary to free the buffer of pb since we allocate
2128  * it and pass it to pb using avio_alloc_context, while avio_context_free does
2129  * not perform this action.
2130  */
2131  av_freep(&rtp_ctx->pb->buffer);
2132  avio_context_free(&rtp_ctx->pb);
2133  avformat_free_context(rtp_ctx);
2134  s->streams[i]->priv_data = NULL;
2135  }
2136 
2137  av_freep(&whip->hist_pool);
2138  av_freep(&whip->hist);
2139  av_freep(&whip->sdp_offer);
2140  av_freep(&whip->sdp_answer);
2141  av_freep(&whip->whip_resource_url);
2142  av_freep(&whip->ice_ufrag_remote);
2143  av_freep(&whip->ice_pwd_remote);
2144  av_freep(&whip->ice_protocol);
2145  av_freep(&whip->ice_host);
2146  av_freep(&whip->authorization);
2147  av_freep(&whip->cert_file);
2148  av_freep(&whip->key_file);
2149  ff_srtp_free(&whip->srtp_audio_send);
2150  ff_srtp_free(&whip->srtp_video_send);
2152  ff_srtp_free(&whip->srtp_rtcp_send);
2153  ff_srtp_free(&whip->srtp_recv);
2154  ffurl_closep(&whip->dtls_uc);
2155  ffurl_closep(&whip->udp);
2156  av_freep(&whip->dtls_fingerprint);
2157  av_freep(&whip->remote_fingerprint);
2158 }
2159 
2161 {
2162  int ret = 1, extradata_isom = 0;
2163  uint8_t *b = pkt->data;
2164  WHIPContext *whip = s->priv_data;
2165 
2166  if (st->codecpar->codec_id == AV_CODEC_ID_H264) {
2167  extradata_isom = st->codecpar->extradata_size > 0 && st->codecpar->extradata[0] == 1;
2168  if (pkt->size >= 5 && AV_RB32(b) != 0x0000001 && (AV_RB24(b) != 0x000001 || extradata_isom)) {
2169  ret = ff_stream_add_bitstream_filter(st, "h264_mp4toannexb", NULL);
2170  av_log(whip, AV_LOG_VERBOSE, "Enable BSF h264_mp4toannexb, packet=[%x %x %x %x %x ...], extradata_isom=%d\n",
2171  b[0], b[1], b[2], b[3], b[4], extradata_isom);
2172  } else
2173  whip->h264_annexb_insert_sps_pps = 1;
2174  }
2175 
2176  return ret;
2177 }
2178 
2179 #define OFFSET(x) offsetof(WHIPContext, x)
2180 #define ENC AV_OPT_FLAG_ENCODING_PARAM
2181 static const AVOption options[] = {
2182  { "handshake_timeout", "Timeout in milliseconds for ICE and DTLS handshake.", OFFSET(handshake_timeout), AV_OPT_TYPE_INT, { .i64 = 5000 }, -1, INT_MAX, ENC },
2183  { "timeout", "Set timeout for socket I/O operations", OFFSET(timeout), AV_OPT_TYPE_DURATION, { .i64 = -1 }, -1, INT_MAX, ENC },
2184  { "pkt_size", "The maximum size, in bytes, of RTP packets that send out", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = 1200 }, -1, INT_MAX, ENC },
2185  { "ts_buffer_size", "The buffer size, in bytes, of underlying protocol", OFFSET(ts_buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, ENC },
2186  { "whip_flags", "Set flags affecting WHIP connection behavior", OFFSET(flags), AV_OPT_TYPE_FLAGS, { .i64 = 0}, 0, UINT_MAX, ENC, .unit = "flags" },
2187  { "dtls_active", "Set dtls role as active", 0, AV_OPT_TYPE_CONST, { .i64 = WHIP_DTLS_ACTIVE}, 0, UINT_MAX, ENC, .unit = "flags" },
2188  { "rtp_history", "The number of RTP history items to store", OFFSET(hist_sz), AV_OPT_TYPE_INT, { .i64 = WHIP_RTP_HISTORY_DEFAULT }, WHIP_RTP_HISTORY_MIN, WHIP_RTP_HISTORY_MAX, ENC },
2189  { "authorization", "The optional Bearer token for WHIP Authorization", OFFSET(authorization), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, ENC },
2190  { "cert_file", "The optional certificate file path for DTLS", OFFSET(cert_file), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, ENC },
2191  { "key_file", "The optional private key file path for DTLS", OFFSET(key_file), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, ENC },
2192  { NULL },
2193 };
2194 
2195 static const AVClass whip_muxer_class = {
2196  .class_name = "WHIP muxer",
2197  .item_name = av_default_item_name,
2198  .option = options,
2199  .version = LIBAVUTIL_VERSION_INT,
2200 };
2201 
2203  .p.name = "whip",
2204  .p.long_name = NULL_IF_CONFIG_SMALL("WHIP(WebRTC-HTTP ingestion protocol) muxer"),
2205  .p.audio_codec = AV_CODEC_ID_OPUS,
2206  .p.video_codec = AV_CODEC_ID_H264,
2207  .p.subtitle_codec = AV_CODEC_ID_NONE,
2209  .p.priv_class = &whip_muxer_class,
2211  .priv_data_size = sizeof(WHIPContext),
2212  .init = whip_init,
2214  .deinit = whip_deinit,
2216 };
error
static void error(const char *err)
Definition: target_bsf_fuzzer.c:32
flags
const SwsFlags flags[]
Definition: swscale.c:77
H264SPS
Definition: avc.h:32
WHIPContext::whip_udp_time
int64_t whip_udp_time
Definition: whip.c:281
on_rtp_write_packet
static int on_rtp_write_packet(void *opaque, const uint8_t *buf, int buf_size)
Callback triggered by the RTP muxer when it creates and sends out an RTP packet.
Definition: whip.c:1536
ff_get_chomp_line
int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen)
Same as ff_get_line but strip the white-space characters in the text tail.
Definition: aviobuf.c:789
AVHMAC
Definition: hmac.c:40
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: packet.c:433
av_gettime_relative
int64_t av_gettime_relative(void)
Get the current time in microseconds since some unspecified starting point.
Definition: time.c:56
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:216
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:71
level
uint8_t level
Definition: svq3.c:208
whip_deinit
static av_cold void whip_deinit(AVFormatContext *s)
Definition: whip.c:2111
rtp_history_store
static int rtp_history_store(WHIPContext *whip, const uint8_t *buf, int size)
Definition: whip.c:1507
AVOutputFormat::name
const char * name
Definition: avformat.h:508
av_bprint_is_complete
static int av_bprint_is_complete(const AVBPrint *buf)
Test if the print buffer is complete (not truncated).
Definition: bprint.h:218
WHIP_DTLS_ACTIVE
@ WHIP_DTLS_ACTIVE
Definition: whip.c:205
r
const char * r
Definition: vf_curves.c:127
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
WHIPContext::sdp_offer
char * sdp_offer
This is the SDP offer generated by the muxer based on the codec parameters, DTLS, and ICE information...
Definition: whip.c:255
AV_PROFILE_H264_INTRA
#define AV_PROFILE_H264_INTRA
Definition: defs.h:108
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:53
WHIPContext::is_peer_ice_lite
int is_peer_ice_lite
Definition: whip.c:257
space
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated space
Definition: undefined.txt:4
STUN_MAGIC_COOKIE
#define STUN_MAGIC_COOKIE
Definition: whip.c:81
WHIP_STATE_ANSWER
@ WHIP_STATE_ANSWER
Definition: whip.c:182
H264_NAL_PPS
@ H264_NAL_PPS
Definition: h264.h:42
out
static FILE * out
Definition: movenc.c:55
av_lfg_init
av_cold void av_lfg_init(AVLFG *c, unsigned int seed)
Definition: lfg.c:32
dtls_initialize
static av_cold int dtls_initialize(AVFormatContext *s)
Definition: whip.c:377
av_bprint_init
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Definition: bprint.c:69
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:49
av_stristr
char * av_stristr(const char *s1, const char *s2)
Locate the first case-independent occurrence in the string haystack of the string needle.
Definition: avstring.c:58
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
AVStream::priv_data
void * priv_data
Definition: avformat.h:772
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
AVIO_FLAG_READ_WRITE
#define AVIO_FLAG_READ_WRITE
read-write pseudo flag
Definition: avio.h:619
STUN_ATTR_FINGERPRINT
@ STUN_ATTR_FINGERPRINT
bind request/response
Definition: whip.c:170
WHIP_STATE_DTLS_FINISHED
@ WHIP_STATE_DTLS_FINISHED
Definition: whip.c:195
avio_context_free
void avio_context_free(AVIOContext **s)
Free the supplied IO context and everything associated with it.
Definition: aviobuf.c:126
RtpHistoryItem::seq
uint16_t seq
Definition: whip.c:209
state
static struct @584 state
int64_t
long long int64_t
Definition: coverity.c:34
WHIPContext::ice_pwd_remote
char * ice_pwd_remote
Definition: whip.c:261
WHIPContext::dtls_uc
URLContext * dtls_uc
Definition: whip.c:304
ffurl_write
static int ffurl_write(URLContext *h, const uint8_t *buf, int size)
Write size bytes from buf to the resource accessed by h.
Definition: url.h:202
av_strcasecmp
int av_strcasecmp(const char *a, const char *b)
Locale-independent case-insensitive compare.
Definition: avstring.c:208
initialize
static av_cold int initialize(AVFormatContext *s)
Initialize and check the options for the WebRTC muxer.
Definition: whip.c:415
out_size
static int out_size
Definition: movenc.c:56
WHIPContext::video_ssrc
uint32_t video_ssrc
Definition: whip.c:240
AVFormatContext::streams
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1352
deinit
static void deinit(AVFormatContext *s)
Definition: chromaprint.c:53
AVFormatContext::strict_std_compliance
int strict_std_compliance
Allow non-standard and experimental extension.
Definition: avformat.h:1643
AVPacket::data
uint8_t * data
Definition: packet.h:595
avio_alloc_context
AVIOContext * avio_alloc_context(unsigned char *buffer, int buffer_size, int write_flag, void *opaque, int(*read_packet)(void *opaque, uint8_t *buf, int buf_size), int(*write_packet)(void *opaque, const uint8_t *buf, int buf_size), int64_t(*seek)(void *opaque, int64_t offset, int whence))
Allocate and initialize an AVIOContext for buffered I/O.
Definition: aviobuf.c:109
WHIPContext::video_rtx_seq
uint16_t video_rtx_seq
Definition: whip.c:246
AVOption
AVOption.
Definition: opt.h:429
srtp.h
b
#define b
Definition: input.c:43
H264_NAL_SPS
@ H264_NAL_SPS
Definition: h264.h:41
WHIPContext::audio_first_seq
uint16_t audio_first_seq
Definition: whip.c:243
AV_OPT_TYPE_DURATION
@ AV_OPT_TYPE_DURATION
Underlying C type is int64_t.
Definition: opt.h:319
ICE_STUN_HEADER_SIZE
#define ICE_STUN_HEADER_SIZE
The STUN message header, which is 20 bytes long, comprises the STUNMessageType (1B),...
Definition: whip.c:110
WHIPContext::handshake_timeout
int handshake_timeout
Definition: whip.c:320
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:226
AVIOContext::max_packet_size
int max_packet_size
Definition: avio.h:241
WHIPContext::srtp_video_rtx_send
SRTPContext srtp_video_rtx_send
Definition: whip.c:309
ice_create_request
static int ice_create_request(AVFormatContext *s, uint8_t *buf, int buf_size, int *request_size)
Creates and marshals an ICE binding request packet.
Definition: whip.c:1022
suite
FFmpeg currently uses a custom build this text attempts to document some of its obscure features and options Makefile the full command issued by make and its output will be shown on the screen DESTDIR Destination directory for the install useful to prepare packages or install FFmpeg in cross environments GEN Set to ‘1’ to generate the missing or mismatched references Makefile builds all the libraries and the executables fate Run the fate test suite
Definition: build_system.txt:23
AVDictionary
Definition: dict.c:32
FF_OFMT_FLAG_ONLY_DEFAULT_CODECS
#define FF_OFMT_FLAG_ONLY_DEFAULT_CODECS
If this flag is set, then the only permitted audio/video/subtitle codec ids are AVOutputFormat....
Definition: mux.h:59
WHIPContext::srtp_video_send
SRTPContext srtp_video_send
Definition: whip.c:308
WHIPContext::udp
URLContext * udp
Definition: whip.c:315
SRTPContext
Definition: srtp.h:30
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:329
WHIP_SDP_CREATOR_IP
#define WHIP_SDP_CREATOR_IP
Definition: whip.c:137
WHIPContext::h264_annexb_insert_sps_pps
int h264_annexb_insert_sps_pps
The h264_mp4toannexb Bitstream Filter (BSF) bypasses the AnnexB packet; therefore,...
Definition: whip.c:230
udp_connect
static int udp_connect(AVFormatContext *s)
To establish a connection with the UDP server, we utilize ICE-LITE in a Client-Server mode.
Definition: whip.c:1260
av_packet_free
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
Definition: packet.c:74
av_hmac_final
int av_hmac_final(AVHMAC *c, uint8_t *out, unsigned int outlen)
Finish hashing and output the HMAC digest.
Definition: hmac.c:181
WHIPContext::video_rtx_ssrc
uint32_t video_rtx_ssrc
Definition: whip.c:241
DTLS_SRTP_CHECKSUM_LEN
#define DTLS_SRTP_CHECKSUM_LEN
The maximum size of the Secure Real-time Transport Protocol (SRTP) HMAC checksum and padding that is ...
Definition: whip.c:69
WHIP_STATE_ICE_CONNECTED
@ WHIP_STATE_ICE_CONNECTED
Definition: whip.c:193
FFOutputFormat::p
AVOutputFormat p
The public AVOutputFormat.
Definition: mux.h:65
av_get_random_seed
uint32_t av_get_random_seed(void)
Get a seed to use in conjunction with random functions.
Definition: random_seed.c:196
WHIPContext::ice_port
int ice_port
Definition: whip.c:269
av_memdup
void * av_memdup(const void *p, size_t size)
Duplicate a buffer with av_malloc().
Definition: mem.c:304
WHIP_SDP_SESSION_ID
#define WHIP_SDP_SESSION_ID
In the case of ICE-LITE, these fields are not used; instead, they are defined as constant values.
Definition: whip.c:136
bit
#define bit(string, value)
Definition: cbs_mpeg2.c:56
crc.h
WHIPContext::key_file
char * key_file
Definition: whip.c:337
AVFormatContext::interrupt_callback
AVIOInterruptCB interrupt_callback
Custom interrupt callbacks for the I/O layer.
Definition: avformat.h:1554
WHIPContext::remote_fingerprint
char * remote_fingerprint
Definition: whip.c:294
ff_whip_muxer
const FFOutputFormat ff_whip_muxer
Definition: whip.c:2202
RtpHistoryItem::buf
uint8_t * buf
Definition: whip.c:211
WHIPContext::cert_buf
char cert_buf[MAX_CERTIFICATE_SIZE]
Definition: whip.c:289
fail
#define fail()
Definition: checkasm.h:225
ff_srtp_decrypt
int ff_srtp_decrypt(struct SRTPContext *s, uint8_t *buf, int *lenptr)
Definition: srtp.c:127
ff_avc_decode_sps
int ff_avc_decode_sps(H264SPS *sps, const uint8_t *buf, int buf_size)
Definition: avc.c:196
WHIP_STATE_SRTP_FINISHED
@ WHIP_STATE_SRTP_FINISHED
Definition: whip.c:197
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:494
WHIPContext::whip_ice_time
int64_t whip_ice_time
Definition: whip.c:282
WHIPContext
Definition: whip.c:214
parse_answer
static int parse_answer(AVFormatContext *s)
Parses the ICE ufrag, pwd, and candidates from the SDP answer.
Definition: whip.c:892
STUN_HOST_CANDIDATE_PRIORITY
#define STUN_HOST_CANDIDATE_PRIORITY
Refer to RFC 8445 5.1.2 priority = (2^24)*(type preference) + (2^8)*(local preference) + (2^0)*(256 -...
Definition: whip.c:88
ff_data_to_hex
char * ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase)
Write hexadecimal string corresponding to given binary data.
Definition: utils.c:458
handle_nack_rtx
static void handle_nack_rtx(AVFormatContext *s, int size)
Definition: whip.c:1946
ff_srtp_encrypt
int ff_srtp_encrypt(struct SRTPContext *s, const uint8_t *in, int len, uint8_t *out, int outlen)
Definition: srtp.c:239
WHIP_RTP_PAYLOAD_TYPE_H264
#define WHIP_RTP_PAYLOAD_TYPE_H264
Definition: whip.c:100
ice_handle_binding_request
static int ice_handle_binding_request(AVFormatContext *s, char *buf, int buf_size)
This function handles incoming binding request messages by responding to them.
Definition: whip.c:1220
avassert.h
h264_annexb_insert_sps_pps
static int h264_annexb_insert_sps_pps(AVFormatContext *s, AVPacket *pkt)
Since the h264_mp4toannexb filter only processes the MP4 ISOM format and bypasses the annexb format,...
Definition: whip.c:1766
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:210
av_cold
#define av_cold
Definition: attributes.h:119
AV_PROFILE_UNKNOWN
#define AV_PROFILE_UNKNOWN
Definition: defs.h:65
WHIPContext::sdp_answer
char * sdp_answer
Definition: whip.c:272
ice_dtls_handshake
static int ice_dtls_handshake(AVFormatContext *s)
Definition: whip.c:1298
ffurl_open_whitelist
int ffurl_open_whitelist(URLContext **puc, const char *filename, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options, const char *whitelist, const char *blacklist, URLContext *parent)
Create an URLContext for accessing to the resource indicated by url, and open it.
Definition: avio.c:368
WHIP_STATE_OFFER
@ WHIP_STATE_OFFER
Definition: whip.c:180
RtpHistoryItem::size
int size
Definition: whip.c:210
ice_is_binding_request
static int ice_is_binding_request(uint8_t *b, int size)
A Binding request has class=0b00 (request) and method=0b000000000001 (Binding) and is encoded into th...
Definition: whip.c:1184
WHIPContext::whip_last_consent_rx_time
int64_t whip_last_consent_rx_time
Definition: whip.c:286
attributes_internal.h
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: packet.c:98
av_lfg_get
static unsigned int av_lfg_get(AVLFG *c)
Get the next random unsigned 32-bit number using an ALFG.
Definition: lfg.h:53
WHIPContext::srtp_audio_send
SRTPContext srtp_audio_send
Definition: whip.c:307
AVFormatContext::flags
int flags
Flags modifying the (de)muxer behaviour.
Definition: avformat.h:1435
WHIPContext::whip_dtls_time
int64_t whip_dtls_time
Definition: whip.c:283
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:201
WHIPContext::ice_ufrag_remote
char * ice_ufrag_remote
Definition: whip.c:260
STUN_ATTR_USE_CANDIDATE
@ STUN_ATTR_USE_CANDIDATE
must be included in a Binding request
Definition: whip.c:168
lfg.h
URLContext::flags
int flags
Definition: url.h:40
ff_url_join
int ff_url_join(char *str, int size, const char *proto, const char *authorization, const char *hostname, int port, const char *fmt,...)
Definition: url.c:40
WHIPContext::ice_ufrag_local
char ice_ufrag_local[9]
Definition: whip.c:236
AVIO_FLAG_WRITE
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:618
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:231
av_usleep
int av_usleep(unsigned usec)
Sleep for a period of time.
Definition: time.c:84
av_mallocz
#define av_mallocz(s)
Definition: tableprint_vlc.h:31
AV_CODEC_ID_H264
@ AV_CODEC_ID_H264
Definition: codec_id.h:79
DTLS_SRTP_SALT_LEN
#define DTLS_SRTP_SALT_LEN
Definition: whip.c:61
avformat_write_header
av_warn_unused_result int avformat_write_header(AVFormatContext *s, AVDictionary **options)
Allocate the stream private data and write the stream header to an output media file.
Definition: mux.c:467
WHIPContext::whip_srtp_time
int64_t whip_srtp_time
Definition: whip.c:284
STUNAttr
STUNAttr
Definition: whip.c:165
EXTERN
#define EXTERN
Definition: attributes_internal.h:34
if
if(ret)
Definition: filter_design.txt:179
ice_create_response
static int ice_create_response(AVFormatContext *s, char *tid, int tid_size, uint8_t *buf, int buf_size, int *response_size)
Create an ICE binding response.
Definition: whip.c:1120
parse_codec
static int parse_codec(AVFormatContext *s)
Parses video SPS/PPS from the extradata of codecpar and checks the codec.
Definition: whip.c:546
WHIP_STATE_READY
@ WHIP_STATE_READY
Definition: whip.c:199
AVFormatContext
Format I/O context.
Definition: avformat.h:1284
dispose_session
static int dispose_session(AVFormatContext *s)
RTC is connectionless, for it's based on UDP, so it check whether sesison is timeout.
Definition: whip.c:1706
internal.h
crc32
static unsigned crc32(const uint8_t *data, unsigned size)
Definition: crypto_bench.c:575
opts
static AVDictionary * opts
Definition: movenc.c:51
WHIPContext::hist
RtpHistoryItem * hist
Definition: whip.c:340
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:770
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
WHIPContext::hist_sz
int hist_sz
Definition: whip.c:339
STUN_ATTR_USERNAME
@ STUN_ATTR_USERNAME
Definition: whip.c:166
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:76
AVStream::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avformat.h:786
WHIPContext::whip_init_time
int64_t whip_init_time
Definition: whip.c:278
NULL
#define NULL
Definition: coverity.c:32
ICE_DTLS_READ_SLEEP_DURATION
#define ICE_DTLS_READ_SLEEP_DURATION
Definition: whip.c:78
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
AV_WB16
#define AV_WB16(p, v)
Definition: intreadwrite.h:401
handle_rtx_packet
static void handle_rtx_packet(AVFormatContext *s, uint16_t seq)
See https://datatracker.ietf.org/doc/html/rfc4588#section-4 Create RTX packet and send it out.
Definition: whip.c:1883
profile_idc
int profile_idc
Definition: h264_levels.c:53
AV_LEVEL_UNKNOWN
#define AV_LEVEL_UNKNOWN
Definition: defs.h:209
WHIPContext::srtp_recv
SRTPContext srtp_recv
Definition: whip.c:312
av_unreachable
#define av_unreachable(msg)
Asserts that are used as compiler optimization hints depending upon ASSERT_LEVEL and NBDEBUG.
Definition: avassert.h:116
WHIPFlags
WHIPFlags
Definition: whip.c:204
certificate_key_init
static av_cold int certificate_key_init(AVFormatContext *s)
Get or Generate a self-signed certificate and private key for DTLS, fingerprint for SDP.
Definition: whip.c:349
WHIPContext::video_payload_type
uint8_t video_payload_type
Definition: whip.c:249
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:242
AVFormatContext::pb
AVIOContext * pb
I/O context.
Definition: avformat.h:1326
avc.h
DTLS_SRTP_KEY_LEN
#define DTLS_SRTP_KEY_LEN
The size of the Secure Real-time Transport Protocol (SRTP) master key material that is exported by Se...
Definition: whip.c:60
options
Definition: swscale.c:50
av_hmac_update
void av_hmac_update(AVHMAC *c, const uint8_t *data, unsigned int len)
Hash data with the HMAC.
Definition: hmac.c:176
WHIPContext::key_buf
char key_buf[MAX_CERTIFICATE_SIZE]
Definition: whip.c:290
avpriv_find_start_code
const uint8_t * avpriv_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state)
FFOutputFormat
Definition: mux.h:61
WHIP_STATE_FAILED
@ WHIP_STATE_FAILED
Definition: whip.c:201
whip_init
static av_cold int whip_init(AVFormatContext *s)
Definition: whip.c:1841
time.h
WHIPContext::ice_tie_breaker
uint64_t ice_tie_breaker
Definition: whip.c:258
ffio_fill
void ffio_fill(AVIOContext *s, int b, int64_t count)
Definition: aviobuf.c:192
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
The channel layout and number of channels.
Definition: codec_par.h:207
av_packet_move_ref
void av_packet_move_ref(AVPacket *dst, AVPacket *src)
Move every field in src to dst and reset src.
Definition: packet.c:490
seed
static unsigned int seed
Definition: videogen.c:78
base64.h
media_is_rtp_rtcp
static int media_is_rtp_rtcp(const uint8_t *b, int size)
In RTP packets, the first byte is represented as 0b10xxxxxx, where the initial two bits (0b10) indica...
Definition: whip.c:1205
rtp_history_find
static const RtpHistoryItem * rtp_history_find(WHIPContext *whip, uint16_t seq)
Definition: whip.c:1522
AVCodecParameters::level
int level
Definition: codec_par.h:136
WHIPContext::ice_host
char * ice_host
Definition: whip.c:268
AVCodecParameters::sample_rate
int sample_rate
The number of audio samples per second.
Definition: codec_par.h:213
AV_HMAC_SHA1
@ AV_HMAC_SHA1
Definition: hmac.h:34
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:75
AV_WB32
#define AV_WB32(p, v)
Definition: intreadwrite.h:415
whip_muxer_class
static const AVClass whip_muxer_class
Definition: whip.c:2195
startcode.h
MAX_UDP_BUFFER_SIZE
#define MAX_UDP_BUFFER_SIZE
Maximum size of the buffer for sending and receiving UDP packets.
Definition: whip.c:97
WHIPContext::hist_head
int hist_head
Definition: whip.c:342
WHIP_RTCP_PT_START
#define WHIP_RTCP_PT_START
For RTCP, PT is [128, 223] (or without marker [0, 95]).
Definition: whip.c:129
AVLFG
Context structure for the Lagged Fibonacci PRNG.
Definition: lfg.h:33
AVIOContext
Bytestream IO Context.
Definition: avio.h:160
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:551
AVPacket::size
int size
Definition: packet.h:596
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
avformat_alloc_context
AVFormatContext * avformat_alloc_context(void)
Allocate an AVFormatContext.
Definition: options.c:164
av_bprint_finalize
int av_bprint_finalize(AVBPrint *buf, char **ret_str)
Finalize a print buffer.
Definition: bprint.c:235
STUN_ATTR_ICE_CONTROLLING
@ STUN_ATTR_ICE_CONTROLLING
rfc5389
Definition: whip.c:171
i
#define i(width, name, range_min, range_max)
Definition: cbs_h264.c:63
size
int size
Definition: twinvq_data.h:10344
WHIPContext::cert_file
char * cert_file
Definition: whip.c:336
AV_RB32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_RB32
Definition: bytestream.h:96
STUN_ATTR_MESSAGE_INTEGRITY
@ STUN_ATTR_MESSAGE_INTEGRITY
bind request
Definition: whip.c:169
AVCodecParameters::profile
int profile
Codec-specific bitstream restrictions that the stream conforms to.
Definition: codec_par.h:135
AV_CODEC_ID_OPUS
@ AV_CODEC_ID_OPUS
Definition: codec_id.h:521
AVFMT_NOFILE
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:469
AV_WB24
#define AV_WB24(p, d)
Definition: intreadwrite.h:446
AVStream::sample_aspect_ratio
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown)
Definition: avformat.h:825
options
static const AVOption options[]
Definition: whip.c:2181
ff_socket_nonblock
int ff_socket_nonblock(int socket, int enable)
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:206
avio_wb32
void avio_wb32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:368
WHIPContext::audio_par
AVCodecParameters * audio_par
Definition: whip.c:222
parse_profile_level
static int parse_profile_level(AVFormatContext *s, AVCodecParameters *par)
When duplicating a stream, the demuxer has already set the extradata, profile, and level of the par.
Definition: whip.c:479
ff_srtp_free
void ff_srtp_free(struct SRTPContext *s)
Definition: srtp.c:32
av_crc_get_table
const AVCRC * av_crc_get_table(AVCRCId crc_id)
Get an initialized standard CRC table.
Definition: crc.c:389
pt
int pt
Definition: rtp.c:35
line
Definition: graph2dot.c:48
WHIPContext::dtls_fingerprint
char * dtls_fingerprint
Definition: whip.c:292
av_packet_make_refcounted
int av_packet_make_refcounted(AVPacket *pkt)
Ensure the data described by a given packet is reference counted.
Definition: packet.c:496
av_packet_alloc
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: packet.c:63
av_dict_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:233
av_strstart
int av_strstart(const char *str, const char *pfx, const char **ptr)
Return non-zero if pfx is a prefix of str.
Definition: avstring.c:36
WHIPContext::rnd
AVLFG rnd
Definition: whip.c:233
WHIPContext::whip_resource_url
char * whip_resource_url
Definition: whip.c:274
WHIP_STATE_INIT
@ WHIP_STATE_INIT
Definition: whip.c:178
rtp.h
av_hmac_alloc
AVHMAC * av_hmac_alloc(enum AVHMACType type)
Allocate an AVHMAC context.
Definition: hmac.c:82
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:221
WHIP_RTP_HISTORY_MAX
#define WHIP_RTP_HISTORY_MAX
Definition: whip.c:159
WHIP_STATE_NONE
@ WHIP_STATE_NONE
Definition: whip.c:175
WHIPContext::whip_last_consent_tx_time
int64_t whip_last_consent_tx_time
Definition: whip.c:285
WHIP_ICE_CONSENT_EXPIRED_TIMER
#define WHIP_ICE_CONSENT_EXPIRED_TIMER
Definition: whip.c:148
WHIPState
WHIPState
Definition: whip.c:174
WHIPContext::timeout
int64_t timeout
Definition: whip.c:323
ENC
#define ENC
Definition: whip.c:2180
ELAPSED
#define ELAPSED(starttime, endtime)
Definition: whip.c:162
av_hmac_free
void av_hmac_free(AVHMAC *c)
Free an AVHMAC context.
Definition: hmac.c:147
av_write_trailer
int av_write_trailer(AVFormatContext *s)
Write the stream trailer to an output media file and free the file private data.
Definition: mux.c:1238
av_packet_copy_props
int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
Copy only "properties" fields from src to dst.
Definition: packet.c:396
generate_sdp_offer
static int generate_sdp_offer(AVFormatContext *s)
Generate SDP offer according to the codec parameters, DTLS and ICE information.
Definition: whip.c:606
ff_is_dtls_packet
int ff_is_dtls_packet(const uint8_t *buf, int size)
Whether the packet is a DTLS packet, as defined by RFC 5764 Section 5.1.2.
Definition: tls.c:167
bprint.h
AV_BASE64_SIZE
#define AV_BASE64_SIZE(x)
Calculate the output size needed to base64-encode x bytes to a null-terminated string.
Definition: base64.h:66
URLContext
Definition: url.h:35
AVFMT_GLOBALHEADER
#define AVFMT_GLOBALHEADER
Format wants global header.
Definition: avformat.h:478
av_malloc
#define av_malloc(s)
Definition: ops_asmgen.c:44
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
avio_internal.h
WHIPContext::ts_buffer_size
int ts_buffer_size
Definition: whip.c:329
STUN_ATTR_PRIORITY
@ STUN_ATTR_PRIORITY
shared secret response/bind request
Definition: whip.c:167
check_bitstream
static int check_bitstream(AVFormatContext *s, FFStream *sti, AVPacket *pkt)
Definition: mux.c:1056
WHIPContext::video_first_seq
uint16_t video_first_seq
Definition: whip.c:244
FF_OFMT_FLAG_MAX_ONE_OF_EACH
#define FF_OFMT_FLAG_MAX_ONE_OF_EACH
If this flag is set, it indicates that for each codec type whose corresponding default codec (i....
Definition: mux.h:50
av_hmac_init
void av_hmac_init(AVHMAC *c, const uint8_t *key, unsigned int keylen)
Initialize an AVHMAC context with an authentication key.
Definition: hmac.c:155
exchange_sdp
static int exchange_sdp(AVFormatContext *s)
Exchange SDP offer with WebRTC peer to get the answer.
Definition: whip.c:770
whip_check_bitstream
static int whip_check_bitstream(AVFormatContext *s, AVStream *st, const AVPacket *pkt)
Definition: whip.c:2160
WHIPContext::state
enum WHIPState state
Definition: whip.c:219
WHIP_RTP_HISTORY_MIN
#define WHIP_RTP_HISTORY_MIN
RTP history packet size.
Definition: whip.c:157
create_rtp_muxer
static int create_rtp_muxer(AVFormatContext *s)
Creates dedicated RTP muxers for each stream in the AVFormatContext to build RTP packets from the enc...
Definition: whip.c:1591
ff_avio_class
const AVClass ff_avio_class
Definition: avio.c:98
av_random_bytes
int av_random_bytes(uint8_t *buf, size_t len)
Generate cryptographically secure random data, i.e.
Definition: random_seed.c:159
AVFormatContext::max_delay
int max_delay
Definition: avformat.h:1429
AVFMT_EXPERIMENTAL
#define AVFMT_EXPERIMENTAL
The muxer/demuxer is experimental and should be used with caution.
Definition: avformat.h:476
setup_srtp
static int setup_srtp(AVFormatContext *s)
Establish the SRTP context using the keying material exported from DTLS.
Definition: whip.c:1417
OFFSET
#define OFFSET(x)
Definition: whip.c:2179
WHIPContext::whip_offer_time
int64_t whip_offer_time
Definition: whip.c:279
ff_srtp_set_crypto
int ff_srtp_set_crypto(struct SRTPContext *s, const char *suite, const char *params)
Definition: srtp.c:66
nal.h
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:264
write_packet
static int write_packet(Muxer *mux, OutputStream *ost, AVPacket *pkt)
Definition: ffmpeg_mux.c:209
WHIPContext::whip_starttime
int64_t whip_starttime
Definition: whip.c:277
AVCodecParameters::avcodec_parameters_copy
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
Definition: codec_par.c:107
ffurl_closep
int ffurl_closep(URLContext **hh)
Close the resource accessed by the URLContext h, and free the memory used by it.
Definition: avio.c:594
AVFMT_FLAG_BITEXACT
#define AVFMT_FLAG_BITEXACT
When muxing, try to avoid writing any random/volatile data to the output.
Definition: avformat.h:1452
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:747
ff_http_get_new_location
const char * ff_http_get_new_location(URLContext *h)
Definition: http.c:610
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:81
AVFormatContext::oformat
const struct AVOutputFormat * oformat
The output container format.
Definition: avformat.h:1303
sps
static int FUNC() sps(CodedBitstreamContext *ctx, RWContext *rw, H264RawSPS *current)
Definition: cbs_h264_syntax_template.c:260
whip_write_packet
static int whip_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: whip.c:2012
WHIPContext::buf
char buf[MAX_UDP_BUFFER_SIZE]
Definition: whip.c:317
pos
unsigned int pos
Definition: spdifenc.c:414
av_bprintf
void av_bprintf(AVBPrint *buf, const char *fmt,...)
Definition: bprint.c:122
WHIPContext::dtls_srtp_materials
uint8_t dtls_srtp_materials[(DTLS_SRTP_KEY_LEN+DTLS_SRTP_SALT_LEN) *2]
This represents the material used to build the SRTP master key.
Definition: whip.c:301
RTCP_RTPFB
@ RTCP_RTPFB
Definition: rtp.h:104
AV_PROFILE_H264_CONSTRAINED
#define AV_PROFILE_H264_CONSTRAINED
Definition: defs.h:107
network.h
WHIP_ICE_CONSENT_CHECK_INTERVAL
#define WHIP_ICE_CONSENT_CHECK_INTERVAL
Refer to RFC 7675 5.1,.
Definition: whip.c:147
WHIPContext::hist_pool
uint8_t * hist_pool
Definition: whip.c:341
tls.h
WHIP_US_PER_MS
#define WHIP_US_PER_MS
Definition: whip.c:71
ff_dtls_export_materials
int ff_dtls_export_materials(URLContext *h, char *dtls_srtp_materials, size_t materials_sz)
Definition: tls_gnutls.c:377
random_seed.h
MAX_URL_SIZE
#define MAX_URL_SIZE
Definition: internal.h:30
WHIP_STATE_UDP_CONNECTED
@ WHIP_STATE_UDP_CONNECTED
Definition: whip.c:189
buffer
the frame and frame reference mechanism is intended to as much as expensive copies of that data while still allowing the filters to produce correct results The data is stored in buffers represented by AVFrame structures Several references can point to the same frame buffer
Definition: filter_design.txt:49
media_is_rtcp
static int media_is_rtcp(const uint8_t *b, int size)
Definition: whip.c:1211
av_crc
uint32_t av_crc(const AVCRC *ctx, uint32_t crc, const uint8_t *buffer, size_t length)
Calculate the CRC of a block.
Definition: crc.c:421
WHIPContext::av_class
AVClass * av_class
Definition: whip.c:215
WHIP_STATE_ICE_CONNECTING
@ WHIP_STATE_ICE_CONNECTING
Definition: whip.c:191
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
avformat_free_context
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: avformat.c:148
ICE_DTLS_READ_MAX_RETRY
#define ICE_DTLS_READ_MAX_RETRY
If we try to read from UDP and get EAGAIN, we sleep for 5ms and retry up to 10 times.
Definition: whip.c:77
WHIP_RTP_PAYLOAD_TYPE_OPUS
#define WHIP_RTP_PAYLOAD_TYPE_OPUS
Definition: whip.c:101
av_base64_encode
char * av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size)
Encode data to base64 and null-terminate.
Definition: base64.c:147
AVPacket::stream_index
int stream_index
Definition: packet.h:597
WHIPContext::whip_answer_time
int64_t whip_answer_time
Definition: whip.c:280
ff_tls_set_external_socket
int ff_tls_set_external_socket(URLContext *h, URLContext *sock)
Definition: tls_gnutls.c:364
WHIPContext::ice_protocol
char * ice_protocol
This represents the ICE candidate protocol, priority, host and port.
Definition: whip.c:267
WHIP_RTP_HEADER_SIZE
#define WHIP_RTP_HEADER_SIZE
The RTP header is 12 bytes long, comprising the Version(1B), PT(1B), SequenceNumber(2B),...
Definition: whip.c:117
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:321
avio_wb64
void avio_wb64(AVIOContext *s, uint64_t val)
Definition: aviobuf.c:434
AV_CRC_32_IEEE_LE
@ AV_CRC_32_IEEE_LE
Definition: crc.h:53
av_dict_set_int
int av_dict_set_int(AVDictionary **pm, const char *key, int64_t value, int flags)
Convenience wrapper for av_dict_set() that converts the value to a string and stores it.
Definition: dict.c:177
AVIO_FLAG_READ
#define AVIO_FLAG_READ
read-only
Definition: avio.h:617
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:200
ff_ssl_read_key_cert
int ff_ssl_read_key_cert(char *key_url, char *cert_url, char *key_buf, size_t key_sz, char *cert_buf, size_t cert_sz, char **fingerprint)
Definition: tls_gnutls.c:113
mem.h
av_strdup
#define av_strdup(s)
Definition: ops_asmgen.c:47
AVCodecParameters::video_delay
int video_delay
Number of delayed frames.
Definition: codec_par.h:200
it
s EdgeDetect Foobar g libavfilter vf_edgedetect c libavfilter vf_foobar c edit libavfilter and add an entry for foobar following the pattern of the other filters edit libavfilter allfilters and add an entry for foobar following the pattern of the other filters configure make j< whatever > ffmpeg ffmpeg i you should get a foobar png with Lena edge detected That s it
Definition: writing_filters.txt:31
MAX_CERTIFICATE_SIZE
#define MAX_CERTIFICATE_SIZE
Maximum size limit of a certificate and private key size.
Definition: tls.h:35
AVFormatContext::start_time_realtime
int64_t start_time_realtime
Start time of the stream in real world time, in microseconds since the Unix epoch (00:00 1st January ...
Definition: avformat.h:1529
AVIOContext::buffer
unsigned char * buffer
Start of the buffer.
Definition: avio.h:225
H264_NAL_IDR_SLICE
@ H264_NAL_IDR_SLICE
Definition: h264.h:39
ff_ssl_gen_key_cert
int ff_ssl_gen_key_cert(char *key_buf, size_t key_sz, char *cert_buf, size_t cert_sz, char **fingerprint)
Definition: tls_gnutls.c:297
WHIPContext::authorization
char * authorization
The optional Bearer token for WHIP Authorization.
Definition: whip.c:334
WHIPContext::srtp_rtcp_send
SRTPContext srtp_rtcp_send
Definition: whip.c:310
ffurl_handshake
int ffurl_handshake(URLContext *c)
Perform one step of the protocol handshake to accept a new client.
Definition: avio.c:289
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:57
WHIP_RTCP_PT_END
#define WHIP_RTCP_PT_END
Definition: whip.c:130
AVPacket
This structure stores compressed data.
Definition: packet.h:572
WHIPContext::ice_pwd_local
char ice_pwd_local[33]
Definition: whip.c:237
AVIO_FLAG_NONBLOCK
#define AVIO_FLAG_NONBLOCK
Use non-blocking mode.
Definition: avio.h:636
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
av_dict_set
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:86
ff_rtp_muxer
const FFOutputFormat ff_rtp_muxer
Definition: rtpenc.c:701
avio_find_protocol_name
const char * avio_find_protocol_name(const char *url)
Return the name of the protocol that will handle the passed URL.
Definition: avio.c:663
AV_OPT_TYPE_FLAGS
@ AV_OPT_TYPE_FLAGS
Underlying C type is unsigned int.
Definition: opt.h:255
h264.h
avio_wb16
void avio_wb16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:446
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
ice_is_binding_response
static int ice_is_binding_response(uint8_t *b, int size)
A Binding response has class=0b10 (success response) and method=0b000000000001, and is encoded into t...
Definition: whip.c:1193
pkt
static AVPacket * pkt
Definition: demux_decode.c:55
WHIPContext::audio_ssrc
uint32_t audio_ssrc
Definition: whip.c:239
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Underlying C type is a uint8_t* that is either NULL or points to a C string allocated with the av_mal...
Definition: opt.h:276
WHIPContext::flags
uint32_t flags
Definition: whip.c:217
AV_RB24
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_RB24
Definition: bytestream.h:97
WHIPContext::audio_payload_type
uint8_t audio_payload_type
Definition: whip.c:248
http.h
ff_nal_find_startcode
const uint8_t * ff_nal_find_startcode(const uint8_t *p, const uint8_t *end)
Definition: nal.c:68
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Special option type for declaring named constants.
Definition: opt.h:299
snprintf
#define snprintf
Definition: snprintf.h:34
ff_stream_add_bitstream_filter
int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args)
Add a bitstream filter to a stream.
Definition: mux.c:1294
ff_format_set_url
void ff_format_set_url(AVFormatContext *s, char *url)
Set AVFormatContext url field to the provided pointer.
Definition: avformat.c:984
WHIPContext::video_par
AVCodecParameters * video_par
Definition: whip.c:223
hmac.h
WHIP_STATE_NEGOTIATED
@ WHIP_STATE_NEGOTIATED
After parsing the answer received from the peer, the muxer negotiates the abilities in the offer that...
Definition: whip.c:187
ffurl_get_file_handle
int ffurl_get_file_handle(URLContext *h)
Return the file descriptor associated with this URL.
Definition: avio.c:820
RtpHistoryItem
Definition: whip.c:208
WHIP_RTP_PAYLOAD_TYPE_VIDEO_RTX
#define WHIP_RTP_PAYLOAD_TYPE_VIDEO_RTX
Definition: whip.c:102
WHIPContext::pkt_size
int pkt_size
The size of RTP packet, should generally be set to MTU.
Definition: whip.c:328
WHIPContext::video_rtx_payload_type
uint8_t video_rtx_payload_type
Definition: whip.c:250
AVIOContext::av_class
const AVClass * av_class
A class for private options.
Definition: avio.h:173
AV_RB16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:98
WHIP_RTP_HISTORY_DEFAULT
#define WHIP_RTP_HISTORY_DEFAULT
Definition: whip.c:158
MAX_SDP_SIZE
#define MAX_SDP_SIZE
Maximum size limit of a Session Description Protocol (SDP), be it an offer or answer.
Definition: whip.c:52
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:349
ffurl_read
static int ffurl_read(URLContext *h, uint8_t *buf, int size)
Read up to size bytes from the resource accessed by h, and store the read bytes in buf.
Definition: url.h:181
mux.h
ff_write_chained
int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt, AVFormatContext *src, int interleave)
Write a packet to another muxer than the one the user originally intended.
Definition: mux.c:1337