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
31namespace cricket {
32
33// Abstract interface for rendering the audio data.
34class AudioRenderer {
35 public:
36  class Sink {
37   public:
38    // Callback to receive data from the AudioRenderer.
39    virtual void OnData(const void* audio_data,
40                        int bits_per_sample,
41                        int sample_rate,
42                        int number_of_channels,
43                        int number_of_frames) = 0;
44
45    // Called when the AudioRenderer is going away.
46    virtual void OnClose() = 0;
47
48   protected:
49    virtual ~Sink() {}
50  };
51
52  // Sets a sink to the AudioRenderer. There can be only one sink connected
53  // to the renderer at a time.
54  virtual void SetSink(Sink* sink) {}
55
56  // Add the WebRtc VoE channel to the renderer.
57  // For local stream, multiple WebRtc VoE channels can be connected to the
58  // renderer. While for remote stream, only one WebRtc VoE channel can be
59  // connected to the renderer.
60  // TODO(xians): Remove this interface after Chrome switches to the
61  // AudioRenderer::Sink interface.
62  virtual void AddChannel(int channel_id) {}
63
64  // Remove the WebRtc VoE channel from the renderer.
65  // This method is called when the VoE channel is going away.
66  // TODO(xians): Remove this interface after Chrome switches to the
67  // AudioRenderer::Sink interface.
68  virtual void RemoveChannel(int channel_id) {}
69
70 protected:
71  virtual ~AudioRenderer() {}
72};
73
74}  // namespace cricket
75
76#endif  // TALK_MEDIA_BASE_AUDIORENDERER_H_
77