Import of the watch repository from Pebble

src/fw/services/normal/audio_endpoint.h

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <inttypes.h>
+#include <stdlib.h>
+
+//! Endpoint for transferring audio data between the watch and phone
+//! https://pebbletechnology.atlassian.net/wiki/pages/viewpage.action?pageId=491698
+
+//! Session identifier passed to endpoint functions
+typedef uint16_t AudioEndpointSessionId;
+#define AUDIO_ENDPOINT_SESSION_INVALID_ID (0)
+
+//! Function signature of the callback to handle stop transfer message received from phone
+typedef void (*AudioEndpointStopTransferCallback)(AudioEndpointSessionId session_id);
+
+//! Function signature of the callback to handle the completion of the setup process.
+//! After this point, the client may start adding audio frames using audio_endpoint_add_frame.
+typedef void (*AudioEndpointSetupCompleteCallback)(AudioEndpointSessionId session_id);
+
+//! Create a session for transferring audio data from watch to phone
+//! @param setup_completed Callback to handle the completion of the audio endpoint setup process.
+//! @param stop_transfer Callback to handle stop transfer message received from phone.
+//! @return Session identifier to pass to other endpoint functions
+AudioEndpointSessionId audio_endpoint_setup_transfer(
+    AudioEndpointSetupCompleteCallback setup_completed,
+    AudioEndpointStopTransferCallback stop_transfer);
+
+//! Add a frame of audio data to session's internal buffer
+//! @param session_id Session identifier returned by audio_endpoint_start_transfer
+//! @param frame Pointer to frame of encoded audio data
+//! @param frame_size Size of frame of encoded audio data in bytes
+void audio_endpoint_add_frame(AudioEndpointSessionId session_id, uint8_t *frame,
+    uint8_t frame_size);
+
+//! Stop transferring audio data from watch to phone
+//! @param session_id Session identifier returned by audio_endpoint_setup_transfer
+void audio_endpoint_stop_transfer(AudioEndpointSessionId session_id);
+
+//! Cancel a transfer session without sending a stop transfer message
+//! @param session_id Session identifier returned by audio_endpoint_setup_transfer
+void audio_endpoint_cancel_transfer(AudioEndpointSessionId session_id);