MediaPlayerService.h revision 64760240f931714858a59c1579f07264d7182ba2 
1/*
2**
3** Copyright 2008, 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 ANDROID_MEDIAPLAYERSERVICE_H
19#define ANDROID_MEDIAPLAYERSERVICE_H
20
21#include <utils/Log.h>
22#include <utils/threads.h>
23#include <utils/List.h>
24#include <utils/Errors.h>
25#include <utils/KeyedVector.h>
26#include <utils/String8.h>
27#include <utils/Vector.h>
28
29#include <media/IMediaPlayerService.h>
30#include <media/MediaPlayerInterface.h>
31#include <media/Metadata.h>
32
33#include <system/audio.h>
34
35namespace android {
36
37class IMediaRecorder;
38class IMediaMetadataRetriever;
39class IOMX;
40class MediaRecorderClient;
41
42#define CALLBACK_ANTAGONIZER 0
43#if CALLBACK_ANTAGONIZER
44class Antagonizer {
45public:
46    Antagonizer(notify_callback_f cb, void* client);
47    void start() { mActive = true; }
48    void stop() { mActive = false; }
49    void kill();
50private:
51    static const int interval;
52    Antagonizer();
53    static int callbackThread(void* cookie);
54    Mutex               mLock;
55    Condition           mCondition;
56    bool                mExit;
57    bool                mActive;
58    void*               mClient;
59    notify_callback_f   mCb;
60};
61#endif
62
63class MediaPlayerService : public BnMediaPlayerService
64{
65    class Client;
66
67    class AudioOutput : public MediaPlayerBase::AudioSink
68    {
69    public:
70                                AudioOutput(int sessionId);
71        virtual                 ~AudioOutput();
72
73        virtual bool            ready() const { return mTrack != NULL; }
74        virtual bool            realtime() const { return true; }
75        virtual ssize_t         bufferSize() const;
76        virtual ssize_t         frameCount() const;
77        virtual ssize_t         channelCount() const;
78        virtual ssize_t         frameSize() const;
79        virtual uint32_t        latency() const;
80        virtual float           msecsPerFrame() const;
81        virtual status_t        getPosition(uint32_t *position);
82        virtual int             getSessionId();
83
84        virtual status_t        open(
85                uint32_t sampleRate, int channelCount,
86                int format, int bufferCount,
87                AudioCallback cb, void *cookie);
88
89        virtual void            start();
90        virtual ssize_t         write(const void* buffer, size_t size);
91        virtual void            stop();
92        virtual void            flush();
93        virtual void            pause();
94        virtual void            close();
95                void            setAudioStreamType(int streamType) { mStreamType = streamType; }
96                void            setVolume(float left, float right);
97                status_t        setAuxEffectSendLevel(float level);
98                status_t        attachAuxEffect(int effectId);
99        virtual status_t        dump(int fd, const Vector<String16>& args) const;
100
101        static bool             isOnEmulator();
102        static int              getMinBufferCount();
103    private:
104        static void             setMinBufferCount();
105        static void             CallbackWrapper(
106                int event, void *me, void *info);
107
108        AudioTrack*             mTrack;
109        AudioCallback           mCallback;
110        void *                  mCallbackCookie;
111        int                     mStreamType;
112        float                   mLeftVolume;
113        float                   mRightVolume;
114        float                   mMsecsPerFrame;
115        uint32_t                mLatency;
116        int                     mSessionId;
117        float                   mSendLevel;
118        int                     mAuxEffectId;
119        static bool             mIsOnEmulator;
120        static int              mMinBufferCount;  // 12 for emulator; otherwise 4
121
122    };
123
124    class AudioCache : public MediaPlayerBase::AudioSink
125    {
126    public:
127                                AudioCache(const char* name);
128        virtual                 ~AudioCache() {}
129
130        virtual bool            ready() const { return (mChannelCount > 0) && (mHeap->getHeapID() > 0); }
131        virtual bool            realtime() const { return false; }
132        virtual ssize_t         bufferSize() const { return frameSize() * mFrameCount; }
133        virtual ssize_t         frameCount() const { return mFrameCount; }
134        virtual ssize_t         channelCount() const { return (ssize_t)mChannelCount; }
135        virtual ssize_t         frameSize() const { return ssize_t(mChannelCount * ((mFormat == AUDIO_FORMAT_PCM_16_BIT)?sizeof(int16_t):sizeof(u_int8_t))); }
136        virtual uint32_t        latency() const;
137        virtual float           msecsPerFrame() const;
138        virtual status_t        getPosition(uint32_t *position);
139        virtual int             getSessionId();
140
141        virtual status_t        open(
142                uint32_t sampleRate, int channelCount, int format,
143                int bufferCount = 1,
144                AudioCallback cb = NULL, void *cookie = NULL);
145
146        virtual void            start();
147        virtual ssize_t         write(const void* buffer, size_t size);
148        virtual void            stop();
149        virtual void            flush() {}
150        virtual void            pause() {}
151        virtual void            close() {}
152                void            setAudioStreamType(int streamType) {}
153                void            setVolume(float left, float right) {}
154                uint32_t        sampleRate() const { return mSampleRate; }
155                uint32_t        format() const { return (uint32_t)mFormat; }
156                size_t          size() const { return mSize; }
157                status_t        wait();
158
159                sp<IMemoryHeap> getHeap() const { return mHeap; }
160
161        static  void            notify(void* cookie, int msg,
162                                       int ext1, int ext2, const Parcel *obj);
163        virtual status_t        dump(int fd, const Vector<String16>& args) const;
164
165    private:
166                                AudioCache();
167
168        Mutex               mLock;
169        Condition           mSignal;
170        sp<MemoryHeapBase>  mHeap;
171        float               mMsecsPerFrame;
172        uint16_t            mChannelCount;
173        uint16_t            mFormat;
174        ssize_t             mFrameCount;
175        uint32_t            mSampleRate;
176        uint32_t            mSize;
177        int                 mError;
178        bool                mCommandComplete;
179
180        sp<Thread>          mCallbackThread;
181    };
182
183public:
184    static  void                instantiate();
185
186    // IMediaPlayerService interface
187    virtual sp<IMediaRecorder>  createMediaRecorder(pid_t pid);
188    void    removeMediaRecorderClient(wp<MediaRecorderClient> client);
189    virtual sp<IMediaMetadataRetriever> createMetadataRetriever(pid_t pid);
190
191    // House keeping for media player clients
192    virtual sp<IMediaPlayer>    create(
193            pid_t pid, const sp<IMediaPlayerClient>& client, const char* url,
194            const KeyedVector<String8, String8> *headers, int audioSessionId);
195
196    virtual sp<IMediaPlayer>    create(pid_t pid, const sp<IMediaPlayerClient>& client, int fd, int64_t offset, int64_t length, int audioSessionId);
197
198    virtual sp<IMediaPlayer>    create(
199            pid_t pid, const sp<IMediaPlayerClient> &client,
200            const sp<IStreamSource> &source, int audioSessionId);
201
202    virtual sp<IMemory>         decode(const char* url, uint32_t *pSampleRate, int* pNumChannels, int* pFormat);
203    virtual sp<IMemory>         decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate, int* pNumChannels, int* pFormat);
204    virtual sp<IOMX>            getOMX();
205
206    virtual status_t            dump(int fd, const Vector<String16>& args);
207
208            void                removeClient(wp<Client> client);
209
210    // For battery usage tracking purpose
211    struct BatteryUsageInfo {
212        // how many streams are being played by one UID
213        int     refCount;
214        // a temp variable to store the duration(ms) of audio codecs
215        // when we start a audio codec, we minus the system time from audioLastTime
216        // when we pause it, we add the system time back to the audioLastTime
217        // so after the pause, audioLastTime = pause time - start time
218        // if multiple audio streams are played (or recorded), then audioLastTime
219        // = the total playing time of all the streams
220        int32_t audioLastTime;
221        // when all the audio streams are being paused, we assign audioLastTime to
222        // this variable, so this value could be provided to the battery app
223        // in the next pullBatteryData call
224        int32_t audioTotalTime;
225
226        int32_t videoLastTime;
227        int32_t videoTotalTime;
228    };
229    KeyedVector<int, BatteryUsageInfo>    mBatteryData;
230
231    enum {
232        SPEAKER,
233        OTHER_AUDIO_DEVICE,
234        SPEAKER_AND_OTHER,
235        NUM_AUDIO_DEVICES
236    };
237
238    struct BatteryAudioFlingerUsageInfo {
239        int refCount; // how many audio streams are being played
240        int deviceOn[NUM_AUDIO_DEVICES]; // whether the device is currently used
241        int32_t lastTime[NUM_AUDIO_DEVICES]; // in ms
242        // totalTime[]: total time of audio output devices usage
243        int32_t totalTime[NUM_AUDIO_DEVICES]; // in ms
244    };
245
246    // This varialble is used to record the usage of audio output device
247    // for battery app
248    BatteryAudioFlingerUsageInfo mBatteryAudio;
249
250    // Collect info of the codec usage from media player and media recorder
251    virtual void                addBatteryData(uint32_t params);
252    // API for the Battery app to pull the data of codecs usage
253    virtual status_t            pullBatteryData(Parcel* reply);
254private:
255
256    class Client : public BnMediaPlayer {
257
258        // IMediaPlayer interface
259        virtual void            disconnect();
260        virtual status_t        setVideoSurface(const sp<Surface>& surface);
261        virtual status_t        setVideoSurfaceTexture(
262                                        const sp<ISurfaceTexture>& surfaceTexture);
263        virtual status_t        prepareAsync();
264        virtual status_t        start();
265        virtual status_t        stop();
266        virtual status_t        pause();
267        virtual status_t        isPlaying(bool* state);
268        virtual status_t        seekTo(int msec);
269        virtual status_t        getCurrentPosition(int* msec);
270        virtual status_t        getDuration(int* msec);
271        virtual status_t        reset();
272        virtual status_t        setAudioStreamType(int type);
273        virtual status_t        setLooping(int loop);
274        virtual status_t        setVolume(float leftVolume, float rightVolume);
275        virtual status_t        invoke(const Parcel& request, Parcel *reply);
276        virtual status_t        setMetadataFilter(const Parcel& filter);
277        virtual status_t        getMetadata(bool update_only,
278                                            bool apply_filter,
279                                            Parcel *reply);
280        virtual status_t        setAuxEffectSendLevel(float level);
281        virtual status_t        attachAuxEffect(int effectId);
282        virtual status_t        setParameter(int key, const Parcel &request);
283        virtual status_t        getParameter(int key, Parcel *reply);
284
285        sp<MediaPlayerBase>     createPlayer(player_type playerType);
286
287                status_t        setDataSource(
288                        const char *url,
289                        const KeyedVector<String8, String8> *headers);
290
291                status_t        setDataSource(int fd, int64_t offset, int64_t length);
292
293                status_t        setDataSource(const sp<IStreamSource> &source);
294
295        static  void            notify(void* cookie, int msg,
296                                       int ext1, int ext2, const Parcel *obj);
297
298                pid_t           pid() const { return mPid; }
299        virtual status_t        dump(int fd, const Vector<String16>& args) const;
300
301                int             getAudioSessionId() { return mAudioSessionId; }
302
303    private:
304        friend class MediaPlayerService;
305                                Client( const sp<MediaPlayerService>& service,
306                                        pid_t pid,
307                                        int32_t connId,
308                                        const sp<IMediaPlayerClient>& client,
309                                        int audioSessionId);
310                                Client();
311        virtual                 ~Client();
312
313                void            deletePlayer();
314
315        sp<MediaPlayerBase>     getPlayer() const { Mutex::Autolock lock(mLock); return mPlayer; }
316
317
318
319        // @param type Of the metadata to be tested.
320        // @return true if the metadata should be dropped according to
321        //              the filters.
322        bool shouldDropMetadata(media::Metadata::Type type) const;
323
324        // Add a new element to the set of metadata updated. Noop if
325        // the element exists already.
326        // @param type Of the metadata to be recorded.
327        void addNewMetadataUpdate(media::Metadata::Type type);
328
329        mutable     Mutex                       mLock;
330                    sp<MediaPlayerBase>         mPlayer;
331                    sp<MediaPlayerService>      mService;
332                    sp<IMediaPlayerClient>      mClient;
333                    sp<AudioOutput>             mAudioOutput;
334                    pid_t                       mPid;
335                    status_t                    mStatus;
336                    bool                        mLoop;
337                    int32_t                     mConnId;
338                    int                         mAudioSessionId;
339
340        // Metadata filters.
341        media::Metadata::Filter mMetadataAllow;  // protected by mLock
342        media::Metadata::Filter mMetadataDrop;  // protected by mLock
343
344        // Metadata updated. For each MEDIA_INFO_METADATA_UPDATE
345        // notification we try to update mMetadataUpdated which is a
346        // set: no duplicate.
347        // getMetadata clears this set.
348        media::Metadata::Filter mMetadataUpdated;  // protected by mLock
349
350#if CALLBACK_ANTAGONIZER
351                    Antagonizer*                mAntagonizer;
352#endif
353    };
354
355// ----------------------------------------------------------------------------
356
357                            MediaPlayerService();
358    virtual                 ~MediaPlayerService();
359
360    mutable     Mutex                       mLock;
361                SortedVector< wp<Client> >  mClients;
362                SortedVector< wp<MediaRecorderClient> > mMediaRecorderClients;
363                int32_t                     mNextConnId;
364                sp<IOMX>                    mOMX;
365};
366
367// ----------------------------------------------------------------------------
368
369}; // namespace android
370
371#endif // ANDROID_MEDIAPLAYERSERVICE_H
372