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_AAUDIO_SERVICE_STREAM_MMAP_H
18 #define AAUDIO_AAUDIO_SERVICE_STREAM_MMAP_H
19 
20 #include <atomic>
21 
22 #include <android-base/thread_annotations.h>
23 #include <android-base/unique_fd.h>
24 #include <media/audiohal/StreamHalInterface.h>
25 #include <media/MmapStreamCallback.h>
26 #include <media/MmapStreamInterface.h>
27 #include <utils/RefBase.h>
28 #include <utils/String16.h>
29 #include <utils/Vector.h>
30 
31 #include "binding/AAudioServiceMessage.h"
32 #include "AAudioServiceStreamBase.h"
33 #include "binding/AudioEndpointParcelable.h"
34 #include "SharedMemoryProxy.h"
35 #include "TimestampScheduler.h"
36 #include "utility/MonotonicCounter.h"
37 
38 namespace aaudio {
39 
40 /**
41  * These corresponds to an EXCLUSIVE mode MMAP client stream.
42  * It has exclusive use of one AAudioServiceEndpointMMAP to communicate with the underlying
43  * device or port.
44  */
45 class AAudioServiceStreamMMAP : public AAudioServiceStreamBase {
46 
47 public:
48     AAudioServiceStreamMMAP(android::AAudioService &aAudioService,
49                             bool inService);
50     virtual ~AAudioServiceStreamMMAP() = default;
51 
52     aaudio_result_t open(const aaudio::AAudioStreamRequest &request) override;
53 
54     aaudio_result_t startClient(const android::AudioClient& client,
55                                 const audio_attributes_t *attr,
56                                 audio_port_handle_t *clientHandle) override;
57 
58     aaudio_result_t stopClient(audio_port_handle_t clientHandle) override;
59 
getTypeText()60     const char *getTypeText() const override { return "MMAP"; }
61 
62 protected:
63 
64     /**
65      * Stop the flow of data so that start() can resume without loss of data.
66      *
67      * This is not guaranteed to be synchronous but it currently is.
68      * An AAUDIO_SERVICE_EVENT_PAUSED will be sent to the client when complete.
69     */
70     aaudio_result_t pause_l() REQUIRES(mLock) override;
71 
72     aaudio_result_t stop_l() REQUIRES(mLock) override;
73 
74     aaudio_result_t getAudioDataDescription(AudioEndpointParcelable &parcelable) override;
75 
76     aaudio_result_t getFreeRunningPosition(int64_t *positionFrames,
77             int64_t *timeNanos) EXCLUDES(mLock) override;
78 
79     aaudio_result_t getHardwareTimestamp(int64_t *positionFrames, int64_t *timeNanos) override;
80 
81     /**
82      * Device specific startup.
83      * @return AAUDIO_OK or negative error.
84      */
85     aaudio_result_t startDevice() override;
86 
87 private:
88 
89     bool                     mInService = false;
90 };
91 
92 } // namespace aaudio
93 
94 #endif //AAUDIO_AAUDIO_SERVICE_STREAM_MMAP_H
95