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