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