/
dbus.c
1378 lines (1151 loc) · 45.3 KB
/
dbus.c
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
/*****************************************************************************
* dbus.c : D-Bus control interface
*****************************************************************************
* Copyright © 2006-2008 Rafaël Carré
* Copyright © 2007-2012 Mirsal Ennaime
* Copyright © 2009-2012 The VideoLAN team
* Copyright © 2013 Alex Merry
*
* Authors: Rafaël Carré <funman at videolanorg>
* Mirsal Ennaime <mirsal at mirsal fr>
* Alex Merry <dev at randomguy3 me uk>
*
* 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.
*****************************************************************************/
/*
* D-Bus Specification:
* http://dbus.freedesktop.org/doc/dbus-specification.html
* D-Bus low-level C API (libdbus)
* http://dbus.freedesktop.org/doc/dbus/api/html/index.html
* extract:
* "If you use this low-level API directly, you're signing up for some pain."
*
* MPRIS Specification version 1.0
* http://wiki.xmms2.xmms.se/index.php/MPRIS
*/
/*****************************************************************************
* Preamble
*****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <dbus/dbus.h>
#include "dbus_common.h"
#include "dbus_root.h"
#include "dbus_player.h"
#include "dbus_tracklist.h"
#include "dbus_introspect.h"
#define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_interface.h>
#include <vlc_meta.h>
#include <vlc_tick.h>
#include <vlc_fs.h>
#include <assert.h>
#include <limits.h>
#include <string.h>
#include <poll.h>
#include <errno.h>
#include <unistd.h>
#define DBUS_MPRIS_BUS_NAME "org.mpris.MediaPlayer2.vlc"
#define DBUS_INSTANCE_ID_PREFIX "instance"
#define SEEK_THRESHOLD 1000 /* µsec */
#define EVENTS_DELAY INT64_C(100000) /* 100 ms */
/*****************************************************************************
* Local prototypes.
*****************************************************************************/
static DBusHandlerResult
MPRISEntryPoint ( DBusConnection *p_conn, DBusMessage *p_from, void *p_this );
static const DBusObjectPathVTable dbus_mpris_vtable = {
NULL, MPRISEntryPoint, /* handler function */
NULL, NULL, NULL, NULL
};
typedef struct
{
int signal;
} callback_info_t;
enum
{
PIPE_OUT = 0,
PIPE_IN = 1
};
static int Open ( vlc_object_t * );
static void Close ( vlc_object_t * );
static void *Run ( void * );
static int TrackChange( intf_thread_t * );
static dbus_bool_t add_timeout(DBusTimeout *, void *);
static void remove_timeout(DBusTimeout *, void *);
static void toggle_timeout(DBusTimeout *, void *);
static dbus_bool_t add_watch ( DBusWatch *p_watch, void *p_data );
static void remove_watch ( DBusWatch *p_watch, void *p_data );
static void watch_toggled ( DBusWatch *p_watch, void *p_data );
static void wakeup_main_loop( void *p_data );
static void ProcessEvents ( intf_thread_t *p_intf,
callback_info_t **p_events,
int i_events );
static void ProcessWatches ( intf_thread_t *p_intf,
DBusWatch **p_watches,
int i_watches,
struct pollfd *p_fds,
int i_fds );
static void DispatchDBusMessages( intf_thread_t *p_intf );
static void playlist_on_items_added(vlc_playlist_t *,
size_t, vlc_playlist_item_t *const [],
size_t, void *);
static void playlist_on_items_removed(vlc_playlist_t *,
size_t, size_t, void *);
static void playlist_on_playback_repeat_changed(vlc_playlist_t *,
enum vlc_playlist_playback_repeat,
void *);
static void playlist_on_playback_order_changed(vlc_playlist_t *,
enum vlc_playlist_playback_order,
void *);
static void playlist_on_current_index_changed(vlc_playlist_t *,
ssize_t, void *);
static void player_on_state_changed(vlc_player_t *,
enum vlc_player_state, void *);
static void player_on_error_changed(vlc_player_t *,
enum vlc_player_error, void *);
static void player_on_rate_changed(vlc_player_t *, float, void *);
static void player_on_capabilities_changed(vlc_player_t *, int, int, void *);
static void player_on_position_changed(vlc_player_t *,
vlc_tick_t, float, void *);
static void player_on_media_meta_changed(vlc_player_t *,
input_item_t *, void *);
static void player_aout_on_volume_changed(audio_output_t *, float, void *);
static void player_aout_on_mute_changed(audio_output_t *, bool, void *);
static void player_vout_on_fullscreen_changed(vout_thread_t *, bool, void *);
/*****************************************************************************
* Module descriptor
*****************************************************************************/
vlc_module_begin ()
set_shortname( N_("DBus"))
set_category( CAT_INTERFACE )
set_description( N_("D-Bus control interface") )
set_capability( "interface", 0 )
set_callbacks( Open, Close )
vlc_module_end ()
/*****************************************************************************
* Open: initialize interface
*****************************************************************************/
static int Open( vlc_object_t *p_this )
{
intf_thread_t *p_intf = (intf_thread_t*)p_this;
vlc_object_t *vlc = VLC_OBJECT(vlc_object_instance(p_this));
vlc_playlist_t *playlist = NULL;
/* initialisation of the connection */
if( !dbus_threads_init_default() )
return VLC_EGENERIC;
intf_sys_t *p_sys = calloc( 1, sizeof( intf_sys_t ) );
if( unlikely(!p_sys) )
return VLC_ENOMEM;
DBusConnection *p_conn;
p_sys->i_player_caps = PLAYER_CAPS_NONE;
p_sys->i_playing_state = PLAYBACK_STATE_INVALID;
if( vlc_pipe( p_sys->p_pipe_fds ) )
{
free( p_sys );
msg_Err( p_intf, "Could not create pipe" );
return VLC_EGENERIC;
}
DBusError error;
dbus_error_init( &error );
/* connect privately to the session bus
* the connection will not be shared with other vlc modules which use dbus,
* thus avoiding a whole class of concurrency issues */
p_conn = dbus_bus_get_private( DBUS_BUS_SESSION, &error );
if( !p_conn )
{
msg_Err( p_this, "Failed to connect to the D-Bus session daemon: %s",
error.message );
dbus_error_free( &error );
goto dbus_connection_failure;
}
dbus_connection_set_exit_on_disconnect( p_conn, FALSE );
/* Register the entry point object path */
dbus_connection_register_object_path( p_conn, DBUS_MPRIS_OBJECT_PATH,
&dbus_mpris_vtable, p_this );
/* Try to register org.mpris.MediaPlayer2.vlc */
const unsigned bus_flags = DBUS_NAME_FLAG_DO_NOT_QUEUE;
var_Create(vlc, "dbus-mpris-name", VLC_VAR_STRING);
if( dbus_bus_request_name( p_conn, DBUS_MPRIS_BUS_NAME, bus_flags, NULL )
!= DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER )
{
/* Register an instance-specific well known name of the form
* org.mpris.MediaPlayer2.vlc.instanceXXXX where XXXX is the
* current Process ID */
char unique_service[sizeof( DBUS_MPRIS_BUS_NAME ) +
sizeof( DBUS_INSTANCE_ID_PREFIX ) + 10];
snprintf( unique_service, sizeof (unique_service),
DBUS_MPRIS_BUS_NAME"."DBUS_INSTANCE_ID_PREFIX"%"PRIu32,
(uint32_t)getpid() );
if( dbus_bus_request_name( p_conn, unique_service, bus_flags, NULL )
== DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER )
{
msg_Dbg( p_intf, "listening on dbus as: %s", unique_service );
var_SetString(vlc, "dbus-mpris-name", unique_service);
}
}
else
{
msg_Dbg( p_intf, "listening on dbus as: %s", DBUS_MPRIS_BUS_NAME );
var_SetString(vlc, "dbus-mpris-name", DBUS_MPRIS_BUS_NAME);
}
dbus_connection_flush( p_conn );
p_intf->p_sys = p_sys;
p_sys->p_conn = p_conn;
vlc_array_init( &p_sys->events );
vlc_array_init( &p_sys->timeouts );
vlc_array_init( &p_sys->watches );
vlc_mutex_init( &p_sys->lock );
p_sys->playlist = playlist = vlc_intf_GetMainPlaylist(p_intf);
vlc_player_t *player = vlc_playlist_GetPlayer(playlist);
vlc_playlist_Lock(playlist);
static struct vlc_playlist_callbacks const playlist_cbs =
{
.on_items_added = playlist_on_items_added,
.on_items_removed = playlist_on_items_removed,
.on_playback_repeat_changed = playlist_on_playback_repeat_changed,
.on_playback_order_changed = playlist_on_playback_order_changed,
.on_current_index_changed = playlist_on_current_index_changed,
};
p_sys->playlist_listener =
vlc_playlist_AddListener(playlist, &playlist_cbs, p_intf, false);
if (!p_sys->playlist_listener)
goto playlist_listener_failure;
static struct vlc_player_cbs const player_cbs =
{
.on_state_changed = player_on_state_changed,
.on_error_changed = player_on_error_changed,
.on_rate_changed = player_on_rate_changed,
.on_capabilities_changed = player_on_capabilities_changed,
.on_position_changed = player_on_position_changed,
.on_media_meta_changed = player_on_media_meta_changed,
};
p_sys->player_listener =
vlc_player_AddListener(player, &player_cbs, p_intf);
if (!p_sys->player_listener)
goto player_listener_failure;
static struct vlc_player_aout_cbs const player_aout_cbs =
{
.on_volume_changed = player_aout_on_volume_changed,
.on_mute_changed = player_aout_on_mute_changed
};
p_sys->player_aout_listener =
vlc_player_aout_AddListener(player, &player_aout_cbs, p_intf);
if (!p_sys->player_aout_listener)
goto player_aout_listener_failure;
static struct vlc_player_vout_cbs const player_vout_cbs =
{
.on_fullscreen_changed = player_vout_on_fullscreen_changed,
};
p_sys->player_vout_listener =
vlc_player_vout_AddListener(player, &player_vout_cbs, p_intf);
if (!p_sys->player_vout_listener)
goto player_vout_listener_failure;
vlc_playlist_Unlock(playlist);
if( !dbus_connection_set_timeout_functions( p_conn,
add_timeout,
remove_timeout,
toggle_timeout,
p_intf, NULL ) )
goto late_failure;
if( !dbus_connection_set_watch_functions( p_conn,
add_watch,
remove_watch,
watch_toggled,
p_intf, NULL ) )
goto late_failure;
if( vlc_clone( &p_sys->thread, Run, p_intf, VLC_THREAD_PRIORITY_LOW ) )
goto late_failure;
return VLC_SUCCESS;
late_failure:
vlc_playlist_Lock(playlist);
player_vout_listener_failure:
vlc_player_vout_RemoveListener(player, p_sys->player_vout_listener);
player_aout_listener_failure:
vlc_player_aout_RemoveListener(player, p_sys->player_aout_listener);
player_listener_failure:
vlc_player_RemoveListener(player, p_sys->player_listener);
playlist_listener_failure:
vlc_playlist_RemoveListener(playlist, p_sys->playlist_listener);
vlc_playlist_Unlock(playlist);
var_Destroy(vlc, "dbus-mpris-name");
/* The dbus connection is private,
* so we are responsible for closing it
* XXX: Does this make sense when OOM ? */
dbus_connection_close( p_sys->p_conn );
dbus_connection_unref( p_conn );
dbus_connection_failure:
vlc_mutex_destroy( &p_sys->lock );
vlc_close( p_sys->p_pipe_fds[1] );
vlc_close( p_sys->p_pipe_fds[0] );
free( p_sys );
return VLC_EGENERIC;
}
/*****************************************************************************
* Close: destroy interface
*****************************************************************************/
static void Close ( vlc_object_t *p_this )
{
intf_thread_t *p_intf = (intf_thread_t*) p_this;
intf_sys_t *p_sys = p_intf->p_sys;
vlc_playlist_t *playlist = p_sys->playlist;
vlc_cancel( p_sys->thread );
vlc_join( p_sys->thread, NULL );
vlc_player_t *player = vlc_playlist_GetPlayer(playlist);
vlc_playlist_Lock(playlist);
vlc_player_vout_RemoveListener(player, p_sys->player_vout_listener);
vlc_player_aout_RemoveListener(player, p_sys->player_aout_listener);
vlc_player_RemoveListener(player, p_sys->player_listener);
vlc_playlist_RemoveListener(playlist, p_sys->playlist_listener);
vlc_playlist_Unlock(playlist);
/* The dbus connection is private, so we are responsible
* for closing it */
dbus_connection_close( p_sys->p_conn );
dbus_connection_unref( p_sys->p_conn );
// Free the events array
for( size_t i = 0; i < vlc_array_count( &p_sys->events ); i++ )
{
callback_info_t* info = vlc_array_item_at_index( &p_sys->events, i );
free( info );
}
vlc_mutex_destroy( &p_sys->lock );
vlc_array_clear( &p_sys->events );
vlc_array_clear( &p_sys->timeouts );
vlc_array_clear( &p_sys->watches );
vlc_close( p_sys->p_pipe_fds[1] );
vlc_close( p_sys->p_pipe_fds[0] );
free( p_sys );
}
static dbus_bool_t add_timeout(DBusTimeout *to, void *data)
{
intf_thread_t *intf = data;
intf_sys_t *sys = intf->p_sys;
vlc_tick_t *expiry = malloc(sizeof (*expiry));
if (unlikely(expiry == NULL))
return FALSE;
dbus_timeout_set_data(to, expiry, free);
vlc_mutex_lock(&sys->lock);
vlc_array_append_or_abort(&sys->timeouts, to);
vlc_mutex_unlock(&sys->lock);
return TRUE;
}
static void remove_timeout(DBusTimeout *to, void *data)
{
intf_thread_t *intf = data;
intf_sys_t *sys = intf->p_sys;
size_t idx;
vlc_mutex_lock(&sys->lock);
idx = vlc_array_index_of_item(&sys->timeouts, to);
vlc_array_remove(&sys->timeouts, idx);
vlc_mutex_unlock(&sys->lock);
}
static void toggle_timeout(DBusTimeout *to, void *data)
{
intf_thread_t *intf = data;
intf_sys_t *sys = intf->p_sys;
vlc_tick_t *expiry = dbus_timeout_get_data(to);
vlc_mutex_lock(&sys->lock);
if (dbus_timeout_get_enabled(to))
*expiry = vlc_tick_now() + UINT64_C(1000) * dbus_timeout_get_interval(to);
vlc_mutex_unlock(&sys->lock);
wakeup_main_loop(intf);
}
/**
* Computes the time until the next timeout expiration.
* @note Interface lock must be held.
* @return The time in milliseconds until the next expiration,
* or -1 if there are no pending timeouts.
*/
static int next_timeout(intf_thread_t *intf)
{
intf_sys_t *sys = intf->p_sys;
vlc_tick_t next_timeout = INT64_MAX;
unsigned count = vlc_array_count(&sys->timeouts);
for (unsigned i = 0; i < count; i++)
{
DBusTimeout *to = vlc_array_item_at_index(&sys->timeouts, i);
if (!dbus_timeout_get_enabled(to))
continue;
vlc_tick_t *expiry = dbus_timeout_get_data(to);
if (next_timeout > *expiry)
next_timeout = *expiry;
}
if (next_timeout >= INT64_MAX)
return -1;
next_timeout /= 1000;
if (next_timeout > INT_MAX)
return INT_MAX;
return (int)next_timeout;
}
/**
* Process pending D-Bus timeouts.
*
* @note Interface lock must be held.
*/
static void process_timeouts(intf_thread_t *intf)
{
intf_sys_t *sys = intf->p_sys;
for (size_t i = 0; i < vlc_array_count(&sys->timeouts); i++)
{
DBusTimeout *to = vlc_array_item_at_index(&sys->timeouts, i);
if (!dbus_timeout_get_enabled(to))
continue;
vlc_tick_t *expiry = dbus_timeout_get_data(to);
if (*expiry > vlc_tick_now())
continue;
expiry += UINT64_C(1000) * dbus_timeout_get_interval(to);
vlc_mutex_unlock(&sys->lock);
dbus_timeout_handle(to);
vlc_mutex_lock(&sys->lock);
i = -1; /* lost track of state, restart from beginning */
}
}
static dbus_bool_t add_watch( DBusWatch *p_watch, void *p_data )
{
intf_thread_t *p_intf = (intf_thread_t*) p_data;
intf_sys_t *p_sys = (intf_sys_t*) p_intf->p_sys;
vlc_mutex_lock( &p_sys->lock );
vlc_array_append_or_abort( &p_sys->watches, p_watch );
vlc_mutex_unlock( &p_sys->lock );
return TRUE;
}
static void remove_watch( DBusWatch *p_watch, void *p_data )
{
intf_thread_t *p_intf = (intf_thread_t*) p_data;
intf_sys_t *p_sys = (intf_sys_t*) p_intf->p_sys;
size_t idx;
vlc_mutex_lock( &p_sys->lock );
idx = vlc_array_index_of_item( &p_sys->watches, p_watch );
vlc_array_remove( &p_sys->watches, idx );
vlc_mutex_unlock( &p_sys->lock );
}
static void watch_toggled( DBusWatch *p_watch, void *p_data )
{
intf_thread_t *p_intf = (intf_thread_t*) p_data;
if( dbus_watch_get_enabled( p_watch ) )
wakeup_main_loop( p_intf );
}
/**
* GetPollFds() fills an array of pollfd data structures with :
* - the set of enabled dbus watches
* - the unix pipe which we use to manually wake up the main loop
*
* This function must be called with p_sys->lock locked
*
* @return The number of file descriptors
*
* @param intf_thread_t *p_intf this interface thread's state
* @param struct pollfd *p_fds a pointer to a pollfd array large enough to
* contain all the returned data (number of enabled dbus watches + 1)
*/
static int GetPollFds( intf_thread_t *p_intf, struct pollfd *p_fds )
{
intf_sys_t *p_sys = p_intf->p_sys;
size_t i_watches = vlc_array_count( &p_sys->watches );
int i_fds = 1;
p_fds[0].fd = p_sys->p_pipe_fds[PIPE_OUT];
p_fds[0].events = POLLIN | POLLPRI;
for( size_t i = 0; i < i_watches; i++ )
{
DBusWatch *p_watch = NULL;
p_watch = vlc_array_item_at_index( &p_sys->watches, i );
if( !dbus_watch_get_enabled( p_watch ) )
continue;
p_fds[i_fds].fd = dbus_watch_get_unix_fd( p_watch );
int i_flags = dbus_watch_get_flags( p_watch );
if( i_flags & DBUS_WATCH_READABLE )
p_fds[i_fds].events |= POLLIN | POLLPRI;
if( i_flags & DBUS_WATCH_WRITABLE )
p_fds[i_fds].events |= POLLOUT;
i_fds++;
}
return i_fds;
}
/**
* ProcessEvents() reacts to a list of events originating from other VLC threads
*
* This function must be called with p_sys->lock unlocked
*
* @param intf_thread_t *p_intf This interface thread state
* @param callback_info_t *p_events the list of events to process
*/
static void ProcessEvents( intf_thread_t *p_intf,
callback_info_t **p_events, int i_events )
{
bool b_can_play = p_intf->p_sys->b_can_play;
vlc_dictionary_t player_properties, tracklist_properties, root_properties;
vlc_dictionary_init( &player_properties, 0 );
vlc_dictionary_init( &tracklist_properties, 0 );
vlc_dictionary_init( &root_properties, 0 );
for( int i = 0; i < i_events; i++ )
{
switch( p_events[i]->signal )
{
case SIGNAL_ITEM_CURRENT:
TrackChange( p_intf );
// rate depends on current item
if( !vlc_dictionary_has_key( &player_properties, "Rate" ) )
vlc_dictionary_insert( &player_properties, "Rate", NULL );
vlc_dictionary_insert( &player_properties, "Metadata", NULL );
break;
case SIGNAL_PLAYLIST_ITEM_APPEND:
case SIGNAL_PLAYLIST_ITEM_DELETED:
{
vlc_playlist_t *playlist = p_intf->p_sys->playlist;
vlc_playlist_Lock(playlist);
b_can_play = vlc_playlist_Count(playlist) > 0;
vlc_playlist_Unlock(playlist);
if( b_can_play != p_intf->p_sys->b_can_play )
{
p_intf->p_sys->b_can_play = b_can_play;
vlc_dictionary_insert( &player_properties, "CanPlay", NULL );
}
if( !vlc_dictionary_has_key( &tracklist_properties, "Tracks" ) )
vlc_dictionary_insert( &tracklist_properties, "Tracks", NULL );
break;
}
case SIGNAL_VOLUME_MUTED:
case SIGNAL_VOLUME_CHANGE:
vlc_dictionary_insert( &player_properties, "Volume", NULL );
break;
case SIGNAL_RANDOM:
vlc_dictionary_insert( &player_properties, "Shuffle", NULL );
break;
case SIGNAL_FULLSCREEN:
vlc_dictionary_insert( &root_properties, "Fullscreen", NULL );
break;
case SIGNAL_REPEAT:
case SIGNAL_LOOP:
vlc_dictionary_insert( &player_properties, "LoopStatus", NULL );
break;
case SIGNAL_STATE:
vlc_dictionary_insert( &player_properties, "PlaybackStatus", NULL );
break;
case SIGNAL_RATE:
vlc_dictionary_insert( &player_properties, "Rate", NULL );
break;
case SIGNAL_INPUT_METADATA:
{
vlc_player_t *player =
vlc_playlist_GetPlayer(p_intf->p_sys->playlist);
vlc_player_Lock(player);
input_item_t *p_item = vlc_player_GetCurrentMedia(player);
if( p_item )
vlc_dictionary_insert( &player_properties,
"Metadata", NULL );
vlc_player_Unlock(player);
break;
}
case SIGNAL_CAN_SEEK:
vlc_dictionary_insert( &player_properties, "CanSeek", NULL );
break;
case SIGNAL_CAN_PAUSE:
vlc_dictionary_insert( &player_properties, "CanPause", NULL );
break;
case SIGNAL_SEEK:
SeekedEmit( p_intf );
break;
default:
vlc_assert_unreachable();
}
free( p_events[i] );
}
if( !vlc_dictionary_is_empty( &player_properties ) )
PlayerPropertiesChangedEmit( p_intf, &player_properties );
if( !vlc_dictionary_is_empty( &tracklist_properties ) )
TrackListPropertiesChangedEmit( p_intf, &tracklist_properties );
if( !vlc_dictionary_is_empty( &root_properties ) )
RootPropertiesChangedEmit( p_intf, &root_properties );
vlc_dictionary_clear( &player_properties, NULL, NULL );
vlc_dictionary_clear( &tracklist_properties, NULL, NULL );
vlc_dictionary_clear( &root_properties, NULL, NULL );
}
/**
* ProcessWatches() handles a list of dbus watches after poll() has returned
*
* This function must be called with p_sys->lock unlocked
*
* @param intf_thread_t *p_intf This interface thread state
* @param DBusWatch **p_watches The list of dbus watches to process
* @param int i_watches The size of the p_watches array
* @param struct pollfd *p_fds The result of a poll() call
* @param int i_fds The number of file descriptors processed by poll()
*/
static void ProcessWatches( intf_thread_t *p_intf,
DBusWatch **p_watches, int i_watches,
struct pollfd *p_fds, int i_fds )
{
VLC_UNUSED(p_intf);
/* Process watches */
for( int i = 0; i < i_watches; i++ )
{
DBusWatch *p_watch = p_watches[i];
if( !dbus_watch_get_enabled( p_watch ) )
continue;
for( int j = 0; j < i_fds; j++ )
{
if( p_fds[j].fd != dbus_watch_get_unix_fd( p_watch ) )
continue;
int i_flags = 0;
int i_revents = p_fds[j].revents;
if( i_revents & POLLIN )
i_flags |= DBUS_WATCH_READABLE;
if( i_revents & POLLOUT )
i_flags |= DBUS_WATCH_WRITABLE;
if( i_revents & POLLERR )
i_flags |= DBUS_WATCH_ERROR;
if( i_revents & POLLHUP )
i_flags |= DBUS_WATCH_HANGUP;
if( i_flags )
dbus_watch_handle( p_watch, i_flags );
}
}
}
/**
* DispatchDBusMessages() dispatches incoming dbus messages
* (indirectly invoking the callbacks), then it sends outgoing
* messages which needs to be sent on the bus (method replies and signals)
*
* This function must be called with p_sys->lock unlocked
*
* @param intf_thread_t *p_intf This interface thread state
*/
static void DispatchDBusMessages( intf_thread_t *p_intf )
{
DBusDispatchStatus status;
intf_sys_t *p_sys = p_intf->p_sys;
/* Dispatch incoming messages */
status = dbus_connection_get_dispatch_status( p_sys->p_conn );
while( status != DBUS_DISPATCH_COMPLETE )
{
dbus_connection_dispatch( p_sys->p_conn );
status = dbus_connection_get_dispatch_status( p_sys->p_conn );
}
/* Send outgoing data */
if( dbus_connection_has_messages_to_send( p_sys->p_conn ) )
dbus_connection_flush( p_sys->p_conn );
}
/**
* MPRISEntryPoint() routes incoming messages to their respective interface
* implementation.
*
* This function is called during dbus_connection_dispatch()
*/
static DBusHandlerResult
MPRISEntryPoint ( DBusConnection *p_conn, DBusMessage *p_from, void *p_this )
{
const char *psz_target_interface;
const char *psz_interface = dbus_message_get_interface( p_from );
const char *psz_method = dbus_message_get_member( p_from );
DBusError error;
if( psz_interface && strcmp( psz_interface, DBUS_INTERFACE_PROPERTIES ) )
psz_target_interface = psz_interface;
else
{
dbus_error_init( &error );
dbus_message_get_args( p_from, &error,
DBUS_TYPE_STRING, &psz_target_interface,
DBUS_TYPE_INVALID );
if( dbus_error_is_set( &error ) )
{
msg_Err( (vlc_object_t*) p_this, "D-Bus error on %s.%s: %s",
psz_interface, psz_method,
error.message );
dbus_error_free( &error );
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
}
if( !strcmp( psz_target_interface, DBUS_INTERFACE_INTROSPECTABLE ) )
return handle_introspect( p_conn, p_from, p_this );
if( !strcmp( psz_target_interface, DBUS_MPRIS_ROOT_INTERFACE ) )
return handle_root( p_conn, p_from, p_this );
if( !strcmp( psz_target_interface, DBUS_MPRIS_PLAYER_INTERFACE ) )
return handle_player( p_conn, p_from, p_this );
if( !strcmp( psz_target_interface, DBUS_MPRIS_TRACKLIST_INTERFACE ) )
return handle_tracklist( p_conn, p_from, p_this );
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
/*****************************************************************************
* Run: main loop
*****************************************************************************/
static void *Run( void *data )
{
intf_thread_t *p_intf = data;
intf_sys_t *p_sys = p_intf->p_sys;
int canc = vlc_savecancel();
vlc_tick_t events_last_date = VLC_TICK_INVALID;
int events_poll_timeout = -1;
for( ;; )
{
vlc_mutex_lock( &p_sys->lock );
size_t i_watches = vlc_array_count( &p_sys->watches );
struct pollfd fds[i_watches];
memset(fds, 0, sizeof fds);
int i_fds = GetPollFds( p_intf, fds );
int timeout = next_timeout(p_intf);
vlc_mutex_unlock( &p_sys->lock );
/* thread cancellation is allowed while the main loop sleeps */
vlc_restorecancel( canc );
if( timeout == -1 )
timeout = events_poll_timeout;
while (poll(fds, i_fds, timeout) == -1)
{
if (errno != EINTR)
goto error;
}
canc = vlc_savecancel();
/* Was the main loop woken up manually ? */
if (fds[0].revents & POLLIN)
{
char buf;
(void)read( fds[0].fd, &buf, 1 );
}
/* We need to lock the mutex while building lists of events,
* timeouts and watches to process but we can't keep the lock while
* processing them, or else we risk a deadlock:
*
* The signal functions could lock mutex X while p_events is locked;
* While some other function in vlc (playlist) might lock mutex X
* and then set a variable which would call PlaylistCallback(), which itself
* needs to lock p_events to add a new event.
*/
vlc_mutex_lock( &p_intf->p_sys->lock );
process_timeouts(p_intf);
/* Get the list of watches to process */
i_watches = vlc_array_count( &p_sys->watches );
DBusWatch *p_watches[i_watches ? i_watches : 1];
for( size_t i = 0; i < i_watches; i++ )
{
p_watches[i] = vlc_array_item_at_index( &p_sys->watches, i );
}
/* Get the list of events to process */
size_t i_events = vlc_array_count( &p_sys->events );
callback_info_t** pp_info = NULL;
if( i_events > 0 )
{
vlc_tick_t now = vlc_tick_now();
if( events_last_date == VLC_TICK_INVALID
|| now - events_last_date > EVENTS_DELAY )
{
/* Send events every EVENTS_DELAY */
events_last_date = now;
events_poll_timeout = -1;
pp_info = vlc_alloc( i_events, sizeof(*pp_info) );
if( pp_info )
{
for( size_t i = 0; i < i_events; i++ )
pp_info[i] = vlc_array_item_at_index( &p_sys->events, i );
vlc_array_clear( &p_sys->events );
}
}
else if( events_poll_timeout == -1 )
{
/* Request poll to wake up in order to send these events after
* some delay */
events_poll_timeout = ( EVENTS_DELAY - ( now - events_last_date ) ) / 1000;
}
}
else /* No events: clear timeout */
events_poll_timeout = -1;
/* now we can release the lock and process what's pending */
vlc_mutex_unlock( &p_intf->p_sys->lock );
if( pp_info )
{
ProcessEvents( p_intf, pp_info, i_events );
free( pp_info );
}
ProcessWatches( p_intf, p_watches, i_watches, fds, i_fds );
DispatchDBusMessages( p_intf );
}
error:
vlc_restorecancel(canc);
return NULL;
}
static void wakeup_main_loop( void *p_data )
{
intf_thread_t *p_intf = (intf_thread_t*) p_data;
if( !write( p_intf->p_sys->p_pipe_fds[PIPE_IN], "\0", 1 ) )
msg_Err( p_intf, "Could not wake up the main loop: %s",
vlc_strerror_c(errno) );
}
static bool add_event_locked( intf_thread_t *p_intf, const callback_info_t *p_info )
{
if( !p_info->signal )
return false;
for( size_t i = 0; i < vlc_array_count( &p_intf->p_sys->events ); ++ i )
{
callback_info_t *oldinfo =
vlc_array_item_at_index( &p_intf->p_sys->events, i );
if( p_info->signal == oldinfo->signal )
return false;
}
callback_info_t *p_dup = malloc( sizeof( *p_dup ) );
if( unlikely(p_dup == NULL) )
return false;
*p_dup = *p_info;
vlc_array_append( &p_intf->p_sys->events, p_dup );
return true;
}
static bool add_event_signal( intf_thread_t *p_intf, const callback_info_t *p_info )
{
intf_sys_t *p_sys = p_intf->p_sys;
vlc_mutex_lock(&p_sys->lock);
bool added = add_event_locked(p_intf, p_info);
vlc_mutex_unlock(&p_sys->lock);
if( added )
wakeup_main_loop( p_intf );
return added;
}
static void
playlist_on_items_added(vlc_playlist_t *playlist, size_t index,
vlc_playlist_item_t *const items[], size_t count,
void *data)
{
add_event_signal(data,
&(callback_info_t){ .signal = SIGNAL_PLAYLIST_ITEM_APPEND });
(void) playlist; (void) index; (void) items; (void) count;
}
static void
playlist_on_items_removed(vlc_playlist_t *playlist,
size_t index, size_t count, void *data)
{
add_event_signal(data,
&(callback_info_t){ .signal = SIGNAL_PLAYLIST_ITEM_DELETED });
(void) playlist; (void) index; (void) count;
}