ppapi/c/ppb_audio_frame.h - Issue 156863005: [PPAPI][MediaStream] Rename AudioFrame to AudioBuffer

Side by Side Diff: ppapi/c/ppb_audio_frame.h

Issue 156863005: [PPAPI][MediaStream] Rename AudioFrame to AudioBuffer (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@frame_to_buffer

Patch Set: Fix build errors Created 6 years, 10 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

OLD	NEW
	(Empty)
1 /* Copyright 2014 The Chromium Authors. All rights reserved.

2 * Use of this source code is governed by a BSD-style license that can be

3 * found in the LICENSE file.

4 */

5

6 /* From ppb_audio_frame.idl modified Wed Jan 29 13:24:24 2014. */

7

8 #ifndef PPAPI_C_PPB_AUDIO_FRAME_H_

9 #define PPAPI_C_PPB_AUDIO_FRAME_H_

10

11 #include "ppapi/c/pp_bool.h"

12 #include "ppapi/c/pp_macros.h"

13 #include "ppapi/c/pp_resource.h"

14 #include "ppapi/c/pp_stdint.h"

15 #include "ppapi/c/pp_time.h"

16

17 #define PPB_AUDIOFRAME_INTERFACE_0_1 "PPB_AudioFrame;0.1" /* dev */

18 /**

19 * @file

20 * Defines the <code>PPB_AudioFrame</code> interface.

21 */

22

23

24 /**

25 * @addtogroup Enums

26 * @{

27 */

28 /**

29 * PP_AudioFrame_SampleRate is an enumeration of the different audio sample

30 * rates.

31 */

32 typedef enum {

33 PP_AUDIOFRAME_SAMPLERATE_UNKNOWN = 0,

34 PP_AUDIOFRAME_SAMPLERATE_8000 = 8000,

35 PP_AUDIOFRAME_SAMPLERATE_44100 = 44100

36 } PP_AudioFrame_SampleRate;

37

38 /**

39 * PP_AudioFrame_SampleSize is an enumeration of the different audio sample

40 * sizes.

41 */

42 typedef enum {

43 PP_AUDIOFRAME_SAMPLESIZE_UNKNOWN = 0,

44 PP_AUDIOFRAME_SAMPLESIZE_16_BITS = 2

45 } PP_AudioFrame_SampleSize;

46 /**

47 * @}

48 */

49

50 /**

51 * @addtogroup Interfaces

52 * @{

53 */

54 struct PPB_AudioFrame_0_1 { /* dev */

55 /**

56 * Determines if a resource is an AudioFrame resource.

57 *

58 * @param[in] resource The <code>PP_Resource</code> to test.

59 *

60 * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given

61 * resource is an AudioFrame resource or <code>PP_FALSE</code> otherwise.

62 */

63 PP_Bool (*IsAudioFrame)(PP_Resource resource);

64 /**

65 * Gets the timestamp of the audio frame.

66 *

67 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

68 * resource.

69 *

70 * @return A <code>PP_TimeDelta</code> containing the timestamp of the audio

71 * frame. Given in seconds since the start of the containing audio stream.

72 */

73 PP_TimeDelta (*GetTimestamp)(PP_Resource frame);

74 /**

75 * Sets the timestamp of the audio frame.

76 *

77 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

78 * resource.

79 * @param[in] timestamp A <code>PP_TimeDelta</code> containing the timestamp

80 * of the audio frame. Given in seconds since the start of the containing

81 * audio stream.

82 */

83 void (*SetTimestamp)(PP_Resource frame, PP_TimeDelta timestamp);

84 /**

85 * Gets the sample rate of the audio frame.

86 *

87 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

88 * resource.

89 *

90 * @return The sample rate of the audio frame.

91 */

92 PP_AudioFrame_SampleRate (*GetSampleRate)(PP_Resource frame);

93 /**

94 * Gets the sample size of the audio frame.

95 *

96 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

97 * resource.

98 *

99 * @return The sample size of the audio frame.

100 */

101 PP_AudioFrame_SampleSize (*GetSampleSize)(PP_Resource frame);

102 /**

103 * Gets the number of channels in the audio frame.

104 *

105 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

106 * resource.

107 *

108 * @return The number of channels in the audio frame.

109 */

110 uint32_t (*GetNumberOfChannels)(PP_Resource frame);

111 /**

112 * Gets the number of samples in the audio frame.

113 *

114 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

115 * resource.

116 *

117 * @return The number of samples in the audio frame.

118 * For example, at a sampling rate of 44,100 Hz in stereo audio, a frame

119 * containing 4410 * 2 samples would have a duration of 100 milliseconds.

120 */

121 uint32_t (*GetNumberOfSamples)(PP_Resource frame);

122 /**

123 * Gets the data buffer containing the audio frame samples.

124 *

125 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

126 * resource.

127 *

128 * @return A pointer to the beginning of the data buffer.

129 */

130 void* (*GetDataBuffer)(PP_Resource frame);

131 /**

132 * Gets the size of the data buffer in bytes.

133 *

134 * @param[in] frame A <code>PP_Resource</code> corresponding to an audio frame

135 * resource.

136 *

137 * @return The size of the data buffer in bytes.

138 */

139 uint32_t (*GetDataBufferSize)(PP_Resource frame);

140 };

141 /**

142 * @}

143 */

144

145 #endif /* PPAPI_C_PPB_AUDIO_FRAME_H_ */

146

OLD	NEW

« no previous file with comments | « ppapi/c/ppb_audio_buffer.h ('k') | ppapi/c/ppb_media_stream_audio_track.h » ('j') | tools/metrics/histograms/histograms.xml » ('J')