summaryrefslogtreecommitdiffstats
path: root/ppapi/cpp/audio.h
blob: 6c8ede8f89bba41beba11cea4990e36432a9e484 (plain)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
// Copyright (c) 2011 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 PPAPI_CPP_AUDIO_H_
#define PPAPI_CPP_AUDIO_H_

#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/ppb_audio.h"
#include "ppapi/cpp/audio_config.h"
#include "ppapi/cpp/instance.h"
#include "ppapi/cpp/resource.h"

/// @file
/// This file defines the API to create realtime stereo audio streaming
/// capabilities.

namespace pp {

/// An audio resource. Refer to the
/// <a href="/chrome/nativeclient/docs/audio.html">Pepper
/// Audio API Code Walkthrough</a> for information on using this interface.
class Audio : public Resource {
 public:

  /// An empty constructor for an Audio resource.
  Audio() {}

  /// A constructor that creates an Audio resource. No sound will be heard
  /// until StartPlayback() is called. The callback is called with the buffer
  /// address and given user data whenever the buffer needs to be filled.
  /// From within the callback, you should not call PPB_Audio functions.
  /// The callback will be called on a different thread than the one which
  /// created the interface. For performance-critical applications (i.e.
  /// low-latency audio), the callback should avoid blocking or calling
  /// functions that can obtain locks, such as malloc. The layout and the size
  /// of the buffer passed to the audio callback will be determined by
  /// the device configuration and is specified in the AudioConfig
  /// documentation.
  ///
  /// @param[in] instance A pointer to an Instance indentifying one instance of
  /// a module.
  /// @param[in] config An AudioConfig containing the audio config resource.
  /// @param[in] callback A PPB_Audio_Callback callback function that the
  /// browser calls when it needs more samples to play.
  /// @param[in] user_data A pointer to user data used in the callback function.
  Audio(Instance* instance,
        const AudioConfig& config,
        PPB_Audio_Callback callback,
        void* user_data);


  /// Getter function for returning the internal PPB_AudioConfig struct
  /// @return A mutable reference to the PPB_AudioConfig struct.
  AudioConfig& config() { return config_; }

  /// Getter function for returning the internal PPB_AudioConfig struct.
  /// @return A const reference to the internal PPB_AudioConfig struct.
  const AudioConfig& config() const { return config_; }

  /// A function to start playback of audio.
  bool StartPlayback();

  /// A function to stop playback of audio.
  bool StopPlayback();

 private:
  AudioConfig config_;
};

}  // namespace pp

#endif  // PPAPI_CPP_AUDIO_H_