tirtc-devtools-cli 0.0.10 → 0.0.12

package/vendor/app-server/bin/runtime/macos-arm64/include/tirtc/audio.h

@@ -1,6 +1,8 @@
 #ifndef TIRTC_FACADE_AUDIO_H_
 #define TIRTC_FACADE_AUDIO_H_
 
+#include <stdint.h>
+
 #include "tirtc/audio_io.h"
 #include "tirtc/audio_processing.h"
 #include "tirtc/trp.h"
@@ -9,388 +11,125 @@
 extern "C" {
 #endif
 
-/**
- * @file tirtc/audio.h
- * @brief Audio facade layer built on top of `tirtc/trp.h`.
- *
- * This header adds local audio capture and remote audio playback objects to the
- * transport-facing facade.
- *
- * Typical uplink flow:
- * 1. Create a ::TirtcAudioInput.
- * 2. Bind a concrete capture backend with ::tirtc_audio_input_set_ain.
- * 3. Optionally configure processing options and an observer.
- * 4. Start the input and attach it to a connection stream.
- * 5. Detach, stop, and destroy the input during shutdown.
- *
- * Typical downlink flow:
- * 1. Create a ::TirtcAudioOutput.
- * 2. Bind a concrete playback backend with ::tirtc_audio_output_set_aout.
- * 3. Optionally configure playback options and an observer.
- * 4. Attach the output to a connected ::TirtcConn.
- * 5. Detach and destroy the output during shutdown.
- *
- * Ownership model:
- * - The caller owns all audio input and output handles.
- * - Attaching an object to a connection is a non-owning bind.
- * - Destroying a connection detaches bound audio objects but does not destroy
- *   them.
- */
-
-/** @brief Opaque audio uplink handle. */
 typedef struct TirtcAudioInput TirtcAudioInput;
 
-/** @brief Opaque audio downlink handle. */
 typedef struct TirtcAudioOutput TirtcAudioOutput;
 
-/**
- * @brief Generic input state used by audio and video input observers.
- *
- * The current facade implementation primarily reports RUNNING and STOPPED.
- * Callers should still handle the full enum for forward compatibility.
- */
 typedef enum TirtcInputState {
-  /** Input exists but has not started running yet. */
+
   TIRTC_INPUT_STATE_IDLE = 0,
 
-  /** Input is actively capturing or producing data. */
   TIRTC_INPUT_STATE_RUNNING = 1,
 
-  /** Reserved paused state. */
-  TIRTC_INPUT_STATE_PAUSED = 2,
-
-  /** Input is stopped. */
-  TIRTC_INPUT_STATE_STOPPED = 3,
+  TIRTC_INPUT_STATE_STOPPED = 2,
 
-  /** Reserved terminal failure state. */
-  TIRTC_INPUT_STATE_FAILED = 4,
+  TIRTC_INPUT_STATE_FAILED = 3,
 } TirtcInputState;
 
-/**
- * @brief Audio output state reported through ::TirtcAudioOutputObserver.
- */
 typedef enum TirtcAudioOutputState {
-  /** Output is attached but not currently rendering audio. */
-  TIRTC_AUDIO_OUTPUT_STATE_IDLE = 0,
 
-  /** Output is actively playing remote audio. */
-  TIRTC_AUDIO_OUTPUT_STATE_PLAYING = 1,
-
-  /** Output is waiting for enough decoded audio to continue playback. */
-  TIRTC_AUDIO_OUTPUT_STATE_BUFFERING = 2,
+  TIRTC_AUDIO_OUTPUT_STATE_IDLE = 0,
 
-  /** Reserved paused state. */
-  TIRTC_AUDIO_OUTPUT_STATE_PAUSED = 3,
+  TIRTC_AUDIO_OUTPUT_STATE_BUFFERING = 1,
 
-  /** Reserved completed state. */
-  TIRTC_AUDIO_OUTPUT_STATE_COMPLETED = 4,
+  TIRTC_AUDIO_OUTPUT_STATE_PLAYING = 2,
 
-  /** Output encountered repeated playback failures. */
-  TIRTC_AUDIO_OUTPUT_STATE_FAILED = 5,
+  TIRTC_AUDIO_OUTPUT_STATE_FAILED = 3,
 } TirtcAudioOutputState;
 
-/**
- * @brief Audio input processing options.
- *
- * These options are consumed when the internal uplink pipeline is created.
- * Configure them before the first successful start for predictable behavior.
- */
 typedef struct TirtcAudioInputOptions {
-  /**
-   * @brief Capture sample rate.
-   *
-   * The current implementation defaults to 16 kHz when this field is set to
-   * ::TIRTC_AUDIO_SAMPLE_RATE_NONE.
-   */
   TirtcAudioSampleRate sample_rate;
 
-  /** @brief Acoustic echo cancellation mode. */
   TirtcAudioAecMode aec_mode;
 
-  /** @brief Automatic gain control level. */
   TirtcAudioAgcLevel agc_level;
 
-  /** @brief Acoustic noise suppression level. */
   TirtcAudioAnsLevel ans_level;
 } TirtcAudioInputOptions;
 
-/**
- * @brief Audio output playback options.
- *
- * Configure these options before attaching the output to a connection. The
- * current API does not support updating them while the output remains bound.
- */
 typedef struct TirtcAudioOutputOptions {
-  /**
-   * @brief Playback volume in percent.
-   *
-   * The current implementation treats `0` as the default `100` percent.
-   */
   uint32_t volume_percent;
 
-  /** @brief Additional gain level forwarded to the downlink pipeline. */
   int gain_level;
 
-  /** @brief Additional noise-reduction level forwarded to the downlink pipeline. */
   int noise_reduction_level;
 } TirtcAudioOutputOptions;
 
 /**
- * @brief Optional observer for an audio input object.
- *
- * The implementation stores a copy of this structure. Installing or replacing
- * an observer does not replay prior state; callbacks describe subsequent local
- * start and stop transitions.
+ * Audio input observer.
  *
- * Callback delivery is not guaranteed to be on a fixed thread. In the current
- * implementation, input state notifications may be dispatched synchronously by
- * API calls such as ::tirtc_audio_input_start and ::tirtc_audio_input_stop.
- * Callers must therefore make callback logic safe for reentrant delivery.
+ * `owned_message` is allocated by facade for this callback dispatch. Consumers must release it
+ * with `tirtc_owned_string_release()` after copying or converting the string they need.
  */
 typedef struct TirtcAudioInputObserver {
-  /**
-   * @brief Called when the input starts or stops.
-   *
-   * In the current implementation, a start failure is reported as STOPPED with
-   * a non-OK ::error value.
-   */
-  void (*on_state_changed)(TirtcAudioInput* input, TirtcInputState state, TirtcError error,
-                           void* user_data);
+  void (*on_state_changed)(TirtcAudioInput* input, TirtcInputState state, void* user_data);
+
+  void (*on_error)(TirtcAudioInput* input, TirtcError error, TirtcOwnedString* owned_message,
+                   void* user_data);
 } TirtcAudioInputObserver;
 
 /**
- * @brief Optional observer for an audio output object.
- *
- * The implementation stores a copy of this structure. Installing or replacing
- * an observer does not replay the current output state.
+ * Audio output observer.
  *
- * Callback delivery is not guaranteed to be on a fixed thread. State changes
- * may be reported synchronously by attach or detach paths, or asynchronously
- * from the internal downlink pipeline. Callers must therefore make callback
- * logic safe for reentrant delivery and perform their own thread handoff when
- * thread affinity is required.
+ * `owned_message` is allocated by facade for this callback dispatch. Consumers must release it
+ * with `tirtc_owned_string_release()` after copying or converting the string they need.
  */
 typedef struct TirtcAudioOutputObserver {
-  /**
-   * @brief Called when the output state changes.
-   *
-   * A common sequence is IDLE after attach, then BUFFERING, then PLAYING, and
-   * IDLE again after detach.
-   * Repeated downlink failures may eventually promote the output to FAILED.
-   */
-  void (*on_state_changed)(TirtcAudioOutput* output, TirtcAudioOutputState state, TirtcError error,
-                           void* user_data);
-} TirtcAudioOutputObserver;
+  void (*on_state_changed)(TirtcAudioOutput* output, TirtcAudioOutputState state, void* user_data);
 
-/**
- * @brief Attach an audio input to a connection stream.
- *
- * This bind is non-owning. The same input cannot be attached to more than one
- * connection at a time. The selected ::stream_id must be unique across all
- * audio inputs, video inputs, and video outputs currently attached to the same
- * connection.
- *
- * The input may be attached before or after ::tirtc_audio_input_start. Audio
- * is actually sent only while the input is both attached and running.
- *
- * @param connection Target connection.
- * @param stream_id Stream identifier that will carry this audio route.
- * @param input Audio input to bind.
- * @return ::TIRTC_ERROR_OK on success.
- */
-TirtcError tirtc_conn_attach_audio_input(TirtcConn* connection, uint8_t stream_id,
-                                         TirtcAudioInput* input);
-
-/**
- * @brief Attach a remote audio output to a connection stream.
- *
- * This bind is non-owning. The same output cannot be attached to more than
- * one connection stream at a time. Configure the output with
- * ::tirtc_audio_output_set_aout and any desired options before attaching it.
- *
- * If an observer is already installed, a successful attach typically reports an
- * initial IDLE state before playback begins.
- *
- * @param connection Target connection.
- * @param stream_id Remote audio stream identifier to render.
- * @param output Audio output to bind.
- * @return ::TIRTC_ERROR_OK on success.
- */
-TirtcError tirtc_conn_attach_audio_output(TirtcConn* connection, uint8_t stream_id,
-                                          TirtcAudioOutput* output);
+  void (*on_error)(TirtcAudioOutput* output, TirtcError error, TirtcOwnedString* owned_message,
+                   void* user_data);
+} TirtcAudioOutputObserver;
 
-/**
- * @brief Detach an audio input from a connection stream.
- *
- * This call is idempotent. If the stream is attached, the internal uplink path
- * for that bind is stopped and the input returns to an unbound state.
- *
- * @param connection Target connection.
- * @param stream_id Stream identifier to detach.
- * @return ::TIRTC_ERROR_OK on success.
- */
-TirtcError tirtc_conn_detach_audio_input(TirtcConn* connection, uint8_t stream_id);
+TirtcError tirtc_conn_subscribe_audio(TirtcConn* connection, uint8_t stream_id);
 
-/**
- * @brief Detach an audio output from a connection stream.
- *
- * This call is idempotent.
- *
- * @param connection Target connection.
- * @param stream_id Stream identifier to detach.
- * @return ::TIRTC_ERROR_OK on success.
- */
-TirtcError tirtc_conn_detach_audio_output(TirtcConn* connection, uint8_t stream_id);
+TirtcError tirtc_conn_unsubscribe_audio(TirtcConn* connection, uint8_t stream_id);
 
-/**
- * @brief Create an audio input object.
- *
- * The runtime must already be initialized.
- *
- * @param out_input Receives the created input handle on success.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_input_create(TirtcAudioInput** out_input);
 
-/**
- * @brief Destroy an audio input object.
- *
- * The input must already be detached from any connection. If the input is
- * still bound, the current implementation keeps it alive and ignores the
- * destroy request.
- *
- * @param input Input handle to destroy.
- */
-void tirtc_audio_input_destroy(TirtcAudioInput* input);
-
-/**
- * @brief Bind a concrete audio capture backend to an input object.
- *
- * This must be done while the input is stopped and detached, before the next
- * successful start. The backend pointer is non-owning and must remain valid
- * while the input may still use it.
- *
- * @param input Target audio input.
- * @param ain Capture backend to bind.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_input_set_ain(TirtcAudioInput* input, TirtcAudioAin* ain);
 
-/**
- * @brief Store audio input processing options.
- *
- * Best practice is to call this before the first successful start. Updating
- * options after the internal uplink pipeline has already been created does not
- * retroactively rebuild that running pipeline.
- *
- * @param input Target audio input.
- * @param options Options to copy into the facade object.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_input_set_options(TirtcAudioInput* input,
                                          const TirtcAudioInputOptions* options);
 
-/**
- * @brief Install, replace, or clear the audio input observer.
- *
- * Passing NULL for ::observer clears the current observer. The implementation
- * stores a copy of the observer structure and does not require it to outlive
- * this call.
- *
- * @param input Target audio input.
- * @param observer Observer to install, or NULL to clear.
- * @param user_data Opaque pointer returned to observer callbacks.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_input_set_observer(TirtcAudioInput* input,
                                           const TirtcAudioInputObserver* observer, void* user_data);
 
-/**
- * @brief Start local audio capture for an input object.
- *
- * A capture backend must already be bound with ::tirtc_audio_input_set_ain.
- * Starting twice without an intervening stop is rejected.
- *
- * @param input Target audio input.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_input_start(TirtcAudioInput* input);
 
-/**
- * @brief Stop local audio capture for an input object.
- *
- * This is the normal pairing call for ::tirtc_audio_input_start. The current
- * implementation also tolerates stopping an already stopped input.
- *
- * @param input Target audio input.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_input_stop(TirtcAudioInput* input);
 
-/**
- * @brief Create an audio output object.
- *
- * The runtime must already be initialized.
- *
- * @param out_output Receives the created output handle on success.
- * @return ::TIRTC_ERROR_OK on success.
- */
-TirtcError tirtc_audio_output_create(TirtcAudioOutput** out_output);
+TirtcError tirtc_audio_input_attach(TirtcAudioInput* input, TirtcConn* connection,
+                                    uint8_t stream_id);
 
-/**
- * @brief Destroy an audio output object.
- *
- * The output must already be detached from any connection. If it is still
- * bound, the current implementation keeps it alive and ignores the destroy
- * request.
- *
- * @param output Output handle to destroy.
- */
-void tirtc_audio_output_destroy(TirtcAudioOutput* output);
+TirtcError tirtc_audio_input_detach(TirtcAudioInput* input, TirtcConn* connection);
+
+void tirtc_audio_input_destroy(TirtcAudioInput* input);
+
+TirtcError tirtc_audio_output_create(TirtcAudioOutput** out_output);
 
-/**
- * @brief Bind a concrete audio playback backend to an output object.
- *
- * The backend pointer is non-owning and should remain valid until the output
- * has been detached and destroyed. Passing NULL is not supported by this API.
- *
- * @param output Target audio output.
- * @param aout Playback backend to bind.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_output_set_aout(TirtcAudioOutput* output, TirtcAudioAout* aout);
 
-/**
- * @brief Store audio output playback options.
- *
- * This call is intended for the pre-attach configuration phase. The current
- * implementation rejects option changes while the output is attached.
- *
- * @param output Target audio output.
- * @param options Options to copy into the facade object.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_output_set_options(TirtcAudioOutput* output,
                                           const TirtcAudioOutputOptions* options);
 
-/**
- * @brief Install, replace, or clear the audio output observer.
- *
- * Passing NULL for ::observer clears the current observer. The implementation
- * stores a copy of the observer structure and does not require it to outlive
- * this call.
- *
- * @param output Target audio output.
- * @param observer Observer to install, or NULL to clear.
- * @param user_data Opaque pointer returned to observer callbacks.
- * @return ::TIRTC_ERROR_OK on success.
- */
 TirtcError tirtc_audio_output_set_observer(TirtcAudioOutput* output,
                                            const TirtcAudioOutputObserver* observer,
                                            void* user_data);
 
+TirtcError tirtc_audio_output_attach(TirtcAudioOutput* output, TirtcConn* connection,
+                                     uint8_t stream_id);
+
+TirtcError tirtc_audio_output_detach(TirtcAudioOutput* output);
+
+void tirtc_audio_output_destroy(TirtcAudioOutput* output);
+
+TirtcError tirtc_audio_output_start_raw_dump(TirtcAudioOutput* output);
+
+TirtcError tirtc_audio_output_stop_raw_dump(TirtcAudioOutput* output);
+
 #ifdef __cplusplus
 }
 #endif
 
-#endif  // TIRTC_FACADE_AUDIO_H_
+#endif