RecordTracks.h revision 84a0c6e87c48f58a0d3be71961432c086a4d24cc 
1/*
2**
3** Copyright 2012, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9**     http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
18#ifndef INCLUDING_FROM_AUDIOFLINGER_H
19    #error This header file should only be included from AudioFlinger.h
20#endif
21
22// record track
23class RecordTrack : public TrackBase {
24public:
25                        RecordTrack(RecordThread *thread,
26                                const sp<Client>& client,
27                                uint32_t sampleRate,
28                                audio_format_t format,
29                                audio_channel_mask_t channelMask,
30                                size_t frameCount,
31                                int sessionId,
32                                int uid);
33    virtual             ~RecordTrack();
34
35    virtual status_t    start(AudioSystem::sync_event_t event, int triggerSession);
36    virtual void        stop();
37
38            void        destroy();
39
40            void        invalidate();
41            // clear the buffer overflow flag
42            void        clearOverflow() { mOverflow = false; }
43            // set the buffer overflow flag and return previous value
44            bool        setOverflow() { bool tmp = mOverflow; mOverflow = true;
45                                                return tmp; }
46
47    static  void        appendDumpHeader(String8& result);
48            void        dump(char* buffer, size_t size, bool active);
49
50            void        handleSyncStartEvent(const sp<SyncEvent>& event);
51            void        clearSyncStartEvent();
52
53private:
54    friend class AudioFlinger;  // for mState
55
56                        RecordTrack(const RecordTrack&);
57                        RecordTrack& operator = (const RecordTrack&);
58
59    // AudioBufferProvider interface
60    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
61                                   int64_t pts = kInvalidPTS);
62    // releaseBuffer() not overridden
63
64    bool                mOverflow;  // overflow on most recent attempt to fill client buffer
65
66           // updated by RecordThread::readInputParameters_l()
67            AudioResampler                      *mResampler;
68
69            // interleaved stereo pairs of fixed-point Q4.27
70            int32_t                             *mRsmpOutBuffer;
71            // current allocated frame count for the above, which may be larger than needed
72            size_t                              mRsmpOutFrameCount;
73
74            size_t                              mRsmpInUnrel;   // unreleased frames remaining from
75                                                                // most recent getNextBuffer
76                                                                // for debug only
77
78            // rolling counter that is never cleared
79            int32_t                             mRsmpInFront;   // next available frame
80
81            AudioBufferProvider::Buffer mSink;  // references client's buffer sink in shared memory
82
83            // sync event triggering actual audio capture. Frames read before this event will
84            // be dropped and therefore not read by the application.
85            sp<SyncEvent>                       mSyncStartEvent;
86
87            // number of captured frames to drop after the start sync event has been received.
88            // when < 0, maximum frames to drop before starting capture even if sync event is
89            // not received
90            ssize_t                             mFramesToDrop;
91
92            // used by resampler to find source frames
93            ResamplerBufferProvider *mResamplerBufferProvider;
94};
95