blob: 83f3d30dd2cfa27b3f9b452b9c64589b6f5691c6 [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include "base/callback.h"
#include "base/macros.h"
#include "media/base/media_export.h"
#include "media/base/video_codecs.h"
#include "ui/gfx/geometry/size.h"
namespace media {
// This defines the interface to be used by various media capabilities services
// to store/retrieve video decoding performance statistics.
class MEDIA_EXPORT VideoDecodeStatsDB {
// Simple description of video decode complexity, serving as a key to look up
// associated DecodeStatsEntries in the database.
struct MEDIA_EXPORT VideoDescKey {
static VideoDescKey MakeBucketedKey(VideoCodecProfile codec_profile,
const gfx::Size& size,
int frame_rate);
const VideoCodecProfile codec_profile;
const gfx::Size size;
const int frame_rate;
VideoDescKey(VideoCodecProfile codec_profile,
const gfx::Size& size,
int frame_rate);
// DecodeStatsEntry saved to identify the capabilities related to a given
// |VideoDescKey|.
struct MEDIA_EXPORT DecodeStatsEntry {
DecodeStatsEntry(uint64_t frames_decoded,
uint64_t frames_dropped,
uint64_t frames_decoded_power_efficient);
uint64_t frames_decoded;
uint64_t frames_dropped;
uint64_t frames_decoded_power_efficient;
virtual ~VideoDecodeStatsDB() = default;
// Run asynchronous initialization of database. Initialization must complete
// before calling other APIs. Initialization must be RE-RUN after calling
// DestroyStats() and receiving its completion callback. |init_cb| must not be
// a null callback.
virtual void Initialize(base::OnceCallback<void(bool)> init_cb) = 0;
// Appends `stats` to existing entry associated with `key`. Will create a new
// entry if none exists. The operation is asynchronous. The caller should be
// aware of potential race conditions when calling this method for the same
// `key` very close to other calls. `append_done_cb` will be run with a bool
// to indicate whether the save succeeded.
using AppendDecodeStatsCB = base::OnceCallback<void(bool)>;
virtual void AppendDecodeStats(const VideoDescKey& key,
const DecodeStatsEntry& entry,
AppendDecodeStatsCB append_done_cb) = 0;
// Returns the stats associated with `key`. The `get_stats_cb` will receive
// the stats in addition to a boolean signaling if the call was successful.
// DecodeStatsEntry can be nullptr if there was no data associated with `key`.
using GetDecodeStatsCB =
base::OnceCallback<void(bool, std::unique_ptr<DecodeStatsEntry>)>;
virtual void GetDecodeStats(const VideoDescKey& key,
GetDecodeStatsCB get_stats_cb) = 0;
// Clear all statistics by DESTROYING the underlying the database.
// DO NOT use the database until |callback| is run. When finished, users must
// RE-RUN Initialize() before performing further I/O.
virtual void DestroyStats(base::OnceClosure destroy_done_cb) = 0;
// Factory interface to create a DB instance.
class MEDIA_EXPORT VideoDecodeStatsDBFactory {
virtual ~VideoDecodeStatsDBFactory() {}
virtual std::unique_ptr<VideoDecodeStatsDB> CreateDB() = 0;
} // namespace media