1 /*
2  * Copyright 2016 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 ANDROID_BINDING_AUDIO_ENDPOINT_PARCELABLE_H
18 #define ANDROID_BINDING_AUDIO_ENDPOINT_PARCELABLE_H
19 
20 #include <stdint.h>
21 
22 //#include <sys/mman.h>
23 #include <binder/Parcel.h>
24 #include <binder/Parcelable.h>
25 
26 #include "binding/AAudioServiceDefinitions.h"
27 #include "binding/RingBufferParcelable.h"
28 
29 using android::status_t;
30 using android::Parcel;
31 using android::Parcelable;
32 
33 namespace aaudio {
34 
35 /**
36  * Container for information about the message queues plus
37  * general stream information needed by AAudio clients.
38  * It contains no addresses, just sizes, offsets and file descriptors for
39  * shared memory that can be passed through Binder.
40  */
41 class AudioEndpointParcelable : public Parcelable {
42 public:
43     AudioEndpointParcelable();
44     virtual ~AudioEndpointParcelable();
45 
46     /**
47      * Add the file descriptor to the table.
48      * @return index in table or negative error
49      */
50     int32_t addFileDescriptor(int fd, int32_t sizeInBytes);
51 
52     virtual status_t writeToParcel(Parcel* parcel) const override;
53 
54     virtual status_t readFromParcel(const Parcel* parcel) override;
55 
56     aaudio_result_t resolve(EndpointDescriptor *descriptor);
57 
58     aaudio_result_t validate();
59 
60     aaudio_result_t close();
61 
62     void dump();
63 
64 public: // TODO add getters
65     // Set capacityInFrames to zero if Queue is unused.
66     RingBufferParcelable    mUpMessageQueueParcelable;   // server to client
67     RingBufferParcelable    mDownMessageQueueParcelable; // to server
68     RingBufferParcelable    mUpDataQueueParcelable;      // eg. record, could share same queue
69     RingBufferParcelable    mDownDataQueueParcelable;    // eg. playback
70 
71 private:
72     int32_t                 mNumSharedMemories = 0;
73     SharedMemoryParcelable  mSharedMemories[MAX_SHARED_MEMORIES];
74 };
75 
76 } /* namespace aaudio */
77 
78 #endif //ANDROID_BINDING_AUDIO_ENDPOINT_PARCELABLE_H
79