• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * libjingle
3  * Copyright 2013 Google Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  *  1. Redistributions of source code must retain the above copyright notice,
9  *     this list of conditions and the following disclaimer.
10  *  2. Redistributions in binary form must reproduce the above copyright notice,
11  *     this list of conditions and the following disclaimer in the documentation
12  *     and/or other materials provided with the distribution.
13  *  3. The name of the author may not be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef TALK_MEDIA_BASE_AUDIORENDERER_H_
29 #define TALK_MEDIA_BASE_AUDIORENDERER_H_
30 
31 #include <cstddef>
32 
33 namespace cricket {
34 
35 // Abstract interface for rendering the audio data.
36 class AudioRenderer {
37  public:
38   class Sink {
39    public:
40     // Callback to receive data from the AudioRenderer.
41     virtual void OnData(const void* audio_data,
42                         int bits_per_sample,
43                         int sample_rate,
44                         size_t number_of_channels,
45                         size_t number_of_frames) = 0;
46 
47     // Called when the AudioRenderer is going away.
48     virtual void OnClose() = 0;
49 
50    protected:
~Sink()51     virtual ~Sink() {}
52   };
53 
54   // Sets a sink to the AudioRenderer. There can be only one sink connected
55   // to the renderer at a time.
SetSink(Sink * sink)56   virtual void SetSink(Sink* sink) {}
57 
58  protected:
~AudioRenderer()59   virtual ~AudioRenderer() {}
60 };
61 
62 }  // namespace cricket
63 
64 #endif  // TALK_MEDIA_BASE_AUDIORENDERER_H_
65