AudioWorkletProcessor: phương thức process()

Cú pháp

process(inputs, outputs, parameters)

Tham số

inputs

Một mảng các đầu vào được kết nối với nút; mỗi phần tử của nó lại là một mảng các kênh. Mỗi kênh là một Float32Array chứa 128 mẫu. Ví dụ, inputs[n][m][i] sẽ truy cập đầu vào thứ n, kênh thứ m của đầu vào đó, và mẫu thứ i của kênh đó.

Mỗi giá trị mẫu nằm trong khoảng [-1 .. 1].

Số lượng đầu vào, và do đó độ dài của mảng này, được cố định tại thời điểm tạo nút (xem AudioWorkletNode). Nếu không có nút hoạt động nào được kết nối tới đầu vào thứ n của nút, inputs[n] sẽ là một mảng rỗng (không có kênh đầu vào khả dụng).

Số lượng kênh trong mỗi đầu vào có thể thay đổi, tùy thuộc vào các thuộc tính channelCount và channelCountMode.

outputs

Một mảng các đầu ra có cấu trúc tương tự tham số inputs. Nó được thiết kế để được điền trong quá trình thực thi phương thức process(). Mỗi kênh đầu ra mặc định được điền bằng số không; processor sẽ xuất im lặng trừ khi các mảng đầu ra được sửa đổi.

parameters

Một đối tượng chứa các khóa chuỗi và các giá trị Float32Array. Với mỗi AudioParam tùy chỉnh được định nghĩa bằng getter parameterDescriptors, khóa trong đối tượng là name của AudioParam đó, còn giá trị là một Float32Array. Các giá trị của mảng được tính toán có xét đến các sự kiện tự động hóa đã được lên lịch.

Nếu tốc độ tự động hóa của tham số là "a-rate", mảng sẽ chứa 128 giá trị, một giá trị cho mỗi khung trong khối âm thanh hiện tại. Nếu không có tự động hóa nào diễn ra trong khoảng thời gian được biểu diễn bởi khối hiện tại, mảng có thể chỉ chứa một giá trị không đổi cho toàn bộ khối thay vì 128 giá trị giống hệt nhau.

Nếu tốc độ tự động hóa là "k-rate", mảng sẽ chỉ chứa một giá trị duy nhất để dùng cho cả 128 khung.

Giá trị trả về

Một giá trị Boolean cho biết có ép AudioWorkletNode tiếp tục hoạt động hay không, ngay cả khi logic nội bộ của trình đại diện người dùng lẽ ra đã quyết định rằng có thể tắt nút an toàn.

Giá trị trả về cho phép processor của bạn ảnh hưởng đến chính sách vòng đời của AudioWorkletProcessor và nút sở hữu nó. Nếu sự kết hợp giữa giá trị trả về và trạng thái của nút khiến trình duyệt quyết định dừng nút, process() sẽ không được gọi nữa.

Trả về true buộc Web Audio API giữ nút sống, còn trả về false cho phép trình duyệt chấm dứt nút nếu nó không tạo dữ liệu âm thanh mới và cũng không nhận dữ liệu qua các đầu vào để xử lý.

Ba loại nút âm thanh phổ biến nhất là:

1. Nguồn tạo đầu ra. Một AudioWorkletProcessor triển khai loại nút này nên trả về true từ phương thức process chừng nào nó còn tạo đầu ra. Phương thức nên trả về false ngay khi biết rằng nó sẽ không còn tạo đầu ra nữa. Ví dụ, với AudioBufferSourceNode, processor phía sau một nút như vậy nên trả về true từ phương thức process khi bộ đệm đang phát, và bắt đầu trả về false khi việc phát kết thúc (không có cách nào gọi play trên cùng một AudioBufferSourceNode lần nữa).
2. Nút biến đổi đầu vào của nó. Processor triển khai loại nút này nên trả về false từ phương thức process để sự hiện diện của các nút đầu vào đang hoạt động và các tham chiếu đến nút quyết định xem nó có thể được thu gom rác hay không. Ví dụ về nút có hành vi này là GainNode. Khi không còn đầu vào nào được kết nối và không còn tham chiếu được giữ lại, gain không thể tiếp tục được áp dụng cho bất cứ thứ gì, nên nút có thể được thu gom rác an toàn.
3. Nút biến đổi đầu vào của nó nhưng có cái gọi là tail-time - nghĩa là nó sẽ tiếp tục tạo đầu ra thêm một khoảng thời gian ngay cả sau khi đầu vào bị ngắt kết nối hoặc không còn hoạt động (tạo ra zero-channels). Processor triển khai loại nút này nên trả về true từ phương thức process trong suốt giai đoạn tail-time, bắt đầu ngay khi phát hiện các đầu vào chứa zero-channels. Ví dụ về một nút như vậy là DelayNode; nó có tail-time bằng với thuộc tính delayTime của nó.

Ngoại lệ

Vì phương thức process() do người dùng triển khai, nó có thể ném ra bất cứ thứ gì. Nếu một lỗi không được bắt bị ném ra, nút sẽ phát ra sự kiện processorerror và xuất im lặng trong suốt phần đời còn lại của nó.

Ví dụ

Trong ví dụ này, chúng ta tạo một AudioWorkletProcessor xuất nhiễu trắng tới đầu ra đầu tiên. Gain có thể được điều khiển bằng tham số customGain.

class WhiteNoiseProcessor extends AudioWorkletProcessor {
  process(inputs, outputs, parameters) {
    // lấy đầu ra đầu tiên
    const output = outputs[0];
    // điền mỗi kênh bằng các giá trị ngẫu nhiên được nhân với gain
    output.forEach((channel) => {
      for (let i = 0; i < channel.length; i++) {
        // tạo giá trị ngẫu nhiên cho từng mẫu
        // khoảng của Math.random là [0; 1); chúng ta cần [-1; 1]
        // cách này sẽ không bao gồm đúng giá trị 1, nhưng hiện tại vẫn ổn để đơn giản
        channel[i] =
          (Math.random() * 2 - 1) *
          // mảng có thể chứa 1 hoặc 128 giá trị
          // tùy thuộc có tự động hóa hay không
          // và tốc độ tự động hóa là k-rate hay a-rate
          (parameters["customGain"].length > 1
            ? parameters["customGain"][i]
            : parameters["customGain"][0]);
      }
    });
    // vì đây là một source node tự tạo đầu ra riêng,
    // chúng ta trả về true để nó không vô tình bị thu gom rác
    // nếu không còn tham chiếu nào tới nó trên luồng chính
    return true;
  }
  // định nghĩa tham số customGain được dùng trong phương thức process
  static get parameterDescriptors() {
    return [
      {
        name: "customGain",
        defaultValue: 1,
        minValue: 0,
        maxValue: 1,
        automationRate: "a-rate",
      },
    ];
  }
}

Thông số kỹ thuật

Tương thích trình duyệt

Đây không phải là một phương thức do trình duyệt cung cấp mà là một phương thức callback phải được viết trong mã phía máy khách.

Xem thêm

• Sử dụng Web Audio API