android_GenericMediaPlayer.cpp revision 06059e5ee1eaf907589c7f8d1320253f92211348 
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//#define USE_LOG SLAndroidLogLevel_Verbose
18
19#include "sles_allinclusive.h"
20#include "android_GenericMediaPlayer.h"
21
22#include <media/IMediaPlayerService.h>
23#include <surfaceflinger/ISurfaceComposer.h>
24#include <surfaceflinger/SurfaceComposerClient.h>
25#include <media/stagefright/foundation/ADebug.h>
26
27namespace android {
28
29// default delay in Us used when reposting an event when the player is not ready to accept
30// the command yet. This is for instance used when seeking on a MediaPlayer that's still preparing
31#define DEFAULT_COMMAND_DELAY_FOR_REPOST_US (100*1000) // 100ms
32
33static const char* const kDistantProtocolPrefix[] = { "http:", "https:", "ftp:", "rtp:", "rtsp:"};
34#define NB_DISTANT_PROTOCOLS (sizeof(kDistantProtocolPrefix)/sizeof(kDistantProtocolPrefix[0]))
35
36//--------------------------------------------------------------------------------------------------
37MediaPlayerNotificationClient::MediaPlayerNotificationClient(GenericMediaPlayer* gmp) :
38    mGenericMediaPlayer(gmp),
39    mPlayerPrepared(PREPARE_NOT_STARTED)
40{
41    SL_LOGV("MediaPlayerNotificationClient::MediaPlayerNotificationClient()");
42}
43
44MediaPlayerNotificationClient::~MediaPlayerNotificationClient() {
45    SL_LOGV("MediaPlayerNotificationClient::~MediaPlayerNotificationClient()");
46}
47
48// Map a MEDIA_* enum to a string
49static const char *media_to_string(int msg)
50{
51    switch (msg) {
52#define _(x) case MEDIA_##x: return "MEDIA_" #x;
53      _(PREPARED)
54      _(SET_VIDEO_SIZE)
55      _(SEEK_COMPLETE)
56      _(PLAYBACK_COMPLETE)
57      _(BUFFERING_UPDATE)
58      _(ERROR)
59      _(NOP)
60      _(TIMED_TEXT)
61      _(INFO)
62#undef _
63    default:
64        return NULL;
65    }
66}
67
68//--------------------------------------------------
69// IMediaPlayerClient implementation
70void MediaPlayerNotificationClient::notify(int msg, int ext1, int ext2, const Parcel *obj) {
71    SL_LOGV("MediaPlayerNotificationClient::notify(msg=%s (%d), ext1=%d, ext2=%d)",
72            media_to_string(msg), msg, ext1, ext2);
73
74    switch (msg) {
75      case MEDIA_PREPARED:
76        mPlayerPrepared = PREPARE_COMPLETED_SUCCESSFULLY;
77        mPlayerPreparedCondition.signal();
78        break;
79
80      case MEDIA_SET_VIDEO_SIZE:
81        // only send video size updates if the player was flagged as having video, to avoid
82        // sending video size updates of (0,0)
83        if (mGenericMediaPlayer->mHasVideo) {
84            mGenericMediaPlayer->notify(PLAYEREVENT_VIDEO_SIZE_UPDATE,
85                    (int32_t)ext1, (int32_t)ext2, true /*async*/);
86        }
87        break;
88
89      case MEDIA_SEEK_COMPLETE:
90          mGenericMediaPlayer->seekComplete();
91        break;
92
93      case MEDIA_PLAYBACK_COMPLETE:
94        mGenericMediaPlayer->notify(PLAYEREVENT_ENDOFSTREAM, 1, true /*async*/);
95        break;
96
97      case MEDIA_BUFFERING_UPDATE:
98        // values received from Android framework for buffer fill level use percent,
99        //   while SL/XA use permille, so does GenericPlayer
100        mGenericMediaPlayer->bufferingUpdate(ext1 * 10 /*fillLevelPerMille*/);
101        break;
102
103      case MEDIA_ERROR:
104        mPlayerPrepared = PREPARE_COMPLETED_UNSUCCESSFULLY;
105        mPlayerPreparedCondition.signal();
106        break;
107
108      case MEDIA_NOP:
109      case MEDIA_TIMED_TEXT:
110      case MEDIA_INFO:
111        break;
112
113      default: { }
114    }
115
116}
117
118//--------------------------------------------------
119void MediaPlayerNotificationClient::beforePrepare()
120{
121    Mutex::Autolock _l(mLock);
122    assert(mPlayerPrepared == PREPARE_NOT_STARTED);
123    mPlayerPrepared = PREPARE_IN_PROGRESS;
124}
125
126//--------------------------------------------------
127bool MediaPlayerNotificationClient::blockUntilPlayerPrepared() {
128    Mutex::Autolock _l(mLock);
129    assert(mPlayerPrepared != PREPARE_NOT_STARTED);
130    while (mPlayerPrepared == PREPARE_IN_PROGRESS) {
131        mPlayerPreparedCondition.wait(mLock);
132    }
133    assert(mPlayerPrepared == PREPARE_COMPLETED_SUCCESSFULLY ||
134            mPlayerPrepared == PREPARE_COMPLETED_UNSUCCESSFULLY);
135    return mPlayerPrepared == PREPARE_COMPLETED_SUCCESSFULLY;
136}
137
138//--------------------------------------------------------------------------------------------------
139GenericMediaPlayer::GenericMediaPlayer(const AudioPlayback_Parameters* params, bool hasVideo) :
140    GenericPlayer(params),
141    mHasVideo(hasVideo),
142    mSeekTimeMsec(0),
143    mVideoSurface(0),
144    mVideoSurfaceTexture(0),
145    mPlayer(0),
146    mPlayerClient(0),
147    mGetMediaPlayerInfoGenCount(0)
148{
149    SL_LOGD("GenericMediaPlayer::GenericMediaPlayer()");
150
151    mServiceManager = defaultServiceManager();
152    mBinder = mServiceManager->getService(String16("media.player"));
153    mMediaPlayerService = interface_cast<IMediaPlayerService>(mBinder);
154
155    CHECK(mMediaPlayerService.get() != NULL);
156
157    mPlayerClient = new MediaPlayerNotificationClient(this);
158}
159
160GenericMediaPlayer::~GenericMediaPlayer() {
161    SL_LOGD("GenericMediaPlayer::~GenericMediaPlayer()");
162}
163
164void GenericMediaPlayer::preDestroy() {
165    SL_LOGD("GenericMediaPlayer::preDestroy()");
166    // we might be in the middle of blocking for a getXXX call
167    {
168        android::Mutex::Autolock autoLock(mGetMediaPlayerInfoLock);
169        mGetMediaPlayerInfoGenCount++;
170        mGetMediaPlayerInfoCondition.broadcast();
171    }
172    GenericPlayer::preDestroy();
173}
174
175//--------------------------------------------------
176// overridden from GenericPlayer
177// pre-condition:
178//   msec != NULL
179// post-condition
180//   *msec == mPositionMsec ==
181//                  ANDROID_UNKNOWN_TIME if position is unknown at time of query,
182//               or the current MediaPlayer position
183void GenericMediaPlayer::getPositionMsec(int* msec) {
184    SL_LOGD("GenericMediaPlayer::getPositionMsec()");
185    uint32_t currentGen = 0;
186    {
187        android::Mutex::Autolock autoLock(mGetMediaPlayerInfoLock);
188        currentGen = mGetMediaPlayerInfoGenCount;
189    }
190    // send a message to update the MediaPlayer position in the event loop where it's safe to
191    //   access the MediaPlayer. We block until the message kWhatMediaPlayerInfo has been processed
192    (new AMessage(kWhatMediaPlayerInfo, id()))->post();
193    {
194        android::Mutex::Autolock autoLock(mGetMediaPlayerInfoLock);
195        // mGetMediaPlayerInfoGenCount will be incremented when the kWhatMediaPlayerInfo
196        //  gets processed.
197        while (currentGen == mGetMediaPlayerInfoGenCount) {
198            mGetMediaPlayerInfoCondition.wait(mGetMediaPlayerInfoLock);
199            // if multiple GetPosition calls were issued before any got processed on the event queue
200            // then they will all return the same "recent-enough" position
201        }
202        // at this point mPositionMsec has been updated
203        // so now updates msec from mPositionMsec, while holding the lock protecting it
204        GenericPlayer::getPositionMsec(msec);
205    }
206}
207
208//--------------------------------------------------
209void GenericMediaPlayer::setVideoSurface(const sp<Surface> &surface) {
210    SL_LOGV("GenericMediaPlayer::setVideoSurface()");
211    mVideoSurface = surface;
212}
213
214void GenericMediaPlayer::setVideoSurfaceTexture(const sp<ISurfaceTexture> &surfaceTexture) {
215    SL_LOGV("GenericMediaPlayer::setVideoSurfaceTexture()");
216    mVideoSurfaceTexture = surfaceTexture;
217}
218
219//--------------------------------------------------
220void GenericMediaPlayer::onMessageReceived(const sp<AMessage> &msg) {
221    SL_LOGV("GenericMediaPlayer::onMessageReceived()");
222    switch (msg->what()) {
223        case kWhatMediaPlayerInfo:
224            onGetMediaPlayerInfo();
225            break;
226
227        default:
228            GenericPlayer::onMessageReceived(msg);
229            break;
230    }
231}
232
233//--------------------------------------------------
234// Event handlers
235
236void GenericMediaPlayer::onPrepare() {
237    SL_LOGD("GenericMediaPlayer::onPrepare()");
238    // Attempt to prepare at most once, and only if there is a MediaPlayer
239    if (!(mStateFlags & (kFlagPrepared | kFlagPreparedUnsuccessfully)) && (mPlayer != 0)) {
240        if (mHasVideo) {
241            if (mVideoSurface != 0) {
242                mPlayer->setVideoSurface(mVideoSurface);
243            } else if (mVideoSurfaceTexture != 0) {
244                mPlayer->setVideoSurfaceTexture(mVideoSurfaceTexture);
245            }
246        }
247        mPlayer->setAudioStreamType(mPlaybackParams.streamType);
248        mPlayerClient->beforePrepare();
249        mPlayer->prepareAsync();
250        if (mPlayerClient->blockUntilPlayerPrepared()) {
251            mStateFlags |= kFlagPrepared;
252            afterMediaPlayerPreparedSuccessfully();
253        } else {
254            mStateFlags |= kFlagPreparedUnsuccessfully;
255        }
256        GenericPlayer::onPrepare();
257    }
258    SL_LOGD("GenericMediaPlayer::onPrepare() done, mStateFlags=0x%x", mStateFlags);
259}
260
261
262void GenericMediaPlayer::onPlay() {
263    SL_LOGD("GenericMediaPlayer::onPlay()");
264    if ((mStateFlags & kFlagPrepared) && (mPlayer != 0)) {
265        SL_LOGD("starting player");
266        mPlayer->start();
267        mStateFlags |= kFlagPlaying;
268    } else {
269        SL_LOGV("NOT starting player mStateFlags=0x%x", mStateFlags);
270    }
271}
272
273
274void GenericMediaPlayer::onPause() {
275    SL_LOGD("GenericMediaPlayer::onPause()");
276    if ((mStateFlags & kFlagPrepared) && (mPlayer != 0)) {
277        mPlayer->pause();
278        mStateFlags &= ~kFlagPlaying;
279    }
280}
281
282/**
283 * pre-condition: WHATPARAM_SEEK_SEEKTIME_MS parameter value >= 0
284 */
285void GenericMediaPlayer::onSeek(const sp<AMessage> &msg) {
286    SL_LOGV("GenericMediaPlayer::onSeek");
287    int64_t timeMsec = ANDROID_UNKNOWN_TIME;
288    if (!msg->findInt64(WHATPARAM_SEEK_SEEKTIME_MS, &timeMsec)) {
289        // invalid command, drop it
290        return;
291    }
292    if ((mStateFlags & kFlagSeeking) && (timeMsec == mSeekTimeMsec)) {
293        // already seeking to the same time, cancel this command
294        return;
295    } else if (mStateFlags & kFlagPreparedUnsuccessfully) {
296        // discard seeks after unsuccessful prepare
297    } else if (!(mStateFlags & kFlagPrepared)) {
298        // we are not ready to accept a seek command at this time, retry later
299        msg->post(DEFAULT_COMMAND_DELAY_FOR_REPOST_US);
300    } else {
301        if (msg->findInt64(WHATPARAM_SEEK_SEEKTIME_MS, &timeMsec) && (mPlayer != 0)) {
302            mStateFlags |= kFlagSeeking;
303            mSeekTimeMsec = (int32_t)timeMsec;
304            if (OK != mPlayer->seekTo(timeMsec)) {
305                mStateFlags &= ~kFlagSeeking;
306                mSeekTimeMsec = ANDROID_UNKNOWN_TIME;
307            } else {
308                mPositionMsec = mSeekTimeMsec;
309            }
310        }
311    }
312}
313
314
315void GenericMediaPlayer::onLoop(const sp<AMessage> &msg) {
316    SL_LOGV("GenericMediaPlayer::onLoop");
317    int32_t loop = 0;
318    if (msg->findInt32(WHATPARAM_LOOP_LOOPING, &loop)) {
319        if (mPlayer != 0 && OK == mPlayer->setLooping(loop)) {
320            if (loop) {
321                mStateFlags |= kFlagLooping;
322            } else {
323                mStateFlags &= ~kFlagLooping;
324            }
325        }
326    }
327}
328
329
330void GenericMediaPlayer::onVolumeUpdate() {
331    SL_LOGD("GenericMediaPlayer::onVolumeUpdate()");
332    // use settings lock to read the volume settings
333    Mutex::Autolock _l(mSettingsLock);
334    if (mPlayer != 0) {
335        mPlayer->setVolume(mAndroidAudioLevels.mFinalVolume[0],
336                mAndroidAudioLevels.mFinalVolume[1]);
337    }
338}
339
340
341void GenericMediaPlayer::onAttachAuxEffect(const sp<AMessage> &msg) {
342    SL_LOGD("GenericMediaPlayer::onAttachAuxEffect()");
343    int32_t effectId = 0;
344    if (msg->findInt32(WHATPARAM_ATTACHAUXEFFECT, &effectId)) {
345        if (mPlayer != 0) {
346            status_t status;
347            status = mPlayer->attachAuxEffect(effectId);
348            // attachAuxEffect returns a status but we have no way to report it back to app
349            (void) status;
350        }
351    }
352}
353
354
355void GenericMediaPlayer::onSetAuxEffectSendLevel(const sp<AMessage> &msg) {
356    SL_LOGD("GenericMediaPlayer::onSetAuxEffectSendLevel()");
357    float level = 0.0f;
358    if (msg->findFloat(WHATPARAM_SETAUXEFFECTSENDLEVEL, &level)) {
359        if (mPlayer != 0) {
360            status_t status;
361            status = mPlayer->setAuxEffectSendLevel(level);
362            // setAuxEffectSendLevel returns a status but we have no way to report it back to app
363            (void) status;
364        }
365    }
366}
367
368
369void GenericMediaPlayer::onBufferingUpdate(const sp<AMessage> &msg) {
370    int32_t fillLevel = 0;
371    if (msg->findInt32(WHATPARAM_BUFFERING_UPDATE, &fillLevel)) {
372        SL_LOGD("GenericMediaPlayer::onBufferingUpdate(fillLevel=%d)", fillLevel);
373
374        Mutex::Autolock _l(mSettingsLock);
375        mCacheFill = fillLevel;
376        // handle cache fill update
377        if (mCacheFill - mLastNotifiedCacheFill >= mCacheFillNotifThreshold) {
378            notifyCacheFill();
379        }
380        // handle prefetch status update
381        //   compute how much time ahead of position is buffered
382        int durationMsec, positionMsec = -1;
383        if ((mStateFlags & kFlagPrepared) && (mPlayer != 0)
384                && (OK == mPlayer->getDuration(&durationMsec))
385                        && (OK == mPlayer->getCurrentPosition(&positionMsec))) {
386            if ((-1 != durationMsec) && (-1 != positionMsec)) {
387                // evaluate prefetch status based on buffer time thresholds
388                int64_t bufferedDurationMsec = (durationMsec * fillLevel / 100) - positionMsec;
389                CacheStatus_t newCacheStatus = mCacheStatus;
390                if (bufferedDurationMsec > DURATION_CACHED_HIGH_MS) {
391                    newCacheStatus = kStatusHigh;
392                } else if (bufferedDurationMsec > DURATION_CACHED_MED_MS) {
393                    newCacheStatus = kStatusEnough;
394                } else if (bufferedDurationMsec > DURATION_CACHED_LOW_MS) {
395                    newCacheStatus = kStatusIntermediate;
396                } else if (bufferedDurationMsec == 0) {
397                    newCacheStatus = kStatusEmpty;
398                } else {
399                    newCacheStatus = kStatusLow;
400                }
401
402                if (newCacheStatus != mCacheStatus) {
403                    mCacheStatus = newCacheStatus;
404                    notifyStatus();
405                }
406            }
407        }
408    } else {
409        SL_LOGV("GenericMediaPlayer::onBufferingUpdate(fillLevel=unknown)");
410    }
411}
412
413
414void GenericMediaPlayer::onGetMediaPlayerInfo() {
415    SL_LOGD("GenericMediaPlayer::onGetMediaPlayerInfo()");
416    {
417        android::Mutex::Autolock autoLock(mGetMediaPlayerInfoLock);
418
419        if ((!(mStateFlags & kFlagPrepared)) || (mPlayer == 0)) {
420            mPositionMsec = ANDROID_UNKNOWN_TIME;
421        } else {
422            mPlayer->getCurrentPosition(&mPositionMsec);
423        }
424
425        // the MediaPlayer info has been refreshed
426        mGetMediaPlayerInfoGenCount++;
427        // there might be multiple requests for MediaPlayer info, so use broadcast instead of signal
428        mGetMediaPlayerInfoCondition.broadcast();
429    }
430}
431
432
433//--------------------------------------------------
434/**
435 * called from GenericMediaPlayer::onPrepare after the MediaPlayer mPlayer is prepared successfully
436 * pre-conditions:
437 *  mPlayer != 0
438 *  mPlayer is prepared successfully
439 */
440void GenericMediaPlayer::afterMediaPlayerPreparedSuccessfully() {
441    SL_LOGV("GenericMediaPlayer::afterMediaPlayerPrepared()");
442    assert(mPlayer != 0);
443    assert(mStateFlags & kFlagPrepared);
444    // retrieve channel count
445    assert(UNKNOWN_NUMCHANNELS == mChannelCount);
446    Parcel *reply = new Parcel();
447    status_t status = mPlayer->getParameter(KEY_PARAMETER_AUDIO_CHANNEL_COUNT, reply);
448    if (status == NO_ERROR) {
449        mChannelCount = reply->readInt32();
450        if (UNKNOWN_NUMCHANNELS != mChannelCount) {
451            // now that we know the channel count, re-calculate the volumes
452            notify(PLAYEREVENT_CHANNEL_COUNT, mChannelCount, true /*async*/);
453        } else {
454            LOGW("channel count is still unknown after prepare");
455        }
456    }
457    delete reply;
458    // retrieve duration
459    {
460        Mutex::Autolock _l(mSettingsLock);
461        int msec = 0;
462        if (OK == mPlayer->getDuration(&msec)) {
463            mDurationMsec = msec;
464        }
465    }
466    // when the MediaPlayer mPlayer is prepared, there is "sufficient data" in the playback buffers
467    // if the data source was local, and the buffers are considered full so we need to notify that
468    bool isLocalSource = true;
469    if (kDataLocatorUri == mDataLocatorType) {
470        for (unsigned int i = 0 ; i < NB_DISTANT_PROTOCOLS ; i++) {
471            if (!strncasecmp(mDataLocator.uriRef,
472                    kDistantProtocolPrefix[i], strlen(kDistantProtocolPrefix[i]))) {
473                isLocalSource = false;
474                break;
475            }
476        }
477    }
478    if (isLocalSource) {
479        SL_LOGD("media player prepared on local source");
480        {
481            Mutex::Autolock _l(mSettingsLock);
482            mCacheStatus = kStatusHigh;
483            mCacheFill = 1000;
484            notifyStatus();
485            notifyCacheFill();
486        }
487    } else {
488        SL_LOGD("media player prepared on non-local source");
489    }
490}
491
492} // namespace android
493