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 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 #include <pulsecore/idxset.h>
  31 #include <pulsecore/hashmap.h>
  32 #include <pulsecore/memblock.h>
  33 #include <pulsecore/resampler.h>
  34 #include <pulsecore/queue.h>
  35 #include <pulsecore/llist.h>
  36 #include <pulsecore/hook-list.h>
  37 #include <pulsecore/asyncmsgq.h>
  38 #include <pulsecore/sample-util.h>
  39 #include <pulsecore/sink.h>
  40 #include <pulsecore/source.h>
  41 #include <pulsecore/core-subscribe.h>
  42 #include <pulsecore/sink-input.h>
  43 #include <pulsecore/msgobject.h>
  44
  45 typedef enum pa_core_state {
  46     PA_CORE_STARTUP,
  47     PA_CORE_RUNNING,
  48     PA_CORE_SHUTDOWN
  49 } pa_core_state_t;
  50
  51 typedef enum pa_core_hook {
  52     PA_CORE_HOOK_SINK_NEW,
  53     PA_CORE_HOOK_SINK_FIXATE,
  54     PA_CORE_HOOK_SINK_PUT,
  55     PA_CORE_HOOK_SINK_UNLINK,
  56     PA_CORE_HOOK_SINK_UNLINK_POST,
  57     PA_CORE_HOOK_SINK_STATE_CHANGED,
  58     PA_CORE_HOOK_SINK_PROPLIST_CHANGED,
  59     PA_CORE_HOOK_SOURCE_NEW,
  60     PA_CORE_HOOK_SOURCE_FIXATE,
  61     PA_CORE_HOOK_SOURCE_PUT,
  62     PA_CORE_HOOK_SOURCE_UNLINK,
  63     PA_CORE_HOOK_SOURCE_UNLINK_POST,
  64     PA_CORE_HOOK_SOURCE_STATE_CHANGED,
  65     PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED,
  66     PA_CORE_HOOK_SINK_INPUT_NEW,
  67     PA_CORE_HOOK_SINK_INPUT_FIXATE,
  68     PA_CORE_HOOK_SINK_INPUT_PUT,
  69     PA_CORE_HOOK_SINK_INPUT_UNLINK,
  70     PA_CORE_HOOK_SINK_INPUT_UNLINK_POST,
  71     PA_CORE_HOOK_SINK_INPUT_MOVE_START,
  72     PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH,
  73     PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED,
  74     PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED,
  75     PA_CORE_HOOK_SINK_INPUT_SET_VOLUME,
  76     PA_CORE_HOOK_SOURCE_OUTPUT_NEW,
  77     PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE,
  78     PA_CORE_HOOK_SOURCE_OUTPUT_PUT,
  79     PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK,
  80     PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST,
  81     PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START,
  82     PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH,
  83     PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED,
  84     PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED,
  85     PA_CORE_HOOK_CLIENT_NEW,
  86     PA_CORE_HOOK_CLIENT_PUT,
  87     PA_CORE_HOOK_CLIENT_UNLINK,
  88     PA_CORE_HOOK_CARD_NEW,
  89     PA_CORE_HOOK_CARD_PUT,
  90     PA_CORE_HOOK_CARD_UNLINK,
  91     PA_CORE_HOOK_MAX
  92 } pa_core_hook_t;
  93
  94 /* The core structure of PulseAudio. Every PulseAudio daemon contains
  95  * exactly one of these. It is used for storing kind of global
  96  * variables for the daemon. */
  97
  98 struct pa_core {
  99     pa_msgobject parent;
 100
 101     pa_core_state_t state;
 102
 103     /* A random value which may be used to identify this instance of
 104      * PulseAudio. Not cryptographically secure in any way. */
 105     uint32_t cookie;
 106
 107     pa_mainloop_api *mainloop;
 108
 109     /* idxset of all kinds of entities */
 110     pa_idxset *clients, *cards, *sinks, *sources, *sink_inputs, *source_outputs, *modules, *scache;
 111
 112     /* Some hashmaps for all sorts of entities */
 113     pa_hashmap *namereg, *shared;
 114
 115     /* The default sink/source */
 116     pa_source *default_source;
 117     pa_sink *default_sink;
 118
 119     pa_sample_spec default_sample_spec;
 120     unsigned default_n_fragments, default_fragment_size_msec;
 121
 122     pa_defer_event *module_defer_unload_event;
 123
 124     pa_defer_event *subscription_defer_event;
 125     PA_LLIST_HEAD(pa_subscription, subscriptions);
 126     PA_LLIST_HEAD(pa_subscription_event, subscription_event_queue);
 127     pa_subscription_event *subscription_event_last;
 128
 129     pa_mempool *mempool;
 130     pa_silence_cache silence_cache;
 131
 132     pa_time_event *exit_event;
 133     pa_time_event *scache_auto_unload_event;
 134
 135     int exit_idle_time, scache_idle_time;
 136
 137     pa_bool_t flat_volumes:1;
 138     pa_bool_t disallow_module_loading:1;
 139     pa_bool_t disallow_exit:1;
 140     pa_bool_t running_as_daemon:1;
 141     pa_bool_t realtime_scheduling:1;
 142     pa_bool_t disable_remixing:1;
 143     pa_bool_t disable_lfe_remixing:1;
 144
 145     pa_resample_method_t resample_method;
 146     int realtime_priority;
 147
 148     /* hooks */
 149     pa_hook hooks[PA_CORE_HOOK_MAX];
 150 };
 151
 152 PA_DECLARE_CLASS(pa_core);
 153 #define PA_CORE(o) pa_core_cast(o)
 154
 155 enum {
 156     PA_CORE_MESSAGE_UNLOAD_MODULE,
 157     PA_CORE_MESSAGE_MAX
 158 };
 159
 160 pa_core* pa_core_new(pa_mainloop_api *m, pa_bool_t shared, size_t shm_size);
 161
 162 /* Check whether noone is connected to this core */
 163 void pa_core_check_idle(pa_core *c);
 164
 165 int pa_core_exit(pa_core *c, pa_bool_t force, int retval);
 166
 167 #endif