zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use backticks not vertical bars to denote variables in comments for /api

Browse Source 
Bug: webrtc:12338
Change-Id: Ib97b2c3d64dbd895f261ffa76a2e885bd934a87f
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/226940
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34554}
This commit is contained in:
Artem Titov
2021-07-25 21:50:14 +02:00
committed by WebRTC LUCI CQ
parent 7750d802a5
commit 0e61fdd27c
94 changed files with 455 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
api/video_codecs/vp8_frame_buffer_controller.h
View File

@ -66,7 +66,7 @@ struct Vp8EncoderConfig {
// Number of active temporal layers. Set to 0 if not used.
uint32_t ts_number_layers;
// Arrays of length |ts_number_layers|, indicating (cumulative) target
// Arrays of length `ts_number_layers`, indicating (cumulative) target
// bitrate and rate decimator (e.g. 4 if every 4th frame is in the given
// layer) for each active temporal layer, starting with temporal id 0.
std::array<uint32_t, kMaxLayers> ts_target_bitrate;
@ -75,7 +75,7 @@ struct Vp8EncoderConfig {
// The periodicity of the temporal pattern. Set to 0 if not used.
uint32_t ts_periodicity;
// Array of length |ts_periodicity| indicating the sequence of temporal id's
// Array of length `ts_periodicity` indicating the sequence of temporal id's
// to assign to incoming frames.
std::array<uint32_t, kMaxPeriodicity> ts_layer_id;
};
@ -106,7 +106,7 @@ class Vp8FrameBufferController {
// The limits are suggestion-only; the controller is allowed to exceed them.
virtual void SetQpLimits(size_t stream_index, int min_qp, int max_qp) = 0;
// Number of streamed controlled by |this|.
// Number of streamed controlled by `this`.
virtual size_t StreamCount() const = 0;
// If this method returns true, the encoder is free to drop frames for
@ -121,7 +121,7 @@ class Vp8FrameBufferController {
virtual bool SupportsEncoderFrameDropping(size_t stream_index) const = 0;
// New target bitrate for a stream (each entry in
// |bitrates_bps| is for another temporal layer).
// `bitrates_bps` is for another temporal layer).
virtual void OnRatesUpdated(size_t stream_index,
const std::vector<uint32_t>& bitrates_bps,
int framerate_fps) = 0;
@ -130,7 +130,7 @@ class Vp8FrameBufferController {
// the controller wishes to enact in the encoder's configuration.
// If a value is not overridden, previous overrides are still in effect.
// However, if |Vp8EncoderConfig::reset_previous_configuration_overrides|
// is set to |true|, all previous overrides are reset.
// is set to `true`, all previous overrides are reset.
virtual Vp8EncoderConfig UpdateConfiguration(size_t stream_index) = 0;
// Returns the recommended VP8 encode flags needed.
@ -142,13 +142,13 @@ class Vp8FrameBufferController {
virtual Vp8FrameConfig NextFrameConfig(size_t stream_index,
uint32_t rtp_timestamp) = 0;
// Called after the encode step is done. |rtp_timestamp| must match the
// Called after the encode step is done. `rtp_timestamp` must match the
// parameter use in the NextFrameConfig() call.
// |is_keyframe| must be true iff the encoder decided to encode this frame as
// `is_keyframe` must be true iff the encoder decided to encode this frame as
// a keyframe.
// If |info| is not null, the encoder may update |info| with codec specific
// data such as temporal id. |qp| should indicate the frame-level QP this
// frame was encoded at. If the encoder does not support extracting this, |qp|
// If `info` is not null, the encoder may update `info` with codec specific
// data such as temporal id. `qp` should indicate the frame-level QP this
// frame was encoded at. If the encoder does not support extracting this, `qp`
// should be set to 0.
virtual void OnEncodeDone(size_t stream_index,
uint32_t rtp_timestamp,
@ -161,7 +161,7 @@ class Vp8FrameBufferController {
virtual void OnFrameDropped(size_t stream_index, uint32_t rtp_timestamp) = 0;
// Called by the encoder when the packet loss rate changes.
// |packet_loss_rate| runs between 0.0 (no loss) and 1.0 (everything lost).
// `packet_loss_rate` runs between 0.0 (no loss) and 1.0 (everything lost).
virtual void OnPacketLossRateUpdate(float packet_loss_rate) = 0;
// Called by the encoder when the round trip time changes.