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
23 class RecordTrack : public TrackBase {
24 public:
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                                 void *buffer,
32                                 int sessionId,
33                                 int uid,
34                                 IAudioFlinger::track_flags_t flags,
35                                 track_type type);
36     virtual             ~RecordTrack();
37     virtual status_t    initCheck() const;
38 
39     virtual status_t    start(AudioSystem::sync_event_t event, int triggerSession);
40     virtual void        stop();
41 
42             void        destroy();
43 
44             void        invalidate();
45             // clear the buffer overflow flag
clearOverflow()46             void        clearOverflow() { mOverflow = false; }
47             // set the buffer overflow flag and return previous value
setOverflow()48             bool        setOverflow() { bool tmp = mOverflow; mOverflow = true;
49                                                 return tmp; }
50 
51     static  void        appendDumpHeader(String8& result);
52             void        dump(char* buffer, size_t size, bool active);
53 
54             void        handleSyncStartEvent(const sp<SyncEvent>& event);
55             void        clearSyncStartEvent();
56 
57 private:
58     friend class AudioFlinger;  // for mState
59 
60                         RecordTrack(const RecordTrack&);
61                         RecordTrack& operator = (const RecordTrack&);
62 
63     // AudioBufferProvider interface
64     virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
65                                    int64_t pts = kInvalidPTS);
66     // releaseBuffer() not overridden
67 
68     bool                mOverflow;  // overflow on most recent attempt to fill client buffer
69 
70             AudioBufferProvider::Buffer mSink;  // references client's buffer sink in shared memory
71 
72             // sync event triggering actual audio capture. Frames read before this event will
73             // be dropped and therefore not read by the application.
74             sp<SyncEvent>                       mSyncStartEvent;
75 
76             // number of captured frames to drop after the start sync event has been received.
77             // when < 0, maximum frames to drop before starting capture even if sync event is
78             // not received
79             ssize_t                             mFramesToDrop;
80 
81             // used by resampler to find source frames
82             ResamplerBufferProvider            *mResamplerBufferProvider;
83 
84             // used by the record thread to convert frames to proper destination format
85             RecordBufferConverter              *mRecordBufferConverter;
86 };
87 
88 // playback track, used by PatchPanel
89 class PatchRecord : virtual public RecordTrack, public PatchProxyBufferProvider {
90 public:
91 
92     PatchRecord(RecordThread *recordThread,
93                 uint32_t sampleRate,
94                 audio_channel_mask_t channelMask,
95                 audio_format_t format,
96                 size_t frameCount,
97                 void *buffer,
98                 IAudioFlinger::track_flags_t flags);
99     virtual             ~PatchRecord();
100 
101     // AudioBufferProvider interface
102     virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
103                                    int64_t pts);
104     virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
105 
106     // PatchProxyBufferProvider interface
107     virtual status_t    obtainBuffer(Proxy::Buffer *buffer,
108                                      const struct timespec *timeOut = NULL);
109     virtual void        releaseBuffer(Proxy::Buffer *buffer);
110 
setPeerProxy(PatchProxyBufferProvider * proxy)111     void setPeerProxy(PatchProxyBufferProvider *proxy) { mPeerProxy = proxy; }
112 
113 private:
114     sp<ClientProxy>             mProxy;
115     PatchProxyBufferProvider*   mPeerProxy;
116     struct timespec             mPeerTimeout;
117 };  // end of PatchRecord
118