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