Add support for reporting "display composited video frames" through the VideoPlayback...
[WebKit-https.git] / Source / WebCore / Modules / mediasource / VideoPlaybackQuality.h
1 /*
2  * Copyright (C) 2013-2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/Ref.h>
29 #include <wtf/RefCounted.h>
30
31 namespace WebCore {
32
33 struct VideoPlaybackQualityMetrics;
34
35 class VideoPlaybackQuality : public RefCounted<VideoPlaybackQuality> {
36     WTF_MAKE_NONCOPYABLE(VideoPlaybackQuality)
37 public:
38     static Ref<VideoPlaybackQuality> create(double creationTime, const VideoPlaybackQualityMetrics&);
39
40     double creationTime() const { return m_creationTime; }
41     unsigned totalVideoFrames() const { return m_totalVideoFrames; }
42     unsigned droppedVideoFrames() const { return m_droppedVideoFrames; }
43     unsigned corruptedVideoFrames() const { return m_corruptedVideoFrames; }
44     unsigned displayCompositedVideoFrames() const { return m_displayCompositedVideoFrames; }
45     double totalFrameDelay() const { return m_totalFrameDelay; }
46
47 private:
48     VideoPlaybackQuality(double creationTime, const VideoPlaybackQualityMetrics&);
49
50     double m_creationTime;
51     uint32_t m_totalVideoFrames;
52     uint32_t m_droppedVideoFrames;
53     uint32_t m_corruptedVideoFrames;
54     uint32_t m_displayCompositedVideoFrames;
55     double m_totalFrameDelay;
56 };
57
58 } // namespace WebCore