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 <cstdint> 24 #include <future> 25 26 #include "audio_a2dp_hw/include/audio_a2dp_hw.h" 27 #include "bta/include/bta_av_api.h" 28 #include "stack/include/bt_hdr.h" 29 #include "types/raw_address.h" 30 31 // 32 // Audio focus state for audio track. 33 // 34 // NOTE: The values must be same as: 35 // - A2dpSinkStreamingStateMachine.STATE_FOCUS_LOST = 0 36 // - A2dpSinkStreamingStateMachine.STATE_FOCUS_GRANTED = 1 37 // 38 typedef enum { 39 BTIF_A2DP_SINK_FOCUS_NOT_GRANTED = 0, 40 BTIF_A2DP_SINK_FOCUS_GRANTED = 1 41 } btif_a2dp_sink_focus_state_t; 42 43 // Initialize the A2DP Sink module. 44 // This function should be called by the BTIF state machine prior to using the 45 // module. 46 bool btif_a2dp_sink_init(void); 47 48 // Startup the A2DP Sink module. 49 // This function should be called by the BTIF state machine after 50 // btif_a2dp_sink_init() to prepare for receiving and processing audio 51 // streaming. 52 bool btif_a2dp_sink_startup(void); 53 54 // Start the A2DP Sink session. 55 // This function should be called by the BTIF state machine after 56 // btif_a2dp_sink_startup() to start the streaming session for |peer_address|. 57 bool btif_a2dp_sink_start_session(const RawAddress& peer_address, 58 std::promise<void> peer_ready_promise); 59 60 // Restart the A2DP Sink session. 61 // This function should be called by the BTIF state machine after 62 // btif_a2dp_sink_startup() to restart the streaming session. 63 // |old_peer_address| is the peer address of the old session. This address 64 // can be empty. 65 // |new_peer_address| is the peer address of the new session. This address 66 // cannot be empty. 67 bool btif_a2dp_sink_restart_session(const RawAddress& old_peer_address, 68 const RawAddress& new_peer_address, 69 std::promise<void> peer_ready_promise); 70 71 // End the A2DP Sink session. 72 // This function should be called by the BTIF state machine to end the 73 // streaming session for |peer_address|. 74 bool btif_a2dp_sink_end_session(const RawAddress& peer_address); 75 76 // Shutdown the A2DP Sink module. 77 // This function should be called by the BTIF state machine before 78 // btif_a2dp_sink_cleanup() to shutdown the processing of the audio streaming. 79 void btif_a2dp_sink_shutdown(void); 80 81 // Cleanup the A2DP Sink module. 82 // This function should be called by the BTIF state machine during graceful 83 // cleanup. 84 void btif_a2dp_sink_cleanup(void); 85 86 // Get the audio sample rate for the A2DP Sink module. 87 tA2DP_SAMPLE_RATE btif_a2dp_sink_get_sample_rate(void); 88 89 // Get the audio channel count for the A2DP Sink module. 90 tA2DP_CHANNEL_COUNT btif_a2dp_sink_get_channel_count(void); 91 92 // Get the audio bits per sample for the A2DP Sink module. 93 tA2DP_BITS_PER_SAMPLE btif_a2dp_sink_get_bits_per_sample(void); 94 95 // Update the decoder for the A2DP Sink module. 96 // |p_codec_info| contains the new codec information. 97 void btif_a2dp_sink_update_decoder(const uint8_t* p_codec_info); 98 99 // Process 'idle' request from the BTIF state machine during initialization. 100 void btif_a2dp_sink_on_idle(void); 101 102 // Process 'stop' request from the BTIF state machine to stop A2DP streaming. 103 // |p_av_suspend| is the data associated with the request - see 104 // |tBTA_AV_SUSPEND|. 105 void btif_a2dp_sink_on_stopped(tBTA_AV_SUSPEND* p_av_suspend); 106 107 // Process 'suspend' request from the BTIF state machine to suspend A2DP 108 // streaming. 109 // |p_av_suspend| is the data associated with the request - see 110 // |tBTA_AV_SUSPEND|. 111 void btif_a2dp_sink_on_suspended(tBTA_AV_SUSPEND* p_av_suspend); 112 113 // Start the decoder for the A2DP Sink module. 114 bool btif_a2dp_sink_on_start(void); 115 116 // Enable/disable discarding of received A2DP frames. 117 // If |enable| is true, the discarding is enabled, otherwise is disabled. 118 void btif_a2dp_sink_set_rx_flush(bool enable); 119 120 // Enqueue a buffer to the A2DP Sink queue. If the queue has reached its 121 // maximum size |MAX_INPUT_A2DP_FRAME_QUEUE_SZ|, the oldest buffer is 122 // removed from the queue. 123 // |p_buf| is the buffer to enqueue. 124 // Returns the number of buffers in the Sink queue after the enqueing. 125 uint8_t btif_a2dp_sink_enqueue_buf(BT_HDR* p_buf); 126 127 // Dump debug-related information for the A2DP Sink module. 128 // |fd| is the file descriptor to use for writing the ASCII formatted 129 // information. 130 void btif_a2dp_sink_debug_dump(int fd); 131 132 // Create a request to set the audio focus state for the audio track. 133 // |state| is the new state value - see |btif_a2dp_sink_focus_state_t| 134 // for valid values. 135 void btif_a2dp_sink_set_focus_state_req(btif_a2dp_sink_focus_state_t state); 136 137 // Set the audio track gain for the audio track. 138 // |gain| is the audio track gain value to use. 139 void btif_a2dp_sink_set_audio_track_gain(float gain); 140 141 #endif /* BTIF_A2DP_SINK_H */ 142