Merge commit 'origin/master-tx'
[platform/upstream/pulseaudio.git] / src / pulsecore / shmasyncq.h
1 #ifndef foopulseshmasyncqhfoo
2 #define foopulseshmasyncqhfoo
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
11   published by the Free Software Foundation; either version 2.1 of the
12   License, 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   Lesser General Public License for more details.
18
19   You should have received a copy of the GNU Lesser General Public
20   License 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 <sys/types.h>
26
27 #include <pulse/def.h>
28 #include <pulsecore/macro.h>
29
30 /* Similar to pa_asyncq, but stores data in a shared memory segment */
31
32
33 struct pa_shmasyncq_data {
34     unsigned n_elements;
35     size_t element_size;
36     unsigned read_idx;
37     unsigned write_idx;
38     pa_fdsem_data read_fdsem_data, write_fdsem_data;
39 };
40
41 #define PA_SHMASYNCQ_DEFAULT_N_ELEMENTS 128
42 #define PA_SHMASYNCQ_SIZE(n_elements, element_size) (PA_ALIGN(sizeof(pa_shmasyncq_data)) + (((n_elements) * (PA_ALIGN(sizeof(pa_atomic_t)) + PA_ALIGN(element_size)))))
43 #define PA_SHMASYNCQ_DEFAULT_SIZE(element_size) PA_SHMASYNCQ_SIZE(PA_SHMASYNCQ_DEFAULT_N_ELEMENTS, element_size)
44
45 typedef struct pa_shmasyncq pa_shmasyncq;
46
47 pa_shmasyncq *pa_shmasyncq_new(unsigned n_elements, size_t element_size, void *data, int fd[2]);
48 void pa_shmasyncq_free(pa_shmasyncq* q, pa_free_cb_t free_cb);
49
50 void* pa_shmasyncq_pop_begin(pa_shmasyncq *q, pa_bool_t wait);
51 void pa_shmasyncq_pop_commit(pa_shmasyncq *q);
52
53 int* pa_shmasyncq_push_begin(pa_shmasyncq *q, pa_bool_t wait);
54 void pa_shmasyncq_push_commit(pa_shmasyncq *q);
55
56 int pa_shmasyncq_get_fd(pa_shmasyncq *q);
57 int pa_shmasyncq_before_poll(pa_shmasyncq *a);
58 void pa_shmasyncq_after_poll(pa_shmasyncq *a);
59
60 #endif