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