Microphone support for Pepper Flash.

ppapi/api/dev/ppb_audio_input_dev.idl

+/* 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.
+ */
+
+/**
+ * This file defines the <code>PPB_AudioInput_Dev</code> interface, which
+ * provides realtime audio input capture.
+ */
+
+label Chrome {
+  M17 = 0.1
+};
+
+/**
+ * <code>PPB_AudioInput_Callback</code> defines the type of an audio callback
+ * function used to provide the audio buffer with data. This callback will be
+ * called on a separate thread to the creation thread.
+ */
+typedef void PPB_AudioInput_Callback([out] mem_t sample_buffer,
+                                     [in] uint32_t buffer_size_in_bytes,
+                                     [inout] mem_t user_data);
+
+/**
+ * The <code>PPB_AudioInput_Dev</code> interface contains pointers to several
+ * functions for handling audio input resources.
+ */
+[version=0.1, macro="PPB_AUDIO_INPUT_DEV_INTERFACE"]

[dmichael (off chromium), 2011/11/17 04:05:21]

nit: I don't think you need this line ^^^

[ilja, 2011/11/17 04:55:29]

Peter and I put this in because the naming convention seems to be that
AudioInput in the interface definition below should be concatenated. But when
all lower cased (like in this file's name) or all upper cased (like in the
macro) then with an underscore.

[dmichael (off chromium), 2011/11/17 18:24:04]

I don't think there is a consistent convention :-).  See, e.g., PPB_URLLoader_*
for counter examples.

That said, I do prefer the one you're doing here. I'll mention this to Noel to
see what he thinks; the IDL compiler should be able enforce this convention (if
it's the one we want) without any special hints, and maybe we should
special-case the *other* way instead.

Leave it as-is; thanks for explaining.

+interface PPB_AudioInput_Dev {
+  /**
+   * Create is a pointer to a function that creates an audio input resource.
+   * No sound will be captured until StartCapture() is called.
+   */
+  PP_Resource Create(
+      [in] PP_Instance instance,
+      [in] PP_Resource config,
+      [in] PPB_AudioInput_Callback audio_input_callback,
+      [inout] mem_t user_data);
+
+  /**
+   * IsAudioInput is a pointer to a function that determines if the given
+   * resource is an audio input resource.
+   *
+   * @param[in] resource A PP_Resource containing a resource.
+   *
+   * @return A PP_BOOL containing containing PP_TRUE if the given resource is
+   * an audio input resource, otherwise PP_FALSE.
+   */
+  PP_Bool IsAudioInput(
+      [in] PP_Resource audio_input);

[dmichael (off chromium), 2011/11/17 04:05:21]

nit: It seems like this could all be 1 line (same below)

[viettrungluu, 2011/11/21 21:26:13]

This is currently the style consistently in the .idl files. If we change it, we
should go ahead and change all instances, but I'll hold off on it for now.

+
+  /**
+   * GetCurrrentConfig() returns an audio config resource for the given audio
+   * resource.
+   *
+   * @param[in] config A <code>PP_Resource</code> corresponding to an audio
+   * resource.
+   *
+   * @return A <code>PP_Resource</code> containing the audio config resource if
+   * successful.
+   */
+  PP_Resource GetCurrentConfig(
+      [in] PP_Resource audio_input);
+
+  /**
+   * StartCapture() starts the capture of the audio input resource and begins
+   * periodically calling the callback.
+   *
+   * @param[in] config A <code>PP_Resource</code> corresponding to an audio
+   * input resource.
+   *
+   * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if
+   * successful, otherwise <code>PP_FALSE</code>. Also returns
+   * <code>PP_TRUE</code> (and be a no-op) if called while callback is already
+   * in progress.
+   */
+  PP_Bool StartCapture(
+      [in] PP_Resource audio_input);
+
+  /**
+   * StopCapture is a pointer to a function that stops the capture of
+   * the audio input resource.
+   *
+   * @param[in] config A PP_Resource containing the audio input resource.
+   *
+   * @return A PP_BOOL containing PP_TRUE if successful, otherwise PP_FALSE.
+   * Also returns PP_TRUE (and is a no-op) if called while capture is already
+   * stopped. If a buffer is being captured, StopCapture will block until the
+   * call completes.
+   */
+  PP_Bool StopCapture(
+      [in] PP_Resource audio_input);
+};
+