MediaPlayerService.h revision 1b86fe063badb5f28c467ade39be0f4008688947 
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/threads.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/MediaPlayerInterface.h>
30#include <media/Metadata.h>
31#include <media/stagefright/foundation/ABase.h>
32
33#include <system/audio.h>
34
35namespace android {
36
37class AudioTrack;
38class IMediaRecorder;
39class IMediaMetadataRetriever;
40class IOMX;
41class IRemoteDisplay;
42class IRemoteDisplayClient;
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        class CallbackData;
73
74     public:
75                                AudioOutput(int sessionId, int uid);
76        virtual                 ~AudioOutput();
77
78        virtual bool            ready() const { return mTrack != 0; }
79        virtual bool            realtime() const { return true; }
80        virtual ssize_t         bufferSize() const;
81        virtual ssize_t         frameCount() const;
82        virtual ssize_t         channelCount() const;
83        virtual ssize_t         frameSize() const;
84        virtual uint32_t        latency() const;
85        virtual float           msecsPerFrame() const;
86        virtual status_t        getPosition(uint32_t *position) const;
87        virtual status_t        getFramesWritten(uint32_t *frameswritten) const;
88        virtual int             getSessionId() const;
89        virtual uint32_t        getSampleRate() const;
90
91        virtual status_t        open(
92                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
93                audio_format_t format, int bufferCount,
94                AudioCallback cb, void *cookie,
95                audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
96                const audio_offload_info_t *offloadInfo = NULL);
97
98        virtual status_t        start();
99        virtual ssize_t         write(const void* buffer, size_t size);
100        virtual void            stop();
101        virtual void            flush();
102        virtual void            pause();
103        virtual void            close();
104                void            setAudioStreamType(audio_stream_type_t streamType) {
105                                                                        mStreamType = streamType; }
106        virtual audio_stream_type_t getAudioStreamType() const { return mStreamType; }
107
108                void            setVolume(float left, float right);
109        virtual status_t        setPlaybackRatePermille(int32_t ratePermille);
110                status_t        setAuxEffectSendLevel(float level);
111                status_t        attachAuxEffect(int effectId);
112        virtual status_t        dump(int fd, const Vector<String16>& args) const;
113
114        static bool             isOnEmulator();
115        static int              getMinBufferCount();
116                void            setNextOutput(const sp<AudioOutput>& nextOutput);
117                void            switchToNextOutput();
118        virtual bool            needsTrailingPadding() { return mNextOutput == NULL; }
119        virtual status_t        setParameters(const String8& keyValuePairs);
120        virtual String8         getParameters(const String8& keys);
121
122    private:
123        static void             setMinBufferCount();
124        static void             CallbackWrapper(
125                int event, void *me, void *info);
126               void             deleteRecycledTrack();
127
128        sp<AudioTrack>          mTrack;
129        sp<AudioTrack>          mRecycledTrack;
130        sp<AudioOutput>         mNextOutput;
131        AudioCallback           mCallback;
132        void *                  mCallbackCookie;
133        CallbackData *          mCallbackData;
134        uint64_t                mBytesWritten;
135        audio_stream_type_t     mStreamType;
136        float                   mLeftVolume;
137        float                   mRightVolume;
138        int32_t                 mPlaybackRatePermille;
139        uint32_t                mSampleRateHz; // sample rate of the content, as set in open()
140        float                   mMsecsPerFrame;
141        int                     mSessionId;
142        int                     mUid;
143        float                   mSendLevel;
144        int                     mAuxEffectId;
145        static bool             mIsOnEmulator;
146        static int              mMinBufferCount;  // 12 for emulator; otherwise 4
147        audio_output_flags_t    mFlags;
148
149        // CallbackData is what is passed to the AudioTrack as the "user" data.
150        // We need to be able to target this to a different Output on the fly,
151        // so we can't use the Output itself for this.
152        class CallbackData {
153        public:
154            CallbackData(AudioOutput *cookie) {
155                mData = cookie;
156                mSwitching = false;
157            }
158            AudioOutput *   getOutput() { return mData;}
159            void            setOutput(AudioOutput* newcookie) { mData = newcookie; }
160            // lock/unlock are used by the callback before accessing the payload of this object
161            void            lock() { mLock.lock(); }
162            void            unlock() { mLock.unlock(); }
163            // beginTrackSwitch/endTrackSwitch are used when this object is being handed over
164            // to the next sink.
165            void            beginTrackSwitch() { mLock.lock(); mSwitching = true; }
166            void            endTrackSwitch() {
167                if (mSwitching) {
168                    mLock.unlock();
169                }
170                mSwitching = false;
171            }
172        private:
173            AudioOutput *   mData;
174            mutable Mutex   mLock;
175            bool            mSwitching;
176            DISALLOW_EVIL_CONSTRUCTORS(CallbackData);
177        };
178
179    }; // AudioOutput
180
181
182    class AudioCache : public MediaPlayerBase::AudioSink
183    {
184    public:
185                                AudioCache(const sp<IMemoryHeap>& heap);
186        virtual                 ~AudioCache() {}
187
188        virtual bool            ready() const { return (mChannelCount > 0) && (mHeap->getHeapID() > 0); }
189        virtual bool            realtime() const { return false; }
190        virtual ssize_t         bufferSize() const { return frameSize() * mFrameCount; }
191        virtual ssize_t         frameCount() const { return mFrameCount; }
192        virtual ssize_t         channelCount() const { return (ssize_t)mChannelCount; }
193        virtual ssize_t         frameSize() const { return ssize_t(mChannelCount * ((mFormat == AUDIO_FORMAT_PCM_16_BIT)?sizeof(int16_t):sizeof(u_int8_t))); }
194        virtual uint32_t        latency() const;
195        virtual float           msecsPerFrame() const;
196        virtual status_t        getPosition(uint32_t *position) const;
197        virtual status_t        getFramesWritten(uint32_t *frameswritten) const;
198        virtual int             getSessionId() const;
199        virtual uint32_t        getSampleRate() const;
200
201        virtual status_t        open(
202                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
203                audio_format_t format, int bufferCount = 1,
204                AudioCallback cb = NULL, void *cookie = NULL,
205                audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
206                const audio_offload_info_t *offloadInfo = NULL);
207
208        virtual status_t        start();
209        virtual ssize_t         write(const void* buffer, size_t size);
210        virtual void            stop();
211        virtual void            flush() {}
212        virtual void            pause() {}
213        virtual void            close() {}
214                void            setAudioStreamType(audio_stream_type_t streamType) {}
215                // stream type is not used for AudioCache
216        virtual audio_stream_type_t getAudioStreamType() const { return AUDIO_STREAM_DEFAULT; }
217
218                void            setVolume(float left, float right) {}
219        virtual status_t        setPlaybackRatePermille(int32_t ratePermille) { return INVALID_OPERATION; }
220                uint32_t        sampleRate() const { return mSampleRate; }
221                audio_format_t  format() const { return mFormat; }
222                size_t          size() const { return mSize; }
223                status_t        wait();
224
225                sp<IMemoryHeap> getHeap() const { return mHeap; }
226
227        static  void            notify(void* cookie, int msg,
228                                       int ext1, int ext2, const Parcel *obj);
229        virtual status_t        dump(int fd, const Vector<String16>& args) const;
230
231    private:
232                                AudioCache();
233
234        Mutex               mLock;
235        Condition           mSignal;
236        sp<IMemoryHeap>     mHeap;
237        float               mMsecsPerFrame;
238        uint16_t            mChannelCount;
239        audio_format_t      mFormat;
240        ssize_t             mFrameCount;
241        uint32_t            mSampleRate;
242        uint32_t            mSize;
243        int                 mError;
244        bool                mCommandComplete;
245
246        sp<Thread>          mCallbackThread;
247    }; // AudioCache
248
249public:
250    static  void                instantiate();
251
252    // IMediaPlayerService interface
253    virtual sp<IMediaRecorder>  createMediaRecorder();
254    void    removeMediaRecorderClient(wp<MediaRecorderClient> client);
255    virtual sp<IMediaMetadataRetriever> createMetadataRetriever();
256
257    virtual sp<IMediaPlayer>    create(const sp<IMediaPlayerClient>& client, int audioSessionId);
258
259    virtual status_t            decode(
260            const sp<IMediaHTTPService> &httpService,
261            const char* url,
262            uint32_t *pSampleRate,
263            int* pNumChannels,
264            audio_format_t* pFormat,
265            const sp<IMemoryHeap>& heap,
266            size_t *pSize);
267
268    virtual status_t            decode(int fd, int64_t offset, int64_t length,
269                                       uint32_t *pSampleRate, int* pNumChannels,
270                                       audio_format_t* pFormat,
271                                       const sp<IMemoryHeap>& heap, size_t *pSize);
272    virtual sp<IOMX>            getOMX();
273    virtual sp<ICrypto>         makeCrypto();
274    virtual sp<IDrm>            makeDrm();
275    virtual sp<IHDCP>           makeHDCP(bool createEncryptionModule);
276
277    virtual sp<IRemoteDisplay> listenForRemoteDisplay(const sp<IRemoteDisplayClient>& client,
278            const String8& iface);
279    virtual status_t            dump(int fd, const Vector<String16>& args);
280
281    virtual status_t        updateProxyConfig(
282            const char *host, int32_t port, const char *exclusionList);
283
284            void                removeClient(wp<Client> client);
285
286    // For battery usage tracking purpose
287    struct BatteryUsageInfo {
288        // how many streams are being played by one UID
289        int     refCount;
290        // a temp variable to store the duration(ms) of audio codecs
291        // when we start a audio codec, we minus the system time from audioLastTime
292        // when we pause it, we add the system time back to the audioLastTime
293        // so after the pause, audioLastTime = pause time - start time
294        // if multiple audio streams are played (or recorded), then audioLastTime
295        // = the total playing time of all the streams
296        int32_t audioLastTime;
297        // when all the audio streams are being paused, we assign audioLastTime to
298        // this variable, so this value could be provided to the battery app
299        // in the next pullBatteryData call
300        int32_t audioTotalTime;
301
302        int32_t videoLastTime;
303        int32_t videoTotalTime;
304    };
305    KeyedVector<int, BatteryUsageInfo>    mBatteryData;
306
307    enum {
308        SPEAKER,
309        OTHER_AUDIO_DEVICE,
310        SPEAKER_AND_OTHER,
311        NUM_AUDIO_DEVICES
312    };
313
314    struct BatteryAudioFlingerUsageInfo {
315        int refCount; // how many audio streams are being played
316        int deviceOn[NUM_AUDIO_DEVICES]; // whether the device is currently used
317        int32_t lastTime[NUM_AUDIO_DEVICES]; // in ms
318        // totalTime[]: total time of audio output devices usage
319        int32_t totalTime[NUM_AUDIO_DEVICES]; // in ms
320    };
321
322    // This varialble is used to record the usage of audio output device
323    // for battery app
324    BatteryAudioFlingerUsageInfo mBatteryAudio;
325
326    // Collect info of the codec usage from media player and media recorder
327    virtual void                addBatteryData(uint32_t params);
328    // API for the Battery app to pull the data of codecs usage
329    virtual status_t            pullBatteryData(Parcel* reply);
330private:
331
332    class Client : public BnMediaPlayer {
333        // IMediaPlayer interface
334        virtual void            disconnect();
335        virtual status_t        setVideoSurfaceTexture(
336                                        const sp<IGraphicBufferProducer>& bufferProducer);
337        virtual status_t        prepareAsync();
338        virtual status_t        start();
339        virtual status_t        stop();
340        virtual status_t        pause();
341        virtual status_t        isPlaying(bool* state);
342        virtual status_t        seekTo(int msec);
343        virtual status_t        getCurrentPosition(int* msec);
344        virtual status_t        getDuration(int* msec);
345        virtual status_t        reset();
346        virtual status_t        setAudioStreamType(audio_stream_type_t type);
347        virtual status_t        setLooping(int loop);
348        virtual status_t        setVolume(float leftVolume, float rightVolume);
349        virtual status_t        invoke(const Parcel& request, Parcel *reply);
350        virtual status_t        setMetadataFilter(const Parcel& filter);
351        virtual status_t        getMetadata(bool update_only,
352                                            bool apply_filter,
353                                            Parcel *reply);
354        virtual status_t        setAuxEffectSendLevel(float level);
355        virtual status_t        attachAuxEffect(int effectId);
356        virtual status_t        setParameter(int key, const Parcel &request);
357        virtual status_t        getParameter(int key, Parcel *reply);
358        virtual status_t        setRetransmitEndpoint(const struct sockaddr_in* endpoint);
359        virtual status_t        getRetransmitEndpoint(struct sockaddr_in* endpoint);
360        virtual status_t        setNextPlayer(const sp<IMediaPlayer>& player);
361
362        sp<MediaPlayerBase>     createPlayer(player_type playerType);
363
364        virtual status_t        setDataSource(
365                        const sp<IMediaHTTPService> &httpService,
366                        const char *url,
367                        const KeyedVector<String8, String8> *headers);
368
369        virtual status_t        setDataSource(int fd, int64_t offset, int64_t length);
370
371        virtual status_t        setDataSource(const sp<IStreamSource> &source);
372
373        sp<MediaPlayerBase>     setDataSource_pre(player_type playerType);
374        void                    setDataSource_post(const sp<MediaPlayerBase>& p,
375                                                   status_t status);
376
377        static  void            notify(void* cookie, int msg,
378                                       int ext1, int ext2, const Parcel *obj);
379
380                pid_t           pid() const { return mPid; }
381        virtual status_t        dump(int fd, const Vector<String16>& args) const;
382
383                int             getAudioSessionId() { return mAudioSessionId; }
384
385    private:
386        friend class MediaPlayerService;
387                                Client( const sp<MediaPlayerService>& service,
388                                        pid_t pid,
389                                        int32_t connId,
390                                        const sp<IMediaPlayerClient>& client,
391                                        int audioSessionId,
392                                        uid_t uid);
393                                Client();
394        virtual                 ~Client();
395
396                void            deletePlayer();
397
398        sp<MediaPlayerBase>     getPlayer() const { Mutex::Autolock lock(mLock); return mPlayer; }
399
400
401
402        // @param type Of the metadata to be tested.
403        // @return true if the metadata should be dropped according to
404        //              the filters.
405        bool shouldDropMetadata(media::Metadata::Type type) const;
406
407        // Add a new element to the set of metadata updated. Noop if
408        // the element exists already.
409        // @param type Of the metadata to be recorded.
410        void addNewMetadataUpdate(media::Metadata::Type type);
411
412        // Disconnect from the currently connected ANativeWindow.
413        void disconnectNativeWindow();
414
415        mutable     Mutex                       mLock;
416                    sp<MediaPlayerBase>         mPlayer;
417                    sp<MediaPlayerService>      mService;
418                    sp<IMediaPlayerClient>      mClient;
419                    sp<AudioOutput>             mAudioOutput;
420                    pid_t                       mPid;
421                    status_t                    mStatus;
422                    bool                        mLoop;
423                    int32_t                     mConnId;
424                    int                         mAudioSessionId;
425                    uid_t                       mUID;
426                    sp<ANativeWindow>           mConnectedWindow;
427                    sp<IBinder>                 mConnectedWindowBinder;
428                    struct sockaddr_in          mRetransmitEndpoint;
429                    bool                        mRetransmitEndpointValid;
430                    sp<Client>                  mNextClient;
431
432        // Metadata filters.
433        media::Metadata::Filter mMetadataAllow;  // protected by mLock
434        media::Metadata::Filter mMetadataDrop;  // protected by mLock
435
436        // Metadata updated. For each MEDIA_INFO_METADATA_UPDATE
437        // notification we try to update mMetadataUpdated which is a
438        // set: no duplicate.
439        // getMetadata clears this set.
440        media::Metadata::Filter mMetadataUpdated;  // protected by mLock
441
442#if CALLBACK_ANTAGONIZER
443                    Antagonizer*                mAntagonizer;
444#endif
445    }; // Client
446
447// ----------------------------------------------------------------------------
448
449                            MediaPlayerService();
450    virtual                 ~MediaPlayerService();
451
452    mutable     Mutex                       mLock;
453                SortedVector< wp<Client> >  mClients;
454                SortedVector< wp<MediaRecorderClient> > mMediaRecorderClients;
455                int32_t                     mNextConnId;
456                sp<IOMX>                    mOMX;
457                sp<ICrypto>                 mCrypto;
458};
459
460// ----------------------------------------------------------------------------
461
462}; // namespace android
463
464#endif // ANDROID_MEDIAPLAYERSERVICE_H
465