X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/045c1d602dcba57868845ba3270510593c39480f..e11b699d45fa3dca2cde8a976cbf25490f5501a4:/src/pulse/context.h diff --git a/src/pulse/context.h b/src/pulse/context.h index 143508f4..3b8b9be7 100644 --- a/src/pulse/context.h +++ b/src/pulse/context.h @@ -1,8 +1,6 @@ #ifndef foocontexthfoo #define foocontexthfoo -/* $Id$ */ - /*** This file is part of PulseAudio. @@ -11,7 +9,7 @@ PulseAudio is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published - by the Free Software Foundation; either version 2 of the License, + by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. PulseAudio is distributed in the hope that it will be useful, but @@ -31,13 +29,14 @@ #include #include #include +#include /** \page async Asynchronous API * * \section overv_sec Overview * * The asynchronous API is the native interface to the PulseAudio library. - * It allows full access to all available functions. This also means that + * It allows full access to all available functionality. This however means that * it is rather complex and can take some time to fully master. * * \section mainloop_sec Main Loop Abstraction @@ -49,14 +48,14 @@ * that some implementations may block all other events * when a deferred event is active. * \li I/O events - Events that trigger on file descriptor activities. - * \li Times events - Events that trigger after a fixed ammount of time. + * \li Times events - Events that trigger after a fixed amount of time. * * The abstraction is represented as a number of function pointers in the * pa_mainloop_api structure. * * To actually be able to use these functions, an implementation needs to * be coupled to the abstraction. There are three of these shipped with - * PulseAudio, but any other can be used with a minimal ammount of work, + * PulseAudio, but any other can be used with a minimal amount of work, * provided it supports the three basic events listed above. * * The implementations shipped with PulseAudio are: @@ -66,8 +65,7 @@ * implementation where all of PulseAudio's * internal handling runs in a separate * thread. - * \li \subpage glib-mainloop - A wrapper around GLIB's main loop. Available - * for both GLIB 1.2 and GLIB 2.x. + * \li \subpage glib-mainloop - A wrapper around GLib's main loop. * * UNIX signals may be hooked to a main loop using the functions from * \ref mainloop-signal.h. These rely only on the main loop abstraction @@ -145,15 +143,12 @@ */ /** \file - * Connection contexts for asynchrononous communication with a + * Connection contexts for asynchronous communication with a * server. A pa_context object wraps a connection to a PulseAudio - * server using its native protocol. */ - -/** \example pacat.c - * A playback and recording tool using the asynchronous API */ - -/** \example paplay.c - * A sound file playback tool using the asynchronous API, based on libsndfile */ + * server using its native protocol. + * + * See also \subpage async + */ PA_C_DECL_BEGIN @@ -166,13 +161,20 @@ typedef void (*pa_context_notify_cb_t)(pa_context *c, void *userdata); /** A generic callback for operation completion */ typedef void (*pa_context_success_cb_t) (pa_context *c, int success, void *userdata); +/** A callback for asynchronous meta/policy event messages. The set + * of defined events can be extended at any time. Also, server modules + * may introduce additional message types so make sure that your + * callback function ignores messages it doesn't know. \since + * 0.9.15 */ +typedef void (*pa_context_event_cb_t)(pa_context *c, const char *name, pa_proplist *p, void *userdata); + /** Instantiate a new connection context with an abstract mainloop API * and an application name. It is recommended to use pa_context_new_with_proplist() * instead and specify some initial properties.*/ pa_context *pa_context_new(pa_mainloop_api *mainloop, const char *name); /** Instantiate a new connection context with an abstract mainloop API - * and an application name, and specify the the initial client property + * and an application name, and specify the initial client property * list. \since 0.9.11 */ pa_context *pa_context_new_with_proplist(pa_mainloop_api *mainloop, const char *name, pa_proplist *proplist); @@ -185,6 +187,10 @@ pa_context* pa_context_ref(pa_context *c); /** Set a callback function that is called whenever the context status changes */ void pa_context_set_state_callback(pa_context *c, pa_context_notify_cb_t cb, void *userdata); +/** Set a callback function that is called whenever a meta/policy + * control event is received. \since 0.9.15 */ +void pa_context_set_event_callback(pa_context *p, pa_context_event_cb_t cb, void *userdata); + /** Return the error number of the last failed operation */ int pa_context_errno(pa_context *c); @@ -198,9 +204,10 @@ pa_context_state_t pa_context_get_state(pa_context *c); connect to the default server. This routine may but will not always return synchronously on error. Use pa_context_set_state_callback() to be notified when the connection is established. If flags doesn't have -PA_NOAUTOSPAWN set and no specific server is specified or accessible a -new daemon is spawned. If api is non-NULL, the functions specified in -the structure are used when forking a new child process. */ +PA_CONTEXT_NOAUTOSPAWN set and no specific server is specified or +accessible a new daemon is spawned. If api is non-NULL, the functions +specified in the structure are used when forking a new child +process. */ int pa_context_connect(pa_context *c, const char *server, pa_context_flags_t flags, const pa_spawn_api *api); /** Terminate the context connection immediately */ @@ -210,7 +217,7 @@ void pa_context_disconnect(pa_context *c); pa_operation* pa_context_drain(pa_context *c, pa_context_notify_cb_t cb, void *userdata); /** Tell the daemon to exit. The returned operation is unlikely to - * complete succesfully, since the daemon probably died before + * complete successfully, since the daemon probably died before * returning a success notification */ pa_operation* pa_context_exit_daemon(pa_context *c, pa_context_success_cb_t cb, void *userdata); @@ -235,14 +242,14 @@ uint32_t pa_context_get_protocol_version(pa_context *c); /** Return the protocol version of the connected server. */ uint32_t pa_context_get_server_protocol_version(pa_context *c); -/* Update the property list of the client, adding new entries. Please +/** Update the property list of the client, adding new entries. Please * note that it is highly recommended to set as much properties * initially via pa_context_new_with_proplist() as possible instead a * posteriori with this function, since that information may then be * used to route streams of the client to the right device. \since 0.9.11 */ 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); -/* Update the property list of the client, remove entries. \since 0.9.11 */ +/** Update the property list of the client, remove entries. \since 0.9.11 */ pa_operation *pa_context_proplist_remove(pa_context *c, const char *const keys[], pa_context_success_cb_t cb, void *userdata); /** Return the client index this context is @@ -250,6 +257,37 @@ pa_operation *pa_context_proplist_remove(pa_context *c, const char *const keys[] * introspection functions, such as pa_context_get_client_info(). \since 0.9.11 */ uint32_t pa_context_get_index(pa_context *s); +/** Create a new timer event source for the specified time (wrapper + * for mainloop->time_new). \since 0.9.16 */ +pa_time_event* pa_context_rttime_new(pa_context *c, pa_usec_t usec, pa_time_event_cb_t cb, void *userdata); + +/** Restart a running or expired timer event source (wrapper for + * mainloop->time_restart). \since 0.9.16 */ +void pa_context_rttime_restart(pa_context *c, pa_time_event *e, pa_usec_t usec); + +/** Return the optimal block size for passing around audio buffers. It + * is recommended to allocate buffers of the size returned here when + * writing audio data to playback streams, if the latency constraints + * permit this. It is not recommended writing larger blocks than this + * because usually they will then be split up internally into chunks + * of this size. It is not recommended writing smaller blocks than + * this (unless required due to latency demands) because this + * increases CPU usage. If ss is NULL you will be returned the + * byte-exact tile size. If you pass a valid ss, then the tile size + * will be rounded down to multiple of the frame size. This is + * supposed to be used in a construct such as + * pa_context_get_tile_size(pa_stream_get_context(s), + * pa_stream_get_sample_spec(ss)); \since 0.9.20 */ +size_t pa_context_get_tile_size(pa_context *c, const pa_sample_spec *ss); + +/** Load the authentication cookie from a file. This function is primarily + * meant for PulseAudio's own tunnel modules, which need to load the cookie + * from a custom location. Applications don't usually need to care about the + * cookie at all, but if it happens that you know what the authentication + * cookie is and your application needs to load it from a non-standard + * location, feel free to use this function. \since 5.0 */ +int pa_context_load_cookie_from_file(pa_context *c, const char *cookie_file_path); + PA_C_DECL_END #endif