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