File: GBMBufferSwapchain.h

package info (click to toggle)
webkit2gtk 2.42.2-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 362,452 kB
  • sloc: cpp: 2,881,971; javascript: 282,447; ansic: 134,088; python: 43,789; ruby: 18,308; perl: 15,872; asm: 14,389; xml: 4,395; yacc: 2,350; sh: 2,074; java: 1,734; lex: 1,323; makefile: 288; pascal: 60
file content (137 lines) | stat: -rw-r--r-- 4,612 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright (C) 2022 Metrological Group B.V.
 * Copyright (C) 2022 Igalia S.L.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#if USE(GBM)

#include "DMABufFormat.h"
#include "DMABufObject.h"
#include "DMABufReleaseFlag.h"
#include <array>
#include <cstdint>
#include <wtf/Noncopyable.h>
#include <wtf/Nonmovable.h>
#include <wtf/RefPtr.h>
#include <wtf/ThreadSafeRefCounted.h>

struct gbm_bo;

namespace WebCore {

class GBMBufferSwapchain : public ThreadSafeRefCounted<GBMBufferSwapchain> {
    WTF_MAKE_FAST_ALLOCATED;
public:
    // The size should be adjusted to the use-case.
    // For cyclical rendering (e.g. WebGL), Four should be ideal since we'll rely on
    // something like vsync to maintain a constant framerate and subsequent buffer churn.
    // There are other sporadic producers like software-based media decoders that will
    // be requesting and filling in buffers in bursts but still have them displayed on
    // a cyclical basis. Eight should be enough to cover that.
    // In any case, the swapchain will do whatever it can to reuse released buffers
    // and not unnecessarily spawn new ones, meaning the limit shouldn't be reached.
    // If it is, getBuffer() will return a null object and the producer has to
    // handle that somehow.
    enum class BufferSwapchainSize : unsigned {
        Four = 4,
        Eight = 8
    };

    explicit GBMBufferSwapchain(BufferSwapchainSize);
    ~GBMBufferSwapchain();

    struct BufferDescription {
        enum Flags : uint32_t {
            NoFlags = 0,
            LinearStorage = 1 << 0,
        };

        DMABufFormat format { };
        uint32_t width { 0 };
        uint32_t height  { 0 };
        uint32_t flags { NoFlags };
    };

    class Buffer : public ThreadSafeRefCounted<Buffer> {
        WTF_MAKE_FAST_ALLOCATED;
    public:
        Buffer(uint32_t, const BufferDescription&);
        ~Buffer();

        DMABufObject createDMABufObject(uintptr_t) const;

        struct PlaneData {
            WTF_MAKE_NONCOPYABLE(PlaneData);
            WTF_MAKE_NONMOVABLE(PlaneData);

            PlaneData() = default;
            ~PlaneData();

            DMABufFormat::FourCC fourcc { DMABufFormat::FourCC::Invalid };
            uint32_t width { 0 };
            uint32_t height { 0 };
            uint32_t stride { 0 };
            struct gbm_bo* bo { nullptr };
        };

        uint32_t handle() const { return m_handle; }

        unsigned numPlanes() const { return m_description.format.numPlanes; }
        const PlaneData& planeData(unsigned index) const
        {
            ASSERT(index < DMABufFormat::c_maxPlanes);
            return m_planes[index];
        }

    private:
        friend class GBMBufferSwapchain;

        uint32_t m_handle { 0 };
        struct {
            bool locked { false };
            DMABufReleaseFlag releaseFlag;
        } m_state;

        BufferDescription m_description;
        std::array<PlaneData, DMABufFormat::c_maxPlanes> m_planes;
    };

    RefPtr<Buffer> getBuffer(const BufferDescription&);

private:
    static constexpr unsigned c_maxBuffers = 8;

    uint32_t m_handleGenerator { 0 };
    struct {
        BufferDescription description;
        unsigned size { 0 };
        std::array<RefPtr<Buffer>, c_maxBuffers> object { };
    } m_array;
};

} // namespace WebCore

#endif // USE(GBM)