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>
57 #include <pulsecore/winsock.h>
58 #include <pulsecore/core-error.h>
60 #include <pulsecore/native-common.h>
61 #include <pulsecore/pdispatch.h>
62 #include <pulsecore/pstream.h>
63 #include <pulsecore/dynarray.h>
64 #include <pulsecore/socket-client.h>
65 #include <pulsecore/pstream-util.h>
66 #include <pulsecore/core-util.h>
67 #include <pulsecore/log.h>
68 #include <pulsecore/socket-util.h>
69 #include <pulsecore/creds.h>
70 #include <pulsecore/macro.h>
71 #include <pulsecore/proplist-util.h>
75 #include "client-conf.h"
78 #include "client-conf-x11.h"
83 #define AUTOSPAWN_LOCK "autospawn.lock"
85 static const pa_pdispatch_cb_t command_table
[PA_COMMAND_MAX
] = {
86 [PA_COMMAND_REQUEST
] = pa_command_request
,
87 [PA_COMMAND_OVERFLOW
] = pa_command_overflow_or_underflow
,
88 [PA_COMMAND_UNDERFLOW
] = pa_command_overflow_or_underflow
,
89 [PA_COMMAND_PLAYBACK_STREAM_KILLED
] = pa_command_stream_killed
,
90 [PA_COMMAND_RECORD_STREAM_KILLED
] = pa_command_stream_killed
,
91 [PA_COMMAND_PLAYBACK_STREAM_MOVED
] = pa_command_stream_moved
,
92 [PA_COMMAND_RECORD_STREAM_MOVED
] = pa_command_stream_moved
,
93 [PA_COMMAND_PLAYBACK_STREAM_SUSPENDED
] = pa_command_stream_suspended
,
94 [PA_COMMAND_RECORD_STREAM_SUSPENDED
] = pa_command_stream_suspended
,
95 [PA_COMMAND_STARTED
] = pa_command_stream_started
,
96 [PA_COMMAND_SUBSCRIBE_EVENT
] = pa_command_subscribe_event
99 static void unlock_autospawn_lock_file(pa_context
*c
) {
102 if (c
->autospawn_lock_fd
>= 0) {
105 if (!(lf
= pa_runtime_path(AUTOSPAWN_LOCK
)))
106 pa_log_warn("Cannot unlock autospawn because runtime path is no more.");
108 pa_unlock_lockfile(lf
, c
->autospawn_lock_fd
);
111 c
->autospawn_lock_fd
= -1;
115 static void context_free(pa_context
*c
);
117 pa_context
*pa_context_new(pa_mainloop_api
*mainloop
, const char *name
) {
118 return pa_context_new_with_proplist(mainloop
, name
, NULL
);
121 static void reset_callbacks(pa_context
*c
) {
124 c
->state_callback
= NULL
;
125 c
->state_userdata
= NULL
;
127 c
->subscribe_callback
= NULL
;
128 c
->subscribe_userdata
= NULL
;
131 pa_context
*pa_context_new_with_proplist(pa_mainloop_api
*mainloop
, const char *name
, pa_proplist
*p
) {
136 if (!name
&& !pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
))
139 c
= pa_xnew(pa_context
, 1);
142 c
->proplist
= p
? pa_proplist_copy(p
) : pa_proplist_new();
145 pa_proplist_sets(c
->proplist
, PA_PROP_APPLICATION_NAME
, name
);
147 c
->mainloop
= mainloop
;
151 c
->playback_streams
= pa_dynarray_new();
152 c
->record_streams
= pa_dynarray_new();
153 c
->client_index
= PA_INVALID_INDEX
;
155 PA_LLIST_HEAD_INIT(pa_stream
, c
->streams
);
156 PA_LLIST_HEAD_INIT(pa_operation
, c
->operations
);
159 c
->state
= PA_CONTEXT_UNCONNECTED
;
166 c
->server_list
= NULL
;
168 c
->autospawn_lock_fd
= -1;
169 memset(&c
->spawn_api
, 0, sizeof(c
->spawn_api
));
170 c
->do_autospawn
= FALSE
;
175 pa_check_signal_is_blocked(SIGPIPE
);
179 c
->conf
= pa_client_conf_new();
181 pa_client_conf_from_x11(c
->conf
, NULL
);
183 pa_client_conf_load(c
->conf
, NULL
);
184 pa_client_conf_env(c
->conf
);
186 if (!(c
->mempool
= pa_mempool_new(!c
->conf
->disable_shm
))) {
188 if (!c
->conf
->disable_shm
)
189 c
->mempool
= pa_mempool_new(0);
200 static void context_unlink(pa_context
*c
) {
205 s
= c
->streams
? pa_stream_ref(c
->streams
) : NULL
;
207 pa_stream
*n
= s
->next
? pa_stream_ref(s
->next
) : NULL
;
208 pa_stream_set_state(s
, c
->state
== PA_CONTEXT_FAILED
? PA_STREAM_FAILED
: PA_STREAM_TERMINATED
);
213 while (c
->operations
)
214 pa_operation_cancel(c
->operations
);
217 pa_pdispatch_unref(c
->pdispatch
);
222 pa_pstream_unlink(c
->pstream
);
223 pa_pstream_unref(c
->pstream
);
228 pa_socket_client_unref(c
->client
);
235 static void context_free(pa_context
*c
) {
240 unlock_autospawn_lock_file(c
);
242 if (c
->record_streams
)
243 pa_dynarray_free(c
->record_streams
, NULL
, NULL
);
244 if (c
->playback_streams
)
245 pa_dynarray_free(c
->playback_streams
, NULL
, NULL
);
248 pa_mempool_free(c
->mempool
);
251 pa_client_conf_free(c
->conf
);
253 pa_strlist_free(c
->server_list
);
256 pa_proplist_free(c
->proplist
);
262 pa_context
* pa_context_ref(pa_context
*c
) {
264 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
270 void pa_context_unref(pa_context
*c
) {
272 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
274 if (PA_REFCNT_DEC(c
) <= 0)
278 void pa_context_set_state(pa_context
*c
, pa_context_state_t st
) {
280 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
289 if (c
->state_callback
)
290 c
->state_callback(c
, c
->state_userdata
);
292 if (st
== PA_CONTEXT_FAILED
|| st
== PA_CONTEXT_TERMINATED
)
298 int pa_context_set_error(pa_context
*c
, int error
) {
299 pa_assert(error
>= 0);
300 pa_assert(error
< PA_ERR_MAX
);
308 void pa_context_fail(pa_context
*c
, int error
) {
310 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
312 pa_context_set_error(c
, error
);
313 pa_context_set_state(c
, PA_CONTEXT_FAILED
);
316 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
317 pa_context
*c
= userdata
;
322 pa_context_fail(c
, PA_ERR_CONNECTIONTERMINATED
);
325 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, const pa_creds
*creds
, void *userdata
) {
326 pa_context
*c
= userdata
;
334 if (pa_pdispatch_run(c
->pdispatch
, packet
, creds
, c
) < 0)
335 pa_context_fail(c
, PA_ERR_PROTOCOL
);
340 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
) {
341 pa_context
*c
= userdata
;
346 pa_assert(chunk
->memblock
);
347 pa_assert(chunk
->length
);
349 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
353 if ((s
= pa_dynarray_get(c
->record_streams
, channel
))) {
355 pa_assert(seek
== PA_SEEK_RELATIVE
);
356 pa_assert(offset
== 0);
358 pa_memblockq_seek(s
->record_memblockq
, offset
, seek
);
359 pa_memblockq_push_align(s
->record_memblockq
, chunk
);
361 if (s
->read_callback
) {
364 if ((l
= pa_memblockq_get_length(s
->record_memblockq
)) > 0)
365 s
->read_callback(s
, l
, s
->read_userdata
);
372 int pa_context_handle_error(pa_context
*c
, uint32_t command
, pa_tagstruct
*t
, pa_bool_t fail
) {
375 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
377 if (command
== PA_COMMAND_ERROR
) {
380 if (pa_tagstruct_getu32(t
, &err
) < 0) {
381 pa_context_fail(c
, PA_ERR_PROTOCOL
);
385 } else if (command
== PA_COMMAND_TIMEOUT
)
386 err
= PA_ERR_TIMEOUT
;
388 pa_context_fail(c
, PA_ERR_PROTOCOL
);
393 pa_context_fail(c
, PA_ERR_PROTOCOL
);
397 if (err
>= PA_ERR_MAX
)
398 err
= PA_ERR_UNKNOWN
;
401 pa_context_fail(c
, err
);
405 pa_context_set_error(c
, err
);
410 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
411 pa_context
*c
= userdata
;
415 pa_assert(c
->state
== PA_CONTEXT_AUTHORIZING
|| c
->state
== PA_CONTEXT_SETTING_NAME
);
419 if (command
!= PA_COMMAND_REPLY
) {
420 pa_context_handle_error(c
, command
, t
, TRUE
);
425 case PA_CONTEXT_AUTHORIZING
: {
427 pa_bool_t shm_on_remote
;
429 if (pa_tagstruct_getu32(t
, &c
->version
) < 0 ||
430 !pa_tagstruct_eof(t
)) {
431 pa_context_fail(c
, PA_ERR_PROTOCOL
);
435 /* Minimum supported version */
436 if (c
->version
< 8) {
437 pa_context_fail(c
, PA_ERR_VERSION
);
441 /* Starting with protocol version 13 the MSB of the version
442 tag reflects if shm is available for this connection or
444 if (c
->version
>= 13) {
445 shm_on_remote
= !!(c
->version
& 0x80000000U
);
446 c
->version
&= 0x7FFFFFFFU
;
449 pa_log_debug("Protocol version: remote %u, local %u", c
->version
, PA_PROTOCOL_VERSION
);
451 /* Enable shared memory support if possible */
453 if (c
->version
< 10 || (c
->version
>= 13 && !shm_on_remote
))
458 /* Only enable SHM if both sides are owned by the same
459 * user. This is a security measure because otherwise
460 * data private to the user might leak. */
463 const pa_creds
*creds
;
464 if (!(creds
= pa_pdispatch_creds(pd
)) || getuid() != creds
->uid
)
469 pa_log_debug("Negotiated SHM: %s", pa_yes_no(c
->do_shm
));
470 pa_pstream_enable_shm(c
->pstream
, c
->do_shm
);
472 reply
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
474 if (c
->version
>= 13) {
475 pa_init_proplist(c
->proplist
);
476 pa_tagstruct_put_proplist(reply
, c
->proplist
);
478 pa_tagstruct_puts(reply
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
480 pa_pstream_send_tagstruct(c
->pstream
, reply
);
481 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
483 pa_context_set_state(c
, PA_CONTEXT_SETTING_NAME
);
487 case PA_CONTEXT_SETTING_NAME
:
489 if ((c
->version
>= 13 && (pa_tagstruct_getu32(t
, &c
->client_index
) < 0 ||
490 c
->client_index
== PA_INVALID_INDEX
)) ||
491 !pa_tagstruct_eof(t
)) {
492 pa_context_fail(c
, PA_ERR_PROTOCOL
);
496 pa_context_set_state(c
, PA_CONTEXT_READY
);
500 pa_assert_not_reached();
507 static void setup_context(pa_context
*c
, pa_iochannel
*io
) {
516 pa_assert(!c
->pstream
);
517 c
->pstream
= pa_pstream_new(c
->mainloop
, io
, c
->mempool
);
519 pa_pstream_set_die_callback(c
->pstream
, pstream_die_callback
, c
);
520 pa_pstream_set_recieve_packet_callback(c
->pstream
, pstream_packet_callback
, c
);
521 pa_pstream_set_recieve_memblock_callback(c
->pstream
, pstream_memblock_callback
, c
);
523 pa_assert(!c
->pdispatch
);
524 c
->pdispatch
= pa_pdispatch_new(c
->mainloop
, command_table
, PA_COMMAND_MAX
);
526 if (!c
->conf
->cookie_valid
)
527 pa_log_info("No cookie loaded. Attempting to connect without.");
529 t
= pa_tagstruct_command(c
, PA_COMMAND_AUTH
, &tag
);
532 pa_mempool_is_shared(c
->mempool
) &&
535 pa_log_debug("SHM possible: %s", pa_yes_no(c
->do_shm
));
537 /* Starting with protocol version 13 we use the MSB of the version
538 * tag for informing the other side if we could do SHM or not */
539 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
| (c
->do_shm
? 0x80000000U
: 0));
540 pa_tagstruct_put_arbitrary(t
, c
->conf
->cookie
, sizeof(c
->conf
->cookie
));
546 if (pa_iochannel_creds_supported(io
))
547 pa_iochannel_creds_enable(io
);
549 ucred
.uid
= getuid();
550 ucred
.gid
= getgid();
552 pa_pstream_send_tagstruct_with_creds(c
->pstream
, t
, &ucred
);
555 pa_pstream_send_tagstruct(c
->pstream
, t
);
558 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
560 pa_context_set_state(c
, PA_CONTEXT_AUTHORIZING
);
565 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
);
569 static int context_connect_spawn(pa_context
*c
) {
572 int fds
[2] = { -1, -1} ;
580 if (socketpair(AF_UNIX
, SOCK_STREAM
, 0, fds
) < 0) {
581 pa_log_error("socketpair(): %s", pa_cstrerror(errno
));
582 pa_context_fail(c
, PA_ERR_INTERNAL
);
586 pa_make_fd_cloexec(fds
[0]);
588 pa_make_socket_low_delay(fds
[0]);
589 pa_make_socket_low_delay(fds
[1]);
591 if (c
->spawn_api
.prefork
)
592 c
->spawn_api
.prefork();
594 if ((pid
= fork()) < 0) {
595 pa_log_error("fork(): %s", pa_cstrerror(errno
));
596 pa_context_fail(c
, PA_ERR_INTERNAL
);
598 if (c
->spawn_api
.postfork
)
599 c
->spawn_api
.postfork();
606 const char *state
= NULL
;
608 const char * argv
[MAX_ARGS
+1];
612 pa_close_all(fds
[1], -1);
614 f
= pa_sprintf_malloc("%i", fds
[1]);
615 pa_set_env("PULSE_PASSED_FD", f
);
618 if (c
->spawn_api
.atfork
)
619 c
->spawn_api
.atfork();
625 argv
[n
++] = c
->conf
->daemon_binary
;
626 argv
[n
++] = "--daemonize=yes";
628 pa_snprintf(t
, sizeof(t
), "-Lmodule-native-protocol-fd fd=%i", fds
[1]);
629 argv
[n
++] = strdup(t
);
631 while (n
< MAX_ARGS
) {
634 if (!(a
= pa_split_spaces(c
->conf
->extra_arguments
, &state
)))
642 execv(argv
[0], (char * const *) argv
);
649 pa_assert_se(pa_close(fds
[1]) == 0);
652 r
= waitpid(pid
, &status
, 0);
654 if (c
->spawn_api
.postfork
)
655 c
->spawn_api
.postfork();
658 pa_log("waitpid(): %s", pa_cstrerror(errno
));
659 pa_context_fail(c
, PA_ERR_INTERNAL
);
661 } else if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
662 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
668 unlock_autospawn_lock_file(c
);
670 io
= pa_iochannel_new(c
->mainloop
, fds
[0], fds
[0]);
671 setup_context(c
, io
);
680 unlock_autospawn_lock_file(c
);
687 #endif /* OS_IS_WIN32 */
689 static int try_next_connection(pa_context
*c
) {
694 pa_assert(!c
->client
);
700 c
->server_list
= pa_strlist_pop(c
->server_list
, &u
);
705 if (c
->do_autospawn
) {
706 r
= context_connect_spawn(c
);
711 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
715 pa_log_debug("Trying to connect to %s...", u
);
718 c
->server
= pa_xstrdup(u
);
720 if (!(c
->client
= pa_socket_client_new_string(c
->mainloop
, u
, PA_NATIVE_DEFAULT_PORT
)))
723 c
->is_local
= !!pa_socket_client_is_local(c
->client
);
724 pa_socket_client_set_callback(c
->client
, on_connection
, c
);
736 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
) {
737 pa_context
*c
= userdata
;
738 int saved_errno
= errno
;
742 pa_assert(c
->state
== PA_CONTEXT_CONNECTING
);
746 pa_socket_client_unref(client
);
750 /* Try the item in the list */
751 if (saved_errno
== ECONNREFUSED
||
752 saved_errno
== ETIMEDOUT
||
753 saved_errno
== EHOSTUNREACH
) {
754 try_next_connection(c
);
758 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
762 unlock_autospawn_lock_file(c
);
763 setup_context(c
, io
);
770 static char *get_legacy_runtime_dir(void) {
774 if (!pa_get_user_name(u
, sizeof(u
)))
777 p
= pa_sprintf_malloc("/tmp/pulse-%s", u
);
779 if (stat(p
, &st
) < 0) {
784 if (st
.st_uid
!= getuid()) {
792 int pa_context_connect(
795 pa_context_flags_t flags
,
796 const pa_spawn_api
*api
) {
801 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
803 PA_CHECK_VALIDITY(c
, c
->state
== PA_CONTEXT_UNCONNECTED
, PA_ERR_BADSTATE
);
804 PA_CHECK_VALIDITY(c
, !(flags
& ~PA_CONTEXT_NOAUTOSPAWN
), PA_ERR_INVALID
);
805 PA_CHECK_VALIDITY(c
, !server
|| *server
, PA_ERR_INVALID
);
808 server
= c
->conf
->default_server
;
812 pa_assert(!c
->server_list
);
815 if (!(c
->server_list
= pa_strlist_parse(server
))) {
816 pa_context_fail(c
, PA_ERR_INVALIDSERVER
);
821 static char *legacy_dir
;
823 /* Prepend in reverse order */
825 if ((d
= getenv("DISPLAY"))) {
828 if ((e
= strchr(d
, ':')))
832 c
->server_list
= pa_strlist_prepend(c
->server_list
, d
);
837 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp6:localhost");
838 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp4:localhost");
840 /* The system wide instance */
841 c
->server_list
= pa_strlist_prepend(c
->server_list
, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
);
843 /* The old per-user instance path. This is supported only to ease upgrades */
844 if ((legacy_dir
= get_legacy_runtime_dir())) {
845 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
846 c
->server_list
= pa_strlist_prepend(c
->server_list
, p
);
848 pa_xfree(legacy_dir
);
851 /* The per-user instance */
852 if ((ufn
= pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET
))) {
853 c
->server_list
= pa_strlist_prepend(c
->server_list
, ufn
);
857 /* Wrap the connection attempts in a single transaction for sane autospawn locking */
858 if (!(flags
& PA_CONTEXT_NOAUTOSPAWN
) && c
->conf
->autospawn
) {
861 lf
= pa_runtime_path(AUTOSPAWN_LOCK
);
862 pa_assert(c
->autospawn_lock_fd
<= 0);
863 c
->autospawn_lock_fd
= pa_lock_lockfile(lf
);
869 c
->do_autospawn
= TRUE
;
873 pa_context_set_state(c
, PA_CONTEXT_CONNECTING
);
874 r
= try_next_connection(c
);
882 void pa_context_disconnect(pa_context
*c
) {
884 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
886 if (PA_CONTEXT_IS_GOOD(c
->state
))
887 pa_context_set_state(c
, PA_CONTEXT_TERMINATED
);
890 pa_context_state_t
pa_context_get_state(pa_context
*c
) {
892 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
897 int pa_context_errno(pa_context
*c
) {
899 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
904 void pa_context_set_state_callback(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
906 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
908 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
911 c
->state_callback
= cb
;
912 c
->state_userdata
= userdata
;
915 int pa_context_is_pending(pa_context
*c
) {
917 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
919 PA_CHECK_VALIDITY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
);
921 return (c
->pstream
&& pa_pstream_is_pending(c
->pstream
)) ||
922 (c
->pdispatch
&& pa_pdispatch_is_pending(c
->pdispatch
)) ||
926 static void set_dispatch_callbacks(pa_operation
*o
);
928 static void pdispatch_drain_callback(PA_GCC_UNUSED pa_pdispatch
*pd
, void *userdata
) {
929 set_dispatch_callbacks(userdata
);
932 static void pstream_drain_callback(PA_GCC_UNUSED pa_pstream
*s
, void *userdata
) {
933 set_dispatch_callbacks(userdata
);
936 static void set_dispatch_callbacks(pa_operation
*o
) {
940 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
941 pa_assert(o
->context
);
942 pa_assert(PA_REFCNT_VALUE(o
->context
) >= 1);
943 pa_assert(o
->context
->state
== PA_CONTEXT_READY
);
945 pa_pstream_set_drain_callback(o
->context
->pstream
, NULL
, NULL
);
946 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, NULL
, NULL
);
948 if (pa_pdispatch_is_pending(o
->context
->pdispatch
)) {
949 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, pdispatch_drain_callback
, o
);
953 if (pa_pstream_is_pending(o
->context
->pstream
)) {
954 pa_pstream_set_drain_callback(o
->context
->pstream
, pstream_drain_callback
, o
);
960 pa_context_notify_cb_t cb
= (pa_context_notify_cb_t
) o
->callback
;
961 cb(o
->context
, o
->userdata
);
964 pa_operation_done(o
);
965 pa_operation_unref(o
);
969 pa_operation
* pa_context_drain(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
973 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
975 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
976 PA_CHECK_VALIDITY_RETURN_NULL(c
, pa_context_is_pending(c
), PA_ERR_BADSTATE
);
978 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
979 set_dispatch_callbacks(pa_operation_ref(o
));
984 void pa_context_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
985 pa_operation
*o
= userdata
;
990 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
995 if (command
!= PA_COMMAND_REPLY
) {
996 if (pa_context_handle_error(o
->context
, command
, t
, FALSE
) < 0)
1000 } else if (!pa_tagstruct_eof(t
)) {
1001 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
1006 pa_context_success_cb_t cb
= (pa_context_success_cb_t
) o
->callback
;
1007 cb(o
->context
, success
, o
->userdata
);
1011 pa_operation_done(o
);
1012 pa_operation_unref(o
);
1015 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
) {
1021 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1023 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1025 o
= pa_operation_new(c
, NULL
, cb
, userdata
);
1027 t
= pa_tagstruct_command(c
, command
, &tag
);
1028 pa_pstream_send_tagstruct(c
->pstream
, t
);
1029 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, internal_cb
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1034 pa_operation
* pa_context_exit_daemon(pa_context
*c
, pa_context_success_cb_t cb
, void *userdata
) {
1036 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1038 return pa_context_send_simple_command(c
, PA_COMMAND_EXIT
, pa_context_simple_ack_callback
, (pa_operation_cb_t
) cb
, userdata
);
1041 pa_operation
* pa_context_set_default_sink(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1047 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1049 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1051 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1052 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SINK
, &tag
);
1053 pa_tagstruct_puts(t
, name
);
1054 pa_pstream_send_tagstruct(c
->pstream
, t
);
1055 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
);
1060 pa_operation
* pa_context_set_default_source(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1066 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1068 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1070 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1071 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SOURCE
, &tag
);
1072 pa_tagstruct_puts(t
, name
);
1073 pa_pstream_send_tagstruct(c
->pstream
, t
);
1074 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
);
1079 int pa_context_is_local(pa_context
*c
) {
1081 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1083 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, -1);
1085 return !!c
->is_local
;
1088 pa_operation
* pa_context_set_name(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1092 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1095 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1097 if (c
->version
>= 13) {
1098 pa_proplist
*p
= pa_proplist_new();
1100 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, name
);
1101 o
= pa_context_proplist_update(c
, PA_UPDATE_REPLACE
, p
, cb
, userdata
);
1102 pa_proplist_free(p
);
1107 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1108 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
1109 pa_tagstruct_puts(t
, name
);
1110 pa_pstream_send_tagstruct(c
->pstream
, t
);
1111 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
);
1117 const char* pa_get_library_version(void) {
1118 return PACKAGE_VERSION
;
1121 const char* pa_context_get_server(pa_context
*c
) {
1123 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1128 if (*c
->server
== '{') {
1129 char *e
= strchr(c
->server
+1, '}');
1130 return e
? e
+1 : c
->server
;
1136 uint32_t pa_context_get_protocol_version(PA_GCC_UNUSED pa_context
*c
) {
1137 return PA_PROTOCOL_VERSION
;
1140 uint32_t pa_context_get_server_protocol_version(pa_context
*c
) {
1142 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1144 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1149 pa_tagstruct
*pa_tagstruct_command(pa_context
*c
, uint32_t command
, uint32_t *tag
) {
1155 t
= pa_tagstruct_new(NULL
, 0);
1156 pa_tagstruct_putu32(t
, command
);
1157 pa_tagstruct_putu32(t
, *tag
= c
->ctag
++);
1162 uint32_t pa_context_get_index(pa_context
*c
) {
1164 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1166 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1167 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
, PA_INVALID_INDEX
);
1169 return c
->client_index
;
1172 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
) {
1178 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1180 PA_CHECK_VALIDITY_RETURN_NULL(c
, mode
== PA_UPDATE_SET
|| mode
== PA_UPDATE_MERGE
|| mode
== PA_UPDATE_REPLACE
, PA_ERR_INVALID
);
1181 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1182 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1184 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1186 t
= pa_tagstruct_command(c
, PA_COMMAND_UPDATE_CLIENT_PROPLIST
, &tag
);
1187 pa_tagstruct_putu32(t
, (uint32_t) mode
);
1188 pa_tagstruct_put_proplist(t
, p
);
1190 pa_pstream_send_tagstruct(c
->pstream
, t
);
1191 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
);
1193 /* Please note that we don't update c->proplist here, because we
1194 * don't export that field */
1199 pa_operation
*pa_context_proplist_remove(pa_context
*c
, const char *const keys
[], pa_context_success_cb_t cb
, void *userdata
) {
1203 const char * const *k
;
1206 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1208 PA_CHECK_VALIDITY_RETURN_NULL(c
, keys
&& keys
[0], PA_ERR_INVALID
);
1209 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1210 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1212 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1214 t
= pa_tagstruct_command(c
, PA_COMMAND_REMOVE_CLIENT_PROPLIST
, &tag
);
1216 for (k
= keys
; *k
; k
++)
1217 pa_tagstruct_puts(t
, *k
);
1219 pa_tagstruct_puts(t
, NULL
);
1221 pa_pstream_send_tagstruct(c
->pstream
, t
);
1222 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
);
1224 /* Please note that we don't update c->proplist here, because we
1225 * don't export that field */