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 void pa_command_extension(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
86 static const pa_pdispatch_cb_t command_table
[PA_COMMAND_MAX
] = {
87 [PA_COMMAND_REQUEST
] = pa_command_request
,
88 [PA_COMMAND_OVERFLOW
] = pa_command_overflow_or_underflow
,
89 [PA_COMMAND_UNDERFLOW
] = pa_command_overflow_or_underflow
,
90 [PA_COMMAND_PLAYBACK_STREAM_KILLED
] = pa_command_stream_killed
,
91 [PA_COMMAND_RECORD_STREAM_KILLED
] = pa_command_stream_killed
,
92 [PA_COMMAND_PLAYBACK_STREAM_MOVED
] = pa_command_stream_moved
,
93 [PA_COMMAND_RECORD_STREAM_MOVED
] = pa_command_stream_moved
,
94 [PA_COMMAND_PLAYBACK_STREAM_SUSPENDED
] = pa_command_stream_suspended
,
95 [PA_COMMAND_RECORD_STREAM_SUSPENDED
] = pa_command_stream_suspended
,
96 [PA_COMMAND_STARTED
] = pa_command_stream_started
,
97 [PA_COMMAND_SUBSCRIBE_EVENT
] = pa_command_subscribe_event
,
98 [PA_COMMAND_EXTENSION
] = pa_command_extension
100 static void context_free(pa_context
*c
);
102 pa_context
*pa_context_new(pa_mainloop_api
*mainloop
, const char *name
) {
103 return pa_context_new_with_proplist(mainloop
, name
, NULL
);
106 static void reset_callbacks(pa_context
*c
) {
109 c
->state_callback
= NULL
;
110 c
->state_userdata
= NULL
;
112 c
->subscribe_callback
= NULL
;
113 c
->subscribe_userdata
= NULL
;
115 c
->ext_stream_restore
.callback
= NULL
;
116 c
->ext_stream_restore
.userdata
= NULL
;
119 pa_context
*pa_context_new_with_proplist(pa_mainloop_api
*mainloop
, const char *name
, pa_proplist
*p
) {
126 if (!name
&& !pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
))
129 c
= pa_xnew(pa_context
, 1);
132 c
->proplist
= p
? pa_proplist_copy(p
) : pa_proplist_new();
135 pa_proplist_sets(c
->proplist
, PA_PROP_APPLICATION_NAME
, name
);
137 c
->mainloop
= mainloop
;
141 c
->playback_streams
= pa_dynarray_new();
142 c
->record_streams
= pa_dynarray_new();
143 c
->client_index
= PA_INVALID_INDEX
;
145 PA_LLIST_HEAD_INIT(pa_stream
, c
->streams
);
146 PA_LLIST_HEAD_INIT(pa_operation
, c
->operations
);
149 c
->state
= PA_CONTEXT_UNCONNECTED
;
156 c
->server_list
= NULL
;
161 c
->do_autospawn
= FALSE
;
162 memset(&c
->spawn_api
, 0, sizeof(c
->spawn_api
));
166 pa_check_signal_is_blocked(SIGPIPE
);
170 c
->conf
= pa_client_conf_new();
172 pa_client_conf_from_x11(c
->conf
, NULL
);
174 pa_client_conf_load(c
->conf
, NULL
);
175 pa_client_conf_env(c
->conf
);
177 if (!(c
->mempool
= pa_mempool_new(!c
->conf
->disable_shm
, c
->conf
->shm_size
))) {
179 if (!c
->conf
->disable_shm
)
180 c
->mempool
= pa_mempool_new(FALSE
, c
->conf
->shm_size
);
191 static void context_unlink(pa_context
*c
) {
196 s
= c
->streams
? pa_stream_ref(c
->streams
) : NULL
;
198 pa_stream
*n
= s
->next
? pa_stream_ref(s
->next
) : NULL
;
199 pa_stream_set_state(s
, c
->state
== PA_CONTEXT_FAILED
? PA_STREAM_FAILED
: PA_STREAM_TERMINATED
);
204 while (c
->operations
)
205 pa_operation_cancel(c
->operations
);
208 pa_pdispatch_unref(c
->pdispatch
);
213 pa_pstream_unlink(c
->pstream
);
214 pa_pstream_unref(c
->pstream
);
219 pa_socket_client_unref(c
->client
);
226 static void context_free(pa_context
*c
) {
231 if (c
->record_streams
)
232 pa_dynarray_free(c
->record_streams
, NULL
, NULL
);
233 if (c
->playback_streams
)
234 pa_dynarray_free(c
->playback_streams
, NULL
, NULL
);
237 pa_mempool_free(c
->mempool
);
240 pa_client_conf_free(c
->conf
);
242 pa_strlist_free(c
->server_list
);
245 pa_proplist_free(c
->proplist
);
251 pa_context
* pa_context_ref(pa_context
*c
) {
253 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
259 void pa_context_unref(pa_context
*c
) {
261 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
263 if (PA_REFCNT_DEC(c
) <= 0)
267 void pa_context_set_state(pa_context
*c
, pa_context_state_t st
) {
269 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
278 if (c
->state_callback
)
279 c
->state_callback(c
, c
->state_userdata
);
281 if (st
== PA_CONTEXT_FAILED
|| st
== PA_CONTEXT_TERMINATED
)
287 int pa_context_set_error(pa_context
*c
, int error
) {
288 pa_assert(error
>= 0);
289 pa_assert(error
< PA_ERR_MAX
);
297 void pa_context_fail(pa_context
*c
, int error
) {
299 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
301 pa_context_set_error(c
, error
);
302 pa_context_set_state(c
, PA_CONTEXT_FAILED
);
305 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
306 pa_context
*c
= userdata
;
311 pa_context_fail(c
, PA_ERR_CONNECTIONTERMINATED
);
314 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, const pa_creds
*creds
, void *userdata
) {
315 pa_context
*c
= userdata
;
323 if (pa_pdispatch_run(c
->pdispatch
, packet
, creds
, c
) < 0)
324 pa_context_fail(c
, PA_ERR_PROTOCOL
);
329 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
) {
330 pa_context
*c
= userdata
;
335 pa_assert(chunk
->memblock
);
336 pa_assert(chunk
->length
);
338 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
342 if ((s
= pa_dynarray_get(c
->record_streams
, channel
))) {
344 pa_assert(seek
== PA_SEEK_RELATIVE
);
345 pa_assert(offset
== 0);
347 pa_memblockq_seek(s
->record_memblockq
, offset
, seek
);
348 pa_memblockq_push_align(s
->record_memblockq
, chunk
);
350 if (s
->read_callback
) {
353 if ((l
= pa_memblockq_get_length(s
->record_memblockq
)) > 0)
354 s
->read_callback(s
, l
, s
->read_userdata
);
361 int pa_context_handle_error(pa_context
*c
, uint32_t command
, pa_tagstruct
*t
, pa_bool_t fail
) {
364 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
366 if (command
== PA_COMMAND_ERROR
) {
369 if (pa_tagstruct_getu32(t
, &err
) < 0) {
370 pa_context_fail(c
, PA_ERR_PROTOCOL
);
374 } else if (command
== PA_COMMAND_TIMEOUT
)
375 err
= PA_ERR_TIMEOUT
;
377 pa_context_fail(c
, PA_ERR_PROTOCOL
);
382 pa_context_fail(c
, PA_ERR_PROTOCOL
);
386 if (err
>= PA_ERR_MAX
)
387 err
= PA_ERR_UNKNOWN
;
390 pa_context_fail(c
, (int) err
);
394 pa_context_set_error(c
, (int) err
);
399 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
400 pa_context
*c
= userdata
;
404 pa_assert(c
->state
== PA_CONTEXT_AUTHORIZING
|| c
->state
== PA_CONTEXT_SETTING_NAME
);
408 if (command
!= PA_COMMAND_REPLY
) {
409 pa_context_handle_error(c
, command
, t
, TRUE
);
414 case PA_CONTEXT_AUTHORIZING
: {
416 pa_bool_t shm_on_remote
= FALSE
;
418 if (pa_tagstruct_getu32(t
, &c
->version
) < 0 ||
419 !pa_tagstruct_eof(t
)) {
420 pa_context_fail(c
, PA_ERR_PROTOCOL
);
424 /* Minimum supported version */
425 if (c
->version
< 8) {
426 pa_context_fail(c
, PA_ERR_VERSION
);
430 /* Starting with protocol version 13 the MSB of the version
431 tag reflects if shm is available for this connection or
433 if (c
->version
>= 13) {
434 shm_on_remote
= !!(c
->version
& 0x80000000U
);
435 c
->version
&= 0x7FFFFFFFU
;
438 pa_log_debug("Protocol version: remote %u, local %u", c
->version
, PA_PROTOCOL_VERSION
);
440 /* Enable shared memory support if possible */
442 if (c
->version
< 10 || (c
->version
>= 13 && !shm_on_remote
))
447 /* Only enable SHM if both sides are owned by the same
448 * user. This is a security measure because otherwise
449 * data private to the user might leak. */
452 const pa_creds
*creds
;
453 if (!(creds
= pa_pdispatch_creds(pd
)) || getuid() != creds
->uid
)
458 pa_log_debug("Negotiated SHM: %s", pa_yes_no(c
->do_shm
));
459 pa_pstream_enable_shm(c
->pstream
, c
->do_shm
);
461 reply
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
463 if (c
->version
>= 13) {
464 pa_init_proplist(c
->proplist
);
465 pa_tagstruct_put_proplist(reply
, c
->proplist
);
467 pa_tagstruct_puts(reply
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
469 pa_pstream_send_tagstruct(c
->pstream
, reply
);
470 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
472 pa_context_set_state(c
, PA_CONTEXT_SETTING_NAME
);
476 case PA_CONTEXT_SETTING_NAME
:
478 if ((c
->version
>= 13 && (pa_tagstruct_getu32(t
, &c
->client_index
) < 0 ||
479 c
->client_index
== PA_INVALID_INDEX
)) ||
480 !pa_tagstruct_eof(t
)) {
481 pa_context_fail(c
, PA_ERR_PROTOCOL
);
485 pa_context_set_state(c
, PA_CONTEXT_READY
);
489 pa_assert_not_reached();
496 static void setup_context(pa_context
*c
, pa_iochannel
*io
) {
505 pa_assert(!c
->pstream
);
506 c
->pstream
= pa_pstream_new(c
->mainloop
, io
, c
->mempool
);
508 pa_pstream_set_die_callback(c
->pstream
, pstream_die_callback
, c
);
509 pa_pstream_set_recieve_packet_callback(c
->pstream
, pstream_packet_callback
, c
);
510 pa_pstream_set_recieve_memblock_callback(c
->pstream
, pstream_memblock_callback
, c
);
512 pa_assert(!c
->pdispatch
);
513 c
->pdispatch
= pa_pdispatch_new(c
->mainloop
, command_table
, PA_COMMAND_MAX
);
515 if (!c
->conf
->cookie_valid
)
516 pa_log_info(_("No cookie loaded. Attempting to connect without."));
518 t
= pa_tagstruct_command(c
, PA_COMMAND_AUTH
, &tag
);
521 pa_mempool_is_shared(c
->mempool
) &&
524 pa_log_debug("SHM possible: %s", pa_yes_no(c
->do_shm
));
526 /* Starting with protocol version 13 we use the MSB of the version
527 * tag for informing the other side if we could do SHM or not */
528 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
| (c
->do_shm
? 0x80000000U
: 0));
529 pa_tagstruct_put_arbitrary(t
, c
->conf
->cookie
, sizeof(c
->conf
->cookie
));
535 if (pa_iochannel_creds_supported(io
))
536 pa_iochannel_creds_enable(io
);
538 ucred
.uid
= getuid();
539 ucred
.gid
= getgid();
541 pa_pstream_send_tagstruct_with_creds(c
->pstream
, t
, &ucred
);
544 pa_pstream_send_tagstruct(c
->pstream
, t
);
547 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
549 pa_context_set_state(c
, PA_CONTEXT_AUTHORIZING
);
554 static char *get_old_legacy_runtime_dir(void) {
558 if (!pa_get_user_name(u
, sizeof(u
)))
561 p
= pa_sprintf_malloc("/tmp/pulse-%s", u
);
563 if (stat(p
, &st
) < 0) {
568 if (st
.st_uid
!= getuid()) {
576 static char *get_very_old_legacy_runtime_dir(void) {
580 if (!pa_get_home_dir(h
, sizeof(h
)))
583 p
= pa_sprintf_malloc("%s/.pulse", h
);
585 if (stat(p
, &st
) < 0) {
590 if (st
.st_uid
!= getuid()) {
599 static pa_strlist
*prepend_per_user(pa_strlist
*l
) {
601 static char *legacy_dir
;
603 /* The very old per-user instance path (< 0.9.11). This is supported only to ease upgrades */
604 if ((legacy_dir
= get_very_old_legacy_runtime_dir())) {
605 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
606 l
= pa_strlist_prepend(l
, p
);
608 pa_xfree(legacy_dir
);
611 /* The old per-user instance path (< 0.9.12). This is supported only to ease upgrades */
612 if ((legacy_dir
= get_old_legacy_runtime_dir())) {
613 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
614 l
= pa_strlist_prepend(l
, p
);
616 pa_xfree(legacy_dir
);
619 /* The per-user instance */
620 if ((ufn
= pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET
))) {
621 l
= pa_strlist_prepend(l
, ufn
);
630 static int context_autospawn(pa_context
*c
) {
634 pa_log_debug("Trying to autospawn...");
638 if (c
->spawn_api
.prefork
)
639 c
->spawn_api
.prefork();
641 if ((pid
= fork()) < 0) {
642 pa_log_error(_("fork(): %s"), pa_cstrerror(errno
));
643 pa_context_fail(c
, PA_ERR_INTERNAL
);
645 if (c
->spawn_api
.postfork
)
646 c
->spawn_api
.postfork();
652 const char *state
= NULL
;
654 const char * argv
[MAX_ARGS
+1];
657 if (c
->spawn_api
.atfork
)
658 c
->spawn_api
.atfork();
666 argv
[n
++] = c
->conf
->daemon_binary
;
667 argv
[n
++] = "--start";
669 while (n
< MAX_ARGS
) {
672 if (!(a
= pa_split_spaces(c
->conf
->extra_arguments
, &state
)))
680 execv(argv
[0], (char * const *) argv
);
687 if (c
->spawn_api
.postfork
)
688 c
->spawn_api
.postfork();
691 r
= waitpid(pid
, &status
, 0);
692 } while (r
< 0 && errno
== EINTR
);
695 pa_log(_("waitpid(): %s"), pa_cstrerror(errno
));
696 pa_context_fail(c
, PA_ERR_INTERNAL
);
698 } else if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
699 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
714 #endif /* OS_IS_WIN32 */
716 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
);
718 static int try_next_connection(pa_context
*c
) {
723 pa_assert(!c
->client
);
729 c
->server_list
= pa_strlist_pop(c
->server_list
, &u
);
734 if (c
->do_autospawn
) {
736 if ((r
= context_autospawn(c
)) < 0)
739 /* Autospawn only once */
740 c
->do_autospawn
= FALSE
;
742 /* Connect only to per-user sockets this time */
743 c
->server_list
= prepend_per_user(c
->server_list
);
745 /* Retry connection */
750 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
754 pa_log_debug("Trying to connect to %s...", u
);
757 c
->server
= pa_xstrdup(u
);
759 if (!(c
->client
= pa_socket_client_new_string(c
->mainloop
, u
, PA_NATIVE_DEFAULT_PORT
)))
762 c
->is_local
= !!pa_socket_client_is_local(c
->client
);
763 pa_socket_client_set_callback(c
->client
, on_connection
, c
);
775 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
) {
776 pa_context
*c
= userdata
;
777 int saved_errno
= errno
;
781 pa_assert(c
->state
== PA_CONTEXT_CONNECTING
);
785 pa_socket_client_unref(client
);
789 /* Try the item in the list */
790 if (saved_errno
== ECONNREFUSED
||
791 saved_errno
== ETIMEDOUT
||
792 saved_errno
== EHOSTUNREACH
) {
793 try_next_connection(c
);
797 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
801 setup_context(c
, io
);
807 int pa_context_connect(
810 pa_context_flags_t flags
,
811 const pa_spawn_api
*api
) {
816 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
818 PA_CHECK_VALIDITY(c
, c
->state
== PA_CONTEXT_UNCONNECTED
, PA_ERR_BADSTATE
);
819 PA_CHECK_VALIDITY(c
, !(flags
& ~PA_CONTEXT_NOAUTOSPAWN
), PA_ERR_INVALID
);
820 PA_CHECK_VALIDITY(c
, !server
|| *server
, PA_ERR_INVALID
);
823 server
= c
->conf
->default_server
;
827 pa_assert(!c
->server_list
);
830 if (!(c
->server_list
= pa_strlist_parse(server
))) {
831 pa_context_fail(c
, PA_ERR_INVALIDSERVER
);
838 /* Prepend in reverse order */
840 /* Follow the X display */
841 if ((d
= getenv("DISPLAY"))) {
844 if ((e
= strchr(d
, ':')))
848 c
->server_list
= pa_strlist_prepend(c
->server_list
, d
);
853 /* Add TCP/IP on the localhost */
854 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp6:[::1]");
855 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp4:127.0.0.1");
857 /* The system wide instance via PF_LOCAL */
858 c
->server_list
= pa_strlist_prepend(c
->server_list
, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
);
860 /* The user instance via PF_LOCAL */
861 c
->server_list
= prepend_per_user(c
->server_list
);
863 /* Set up autospawning */
864 if (!(flags
& PA_CONTEXT_NOAUTOSPAWN
) && c
->conf
->autospawn
) {
867 pa_log_debug("Not doing autospawn since we are root.");
869 c
->do_autospawn
= TRUE
;
877 pa_context_set_state(c
, PA_CONTEXT_CONNECTING
);
878 r
= try_next_connection(c
);
886 void pa_context_disconnect(pa_context
*c
) {
888 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
890 if (PA_CONTEXT_IS_GOOD(c
->state
))
891 pa_context_set_state(c
, PA_CONTEXT_TERMINATED
);
894 pa_context_state_t
pa_context_get_state(pa_context
*c
) {
896 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
901 int pa_context_errno(pa_context
*c
) {
903 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
908 void pa_context_set_state_callback(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
910 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
912 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
915 c
->state_callback
= cb
;
916 c
->state_userdata
= userdata
;
919 int pa_context_is_pending(pa_context
*c
) {
921 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
923 PA_CHECK_VALIDITY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
);
925 return (c
->pstream
&& pa_pstream_is_pending(c
->pstream
)) ||
926 (c
->pdispatch
&& pa_pdispatch_is_pending(c
->pdispatch
)) ||
930 static void set_dispatch_callbacks(pa_operation
*o
);
932 static void pdispatch_drain_callback(pa_pdispatch
*pd
, void *userdata
) {
933 set_dispatch_callbacks(userdata
);
936 static void pstream_drain_callback(pa_pstream
*s
, void *userdata
) {
937 set_dispatch_callbacks(userdata
);
940 static void set_dispatch_callbacks(pa_operation
*o
) {
944 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
945 pa_assert(o
->context
);
946 pa_assert(PA_REFCNT_VALUE(o
->context
) >= 1);
947 pa_assert(o
->context
->state
== PA_CONTEXT_READY
);
949 pa_pstream_set_drain_callback(o
->context
->pstream
, NULL
, NULL
);
950 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, NULL
, NULL
);
952 if (pa_pdispatch_is_pending(o
->context
->pdispatch
)) {
953 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, pdispatch_drain_callback
, o
);
957 if (pa_pstream_is_pending(o
->context
->pstream
)) {
958 pa_pstream_set_drain_callback(o
->context
->pstream
, pstream_drain_callback
, o
);
964 pa_context_notify_cb_t cb
= (pa_context_notify_cb_t
) o
->callback
;
965 cb(o
->context
, o
->userdata
);
968 pa_operation_done(o
);
969 pa_operation_unref(o
);
973 pa_operation
* pa_context_drain(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
977 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
979 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
980 PA_CHECK_VALIDITY_RETURN_NULL(c
, pa_context_is_pending(c
), PA_ERR_BADSTATE
);
982 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
983 set_dispatch_callbacks(pa_operation_ref(o
));
988 void pa_context_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
989 pa_operation
*o
= userdata
;
994 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
999 if (command
!= PA_COMMAND_REPLY
) {
1000 if (pa_context_handle_error(o
->context
, command
, t
, FALSE
) < 0)
1004 } else if (!pa_tagstruct_eof(t
)) {
1005 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
1010 pa_context_success_cb_t cb
= (pa_context_success_cb_t
) o
->callback
;
1011 cb(o
->context
, success
, o
->userdata
);
1015 pa_operation_done(o
);
1016 pa_operation_unref(o
);
1019 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
) {
1025 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1027 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1029 o
= pa_operation_new(c
, NULL
, cb
, userdata
);
1031 t
= pa_tagstruct_command(c
, command
, &tag
);
1032 pa_pstream_send_tagstruct(c
->pstream
, t
);
1033 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, internal_cb
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1038 pa_operation
* pa_context_exit_daemon(pa_context
*c
, pa_context_success_cb_t cb
, void *userdata
) {
1040 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1042 return pa_context_send_simple_command(c
, PA_COMMAND_EXIT
, pa_context_simple_ack_callback
, (pa_operation_cb_t
) cb
, userdata
);
1045 pa_operation
* pa_context_set_default_sink(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1051 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1053 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1055 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1056 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SINK
, &tag
);
1057 pa_tagstruct_puts(t
, name
);
1058 pa_pstream_send_tagstruct(c
->pstream
, t
);
1059 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
);
1064 pa_operation
* pa_context_set_default_source(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1070 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1072 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1074 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1075 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SOURCE
, &tag
);
1076 pa_tagstruct_puts(t
, name
);
1077 pa_pstream_send_tagstruct(c
->pstream
, t
);
1078 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
);
1083 int pa_context_is_local(pa_context
*c
) {
1085 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1087 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, -1);
1089 return !!c
->is_local
;
1092 pa_operation
* pa_context_set_name(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1096 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1099 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1101 if (c
->version
>= 13) {
1102 pa_proplist
*p
= pa_proplist_new();
1104 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, name
);
1105 o
= pa_context_proplist_update(c
, PA_UPDATE_REPLACE
, p
, cb
, userdata
);
1106 pa_proplist_free(p
);
1111 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1112 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
1113 pa_tagstruct_puts(t
, name
);
1114 pa_pstream_send_tagstruct(c
->pstream
, t
);
1115 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
);
1121 const char* pa_get_library_version(void) {
1122 return PACKAGE_VERSION
;
1125 const char* pa_context_get_server(pa_context
*c
) {
1127 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1132 if (*c
->server
== '{') {
1133 char *e
= strchr(c
->server
+1, '}');
1134 return e
? e
+1 : c
->server
;
1140 uint32_t pa_context_get_protocol_version(pa_context
*c
) {
1141 return PA_PROTOCOL_VERSION
;
1144 uint32_t pa_context_get_server_protocol_version(pa_context
*c
) {
1146 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1148 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1153 pa_tagstruct
*pa_tagstruct_command(pa_context
*c
, uint32_t command
, uint32_t *tag
) {
1159 t
= pa_tagstruct_new(NULL
, 0);
1160 pa_tagstruct_putu32(t
, command
);
1161 pa_tagstruct_putu32(t
, *tag
= c
->ctag
++);
1166 uint32_t pa_context_get_index(pa_context
*c
) {
1168 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1170 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1171 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
, PA_INVALID_INDEX
);
1173 return c
->client_index
;
1176 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
) {
1182 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1184 PA_CHECK_VALIDITY_RETURN_NULL(c
, mode
== PA_UPDATE_SET
|| mode
== PA_UPDATE_MERGE
|| mode
== PA_UPDATE_REPLACE
, PA_ERR_INVALID
);
1185 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1186 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1188 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1190 t
= pa_tagstruct_command(c
, PA_COMMAND_UPDATE_CLIENT_PROPLIST
, &tag
);
1191 pa_tagstruct_putu32(t
, (uint32_t) mode
);
1192 pa_tagstruct_put_proplist(t
, p
);
1194 pa_pstream_send_tagstruct(c
->pstream
, t
);
1195 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
);
1197 /* Please note that we don't update c->proplist here, because we
1198 * don't export that field */
1203 pa_operation
*pa_context_proplist_remove(pa_context
*c
, const char *const keys
[], pa_context_success_cb_t cb
, void *userdata
) {
1207 const char * const *k
;
1210 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1212 PA_CHECK_VALIDITY_RETURN_NULL(c
, keys
&& keys
[0], PA_ERR_INVALID
);
1213 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1214 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1216 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1218 t
= pa_tagstruct_command(c
, PA_COMMAND_REMOVE_CLIENT_PROPLIST
, &tag
);
1220 for (k
= keys
; *k
; k
++)
1221 pa_tagstruct_puts(t
, *k
);
1223 pa_tagstruct_puts(t
, NULL
);
1225 pa_pstream_send_tagstruct(c
->pstream
, t
);
1226 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
);
1228 /* Please note that we don't update c->proplist here, because we
1229 * don't export that field */
1234 void pa_command_extension(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1235 pa_context
*c
= userdata
;
1240 pa_assert(command
== PA_COMMAND_EXTENSION
);
1243 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1247 if (pa_tagstruct_getu32(t
, &idx
) < 0 ||
1248 pa_tagstruct_gets(t
, &name
) < 0) {
1249 pa_context_fail(c
, PA_ERR_PROTOCOL
);
1253 if (!strcmp(name
, "module-stream-restore"))
1254 pa_ext_stream_restore_command(c
, tag
, t
);
1256 pa_log(_("Received message for unknown extension '%s'"), name
);
1259 pa_context_unref(c
);