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