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