File: AudioSegment.h

package info (click to toggle)
audacity 3.7.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 134,800 kB
  • sloc: cpp: 366,277; ansic: 198,323; lisp: 7,761; sh: 3,414; python: 1,501; xml: 1,385; perl: 854; makefile: 125
file content (46 lines) | stat: -rw-r--r-- 1,161 bytes parent folder | download | duplicates (2)
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
/*  SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************

  Audacity: A Digital Audio Editor

  AudioSegment.h

  Matthieu Hodgkinson

**********************************************************************/

#pragma once

#include "SampleCount.h"

#include <vector>

/**
 * @brief A generalization for audio segments, whether clips or silence between
 * clips.
 */
class STRETCHING_SEQUENCE_API AudioSegment
{
public:
   virtual ~AudioSegment();

   /**
    * @brief Fills `buffers` with as many as `numSamples` or the number of
    * remaining samples, whichever is smaller.
    * @param buffers Pointers to buffers, one for each channel.
    * @param numSamples The max. number of samples to write to each buffer.
    * @return The number of samples actually provided in each buffer.
    */
   virtual size_t
   GetFloats(float *const *buffers, size_t numSamples) = 0;

   /**
    * @brief The number of channels in the segment.
    */
   virtual size_t NChannels() const = 0;

   /**
    * @brief Whether the segment has no more samples to provide.
    */
   virtual bool Empty() const = 0;
};