webrtc_media_fb (webrtc v0.1.0)
View SourceSlice loss (SLI) and reference picture selection (RPSI) indications, RFC 4585 §6.3.2 and §6.3.3, used as RFC 8834 §5.1.3 and §5.1.4 ask once nack sli or nack rpsi is negotiated.
The library does not encode or decode, so:
- As media sender, an indication for one of our streams goes to the owner,
{slice_loss, Mid, Entries}or{reference_picture, Mid, Pt, Bits}(with the rid for a simulcast layer), and to the stream's encoding codec plugin through its optionalfeedback/2callback, which repairs or changes its reference picture. - As media receiver, the application (
send/4) or the decoding plugin (the feedbackdecode/2returns) sends them.
Indications on a stream that did not negotiate them are ignored and counted (sli_ignored, rpsi_ignored).
Summary
Functions
RTCP for the indications a decoding plugin returned on stream Ssrc, those the stream negotiated.
An SLI or RPSI from the peer.
The indications a receive stream negotiated with its codecs.
Send an indication to the senders of a transceiver (Mid) or of one simulcast layer ({Mid, Rid}).
Types
Functions
-spec packets(non_neg_integer(), [indication()], #media{cname :: binary(), ecn :: boolean(), rtcp_ssrc :: non_neg_integer(), out :: undefined | term(), in :: undefined | term(), senders :: #{sender_key() => #snd{mid :: binary(), kind :: audio | video, ssrc :: non_neg_integer(), rtx_ssrc :: non_neg_integer(), codecs :: [map()], rtx :: #{0..127 => 0..127}, mid_ext :: undefined | pos_integer(), twcc_ext :: undefined | pos_integer(), seq :: 0..65535, rtx_seq :: 0..65535, last_ts :: non_neg_integer(), last_ts_at :: undefined | integer(), tx :: term(), buffer :: term(), rid :: undefined | binary(), rid_ext :: undefined | pos_integer(), rrid_ext :: undefined | pos_integer(), audio_level_ext :: undefined | pos_integer(), pause :: undefined | webrtc_rtp_pause:sender(), hold_off :: non_neg_integer(), cycles :: non_neg_integer(), red_prev :: undefined | {0..127, non_neg_integer(), binary()}, picture_id :: 0..32767, fec_group :: [{0..65535, binary()}], fec_ssrc :: undefined | non_neg_integer(), fec_seq :: 0..65535, plugin :: undefined | {module(), term()} | {off, term()}, ext_form :: webrtc_rtp_ext:form(), tmmbr :: undefined | webrtc_tmmbr:state(), limiter :: undefined | webrtc_rate_limit:state(), limit :: non_neg_integer() | infinity, ntp_ext :: undefined | pos_integer(), sync_acked :: boolean(), sync_key_ts :: undefined | non_neg_integer(), sync_next :: boolean(), sync_req :: boolean(), priority :: webrtc_dscp:priority(), interactive :: boolean(), key_ts :: undefined | non_neg_integer()}}, receivers :: #{non_neg_integer() => #rcv{mid :: binary(), clock_rate :: pos_integer(), rx :: term(), nack :: undefined | term(), recent :: webrtc_red:history(), frames :: undefined | webrtc_frame_buffer:state(), keyframe :: [pli | fir], loss_fb :: [sli | rpsi], sync :: undefined | {integer(), non_neg_integer()}, sr_ntp :: undefined | non_neg_integer(), sync_from :: undefined | integer(), fir_seq :: 0..255, plugin :: undefined | {module(), term(), binary()} | {off, term()}, fec :: undefined | webrtc_ulpfec:receiver()}}, ssrc_mid :: #{non_neg_integer() => binary()}, signaled :: #{non_neg_integer() => binary()}, last_seen :: #{non_neg_integer() => integer()}, rtx_ssrc :: #{non_neg_integer() => non_neg_integer()}, pt_mid :: #{0..127 => binary()}, mid_ext :: #{binary() => pos_integer()}, recv :: #{binary() => map()}, rids :: webrtc_media_rid:state(), twcc_ids :: [pos_integer()], cc :: webrtc_cc:state(), rtcp :: undefined | webrtc_rtcp_sched:state(), rtcp_opts :: map(), pending_fb :: list(), dscp_off :: [0..63], ended :: [{non_neg_integer(), map(), map()}], limit_req :: #{binary() => {pos_integer() | infinity, [non_neg_integer()]}}, reduced_size :: boolean(), cryptex :: boolean(), send_encrypted :: [pos_integer()], recv_encrypted :: [pos_integer()], rtp_sent_mark :: non_neg_integer(), rtcp_rot :: non_neg_integer(), pause_req :: #{non_neg_integer() => webrtc_rtp_pause:requester()}, counters :: map(), xr_rrtr :: #{non_neg_integer() => {0..4294967295, integer()}}, sources :: #{binary() => map()}, raw :: undefined | binary(), video_fec :: auto | float(), playouts :: #{binary() => map()}, streams :: #{{in | out, non_neg_integer()} => map()}}) -> [#rtcp_sli{sender_ssrc :: rtcp_u32(), media_ssrc :: rtcp_u32(), entries :: [{0..8191, 0..8191, 0..63}]} | #rtcp_rpsi{sender_ssrc :: rtcp_u32(), media_ssrc :: rtcp_u32(), pt :: 0..127, bits :: bitstring()}].
RTCP for the indications a decoding plugin returned on stream Ssrc, those the stream negotiated.
-spec received(#rtcp_sli{sender_ssrc :: rtcp_u32(), media_ssrc :: rtcp_u32(), entries :: [{0..8191, 0..8191, 0..63}]} | #rtcp_rpsi{sender_ssrc :: rtcp_u32(), media_ssrc :: rtcp_u32(), pt :: 0..127, bits :: bitstring()}, #media{cname :: binary(), ecn :: boolean(), rtcp_ssrc :: non_neg_integer(), out :: undefined | term(), in :: undefined | term(), senders :: #{sender_key() => #snd{mid :: binary(), kind :: audio | video, ssrc :: non_neg_integer(), rtx_ssrc :: non_neg_integer(), codecs :: [map()], rtx :: #{0..127 => 0..127}, mid_ext :: undefined | pos_integer(), twcc_ext :: undefined | pos_integer(), seq :: 0..65535, rtx_seq :: 0..65535, last_ts :: non_neg_integer(), last_ts_at :: undefined | integer(), tx :: term(), buffer :: term(), rid :: undefined | binary(), rid_ext :: undefined | pos_integer(), rrid_ext :: undefined | pos_integer(), audio_level_ext :: undefined | pos_integer(), pause :: undefined | webrtc_rtp_pause:sender(), hold_off :: non_neg_integer(), cycles :: non_neg_integer(), red_prev :: undefined | {0..127, non_neg_integer(), binary()}, picture_id :: 0..32767, fec_group :: [{0..65535, binary()}], fec_ssrc :: undefined | non_neg_integer(), fec_seq :: 0..65535, plugin :: undefined | {module(), term()} | {off, term()}, ext_form :: webrtc_rtp_ext:form(), tmmbr :: undefined | webrtc_tmmbr:state(), limiter :: undefined | webrtc_rate_limit:state(), limit :: non_neg_integer() | infinity, ntp_ext :: undefined | pos_integer(), sync_acked :: boolean(), sync_key_ts :: undefined | non_neg_integer(), sync_next :: boolean(), sync_req :: boolean(), priority :: webrtc_dscp:priority(), interactive :: boolean(), key_ts :: undefined | non_neg_integer()}}, receivers :: #{non_neg_integer() => #rcv{mid :: binary(), clock_rate :: pos_integer(), rx :: term(), nack :: undefined | term(), recent :: webrtc_red:history(), frames :: undefined | webrtc_frame_buffer:state(), keyframe :: [pli | fir], loss_fb :: [sli | rpsi], sync :: undefined | {integer(), non_neg_integer()}, sr_ntp :: undefined | non_neg_integer(), sync_from :: undefined | integer(), fir_seq :: 0..255, plugin :: undefined | {module(), term(), binary()} | {off, term()}, fec :: undefined | webrtc_ulpfec:receiver()}}, ssrc_mid :: #{non_neg_integer() => binary()}, signaled :: #{non_neg_integer() => binary()}, last_seen :: #{non_neg_integer() => integer()}, rtx_ssrc :: #{non_neg_integer() => non_neg_integer()}, pt_mid :: #{0..127 => binary()}, mid_ext :: #{binary() => pos_integer()}, recv :: #{binary() => map()}, rids :: webrtc_media_rid:state(), twcc_ids :: [pos_integer()], cc :: webrtc_cc:state(), rtcp :: undefined | webrtc_rtcp_sched:state(), rtcp_opts :: map(), pending_fb :: list(), dscp_off :: [0..63], ended :: [{non_neg_integer(), map(), map()}], limit_req :: #{binary() => {pos_integer() | infinity, [non_neg_integer()]}}, reduced_size :: boolean(), cryptex :: boolean(), send_encrypted :: [pos_integer()], recv_encrypted :: [pos_integer()], rtp_sent_mark :: non_neg_integer(), rtcp_rot :: non_neg_integer(), pause_req :: #{non_neg_integer() => webrtc_rtp_pause:requester()}, counters :: map(), xr_rrtr :: #{non_neg_integer() => {0..4294967295, integer()}}, sources :: #{binary() => map()}, raw :: undefined | binary(), video_fec :: auto | float(), playouts :: #{binary() => map()}, streams :: #{{in | out, non_neg_integer()} => map()}}) -> {#media{cname :: binary(), ecn :: boolean(), rtcp_ssrc :: non_neg_integer(), out :: undefined | term(), in :: undefined | term(), senders :: #{sender_key() => #snd{mid :: binary(), kind :: audio | video, ssrc :: non_neg_integer(), rtx_ssrc :: non_neg_integer(), codecs :: [map()], rtx :: #{0..127 => 0..127}, mid_ext :: undefined | pos_integer(), twcc_ext :: undefined | pos_integer(), seq :: 0..65535, rtx_seq :: 0..65535, last_ts :: non_neg_integer(), last_ts_at :: undefined | integer(), tx :: term(), buffer :: term(), rid :: undefined | binary(), rid_ext :: undefined | pos_integer(), rrid_ext :: undefined | pos_integer(), audio_level_ext :: undefined | pos_integer(), pause :: undefined | webrtc_rtp_pause:sender(), hold_off :: non_neg_integer(), cycles :: non_neg_integer(), red_prev :: undefined | {0..127, non_neg_integer(), binary()}, picture_id :: 0..32767, fec_group :: [{0..65535, binary()}], fec_ssrc :: undefined | non_neg_integer(), fec_seq :: 0..65535, plugin :: undefined | {module(), term()} | {off, term()}, ext_form :: webrtc_rtp_ext:form(), tmmbr :: undefined | webrtc_tmmbr:state(), limiter :: undefined | webrtc_rate_limit:state(), limit :: non_neg_integer() | infinity, ntp_ext :: undefined | pos_integer(), sync_acked :: boolean(), sync_key_ts :: undefined | non_neg_integer(), sync_next :: boolean(), sync_req :: boolean(), priority :: webrtc_dscp:priority(), interactive :: boolean(), key_ts :: undefined | non_neg_integer()}}, receivers :: #{non_neg_integer() => #rcv{mid :: binary(), clock_rate :: pos_integer(), rx :: term(), nack :: undefined | term(), recent :: webrtc_red:history(), frames :: undefined | webrtc_frame_buffer:state(), keyframe :: [pli | fir], loss_fb :: [sli | rpsi], sync :: undefined | {integer(), non_neg_integer()}, sr_ntp :: undefined | non_neg_integer(), sync_from :: undefined | integer(), fir_seq :: 0..255, plugin :: undefined | {module(), term(), binary()} | {off, term()}, fec :: undefined | webrtc_ulpfec:receiver()}}, ssrc_mid :: #{non_neg_integer() => binary()}, signaled :: #{non_neg_integer() => binary()}, last_seen :: #{non_neg_integer() => integer()}, rtx_ssrc :: #{non_neg_integer() => non_neg_integer()}, pt_mid :: #{0..127 => binary()}, mid_ext :: #{binary() => pos_integer()}, recv :: #{binary() => map()}, rids :: webrtc_media_rid:state(), twcc_ids :: [pos_integer()], cc :: webrtc_cc:state(), rtcp :: undefined | webrtc_rtcp_sched:state(), rtcp_opts :: map(), pending_fb :: list(), dscp_off :: [0..63], ended :: [{non_neg_integer(), map(), map()}], limit_req :: #{binary() => {pos_integer() | infinity, [non_neg_integer()]}}, reduced_size :: boolean(), cryptex :: boolean(), send_encrypted :: [pos_integer()], recv_encrypted :: [pos_integer()], rtp_sent_mark :: non_neg_integer(), rtcp_rot :: non_neg_integer(), pause_req :: #{non_neg_integer() => webrtc_rtp_pause:requester()}, counters :: map(), xr_rrtr :: #{non_neg_integer() => {0..4294967295, integer()}}, sources :: #{binary() => map()}, raw :: undefined | binary(), video_fec :: auto | float(), playouts :: #{binary() => map()}, streams :: #{{in | out, non_neg_integer()} => map()}}, list()}.
An SLI or RPSI from the peer.
-spec receiver_kinds([map()]) -> [sli | rpsi].
The indications a receive stream negotiated with its codecs.
-spec send(term(), indication(), integer(), #media{cname :: binary(), ecn :: boolean(), rtcp_ssrc :: non_neg_integer(), out :: undefined | term(), in :: undefined | term(), senders :: #{sender_key() => #snd{mid :: binary(), kind :: audio | video, ssrc :: non_neg_integer(), rtx_ssrc :: non_neg_integer(), codecs :: [map()], rtx :: #{0..127 => 0..127}, mid_ext :: undefined | pos_integer(), twcc_ext :: undefined | pos_integer(), seq :: 0..65535, rtx_seq :: 0..65535, last_ts :: non_neg_integer(), last_ts_at :: undefined | integer(), tx :: term(), buffer :: term(), rid :: undefined | binary(), rid_ext :: undefined | pos_integer(), rrid_ext :: undefined | pos_integer(), audio_level_ext :: undefined | pos_integer(), pause :: undefined | webrtc_rtp_pause:sender(), hold_off :: non_neg_integer(), cycles :: non_neg_integer(), red_prev :: undefined | {0..127, non_neg_integer(), binary()}, picture_id :: 0..32767, fec_group :: [{0..65535, binary()}], fec_ssrc :: undefined | non_neg_integer(), fec_seq :: 0..65535, plugin :: undefined | {module(), term()} | {off, term()}, ext_form :: webrtc_rtp_ext:form(), tmmbr :: undefined | webrtc_tmmbr:state(), limiter :: undefined | webrtc_rate_limit:state(), limit :: non_neg_integer() | infinity, ntp_ext :: undefined | pos_integer(), sync_acked :: boolean(), sync_key_ts :: undefined | non_neg_integer(), sync_next :: boolean(), sync_req :: boolean(), priority :: webrtc_dscp:priority(), interactive :: boolean(), key_ts :: undefined | non_neg_integer()}}, receivers :: #{non_neg_integer() => #rcv{mid :: binary(), clock_rate :: pos_integer(), rx :: term(), nack :: undefined | term(), recent :: webrtc_red:history(), frames :: undefined | webrtc_frame_buffer:state(), keyframe :: [pli | fir], loss_fb :: [sli | rpsi], sync :: undefined | {integer(), non_neg_integer()}, sr_ntp :: undefined | non_neg_integer(), sync_from :: undefined | integer(), fir_seq :: 0..255, plugin :: undefined | {module(), term(), binary()} | {off, term()}, fec :: undefined | webrtc_ulpfec:receiver()}}, ssrc_mid :: #{non_neg_integer() => binary()}, signaled :: #{non_neg_integer() => binary()}, last_seen :: #{non_neg_integer() => integer()}, rtx_ssrc :: #{non_neg_integer() => non_neg_integer()}, pt_mid :: #{0..127 => binary()}, mid_ext :: #{binary() => pos_integer()}, recv :: #{binary() => map()}, rids :: webrtc_media_rid:state(), twcc_ids :: [pos_integer()], cc :: webrtc_cc:state(), rtcp :: undefined | webrtc_rtcp_sched:state(), rtcp_opts :: map(), pending_fb :: list(), dscp_off :: [0..63], ended :: [{non_neg_integer(), map(), map()}], limit_req :: #{binary() => {pos_integer() | infinity, [non_neg_integer()]}}, reduced_size :: boolean(), cryptex :: boolean(), send_encrypted :: [pos_integer()], recv_encrypted :: [pos_integer()], rtp_sent_mark :: non_neg_integer(), rtcp_rot :: non_neg_integer(), pause_req :: #{non_neg_integer() => webrtc_rtp_pause:requester()}, counters :: map(), xr_rrtr :: #{non_neg_integer() => {0..4294967295, integer()}}, sources :: #{binary() => map()}, raw :: undefined | binary(), video_fec :: auto | float(), playouts :: #{binary() => map()}, streams :: #{{in | out, non_neg_integer()} => map()}}) -> {ok, [{send, binary()}], #media{cname :: binary(), ecn :: boolean(), rtcp_ssrc :: non_neg_integer(), out :: undefined | term(), in :: undefined | term(), senders :: #{sender_key() => #snd{mid :: binary(), kind :: audio | video, ssrc :: non_neg_integer(), rtx_ssrc :: non_neg_integer(), codecs :: [map()], rtx :: #{0..127 => 0..127}, mid_ext :: undefined | pos_integer(), twcc_ext :: undefined | pos_integer(), seq :: 0..65535, rtx_seq :: 0..65535, last_ts :: non_neg_integer(), last_ts_at :: undefined | integer(), tx :: term(), buffer :: term(), rid :: undefined | binary(), rid_ext :: undefined | pos_integer(), rrid_ext :: undefined | pos_integer(), audio_level_ext :: undefined | pos_integer(), pause :: undefined | webrtc_rtp_pause:sender(), hold_off :: non_neg_integer(), cycles :: non_neg_integer(), red_prev :: undefined | {0..127, non_neg_integer(), binary()}, picture_id :: 0..32767, fec_group :: [{0..65535, binary()}], fec_ssrc :: undefined | non_neg_integer(), fec_seq :: 0..65535, plugin :: undefined | {module(), term()} | {off, term()}, ext_form :: webrtc_rtp_ext:form(), tmmbr :: undefined | webrtc_tmmbr:state(), limiter :: undefined | webrtc_rate_limit:state(), limit :: non_neg_integer() | infinity, ntp_ext :: undefined | pos_integer(), sync_acked :: boolean(), sync_key_ts :: undefined | non_neg_integer(), sync_next :: boolean(), sync_req :: boolean(), priority :: webrtc_dscp:priority(), interactive :: boolean(), key_ts :: undefined | non_neg_integer()}}, receivers :: #{non_neg_integer() => #rcv{mid :: binary(), clock_rate :: pos_integer(), rx :: term(), nack :: undefined | term(), recent :: webrtc_red:history(), frames :: undefined | webrtc_frame_buffer:state(), keyframe :: [pli | fir], loss_fb :: [sli | rpsi], sync :: undefined | {integer(), non_neg_integer()}, sr_ntp :: undefined | non_neg_integer(), sync_from :: undefined | integer(), fir_seq :: 0..255, plugin :: undefined | {module(), term(), binary()} | {off, term()}, fec :: undefined | webrtc_ulpfec:receiver()}}, ssrc_mid :: #{non_neg_integer() => binary()}, signaled :: #{non_neg_integer() => binary()}, last_seen :: #{non_neg_integer() => integer()}, rtx_ssrc :: #{non_neg_integer() => non_neg_integer()}, pt_mid :: #{0..127 => binary()}, mid_ext :: #{binary() => pos_integer()}, recv :: #{binary() => map()}, rids :: webrtc_media_rid:state(), twcc_ids :: [pos_integer()], cc :: webrtc_cc:state(), rtcp :: undefined | webrtc_rtcp_sched:state(), rtcp_opts :: map(), pending_fb :: list(), dscp_off :: [0..63], ended :: [{non_neg_integer(), map(), map()}], limit_req :: #{binary() => {pos_integer() | infinity, [non_neg_integer()]}}, reduced_size :: boolean(), cryptex :: boolean(), send_encrypted :: [pos_integer()], recv_encrypted :: [pos_integer()], rtp_sent_mark :: non_neg_integer(), rtcp_rot :: non_neg_integer(), pause_req :: #{non_neg_integer() => webrtc_rtp_pause:requester()}, counters :: map(), xr_rrtr :: #{non_neg_integer() => {0..4294967295, integer()}}, sources :: #{binary() => map()}, raw :: undefined | binary(), video_fec :: auto | float(), playouts :: #{binary() => map()}, streams :: #{{in | out, non_neg_integer()} => map()}}} | {error, not_negotiated}.
Send an indication to the senders of a transceiver (Mid) or of one simulcast layer ({Mid, Rid}).