code.delx.au - pulseaudio/blob - src/pulsecore/core.h

   1 #ifndef foocorehfoo
   2 #define foocorehfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8
   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.1 of the License,
  12   or (at your option) any later version.
  13
  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.
  18
  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
  22   USA.
  23 ***/
  24
  25 #include <pulse/mainloop-api.h>
  26 #include <pulse/sample.h>
  27 #include <pulsecore/cpu.h>
  28
  29 typedef struct pa_core pa_core;
  30
  31 /* This is a bitmask that encodes the cause why a sink/source is
  32  * suspended. */
  33 typedef enum pa_suspend_cause {
  34     PA_SUSPEND_USER = 1,         /* Exposed to the user via some protocol */
  35     PA_SUSPEND_APPLICATION = 2,  /* Used by the device reservation logic */
  36     PA_SUSPEND_IDLE = 4,         /* Used by module-suspend-on-idle */
  37     PA_SUSPEND_SESSION = 8,      /* Used by module-hal for mark inactive sessions */
  38     PA_SUSPEND_PASSTHROUGH = 16, /* Used to suspend monitor sources when the sink is in passthrough mode */
  39     PA_SUSPEND_ALL = 0xFFFF      /* Magic cause that can be used to resume forcibly */
  40 } pa_suspend_cause_t;
  41
  42 #include <pulsecore/idxset.h>
  43 #include <pulsecore/hashmap.h>
  44 #include <pulsecore/memblock.h>
  45 #include <pulsecore/resampler.h>
  46 #include <pulsecore/llist.h>
  47 #include <pulsecore/hook-list.h>
  48 #include <pulsecore/asyncmsgq.h>
  49 #include <pulsecore/sample-util.h>
  50 #include <pulsecore/sink.h>
  51 #include <pulsecore/source.h>
  52 #include <pulsecore/core-subscribe.h>
  53 #include <pulsecore/msgobject.h>
  54
  55 typedef enum pa_server_type {
  56     PA_SERVER_TYPE_UNSET,
  57     PA_SERVER_TYPE_USER,
  58     PA_SERVER_TYPE_SYSTEM,
  59     PA_SERVER_TYPE_NONE
  60 } pa_server_type_t;
  61
  62 typedef enum pa_core_state {
  63     PA_CORE_STARTUP,
  64     PA_CORE_RUNNING,
  65     PA_CORE_SHUTDOWN
  66 } pa_core_state_t;
  67
  68 typedef enum pa_core_hook {
  69     PA_CORE_HOOK_SINK_NEW,
  70     PA_CORE_HOOK_SINK_FIXATE,
  71     PA_CORE_HOOK_SINK_PUT,
  72     PA_CORE_HOOK_SINK_UNLINK,
  73     PA_CORE_HOOK_SINK_UNLINK_POST,
  74     PA_CORE_HOOK_SINK_STATE_CHANGED,
  75     PA_CORE_HOOK_SINK_PROPLIST_CHANGED,
  76     PA_CORE_HOOK_SINK_PORT_CHANGED,
  77     PA_CORE_HOOK_SOURCE_NEW,
  78     PA_CORE_HOOK_SOURCE_FIXATE,
  79     PA_CORE_HOOK_SOURCE_PUT,
  80     PA_CORE_HOOK_SOURCE_UNLINK,
  81     PA_CORE_HOOK_SOURCE_UNLINK_POST,
  82     PA_CORE_HOOK_SOURCE_STATE_CHANGED,
  83     PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED,
  84     PA_CORE_HOOK_SOURCE_PORT_CHANGED,
  85     PA_CORE_HOOK_SINK_INPUT_NEW,
  86     PA_CORE_HOOK_SINK_INPUT_FIXATE,
  87     PA_CORE_HOOK_SINK_INPUT_PUT,
  88     PA_CORE_HOOK_SINK_INPUT_UNLINK,
  89     PA_CORE_HOOK_SINK_INPUT_UNLINK_POST,
  90     PA_CORE_HOOK_SINK_INPUT_MOVE_START,
  91     PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH,
  92     PA_CORE_HOOK_SINK_INPUT_MOVE_FAIL,
  93     PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED,
  94     PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED,
  95     PA_CORE_HOOK_SINK_INPUT_SEND_EVENT,
  96     PA_CORE_HOOK_SOURCE_OUTPUT_NEW,
  97     PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE,
  98     PA_CORE_HOOK_SOURCE_OUTPUT_PUT,
  99     PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK,
 100     PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST,
 101     PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START,
 102     PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH,
 103     PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL,
 104     PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED,
 105     PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED,
 106     PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT,
 107     PA_CORE_HOOK_CLIENT_NEW,
 108     PA_CORE_HOOK_CLIENT_PUT,
 109     PA_CORE_HOOK_CLIENT_UNLINK,
 110     PA_CORE_HOOK_CLIENT_PROPLIST_CHANGED,
 111     PA_CORE_HOOK_CLIENT_SEND_EVENT,
 112     PA_CORE_HOOK_CARD_NEW,
 113     PA_CORE_HOOK_CARD_PUT,
 114     PA_CORE_HOOK_CARD_UNLINK,
 115     PA_CORE_HOOK_CARD_PROFILE_CHANGED,
 116     PA_CORE_HOOK_CARD_PROFILE_ADDED,
 117     PA_CORE_HOOK_CARD_PROFILE_AVAILABLE_CHANGED,
 118     PA_CORE_HOOK_PORT_AVAILABLE_CHANGED,
 119     PA_CORE_HOOK_PORT_ADDED,
 120     PA_CORE_HOOK_PORT_LATENCY_OFFSET_CHANGED,
 121     PA_CORE_HOOK_MAX
 122 } pa_core_hook_t;
 123
 124 /* The core structure of PulseAudio. Every PulseAudio daemon contains
 125  * exactly one of these. It is used for storing kind of global
 126  * variables for the daemon. */
 127
 128 struct pa_core {
 129     pa_msgobject parent;
 130
 131     pa_core_state_t state;
 132
 133     /* A random value which may be used to identify this instance of
 134      * PulseAudio. Not cryptographically secure in any way. */
 135     uint32_t cookie;
 136
 137     pa_mainloop_api *mainloop;
 138
 139     /* idxset of all kinds of entities */
 140     pa_idxset *clients, *cards, *sinks, *sources, *sink_inputs, *source_outputs, *modules, *scache;
 141
 142     /* Some hashmaps for all sorts of entities */
 143     pa_hashmap *namereg, *shared;
 144
 145     /* The default sink/source */
 146     pa_source *default_source;
 147     pa_sink *default_sink;
 148
 149     pa_channel_map default_channel_map;
 150     pa_sample_spec default_sample_spec;
 151     uint32_t alternate_sample_rate;
 152     unsigned default_n_fragments, default_fragment_size_msec;
 153     unsigned deferred_volume_safety_margin_usec;
 154     int deferred_volume_extra_delay_usec;
 155
 156     pa_defer_event *module_defer_unload_event;
 157
 158     pa_defer_event *subscription_defer_event;
 159     PA_LLIST_HEAD(pa_subscription, subscriptions);
 160     PA_LLIST_HEAD(pa_subscription_event, subscription_event_queue);
 161     pa_subscription_event *subscription_event_last;
 162
 163     pa_mempool *mempool;
 164     pa_silence_cache silence_cache;
 165
 166     pa_time_event *exit_event;
 167     pa_time_event *scache_auto_unload_event;
 168
 169     int exit_idle_time, scache_idle_time;
 170
 171     pa_bool_t flat_volumes:1;
 172     pa_bool_t disallow_module_loading:1;
 173     pa_bool_t disallow_exit:1;
 174     pa_bool_t running_as_daemon:1;
 175     pa_bool_t realtime_scheduling:1;
 176     pa_bool_t disable_remixing:1;
 177     pa_bool_t disable_lfe_remixing:1;
 178     pa_bool_t deferred_volume:1;
 179
 180     pa_resample_method_t resample_method;
 181     int realtime_priority;
 182
 183     pa_server_type_t server_type;
 184     pa_cpu_info cpu_info;
 185
 186     /* hooks */
 187     pa_hook hooks[PA_CORE_HOOK_MAX];
 188 };
 189
 190 PA_DECLARE_PUBLIC_CLASS(pa_core);
 191 #define PA_CORE(o) pa_core_cast(o)
 192
 193 enum {
 194     PA_CORE_MESSAGE_UNLOAD_MODULE,
 195     PA_CORE_MESSAGE_MAX
 196 };
 197
 198 pa_core* pa_core_new(pa_mainloop_api *m, pa_bool_t shared, size_t shm_size);
 199
 200 /* Check whether no one is connected to this core */
 201 void pa_core_check_idle(pa_core *c);
 202
 203 int pa_core_exit(pa_core *c, pa_bool_t force, int retval);
 204
 205 void pa_core_maybe_vacuum(pa_core *c);
 206
 207 /* wrapper for c->mainloop->time_*() RT time events */
 208 pa_time_event* pa_core_rttime_new(pa_core *c, pa_usec_t usec, pa_time_event_cb_t cb, void *userdata);
 209 void pa_core_rttime_restart(pa_core *c, pa_time_event *e, pa_usec_t usec);
 210
 211 #endif