MediaPlayerService.h revision 2650e9661ea1608dfb6b58bc640a66cdbbb6ae58 
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(int 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 status_t        getFramesWritten(uint32_t *frameswritten) const;
92        virtual int             getSessionId() const;
93        virtual uint32_t        getSampleRate() const;
94
95        virtual status_t        open(
96                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
97                audio_format_t format, int bufferCount,
98                AudioCallback cb, void *cookie,
99                audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
100                const audio_offload_info_t *offloadInfo = NULL,
101                bool doNotReconnect = false,
102                uint32_t suggestedFrameCount = 0);
103
104        virtual status_t        start();
105        virtual ssize_t         write(const void* buffer, size_t size, bool blocking = true);
106        virtual void            stop();
107        virtual void            flush();
108        virtual void            pause();
109        virtual void            close();
110                void            setAudioStreamType(audio_stream_type_t streamType);
111        virtual audio_stream_type_t getAudioStreamType() const { return mStreamType; }
112                void            setAudioAttributes(const audio_attributes_t * attributes);
113
114                void            setVolume(float left, float right);
115        virtual status_t        setPlaybackRate(const AudioPlaybackRate& rate);
116        virtual status_t        getPlaybackRate(AudioPlaybackRate* rate /* nonnull */);
117
118                status_t        setAuxEffectSendLevel(float level);
119                status_t        attachAuxEffect(int effectId);
120        virtual status_t        dump(int fd, const Vector<String16>& args) const;
121
122        static bool             isOnEmulator();
123        static int              getMinBufferCount();
124                void            setNextOutput(const sp<AudioOutput>& nextOutput);
125                void            switchToNextOutput();
126        virtual bool            needsTrailingPadding() { return mNextOutput == NULL; }
127        virtual status_t        setParameters(const String8& keyValuePairs);
128        virtual String8         getParameters(const String8& keys);
129
130    private:
131        static void             setMinBufferCount();
132        static void             CallbackWrapper(
133                int event, void *me, void *info);
134               void             deleteRecycledTrack_l();
135               void             close_l();
136
137        sp<AudioTrack>          mTrack;
138        sp<AudioTrack>          mRecycledTrack;
139        sp<AudioOutput>         mNextOutput;
140        AudioCallback           mCallback;
141        void *                  mCallbackCookie;
142        CallbackData *          mCallbackData;
143        uint64_t                mBytesWritten;
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        int                     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, int audioSessionId);
217
218    virtual sp<IMediaCodecList> getCodecList() const;
219    virtual sp<IOMX>            getOMX();
220    virtual sp<ICrypto>         makeCrypto();
221    virtual sp<IDrm>            makeDrm();
222    virtual sp<IHDCP>           makeHDCP(bool createEncryptionModule);
223
224    virtual sp<IRemoteDisplay> listenForRemoteDisplay(const String16 &opPackageName,
225            const sp<IRemoteDisplayClient>& client, const String8& iface);
226    virtual status_t            dump(int fd, const Vector<String16>& args);
227
228            void                removeClient(wp<Client> client);
229
230    // For battery usage tracking purpose
231    struct BatteryUsageInfo {
232        // how many streams are being played by one UID
233        int     refCount;
234        // a temp variable to store the duration(ms) of audio codecs
235        // when we start a audio codec, we minus the system time from audioLastTime
236        // when we pause it, we add the system time back to the audioLastTime
237        // so after the pause, audioLastTime = pause time - start time
238        // if multiple audio streams are played (or recorded), then audioLastTime
239        // = the total playing time of all the streams
240        int32_t audioLastTime;
241        // when all the audio streams are being paused, we assign audioLastTime to
242        // this variable, so this value could be provided to the battery app
243        // in the next pullBatteryData call
244        int32_t audioTotalTime;
245
246        int32_t videoLastTime;
247        int32_t videoTotalTime;
248    };
249    KeyedVector<int, BatteryUsageInfo>    mBatteryData;
250
251    enum {
252        SPEAKER,
253        OTHER_AUDIO_DEVICE,
254        SPEAKER_AND_OTHER,
255        NUM_AUDIO_DEVICES
256    };
257
258    struct BatteryAudioFlingerUsageInfo {
259        int refCount; // how many audio streams are being played
260        int deviceOn[NUM_AUDIO_DEVICES]; // whether the device is currently used
261        int32_t lastTime[NUM_AUDIO_DEVICES]; // in ms
262        // totalTime[]: total time of audio output devices usage
263        int32_t totalTime[NUM_AUDIO_DEVICES]; // in ms
264    };
265
266    // This varialble is used to record the usage of audio output device
267    // for battery app
268    BatteryAudioFlingerUsageInfo mBatteryAudio;
269
270    // Collect info of the codec usage from media player and media recorder
271    virtual void                addBatteryData(uint32_t params);
272    // API for the Battery app to pull the data of codecs usage
273    virtual status_t            pullBatteryData(Parcel* reply);
274private:
275
276    class Client : public BnMediaPlayer {
277        // IMediaPlayer interface
278        virtual void            disconnect();
279        virtual status_t        setVideoSurfaceTexture(
280                                        const sp<IGraphicBufferProducer>& bufferProducer);
281        virtual status_t        prepareAsync();
282        virtual status_t        start();
283        virtual status_t        stop();
284        virtual status_t        pause();
285        virtual status_t        isPlaying(bool* state);
286        virtual status_t        setPlaybackSettings(const AudioPlaybackRate& rate);
287        virtual status_t        getPlaybackSettings(AudioPlaybackRate* rate /* nonnull */);
288        virtual status_t        setSyncSettings(const AVSyncSettings& rate, float videoFpsHint);
289        virtual status_t        getSyncSettings(AVSyncSettings* rate /* nonnull */,
290                                                float* videoFps /* nonnull */);
291        virtual status_t        seekTo(int msec);
292        virtual status_t        getCurrentPosition(int* msec);
293        virtual status_t        getDuration(int* msec);
294        virtual status_t        reset();
295        virtual status_t        setAudioStreamType(audio_stream_type_t type);
296        virtual status_t        setLooping(int loop);
297        virtual status_t        setVolume(float leftVolume, float rightVolume);
298        virtual status_t        invoke(const Parcel& request, Parcel *reply);
299        virtual status_t        setMetadataFilter(const Parcel& filter);
300        virtual status_t        getMetadata(bool update_only,
301                                            bool apply_filter,
302                                            Parcel *reply);
303        virtual status_t        setAuxEffectSendLevel(float level);
304        virtual status_t        attachAuxEffect(int effectId);
305        virtual status_t        setParameter(int key, const Parcel &request);
306        virtual status_t        getParameter(int key, Parcel *reply);
307        virtual status_t        setRetransmitEndpoint(const struct sockaddr_in* endpoint);
308        virtual status_t        getRetransmitEndpoint(struct sockaddr_in* endpoint);
309        virtual status_t        setNextPlayer(const sp<IMediaPlayer>& player);
310
311        sp<MediaPlayerBase>     createPlayer(player_type playerType);
312
313        virtual status_t        setDataSource(
314                        const sp<IMediaHTTPService> &httpService,
315                        const char *url,
316                        const KeyedVector<String8, String8> *headers);
317
318        virtual status_t        setDataSource(int fd, int64_t offset, int64_t length);
319
320        virtual status_t        setDataSource(const sp<IStreamSource> &source);
321        virtual status_t        setDataSource(const sp<IDataSource> &source);
322
323
324        sp<MediaPlayerBase>     setDataSource_pre(player_type playerType);
325        void                    setDataSource_post(const sp<MediaPlayerBase>& p,
326                                                   status_t status);
327
328        static  void            notify(void* cookie, int msg,
329                                       int ext1, int ext2, const Parcel *obj);
330
331                pid_t           pid() const { return mPid; }
332        virtual status_t        dump(int fd, const Vector<String16>& args);
333
334                int             getAudioSessionId() { return mAudioSessionId; }
335
336    private:
337        friend class MediaPlayerService;
338                                Client( const sp<MediaPlayerService>& service,
339                                        pid_t pid,
340                                        int32_t connId,
341                                        const sp<IMediaPlayerClient>& client,
342                                        int audioSessionId,
343                                        uid_t uid);
344                                Client();
345        virtual                 ~Client();
346
347                void            deletePlayer();
348
349        sp<MediaPlayerBase>     getPlayer() const { Mutex::Autolock lock(mLock); return mPlayer; }
350
351
352
353        // @param type Of the metadata to be tested.
354        // @return true if the metadata should be dropped according to
355        //              the filters.
356        bool shouldDropMetadata(media::Metadata::Type type) const;
357
358        // Add a new element to the set of metadata updated. Noop if
359        // the element exists already.
360        // @param type Of the metadata to be recorded.
361        void addNewMetadataUpdate(media::Metadata::Type type);
362
363        // Disconnect from the currently connected ANativeWindow.
364        void disconnectNativeWindow();
365
366        status_t setAudioAttributes_l(const Parcel &request);
367
368        mutable     Mutex                       mLock;
369                    sp<MediaPlayerBase>         mPlayer;
370                    sp<MediaPlayerService>      mService;
371                    sp<IMediaPlayerClient>      mClient;
372                    sp<AudioOutput>             mAudioOutput;
373                    pid_t                       mPid;
374                    status_t                    mStatus;
375                    bool                        mLoop;
376                    int32_t                     mConnId;
377                    int                         mAudioSessionId;
378                    audio_attributes_t *        mAudioAttributes;
379                    uid_t                       mUID;
380                    sp<ANativeWindow>           mConnectedWindow;
381                    sp<IBinder>                 mConnectedWindowBinder;
382                    struct sockaddr_in          mRetransmitEndpoint;
383                    bool                        mRetransmitEndpointValid;
384                    sp<Client>                  mNextClient;
385
386        // Metadata filters.
387        media::Metadata::Filter mMetadataAllow;  // protected by mLock
388        media::Metadata::Filter mMetadataDrop;  // protected by mLock
389
390        // Metadata updated. For each MEDIA_INFO_METADATA_UPDATE
391        // notification we try to update mMetadataUpdated which is a
392        // set: no duplicate.
393        // getMetadata clears this set.
394        media::Metadata::Filter mMetadataUpdated;  // protected by mLock
395
396#if CALLBACK_ANTAGONIZER
397                    Antagonizer*                mAntagonizer;
398#endif
399    }; // Client
400
401// ----------------------------------------------------------------------------
402
403                            MediaPlayerService();
404    virtual                 ~MediaPlayerService();
405
406    mutable     Mutex                       mLock;
407                SortedVector< wp<Client> >  mClients;
408                SortedVector< wp<MediaRecorderClient> > mMediaRecorderClients;
409                int32_t                     mNextConnId;
410                sp<IOMX>                    mOMX;
411                sp<ICrypto>                 mCrypto;
412};
413
414// ----------------------------------------------------------------------------
415
416}; // namespace android
417
418#endif // ANDROID_MEDIAPLAYERSERVICE_H
419