summaryrefslogtreecommitdiffstats
path: root/chromium/third_party/blink/renderer/modules/webaudio/audio_buffer.h
blob: 43ef43a8c89cdc06db498d082be7c06bc6204fd8 (plain)
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
145
146
147
148
149
150
151
152
153
154
155
156
/*
 * Copyright (C) 2010 Google 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 Computer, 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.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_WEBAUDIO_AUDIO_BUFFER_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_WEBAUDIO_AUDIO_BUFFER_H_

#include "base/memory/scoped_refptr.h"
#include "third_party/blink/renderer/core/typed_arrays/array_buffer_view_helpers.h"
#include "third_party/blink/renderer/core/typed_arrays/dom_typed_array.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/bindings/script_wrappable.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"

namespace blink {

class AudioBus;
class AudioBufferOptions;
class ExceptionState;
class SharedAudioBuffer;

class MODULES_EXPORT AudioBuffer final : public ScriptWrappable {
  DEFINE_WRAPPERTYPEINFO();

 public:
  static AudioBuffer* Create(unsigned number_of_channels,
                             uint32_t number_of_frames,
                             float sample_rate);
  static AudioBuffer* Create(unsigned number_of_channels,
                             uint32_t number_of_frames,
                             float sample_rate,
                             ExceptionState&);
  static AudioBuffer* Create(const AudioBufferOptions*, ExceptionState&);

  // Creates an AudioBuffer with uninitialized contents.  This should
  // only be used where we are guaranteed to initialize the contents
  // with valid data and where JS cannot access until initializations
  // is done.  |OfflineAudioContext::startRendering()| is one such
  // place.
  static AudioBuffer* CreateUninitialized(unsigned number_of_channels,
                                          uint32_t number_of_frames,
                                          float sample_rate);

  static AudioBuffer* CreateFromAudioBus(AudioBus*);

  explicit AudioBuffer(AudioBus*);
  // How to initialize the contents of an AudioBuffer.  Default is to
  // zero-initialize (|kZeroInitialize|).  Otherwise, leave the array
  // uninitialized (|kDontInitialize|).
  enum InitializationPolicy { kZeroInitialize, kDontInitialize };
  AudioBuffer(unsigned number_of_channels,
              uint32_t number_of_frames,
              float sample_rate,
              InitializationPolicy allocation_policy = kZeroInitialize);

  // Format
  uint32_t length() const { return length_; }
  double duration() const {
    return length() / static_cast<double>(sampleRate());
  }
  float sampleRate() const { return sample_rate_; }

  // Channel data access
  unsigned numberOfChannels() const { return channels_.size(); }
  NotShared<DOMFloat32Array> getChannelData(unsigned channel_index,
                                            ExceptionState&);
  NotShared<DOMFloat32Array> getChannelData(unsigned channel_index);
  void copyFromChannel(NotShared<DOMFloat32Array>,
                       int32_t channel_number,
                       ExceptionState&);
  void copyFromChannel(NotShared<DOMFloat32Array>,
                       int32_t channel_number,
                       size_t buffer_offset,
                       ExceptionState&);
  void copyToChannel(NotShared<DOMFloat32Array>,
                     int32_t channel_number,
                     ExceptionState&);
  void copyToChannel(NotShared<DOMFloat32Array>,
                     int32_t channel_number,
                     size_t buffer_offset,
                     ExceptionState&);

  void Zero();

  void Trace(Visitor* visitor) const override {
    visitor->Trace(channels_);
    ScriptWrappable::Trace(visitor);
  }

  std::unique_ptr<SharedAudioBuffer> CreateSharedAudioBuffer();

 private:
  static DOMFloat32Array* CreateFloat32ArrayOrNull(
      uint32_t length,
      InitializationPolicy allocation_policy = kZeroInitialize);

  bool CreatedSuccessfully(unsigned desired_number_of_channels) const;

  float sample_rate_;
  uint32_t length_;

  HeapVector<Member<DOMFloat32Array>> channels_;
};

// Shared data that audio threads can hold onto.
class SharedAudioBuffer final {
  USING_FAST_MALLOC(SharedAudioBuffer);

 public:
  explicit SharedAudioBuffer(AudioBuffer*);

  unsigned numberOfChannels() const { return channels_.size(); }
  uint32_t length() const { return length_; }
  double duration() const {
    return length() / static_cast<double>(sampleRate());
  }
  float sampleRate() const { return sample_rate_; }

  const Vector<ArrayBufferContents>& channels() { return channels_; }

  void Zero();

 private:
  float sample_rate_;
  uint32_t length_;
  Vector<ArrayBufferContents> channels_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_WEBAUDIO_AUDIO_BUFFER_H_