2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <sys/types.h>
38 #ifdef HAVE_SYS_WAIT_H
42 #ifdef HAVE_SYS_SOCKET_H
43 #include <sys/socket.h>
52 #include <pulse/version.h>
53 #include <pulse/xmalloc.h>
54 #include <pulse/utf8.h>
55 #include <pulse/util.h>
56 #include <pulse/i18n.h>
58 #include <pulsecore/winsock.h>
59 #include <pulsecore/core-error.h>
61 #include <pulsecore/native-common.h>
62 #include <pulsecore/pdispatch.h>
63 #include <pulsecore/pstream.h>
64 #include <pulsecore/dynarray.h>
65 #include <pulsecore/socket-client.h>
66 #include <pulsecore/pstream-util.h>
67 #include <pulsecore/core-util.h>
68 #include <pulsecore/log.h>
69 #include <pulsecore/socket-util.h>
70 #include <pulsecore/creds.h>
71 #include <pulsecore/macro.h>
72 #include <pulsecore/proplist-util.h>
76 #include "client-conf.h"
79 #include "client-conf-x11.h"
84 #define AUTOSPAWN_LOCK "autospawn.lock"
86 void pa_command_extension(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
88 static const pa_pdispatch_cb_t command_table
[PA_COMMAND_MAX
] = {
89 [PA_COMMAND_REQUEST
] = pa_command_request
,
90 [PA_COMMAND_OVERFLOW
] = pa_command_overflow_or_underflow
,
91 [PA_COMMAND_UNDERFLOW
] = pa_command_overflow_or_underflow
,
92 [PA_COMMAND_PLAYBACK_STREAM_KILLED
] = pa_command_stream_killed
,
93 [PA_COMMAND_RECORD_STREAM_KILLED
] = pa_command_stream_killed
,
94 [PA_COMMAND_PLAYBACK_STREAM_MOVED
] = pa_command_stream_moved
,
95 [PA_COMMAND_RECORD_STREAM_MOVED
] = pa_command_stream_moved
,
96 [PA_COMMAND_PLAYBACK_STREAM_SUSPENDED
] = pa_command_stream_suspended
,
97 [PA_COMMAND_RECORD_STREAM_SUSPENDED
] = pa_command_stream_suspended
,
98 [PA_COMMAND_STARTED
] = pa_command_stream_started
,
99 [PA_COMMAND_SUBSCRIBE_EVENT
] = pa_command_subscribe_event
,
100 [PA_COMMAND_EXTENSION
] = pa_command_extension
103 static void unlock_autospawn_lock_file(pa_context
*c
) {
106 if (c
->autospawn_lock_fd
>= 0) {
109 if (!(lf
= pa_runtime_path(AUTOSPAWN_LOCK
)))
110 pa_log_warn(_("Cannot unlock autospawn because runtime path is no more."));
112 pa_unlock_lockfile(lf
, c
->autospawn_lock_fd
);
115 c
->autospawn_lock_fd
= -1;
119 static void context_free(pa_context
*c
);
121 pa_context
*pa_context_new(pa_mainloop_api
*mainloop
, const char *name
) {
122 return pa_context_new_with_proplist(mainloop
, name
, NULL
);
125 static void reset_callbacks(pa_context
*c
) {
128 c
->state_callback
= NULL
;
129 c
->state_userdata
= NULL
;
131 c
->subscribe_callback
= NULL
;
132 c
->subscribe_userdata
= NULL
;
134 c
->ext_stream_restore
.callback
= NULL
;
135 c
->ext_stream_restore
.userdata
= NULL
;
138 pa_context
*pa_context_new_with_proplist(pa_mainloop_api
*mainloop
, const char *name
, pa_proplist
*p
) {
145 if (!name
&& !pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
))
148 c
= pa_xnew(pa_context
, 1);
151 c
->proplist
= p
? pa_proplist_copy(p
) : pa_proplist_new();
154 pa_proplist_sets(c
->proplist
, PA_PROP_APPLICATION_NAME
, name
);
156 c
->mainloop
= mainloop
;
160 c
->playback_streams
= pa_dynarray_new();
161 c
->record_streams
= pa_dynarray_new();
162 c
->client_index
= PA_INVALID_INDEX
;
164 PA_LLIST_HEAD_INIT(pa_stream
, c
->streams
);
165 PA_LLIST_HEAD_INIT(pa_operation
, c
->operations
);
168 c
->state
= PA_CONTEXT_UNCONNECTED
;
175 c
->server_list
= NULL
;
177 c
->autospawn_lock_fd
= -1;
178 memset(&c
->spawn_api
, 0, sizeof(c
->spawn_api
));
179 c
->do_autospawn
= FALSE
;
184 pa_check_signal_is_blocked(SIGPIPE
);
188 c
->conf
= pa_client_conf_new();
190 pa_client_conf_from_x11(c
->conf
, NULL
);
192 pa_client_conf_load(c
->conf
, NULL
);
193 pa_client_conf_env(c
->conf
);
195 if (!(c
->mempool
= pa_mempool_new(!c
->conf
->disable_shm
))) {
197 if (!c
->conf
->disable_shm
)
198 c
->mempool
= pa_mempool_new(0);
209 static void context_unlink(pa_context
*c
) {
214 s
= c
->streams
? pa_stream_ref(c
->streams
) : NULL
;
216 pa_stream
*n
= s
->next
? pa_stream_ref(s
->next
) : NULL
;
217 pa_stream_set_state(s
, c
->state
== PA_CONTEXT_FAILED
? PA_STREAM_FAILED
: PA_STREAM_TERMINATED
);
222 while (c
->operations
)
223 pa_operation_cancel(c
->operations
);
226 pa_pdispatch_unref(c
->pdispatch
);
231 pa_pstream_unlink(c
->pstream
);
232 pa_pstream_unref(c
->pstream
);
237 pa_socket_client_unref(c
->client
);
244 static void context_free(pa_context
*c
) {
249 unlock_autospawn_lock_file(c
);
251 if (c
->record_streams
)
252 pa_dynarray_free(c
->record_streams
, NULL
, NULL
);
253 if (c
->playback_streams
)
254 pa_dynarray_free(c
->playback_streams
, NULL
, NULL
);
257 pa_mempool_free(c
->mempool
);
260 pa_client_conf_free(c
->conf
);
262 pa_strlist_free(c
->server_list
);
265 pa_proplist_free(c
->proplist
);
271 pa_context
* pa_context_ref(pa_context
*c
) {
273 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
279 void pa_context_unref(pa_context
*c
) {
281 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
283 if (PA_REFCNT_DEC(c
) <= 0)
287 void pa_context_set_state(pa_context
*c
, pa_context_state_t st
) {
289 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
298 if (c
->state_callback
)
299 c
->state_callback(c
, c
->state_userdata
);
301 if (st
== PA_CONTEXT_FAILED
|| st
== PA_CONTEXT_TERMINATED
)
307 int pa_context_set_error(pa_context
*c
, int error
) {
308 pa_assert(error
>= 0);
309 pa_assert(error
< PA_ERR_MAX
);
317 void pa_context_fail(pa_context
*c
, int error
) {
319 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
321 pa_context_set_error(c
, error
);
322 pa_context_set_state(c
, PA_CONTEXT_FAILED
);
325 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
326 pa_context
*c
= userdata
;
331 pa_context_fail(c
, PA_ERR_CONNECTIONTERMINATED
);
334 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, const pa_creds
*creds
, void *userdata
) {
335 pa_context
*c
= userdata
;
343 if (pa_pdispatch_run(c
->pdispatch
, packet
, creds
, c
) < 0)
344 pa_context_fail(c
, PA_ERR_PROTOCOL
);
349 static void pstream_memblock_callback(pa_pstream
*p
, uint32_t channel
, int64_t offset
, pa_seek_mode_t seek
, const pa_memchunk
*chunk
, void *userdata
) {
350 pa_context
*c
= userdata
;
355 pa_assert(chunk
->memblock
);
356 pa_assert(chunk
->length
);
358 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
362 if ((s
= pa_dynarray_get(c
->record_streams
, channel
))) {
364 pa_assert(seek
== PA_SEEK_RELATIVE
);
365 pa_assert(offset
== 0);
367 pa_memblockq_seek(s
->record_memblockq
, offset
, seek
);
368 pa_memblockq_push_align(s
->record_memblockq
, chunk
);
370 if (s
->read_callback
) {
373 if ((l
= pa_memblockq_get_length(s
->record_memblockq
)) > 0)
374 s
->read_callback(s
, l
, s
->read_userdata
);
381 int pa_context_handle_error(pa_context
*c
, uint32_t command
, pa_tagstruct
*t
, pa_bool_t fail
) {
384 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
386 if (command
== PA_COMMAND_ERROR
) {
389 if (pa_tagstruct_getu32(t
, &err
) < 0) {
390 pa_context_fail(c
, PA_ERR_PROTOCOL
);
394 } else if (command
== PA_COMMAND_TIMEOUT
)
395 err
= PA_ERR_TIMEOUT
;
397 pa_context_fail(c
, PA_ERR_PROTOCOL
);
402 pa_context_fail(c
, PA_ERR_PROTOCOL
);
406 if (err
>= PA_ERR_MAX
)
407 err
= PA_ERR_UNKNOWN
;
410 pa_context_fail(c
, err
);
414 pa_context_set_error(c
, err
);
419 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
420 pa_context
*c
= userdata
;
424 pa_assert(c
->state
== PA_CONTEXT_AUTHORIZING
|| c
->state
== PA_CONTEXT_SETTING_NAME
);
428 if (command
!= PA_COMMAND_REPLY
) {
429 pa_context_handle_error(c
, command
, t
, TRUE
);
434 case PA_CONTEXT_AUTHORIZING
: {
436 pa_bool_t shm_on_remote
;
438 if (pa_tagstruct_getu32(t
, &c
->version
) < 0 ||
439 !pa_tagstruct_eof(t
)) {
440 pa_context_fail(c
, PA_ERR_PROTOCOL
);
444 /* Minimum supported version */
445 if (c
->version
< 8) {
446 pa_context_fail(c
, PA_ERR_VERSION
);
450 /* Starting with protocol version 13 the MSB of the version
451 tag reflects if shm is available for this connection or
453 if (c
->version
>= 13) {
454 shm_on_remote
= !!(c
->version
& 0x80000000U
);
455 c
->version
&= 0x7FFFFFFFU
;
458 pa_log_debug("Protocol version: remote %u, local %u", c
->version
, PA_PROTOCOL_VERSION
);
460 /* Enable shared memory support if possible */
462 if (c
->version
< 10 || (c
->version
>= 13 && !shm_on_remote
))
467 /* Only enable SHM if both sides are owned by the same
468 * user. This is a security measure because otherwise
469 * data private to the user might leak. */
472 const pa_creds
*creds
;
473 if (!(creds
= pa_pdispatch_creds(pd
)) || getuid() != creds
->uid
)
478 pa_log_debug("Negotiated SHM: %s", pa_yes_no(c
->do_shm
));
479 pa_pstream_enable_shm(c
->pstream
, c
->do_shm
);
481 reply
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
483 if (c
->version
>= 13) {
484 pa_init_proplist(c
->proplist
);
485 pa_tagstruct_put_proplist(reply
, c
->proplist
);
487 pa_tagstruct_puts(reply
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
489 pa_pstream_send_tagstruct(c
->pstream
, reply
);
490 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
492 pa_context_set_state(c
, PA_CONTEXT_SETTING_NAME
);
496 case PA_CONTEXT_SETTING_NAME
:
498 if ((c
->version
>= 13 && (pa_tagstruct_getu32(t
, &c
->client_index
) < 0 ||
499 c
->client_index
== PA_INVALID_INDEX
)) ||
500 !pa_tagstruct_eof(t
)) {
501 pa_context_fail(c
, PA_ERR_PROTOCOL
);
505 pa_context_set_state(c
, PA_CONTEXT_READY
);
509 pa_assert_not_reached();
516 static void setup_context(pa_context
*c
, pa_iochannel
*io
) {
525 pa_assert(!c
->pstream
);
526 c
->pstream
= pa_pstream_new(c
->mainloop
, io
, c
->mempool
);
528 pa_pstream_set_die_callback(c
->pstream
, pstream_die_callback
, c
);
529 pa_pstream_set_recieve_packet_callback(c
->pstream
, pstream_packet_callback
, c
);
530 pa_pstream_set_recieve_memblock_callback(c
->pstream
, pstream_memblock_callback
, c
);
532 pa_assert(!c
->pdispatch
);
533 c
->pdispatch
= pa_pdispatch_new(c
->mainloop
, command_table
, PA_COMMAND_MAX
);
535 if (!c
->conf
->cookie_valid
)
536 pa_log_info(_("No cookie loaded. Attempting to connect without."));
538 t
= pa_tagstruct_command(c
, PA_COMMAND_AUTH
, &tag
);
541 pa_mempool_is_shared(c
->mempool
) &&
544 pa_log_debug("SHM possible: %s", pa_yes_no(c
->do_shm
));
546 /* Starting with protocol version 13 we use the MSB of the version
547 * tag for informing the other side if we could do SHM or not */
548 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
| (c
->do_shm
? 0x80000000U
: 0));
549 pa_tagstruct_put_arbitrary(t
, c
->conf
->cookie
, sizeof(c
->conf
->cookie
));
555 if (pa_iochannel_creds_supported(io
))
556 pa_iochannel_creds_enable(io
);
558 ucred
.uid
= getuid();
559 ucred
.gid
= getgid();
561 pa_pstream_send_tagstruct_with_creds(c
->pstream
, t
, &ucred
);
564 pa_pstream_send_tagstruct(c
->pstream
, t
);
567 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
569 pa_context_set_state(c
, PA_CONTEXT_AUTHORIZING
);
574 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
);
578 static int context_connect_spawn(pa_context
*c
) {
581 int fds
[2] = { -1, -1} ;
589 if (socketpair(AF_UNIX
, SOCK_STREAM
, 0, fds
) < 0) {
590 pa_log_error(_("socketpair(): %s"), pa_cstrerror(errno
));
591 pa_context_fail(c
, PA_ERR_INTERNAL
);
595 pa_make_fd_cloexec(fds
[0]);
597 pa_make_socket_low_delay(fds
[0]);
598 pa_make_socket_low_delay(fds
[1]);
600 if (c
->spawn_api
.prefork
)
601 c
->spawn_api
.prefork();
603 if ((pid
= fork()) < 0) {
604 pa_log_error(_("fork(): %s"), pa_cstrerror(errno
));
605 pa_context_fail(c
, PA_ERR_INTERNAL
);
607 if (c
->spawn_api
.postfork
)
608 c
->spawn_api
.postfork();
615 const char *state
= NULL
;
617 const char * argv
[MAX_ARGS
+1];
621 pa_close_all(fds
[1], -1);
623 f
= pa_sprintf_malloc("%i", fds
[1]);
624 pa_set_env("PULSE_PASSED_FD", f
);
627 if (c
->spawn_api
.atfork
)
628 c
->spawn_api
.atfork();
634 argv
[n
++] = c
->conf
->daemon_binary
;
635 argv
[n
++] = "--daemonize=yes";
637 pa_snprintf(t
, sizeof(t
), "-Lmodule-native-protocol-fd fd=%i", fds
[1]);
638 argv
[n
++] = strdup(t
);
640 while (n
< MAX_ARGS
) {
643 if (!(a
= pa_split_spaces(c
->conf
->extra_arguments
, &state
)))
651 execv(argv
[0], (char * const *) argv
);
658 pa_assert_se(pa_close(fds
[1]) == 0);
661 r
= waitpid(pid
, &status
, 0);
663 if (c
->spawn_api
.postfork
)
664 c
->spawn_api
.postfork();
667 pa_log(_("waitpid(): %s"), pa_cstrerror(errno
));
668 pa_context_fail(c
, PA_ERR_INTERNAL
);
670 } else if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
671 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
677 unlock_autospawn_lock_file(c
);
679 io
= pa_iochannel_new(c
->mainloop
, fds
[0], fds
[0]);
680 setup_context(c
, io
);
689 unlock_autospawn_lock_file(c
);
696 #endif /* OS_IS_WIN32 */
698 static int try_next_connection(pa_context
*c
) {
703 pa_assert(!c
->client
);
709 c
->server_list
= pa_strlist_pop(c
->server_list
, &u
);
714 if (c
->do_autospawn
) {
715 r
= context_connect_spawn(c
);
720 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
724 pa_log_debug("Trying to connect to %s...", u
);
727 c
->server
= pa_xstrdup(u
);
729 if (!(c
->client
= pa_socket_client_new_string(c
->mainloop
, u
, PA_NATIVE_DEFAULT_PORT
)))
732 c
->is_local
= !!pa_socket_client_is_local(c
->client
);
733 pa_socket_client_set_callback(c
->client
, on_connection
, c
);
745 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
) {
746 pa_context
*c
= userdata
;
747 int saved_errno
= errno
;
751 pa_assert(c
->state
== PA_CONTEXT_CONNECTING
);
755 pa_socket_client_unref(client
);
759 /* Try the item in the list */
760 if (saved_errno
== ECONNREFUSED
||
761 saved_errno
== ETIMEDOUT
||
762 saved_errno
== EHOSTUNREACH
) {
763 try_next_connection(c
);
767 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
771 unlock_autospawn_lock_file(c
);
772 setup_context(c
, io
);
779 static char *get_old_legacy_runtime_dir(void) {
783 if (!pa_get_user_name(u
, sizeof(u
)))
786 p
= pa_sprintf_malloc("/tmp/pulse-%s", u
);
788 if (stat(p
, &st
) < 0) {
793 if (st
.st_uid
!= getuid()) {
801 static char *get_very_old_legacy_runtime_dir(void) {
805 if (!pa_get_home_dir(h
, sizeof(h
)))
808 p
= pa_sprintf_malloc("%s/.pulse", h
);
810 if (stat(p
, &st
) < 0) {
815 if (st
.st_uid
!= getuid()) {
823 int pa_context_connect(
826 pa_context_flags_t flags
,
827 const pa_spawn_api
*api
) {
832 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
834 PA_CHECK_VALIDITY(c
, c
->state
== PA_CONTEXT_UNCONNECTED
, PA_ERR_BADSTATE
);
835 PA_CHECK_VALIDITY(c
, !(flags
& ~PA_CONTEXT_NOAUTOSPAWN
), PA_ERR_INVALID
);
836 PA_CHECK_VALIDITY(c
, !server
|| *server
, PA_ERR_INVALID
);
839 server
= c
->conf
->default_server
;
843 pa_assert(!c
->server_list
);
846 if (!(c
->server_list
= pa_strlist_parse(server
))) {
847 pa_context_fail(c
, PA_ERR_INVALIDSERVER
);
852 static char *legacy_dir
;
854 /* Prepend in reverse order */
856 if ((d
= getenv("DISPLAY"))) {
859 if ((e
= strchr(d
, ':')))
863 c
->server_list
= pa_strlist_prepend(c
->server_list
, d
);
868 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp6:localhost");
869 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp4:localhost");
871 /* The system wide instance */
872 c
->server_list
= pa_strlist_prepend(c
->server_list
, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
);
874 /* The very old per-user instance path (< 0.9.11). This is supported only to ease upgrades */
875 if ((legacy_dir
= get_very_old_legacy_runtime_dir())) {
876 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
877 c
->server_list
= pa_strlist_prepend(c
->server_list
, p
);
879 pa_xfree(legacy_dir
);
882 /* The old per-user instance path (< 0.9.12). This is supported only to ease upgrades */
883 if ((legacy_dir
= get_old_legacy_runtime_dir())) {
884 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
885 c
->server_list
= pa_strlist_prepend(c
->server_list
, p
);
887 pa_xfree(legacy_dir
);
890 /* The per-user instance */
891 if ((ufn
= pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET
))) {
892 c
->server_list
= pa_strlist_prepend(c
->server_list
, ufn
);
896 /* Wrap the connection attempts in a single transaction for sane autospawn locking */
897 if (!(flags
& PA_CONTEXT_NOAUTOSPAWN
) && c
->conf
->autospawn
) {
900 if (!(lf
= pa_runtime_path(AUTOSPAWN_LOCK
))) {
901 pa_context_fail(c
, PA_ERR_ACCESS
);
905 pa_assert(c
->autospawn_lock_fd
<= 0);
906 c
->autospawn_lock_fd
= pa_lock_lockfile(lf
);
912 c
->do_autospawn
= TRUE
;
916 pa_context_set_state(c
, PA_CONTEXT_CONNECTING
);
917 r
= try_next_connection(c
);
925 void pa_context_disconnect(pa_context
*c
) {
927 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
929 if (PA_CONTEXT_IS_GOOD(c
->state
))
930 pa_context_set_state(c
, PA_CONTEXT_TERMINATED
);
933 pa_context_state_t
pa_context_get_state(pa_context
*c
) {
935 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
940 int pa_context_errno(pa_context
*c
) {
942 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
947 void pa_context_set_state_callback(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
949 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
951 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
954 c
->state_callback
= cb
;
955 c
->state_userdata
= userdata
;
958 int pa_context_is_pending(pa_context
*c
) {
960 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
962 PA_CHECK_VALIDITY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
);
964 return (c
->pstream
&& pa_pstream_is_pending(c
->pstream
)) ||
965 (c
->pdispatch
&& pa_pdispatch_is_pending(c
->pdispatch
)) ||
969 static void set_dispatch_callbacks(pa_operation
*o
);
971 static void pdispatch_drain_callback(PA_GCC_UNUSED pa_pdispatch
*pd
, void *userdata
) {
972 set_dispatch_callbacks(userdata
);
975 static void pstream_drain_callback(PA_GCC_UNUSED pa_pstream
*s
, void *userdata
) {
976 set_dispatch_callbacks(userdata
);
979 static void set_dispatch_callbacks(pa_operation
*o
) {
983 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
984 pa_assert(o
->context
);
985 pa_assert(PA_REFCNT_VALUE(o
->context
) >= 1);
986 pa_assert(o
->context
->state
== PA_CONTEXT_READY
);
988 pa_pstream_set_drain_callback(o
->context
->pstream
, NULL
, NULL
);
989 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, NULL
, NULL
);
991 if (pa_pdispatch_is_pending(o
->context
->pdispatch
)) {
992 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, pdispatch_drain_callback
, o
);
996 if (pa_pstream_is_pending(o
->context
->pstream
)) {
997 pa_pstream_set_drain_callback(o
->context
->pstream
, pstream_drain_callback
, o
);
1003 pa_context_notify_cb_t cb
= (pa_context_notify_cb_t
) o
->callback
;
1004 cb(o
->context
, o
->userdata
);
1007 pa_operation_done(o
);
1008 pa_operation_unref(o
);
1012 pa_operation
* pa_context_drain(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
1016 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1018 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1019 PA_CHECK_VALIDITY_RETURN_NULL(c
, pa_context_is_pending(c
), PA_ERR_BADSTATE
);
1021 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1022 set_dispatch_callbacks(pa_operation_ref(o
));
1027 void pa_context_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1028 pa_operation
*o
= userdata
;
1033 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
1038 if (command
!= PA_COMMAND_REPLY
) {
1039 if (pa_context_handle_error(o
->context
, command
, t
, FALSE
) < 0)
1043 } else if (!pa_tagstruct_eof(t
)) {
1044 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
1049 pa_context_success_cb_t cb
= (pa_context_success_cb_t
) o
->callback
;
1050 cb(o
->context
, success
, o
->userdata
);
1054 pa_operation_done(o
);
1055 pa_operation_unref(o
);
1058 pa_operation
* pa_context_send_simple_command(pa_context
*c
, uint32_t command
, pa_pdispatch_cb_t internal_cb
, pa_operation_cb_t cb
, void *userdata
) {
1064 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1066 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1068 o
= pa_operation_new(c
, NULL
, cb
, userdata
);
1070 t
= pa_tagstruct_command(c
, command
, &tag
);
1071 pa_pstream_send_tagstruct(c
->pstream
, t
);
1072 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, internal_cb
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1077 pa_operation
* pa_context_exit_daemon(pa_context
*c
, pa_context_success_cb_t cb
, void *userdata
) {
1079 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1081 return pa_context_send_simple_command(c
, PA_COMMAND_EXIT
, pa_context_simple_ack_callback
, (pa_operation_cb_t
) cb
, userdata
);
1084 pa_operation
* pa_context_set_default_sink(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1090 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1092 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1094 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1095 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SINK
, &tag
);
1096 pa_tagstruct_puts(t
, name
);
1097 pa_pstream_send_tagstruct(c
->pstream
, t
);
1098 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_context_simple_ack_callback
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1103 pa_operation
* pa_context_set_default_source(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1109 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1111 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1113 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1114 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SOURCE
, &tag
);
1115 pa_tagstruct_puts(t
, name
);
1116 pa_pstream_send_tagstruct(c
->pstream
, t
);
1117 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_context_simple_ack_callback
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1122 int pa_context_is_local(pa_context
*c
) {
1124 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1126 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, -1);
1128 return !!c
->is_local
;
1131 pa_operation
* pa_context_set_name(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1135 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1138 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1140 if (c
->version
>= 13) {
1141 pa_proplist
*p
= pa_proplist_new();
1143 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, name
);
1144 o
= pa_context_proplist_update(c
, PA_UPDATE_REPLACE
, p
, cb
, userdata
);
1145 pa_proplist_free(p
);
1150 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1151 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
1152 pa_tagstruct_puts(t
, name
);
1153 pa_pstream_send_tagstruct(c
->pstream
, t
);
1154 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_context_simple_ack_callback
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1160 const char* pa_get_library_version(void) {
1161 return PACKAGE_VERSION
;
1164 const char* pa_context_get_server(pa_context
*c
) {
1166 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1171 if (*c
->server
== '{') {
1172 char *e
= strchr(c
->server
+1, '}');
1173 return e
? e
+1 : c
->server
;
1179 uint32_t pa_context_get_protocol_version(PA_GCC_UNUSED pa_context
*c
) {
1180 return PA_PROTOCOL_VERSION
;
1183 uint32_t pa_context_get_server_protocol_version(pa_context
*c
) {
1185 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1187 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1192 pa_tagstruct
*pa_tagstruct_command(pa_context
*c
, uint32_t command
, uint32_t *tag
) {
1198 t
= pa_tagstruct_new(NULL
, 0);
1199 pa_tagstruct_putu32(t
, command
);
1200 pa_tagstruct_putu32(t
, *tag
= c
->ctag
++);
1205 uint32_t pa_context_get_index(pa_context
*c
) {
1207 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1209 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1210 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
, PA_INVALID_INDEX
);
1212 return c
->client_index
;
1215 pa_operation
*pa_context_proplist_update(pa_context
*c
, pa_update_mode_t mode
, pa_proplist
*p
, pa_context_success_cb_t cb
, void *userdata
) {
1221 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1223 PA_CHECK_VALIDITY_RETURN_NULL(c
, mode
== PA_UPDATE_SET
|| mode
== PA_UPDATE_MERGE
|| mode
== PA_UPDATE_REPLACE
, PA_ERR_INVALID
);
1224 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1225 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1227 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1229 t
= pa_tagstruct_command(c
, PA_COMMAND_UPDATE_CLIENT_PROPLIST
, &tag
);
1230 pa_tagstruct_putu32(t
, (uint32_t) mode
);
1231 pa_tagstruct_put_proplist(t
, p
);
1233 pa_pstream_send_tagstruct(c
->pstream
, t
);
1234 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_context_simple_ack_callback
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1236 /* Please note that we don't update c->proplist here, because we
1237 * don't export that field */
1242 pa_operation
*pa_context_proplist_remove(pa_context
*c
, const char *const keys
[], pa_context_success_cb_t cb
, void *userdata
) {
1246 const char * const *k
;
1249 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1251 PA_CHECK_VALIDITY_RETURN_NULL(c
, keys
&& keys
[0], PA_ERR_INVALID
);
1252 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1253 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1255 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1257 t
= pa_tagstruct_command(c
, PA_COMMAND_REMOVE_CLIENT_PROPLIST
, &tag
);
1259 for (k
= keys
; *k
; k
++)
1260 pa_tagstruct_puts(t
, *k
);
1262 pa_tagstruct_puts(t
, NULL
);
1264 pa_pstream_send_tagstruct(c
->pstream
, t
);
1265 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_context_simple_ack_callback
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1267 /* Please note that we don't update c->proplist here, because we
1268 * don't export that field */
1273 void pa_command_extension(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1274 pa_context
*c
= userdata
;
1279 pa_assert(command
== PA_COMMAND_EXTENSION
);
1282 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1286 if (pa_tagstruct_getu32(t
, &idx
) < 0 ||
1287 pa_tagstruct_gets(t
, &name
) < 0) {
1288 pa_context_fail(c
, PA_ERR_PROTOCOL
);
1292 if (!strcmp(name
, "module-stream-restore"))
1293 pa_ext_stream_restore_command(c
, tag
, t
);
1295 pa_log(_("Received message for unknown extension '%s'"), name
);
1298 pa_context_unref(c
);