audio_frame.h

/*
 * Copyright 2025 LiveKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an “AS IS” BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <cstdint>
#include <string>
#include <vector>
 
#include "livekit/visibility.h"
 
namespace livekit {
 
namespace proto {
class AudioFrameBufferInfo;
class OwnedAudioFrameBuffer;
} // namespace proto
 
class LIVEKIT_API AudioFrame {
public:
  AudioFrame(std::vector<std::int16_t> data, int sample_rate, int num_channels, int samples_per_channel);
  AudioFrame(); // Default constructor
  virtual ~AudioFrame() = default;
 
  static AudioFrame create(int sample_rate, int num_channels, int samples_per_channel);
 
  static AudioFrame fromOwnedInfo(const proto::OwnedAudioFrameBuffer& owned);
 
  // ---- Accessors ----
 
  const std::vector<std::int16_t>& data() const noexcept { return data_; }
  std::vector<std::int16_t>& data() noexcept { return data_; }
 
  std::size_t totalSamples() const noexcept { return data_.size(); }
 
  int sampleRate() const noexcept { return sample_rate_; }
 
  int numChannels() const noexcept { return num_channels_; }
 
  int samplesPerChannel() const noexcept { return samples_per_channel_; }
 
  double duration() const noexcept;
 
  std::string toString() const;
 
protected:
  // Build a proto AudioFrameBufferInfo pointing at this frame’s data.
  // Used internally by AudioSource.
  proto::AudioFrameBufferInfo toProto() const;
  friend class AudioSource;
 
private:
  std::vector<std::int16_t> data_;
  int sample_rate_;
  int num_channels_;
  int samples_per_channel_;
};
 
} // namespace livekit