AudioEndpointParcelable.h revision 5ed503c7a66c90f93759c90237a9b432dbd93f9f
1828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk/*
2828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * Copyright 2016 The Android Open Source Project
3828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk *
4828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * Licensed under the Apache License, Version 2.0 (the "License");
5828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * you may not use this file except in compliance with the License.
6828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * You may obtain a copy of the License at
7828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk *
8828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk *      http://www.apache.org/licenses/LICENSE-2.0
9828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk *
10828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * Unless required by applicable law or agreed to in writing, software
11828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * distributed under the License is distributed on an "AS IS" BASIS,
12828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * See the License for the specific language governing permissions and
14828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * limitations under the License.
15828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk */
16828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
17828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#ifndef BINDING_AUDIOENDPOINTPARCELABLE_H
18828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#define BINDING_AUDIOENDPOINTPARCELABLE_H
19828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
20828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#include <stdint.h>
21828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
22828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk//#include <sys/mman.h>
23828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#include <binder/Parcel.h>
24828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#include <binder/Parcelable.h>
25828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
265ed503c7a66c90f93759c90237a9b432dbd93f9fPhil Burk#include "binding/AAudioServiceDefinitions.h"
27828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#include "binding/RingBufferParcelable.h"
28828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
29828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkusing android::status_t;
30828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkusing android::Parcel;
31828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkusing android::Parcelable;
32828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
335ed503c7a66c90f93759c90237a9b432dbd93f9fPhil Burknamespace aaudio {
34828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
35828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk/**
36828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * Container for information about the message queues plus
375ed503c7a66c90f93759c90237a9b432dbd93f9fPhil Burk * general stream information needed by AAudio clients.
38828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * It contains no addresses, just sizes, offsets and file descriptors for
39828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk * shared memory that can be passed through Binder.
40828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk */
41828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkclass AudioEndpointParcelable : public Parcelable {
42828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkpublic:
43828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    AudioEndpointParcelable();
44828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    virtual ~AudioEndpointParcelable();
45828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
46828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    /**
47828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk     * Add the file descriptor to the table.
48828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk     * @return index in table or negative error
49828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk     */
50828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    int32_t addFileDescriptor(int fd, int32_t sizeInBytes);
51828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
52828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    virtual status_t writeToParcel(Parcel* parcel) const override;
53828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
54828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    virtual status_t readFromParcel(const Parcel* parcel) override;
55828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
565ed503c7a66c90f93759c90237a9b432dbd93f9fPhil Burk    aaudio_result_t resolve(EndpointDescriptor *descriptor);
57828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
585ed503c7a66c90f93759c90237a9b432dbd93f9fPhil Burk    aaudio_result_t validate();
59828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
60828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    void dump();
61828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
62828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkpublic: // TODO add getters
63828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    // Set capacityInFrames to zero if Queue is unused.
64828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    RingBufferParcelable    mUpMessageQueueParcelable;   // server to client
65828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    RingBufferParcelable    mDownMessageQueueParcelable; // to server
66828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    RingBufferParcelable    mUpDataQueueParcelable;      // eg. record, could share same queue
67828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    RingBufferParcelable    mDownDataQueueParcelable;    // eg. playback
68828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
69828bea5f61f3c40d24759cd8739dd95570883b56Phil Burkprivate:
70828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    int32_t                 mNumSharedMemories = 0;
71828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk    SharedMemoryParcelable  mSharedMemories[MAX_SHARED_MEMORIES];
72828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk};
73828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
745ed503c7a66c90f93759c90237a9b432dbd93f9fPhil Burk} /* namespace aaudio */
75828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk
76828bea5f61f3c40d24759cd8739dd95570883b56Phil Burk#endif //BINDING_AUDIOENDPOINTPARCELABLE_H
77