python: release 3.0.6109
[vlc/bindings/python.git] / generated / 3.0 / examples / pyqt5vlc.py
1 """
2 A simple example for VLC python bindings using PyQt5.
3
4 Author: Saveliy Yusufov, Columbia University, sy2685@columbia.edu
5 Date: 25 December 2018
6 """
7
8 import platform
9 import os
10 import sys
11
12 from PyQt5 import QtWidgets, QtGui, QtCore
13 import vlc
14
15 class Player(QtWidgets.QMainWindow):
16     """A simple Media Player using VLC and Qt
17     """
18
19     def __init__(self, master=None):
20         QtWidgets.QMainWindow.__init__(self, master)
21         self.setWindowTitle("Media Player")
22
23         # Create a basic vlc instance
24         self.instance = vlc.Instance()
25
26         self.media = None
27
28         # Create an empty vlc media player
29         self.mediaplayer = self.instance.media_player_new()
30
31         self.create_ui()
32         self.is_paused = False
33
34     def create_ui(self):
35         """Set up the user interface, signals & slots
36         """
37         self.widget = QtWidgets.QWidget(self)
38         self.setCentralWidget(self.widget)
39
40         # In this widget, the video will be drawn
41         if platform.system() == "Darwin": # for MacOS
42             self.videoframe = QtWidgets.QMacCocoaViewContainer(0)
43         else:
44             self.videoframe = QtWidgets.QFrame()
45
46         self.palette = self.videoframe.palette()
47         self.palette.setColor(QtGui.QPalette.Window, QtGui.QColor(0, 0, 0))
48         self.videoframe.setPalette(self.palette)
49         self.videoframe.setAutoFillBackground(True)
50
51         self.positionslider = QtWidgets.QSlider(QtCore.Qt.Horizontal, self)
52         self.positionslider.setToolTip("Position")
53         self.positionslider.setMaximum(1000)
54         self.positionslider.sliderMoved.connect(self.set_position)
55         self.positionslider.sliderPressed.connect(self.set_position)
56
57         self.hbuttonbox = QtWidgets.QHBoxLayout()
58         self.playbutton = QtWidgets.QPushButton("Play")
59         self.hbuttonbox.addWidget(self.playbutton)
60         self.playbutton.clicked.connect(self.play_pause)
61
62         self.stopbutton = QtWidgets.QPushButton("Stop")
63         self.hbuttonbox.addWidget(self.stopbutton)
64         self.stopbutton.clicked.connect(self.stop)
65
66         self.hbuttonbox.addStretch(1)
67         self.volumeslider = QtWidgets.QSlider(QtCore.Qt.Horizontal, self)
68         self.volumeslider.setMaximum(100)
69         self.volumeslider.setValue(self.mediaplayer.audio_get_volume())
70         self.volumeslider.setToolTip("Volume")
71         self.hbuttonbox.addWidget(self.volumeslider)
72         self.volumeslider.valueChanged.connect(self.set_volume)
73
74         self.vboxlayout = QtWidgets.QVBoxLayout()
75         self.vboxlayout.addWidget(self.videoframe)
76         self.vboxlayout.addWidget(self.positionslider)
77         self.vboxlayout.addLayout(self.hbuttonbox)
78
79         self.widget.setLayout(self.vboxlayout)
80
81         menu_bar = self.menuBar()
82
83         # File menu
84         file_menu = menu_bar.addMenu("File")
85
86         # Add actions to file menu
87         open_action = QtWidgets.QAction("Load Video", self)
88         close_action = QtWidgets.QAction("Close App", self)
89         file_menu.addAction(open_action)
90         file_menu.addAction(close_action)
91
92         open_action.triggered.connect(self.open_file)
93         close_action.triggered.connect(sys.exit)
94
95         self.timer = QtCore.QTimer(self)
96         self.timer.setInterval(100)
97         self.timer.timeout.connect(self.update_ui)
98
99     def play_pause(self):
100         """Toggle play/pause status
101         """
102         if self.mediaplayer.is_playing():
103             self.mediaplayer.pause()
104             self.playbutton.setText("Play")
105             self.is_paused = True
106             self.timer.stop()
107         else:
108             if self.mediaplayer.play() == -1:
109                 self.open_file()
110                 return
111
112             self.mediaplayer.play()
113             self.playbutton.setText("Pause")
114             self.timer.start()
115             self.is_paused = False
116
117     def stop(self):
118         """Stop player
119         """
120         self.mediaplayer.stop()
121         self.playbutton.setText("Play")
122
123     def open_file(self):
124         """Open a media file in a MediaPlayer
125         """
126
127         dialog_txt = "Choose Media File"
128         filename = QtWidgets.QFileDialog.getOpenFileName(self, dialog_txt, os.path.expanduser('~'))
129         if not filename:
130             return
131
132         # getOpenFileName returns a tuple, so use only the actual file name
133         self.media = self.instance.media_new(filename[0])
134
135         # Put the media in the media player
136         self.mediaplayer.set_media(self.media)
137
138         # Parse the metadata of the file
139         self.media.parse()
140
141         # Set the title of the track as window title
142         self.setWindowTitle(self.media.get_meta(0))
143
144         # The media player has to be 'connected' to the QFrame (otherwise the
145         # video would be displayed in it's own window). This is platform
146         # specific, so we must give the ID of the QFrame (or similar object) to
147         # vlc. Different platforms have different functions for this
148         if platform.system() == "Linux": # for Linux using the X Server
149             self.mediaplayer.set_xwindow(int(self.videoframe.winId()))
150         elif platform.system() == "Windows": # for Windows
151             self.mediaplayer.set_hwnd(int(self.videoframe.winId()))
152         elif platform.system() == "Darwin": # for MacOS
153             self.mediaplayer.set_nsobject(int(self.videoframe.winId()))
154
155         self.play_pause()
156
157     def set_volume(self, volume):
158         """Set the volume
159         """
160         self.mediaplayer.audio_set_volume(volume)
161
162     def set_position(self):
163         """Set the movie position according to the position slider.
164         """
165
166         # The vlc MediaPlayer needs a float value between 0 and 1, Qt uses
167         # integer variables, so you need a factor; the higher the factor, the
168         # more precise are the results (1000 should suffice).
169
170         # Set the media position to where the slider was dragged
171         self.timer.stop()
172         pos = self.positionslider.value()
173         self.mediaplayer.set_position(pos / 1000.0)
174         self.timer.start()
175
176     def update_ui(self):
177         """Updates the user interface"""
178
179         # Set the slider's position to its corresponding media position
180         # Note that the setValue function only takes values of type int,
181         # so we must first convert the corresponding media position.
182         media_pos = int(self.mediaplayer.get_position() * 1000)
183         self.positionslider.setValue(media_pos)
184
185         # No need to call this function if nothing is played
186         if not self.mediaplayer.is_playing():
187             self.timer.stop()
188
189             # After the video finished, the play button stills shows "Pause",
190             # which is not the desired behavior of a media player.
191             # This fixes that "bug".
192             if not self.is_paused:
193                 self.stop()
194
195 def main():
196     """Entry point for our simple vlc player
197     """
198     app = QtWidgets.QApplication(sys.argv)
199     player = Player()
200     player.show()
201     player.resize(640, 480)
202     sys.exit(app.exec_())
203
204 if __name__ == "__main__":
205     main()