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 if (!(lf
= pa_runtime_path(AUTOSPAWN_LOCK
)))
107 pa_log_warn("Cannot unlock autospawn because runtime path is no more.");
109 pa_unlock_lockfile(lf
, c
->autospawn_lock_fd
);
112 c
->autospawn_lock_fd
= -1;
116 static void context_free(pa_context
*c
);
118 pa_context
*pa_context_new(pa_mainloop_api
*mainloop
, const char *name
) {
119 return pa_context_new_with_proplist(mainloop
, name
, NULL
);
122 static void reset_callbacks(pa_context
*c
) {
125 c
->state_callback
= NULL
;
126 c
->state_userdata
= NULL
;
128 c
->subscribe_callback
= NULL
;
129 c
->subscribe_userdata
= NULL
;
132 pa_context
*pa_context_new_with_proplist(pa_mainloop_api
*mainloop
, const char *name
, pa_proplist
*p
) {
137 if (!name
&& !pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
))
140 c
= pa_xnew(pa_context
, 1);
143 c
->proplist
= p
? pa_proplist_copy(p
) : pa_proplist_new();
146 pa_proplist_sets(c
->proplist
, PA_PROP_APPLICATION_NAME
, name
);
148 c
->mainloop
= mainloop
;
152 c
->playback_streams
= pa_dynarray_new();
153 c
->record_streams
= pa_dynarray_new();
154 c
->client_index
= PA_INVALID_INDEX
;
156 PA_LLIST_HEAD_INIT(pa_stream
, c
->streams
);
157 PA_LLIST_HEAD_INIT(pa_operation
, c
->operations
);
160 c
->state
= PA_CONTEXT_UNCONNECTED
;
167 c
->server_list
= NULL
;
169 c
->autospawn_lock_fd
= -1;
170 memset(&c
->spawn_api
, 0, sizeof(c
->spawn_api
));
171 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
: {
428 if (pa_tagstruct_getu32(t
, &c
->version
) < 0 ||
429 !pa_tagstruct_eof(t
)) {
430 pa_context_fail(c
, PA_ERR_PROTOCOL
);
434 /* Minimum supported version */
435 if (c
->version
< 8) {
436 pa_context_fail(c
, PA_ERR_VERSION
);
440 /* Enable shared memory support if possible */
441 if (c
->version
>= 10 &&
442 pa_mempool_is_shared(c
->mempool
) &&
445 /* Only enable SHM if both sides are owned by the same
446 * user. This is a security measure because otherwise
447 * data private to the user might leak. */
450 const pa_creds
*creds
;
451 if ((creds
= pa_pdispatch_creds(pd
)))
452 if (getuid() == creds
->uid
)
453 pa_pstream_enable_shm(c
->pstream
, TRUE
);
457 reply
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
459 if (c
->version
>= 13) {
460 pa_init_proplist(c
->proplist
);
461 pa_tagstruct_put_proplist(reply
, c
->proplist
);
463 pa_tagstruct_puts(reply
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
465 pa_pstream_send_tagstruct(c
->pstream
, reply
);
466 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
468 pa_context_set_state(c
, PA_CONTEXT_SETTING_NAME
);
472 case PA_CONTEXT_SETTING_NAME
:
474 if ((c
->version
>= 13 && (pa_tagstruct_getu32(t
, &c
->client_index
) < 0 ||
475 c
->client_index
== PA_INVALID_INDEX
)) ||
476 !pa_tagstruct_eof(t
)) {
477 pa_context_fail(c
, PA_ERR_PROTOCOL
);
481 pa_context_set_state(c
, PA_CONTEXT_READY
);
485 pa_assert_not_reached();
492 static void setup_context(pa_context
*c
, pa_iochannel
*io
) {
501 pa_assert(!c
->pstream
);
502 c
->pstream
= pa_pstream_new(c
->mainloop
, io
, c
->mempool
);
504 pa_pstream_set_die_callback(c
->pstream
, pstream_die_callback
, c
);
505 pa_pstream_set_recieve_packet_callback(c
->pstream
, pstream_packet_callback
, c
);
506 pa_pstream_set_recieve_memblock_callback(c
->pstream
, pstream_memblock_callback
, c
);
508 pa_assert(!c
->pdispatch
);
509 c
->pdispatch
= pa_pdispatch_new(c
->mainloop
, command_table
, PA_COMMAND_MAX
);
511 if (!c
->conf
->cookie_valid
)
512 pa_log_info("No cookie loaded. Attempting to connect without.");
514 t
= pa_tagstruct_command(c
, PA_COMMAND_AUTH
, &tag
);
515 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
);
516 pa_tagstruct_put_arbitrary(t
, c
->conf
->cookie
, sizeof(c
->conf
->cookie
));
522 if (pa_iochannel_creds_supported(io
))
523 pa_iochannel_creds_enable(io
);
525 ucred
.uid
= getuid();
526 ucred
.gid
= getgid();
528 pa_pstream_send_tagstruct_with_creds(c
->pstream
, t
, &ucred
);
531 pa_pstream_send_tagstruct(c
->pstream
, t
);
534 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
536 pa_context_set_state(c
, PA_CONTEXT_AUTHORIZING
);
541 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
);
545 static int context_connect_spawn(pa_context
*c
) {
548 int fds
[2] = { -1, -1} ;
556 if (socketpair(AF_UNIX
, SOCK_STREAM
, 0, fds
) < 0) {
557 pa_log_error("socketpair(): %s", pa_cstrerror(errno
));
558 pa_context_fail(c
, PA_ERR_INTERNAL
);
562 pa_make_fd_cloexec(fds
[0]);
564 pa_make_socket_low_delay(fds
[0]);
565 pa_make_socket_low_delay(fds
[1]);
567 if (c
->spawn_api
.prefork
)
568 c
->spawn_api
.prefork();
570 if ((pid
= fork()) < 0) {
571 pa_log_error("fork(): %s", pa_cstrerror(errno
));
572 pa_context_fail(c
, PA_ERR_INTERNAL
);
574 if (c
->spawn_api
.postfork
)
575 c
->spawn_api
.postfork();
582 const char *state
= NULL
;
584 const char * argv
[MAX_ARGS
+1];
588 pa_close_all(fds
[1], -1);
590 f
= pa_sprintf_malloc("%i", fds
[1]);
591 pa_set_env("PULSE_PASSED_FD", f
);
594 if (c
->spawn_api
.atfork
)
595 c
->spawn_api
.atfork();
601 argv
[n
++] = c
->conf
->daemon_binary
;
602 argv
[n
++] = "--daemonize=yes";
604 pa_snprintf(t
, sizeof(t
), "-Lmodule-native-protocol-fd fd=%i", fds
[1]);
605 argv
[n
++] = strdup(t
);
607 while (n
< MAX_ARGS
) {
610 if (!(a
= pa_split_spaces(c
->conf
->extra_arguments
, &state
)))
618 execv(argv
[0], (char * const *) argv
);
625 pa_assert_se(pa_close(fds
[1]) == 0);
628 r
= waitpid(pid
, &status
, 0);
630 if (c
->spawn_api
.postfork
)
631 c
->spawn_api
.postfork();
634 pa_log("waitpid(): %s", pa_cstrerror(errno
));
635 pa_context_fail(c
, PA_ERR_INTERNAL
);
637 } else if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
638 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
644 unlock_autospawn_lock_file(c
);
646 io
= pa_iochannel_new(c
->mainloop
, fds
[0], fds
[0]);
647 setup_context(c
, io
);
656 unlock_autospawn_lock_file(c
);
663 #endif /* OS_IS_WIN32 */
665 static int try_next_connection(pa_context
*c
) {
670 pa_assert(!c
->client
);
676 c
->server_list
= pa_strlist_pop(c
->server_list
, &u
);
681 if (c
->do_autospawn
) {
682 r
= context_connect_spawn(c
);
687 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
691 pa_log_debug("Trying to connect to %s...", u
);
694 c
->server
= pa_xstrdup(u
);
696 if (!(c
->client
= pa_socket_client_new_string(c
->mainloop
, u
, PA_NATIVE_DEFAULT_PORT
)))
699 c
->is_local
= !!pa_socket_client_is_local(c
->client
);
700 pa_socket_client_set_callback(c
->client
, on_connection
, c
);
712 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
) {
713 pa_context
*c
= userdata
;
714 int saved_errno
= errno
;
718 pa_assert(c
->state
== PA_CONTEXT_CONNECTING
);
722 pa_socket_client_unref(client
);
726 /* Try the item in the list */
727 if (saved_errno
== ECONNREFUSED
||
728 saved_errno
== ETIMEDOUT
||
729 saved_errno
== EHOSTUNREACH
) {
730 try_next_connection(c
);
734 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
738 unlock_autospawn_lock_file(c
);
739 setup_context(c
, io
);
746 static char *get_legacy_runtime_dir(void) {
750 if (!pa_get_user_name(u
, sizeof(u
)))
753 p
= pa_sprintf_malloc("/tmp/pulse-%s", u
);
755 if (stat(p
, &st
) < 0) {
760 if (st
.st_uid
!= getuid()) {
768 int pa_context_connect(
771 pa_context_flags_t flags
,
772 const pa_spawn_api
*api
) {
777 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
779 PA_CHECK_VALIDITY(c
, c
->state
== PA_CONTEXT_UNCONNECTED
, PA_ERR_BADSTATE
);
780 PA_CHECK_VALIDITY(c
, !(flags
& ~PA_CONTEXT_NOAUTOSPAWN
), PA_ERR_INVALID
);
781 PA_CHECK_VALIDITY(c
, !server
|| *server
, PA_ERR_INVALID
);
784 server
= c
->conf
->default_server
;
788 pa_assert(!c
->server_list
);
791 if (!(c
->server_list
= pa_strlist_parse(server
))) {
792 pa_context_fail(c
, PA_ERR_INVALIDSERVER
);
797 static char *legacy_dir
;
799 /* Prepend in reverse order */
801 if ((d
= getenv("DISPLAY"))) {
804 if ((e
= strchr(d
, ':')))
808 c
->server_list
= pa_strlist_prepend(c
->server_list
, d
);
813 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp6:localhost");
814 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp4:localhost");
816 /* The system wide instance */
817 c
->server_list
= pa_strlist_prepend(c
->server_list
, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
);
819 /* The old per-user instance path. This is supported only to ease upgrades */
820 if ((legacy_dir
= get_legacy_runtime_dir())) {
821 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
822 c
->server_list
= pa_strlist_prepend(c
->server_list
, p
);
824 pa_xfree(legacy_dir
);
827 /* The per-user instance */
828 if ((ufn
= pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET
))) {
829 c
->server_list
= pa_strlist_prepend(c
->server_list
, ufn
);
833 /* Wrap the connection attempts in a single transaction for sane autospawn locking */
834 if (!(flags
& PA_CONTEXT_NOAUTOSPAWN
) && c
->conf
->autospawn
) {
837 lf
= pa_runtime_path(AUTOSPAWN_LOCK
);
838 pa_assert(c
->autospawn_lock_fd
<= 0);
839 c
->autospawn_lock_fd
= pa_lock_lockfile(lf
);
845 c
->do_autospawn
= TRUE
;
849 pa_context_set_state(c
, PA_CONTEXT_CONNECTING
);
850 r
= try_next_connection(c
);
858 void pa_context_disconnect(pa_context
*c
) {
860 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
862 if (PA_CONTEXT_IS_GOOD(c
->state
))
863 pa_context_set_state(c
, PA_CONTEXT_TERMINATED
);
866 pa_context_state_t
pa_context_get_state(pa_context
*c
) {
868 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
873 int pa_context_errno(pa_context
*c
) {
875 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
880 void pa_context_set_state_callback(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
882 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
884 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
887 c
->state_callback
= cb
;
888 c
->state_userdata
= userdata
;
891 int pa_context_is_pending(pa_context
*c
) {
893 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
895 PA_CHECK_VALIDITY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
);
897 return (c
->pstream
&& pa_pstream_is_pending(c
->pstream
)) ||
898 (c
->pdispatch
&& pa_pdispatch_is_pending(c
->pdispatch
)) ||
902 static void set_dispatch_callbacks(pa_operation
*o
);
904 static void pdispatch_drain_callback(PA_GCC_UNUSED pa_pdispatch
*pd
, void *userdata
) {
905 set_dispatch_callbacks(userdata
);
908 static void pstream_drain_callback(PA_GCC_UNUSED pa_pstream
*s
, void *userdata
) {
909 set_dispatch_callbacks(userdata
);
912 static void set_dispatch_callbacks(pa_operation
*o
) {
916 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
917 pa_assert(o
->context
);
918 pa_assert(PA_REFCNT_VALUE(o
->context
) >= 1);
919 pa_assert(o
->context
->state
== PA_CONTEXT_READY
);
921 pa_pstream_set_drain_callback(o
->context
->pstream
, NULL
, NULL
);
922 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, NULL
, NULL
);
924 if (pa_pdispatch_is_pending(o
->context
->pdispatch
)) {
925 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, pdispatch_drain_callback
, o
);
929 if (pa_pstream_is_pending(o
->context
->pstream
)) {
930 pa_pstream_set_drain_callback(o
->context
->pstream
, pstream_drain_callback
, o
);
936 pa_context_notify_cb_t cb
= (pa_context_notify_cb_t
) o
->callback
;
937 cb(o
->context
, o
->userdata
);
940 pa_operation_done(o
);
941 pa_operation_unref(o
);
945 pa_operation
* pa_context_drain(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
949 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
951 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
952 PA_CHECK_VALIDITY_RETURN_NULL(c
, pa_context_is_pending(c
), PA_ERR_BADSTATE
);
954 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
955 set_dispatch_callbacks(pa_operation_ref(o
));
960 void pa_context_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
961 pa_operation
*o
= userdata
;
966 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
971 if (command
!= PA_COMMAND_REPLY
) {
972 if (pa_context_handle_error(o
->context
, command
, t
, FALSE
) < 0)
976 } else if (!pa_tagstruct_eof(t
)) {
977 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
982 pa_context_success_cb_t cb
= (pa_context_success_cb_t
) o
->callback
;
983 cb(o
->context
, success
, o
->userdata
);
987 pa_operation_done(o
);
988 pa_operation_unref(o
);
991 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
) {
997 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
999 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1001 o
= pa_operation_new(c
, NULL
, cb
, userdata
);
1003 t
= pa_tagstruct_command(c
, command
, &tag
);
1004 pa_pstream_send_tagstruct(c
->pstream
, t
);
1005 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, internal_cb
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1010 pa_operation
* pa_context_exit_daemon(pa_context
*c
, pa_context_success_cb_t cb
, void *userdata
) {
1012 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1014 return pa_context_send_simple_command(c
, PA_COMMAND_EXIT
, pa_context_simple_ack_callback
, (pa_operation_cb_t
) cb
, userdata
);
1017 pa_operation
* pa_context_set_default_sink(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1023 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1025 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1027 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1028 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SINK
, &tag
);
1029 pa_tagstruct_puts(t
, name
);
1030 pa_pstream_send_tagstruct(c
->pstream
, t
);
1031 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
);
1036 pa_operation
* pa_context_set_default_source(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1042 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1044 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1046 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1047 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SOURCE
, &tag
);
1048 pa_tagstruct_puts(t
, name
);
1049 pa_pstream_send_tagstruct(c
->pstream
, t
);
1050 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
);
1055 int pa_context_is_local(pa_context
*c
) {
1057 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1059 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, -1);
1061 return !!c
->is_local
;
1064 pa_operation
* pa_context_set_name(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1068 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1071 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1073 if (c
->version
>= 13) {
1074 pa_proplist
*p
= pa_proplist_new();
1076 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, name
);
1077 o
= pa_context_proplist_update(c
, PA_UPDATE_REPLACE
, p
, cb
, userdata
);
1078 pa_proplist_free(p
);
1083 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1084 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
1085 pa_tagstruct_puts(t
, name
);
1086 pa_pstream_send_tagstruct(c
->pstream
, t
);
1087 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
);
1093 const char* pa_get_library_version(void) {
1094 return PACKAGE_VERSION
;
1097 const char* pa_context_get_server(pa_context
*c
) {
1099 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1104 if (*c
->server
== '{') {
1105 char *e
= strchr(c
->server
+1, '}');
1106 return e
? e
+1 : c
->server
;
1112 uint32_t pa_context_get_protocol_version(PA_GCC_UNUSED pa_context
*c
) {
1113 return PA_PROTOCOL_VERSION
;
1116 uint32_t pa_context_get_server_protocol_version(pa_context
*c
) {
1118 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1120 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1125 pa_tagstruct
*pa_tagstruct_command(pa_context
*c
, uint32_t command
, uint32_t *tag
) {
1131 t
= pa_tagstruct_new(NULL
, 0);
1132 pa_tagstruct_putu32(t
, command
);
1133 pa_tagstruct_putu32(t
, *tag
= c
->ctag
++);
1138 uint32_t pa_context_get_index(pa_context
*c
) {
1140 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1142 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1143 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
, PA_INVALID_INDEX
);
1145 return c
->client_index
;
1148 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
) {
1154 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1156 PA_CHECK_VALIDITY_RETURN_NULL(c
, mode
== PA_UPDATE_SET
|| mode
== PA_UPDATE_MERGE
|| mode
== PA_UPDATE_REPLACE
, PA_ERR_INVALID
);
1157 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1158 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1160 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1162 t
= pa_tagstruct_command(c
, PA_COMMAND_UPDATE_CLIENT_PROPLIST
, &tag
);
1163 pa_tagstruct_putu32(t
, (uint32_t) mode
);
1164 pa_tagstruct_put_proplist(t
, p
);
1166 pa_pstream_send_tagstruct(c
->pstream
, t
);
1167 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
);
1169 /* Please note that we don't update c->proplist here, because we
1170 * don't export that field */
1175 pa_operation
*pa_context_proplist_remove(pa_context
*c
, const char *const keys
[], pa_context_success_cb_t cb
, void *userdata
) {
1179 const char * const *k
;
1182 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1184 PA_CHECK_VALIDITY_RETURN_NULL(c
, keys
&& keys
[0], 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_REMOVE_CLIENT_PROPLIST
, &tag
);
1192 for (k
= keys
; *k
; k
++)
1193 pa_tagstruct_puts(t
, *k
);
1195 pa_tagstruct_puts(t
, NULL
);
1197 pa_pstream_send_tagstruct(c
->pstream
, t
);
1198 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
);
1200 /* Please note that we don't update c->proplist here, because we
1201 * don't export that field */
1206 void pa_init_proplist(pa_proplist
*p
) {
1208 #ifndef HAVE_DECL_ENVIRON
1209 extern char **environ
;
1215 for (e
= environ
; *e
; e
++) {
1217 if (pa_startswith(*e
, "PULSE_PROP_")) {
1218 size_t kl
= strcspn(*e
+11, "=");
1221 if ((*e
)[11+kl
] != '=')
1224 if (!pa_utf8_valid(*e
+11+kl
+1))
1227 k
= pa_xstrndup(*e
+11, kl
);
1229 if (pa_proplist_contains(p
, k
)) {
1234 pa_proplist_sets(p
, k
, *e
+11+kl
+1);
1239 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_ID
)) {
1241 pa_snprintf(t
, sizeof(t
), "%lu", (unsigned long) getpid());
1242 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_ID
, t
);
1245 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_USER
)) {
1247 if (pa_get_user_name(t
, sizeof(t
))) {
1248 char *c
= pa_utf8_filter(t
);
1249 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_USER
, c
);
1254 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_HOST
)) {
1256 if (pa_get_host_name(t
, sizeof(t
))) {
1257 char *c
= pa_utf8_filter(t
);
1258 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_HOST
, c
);
1263 a
= pa_proplist_contains(p
, PA_PROP_APPLICATION_PROCESS_BINARY
);
1264 b
= pa_proplist_contains(p
, PA_PROP_APPLICATION_NAME
);
1268 if (pa_get_binary_name(t
, sizeof(t
))) {
1269 char *c
= pa_utf8_filter(t
);
1272 pa_proplist_sets(p
, PA_PROP_APPLICATION_PROCESS_BINARY
, c
);
1274 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, c
);
1280 if (!pa_proplist_contains(p
, PA_PROP_APPLICATION_LANGUAGE
)) {
1283 if ((l
= setlocale(LC_MESSAGES
, NULL
)))
1284 pa_proplist_sets(p
, PA_PROP_APPLICATION_LANGUAGE
, l
);