Home | History | Annotate | Download | only in oboeservice 
      1 /*
      2  * Copyright (C) 2017 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 #ifndef AAUDIO_SERVICE_ENDPOINT_H
     18 #define AAUDIO_SERVICE_ENDPOINT_H
     19 
     20 #include <atomic>
     21 #include <functional>
     22 #include <mutex>
     23 #include <vector>
     24 
     25 #include "client/AudioStreamInternal.h"
     26 #include "client/AudioStreamInternalPlay.h"
     27 #include "core/AAudioStreamParameters.h"
     28 #include "binding/AAudioServiceMessage.h"
     29 #include "binding/AAudioStreamConfiguration.h"
     30 
     31 #include "AAudioServiceStreamBase.h"
     32 
     33 namespace aaudio {
     34 
     35 /**
     36  * AAudioServiceEndpoint is used by a subclass of AAudioServiceStreamBase
     37  * to communicate with the underlying audio device or port.
     38  */
     39 class AAudioServiceEndpoint
     40         : public virtual android::RefBase
     41         , public AAudioStreamParameters {
     42 public:
     43 
     44     virtual ~AAudioServiceEndpoint() = default;
     45 
     46     virtual std::string dump() const;
     47 
     48     virtual aaudio_result_t open(const aaudio::AAudioStreamRequest &request) = 0;
     49 
     50     virtual aaudio_result_t close() = 0;
     51 
     52     aaudio_result_t registerStream(android::sp<AAudioServiceStreamBase> stream);
     53 
     54     aaudio_result_t unregisterStream(android::sp<AAudioServiceStreamBase> stream);
     55 
     56     virtual aaudio_result_t startStream(android::sp<AAudioServiceStreamBase> stream,
     57                                         audio_port_handle_t *clientHandle) = 0;
     58 
     59     virtual aaudio_result_t stopStream(android::sp<AAudioServiceStreamBase> stream,
     60                                        audio_port_handle_t clientHandle) = 0;
     61 
     62     virtual aaudio_result_t startClient(const android::AudioClient& client,
     63                                         audio_port_handle_t *clientHandle) {
     64         ALOGD("AAudioServiceEndpoint::startClient(...) AAUDIO_ERROR_UNAVAILABLE");
     65         return AAUDIO_ERROR_UNAVAILABLE;
     66     }
     67 
     68     virtual aaudio_result_t stopClient(audio_port_handle_t clientHandle) {
     69         ALOGD("AAudioServiceEndpoint::stopClient(...) AAUDIO_ERROR_UNAVAILABLE");
     70         return AAUDIO_ERROR_UNAVAILABLE;
     71     }
     72 
     73     /**
     74      * @param positionFrames
     75      * @param timeNanos
     76      * @return AAUDIO_OK or AAUDIO_ERROR_UNAVAILABLE or other negative error
     77      */
     78     virtual aaudio_result_t getFreeRunningPosition(int64_t *positionFrames, int64_t *timeNanos) = 0;
     79 
     80     /**
     81      * Set time that the associated frame was presented to the hardware.
     82      *
     83      * @param positionFrames receive position, input value is ignored
     84      * @param timeNanos receive time, input value is ignored
     85      * @return AAUDIO_OK or AAUDIO_ERROR_UNAVAILABLE or other negative error
     86      */
     87     virtual aaudio_result_t getTimestamp(int64_t *positionFrames, int64_t *timeNanos) = 0;
     88 
     89     int32_t getFramesPerBurst() const {
     90         return mFramesPerBurst;
     91     }
     92 
     93     int32_t getRequestedDeviceId() const { return mRequestedDeviceId; }
     94 
     95     bool matches(const AAudioStreamConfiguration& configuration);
     96 
     97     // This should only be called from the AAudioEndpointManager under a mutex.
     98     int32_t getOpenCount() const {
     99         return mOpenCount;
    100     }
    101 
    102     // This should only be called from the AAudioEndpointManager under a mutex.
    103     void setOpenCount(int32_t count) {
    104         mOpenCount = count;
    105     }
    106 
    107     bool isConnected() const {
    108         return mConnected;
    109     }
    110 
    111 protected:
    112 
    113     /**
    114      * @param portHandle
    115      * @return return true if a stream with the given portHandle is registered
    116      */
    117     bool                     isStreamRegistered(audio_port_handle_t portHandle);
    118 
    119     void                     disconnectRegisteredStreams();
    120 
    121     mutable std::mutex       mLockStreams;
    122     std::vector<android::sp<AAudioServiceStreamBase>> mRegisteredStreams;
    123 
    124     SimpleDoubleBuffer<Timestamp>  mAtomicEndpointTimestamp;
    125 
    126     android::AudioClient     mMmapClient;   // set in open, used in open and startStream
    127 
    128     int32_t                  mFramesPerBurst = 0;
    129     int32_t                  mOpenCount = 0;
    130     int32_t                  mRequestedDeviceId = 0;
    131 
    132     std::atomic<bool>        mConnected{true};
    133 };
    134 
    135 } /* namespace aaudio */
    136 
    137 
    138 #endif //AAUDIO_SERVICE_ENDPOINT_H
    139