4 This file is part of PulseAudio.
6 Copyright 2004-2008 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include <sys/types.h>
40 #ifdef HAVE_SYS_WAIT_H
44 #ifdef HAVE_SYS_SOCKET_H
45 #include <sys/socket.h>
54 #include <pulse/version.h>
55 #include <pulse/xmalloc.h>
56 #include <pulse/utf8.h>
57 #include <pulse/util.h>
59 #include <pulsecore/winsock.h>
60 #include <pulsecore/core-error.h>
62 #include <pulsecore/native-common.h>
63 #include <pulsecore/pdispatch.h>
64 #include <pulsecore/pstream.h>
65 #include <pulsecore/dynarray.h>
66 #include <pulsecore/socket-client.h>
67 #include <pulsecore/pstream-util.h>
68 #include <pulsecore/core-util.h>
69 #include <pulsecore/log.h>
70 #include <pulsecore/socket-util.h>
71 #include <pulsecore/creds.h>
72 #include <pulsecore/macro.h>
76 #include "client-conf.h"
79 #include "client-conf-x11.h"
84 #define AUTOSPAWN_LOCK "autospawn.lock"
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
100 static void unlock_autospawn_lock_file(pa_context
*c
) {
103 if (c
->autospawn_lock_fd
>= 0) {
106 lf
= pa_runtime_path(AUTOSPAWN_LOCK
);
107 pa_unlock_lockfile(lf
, c
->autospawn_lock_fd
);
110 c
->autospawn_lock_fd
= -1;
114 static void context_free(pa_context
*c
);
116 pa_context
*pa_context_new(pa_mainloop_api
*mainloop
, const char *name
) {
117 return pa_context_new_with_proplist(mainloop
, name
, NULL
);
120 static void reset_callbacks(pa_context
*c
) {
123 c
->state_callback
= NULL
;
124 c
->state_userdata
= NULL
;
126 c
->subscribe_callback
= NULL
;
127 c
->subscribe_userdata
= NULL
;
130 pa_context
*pa_context_new_with_proplist(pa_mainloop_api
*mainloop
, const char *name
, pa_proplist
*p
) {
135 if (!name
&& !pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
))
138 c
= pa_xnew(pa_context
, 1);
141 c
->proplist
= p
? pa_proplist_copy(p
) : pa_proplist_new();
144 pa_proplist_sets(c
->proplist
, PA_PROP_APPLICATION_NAME
, name
);
146 c
->mainloop
= mainloop
;
150 c
->playback_streams
= pa_dynarray_new();
151 c
->record_streams
= pa_dynarray_new();
152 c
->client_index
= PA_INVALID_INDEX
;
154 PA_LLIST_HEAD_INIT(pa_stream
, c
->streams
);
155 PA_LLIST_HEAD_INIT(pa_operation
, c
->operations
);
158 c
->state
= PA_CONTEXT_UNCONNECTED
;
165 c
->server_list
= NULL
;
167 c
->autospawn_lock_fd
= -1;
168 memset(&c
->spawn_api
, 0, sizeof(c
->spawn_api
));
169 c
->do_autospawn
= FALSE
;
173 pa_check_signal_is_blocked(SIGPIPE
);
177 c
->conf
= pa_client_conf_new();
178 pa_client_conf_load(c
->conf
, NULL
);
180 pa_client_conf_from_x11(c
->conf
, NULL
);
182 pa_client_conf_env(c
->conf
);
184 if (!(c
->mempool
= pa_mempool_new(!c
->conf
->disable_shm
))) {
186 if (!c
->conf
->disable_shm
)
187 c
->mempool
= pa_mempool_new(0);
198 static void context_unlink(pa_context
*c
) {
203 s
= c
->streams
? pa_stream_ref(c
->streams
) : NULL
;
205 pa_stream
*n
= s
->next
? pa_stream_ref(s
->next
) : NULL
;
206 pa_stream_set_state(s
, c
->state
== PA_CONTEXT_FAILED
? PA_STREAM_FAILED
: PA_STREAM_TERMINATED
);
211 while (c
->operations
)
212 pa_operation_cancel(c
->operations
);
215 pa_pdispatch_unref(c
->pdispatch
);
220 pa_pstream_unlink(c
->pstream
);
221 pa_pstream_unref(c
->pstream
);
226 pa_socket_client_unref(c
->client
);
233 static void context_free(pa_context
*c
) {
238 unlock_autospawn_lock_file(c
);
240 if (c
->record_streams
)
241 pa_dynarray_free(c
->record_streams
, NULL
, NULL
);
242 if (c
->playback_streams
)
243 pa_dynarray_free(c
->playback_streams
, NULL
, NULL
);
246 pa_mempool_free(c
->mempool
);
249 pa_client_conf_free(c
->conf
);
251 pa_strlist_free(c
->server_list
);
254 pa_proplist_free(c
->proplist
);
260 pa_context
* pa_context_ref(pa_context
*c
) {
262 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
268 void pa_context_unref(pa_context
*c
) {
270 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
272 if (PA_REFCNT_DEC(c
) <= 0)
276 void pa_context_set_state(pa_context
*c
, pa_context_state_t st
) {
278 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
287 if (c
->state_callback
)
288 c
->state_callback(c
, c
->state_userdata
);
290 if (st
== PA_CONTEXT_FAILED
|| st
== PA_CONTEXT_TERMINATED
)
296 int pa_context_set_error(pa_context
*c
, int error
) {
297 pa_assert(error
>= 0);
298 pa_assert(error
< PA_ERR_MAX
);
306 void pa_context_fail(pa_context
*c
, int error
) {
308 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
310 pa_context_set_error(c
, error
);
311 pa_context_set_state(c
, PA_CONTEXT_FAILED
);
314 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
315 pa_context
*c
= userdata
;
320 pa_context_fail(c
, PA_ERR_CONNECTIONTERMINATED
);
323 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, const pa_creds
*creds
, void *userdata
) {
324 pa_context
*c
= userdata
;
332 if (pa_pdispatch_run(c
->pdispatch
, packet
, creds
, c
) < 0)
333 pa_context_fail(c
, PA_ERR_PROTOCOL
);
338 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
) {
339 pa_context
*c
= userdata
;
344 pa_assert(chunk
->memblock
);
345 pa_assert(chunk
->length
);
347 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
351 if ((s
= pa_dynarray_get(c
->record_streams
, channel
))) {
353 pa_assert(seek
== PA_SEEK_RELATIVE
);
354 pa_assert(offset
== 0);
356 pa_memblockq_seek(s
->record_memblockq
, offset
, seek
);
357 pa_memblockq_push_align(s
->record_memblockq
, chunk
);
359 if (s
->read_callback
) {
362 if ((l
= pa_memblockq_get_length(s
->record_memblockq
)) > 0)
363 s
->read_callback(s
, l
, s
->read_userdata
);
370 int pa_context_handle_error(pa_context
*c
, uint32_t command
, pa_tagstruct
*t
, pa_bool_t fail
) {
373 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
375 if (command
== PA_COMMAND_ERROR
) {
378 if (pa_tagstruct_getu32(t
, &err
) < 0) {
379 pa_context_fail(c
, PA_ERR_PROTOCOL
);
383 } else if (command
== PA_COMMAND_TIMEOUT
)
384 err
= PA_ERR_TIMEOUT
;
386 pa_context_fail(c
, PA_ERR_PROTOCOL
);
391 pa_context_fail(c
, PA_ERR_PROTOCOL
);
395 if (err
>= PA_ERR_MAX
)
396 err
= PA_ERR_UNKNOWN
;
399 pa_context_fail(c
, err
);
403 pa_context_set_error(c
, err
);
408 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
409 pa_context
*c
= userdata
;
413 pa_assert(c
->state
== PA_CONTEXT_AUTHORIZING
|| c
->state
== PA_CONTEXT_SETTING_NAME
);
417 if (command
!= PA_COMMAND_REPLY
) {
418 pa_context_handle_error(c
, command
, t
, TRUE
);
423 case PA_CONTEXT_AUTHORIZING
: {
426 if (pa_tagstruct_getu32(t
, &c
->version
) < 0 ||
427 !pa_tagstruct_eof(t
)) {
428 pa_context_fail(c
, PA_ERR_PROTOCOL
);
432 /* Minimum supported version */
433 if (c
->version
< 8) {
434 pa_context_fail(c
, PA_ERR_VERSION
);
438 /* Enable shared memory support if possible */
439 if (c
->version
>= 10 &&
440 pa_mempool_is_shared(c
->mempool
) &&
443 /* Only enable SHM if both sides are owned by the same
444 * user. This is a security measure because otherwise
445 * data private to the user might leak. */
448 const pa_creds
*creds
;
449 if ((creds
= pa_pdispatch_creds(pd
)))
450 if (getuid() == creds
->uid
)
451 pa_pstream_enable_shm(c
->pstream
, TRUE
);
455 reply
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
457 if (c
->version
>= 13) {
458 pa_init_proplist(c
->proplist
);
459 pa_tagstruct_put_proplist(reply
, c
->proplist
);
461 pa_tagstruct_puts(reply
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
463 pa_pstream_send_tagstruct(c
->pstream
, reply
);
464 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
466 pa_context_set_state(c
, PA_CONTEXT_SETTING_NAME
);
470 case PA_CONTEXT_SETTING_NAME
:
472 if ((c
->version
>= 13 && (pa_tagstruct_getu32(t
, &c
->client_index
) < 0 ||
473 c
->client_index
== PA_INVALID_INDEX
)) ||
474 !pa_tagstruct_eof(t
)) {
475 pa_context_fail(c
, PA_ERR_PROTOCOL
);
479 pa_context_set_state(c
, PA_CONTEXT_READY
);
483 pa_assert_not_reached();
490 static void setup_context(pa_context
*c
, pa_iochannel
*io
) {
499 pa_assert(!c
->pstream
);
500 c
->pstream
= pa_pstream_new(c
->mainloop
, io
, c
->mempool
);
502 pa_pstream_set_die_callback(c
->pstream
, pstream_die_callback
, c
);
503 pa_pstream_set_recieve_packet_callback(c
->pstream
, pstream_packet_callback
, c
);
504 pa_pstream_set_recieve_memblock_callback(c
->pstream
, pstream_memblock_callback
, c
);
506 pa_assert(!c
->pdispatch
);
507 c
->pdispatch
= pa_pdispatch_new(c
->mainloop
, command_table
, PA_COMMAND_MAX
);
509 if (!c
->conf
->cookie_valid
)
510 pa_log_info("No cookie loaded. Attempting to connect without.");
512 t
= pa_tagstruct_command(c
, PA_COMMAND_AUTH
, &tag
);
513 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
);
514 pa_tagstruct_put_arbitrary(t
, c
->conf
->cookie
, sizeof(c
->conf
->cookie
));
520 if (pa_iochannel_creds_supported(io
))
521 pa_iochannel_creds_enable(io
);
523 ucred
.uid
= getuid();
524 ucred
.gid
= getgid();
526 pa_pstream_send_tagstruct_with_creds(c
->pstream
, t
, &ucred
);
529 pa_pstream_send_tagstruct(c
->pstream
, t
);
532 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
534 pa_context_set_state(c
, PA_CONTEXT_AUTHORIZING
);
539 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
);
543 static int context_connect_spawn(pa_context
*c
) {
546 int fds
[2] = { -1, -1} ;
554 if (socketpair(AF_UNIX
, SOCK_STREAM
, 0, fds
) < 0) {
555 pa_log_error("socketpair(): %s", pa_cstrerror(errno
));
556 pa_context_fail(c
, PA_ERR_INTERNAL
);
560 pa_make_fd_cloexec(fds
[0]);
562 pa_make_socket_low_delay(fds
[0]);
563 pa_make_socket_low_delay(fds
[1]);
565 if (c
->spawn_api
.prefork
)
566 c
->spawn_api
.prefork();
568 if ((pid
= fork()) < 0) {
569 pa_log_error("fork(): %s", pa_cstrerror(errno
));
570 pa_context_fail(c
, PA_ERR_INTERNAL
);
572 if (c
->spawn_api
.postfork
)
573 c
->spawn_api
.postfork();
580 const char *state
= NULL
;
582 const char * argv
[MAX_ARGS
+1];
586 pa_close_all(fds
[1], -1);
588 f
= pa_sprintf_malloc("%i", fds
[1]);
589 pa_set_env("PULSE_PASSED_FD", f
);
592 if (c
->spawn_api
.atfork
)
593 c
->spawn_api
.atfork();
599 argv
[n
++] = c
->conf
->daemon_binary
;
600 argv
[n
++] = "--daemonize=yes";
602 pa_snprintf(t
, sizeof(t
), "-Lmodule-native-protocol-fd fd=%i", fds
[1]);
603 argv
[n
++] = strdup(t
);
605 while (n
< MAX_ARGS
) {
608 if (!(a
= pa_split_spaces(c
->conf
->extra_arguments
, &state
)))
616 execv(argv
[0], (char * const *) argv
);
623 pa_assert_se(pa_close(fds
[1]) == 0);
625 r
= waitpid(pid
, &status
, 0);
627 if (c
->spawn_api
.postfork
)
628 c
->spawn_api
.postfork();
631 pa_log("waitpid(): %s", pa_cstrerror(errno
));
632 pa_context_fail(c
, PA_ERR_INTERNAL
);
634 } else if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
635 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
641 unlock_autospawn_lock_file(c
);
643 io
= pa_iochannel_new(c
->mainloop
, fds
[0], fds
[0]);
644 setup_context(c
, io
);
653 unlock_autospawn_lock_file(c
);
660 #endif /* OS_IS_WIN32 */
662 static int try_next_connection(pa_context
*c
) {
667 pa_assert(!c
->client
);
673 c
->server_list
= pa_strlist_pop(c
->server_list
, &u
);
678 if (c
->do_autospawn
) {
679 r
= context_connect_spawn(c
);
684 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
688 pa_log_debug("Trying to connect to %s...", u
);
691 c
->server
= pa_xstrdup(u
);
693 if (!(c
->client
= pa_socket_client_new_string(c
->mainloop
, u
, PA_NATIVE_DEFAULT_PORT
)))
696 c
->is_local
= !!pa_socket_client_is_local(c
->client
);
697 pa_socket_client_set_callback(c
->client
, on_connection
, c
);
709 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
) {
710 pa_context
*c
= userdata
;
711 int saved_errno
= errno
;
715 pa_assert(c
->state
== PA_CONTEXT_CONNECTING
);
719 pa_socket_client_unref(client
);
723 /* Try the item in the list */
724 if (saved_errno
== ECONNREFUSED
||
725 saved_errno
== ETIMEDOUT
||
726 saved_errno
== EHOSTUNREACH
) {
727 try_next_connection(c
);
731 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
735 unlock_autospawn_lock_file(c
);
736 setup_context(c
, io
);
743 static char *get_legacy_runtime_dir(void) {
747 if (!pa_get_user_name(u
, sizeof(u
)))
750 p
= pa_sprintf_malloc("/tmp/pulse-%s", u
);
752 if (stat(p
, &st
) < 0)
755 if (st
.st_uid
!= getuid())
761 int pa_context_connect(
764 pa_context_flags_t flags
,
765 const pa_spawn_api
*api
) {
770 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
772 PA_CHECK_VALIDITY(c
, c
->state
== PA_CONTEXT_UNCONNECTED
, PA_ERR_BADSTATE
);
773 PA_CHECK_VALIDITY(c
, !(flags
& ~PA_CONTEXT_NOAUTOSPAWN
), PA_ERR_INVALID
);
774 PA_CHECK_VALIDITY(c
, !server
|| *server
, PA_ERR_INVALID
);
777 server
= c
->conf
->default_server
;
781 pa_assert(!c
->server_list
);
784 if (!(c
->server_list
= pa_strlist_parse(server
))) {
785 pa_context_fail(c
, PA_ERR_INVALIDSERVER
);
790 static char *legacy_dir
;
792 /* Prepend in reverse order */
794 if ((d
= getenv("DISPLAY"))) {
797 if ((e
= strchr(d
, ':')))
801 c
->server_list
= pa_strlist_prepend(c
->server_list
, d
);
806 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp6:localhost");
807 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp4:localhost");
809 /* The system wide instance */
810 c
->server_list
= pa_strlist_prepend(c
->server_list
, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
);
812 /* The old per-user instance path. This is supported only to easy upgrades */
813 if ((legacy_dir
= get_legacy_runtime_dir())) {
814 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
815 c
->server_list
= pa_strlist_prepend(c
->server_list
, p
);
817 pa_xfree(legacy_dir
);
820 /* The per-user instance */
821 c
->server_list
= pa_strlist_prepend(c
->server_list
, ufn
= pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET
));
824 /* Wrap the connection attempts in a single transaction for sane autospawn locking */
825 if (!(flags
& PA_CONTEXT_NOAUTOSPAWN
) && c
->conf
->autospawn
) {
828 lf
= pa_runtime_path(AUTOSPAWN_LOCK
);
829 pa_assert(c
->autospawn_lock_fd
<= 0);
830 c
->autospawn_lock_fd
= pa_lock_lockfile(lf
);
836 c
->do_autospawn
= TRUE
;
840 pa_context_set_state(c
, PA_CONTEXT_CONNECTING
);
841 r
= try_next_connection(c
);
849 void pa_context_disconnect(pa_context
*c
) {
851 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
853 if (PA_CONTEXT_IS_GOOD(c
->state
))
854 pa_context_set_state(c
, PA_CONTEXT_TERMINATED
);
857 pa_context_state_t
pa_context_get_state(pa_context
*c
) {
859 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
864 int pa_context_errno(pa_context
*c
) {
866 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
871 void pa_context_set_state_callback(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
873 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
875 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
878 c
->state_callback
= cb
;
879 c
->state_userdata
= userdata
;
882 int pa_context_is_pending(pa_context
*c
) {
884 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
886 PA_CHECK_VALIDITY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
);
888 return (c
->pstream
&& pa_pstream_is_pending(c
->pstream
)) ||
889 (c
->pdispatch
&& pa_pdispatch_is_pending(c
->pdispatch
)) ||
893 static void set_dispatch_callbacks(pa_operation
*o
);
895 static void pdispatch_drain_callback(PA_GCC_UNUSED pa_pdispatch
*pd
, void *userdata
) {
896 set_dispatch_callbacks(userdata
);
899 static void pstream_drain_callback(PA_GCC_UNUSED pa_pstream
*s
, void *userdata
) {
900 set_dispatch_callbacks(userdata
);
903 static void set_dispatch_callbacks(pa_operation
*o
) {
907 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
908 pa_assert(o
->context
);
909 pa_assert(PA_REFCNT_VALUE(o
->context
) >= 1);
910 pa_assert(o
->context
->state
== PA_CONTEXT_READY
);
912 pa_pstream_set_drain_callback(o
->context
->pstream
, NULL
, NULL
);
913 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, NULL
, NULL
);
915 if (pa_pdispatch_is_pending(o
->context
->pdispatch
)) {
916 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, pdispatch_drain_callback
, o
);
920 if (pa_pstream_is_pending(o
->context
->pstream
)) {
921 pa_pstream_set_drain_callback(o
->context
->pstream
, pstream_drain_callback
, o
);
927 pa_context_notify_cb_t cb
= (pa_context_notify_cb_t
) o
->callback
;
928 cb(o
->context
, o
->userdata
);
931 pa_operation_done(o
);
932 pa_operation_unref(o
);
936 pa_operation
* pa_context_drain(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
940 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
942 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
943 PA_CHECK_VALIDITY_RETURN_NULL(c
, pa_context_is_pending(c
), PA_ERR_BADSTATE
);
945 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
946 set_dispatch_callbacks(pa_operation_ref(o
));
951 void pa_context_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
952 pa_operation
*o
= userdata
;
957 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
962 if (command
!= PA_COMMAND_REPLY
) {
963 if (pa_context_handle_error(o
->context
, command
, t
, FALSE
) < 0)
967 } else if (!pa_tagstruct_eof(t
)) {
968 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
973 pa_context_success_cb_t cb
= (pa_context_success_cb_t
) o
->callback
;
974 cb(o
->context
, success
, o
->userdata
);
978 pa_operation_done(o
);
979 pa_operation_unref(o
);
982 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
) {
988 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
990 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
992 o
= pa_operation_new(c
, NULL
, cb
, userdata
);
994 t
= pa_tagstruct_command(c
, command
, &tag
);
995 pa_pstream_send_tagstruct(c
->pstream
, t
);
996 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, internal_cb
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1001 pa_operation
* pa_context_exit_daemon(pa_context
*c
, pa_context_success_cb_t cb
, void *userdata
) {
1003 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1005 return pa_context_send_simple_command(c
, PA_COMMAND_EXIT
, pa_context_simple_ack_callback
, (pa_operation_cb_t
) cb
, userdata
);
1008 pa_operation
* pa_context_set_default_sink(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1014 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1016 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1018 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1019 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SINK
, &tag
);
1020 pa_tagstruct_puts(t
, name
);
1021 pa_pstream_send_tagstruct(c
->pstream
, t
);
1022 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
);
1027 pa_operation
* pa_context_set_default_source(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1033 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1035 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1037 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1038 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SOURCE
, &tag
);
1039 pa_tagstruct_puts(t
, name
);
1040 pa_pstream_send_tagstruct(c
->pstream
, t
);
1041 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
);
1046 int pa_context_is_local(pa_context
*c
) {
1048 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1050 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, -1);
1052 return !!c
->is_local
;
1055 pa_operation
* pa_context_set_name(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1059 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1062 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1064 if (c
->version
>= 13) {
1065 pa_proplist
*p
= pa_proplist_new();
1067 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, name
);
1068 o
= pa_context_proplist_update(c
, PA_UPDATE_REPLACE
, p
, cb
, userdata
);
1069 pa_proplist_free(p
);
1074 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1075 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &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
);
1084 const char* pa_get_library_version(void) {
1085 return PACKAGE_VERSION
;
1088 const char* pa_context_get_server(pa_context
*c
) {
1090 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1095 if (*c
->server
== '{') {
1096 char *e
= strchr(c
->server
+1, '}');
1097 return e
? e
+1 : c
->server
;
1103 uint32_t pa_context_get_protocol_version(PA_GCC_UNUSED pa_context
*c
) {
1104 return PA_PROTOCOL_VERSION
;
1107 uint32_t pa_context_get_server_protocol_version(pa_context
*c
) {
1109 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1111 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1116 pa_tagstruct
*pa_tagstruct_command(pa_context
*c
, uint32_t command
, uint32_t *tag
) {
1122 t
= pa_tagstruct_new(NULL
, 0);
1123 pa_tagstruct_putu32(t
, command
);
1124 pa_tagstruct_putu32(t
, *tag
= c
->ctag
++);
1129 uint32_t pa_context_get_index(pa_context
*c
) {
1131 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1133 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1134 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
, PA_INVALID_INDEX
);
1136 return c
->client_index
;
1139 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
) {
1145 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1147 PA_CHECK_VALIDITY_RETURN_NULL(c
, mode
== PA_UPDATE_SET
|| mode
== PA_UPDATE_MERGE
|| mode
== PA_UPDATE_REPLACE
, PA_ERR_INVALID
);
1148 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1149 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1151 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1153 t
= pa_tagstruct_command(c
, PA_COMMAND_UPDATE_CLIENT_PROPLIST
, &tag
);
1154 pa_tagstruct_putu32(t
, (uint32_t) mode
);
1155 pa_tagstruct_put_proplist(t
, p
);
1157 pa_pstream_send_tagstruct(c
->pstream
, t
);
1158 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 /* Please note that we don't update c->proplist here, because we
1161 * don't export that field */
1166 pa_operation
*pa_context_proplist_remove(pa_context
*c
, const char *const keys
[], pa_context_success_cb_t cb
, void *userdata
) {
1170 const char * const *k
;
1173 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1175 PA_CHECK_VALIDITY_RETURN_NULL(c
, keys
&& keys
[0], PA_ERR_INVALID
);
1176 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1177 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1179 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1181 t
= pa_tagstruct_command(c
, PA_COMMAND_REMOVE_CLIENT_PROPLIST
, &tag
);
1183 for (k
= keys
; *k
; k
++)
1184 pa_tagstruct_puts(t
, *k
);
1186 pa_tagstruct_puts(t
, NULL
);
1188 pa_pstream_send_tagstruct(c
->pstream
, t
);
1189 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
);
1191 /* Please note that we don't update c->proplist here, because we
1192 * don't export that field */
1197 void pa_init_proplist(pa_proplist
*p
) {
1199 #ifndef HAVE_DECL_ENVIRON
1200 extern char **environ
;
1206 for (e
= environ
; *e
; e
++) {
1208 if (pa_startswith(*e
, "PULSE_PROP_")) {
1209 size_t kl
= strcspn(*e
+11, "=");
1212 if ((*e
)[11+kl
] != '=')
1215 if (!pa_utf8_valid(*e
+11+kl
+1))
1218 k
= pa_xstrndup(*e
+11, kl
);
1220 if (pa_proplist_contains(p
, k
)) {
1225 pa_proplist_sets(p
, k
, *e
+11+kl
+1);
1230 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_ID
)) {
1232 pa_snprintf(t
, sizeof(t
), "%lu", (unsigned long) getpid());
1233 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_ID
, t
);
1236 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_USER
)) {
1238 if (pa_get_user_name(t
, sizeof(t
))) {
1239 char *c
= pa_utf8_filter(t
);
1240 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_USER
, c
);
1245 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_HOST
)) {
1247 if (pa_get_host_name(t
, sizeof(t
))) {
1248 char *c
= pa_utf8_filter(t
);
1249 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_HOST
, c
);
1254 a
= pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_BINARY
);
1255 b
= pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
);
1259 if (pa_get_binary_name(t
, sizeof(t
))) {
1260 char *c
= pa_utf8_filter(t
);
1263 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_BINARY
, c
);
1265 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, c
);
1271 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_LANGUAGE
)) {
1274 if ((l
= setlocale(LC_MESSAGES
, NULL
)))
1275 pa_proplist_sets(p
, PA_PROP_APPLICATION_LANGUAGE
, l
);