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