MediaPlayerService.h revision 6556e5bb99bda64f3ab92e8b540fccdd59e9ed8d 
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 <arpa/inet.h>
22
23#include <utils/Log.h>
24#include <utils/threads.h>
25#include <utils/List.h>
26#include <utils/Errors.h>
27#include <utils/KeyedVector.h>
28#include <utils/String8.h>
29#include <utils/Vector.h>
30
31#include <media/IMediaPlayerService.h>
32#include <media/MediaPlayerInterface.h>
33#include <media/Metadata.h>
34
35#include <system/audio.h>
36
37namespace android {
38
39class AudioTrack;
40class IMediaRecorder;
41class IMediaMetadataRetriever;
42class IOMX;
43class MediaRecorderClient;
44
45#define CALLBACK_ANTAGONIZER 0
46#if CALLBACK_ANTAGONIZER
47class Antagonizer {
48public:
49    Antagonizer(notify_callback_f cb, void* client);
50    void start() { mActive = true; }
51    void stop() { mActive = false; }
52    void kill();
53private:
54    static const int interval;
55    Antagonizer();
56    static int callbackThread(void* cookie);
57    Mutex               mLock;
58    Condition           mCondition;
59    bool                mExit;
60    bool                mActive;
61    void*               mClient;
62    notify_callback_f   mCb;
63};
64#endif
65
66class MediaPlayerService : public BnMediaPlayerService
67{
68    class Client;
69
70    class AudioOutput : public MediaPlayerBase::AudioSink
71    {
72    public:
73                                AudioOutput(int sessionId);
74        virtual                 ~AudioOutput();
75
76        virtual bool            ready() const { return mTrack != NULL; }
77        virtual bool            realtime() const { return true; }
78        virtual ssize_t         bufferSize() const;
79        virtual ssize_t         frameCount() const;
80        virtual ssize_t         channelCount() const;
81        virtual ssize_t         frameSize() const;
82        virtual uint32_t        latency() const;
83        virtual float           msecsPerFrame() const;
84        virtual status_t        getPosition(uint32_t *position);
85        virtual int             getSessionId();
86
87        virtual status_t        open(
88                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
89                audio_format_t format, int bufferCount,
90                AudioCallback cb, void *cookie);
91
92        virtual void            start();
93        virtual ssize_t         write(const void* buffer, size_t size);
94        virtual void            stop();
95        virtual void            flush();
96        virtual void            pause();
97        virtual void            close();
98                void            setAudioStreamType(audio_stream_type_t streamType) { mStreamType = streamType; }
99                void            setVolume(float left, float right);
100        virtual status_t        setPlaybackRatePermille(int32_t ratePermille);
101                status_t        setAuxEffectSendLevel(float level);
102                status_t        attachAuxEffect(int effectId);
103        virtual status_t        dump(int fd, const Vector<String16>& args) const;
104
105        static bool             isOnEmulator();
106        static int              getMinBufferCount();
107    private:
108        static void             setMinBufferCount();
109        static void             CallbackWrapper(
110                int event, void *me, void *info);
111
112        AudioTrack*             mTrack;
113        AudioCallback           mCallback;
114        void *                  mCallbackCookie;
115        audio_stream_type_t     mStreamType;
116        float                   mLeftVolume;
117        float                   mRightVolume;
118        int32_t                 mPlaybackRatePermille;
119        uint32_t                mSampleRateHz; // sample rate of the content, as set in open()
120        float                   mMsecsPerFrame;
121        int                     mSessionId;
122        float                   mSendLevel;
123        int                     mAuxEffectId;
124        static bool             mIsOnEmulator;
125        static int              mMinBufferCount;  // 12 for emulator; otherwise 4
126
127    };
128
129    class AudioCache : public MediaPlayerBase::AudioSink
130    {
131    public:
132                                AudioCache(const char* name);
133        virtual                 ~AudioCache() {}
134
135        virtual bool            ready() const { return (mChannelCount > 0) && (mHeap->getHeapID() > 0); }
136        virtual bool            realtime() const { return false; }
137        virtual ssize_t         bufferSize() const { return frameSize() * mFrameCount; }
138        virtual ssize_t         frameCount() const { return mFrameCount; }
139        virtual ssize_t         channelCount() const { return (ssize_t)mChannelCount; }
140        virtual ssize_t         frameSize() const { return ssize_t(mChannelCount * ((mFormat == AUDIO_FORMAT_PCM_16_BIT)?sizeof(int16_t):sizeof(u_int8_t))); }
141        virtual uint32_t        latency() const;
142        virtual float           msecsPerFrame() const;
143        virtual status_t        getPosition(uint32_t *position);
144        virtual int             getSessionId();
145
146        virtual status_t        open(
147                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
148                audio_format_t format, int bufferCount = 1,
149                AudioCallback cb = NULL, void *cookie = NULL);
150
151        virtual void            start();
152        virtual ssize_t         write(const void* buffer, size_t size);
153        virtual void            stop();
154        virtual void            flush() {}
155        virtual void            pause() {}
156        virtual void            close() {}
157                void            setAudioStreamType(audio_stream_type_t streamType) {}
158                void            setVolume(float left, float right) {}
159        virtual status_t        setPlaybackRatePermille(int32_t ratePermille) { return INVALID_OPERATION; }
160                uint32_t        sampleRate() const { return mSampleRate; }
161                audio_format_t  format() const { return mFormat; }
162                size_t          size() const { return mSize; }
163                status_t        wait();
164
165                sp<IMemoryHeap> getHeap() const { return mHeap; }
166
167        static  void            notify(void* cookie, int msg,
168                                       int ext1, int ext2, const Parcel *obj);
169        virtual status_t        dump(int fd, const Vector<String16>& args) const;
170
171    private:
172                                AudioCache();
173
174        Mutex               mLock;
175        Condition           mSignal;
176        sp<MemoryHeapBase>  mHeap;
177        float               mMsecsPerFrame;
178        uint16_t            mChannelCount;
179        audio_format_t      mFormat;
180        ssize_t             mFrameCount;
181        uint32_t            mSampleRate;
182        uint32_t            mSize;
183        int                 mError;
184        bool                mCommandComplete;
185
186        sp<Thread>          mCallbackThread;
187    };
188
189public:
190    static  void                instantiate();
191
192    // IMediaPlayerService interface
193    virtual sp<IMediaRecorder>  createMediaRecorder(pid_t pid);
194    void    removeMediaRecorderClient(wp<MediaRecorderClient> client);
195    virtual sp<IMediaMetadataRetriever> createMetadataRetriever(pid_t pid);
196
197    virtual sp<IMediaPlayer>    create(pid_t pid, const sp<IMediaPlayerClient>& client, int audioSessionId);
198
199    virtual sp<IMemory>         decode(const char* url, uint32_t *pSampleRate, int* pNumChannels, audio_format_t* pFormat);
200    virtual sp<IMemory>         decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate, int* pNumChannels, audio_format_t* 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        setVideoSurfaceTexture(
258                                        const sp<ISurfaceTexture>& surfaceTexture);
259        virtual status_t        prepareAsync();
260        virtual status_t        start();
261        virtual status_t        stop();
262        virtual status_t        pause();
263        virtual status_t        isPlaying(bool* state);
264        virtual status_t        seekTo(int msec);
265        virtual status_t        getCurrentPosition(int* msec);
266        virtual status_t        getDuration(int* msec);
267        virtual status_t        reset();
268        virtual status_t        setAudioStreamType(audio_stream_type_t type);
269        virtual status_t        setLooping(int loop);
270        virtual status_t        setVolume(float leftVolume, float rightVolume);
271        virtual status_t        invoke(const Parcel& request, Parcel *reply);
272        virtual status_t        setMetadataFilter(const Parcel& filter);
273        virtual status_t        getMetadata(bool update_only,
274                                            bool apply_filter,
275                                            Parcel *reply);
276        virtual status_t        setAuxEffectSendLevel(float level);
277        virtual status_t        attachAuxEffect(int effectId);
278        virtual status_t        setParameter(int key, const Parcel &request);
279        virtual status_t        getParameter(int key, Parcel *reply);
280        virtual status_t        setRetransmitEndpoint(const struct sockaddr_in* endpoint);
281
282        sp<MediaPlayerBase>     createPlayer(player_type playerType);
283
284        virtual status_t        setDataSource(
285                        const char *url,
286                        const KeyedVector<String8, String8> *headers);
287
288        virtual status_t        setDataSource(int fd, int64_t offset, int64_t length);
289
290        virtual status_t        setDataSource(const sp<IStreamSource> &source);
291
292        sp<MediaPlayerBase>     setDataSource_pre(player_type playerType);
293        void                    setDataSource_post(const sp<MediaPlayerBase>& p,
294                                                   status_t status);
295
296        player_type             getPlayerType(int fd, int64_t offset, int64_t length);
297        player_type             getPlayerType(const char* url);
298        player_type             getPlayerType(const sp<IStreamSource> &source);
299
300        static  void            notify(void* cookie, int msg,
301                                       int ext1, int ext2, const Parcel *obj);
302
303                pid_t           pid() const { return mPid; }
304        virtual status_t        dump(int fd, const Vector<String16>& args) const;
305
306                int             getAudioSessionId() { return mAudioSessionId; }
307
308    private:
309        friend class MediaPlayerService;
310                                Client( const sp<MediaPlayerService>& service,
311                                        pid_t pid,
312                                        int32_t connId,
313                                        const sp<IMediaPlayerClient>& client,
314                                        int audioSessionId,
315                                        uid_t uid);
316                                Client();
317        virtual                 ~Client();
318
319                void            deletePlayer();
320
321        sp<MediaPlayerBase>     getPlayer() const { Mutex::Autolock lock(mLock); return mPlayer; }
322
323
324
325        // @param type Of the metadata to be tested.
326        // @return true if the metadata should be dropped according to
327        //              the filters.
328        bool shouldDropMetadata(media::Metadata::Type type) const;
329
330        // Add a new element to the set of metadata updated. Noop if
331        // the element exists already.
332        // @param type Of the metadata to be recorded.
333        void addNewMetadataUpdate(media::Metadata::Type type);
334
335        // Disconnect from the currently connected ANativeWindow.
336        void disconnectNativeWindow();
337
338        mutable     Mutex                       mLock;
339                    sp<MediaPlayerBase>         mPlayer;
340                    sp<MediaPlayerService>      mService;
341                    sp<IMediaPlayerClient>      mClient;
342                    sp<AudioOutput>             mAudioOutput;
343                    pid_t                       mPid;
344                    status_t                    mStatus;
345                    bool                        mLoop;
346                    int32_t                     mConnId;
347                    int                         mAudioSessionId;
348                    uid_t                       mUID;
349                    sp<ANativeWindow>           mConnectedWindow;
350                    sp<IBinder>                 mConnectedWindowBinder;
351                    struct sockaddr_in          mRetransmitEndpoint;
352                    bool                        mRetransmitEndpointValid;
353
354        // Metadata filters.
355        media::Metadata::Filter mMetadataAllow;  // protected by mLock
356        media::Metadata::Filter mMetadataDrop;  // protected by mLock
357
358        // Metadata updated. For each MEDIA_INFO_METADATA_UPDATE
359        // notification we try to update mMetadataUpdated which is a
360        // set: no duplicate.
361        // getMetadata clears this set.
362        media::Metadata::Filter mMetadataUpdated;  // protected by mLock
363
364#if CALLBACK_ANTAGONIZER
365                    Antagonizer*                mAntagonizer;
366#endif
367    };
368
369// ----------------------------------------------------------------------------
370
371                            MediaPlayerService();
372    virtual                 ~MediaPlayerService();
373
374    mutable     Mutex                       mLock;
375                SortedVector< wp<Client> >  mClients;
376                SortedVector< wp<MediaRecorderClient> > mMediaRecorderClients;
377                int32_t                     mNextConnId;
378                sp<IOMX>                    mOMX;
379};
380
381// ----------------------------------------------------------------------------
382
383}; // namespace android
384
385#endif // ANDROID_MEDIAPLAYERSERVICE_H
386