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