AudioBus: Add a ToInterleavedFloat() method to AudioBus

media/base/audio_bus.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef MEDIA_BASE_AUDIO_BUS_H_
 #define MEDIA_BASE_AUDIO_BUS_H_
 
 #include <stdint.h>
 
 #include <memory>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/aligned_memory.h"
 #include "base/memory/ref_counted.h"
 #include "media/base/media_export.h"
 
 namespace media {
 class AudioParameters;
 
-// Scoped container for "busing" audio channel data around.  Each channel is
-// stored in planar format and guaranteed to be aligned by kChannelAlignment.
-// AudioBus objects can be created normally or via wrapping.  Normally, AudioBus
-// will dice up a contiguous memory block for channel data.  When wrapped,
-// AudioBus instead routes requests for channel data to the wrapped object.
+// Represents a sequence of audio frames containing frames() audio samples for
+// each of channels() channels. The data is stored as a set of contiguous
+// float arrays with one array per channel. The memory for the arrays is either
+// allocated and owned by the AudioBus or it is provided to one of the factory
+// methods. AudioBus guarantees that it allocates memory such that float array
+// for each channel is aligned by AudioBus::kChannelAlignment bytes and it
+// requires the same for memory passed to its Wrap...() factory methods.
+// TODO(chfremer: When can SetChannelData be used? There are currently no unit
+// tests involving CreateWrapper and SetChannelData, so we need to add them.
 class MEDIA_EXPORT AudioBus {
  public:
   // Guaranteed alignment of each channel's data; use 16-byte alignment for easy
   // SSE optimizations.
   enum { kChannelAlignment = 16 };
 
   // Creates a new AudioBus and allocates |channels| of length |frames|.  Uses
   // channels() and frames_per_buffer() from AudioParameters if given.
   static std::unique_ptr<AudioBus> Create(int channels, int frames);
   static std::unique_ptr<AudioBus> Create(const AudioParameters& params);
 
   // Creates a new AudioBus with the given number of channels, but zero length.
-  // It's expected to be used with SetChannelData() and set_frames() to
-  // wrap externally allocated memory.
+  // Clients are expected to subsequently call SetChannelData() and set_frames()
+  // to wrap externally allocated memory.
   static std::unique_ptr<AudioBus> CreateWrapper(int channels);
 
   // Creates a new AudioBus from an existing channel vector.  Does not transfer
   // ownership of |channel_data| to AudioBus; i.e., |channel_data| must outlive
   // the returned AudioBus.  Each channel must be aligned by kChannelAlignment.
   static std::unique_ptr<AudioBus> WrapVector(
       int frames,
       const std::vector<float*>& channel_data);
 
   // Creates a new AudioBus by wrapping an existing block of memory.  Block must
   // be at least CalculateMemorySize() bytes in size.  |data| must outlive the
   // returned AudioBus.  |data| must be aligned by kChannelAlignment.
   static std::unique_ptr<AudioBus> WrapMemory(int channels,
                                               int frames,
                                               void* data);
   static std::unique_ptr<AudioBus> WrapMemory(const AudioParameters& params,
                                               void* data);
+
+  // Based on the given number of channels and frames, calculates the minimum
+  // required size in bytes of a contiguous block of memory to be passed to
+  // AudioBus for storage of the audio data.
+  // Uses channels() and frames_per_buffer() from AudioParameters if given.
+  static int CalculateMemorySize(int channels, int frames);
   static int CalculateMemorySize(const AudioParameters& params);
 
-  // Calculates the required size for an AudioBus given the number of channels
-  // and frames.
-  static int CalculateMemorySize(int channels, int frames);
+  // Methods that are expected to be called after AudioBus::CreateWrapper() in
+  // order to wrap externally allocated memory. Note: It is illegal to call
+  // these methods when using a factory method other than CreateWrapper().
+  void SetChannelData(int channel, float* data);
+  void set_frames(int frames);
 
   // Helper methods for converting an AudioBus from and to interleaved integer
   // data.  Expects interleaving to be [ch0, ch1, ..., chN, ch0, ch1, ...] with
   // |bytes_per_sample| per value.  Values are scaled and bias corrected during
   // conversion.  ToInterleaved() will also clip values to format range.
   // Handles uint8_t, int16_t, and int32_t currently.  FromInterleaved() will
-  // zero out
-  // any unfilled frames when |frames| is less than frames().
+  // zero out any unfilled frames when |frames| is less than frames().
   void FromInterleaved(const void* source, int frames, int bytes_per_sample);
   void ToInterleaved(int frames, int bytes_per_sample, void* dest) const;
+  // TODO(chfremer): Instead of adding extra functions for float, it may be
+  // nicer to reuse the existing methods and replace |int bytes_per_sample" with

[miu, 2016/06/02 20:40:21]

FYI--We're actually trying to get rid of |bytes_per_sample| throughout the audio
stack. :)

The reason is that we want the audio stack to standardize on planar float PCM.
The conversion to/from interleaved int PCM is almost always a
platform-interface-glue detail.

+  // an enum indicating the frame type.
+  void ToInterleavedFloat(int source_offset,

[miu, 2016/06/02 20:40:21]

I agree with Miguel here, but realize it's a much larger change: Seems that we
should have templated From/ToInterleaved methods instead. Something like:

  template <typename InterleavedPODType>
  void FromInterleaved(const InterleavedPODType* source, int frames);

  template <typename InterleavedPODType>
  void ToInterleaved(int frames, InterleavedPODType* dest) const;

...where the only implemented InterleavedPODTypes would be int16_t and float
(unless there is actually code that uses 8-bit or 24-bit integer PCM?).

[chfremer, 2016/06/07 21:21:39]

Done.

+                          int destination_offset,

[miu, 2016/06/02 20:40:21]

nit: Please remove the |destination_offset| argument. Instead the caller should
do pointer math on |buffer| so that it points at the correct starting
destination location.

+                          int num_channels,

[miu, 2016/06/02 20:40:21]

This argument should be named |frames| (it's definitely not the number of
channels!).

+                          float* buffer) const;
   void ToInterleavedPartial(int start_frame, int frames, int bytes_per_sample,
                             void* dest) const;
 
   // Similar to FromInterleaved() above, but meant for streaming sources.  Does
   // not zero out remaining frames, the caller is responsible for doing so using
   // ZeroFramesPartial().  Frames are deinterleaved from the start of |source|
   // to channel(x)[start_frame].
   void FromInterleavedPartial(const void* source, int start_frame, int frames,
                               int bytes_per_sample);
 
   // Helper method for copying channel data from one AudioBus to another.  Both
   // AudioBus object must have the same frames() and channels().
   void CopyTo(AudioBus* dest) const;
 
   // Helper method to copy frames from one AudioBus to another. Both AudioBus
   // objects must have the same number of channels(). |source_start_frame| is
   // the starting offset. |dest_start_frame| is the starting offset in |dest|.
   // |frame_count| is the number of frames to copy.
   void CopyPartialFramesTo(int source_start_frame,
                            int frame_count,
                            int dest_start_frame,
                            AudioBus* dest) const;
 
   // Returns a raw pointer to the requested channel.  Pointer is guaranteed to
   // have a 16-byte alignment.  Warning: Do not rely on having sane (i.e. not
   // inf, nan, or between [-1.0, 1.0]) values in the channel data.
   float* channel(int channel) { return channel_data_[channel]; }
   const float* channel(int channel) const { return channel_data_[channel]; }
-  void SetChannelData(int channel, float* data);
 
+  // Returns the number of channels.
   int channels() const { return static_cast<int>(channel_data_.size()); }
+  // Returns the number of frames.
   int frames() const { return frames_; }
-  void set_frames(int frames);
 
   // Helper method for zeroing out all channels of audio data.
   void Zero();
   void ZeroFrames(int frames);
   void ZeroFramesPartial(int start_frame, int frames);
 
   // Checks if all frames are zero.
   bool AreFramesZero() const;
 
   // Scale internal channel values by |volume| >= 0.  If an invalid value
   // is provided, no adjustment is done.
   void Scale(float volume);
 
   // Swaps channels identified by |a| and |b|.  The caller needs to make sure
   // the channels are valid.
   void SwapChannels(int a, int b);
 
   virtual ~AudioBus();
 
  protected:
   AudioBus(int channels, int frames);
   AudioBus(int channels, int frames, float* data);
   AudioBus(int frames, const std::vector<float*>& channel_data);
   explicit AudioBus(int channels);
 
  private:
   // Helper method for building |channel_data_| from a block of memory.  |data|
-  // must be at least BlockSize() bytes in size.
+  // must be at least CalculateMemorySize(...) bytes in size.
   void BuildChannelData(int channels, int aligned_frame, float* data);
 
   // Contiguous block of channel memory.
   std::unique_ptr<float, base::AlignedFreeDeleter> data_;
 
+  // One float pointer per channel pointing to a contiguous block of memory for
+  // that channel. If the memory is owned by this instance, this will
+  // point to the memory in |data_|. Otherwise, it may point to memory provided
+  // by the client.
   std::vector<float*> channel_data_;
   int frames_;
 
   // Protect SetChannelData() and set_frames() for use by CreateWrapper().
   bool can_set_channel_data_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioBus);
 };
 
 // RefCounted version of AudioBus. This is not meant for general use. Only use
@@ skipping 10 matching lines @@
 
   AudioBusRefCounted(int channels, int frames);
   ~AudioBusRefCounted() override;
 
   DISALLOW_COPY_AND_ASSIGN(AudioBusRefCounted);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_BASE_AUDIO_BUS_H_