Universal播放器的源码学习笔记

作者: 30cf443c3643 | 来源:发表于2019-01-08 16:42 被阅读10次

以前也弄过音乐播放器的代码，自己写起来非常的粗糙，感觉音乐播放器的难点包括歌曲列表的管理，音乐后台服务跟主线程之间的通信。当然，也看过别人封装的比较好的音乐服务，通过aidl的方式来实现进程间通信，比如这个MusicService.java,3000行代码把所有的内容都封装好了。阅读者看起来真的吃力。之后，看到谷歌的UniversalMusicPlayer播放器，用MediaBrowserService框架来实现播放器。

框架基本构成

20180518102735984.png

UI端

UI端的角色有MediaBrowser和MediaController。

MediaBrowser

首先MediaBrowser需要去想办法连接服务端，通过

 mMediaBrowser = new MediaBrowserCompat(this,
            new ComponentName(this, MusicService.class), mConnectionCallback, null);
mMediaBrowser .connect();

其中mConnectionCallback是和服务端连接的回调。

private final MediaBrowserCompat.ConnectionCallback mConnectionCallback =
            new MediaBrowserCompat.ConnectionCallback() {
        @Override
        public void onConnected() {
             //说明已经连接上了
            try {
                connectToSession(mMediaBrowser.getSessionToken());
            } catch (RemoteException e) {
                LogHelper.e(TAG, e, "could not connect media controller");
            }
        }
    };

可以通过返回的MediaSessionCompat.Token获取到MediaControllerCompat（控制器）

private void connectToSession(MediaSessionCompat.Token token) throws RemoteException {
        MediaControllerCompat mediaController = new MediaControllerCompat(
                FullScreenPlayerActivity.this, token);
        MediaControllerCompat.setMediaController(FullScreenPlayerActivity.this, mediaController);
        mediaController.registerCallback(mCallback);
        PlaybackStateCompat state = mediaController.getPlaybackState();
        //更新播放状态()
        MediaMetadataCompat metadata = mediaController.getMetadata();
        if (metadata != null) {
            //更新ui
        }
    }

MediaControllerCompat

控制播放，暂停，下一首，上一首等操作，通过TransportControls来实现

        MediaControllerCompat controller = MediaControllerCompat.getMediaController(context);
        MediaControllerCompat.TransportControls transport = controller.getTransportControls();
        transport.play();

同时也监听播放状态跟metadata的变化。

mediaController.registerCallback(new MediaControllerCompat.Callback() {
       @Override
       public void onPlaybackStateChanged(@NonNull PlaybackStateCompat state) {
           LogHelper.d(TAG, "onPlaybackstate changed", state);
           
       }

       @Override
       public void onMetadataChanged(MediaMetadataCompat metadata) {
           if (metadata != null) {
               
           }
       });

PlaybackStateCompat

mediaController回调onPlaybackStateChanged方法，然后根据state.getState()来处理UI的变化

switch (state.getState()) {
            case PlaybackStateCompat.STATE_PLAYING://正在播放
                break;
            case PlaybackStateCompat.STATE_PAUSED://暂停
                break;
            case PlaybackStateCompat.STATE_NONE:
                break;
            case PlaybackStateCompat.STATE_STOPPED://停止
                break;
            case PlaybackStateCompat.STATE_BUFFERING:
                break;
            default:
                break;

        }

MediaMetadataCompat

保存了歌曲的信息，包括uri，专辑名称，歌手，时长等。

通过 builder = new MediaMetadataCompat.Builder();
builde.putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title");保存信息

服务端

MediaBrowserServiceCompat

我们让自己定义的service继承MediaBrowserServiceCompat，同时在清单中注册。然后处理连接的请求。服务端会在onGetRoot方法中收到请求，此时返回一个rootId就好了，例如:"_EMPTY"，如果方法返回null，则拒绝连接

 @Override
    public BrowserRoot onGetRoot(@NonNull String s, int i, @Nullable Bundle bundle) {
        return new BrowserRoot("__EMPTY_",null);
    }

MediaSession

那么什么是MediaSessionCompat呢?
在MediaSession框架中，有受控端（一个）和控制端（可以有多个）。接下来为了保证受控端和控制端不串号（想象一个遥控器可以遥控同一型号的多台电视），就有了SessionToken的概念，相当于我们在连接蓝牙设备时的配对码，这样就保证了不串号
当应用程序想要发布媒体播放信息或处理媒体密钥时，应该创建MediaSession。MediaSessionCompat允许与媒体控制器、音量键、媒体按钮和传输控制进行交互。一般来说，一个应用程序只需要一个会话来进行所有的播放（尽管可以创建多个会话来提供更好的媒体控制）
在MusicService中初始化MediaSession

        mSession = new MediaSessionCompat(this, "MusicService");
        setSessionToken(mSession.getSessionToken());
        mSession.setCallback(mCallback);
        mSession.setFlags(MediaSessionCompat.FLAG_HANDLES_MEDIA_BUTTONS |
                MediaSessionCompat.FLAG_HANDLES_TRANSPORT_CONTROLS);

此处mCallback是MediaSessionCompat.Callback的子类，它的回调方法有onPlay(),onPause(),onSkipToQueueItem(long queueId),onSkipToPrevious()。也就是说MediaControllerCompat.TransportControls调用播放，暂停等功能时会调用服务端MediaSession的onPlay(),onPause()等方法。

另外

mSession.setMetadata(metadata);
mSession.setPlaybackState(newState);

会回调controller的onMetadataChanged，onPlaybackStateChanged方法。
一个MediaSession框架基本思路就完成了。

分析源码

Playback

定义一个播放器接口Playback

    void start();

    void stop(boolean notifyListeners);

    void setState(int state);

    int getState();

    boolean isConnected();

    boolean isPlaying();

    long getCurrentStreamPosition();

    void updateLastKnownStreamPosition();

    void play(QueueItem item);

    void pause();

    void seekTo(long position);

    void setCurrentMediaId(String mediaId);

    String getCurrentMediaId();

具体的实现由MediaPlayer或exoPlayer完成

QueueManager

需要去定义一个队列，它可以是单例的。它需要完成哪些功能呢？获取当前播放的列表，获取当前播放曲目，获取当前下标，更换新列表。同时列表改变了，曲目改变了，下标改变了等等需要让MediaSession知道吧，毕竟mSession.setMetadata(metadata)会回调ui的变化，所以需要一个接口

public interface MetadataUpdateListener {
        void onMetadataChanged(MediaMetadataCompat metadata);
        void onMetadataRetrieveError();
        void onCurrentQueueIndexUpdated(int queueIndex);
        void onQueueUpdated(String title, List<MediaSessionCompat.QueueItem> newQueue);
    }

所以在MusicService中有这样的一段

QueueManager queueManager = new QueueManager(mMusicProvider, getResources(),
                new QueueManager.MetadataUpdateListener() {
                    @Override
                    public void onMetadataChanged(MediaMetadataCompat metadata) {
                        mSession.setMetadata(metadata);
                    }

                    @Override
                    public void onMetadataRetrieveError() {
                        mPlaybackManager.updatePlaybackState(
                                getString(R.string.error_no_metadata));
                    }

                    @Override
                    public void onCurrentQueueIndexUpdated(int queueIndex) {
                        mPlaybackManager.handlePlayRequest();
                    }

                    @Override
                    public void onQueueUpdated(String title,
                                               List<MediaSessionCompat.QueueItem> newQueue) {
                        mSession.setQueue(newQueue);
                        mSession.setQueueTitle(title);
                    }
                });

java中有个模式叫中介者模式，用来协调各角色之间的关系。将系统从网状结构变成星型结构，为了协调player,queue,MusicService之间的关系，所以有了MusicPlayBackManager这个角色。首先MusicPlayBackManager需要知道播放器player的状况。比如播放完成，播放出错等，所以MusicPlayBackManager实现了

interface Callback {
        /**
         * On current music completed.
         */
        void onCompletion();
        /**
         * on Playback status changed
         * Implementations can use this callback to update
         * playback state on the media sessions.
         */
        void onPlaybackStatusChanged(int state);

        /**
         * @param error to be added to the PlaybackState
         */
        void onError(String error);

        /**
         * @param mediaId being currently played
         */
        void setCurrentMediaId(String mediaId);
    }

这些方法都由MusicPlayBackManager来处理，具体的player用callback来回调这些方法。
例如

 @Override
    public void play(QueueItem item) {
        try {
            loadMedia(item.getDescription().getMediaId(), true);
            mPlaybackState = PlaybackStateCompat.STATE_BUFFERING;
            if (mCallback != null) {
                mCallback.onPlaybackStatusChanged(mPlaybackState);
            }
        } catch (JSONException e) {
            LogHelper.e(TAG, "Exception loading media ", e, null);
            if (mCallback != null) {
                mCallback.onError(e.getMessage());
            }
        }
    }

MusicPlayBackManager跟mediaseesion要产生联系，通过PlaybackManager.PlaybackServiceCallback

    public interface PlaybackServiceCallback {
        void onPlaybackStart();

        void onNotificationRequired();

        void onPlaybackStop();

        void onPlaybackStateUpdated(PlaybackStateCompat newState);
    }

MusicService实现了这些方法,例如

    @Override
    public void onPlaybackStateUpdated(PlaybackStateCompat newState) {
        mSession.setPlaybackState(newState);
    }

    @Override
    public void onPlaybackStop() {
        mSession.setActive(false);
        // Reset the delayed stop handler, so after STOP_DELAY it will be executed again,
        // potentially stopping the service.
        mDelayedStopHandler.removeCallbacksAndMessages(null);
        mDelayedStopHandler.sendEmptyMessageDelayed(0, STOP_DELAY);
        stopForeground(true);
    }

同时MusicPlayBackManager 还要处理mSession.setCallback(mPlaybackManager.getMediaSessionCallback())，内部类的方式

private class MediaSessionCallback extends MediaSessionCompat.Callback {
        @Override
        public void onPlay() {
            LogHelper.d(TAG, "play");
            if (mQueueManager.getCurrentMusic() == null) {
                mQueueManager.setRandomQueue();
            }
            handlePlayRequest();
        }

        @Override
        public void onSkipToQueueItem(long queueId) {
            LogHelper.d(TAG, "OnSkipToQueueItem:" + queueId);
            mQueueManager.setCurrentQueueItem(queueId);
            mQueueManager.updateMetadata();
        }
        ...
}

基本的设计思路就是这样,值得学习的项目

Universal播放器的源码学习笔记

框架基本构成

UI端

MediaBrowser

MediaControllerCompat

PlaybackStateCompat

MediaMetadataCompat

服务端

MediaBrowserServiceCompat

MediaSession

分析源码

Playback

QueueManager

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读