1/*
2 * Copyright (C) 2012 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_AUDIO_STREAM_OUT_SINK_H
18#define ANDROID_AUDIO_STREAM_OUT_SINK_H
19
20#include "NBAIO.h"
21
22namespace android {
23
24class StreamOutHalInterface;
25
26// not multi-thread safe
27class AudioStreamOutSink : public NBAIO_Sink {
28
29public:
30    AudioStreamOutSink(sp<StreamOutHalInterface> stream);
31    virtual ~AudioStreamOutSink();
32
33    // NBAIO_Port interface
34
35    virtual ssize_t negotiate(const NBAIO_Format offers[], size_t numOffers,
36                              NBAIO_Format counterOffers[], size_t& numCounterOffers);
37    //virtual NBAIO_Format format();
38
39    // NBAIO_Sink interface
40
41    //virtual size_t framesWritten() const;
42    //virtual size_t framesUnderrun() const;
43    //virtual size_t underruns() const;
44
45    // This is an over-estimate, and could dupe the caller into making a blocking write()
46    // FIXME Use an audio HAL API to query the buffer emptying status when it's available.
47    virtual ssize_t availableToWrite() { return mStreamBufferSizeBytes / mFrameSize; }
48
49    virtual ssize_t write(const void *buffer, size_t count);
50
51    virtual status_t getTimestamp(ExtendedTimestamp &timestamp);
52
53    // NBAIO_Sink end
54
55#if 0   // until necessary
56    sp<StreamOutHalInterface> stream() const { return mStream; }
57#endif
58
59private:
60    sp<StreamOutHalInterface> mStream;
61    size_t              mStreamBufferSizeBytes; // as reported by get_buffer_size()
62};
63
64}   // namespace android
65
66#endif  // ANDROID_AUDIO_STREAM_OUT_SINK_H
67