1 /****************************************************************************** 2 * 3 * Copyright 2016 The Android Open Source Project 4 * Copyright 2009-2012 Broadcom Corporation 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at: 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 * 18 ******************************************************************************/ 19 20 #ifndef BTIF_A2DP_SINK_H 21 #define BTIF_A2DP_SINK_H 22 23 #include <inttypes.h> 24 #include <stdbool.h> 25 #include <future> 26 27 #include "bt_types.h" 28 #include "bta_av_api.h" 29 30 // 31 // Audio focus state for audio track. 32 // 33 // NOTE: The values must be same as: 34 // - A2dpSinkStreamingStateMachine.STATE_FOCUS_LOST = 0 35 // - A2dpSinkStreamingStateMachine.STATE_FOCUS_GRANTED = 1 36 // 37 typedef enum { 38 BTIF_A2DP_SINK_FOCUS_NOT_GRANTED = 0, 39 BTIF_A2DP_SINK_FOCUS_GRANTED = 1 40 } btif_a2dp_sink_focus_state_t; 41 42 // Initialize the A2DP Sink module. 43 // This function should be called by the BTIF state machine prior to using the 44 // module. 45 bool btif_a2dp_sink_init(void); 46 47 // Startup the A2DP Sink module. 48 // This function should be called by the BTIF state machine after 49 // btif_a2dp_sink_init() to prepare for receiving and processing audio 50 // streaming. 51 bool btif_a2dp_sink_startup(void); 52 53 // Start the A2DP Sink session. 54 // This function should be called by the BTIF state machine after 55 // btif_a2dp_sink_startup() to start the streaming session for |peer_address|. 56 bool btif_a2dp_sink_start_session(const RawAddress& peer_address, 57 std::promise<void> peer_ready_promise); 58 59 // Restart the A2DP Sink session. 60 // This function should be called by the BTIF state machine after 61 // btif_a2dp_sink_startup() to restart the streaming session. 62 // |old_peer_address| is the peer address of the old session. This address 63 // can be empty. 64 // |new_peer_address| is the peer address of the new session. This address 65 // cannot be empty. 66 bool btif_a2dp_sink_restart_session(const RawAddress& old_peer_address, 67 const RawAddress& new_peer_address, 68 std::promise<void> peer_ready_promise); 69 70 // End the A2DP Sink session. 71 // This function should be called by the BTIF state machine to end the 72 // streaming session for |peer_address|. 73 bool btif_a2dp_sink_end_session(const RawAddress& peer_address); 74 75 // Shutdown the A2DP Sink module. 76 // This function should be called by the BTIF state machine before 77 // btif_a2dp_sink_cleanup() to shutdown the processing of the audio streaming. 78 void btif_a2dp_sink_shutdown(void); 79 80 // Cleanup the A2DP Sink module. 81 // This function should be called by the BTIF state machine during graceful 82 // cleanup. 83 void btif_a2dp_sink_cleanup(void); 84 85 // Get the audio sample rate for the A2DP Sink module. 86 tA2DP_SAMPLE_RATE btif_a2dp_sink_get_sample_rate(void); 87 88 // Get the audio channel count for the A2DP Sink module. 89 tA2DP_CHANNEL_COUNT btif_a2dp_sink_get_channel_count(void); 90 91 // Get the audio bits per sample for the A2DP Sink module. 92 tA2DP_BITS_PER_SAMPLE btif_a2dp_sink_get_bits_per_sample(void); 93 94 // Update the decoder for the A2DP Sink module. 95 // |p_codec_info| contains the new codec information. 96 void btif_a2dp_sink_update_decoder(const uint8_t* p_codec_info); 97 98 // Process 'idle' request from the BTIF state machine during initialization. 99 void btif_a2dp_sink_on_idle(void); 100 101 // Process 'stop' request from the BTIF state machine to stop A2DP streaming. 102 // |p_av_suspend| is the data associated with the request - see 103 // |tBTA_AV_SUSPEND|. 104 void btif_a2dp_sink_on_stopped(tBTA_AV_SUSPEND* p_av_suspend); 105 106 // Process 'suspend' request from the BTIF state machine to suspend A2DP 107 // streaming. 108 // |p_av_suspend| is the data associated with the request - see 109 // |tBTA_AV_SUSPEND|. 110 void btif_a2dp_sink_on_suspended(tBTA_AV_SUSPEND* p_av_suspend); 111 112 // Enable/disable discarding of received A2DP frames. 113 // If |enable| is true, the discarding is enabled, otherwise is disabled. 114 void btif_a2dp_sink_set_rx_flush(bool enable); 115 116 // Enqueue a buffer to the A2DP Sink queue. If the queue has reached its 117 // maximum size |MAX_INPUT_A2DP_FRAME_QUEUE_SZ|, the oldest buffer is 118 // removed from the queue. 119 // |p_buf| is the buffer to enqueue. 120 // Returns the number of buffers in the Sink queue after the enqueing. 121 uint8_t btif_a2dp_sink_enqueue_buf(BT_HDR* p_buf); 122 123 // Dump debug-related information for the A2DP Sink module. 124 // |fd| is the file descriptor to use for writing the ASCII formatted 125 // information. 126 void btif_a2dp_sink_debug_dump(int fd); 127 128 // Create a request to set the audio focus state for the audio track. 129 // |state| is the new state value - see |btif_a2dp_sink_focus_state_t| 130 // for valid values. 131 void btif_a2dp_sink_set_focus_state_req(btif_a2dp_sink_focus_state_t state); 132 133 // Set the audio track gain for the audio track. 134 // |gain| is the audio track gain value to use. 135 void btif_a2dp_sink_set_audio_track_gain(float gain); 136 137 #endif /* BTIF_A2DP_SINK_H */ 138