AudioEndpointParcelable.h revision 5ed503c7a66c90f93759c90237a9b432dbd93f9f 
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 BINDING_AUDIOENDPOINTPARCELABLE_H
18#define BINDING_AUDIOENDPOINTPARCELABLE_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
29using android::status_t;
30using android::Parcel;
31using android::Parcelable;
32
33namespace 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 */
41class AudioEndpointParcelable : public Parcelable {
42public:
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    void dump();
61
62public: // TODO add getters
63    // Set capacityInFrames to zero if Queue is unused.
64    RingBufferParcelable    mUpMessageQueueParcelable;   // server to client
65    RingBufferParcelable    mDownMessageQueueParcelable; // to server
66    RingBufferParcelable    mUpDataQueueParcelable;      // eg. record, could share same queue
67    RingBufferParcelable    mDownDataQueueParcelable;    // eg. playback
68
69private:
70    int32_t                 mNumSharedMemories = 0;
71    SharedMemoryParcelable  mSharedMemories[MAX_SHARED_MEMORIES];
72};
73
74} /* namespace aaudio */
75
76#endif //BINDING_AUDIOENDPOINTPARCELABLE_H
77