File: PixelBuffer.h

package info (click to toggle)
webkit2gtk 2.51.2-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 457,708 kB
  • sloc: cpp: 3,884,629; javascript: 198,661; ansic: 165,298; python: 49,171; asm: 21,849; ruby: 18,095; perl: 16,914; xml: 4,623; sh: 2,397; yacc: 2,356; java: 2,019; lex: 1,330; pascal: 372; makefile: 197
file content (144 lines) | stat: -rw-r--r-- 5,126 bytes parent folder | download | duplicates (2)
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
138
139
140
141
142
143
144
/*
 * Copyright (C) 2021-2022 Apple Inc. All rights reserved.
 *
 * 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

#include <WebCore/IntSize.h>
#include <WebCore/PixelBufferFormat.h>
#include <optional>
#include <span>
#include <wtf/RefCounted.h>

namespace WTF {
class TextStream;
}

namespace WebCore {

// Type for holding pixel buffers data.
// For functions that source pixel buffers, see PixelBufferSourceView.
class PixelBuffer : public RefCounted<PixelBuffer> {
    WTF_MAKE_NONCOPYABLE(PixelBuffer);
public:
    static constexpr uint32_t bytesPerPixelComponent(PixelFormat);
    static constexpr uint32_t componentsPerPixel(PixelFormat);
    static constexpr uint32_t bytesPerPixel(PixelFormat);

    static CheckedUint32 computePixelCount(const IntSize&);
    static CheckedUint32 computePixelComponentCount(PixelFormat, const IntSize&);
    WEBCORE_EXPORT static CheckedUint32 computeBufferSize(PixelFormat, const IntSize&);

    WEBCORE_EXPORT static bool supportedPixelFormat(PixelFormat);

    WEBCORE_EXPORT virtual ~PixelBuffer();

    const PixelBufferFormat& format() const { return m_format; }
    const IntSize& size() const { return m_size; }

    std::span<uint8_t> bytes() const { return m_bytes; }

    enum class Type {
        ByteArray,
#if ENABLE(PIXEL_FORMAT_RGBA16F)
        Float16Array,
#endif
        Other
    };
    virtual Type type() const { return Type::Other; }
    virtual RefPtr<PixelBuffer> createScratchPixelBuffer(const IntSize&) const = 0;

    bool setRange(std::span<const uint8_t> data, size_t byteOffset);
    WEBCORE_EXPORT bool zeroRange(size_t byteOffset, size_t rangeByteLength);
    void zeroFill() { zeroRange(0, bytes().size()); }

    WEBCORE_EXPORT uint8_t item(size_t index) const;
    void set(size_t index, double value);

protected:
    WEBCORE_EXPORT PixelBuffer(const PixelBufferFormat&, const IntSize&, std::span<uint8_t> bytes);

    PixelBufferFormat m_format;
    IntSize m_size;

    std::span<uint8_t> m_bytes;
};

// Type to use for functions that use the PixelBuffer data as source during the call, but do not store a reference to the object or modify the data.
class PixelBufferSourceView {
public:
    PixelBufferSourceView() = delete;
    PixelBufferSourceView(const PixelBuffer& pixelBuffer)
        : PixelBufferSourceView(pixelBuffer.format(), pixelBuffer.size(), pixelBuffer.bytes())
    {
    }

    static std::optional<PixelBufferSourceView> create(const PixelBufferFormat& format, const IntSize& size, std::span<const uint8_t> bytes)
    {
        if (!PixelBuffer::supportedPixelFormat(format.pixelFormat))
            return std::nullopt;
        auto bufferSize = PixelBuffer::computeBufferSize(format.pixelFormat, size);
        if (bufferSize.hasOverflowed() || bytes.size() != bufferSize)
            return std::nullopt;
        return PixelBufferSourceView(format, size, bytes);
    }

    const PixelBufferFormat& format() const { return m_format; }
    IntSize size() const { return m_size; }
    std::span<const uint8_t> bytes() const LIFETIME_BOUND { return m_bytes; }

private:
    PixelBufferSourceView(const PixelBufferFormat& format, const IntSize& size, std::span<const uint8_t> bytes)
        : m_format(format)
        , m_size(size)
        , m_bytes(bytes)
    {
    }

    PixelBufferFormat m_format;
    IntSize m_size;
    std::span<const uint8_t> m_bytes;
};

constexpr uint32_t PixelBuffer::bytesPerPixelComponent(PixelFormat pixelFormat)
{
#if ENABLE(PIXEL_FORMAT_RGBA16F)
    return (pixelFormat == PixelFormat::RGBA16F) ? 2 : 1;
#else
    UNUSED_PARAM(pixelFormat);
    return 1;
#endif
}

constexpr uint32_t PixelBuffer::componentsPerPixel(PixelFormat)
{
    return 4;
}

constexpr uint32_t PixelBuffer::bytesPerPixel(PixelFormat pixelFormat)
{
    return bytesPerPixelComponent(pixelFormat) * componentsPerPixel(pixelFormat);
}

} // namespace WebCore