media/mojo/services/webrtc_video_perf_recorder.h

   1 // Copyright 2022 The Chromium Authors
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef MEDIA_MOJO_SERVICES_WEBRTC_VIDEO_PERF_RECORDER_H_
   6 #define MEDIA_MOJO_SERVICES_WEBRTC_VIDEO_PERF_RECORDER_H_
   7
   8 #include <stdint.h>
   9
  10 #include "media/base/video_codecs.h"
  11 #include "media/mojo/mojom/media_types.mojom.h"
  12 #include "media/mojo/mojom/webrtc_video_perf.mojom.h"
  13 #include "media/mojo/services/media_mojo_export.h"
  14 #include "media/mojo/services/webrtc_video_perf_history.h"
  15
  16 namespace media {
  17
  18 // This class implements the mojo interface WebrtcVideoPerfRecorder. The purpose
  19 // of the class is to receive video perf data from the browser process and pass
  20 // the data on to the WebrtcVideoPerfHistory save callback.
  21 class MEDIA_MOJO_EXPORT WebrtcVideoPerfRecorder
  22     : public media::mojom::WebrtcVideoPerfRecorder {
  23  public:
  24   // Creates a WebrtcVideoPerfRecorder. `webrtc_video_perf_history` is required
  25   // to save stats to local database and report metrics. Callers must ensure
  26   // that `webrtc_video_perf_history` outlives this object; may be nullptr if
  27   // database recording is currently disabled.
  28   static void Create(
  29       media::WebrtcVideoPerfHistory* webrtc_video_perf_history,
  30       mojo::PendingReceiver<media::mojom::WebrtcVideoPerfRecorder> receiver);
  31
  32   explicit WebrtcVideoPerfRecorder(
  33       WebrtcVideoPerfHistory::SaveCallback save_cb);
  34   ~WebrtcVideoPerfRecorder() override;
  35   WebrtcVideoPerfRecorder(const WebrtcVideoPerfRecorder&) = delete;
  36   WebrtcVideoPerfRecorder& operator=(const WebrtcVideoPerfRecorder&) = delete;
  37
  38   // mojom::WebrtcVideoPerfRecorder implementation. Tracks `features` and
  39   // `video_stats` individually for encode and decode. Flushes the data to the
  40   // database by calling `save_cb_` whenever `features` is changed. An empty
  41   // pair of `features` and `video_stats` may be passed to the function to
  42   // signal that no more data is expected for the current `features` and force a
  43   // call to `save_cb_` with the current state.
  44   void UpdateRecord(media::mojom::WebrtcPredictionFeaturesPtr features,
  45                     media::mojom::WebrtcVideoStatsPtr video_stats) override;
  46
  47  private:
  48   // Starts a new recording of stats, this essentially means flushing any
  49   // existing stats to the DB and storing the specified `features`.
  50   void StartNewRecord(media::mojom::WebrtcPredictionFeaturesPtr features);
  51   // Save most recent stats values to the database. Called during destruction
  52   // and upon starting a new record.
  53   void FinalizeRecord(int encode_or_decode_index);
  54
  55   const WebrtcVideoPerfHistory::SaveCallback save_cb_;
  56   // `features_` tracks the last video configuration that was supplied to
  57   // UpdateRecord(). This is individually tracked for encode and decode stats
  58   // per the video configuration.
  59   media::mojom::WebrtcPredictionFeatures features_[2];
  60   media::mojom::WebrtcVideoStats video_stats_[2];
  61 };
  62
  63 }  // namespace media
  64
  65 #endif  // MEDIA_MOJO_SERVICES_WEBRTC_VIDEO_PERF_RECORDER_H_