Python 流媒体播放器(基于VLC)
阅读目录
- 环境准备
- 安装python-vlc 绑定
- 简单播放示例
- VLC 监听器
- 视频加字幕
- VLC的选项参数设置
- 在Tkinter中嵌入视频
- 跨平台
网上关于Python的音视频播放示例都集中在简单的多媒体库或者PyGame这样的游戏库,有些库使用简单,但功能单一,有些库功能丰富,支持的格式多,但使用繁琐。那有没有一种功能丰富全面又使用简单,而且还能支持流媒体播放的库呢?答案是有的。
VLC就是我们今天的主角。官网地址: https://www.videolan.org/
根据官网的介绍,它是一款自由、开源的跨平台多媒体播放器及框架,它全面支持绝大部分的多媒体格式,以及各类流媒体协议。也就是说,使用它既能播放本地音视频文件,也能在线播放各类流媒体资源。
这是目前全网最全面的一篇关于VLC的Python语言绑定的使用教程,本人浏览了其API文档,从文档中直接提炼出了Python语言绑定的使用方法,本篇以Windows平台为主,如果读者朋友觉得有用,请点赞支持!
环境准备
VLC 安装
VLC实际上是比较知名的开源多媒体播放器,要使用这个库,首先需要在电脑上安装VLC,我们可以直接在上述的官网中下载并安装它,有一点需要特别注意,如果本地安装的Python是32位,则你必须下载32位的VLC,64位则下64位的VLC,必须与Python的版本对应,否则无法使用。
事实上,我并不推荐这样直接安装。试想一下,如果我们使用Python开发一个基于VLC的播放器发布出去,却要求用户在使用之前,先安装一个VLC播放器,岂不是很荒谬?那么如何将VLC集成到Python程序中来,才是问题的关键。
关于这个问题,没有找到相关资料,只能通过查看python-vlc绑定的源码来寻找方法。
安装python-vlc 绑定
VLC
是纯C语言开发的框架,Python想要更简单的调用,需要安装一个python-vlc 绑定,实际上就是一个vlc.py
模块,它封装了VLC
动态库的接口,让我们使用更简单。
完成安装后,我们在site-packages中找到vlc.py源码,查看其对VLC动态库的加载代码,可以发现,在Windows系统上,vlc.py是通过查询Windows注册表的方式来搜索路径并加载VLC的dll动态库的。但它其中也提供了一个配置环境变量PYTHON_VLC_MODULE_PATH的加载方式,这样我们就能在尽可能不修改vlc.py源码的前提下完成VLC动态库的集成。
好了,到这里,我们只需要去下载一个VLC的绿色免安装版本即可。由于我的Python环境是64位,这里给出一个Windows 64位下载地址:http://download.videolan.org/pub/videolan/vlc/last/win64/; 选择vlc-3.0.6-win64.7z即可
下载完成后,解压目录,进入其中,删除无关内容,保留如下文件
其中plugins
中的内容非常多,达到122M,我们可以根据实际情况进行剪裁,例如我们只需要做一个音频播放器,则可将其中的video相关的文件夹删除,还包括gui文件夹,因为我们要自己做界面,不需要gui里面的qt相关的dll。
简单播放示例
创建一个Python工程,将已经剪裁好的vlc-3.0.6
文件夹拷贝到工程根目录。然后创建一个python脚本,我们对vlc.py
再次封装。
import os, time# 设置VLC库路径,需在import vlc之前os.environ['PYTHON_VLC_MODULE_PATH'] = './vlc-3.0.6'import vlcclass Player: ''' args:设置 options ''' def __init__(self, *args): if args: instance = vlc.Instance(*args) self.media = instance.media_player_new() else: self.media = vlc.MediaPlayer() # 设置待播放的url地址或本地文件路径,每次调用都会重新加载资源 def set_uri(self, uri): self.media.set_mrl(uri) # 播放 成功返回0,失败返回-1 def play(self, path=None): if path: self.set_uri(path) return self.media.play() else: return self.media.play() # 暂停 def pause(self): self.media.pause() # 恢复 def resume(self): self.media.set_pause(0) # 停止 def stop(self): self.media.stop() # 释放资源 def release(self): return self.media.release() # 是否正在播放 def is_playing(self): return self.media.is_playing() # 已播放时间,返回毫秒值 def get_time(self): return self.media.get_time() # 拖动指定的毫秒值处播放。成功返回0,失败返回-1 (需要注意,只有当前多媒体格式或流媒体协议支持才会生效) def set_time(self, ms): return self.media.get_time() # 音视频总长度,返回毫秒值 def get_length(self): return self.media.get_length() # 获取当前音量(0~100) def get_volume(self): return self.media.audio_get_volume() # 设置音量(0~100) def set_volume(self, volume): return self.media.audio_set_volume(volume) # 返回当前状态:正在播放;暂停中;其他 def get_state(self): state = self.media.get_state() if state == vlc.State.Playing: return 1 elif state == vlc.State.Paused: return 0 else: return -1 # 当前播放进度情况。返回0.0~1.0之间的浮点数 def get_position(self): return self.media.get_position() # 拖动当前进度,传入0.0~1.0之间的浮点数(需要注意,只有当前多媒体格式或流媒体协议支持才会生效) def set_position(self, float_val): return self.media.set_position(float_val) # 获取当前文件播放速率 def get_rate(self): return self.media.get_rate() # 设置播放速率(如:1.2,表示加速1.2倍播放) def set_rate(self, rate): return self.media.set_rate(rate) # 设置宽高比率(如'16:9','4:3') def set_ratio(self, ratio): self.media.video_set_scale(0) # 必须设置为0,否则无法修改屏幕宽高 self.media.video_set_aspect_ratio(ratio) # 注册监听器 def add_callback(self, event_type, callback): self.media.event_manager().event_attach(event_type, callback) # 移除监听器 def remove_callback(self, event_type, callback): self.media.event_manager().event_detach(event_type, callback)
调用代码
VLC 监听器
上面代码中,我们注册了MediaPlayerTimeChanged类型的监听器,表示已播放时间变化时回调,可以看到my_call_back会不断回调,因为每播放一点都会回调。
除了上述的监听器,VLC的监听器实际上非常多,常见的我们列举如下:
- MediaPlayerNothingSpecial:vlc处于空闲状态,只是等待发出命令
- MediaPlayerOpening:vlc正在打开媒体资源定位器(MRL)
- MediaPlayerBuffering(int cache):vlc正在缓冲
- MediaPlayerPlaying:vlc正在播放媒体
- MediaPlayerPaused:vlc处于暂停状态
- MediaPlayerStopped:vlc处于停止状态
- MediaPlayerForward:vlc通过媒体快进(这永远不会被调用)
- MediaPlayerBackward:vlc正在快退(这永远不会被调用)
- MediaPlayerEncounteredError:vlc遇到错误,无法继续
- MediaPlayerEndReached:vlc已到达当前播放列表的末尾
- MediaPlayerTimeChanged:时间发生改变
- MediaPlayerPositionChanged:进度发生改变
- MediaPlayerSeekableChanged:流媒体是否可搜索的状态发生改变(true表示可搜索,false表示不可搜索)
- MediaPlayerPausableChanged:媒体是否可暂停状态发生改变(true表示可暂停,false表示不可暂停)
- MediaPlayerMediaChanged : 媒体发生改变
- MediaPlayerTitleChanged: 标题发生改变(DVD/Blu-ray)
- MediaPlayerChapterChanged :章节发生改变(DVD/Blu-ray)
- MediaPlayerLengthChanged :(在vlc版本<2.2.0仅适用于Mozilla)长度已更改
- MediaPlayerVout :视频输出的数量发生改变
- MediaPlayerMuted :静音
- MediaPlayerUnmuted :取消静音
- MediaPlayerAudioVolume :音量发生改变
要查看全部支持的监听器,请访问 官方文档:https://www.olivieraubert.net/vlc/python-ctypes 并搜索EventType类型查看
视频加字幕
在我们上述封装的Player
类中添加如下方法。
def set_marquee(self): self.media.video_set_marquee_int(vlc.VideoMarqueeOption.Enable, 1) self.media.video_set_marquee_int(vlc.VideoMarqueeOption.Size, 28) self.media.video_set_marquee_int(vlc.VideoMarqueeOption.Color, 0xff0000) self.media.video_set_marquee_int(vlc.VideoMarqueeOption.Position, vlc.Position.Bottom) self.media.video_set_marquee_int(vlc.VideoMarqueeOption.Timeout, 0) self.media.video_set_marquee_int(vlc.VideoMarqueeOption.Refresh, 10000) def update_text(self, content): self.media.video_set_marquee_string(vlc.VideoMarqueeOption.Text, content)
创建调用代码
video_set_marquee_string
函数不仅支持直接传入字符串,还支持'%Y-%m-%d %H:%M:%S'
这种时间格式,运行上述代码后,会在屏幕下方显示当前时间,且每一秒刷新一次。
关于文本的一些属性设置
- VideoMarqueeOption.Color :文本颜色,值为16进制数
- VideoMarqueeOption.Enable:是否开启文本显示,1表示开启
- VideoMarqueeOption.Opacity:文本透明度,0 透明,255 完全不透明
- VideoMarqueeOption.Position:文本显示的位置
- VideoMarqueeOption.Refresh:字符串刷新的间隔(毫秒)对时间格式字串刷新有用
- VideoMarqueeOption.Size:文字大小,单位像素
- VideoMarqueeOption.Text:要显示的文本内容
- VideoMarqueeOption.Timeout:文本停留时间。0表示永远停留(毫秒值)
- VideoMarqueeOption.marquee_X:设置显示文本的x坐标值
- VideoMarqueeOption.marquee_Y:设置显示文本的y坐标值
上面的示例仅仅显示了一个固定的时间字符串,下面我们看一下如何显示连续的字幕
if '__main__' == __name__: player = Player('--sub-source=marq') player.play('http://hd.yinyuetai.com/uploads/videos/common/' '22970150925A6BB75E20D95798D129EE.flv?sc\u003d17d6a907580e9892' '\u0026br\u003d1103\u0026vid\u003d2400382\u0026aid\u003d32' '\u0026area\u003dML\u0026vst\u003d0') player.set_marquee() i = 0 while True: # 字幕每2秒刷新一条 time.sleep(2) player.update_text('我是字幕君 '+str(i)) i += 1
VLC的选项参数设置
我们在封装时,特意预留了选项参数的设置,上面添加字幕时,用到了'--sub-source=marq'
参数,实际上VLC
有非常多的参数,关于各种参数的详细介绍,可以查看 官方资料
如果看英文太累,这里还有一份 中文版参数详解。
if '__main__' == __name__: player = Player('--audio-visual=visual', '--effect-list=spectrum', '--effect-fft-window=flattop') player.play('https://api.mlwei.com/music/api/wy/?key=523077333&cache=1&type=url&id=566442496') while True: pass
--effect-list=<字符串>
当前可用的效果包括: dummy、scope、spectrum(频谱)、spectrometer(频谱仪)与vuMeter
--effect-fft-window=
可选的值{none,hann,flattop,blackmanharris,kaiser}
在Tkinter中嵌入视频
上面的测试代码都是在命令行执行的,虽然运行后启动了一个窗口渲染视频,但是我们无法进行暂停、快进、退出、设置音量等操作,这是因为我们没有写GUI程序,而tkinter
作为Python犀利的图形程序库,可以帮助我们快速构建一个界面程序。
完整示例代码如下
最后说一点,如果我们在创建Player
时,指定音频可视化参数,如下,则当播放音频时,self._canvas
中将显示音频可视化频谱。
player = Player('--audio-visual=visual', '--effect-list=spectrum', '--effect-fft-window=flattop')
跨平台
如果我们想用Python开发跨平台的播放器,在Linux系统中,不推荐集成VLC
二进制文件,我们可以有两种思路,Ubuntu中,我们可以通过调用命令在线安装vlc。
另一种思路则是集成VLC
源码,调用系统的编译命令进行编译。通常Linux平台都会带有gcc
编译器和make
构建工具。该方案同样适用于Mac os平台。