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
,
99 [PA_COMMAND_PLAYBACK_STREAM_EVENT
] = pa_command_stream_event
,
100 [PA_COMMAND_RECORD_STREAM_EVENT
] = pa_command_stream_event
,
101 [PA_COMMAND_CLIENT_EVENT
] = pa_command_client_event
103 static void context_free(pa_context
*c
);
105 pa_context
*pa_context_new(pa_mainloop_api
*mainloop
, const char *name
) {
106 return pa_context_new_with_proplist(mainloop
, name
, NULL
);
109 static void reset_callbacks(pa_context
*c
) {
112 c
->state_callback
= NULL
;
113 c
->state_userdata
= NULL
;
115 c
->subscribe_callback
= NULL
;
116 c
->subscribe_userdata
= NULL
;
118 c
->event_callback
= NULL
;
119 c
->event_userdata
= NULL
;
121 c
->ext_stream_restore
.callback
= NULL
;
122 c
->ext_stream_restore
.userdata
= NULL
;
125 pa_context
*pa_context_new_with_proplist(pa_mainloop_api
*mainloop
, const char *name
, pa_proplist
*p
) {
132 c
= pa_xnew(pa_context
, 1);
135 c
->proplist
= p
? pa_proplist_copy(p
) : pa_proplist_new();
138 pa_proplist_sets(c
->proplist
, PA_PROP_APPLICATION_NAME
, name
);
140 c
->mainloop
= mainloop
;
144 c
->playback_streams
= pa_dynarray_new();
145 c
->record_streams
= pa_dynarray_new();
146 c
->client_index
= PA_INVALID_INDEX
;
148 PA_LLIST_HEAD_INIT(pa_stream
, c
->streams
);
149 PA_LLIST_HEAD_INIT(pa_operation
, c
->operations
);
152 c
->state
= PA_CONTEXT_UNCONNECTED
;
159 c
->server_list
= NULL
;
164 c
->do_autospawn
= FALSE
;
165 memset(&c
->spawn_api
, 0, sizeof(c
->spawn_api
));
169 pa_check_signal_is_blocked(SIGPIPE
);
173 c
->conf
= pa_client_conf_new();
175 pa_client_conf_from_x11(c
->conf
, NULL
);
177 pa_client_conf_load(c
->conf
, NULL
);
178 pa_client_conf_env(c
->conf
);
180 if (!(c
->mempool
= pa_mempool_new(!c
->conf
->disable_shm
, c
->conf
->shm_size
))) {
182 if (!c
->conf
->disable_shm
)
183 c
->mempool
= pa_mempool_new(FALSE
, c
->conf
->shm_size
);
194 static void context_unlink(pa_context
*c
) {
199 s
= c
->streams
? pa_stream_ref(c
->streams
) : NULL
;
201 pa_stream
*n
= s
->next
? pa_stream_ref(s
->next
) : NULL
;
202 pa_stream_set_state(s
, c
->state
== PA_CONTEXT_FAILED
? PA_STREAM_FAILED
: PA_STREAM_TERMINATED
);
207 while (c
->operations
)
208 pa_operation_cancel(c
->operations
);
211 pa_pdispatch_unref(c
->pdispatch
);
216 pa_pstream_unlink(c
->pstream
);
217 pa_pstream_unref(c
->pstream
);
222 pa_socket_client_unref(c
->client
);
229 static void context_free(pa_context
*c
) {
234 if (c
->record_streams
)
235 pa_dynarray_free(c
->record_streams
, NULL
, NULL
);
236 if (c
->playback_streams
)
237 pa_dynarray_free(c
->playback_streams
, NULL
, NULL
);
240 pa_mempool_free(c
->mempool
);
243 pa_client_conf_free(c
->conf
);
245 pa_strlist_free(c
->server_list
);
248 pa_proplist_free(c
->proplist
);
254 pa_context
* pa_context_ref(pa_context
*c
) {
256 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
262 void pa_context_unref(pa_context
*c
) {
264 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
266 if (PA_REFCNT_DEC(c
) <= 0)
270 void pa_context_set_state(pa_context
*c
, pa_context_state_t st
) {
272 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
281 if (c
->state_callback
)
282 c
->state_callback(c
, c
->state_userdata
);
284 if (st
== PA_CONTEXT_FAILED
|| st
== PA_CONTEXT_TERMINATED
)
290 int pa_context_set_error(pa_context
*c
, int error
) {
291 pa_assert(error
>= 0);
292 pa_assert(error
< PA_ERR_MAX
);
300 void pa_context_fail(pa_context
*c
, int error
) {
302 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
304 pa_context_set_error(c
, error
);
305 pa_context_set_state(c
, PA_CONTEXT_FAILED
);
308 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
309 pa_context
*c
= userdata
;
314 pa_context_fail(c
, PA_ERR_CONNECTIONTERMINATED
);
317 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, const pa_creds
*creds
, void *userdata
) {
318 pa_context
*c
= userdata
;
326 if (pa_pdispatch_run(c
->pdispatch
, packet
, creds
, c
) < 0)
327 pa_context_fail(c
, PA_ERR_PROTOCOL
);
332 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
) {
333 pa_context
*c
= userdata
;
338 pa_assert(chunk
->memblock
);
339 pa_assert(chunk
->length
);
341 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
345 if ((s
= pa_dynarray_get(c
->record_streams
, channel
))) {
347 pa_assert(seek
== PA_SEEK_RELATIVE
);
348 pa_assert(offset
== 0);
350 pa_memblockq_seek(s
->record_memblockq
, offset
, seek
);
351 pa_memblockq_push_align(s
->record_memblockq
, chunk
);
353 if (s
->read_callback
) {
356 if ((l
= pa_memblockq_get_length(s
->record_memblockq
)) > 0)
357 s
->read_callback(s
, l
, s
->read_userdata
);
364 int pa_context_handle_error(pa_context
*c
, uint32_t command
, pa_tagstruct
*t
, pa_bool_t fail
) {
367 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
369 if (command
== PA_COMMAND_ERROR
) {
372 if (pa_tagstruct_getu32(t
, &err
) < 0 ||
373 !pa_tagstruct_eof(t
)) {
374 pa_context_fail(c
, PA_ERR_PROTOCOL
);
378 } else if (command
== PA_COMMAND_TIMEOUT
)
379 err
= PA_ERR_TIMEOUT
;
381 pa_context_fail(c
, PA_ERR_PROTOCOL
);
386 pa_context_fail(c
, PA_ERR_PROTOCOL
);
390 if (err
>= PA_ERR_MAX
)
391 err
= PA_ERR_UNKNOWN
;
394 pa_context_fail(c
, (int) err
);
398 pa_context_set_error(c
, (int) err
);
403 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
404 pa_context
*c
= userdata
;
408 pa_assert(c
->state
== PA_CONTEXT_AUTHORIZING
|| c
->state
== PA_CONTEXT_SETTING_NAME
);
412 if (command
!= PA_COMMAND_REPLY
) {
413 pa_context_handle_error(c
, command
, t
, TRUE
);
418 case PA_CONTEXT_AUTHORIZING
: {
420 pa_bool_t shm_on_remote
= FALSE
;
422 if (pa_tagstruct_getu32(t
, &c
->version
) < 0 ||
423 !pa_tagstruct_eof(t
)) {
424 pa_context_fail(c
, PA_ERR_PROTOCOL
);
428 /* Minimum supported version */
429 if (c
->version
< 8) {
430 pa_context_fail(c
, PA_ERR_VERSION
);
434 /* Starting with protocol version 13 the MSB of the version
435 tag reflects if shm is available for this connection or
437 if (c
->version
>= 13) {
438 shm_on_remote
= !!(c
->version
& 0x80000000U
);
439 c
->version
&= 0x7FFFFFFFU
;
442 pa_log_debug("Protocol version: remote %u, local %u", c
->version
, PA_PROTOCOL_VERSION
);
444 /* Enable shared memory support if possible */
446 if (c
->version
< 10 || (c
->version
>= 13 && !shm_on_remote
))
451 /* Only enable SHM if both sides are owned by the same
452 * user. This is a security measure because otherwise
453 * data private to the user might leak. */
456 const pa_creds
*creds
;
457 if (!(creds
= pa_pdispatch_creds(pd
)) || getuid() != creds
->uid
)
462 pa_log_debug("Negotiated SHM: %s", pa_yes_no(c
->do_shm
));
463 pa_pstream_enable_shm(c
->pstream
, c
->do_shm
);
465 reply
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
467 if (c
->version
>= 13) {
468 pa_init_proplist(c
->proplist
);
469 pa_tagstruct_put_proplist(reply
, c
->proplist
);
471 pa_tagstruct_puts(reply
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
473 pa_pstream_send_tagstruct(c
->pstream
, reply
);
474 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
476 pa_context_set_state(c
, PA_CONTEXT_SETTING_NAME
);
480 case PA_CONTEXT_SETTING_NAME
:
482 if ((c
->version
>= 13 && (pa_tagstruct_getu32(t
, &c
->client_index
) < 0 ||
483 c
->client_index
== PA_INVALID_INDEX
)) ||
484 !pa_tagstruct_eof(t
)) {
485 pa_context_fail(c
, PA_ERR_PROTOCOL
);
489 pa_context_set_state(c
, PA_CONTEXT_READY
);
493 pa_assert_not_reached();
500 static void setup_context(pa_context
*c
, pa_iochannel
*io
) {
509 pa_assert(!c
->pstream
);
510 c
->pstream
= pa_pstream_new(c
->mainloop
, io
, c
->mempool
);
512 pa_pstream_set_die_callback(c
->pstream
, pstream_die_callback
, c
);
513 pa_pstream_set_recieve_packet_callback(c
->pstream
, pstream_packet_callback
, c
);
514 pa_pstream_set_recieve_memblock_callback(c
->pstream
, pstream_memblock_callback
, c
);
516 pa_assert(!c
->pdispatch
);
517 c
->pdispatch
= pa_pdispatch_new(c
->mainloop
, command_table
, PA_COMMAND_MAX
);
519 if (!c
->conf
->cookie_valid
)
520 pa_log_info(_("No cookie loaded. Attempting to connect without."));
522 t
= pa_tagstruct_command(c
, PA_COMMAND_AUTH
, &tag
);
525 pa_mempool_is_shared(c
->mempool
) &&
528 pa_log_debug("SHM possible: %s", pa_yes_no(c
->do_shm
));
530 /* Starting with protocol version 13 we use the MSB of the version
531 * tag for informing the other side if we could do SHM or not */
532 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
| (c
->do_shm
? 0x80000000U
: 0));
533 pa_tagstruct_put_arbitrary(t
, c
->conf
->cookie
, sizeof(c
->conf
->cookie
));
539 if (pa_iochannel_creds_supported(io
))
540 pa_iochannel_creds_enable(io
);
542 ucred
.uid
= getuid();
543 ucred
.gid
= getgid();
545 pa_pstream_send_tagstruct_with_creds(c
->pstream
, t
, &ucred
);
548 pa_pstream_send_tagstruct(c
->pstream
, t
);
551 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, c
, NULL
);
553 pa_context_set_state(c
, PA_CONTEXT_AUTHORIZING
);
558 static char *get_old_legacy_runtime_dir(void) {
562 if (!pa_get_user_name(u
, sizeof(u
)))
565 p
= pa_sprintf_malloc("/tmp/pulse-%s", u
);
567 if (stat(p
, &st
) < 0) {
572 if (st
.st_uid
!= getuid()) {
580 static char *get_very_old_legacy_runtime_dir(void) {
584 if (!pa_get_home_dir(h
, sizeof(h
)))
587 p
= pa_sprintf_malloc("%s/.pulse", h
);
589 if (stat(p
, &st
) < 0) {
594 if (st
.st_uid
!= getuid()) {
603 static pa_strlist
*prepend_per_user(pa_strlist
*l
) {
605 static char *legacy_dir
;
607 /* The very old per-user instance path (< 0.9.11). This is supported only to ease upgrades */
608 if ((legacy_dir
= get_very_old_legacy_runtime_dir())) {
609 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
610 l
= pa_strlist_prepend(l
, p
);
612 pa_xfree(legacy_dir
);
615 /* The old per-user instance path (< 0.9.12). This is supported only to ease upgrades */
616 if ((legacy_dir
= get_old_legacy_runtime_dir())) {
617 char *p
= pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
, legacy_dir
);
618 l
= pa_strlist_prepend(l
, p
);
620 pa_xfree(legacy_dir
);
623 /* The per-user instance */
624 if ((ufn
= pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET
))) {
625 l
= pa_strlist_prepend(l
, ufn
);
634 static int context_autospawn(pa_context
*c
) {
638 pa_log_debug("Trying to autospawn...");
642 if (c
->spawn_api
.prefork
)
643 c
->spawn_api
.prefork();
645 if ((pid
= fork()) < 0) {
646 pa_log_error(_("fork(): %s"), pa_cstrerror(errno
));
647 pa_context_fail(c
, PA_ERR_INTERNAL
);
649 if (c
->spawn_api
.postfork
)
650 c
->spawn_api
.postfork();
656 const char *state
= NULL
;
658 const char * argv
[MAX_ARGS
+1];
661 if (c
->spawn_api
.atfork
)
662 c
->spawn_api
.atfork();
670 argv
[n
++] = c
->conf
->daemon_binary
;
671 argv
[n
++] = "--start";
673 while (n
< MAX_ARGS
) {
676 if (!(a
= pa_split_spaces(c
->conf
->extra_arguments
, &state
)))
684 execv(argv
[0], (char * const *) argv
);
691 if (c
->spawn_api
.postfork
)
692 c
->spawn_api
.postfork();
695 r
= waitpid(pid
, &status
, 0);
696 } while (r
< 0 && errno
== EINTR
);
699 pa_log(_("waitpid(): %s"), pa_cstrerror(errno
));
700 pa_context_fail(c
, PA_ERR_INTERNAL
);
702 } else if (!WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
703 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
718 #endif /* OS_IS_WIN32 */
720 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
);
722 static int try_next_connection(pa_context
*c
) {
727 pa_assert(!c
->client
);
733 c
->server_list
= pa_strlist_pop(c
->server_list
, &u
);
738 if (c
->do_autospawn
) {
740 if ((r
= context_autospawn(c
)) < 0)
743 /* Autospawn only once */
744 c
->do_autospawn
= FALSE
;
746 /* Connect only to per-user sockets this time */
747 c
->server_list
= prepend_per_user(c
->server_list
);
749 /* Retry connection */
754 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
758 pa_log_debug("Trying to connect to %s...", u
);
761 c
->server
= pa_xstrdup(u
);
763 if (!(c
->client
= pa_socket_client_new_string(c
->mainloop
, u
, PA_NATIVE_DEFAULT_PORT
)))
766 c
->is_local
= !!pa_socket_client_is_local(c
->client
);
767 pa_socket_client_set_callback(c
->client
, on_connection
, c
);
779 static void on_connection(pa_socket_client
*client
, pa_iochannel
*io
, void *userdata
) {
780 pa_context
*c
= userdata
;
781 int saved_errno
= errno
;
785 pa_assert(c
->state
== PA_CONTEXT_CONNECTING
);
789 pa_socket_client_unref(client
);
793 /* Try the item in the list */
794 if (saved_errno
== ECONNREFUSED
||
795 saved_errno
== ETIMEDOUT
||
796 saved_errno
== EHOSTUNREACH
) {
797 try_next_connection(c
);
801 pa_context_fail(c
, PA_ERR_CONNECTIONREFUSED
);
805 setup_context(c
, io
);
811 int pa_context_connect(
814 pa_context_flags_t flags
,
815 const pa_spawn_api
*api
) {
820 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
822 PA_CHECK_VALIDITY(c
, c
->state
== PA_CONTEXT_UNCONNECTED
, PA_ERR_BADSTATE
);
823 PA_CHECK_VALIDITY(c
, !(flags
& ~PA_CONTEXT_NOAUTOSPAWN
), PA_ERR_INVALID
);
824 PA_CHECK_VALIDITY(c
, !server
|| *server
, PA_ERR_INVALID
);
827 server
= c
->conf
->default_server
;
831 pa_assert(!c
->server_list
);
834 if (!(c
->server_list
= pa_strlist_parse(server
))) {
835 pa_context_fail(c
, PA_ERR_INVALIDSERVER
);
842 /* Prepend in reverse order */
844 /* Follow the X display */
845 if ((d
= getenv("DISPLAY"))) {
848 if ((e
= strchr(d
, ':')))
852 c
->server_list
= pa_strlist_prepend(c
->server_list
, d
);
857 /* Add TCP/IP on the localhost */
858 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp6:[::1]");
859 c
->server_list
= pa_strlist_prepend(c
->server_list
, "tcp4:127.0.0.1");
861 /* The system wide instance via PF_LOCAL */
862 c
->server_list
= pa_strlist_prepend(c
->server_list
, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET
);
864 /* The user instance via PF_LOCAL */
865 c
->server_list
= prepend_per_user(c
->server_list
);
867 /* Set up autospawning */
868 if (!(flags
& PA_CONTEXT_NOAUTOSPAWN
) && c
->conf
->autospawn
) {
871 pa_log_debug("Not doing autospawn since we are root.");
873 c
->do_autospawn
= TRUE
;
881 pa_context_set_state(c
, PA_CONTEXT_CONNECTING
);
882 r
= try_next_connection(c
);
890 void pa_context_disconnect(pa_context
*c
) {
892 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
894 if (PA_CONTEXT_IS_GOOD(c
->state
))
895 pa_context_set_state(c
, PA_CONTEXT_TERMINATED
);
898 pa_context_state_t
pa_context_get_state(pa_context
*c
) {
900 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
905 int pa_context_errno(pa_context
*c
) {
907 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
912 void pa_context_set_state_callback(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
914 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
916 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
919 c
->state_callback
= cb
;
920 c
->state_userdata
= userdata
;
923 void pa_context_set_event_callback(pa_context
*c
, pa_context_event_cb_t cb
, void *userdata
) {
925 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
927 if (c
->state
== PA_CONTEXT_TERMINATED
|| c
->state
== PA_CONTEXT_FAILED
)
930 c
->event_callback
= cb
;
931 c
->event_userdata
= userdata
;
934 int pa_context_is_pending(pa_context
*c
) {
936 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
938 PA_CHECK_VALIDITY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
);
940 return (c
->pstream
&& pa_pstream_is_pending(c
->pstream
)) ||
941 (c
->pdispatch
&& pa_pdispatch_is_pending(c
->pdispatch
)) ||
945 static void set_dispatch_callbacks(pa_operation
*o
);
947 static void pdispatch_drain_callback(pa_pdispatch
*pd
, void *userdata
) {
948 set_dispatch_callbacks(userdata
);
951 static void pstream_drain_callback(pa_pstream
*s
, void *userdata
) {
952 set_dispatch_callbacks(userdata
);
955 static void set_dispatch_callbacks(pa_operation
*o
) {
959 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
960 pa_assert(o
->context
);
961 pa_assert(PA_REFCNT_VALUE(o
->context
) >= 1);
962 pa_assert(o
->context
->state
== PA_CONTEXT_READY
);
964 pa_pstream_set_drain_callback(o
->context
->pstream
, NULL
, NULL
);
965 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, NULL
, NULL
);
967 if (pa_pdispatch_is_pending(o
->context
->pdispatch
)) {
968 pa_pdispatch_set_drain_callback(o
->context
->pdispatch
, pdispatch_drain_callback
, o
);
972 if (pa_pstream_is_pending(o
->context
->pstream
)) {
973 pa_pstream_set_drain_callback(o
->context
->pstream
, pstream_drain_callback
, o
);
979 pa_context_notify_cb_t cb
= (pa_context_notify_cb_t
) o
->callback
;
980 cb(o
->context
, o
->userdata
);
983 pa_operation_done(o
);
984 pa_operation_unref(o
);
988 pa_operation
* pa_context_drain(pa_context
*c
, pa_context_notify_cb_t cb
, void *userdata
) {
992 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
994 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
995 PA_CHECK_VALIDITY_RETURN_NULL(c
, pa_context_is_pending(c
), PA_ERR_BADSTATE
);
997 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
998 set_dispatch_callbacks(pa_operation_ref(o
));
1003 void pa_context_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1004 pa_operation
*o
= userdata
;
1009 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
1014 if (command
!= PA_COMMAND_REPLY
) {
1015 if (pa_context_handle_error(o
->context
, command
, t
, FALSE
) < 0)
1019 } else if (!pa_tagstruct_eof(t
)) {
1020 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
1025 pa_context_success_cb_t cb
= (pa_context_success_cb_t
) o
->callback
;
1026 cb(o
->context
, success
, o
->userdata
);
1030 pa_operation_done(o
);
1031 pa_operation_unref(o
);
1034 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
) {
1040 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1042 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1044 o
= pa_operation_new(c
, NULL
, cb
, userdata
);
1046 t
= pa_tagstruct_command(c
, command
, &tag
);
1047 pa_pstream_send_tagstruct(c
->pstream
, t
);
1048 pa_pdispatch_register_reply(c
->pdispatch
, tag
, DEFAULT_TIMEOUT
, internal_cb
, pa_operation_ref(o
), (pa_free_cb_t
) pa_operation_unref
);
1053 pa_operation
* pa_context_exit_daemon(pa_context
*c
, pa_context_success_cb_t cb
, void *userdata
) {
1055 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1057 return pa_context_send_simple_command(c
, PA_COMMAND_EXIT
, pa_context_simple_ack_callback
, (pa_operation_cb_t
) cb
, userdata
);
1060 pa_operation
* pa_context_set_default_sink(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_SINK
, &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 pa_operation
* pa_context_set_default_source(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1085 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1087 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1089 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1090 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_DEFAULT_SOURCE
, &tag
);
1091 pa_tagstruct_puts(t
, name
);
1092 pa_pstream_send_tagstruct(c
->pstream
, t
);
1093 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
);
1098 int pa_context_is_local(pa_context
*c
) {
1100 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1102 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, -1);
1104 return !!c
->is_local
;
1107 pa_operation
* pa_context_set_name(pa_context
*c
, const char *name
, pa_context_success_cb_t cb
, void *userdata
) {
1111 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1114 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1116 if (c
->version
>= 13) {
1117 pa_proplist
*p
= pa_proplist_new();
1119 pa_proplist_sets(p
, PA_PROP_APPLICATION_NAME
, name
);
1120 o
= pa_context_proplist_update(c
, PA_UPDATE_REPLACE
, p
, cb
, userdata
);
1121 pa_proplist_free(p
);
1126 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1127 t
= pa_tagstruct_command(c
, PA_COMMAND_SET_CLIENT_NAME
, &tag
);
1128 pa_tagstruct_puts(t
, name
);
1129 pa_pstream_send_tagstruct(c
->pstream
, t
);
1130 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
);
1136 const char* pa_get_library_version(void) {
1137 return PACKAGE_VERSION
;
1140 const char* pa_context_get_server(pa_context
*c
) {
1142 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1147 if (*c
->server
== '{') {
1148 char *e
= strchr(c
->server
+1, '}');
1149 return e
? e
+1 : c
->server
;
1155 uint32_t pa_context_get_protocol_version(pa_context
*c
) {
1156 return PA_PROTOCOL_VERSION
;
1159 uint32_t pa_context_get_server_protocol_version(pa_context
*c
) {
1161 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1163 PA_CHECK_VALIDITY_RETURN_ANY(c
, PA_CONTEXT_IS_GOOD(c
->state
), PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1168 pa_tagstruct
*pa_tagstruct_command(pa_context
*c
, uint32_t command
, uint32_t *tag
) {
1174 t
= pa_tagstruct_new(NULL
, 0);
1175 pa_tagstruct_putu32(t
, command
);
1176 pa_tagstruct_putu32(t
, *tag
= c
->ctag
++);
1181 uint32_t pa_context_get_index(pa_context
*c
) {
1183 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1185 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
1186 PA_CHECK_VALIDITY_RETURN_ANY(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
, PA_INVALID_INDEX
);
1188 return c
->client_index
;
1191 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
) {
1197 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1199 PA_CHECK_VALIDITY_RETURN_NULL(c
, mode
== PA_UPDATE_SET
|| mode
== PA_UPDATE_MERGE
|| mode
== PA_UPDATE_REPLACE
, PA_ERR_INVALID
);
1200 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1201 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1203 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1205 t
= pa_tagstruct_command(c
, PA_COMMAND_UPDATE_CLIENT_PROPLIST
, &tag
);
1206 pa_tagstruct_putu32(t
, (uint32_t) mode
);
1207 pa_tagstruct_put_proplist(t
, p
);
1209 pa_pstream_send_tagstruct(c
->pstream
, t
);
1210 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
);
1212 /* Please note that we don't update c->proplist here, because we
1213 * don't export that field */
1218 pa_operation
*pa_context_proplist_remove(pa_context
*c
, const char *const keys
[], pa_context_success_cb_t cb
, void *userdata
) {
1222 const char * const *k
;
1225 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1227 PA_CHECK_VALIDITY_RETURN_NULL(c
, keys
&& keys
[0], PA_ERR_INVALID
);
1228 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
1229 PA_CHECK_VALIDITY_RETURN_NULL(c
, c
->version
>= 13, PA_ERR_NOTSUPPORTED
);
1231 o
= pa_operation_new(c
, NULL
, (pa_operation_cb_t
) cb
, userdata
);
1233 t
= pa_tagstruct_command(c
, PA_COMMAND_REMOVE_CLIENT_PROPLIST
, &tag
);
1235 for (k
= keys
; *k
; k
++)
1236 pa_tagstruct_puts(t
, *k
);
1238 pa_tagstruct_puts(t
, NULL
);
1240 pa_pstream_send_tagstruct(c
->pstream
, t
);
1241 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
);
1243 /* Please note that we don't update c->proplist here, because we
1244 * don't export that field */
1249 void pa_command_extension(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1250 pa_context
*c
= userdata
;
1255 pa_assert(command
== PA_COMMAND_EXTENSION
);
1258 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1262 if (c
->version
< 15) {
1263 pa_context_fail(c
, PA_ERR_PROTOCOL
);
1267 if (pa_tagstruct_getu32(t
, &idx
) < 0 ||
1268 pa_tagstruct_gets(t
, &name
) < 0) {
1269 pa_context_fail(c
, PA_ERR_PROTOCOL
);
1273 if (!strcmp(name
, "module-stream-restore"))
1274 pa_ext_stream_restore_command(c
, tag
, t
);
1276 pa_log(_("Received message for unknown extension '%s'"), name
);
1279 pa_context_unref(c
);
1283 void pa_command_client_event(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1284 pa_context
*c
= userdata
;
1285 pa_proplist
*pl
= NULL
;
1289 pa_assert(command
== PA_COMMAND_CLIENT_EVENT
);
1292 pa_assert(PA_REFCNT_VALUE(c
) >= 1);
1296 if (c
->version
< 15) {
1297 pa_context_fail(c
, PA_ERR_PROTOCOL
);
1301 pl
= pa_proplist_new();
1303 if (pa_tagstruct_gets(t
, &event
) < 0 ||
1304 pa_tagstruct_get_proplist(t
, pl
) < 0 ||
1305 !pa_tagstruct_eof(t
) || !event
) {
1306 pa_context_fail(c
, PA_ERR_PROTOCOL
);
1310 if (c
->event_callback
)
1311 c
->event_callback(c
, event
, pl
, c
->event_userdata
);
1314 pa_context_unref(c
);
1317 pa_proplist_free(pl
);