-
Notifications
You must be signed in to change notification settings - Fork 0
/
vlc.py
5579 lines (4919 loc) · 222 KB
/
vlc.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! /usr/bin/python
#
# Python ctypes bindings for VLC
# Copyright (C) 2009 the VideoLAN team
# $Id: $
#
# Authors: Olivier Aubert <olivier.aubert at liris.cnrs.fr>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
#
"""This module provides bindings for the
U{libvlc<http://wiki.videolan.org/ExternalAPI>} and
U{MediaControl<http://wiki.videolan.org/MediaControlAPI>} APIs.
You can find documentation at U{http://www.advene.org/download/python-ctypes/}.
Basically, the most important class is L{Instance}, which is used to
create a libvlc Instance. From this instance, you can then create
L{MediaPlayer} and L{MediaListPlayer} instances.
"""
import logging
import ctypes
import sys
build_date="Thu Jan 28 12:00:04 2010"
# Used for win32 and MacOS X
detected_plugin_path=None
if sys.platform == 'linux2':
dll=ctypes.CDLL('libvlc.so')
elif sys.platform == 'win32':
import ctypes.util
import os
detected_plugin_path=None
path=ctypes.util.find_library('libvlc.dll')
if path is None:
# Try to use registry settings
import _winreg
detected_plugin_path_found = None
subkey, name = 'Software\\VideoLAN\\VLC','InstallDir'
for hkey in _winreg.HKEY_LOCAL_MACHINE, _winreg.HKEY_CURRENT_USER:
try:
reg = _winreg.OpenKey(hkey, subkey)
detected_plugin_path_found, type_id = _winreg.QueryValueEx(reg, name)
_winreg.CloseKey(reg)
break
except _winreg.error:
pass
if detected_plugin_path_found:
detected_plugin_path = detected_plugin_path_found
else:
# Try a standard location.
p='c:\\Program Files\\VideoLAN\\VLC\\libvlc.dll'
if os.path.exists(p):
detected_plugin_path=os.path.dirname(p)
if detected_plugin_path is not None:
os.chdir(detected_plugin_path)
# If chdir failed, this will not work and raise an exception
path='libvlc.dll'
else:
detected_plugin_path=os.path.dirname(path)
dll=ctypes.CDLL(path)
elif sys.platform == 'darwin':
# FIXME: should find a means to configure path
d='/Applications/VLC.app'
import os
if os.path.exists(d):
dll=ctypes.CDLL(d+'/Contents/MacOS/lib/libvlc.2.dylib')
detected_plugin_path=d+'/Contents/MacOS/modules'
else:
# Hope some default path is set...
dll=ctypes.CDLL('libvlc.2.dylib')
#
# Generated enum types.
#
class EventType(ctypes.c_ulong):
""" libvlc_core
LibVLC Available Events
"""
_names={
1: 'MediaSubItemAdded',
2: 'MediaDurationChanged',
3: 'MediaPreparsedChanged',
4: 'MediaFreed',
5: 'MediaStateChanged',
6: 'MediaPlayerNothingSpecial',
7: 'MediaPlayerOpening',
8: 'MediaPlayerBuffering',
9: 'MediaPlayerPlaying',
10: 'MediaPlayerPaused',
11: 'MediaPlayerStopped',
12: 'MediaPlayerForward',
13: 'MediaPlayerBackward',
14: 'MediaPlayerEndReached',
15: 'MediaPlayerEncounteredError',
16: 'MediaPlayerTimeChanged',
17: 'MediaPlayerPositionChanged',
18: 'MediaPlayerSeekableChanged',
19: 'MediaPlayerPausableChanged',
20: 'MediaListItemAdded',
21: 'MediaListWillAddItem',
22: 'MediaListItemDeleted',
23: 'MediaListWillDeleteItem',
24: 'MediaListViewItemAdded',
25: 'MediaListViewWillAddItem',
26: 'MediaListViewItemDeleted',
27: 'MediaListViewWillDeleteItem',
28: 'MediaListPlayerPlayed',
29: 'MediaListPlayerNextItemSet',
30: 'MediaListPlayerStopped',
31: 'MediaDiscovererStarted',
32: 'MediaDiscovererEnded',
33: 'MediaPlayerTitleChanged',
34: 'MediaPlayerSnapshotTaken',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
EventType.MediaSubItemAdded=EventType(1)
EventType.MediaDurationChanged=EventType(2)
EventType.MediaPreparsedChanged=EventType(3)
EventType.MediaFreed=EventType(4)
EventType.MediaStateChanged=EventType(5)
EventType.MediaPlayerNothingSpecial=EventType(6)
EventType.MediaPlayerOpening=EventType(7)
EventType.MediaPlayerBuffering=EventType(8)
EventType.MediaPlayerPlaying=EventType(9)
EventType.MediaPlayerPaused=EventType(10)
EventType.MediaPlayerStopped=EventType(11)
EventType.MediaPlayerForward=EventType(12)
EventType.MediaPlayerBackward=EventType(13)
EventType.MediaPlayerEndReached=EventType(14)
EventType.MediaPlayerEncounteredError=EventType(15)
EventType.MediaPlayerTimeChanged=EventType(16)
EventType.MediaPlayerPositionChanged=EventType(17)
EventType.MediaPlayerSeekableChanged=EventType(18)
EventType.MediaPlayerPausableChanged=EventType(19)
EventType.MediaListItemAdded=EventType(20)
EventType.MediaListWillAddItem=EventType(21)
EventType.MediaListItemDeleted=EventType(22)
EventType.MediaListWillDeleteItem=EventType(23)
EventType.MediaListViewItemAdded=EventType(24)
EventType.MediaListViewWillAddItem=EventType(25)
EventType.MediaListViewItemDeleted=EventType(26)
EventType.MediaListViewWillDeleteItem=EventType(27)
EventType.MediaListPlayerPlayed=EventType(28)
EventType.MediaListPlayerNextItemSet=EventType(29)
EventType.MediaListPlayerStopped=EventType(30)
EventType.MediaDiscovererStarted=EventType(31)
EventType.MediaDiscovererEnded=EventType(32)
EventType.MediaPlayerTitleChanged=EventType(33)
EventType.MediaPlayerSnapshotTaken=EventType(34)
class Meta(ctypes.c_ulong):
""" libvlc_media
LibVLC Media Meta
"""
_names={
0: 'Title',
1: 'Artist',
2: 'Genre',
3: 'Copyright',
4: 'Album',
5: 'TrackNumber',
6: 'Description',
7: 'Rating',
8: 'Date',
9: 'Setting',
10: 'URL',
11: 'Language',
12: 'NowPlaying',
13: 'Publisher',
14: 'EncodedBy',
15: 'ArtworkURL',
16: 'TrackID',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
Meta.Title=Meta(0)
Meta.Artist=Meta(1)
Meta.Genre=Meta(2)
Meta.Copyright=Meta(3)
Meta.Album=Meta(4)
Meta.TrackNumber=Meta(5)
Meta.Description=Meta(6)
Meta.Rating=Meta(7)
Meta.Date=Meta(8)
Meta.Setting=Meta(9)
Meta.URL=Meta(10)
Meta.Language=Meta(11)
Meta.NowPlaying=Meta(12)
Meta.Publisher=Meta(13)
Meta.EncodedBy=Meta(14)
Meta.ArtworkURL=Meta(15)
Meta.TrackID=Meta(16)
class State(ctypes.c_ulong):
"""Note the order of libvlc_state_t enum must match exactly the order of
See mediacontrol_PlayerStatus, See input_state_e enums,
and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs).
Expected states by web plugins are:
IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4,
STOPPING=5, ENDED=6, ERROR=7
"""
_names={
0: 'NothingSpecial',
1: 'Opening',
2: 'Buffering',
3: 'Playing',
4: 'Paused',
5: 'Stopped',
6: 'Ended',
7: 'Error',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
State.NothingSpecial=State(0)
State.Opening=State(1)
State.Buffering=State(2)
State.Playing=State(3)
State.Paused=State(4)
State.Stopped=State(5)
State.Ended=State(6)
State.Error=State(7)
class AudioOutputDeviceTypes(ctypes.c_ulong):
"""Audio device types
"""
_names={
-1: 'Error',
1: 'Mono',
2: 'Stereo',
4: '_2F2R',
5: '_3F2R',
6: '_5_1',
7: '_6_1',
8: '_7_1',
10: 'SPDIF',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
AudioOutputDeviceTypes.Error=AudioOutputDeviceTypes(-1)
AudioOutputDeviceTypes.Mono=AudioOutputDeviceTypes(1)
AudioOutputDeviceTypes.Stereo=AudioOutputDeviceTypes(2)
AudioOutputDeviceTypes._2F2R=AudioOutputDeviceTypes(4)
AudioOutputDeviceTypes._3F2R=AudioOutputDeviceTypes(5)
AudioOutputDeviceTypes._5_1=AudioOutputDeviceTypes(6)
AudioOutputDeviceTypes._6_1=AudioOutputDeviceTypes(7)
AudioOutputDeviceTypes._7_1=AudioOutputDeviceTypes(8)
AudioOutputDeviceTypes.SPDIF=AudioOutputDeviceTypes(10)
class AudioOutputChannel(ctypes.c_ulong):
"""Audio channels
"""
_names={
-1: 'Error',
1: 'Stereo',
2: 'RStereo',
3: 'Left',
4: 'Right',
5: 'Dolbys',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
AudioOutputChannel.Error=AudioOutputChannel(-1)
AudioOutputChannel.Stereo=AudioOutputChannel(1)
AudioOutputChannel.RStereo=AudioOutputChannel(2)
AudioOutputChannel.Left=AudioOutputChannel(3)
AudioOutputChannel.Right=AudioOutputChannel(4)
AudioOutputChannel.Dolbys=AudioOutputChannel(5)
class PositionOrigin(ctypes.c_ulong):
"""A position may have different origins:
- absolute counts from the movie start
- relative counts from the current position
- modulo counts from the current position and wraps at the end of the movie
"""
_names={
0: 'AbsolutePosition',
1: 'RelativePosition',
2: 'ModuloPosition',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
PositionOrigin.AbsolutePosition=PositionOrigin(0)
PositionOrigin.RelativePosition=PositionOrigin(1)
PositionOrigin.ModuloPosition=PositionOrigin(2)
class PositionKey(ctypes.c_ulong):
"""Units available in mediacontrol Positions
- ByteCount number of bytes
- SampleCount number of frames
- MediaTime time in milliseconds
"""
_names={
0: 'ByteCount',
1: 'SampleCount',
2: 'MediaTime',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
PositionKey.ByteCount=PositionKey(0)
PositionKey.SampleCount=PositionKey(1)
PositionKey.MediaTime=PositionKey(2)
class PlayerStatus(ctypes.c_ulong):
"""Possible player status
Note the order of these enums must match exactly the order of
libvlc_state_t and input_state_e enums.
"""
_names={
0: 'UndefinedStatus',
1: 'InitStatus',
2: 'BufferingStatus',
3: 'PlayingStatus',
4: 'PauseStatus',
5: 'StopStatus',
6: 'EndStatus',
7: 'ErrorStatus',
}
def __repr__(self):
return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
def __eq__(self, other):
return ( (isinstance(other, ctypes.c_ulong) and self.value == other.value)
or (isinstance(other, (int, long)) and self.value == other ) )
def __ne__(self, other):
return not self.__eq__(other)
PlayerStatus.UndefinedStatus=PlayerStatus(0)
PlayerStatus.InitStatus=PlayerStatus(1)
PlayerStatus.BufferingStatus=PlayerStatus(2)
PlayerStatus.PlayingStatus=PlayerStatus(3)
PlayerStatus.PauseStatus=PlayerStatus(4)
PlayerStatus.StopStatus=PlayerStatus(5)
PlayerStatus.EndStatus=PlayerStatus(6)
PlayerStatus.ErrorStatus=PlayerStatus(7)
#
# End of generated enum types.
#
class ListPOINTER(object):
'''Just like a POINTER but accept a list of ctype as an argument.
'''
def __init__(self, etype):
self.etype = etype
def from_param(self, param):
if isinstance(param, (list, tuple)):
return (self.etype * len(param))(*param)
class LibVLCException(Exception):
"""Python exception raised by libvlc methods.
"""
pass
# From libvlc_structures.h
# This is version-dependent, depending on the presence of libvlc_errmsg
if hasattr(dll, 'libvlc_errmsg'):
# New-style message passing
class VLCException(ctypes.Structure):
"""libvlc exception.
"""
_fields_= [
('raised', ctypes.c_int),
]
@property
def message(self):
return dll.libvlc_errmsg()
def init(self):
libvlc_exception_init(self)
def clear(self):
libvlc_exception_clear(self)
else:
# Old-style exceptions
class VLCException(ctypes.Structure):
"""libvlc exception.
"""
_fields_= [
('raised', ctypes.c_int),
('code', ctypes.c_int),
('message', ctypes.c_char_p),
]
def init(self):
libvlc_exception_init(self)
def clear(self):
libvlc_exception_clear(self)
class MediaStats(ctypes.Structure):
_fields_= [
('read_bytes', ctypes.c_int ),
('input_bitrate', ctypes.c_float),
('demux_read_bytes', ctypes.c_int ),
('demux_bitrate', ctypes.c_float),
('demux_corrupted', ctypes.c_int ),
('demux_discontinuity', ctypes.c_int ),
('decoded_video', ctypes.c_int ),
('decoded_audio', ctypes.c_int ),
('displayed_pictures', ctypes.c_int ),
('lost_pictures', ctypes.c_int ),
('played_abuffers', ctypes.c_int ),
('lost_abuffers', ctypes.c_int ),
('sent_packets', ctypes.c_int ),
('sent_bytes', ctypes.c_int ),
('send_bitrate', ctypes.c_float),
]
def __str__(self):
return "MediaStats\n%s" % "\n".join( "%s:\t%s" % (n, getattr(self, n)) for n in self._fields_ )
if 'EsType' in dir():
class MediaES(ctypes.Structure):
_fields_= [
('codec' , ctypes.c_uint32),
('id' , ctypes.c_int),
('type' , EsType),
('profile' , ctypes.c_int),
('level' , ctypes.c_int),
('channels', ctypes.c_uint),
('rate' , ctypes.c_uint),
('height' , ctypes.c_uint),
('width' , ctypes.c_uint),
]
def __str__(self):
return "MediaES \n%s" % "\n".join( "%s:\t%s" % (n, getattr(self, n)) for n in self._fields_ )
class PlaylistItem(ctypes.Structure):
_fields_= [
('id', ctypes.c_int),
('uri', ctypes.c_char_p),
('name', ctypes.c_char_p),
]
def __str__(self):
return "PlaylistItem #%d %s (%uri)" % (self.id, self.name, self.uri)
class LogMessage(ctypes.Structure):
_fields_= [
('size', ctypes.c_uint),
('severity', ctypes.c_int),
('type', ctypes.c_char_p),
('name', ctypes.c_char_p),
('header', ctypes.c_char_p),
('message', ctypes.c_char_p),
]
def __init__(self):
super(LogMessage, self).__init__()
self.size=ctypes.sizeof(self)
def __str__(self):
return "vlc.LogMessage(%d:%s): %s" % (self.severity, self.type, self.message)
class MediaControlPosition(ctypes.Structure):
_fields_= [
('origin', PositionOrigin),
('key', PositionKey),
('value', ctypes.c_longlong),
]
def __init__(self, value=0, origin=None, key=None):
# We override the __init__ method so that instanciating the
# class with an int as parameter will create the appropriate
# default position (absolute position, media time, with the
# int as value).
super(MediaControlPosition, self).__init__()
self.value=value
if origin is None:
origin=PositionOrigin.AbsolutePosition
if key is None:
key=PositionKey.MediaTime
self.origin=origin
self.key=key
def __str__(self):
return "MediaControlPosition %ld (%s, %s)" % (
self.value,
str(self.origin),
str(self.key)
)
@staticmethod
def from_param(arg):
if isinstance(arg, (int, long)):
return MediaControlPosition(arg)
else:
return arg
class MediaControlException(ctypes.Structure):
_fields_= [
('code', ctypes.c_int),
('message', ctypes.c_char_p),
]
def init(self):
mediacontrol_exception_init(self)
def clear(self):
mediacontrol_exception_free(self)
class MediaControlStreamInformation(ctypes.Structure):
_fields_= [
('status', PlayerStatus),
('url', ctypes.c_char_p),
('position', ctypes.c_longlong),
('length', ctypes.c_longlong),
]
def __str__(self):
return "%s (%s) : %ld / %ld" % (self.url or "<No defined URL>",
str(self.status),
self.position,
self.length)
class RGBPicture(ctypes.Structure):
_fields_= [
('width', ctypes.c_int),
('height', ctypes.c_int),
('type', ctypes.c_uint32),
('date', ctypes.c_ulonglong),
('size', ctypes.c_int),
('data_pointer', ctypes.c_void_p),
]
@property
def data(self):
return ctypes.string_at(self.data_pointer, self.size)
def __str__(self):
return "RGBPicture (%d, %d) - %ld ms - %d bytes" % (self.width, self.height, self.date, self.size)
def free(self):
mediacontrol_RGBPicture__free(self)
def check_vlc_exception(result, func, args):
"""Error checking method for functions using an exception in/out parameter.
"""
ex=args[-1]
if not isinstance(ex, (VLCException, MediaControlException)):
logging.warn("python-vlc: error when processing function %s. Please report this as a bug to vlc-devel@videolan.org" % str(func))
return result
# Take into account both VLCException and MediacontrolException:
c=getattr(ex, 'raised', getattr(ex, 'code', 0))
if c:
raise LibVLCException(ex.message)
return result
### End of header.py ###
class AudioOutput(object):
def __new__(cls, pointer=None):
'''Internal method used for instanciating wrappers from ctypes.
'''
if pointer is None:
raise Exception("Internal method. Surely this class cannot be instanciated by itself.")
if pointer == 0:
return None
else:
o=object.__new__(cls)
o._as_parameter_=ctypes.c_void_p(pointer)
return o
@staticmethod
def from_param(arg):
'''(INTERNAL) ctypes parameter conversion method.
'''
return arg._as_parameter_
if hasattr(dll, 'libvlc_audio_output_list_release'):
def list_release(self):
"""Free the list of available audio outputs
"""
return libvlc_audio_output_list_release(self)
class EventManager(object):
def __new__(cls, pointer=None):
'''Internal method used for instanciating wrappers from ctypes.
'''
if pointer is None:
raise Exception("Internal method. Surely this class cannot be instanciated by itself.")
if pointer == 0:
return None
else:
o=object.__new__(cls)
o._as_parameter_=ctypes.c_void_p(pointer)
return o
@staticmethod
def from_param(arg):
'''(INTERNAL) ctypes parameter conversion method.
'''
return arg._as_parameter_
if hasattr(dll, 'libvlc_event_attach'):
def event_attach(self, i_event_type, f_callback, user_data):
"""Register for an event notification.
@param i_event_type: the desired event to which we want to listen
@param f_callback: the function to call when i_event_type occurs
@param user_data: user provided data to carry with the event
"""
e=VLCException()
return libvlc_event_attach(self, i_event_type, f_callback, user_data, e)
if hasattr(dll, 'libvlc_event_detach'):
def event_detach(self, i_event_type, f_callback, p_user_data):
"""Unregister an event notification.
@param i_event_type: the desired event to which we want to unregister
@param f_callback: the function to call when i_event_type occurs
@param p_user_data: user provided data to carry with the event
"""
e=VLCException()
return libvlc_event_detach(self, i_event_type, f_callback, p_user_data, e)
class Instance(object):
"""Create a new Instance instance.
It may take as parameter either:
- a string
- a list of strings as first parameters
- the parameters given as the constructor parameters (must be strings)
- a MediaControl instance
"""
@staticmethod
def from_param(arg):
'''(INTERNAL) ctypes parameter conversion method.
'''
return arg._as_parameter_
def __new__(cls, *p):
if p and p[0] == 0:
return None
elif p and isinstance(p[0], (int, long)):
# instance creation from ctypes
o=object.__new__(cls)
o._as_parameter_=ctypes.c_void_p(p[0])
return o
elif len(p) == 1 and isinstance(p[0], basestring):
# Only 1 string parameter: should be a parameter line
p=p[0].split(' ')
elif len(p) == 1 and isinstance(p[0], (tuple, list)):
p=p[0]
if p and isinstance(p[0], MediaControl):
return p[0].get_instance()
else:
if not p and detected_plugin_path is not None:
# No parameters passed. Under win32 and MacOS, specify
# the detected_plugin_path if present.
p=[ 'vlc', '--plugin-path='+ detected_plugin_path ]
e=VLCException()
return libvlc_new(len(p), p, e)
def media_player_new(self, uri=None):
"""Create a new Media Player object.
@param uri: an optional URI to play in the player.
"""
e=VLCException()
p=libvlc_media_player_new(self, e)
if uri:
p.set_media(self.media_new(uri))
p._instance=self
return p
def media_list_player_new(self):
"""Create an empty Media Player object
"""
e=VLCException()
p=libvlc_media_list_player_new(self, e)
p._instance=self
return p
def media_new(self, mrl, *options):
"""Create an empty Media Player object
Options can be specified as supplementary string parameters, e.g.
m=i.media_new('foo.avi', 'sub-filter=marq{marquee=Hello}', 'vout-filter=invert')
"""
e=VLCException()
m=libvlc_media_new(self, mrl, e)
for o in options:
libvlc_media_add_option(m, o, e)
return m
if hasattr(dll, 'libvlc_get_vlc_id'):
def get_vlc_id(self):
"""Return a libvlc instance identifier for legacy APIs. Use of this
function is discouraged, you should convert your program to use the
new API.
@return: the instance identifier
"""
return libvlc_get_vlc_id(self)
if hasattr(dll, 'libvlc_release'):
def release(self):
"""Decrement the reference count of a libvlc instance, and destroy it
if it reaches zero.
"""
return libvlc_release(self)
if hasattr(dll, 'libvlc_retain'):
def retain(self):
"""Increments the reference count of a libvlc instance.
The initial reference count is 1 after libvlc_new() returns.
"""
return libvlc_retain(self)
if hasattr(dll, 'libvlc_add_intf'):
def add_intf(self, name):
"""Try to start a user interface for the libvlc instance.
@param name: interface name, or NULL for default
"""
e=VLCException()
return libvlc_add_intf(self, name, e)
if hasattr(dll, 'libvlc_wait'):
def wait(self):
"""Waits until an interface causes the instance to exit.
You should start at least one interface first, using libvlc_add_intf().
"""
return libvlc_wait(self)
if hasattr(dll, 'libvlc_get_log_verbosity'):
def get_log_verbosity(self):
"""Return the VLC messaging verbosity level.
@return: verbosity level for messages
"""
e=VLCException()
return libvlc_get_log_verbosity(self, e)
if hasattr(dll, 'libvlc_set_log_verbosity'):
def set_log_verbosity(self, level):
"""Set the VLC messaging verbosity level.
@param level: log level
"""
e=VLCException()
return libvlc_set_log_verbosity(self, level, e)
if hasattr(dll, 'libvlc_log_open'):
def log_open(self):
"""Open a VLC message log instance.
@return: log message instance
"""
e=VLCException()
return libvlc_log_open(self, e)
if hasattr(dll, 'libvlc_media_new_as_node'):
def media_new_as_node(self, psz_name):
"""Create a media as an empty node with the passed name.
@param psz_name: the name of the node
@return: the new empty media
"""
e=VLCException()
return libvlc_media_new_as_node(self, psz_name, e)
if hasattr(dll, 'libvlc_media_discoverer_new_from_name'):
def media_discoverer_new_from_name(self, psz_name):
"""Discover media service by name.
@param psz_name: service name
@return: media discover object
"""
e=VLCException()
return libvlc_media_discoverer_new_from_name(self, psz_name, e)
if hasattr(dll, 'libvlc_media_library_new'):
def media_library_new(self):
"""\ingroup libvlc
LibVLC Media Library
"""
e=VLCException()
return libvlc_media_library_new(self, e)
if hasattr(dll, 'libvlc_media_list_new'):
def media_list_new(self):
"""Create an empty media list.
@return: empty media list
"""
e=VLCException()
return libvlc_media_list_new(self, e)
if hasattr(dll, 'libvlc_audio_output_list_get'):
def audio_output_list_get(self):
"""Get the list of available audio outputs
@return: list of available audio outputs, at the end free it with
"""
e=VLCException()
return libvlc_audio_output_list_get(self, e)
if hasattr(dll, 'libvlc_audio_output_set'):
def audio_output_set(self, psz_name):
"""Set the audio output.
Change will be applied after stop and play.
@return: true if function succeded
"""
return libvlc_audio_output_set(self, psz_name)
if hasattr(dll, 'libvlc_audio_output_device_count'):
def audio_output_device_count(self, psz_audio_output):
"""Get count of devices for audio output, these devices are hardware oriented
like analor or digital output of sound card
@return: number of devices
"""
return libvlc_audio_output_device_count(self, psz_audio_output)
if hasattr(dll, 'libvlc_audio_output_device_longname'):
def audio_output_device_longname(self, psz_audio_output, i_device):
"""Get long name of device, if not available short name given
@param psz_audio_output: - name of audio output, \see libvlc_audio_output_t
@return: long name of device
"""
return libvlc_audio_output_device_longname(self, psz_audio_output, i_device)
if hasattr(dll, 'libvlc_audio_output_device_id'):
def audio_output_device_id(self, psz_audio_output, i_device):
"""Get id name of device
@param psz_audio_output: - name of audio output, \see libvlc_audio_output_t
@return: id name of device, use for setting device, need to be free after use
"""
return libvlc_audio_output_device_id(self, psz_audio_output, i_device)
if hasattr(dll, 'libvlc_audio_output_device_set'):
def audio_output_device_set(self, psz_audio_output, psz_device_id):
"""Set device for using
@param psz_audio_output: - name of audio output, \see libvlc_audio_output_t
"""
return libvlc_audio_output_device_set(self, psz_audio_output, psz_device_id)
if hasattr(dll, 'libvlc_audio_output_get_device_type'):
def audio_output_get_device_type(self):
"""Get current audio device type. Device type describes something like
character of output sound - stereo sound, 2.1, 5.1 etc
@return: the audio devices type \see libvlc_audio_output_device_types_t
"""
e=VLCException()
return libvlc_audio_output_get_device_type(self, e)
if hasattr(dll, 'libvlc_audio_output_set_device_type'):
def audio_output_set_device_type(self, device_type):
"""Set current audio device type.
@param device_type: the audio device type,
"""
e=VLCException()
return libvlc_audio_output_set_device_type(self, device_type, e)
if hasattr(dll, 'libvlc_audio_toggle_mute'):
def audio_toggle_mute(self):
"""Toggle mute status.
"""
e=VLCException()
return libvlc_audio_toggle_mute(self, e)
if hasattr(dll, 'libvlc_audio_get_mute'):
def audio_get_mute(self):
"""Get current mute status.
@return: the mute status (boolean)
"""
e=VLCException()
return libvlc_audio_get_mute(self, e)
if hasattr(dll, 'libvlc_audio_set_mute'):
def audio_set_mute(self, status):
"""Set mute status.
@param status: If status is true then mute, otherwise unmute
"""
e=VLCException()
return libvlc_audio_set_mute(self, status, e)
if hasattr(dll, 'libvlc_audio_get_volume'):
def audio_get_volume(self):
"""Get current audio level.
@return: the audio level (int)
"""
e=VLCException()
return libvlc_audio_get_volume(self, e)
if hasattr(dll, 'libvlc_audio_set_volume'):
def audio_set_volume(self, i_volume):
"""Set current audio level.
@param i_volume: the volume (int)
"""
e=VLCException()
return libvlc_audio_set_volume(self, i_volume, e)
if hasattr(dll, 'libvlc_audio_get_channel'):
def audio_get_channel(self):
"""Get current audio channel.
@return: the audio channel \see libvlc_audio_output_channel_t
"""
e=VLCException()
return libvlc_audio_get_channel(self, e)
if hasattr(dll, 'libvlc_audio_set_channel'):