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