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
|
/*
* Copyright (C) 2010 Google Inc. All rights reserved.
* Copyright (C) 2017-2021 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.
* 3. Neither the name of Apple Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE 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 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 "AudioBufferOptions.h"
#include "ExceptionOr.h"
#include "JSValueInWrappedObject.h"
#include "ScriptWrappable.h"
#include <JavaScriptCore/Forward.h>
#include <JavaScriptCore/TypedArrayAdaptersForwardDeclarations.h>
#include <wtf/Lock.h>
#include <wtf/Vector.h>
namespace WebCore {
class AudioBus;
class WebCoreOpaqueRoot;
class AudioBuffer : public ScriptWrappable, public RefCounted<AudioBuffer> {
WTF_MAKE_TZONE_OR_ISO_ALLOCATED(AudioBuffer);
public:
enum class LegacyPreventDetaching : bool { No, Yes };
static RefPtr<AudioBuffer> create(unsigned numberOfChannels, size_t numberOfFrames, float sampleRate, LegacyPreventDetaching = LegacyPreventDetaching::No);
static ExceptionOr<Ref<AudioBuffer>> create(const AudioBufferOptions&);
// Returns nullptr if data is not a valid audio file.
static RefPtr<AudioBuffer> createFromAudioFileData(std::span<const uint8_t> data, bool mixToMono, float sampleRate);
// Format
size_t originalLength() const { return m_originalLength; }
double originalDuration() const { return originalLength() / static_cast<double>(sampleRate()); }
float sampleRate() const { return m_sampleRate; }
// The following function may start returning 0 if any of the underlying channel buffers gets detached.
size_t length() const { return hasDetachedChannelBuffer() ? 0 : m_originalLength; }
double duration() const { return length() / static_cast<double>(sampleRate()); }
void markBuffersAsNonDetachable();
// Channel data access
unsigned numberOfChannels() const { return m_channels.size(); }
ExceptionOr<JSC::JSValue> getChannelData(JSDOMGlobalObject&, unsigned channelIndex);
ExceptionOr<void> copyFromChannel(Ref<Float32Array>&&, unsigned channelNumber, unsigned bufferOffset);
ExceptionOr<void> copyToChannel(Ref<Float32Array>&&, unsigned channelNumber, unsigned startInChannel);
// Native channel data access.
RefPtr<Float32Array> channelData(unsigned channelIndex);
std::span<float> rawChannelData(unsigned channelIndex);
void zero();
// Because an AudioBuffer has a JavaScript wrapper, which will be garbage collected, it may take a while for this object to be deleted.
// releaseMemory() can be called when the AudioContext goes away, so we can release the memory earlier than when the garbage collection happens.
// Careful! Only call this when the page unloads, after the AudioContext is no longer processing.
void releaseMemory();
size_t memoryCost() const;
template<typename Visitor> void visitChannelWrappers(Visitor&);
bool copyTo(AudioBuffer&) const;
enum class ShouldCopyChannelData : bool { No, Yes };
Ref<AudioBuffer> clone(ShouldCopyChannelData = ShouldCopyChannelData::Yes) const;
bool topologyMatches(const AudioBuffer&) const;
void increaseNoiseInjectionMultiplier(float amount = 0.001) { m_noiseInjectionMultiplier += amount; }
float noiseInjectionMultiplier() const { return m_noiseInjectionMultiplier; }
private:
AudioBuffer(unsigned numberOfChannels, size_t length, float sampleRate, LegacyPreventDetaching = LegacyPreventDetaching::No);
explicit AudioBuffer(AudioBus&);
void invalidate();
bool hasDetachedChannelBuffer() const;
void applyNoiseIfNeeded();
// We do not currently support having the Float32Arrays in m_channels being more than 2GB,
// and we have tests that we return an error promptly on trying to create such a huge AudioBuffer.
static constexpr uint64_t s_maxChannelLength = (1ull << 32) / sizeof(float);
static constexpr uint64_t s_maxLength = 1ull << 32;
float m_sampleRate;
size_t m_originalLength;
FixedVector<RefPtr<Float32Array>> m_channels;
FixedVector<JSValueInWrappedObject> m_channelWrappers;
bool m_isDetachable { true };
mutable Lock m_channelsLock;
float m_noiseInjectionMultiplier { 0 };
};
WebCoreOpaqueRoot root(AudioBuffer*);
} // namespace WebCore
|
