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