RecordTracks.h revision deca2ae0a7cf8bc54ff3f30b7dc39bbc78b94c0d 
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
50private:
51    friend class AudioFlinger;  // for mState
52
53                        RecordTrack(const RecordTrack&);
54                        RecordTrack& operator = (const RecordTrack&);
55
56    // AudioBufferProvider interface
57    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
58                                   int64_t pts = kInvalidPTS);
59    // releaseBuffer() not overridden
60
61    bool                mOverflow;  // overflow on most recent attempt to fill client buffer
62
63           // updated by RecordThread::readInputParameters_l()
64            AudioResampler                      *mResampler;
65
66            // interleaved stereo pairs of fixed-point signed Q19.12
67            int32_t                             *mRsmpOutBuffer;
68            // current allocated frame count for the above, which may be larger than needed
69            size_t                              mRsmpOutFrameCount;
70
71            size_t                              mRsmpInUnrel;   // unreleased frames remaining from
72                                                                // most recent getNextBuffer
73                                                                // for debug only
74
75            // rolling counter that is never cleared
76            int32_t                             mRsmpInFront;   // next available frame
77
78            AudioBufferProvider::Buffer mSink;  // references client's buffer sink in shared memory
79
80            // sync event triggering actual audio capture. Frames read before this event will
81            // be dropped and therefore not read by the application.
82            sp<SyncEvent>                       mSyncStartEvent;
83
84            // number of captured frames to drop after the start sync event has been received.
85            // when < 0, maximum frames to drop before starting capture even if sync event is
86            // not received
87            ssize_t                             mFramesToDrop;
88
89            // used by resampler to find source frames
90            ResamplerBufferProvider *mResamplerBufferProvider;
91};
92