format: Const-ify some parameters
[platform/upstream/pulseaudio.git] / src / pulse / format.c
1 /***
2   This file is part of PulseAudio.
3
4   Copyright 2011 Intel Corporation
5   Copyright 2011 Collabora Multimedia
6   Copyright 2011 Arun Raghavan <arun.raghavan@collabora.co.uk>
7
8   PulseAudio is free software; you can redistribute it and/or modify
9   it under the terms of the GNU Lesser General Public License as published
10   by the Free Software Foundation; either version 2.1 of the License,
11   or (at your option) any later version.
12
13   PulseAudio is distributed in the hope that it will be useful, but
14   WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   General Public License for more details.
17
18   You should have received a copy of the GNU Lesser General Public License
19   along with PulseAudio; if not, write to the Free Software
20   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21   USA.
22 ***/
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <pulse/internal.h>
29 #include <pulse/xmalloc.h>
30
31 #include <pulsecore/core-util.h>
32 #include <pulsecore/macro.h>
33
34 #include "format.h"
35
36 pa_format_info* pa_format_info_new(void) {
37     pa_format_info *f = pa_xnew(pa_format_info, 1);
38
39     f->encoding = PA_ENCODING_INVALID;
40     f->plist = pa_proplist_new();
41
42     return f;
43 }
44
45 pa_format_info* pa_format_info_copy(const pa_format_info *src) {
46     pa_format_info *dest;
47
48     pa_assert(src);
49
50     dest = pa_xnew(pa_format_info, 1);
51
52     dest->encoding = src->encoding;
53
54     if (src->plist)
55         dest->plist = pa_proplist_copy(src->plist);
56     else
57         dest->plist = NULL;
58
59     return dest;
60 }
61
62 void pa_format_info_free(pa_format_info *f) {
63     pa_assert(f);
64
65     pa_proplist_free(f->plist);
66     pa_xfree(f);
67 }
68
69 void pa_format_info_free2(pa_format_info *f, void *userdata) {
70     pa_format_info_free(f);
71 }
72
73 int pa_format_info_valid(const pa_format_info *f) {
74     return (f->encoding >= 0 && f->encoding < PA_ENCODING_MAX && f->plist != NULL);
75 }
76
77 int pa_format_info_is_pcm(const pa_format_info *f) {
78     return f->encoding == PA_ENCODING_PCM;
79 }
80
81 pa_bool_t pa_format_info_is_compatible(pa_format_info *first, pa_format_info *second) {
82     const char *key;
83     void *state = NULL;
84
85     pa_assert(first);
86     pa_assert(second);
87
88     if (first->encoding != second->encoding)
89         return FALSE;
90
91     while ((key = pa_proplist_iterate(first->plist, &state))) {
92         const char *value_one, *value_two;
93
94         value_one = pa_proplist_gets(first->plist, key);
95         value_two = pa_proplist_gets(second->plist, key);
96
97         if (!value_two || !pa_streq(value_one, value_two))
98             return FALSE;
99     }
100
101     return TRUE;
102 }
103
104 pa_format_info* pa_format_info_from_sample_spec(pa_sample_spec *ss, pa_channel_map *map) {
105     char cm[PA_CHANNEL_MAP_SNPRINT_MAX];
106     pa_format_info *f;
107
108     pa_assert(ss && pa_sample_spec_valid(ss));
109     pa_assert(!map || pa_channel_map_valid(map));
110
111     f = pa_format_info_new();
112     f->encoding = PA_ENCODING_PCM;
113
114     pa_proplist_sets(f->plist, PA_PROP_FORMAT_SAMPLE_FORMAT, pa_sample_format_to_string(ss->format));
115     pa_proplist_setf(f->plist, PA_PROP_FORMAT_RATE, "%u", (unsigned int) ss->rate);
116     pa_proplist_setf(f->plist, PA_PROP_FORMAT_CHANNELS, "%u", (unsigned int) ss->channels);
117
118     if (map) {
119         pa_channel_map_snprint(cm, sizeof(cm), map);
120         pa_proplist_setf(f->plist, PA_PROP_FORMAT_CHANNEL_MAP, "%s", cm);
121     }
122
123     return f;
124 }
125
126 /* For PCM streams */
127 pa_bool_t pa_format_info_to_sample_spec(pa_format_info *f, pa_sample_spec *ss, pa_channel_map *map) {
128     const char *sf, *r, *ch;
129     uint32_t channels;
130
131     pa_assert(f);
132     pa_assert(ss);
133     pa_return_val_if_fail(f->encoding == PA_ENCODING_PCM, FALSE);
134
135     pa_return_val_if_fail(sf = pa_proplist_gets(f->plist, PA_PROP_FORMAT_SAMPLE_FORMAT), FALSE);
136     pa_return_val_if_fail(r = pa_proplist_gets(f->plist, PA_PROP_FORMAT_RATE), FALSE);
137     pa_return_val_if_fail(ch = pa_proplist_gets(f->plist, PA_PROP_FORMAT_CHANNELS), FALSE);
138
139     pa_return_val_if_fail((ss->format = pa_parse_sample_format(sf)) != PA_SAMPLE_INVALID, FALSE);
140     pa_return_val_if_fail(pa_atou(r, &ss->rate) == 0, FALSE);
141     pa_return_val_if_fail(pa_atou(ch, &channels) == 0, FALSE);
142     ss->channels = (uint8_t) channels;
143
144     if (map) {
145         const char *m = pa_proplist_gets(f->plist, PA_PROP_FORMAT_CHANNEL_MAP);
146         pa_channel_map_init(map);
147
148         if (m)
149             pa_return_val_if_fail(pa_channel_map_parse(map, m) != NULL, FALSE);
150     }
151
152     return TRUE;
153 }
154
155 /* For compressed streams */
156 pa_bool_t pa_format_info_to_sample_spec_fake(pa_format_info *f, pa_sample_spec *ss) {
157     const char *r;
158
159     pa_assert(f);
160     pa_assert(ss);
161     pa_return_val_if_fail(f->encoding != PA_ENCODING_PCM, FALSE);
162
163     ss->format = PA_SAMPLE_S16LE;
164     ss->channels = 2;
165
166     pa_return_val_if_fail(r = pa_proplist_gets(f->plist, PA_PROP_FORMAT_RATE), FALSE);
167     pa_return_val_if_fail(pa_atou(r, &ss->rate) == 0, FALSE);
168
169     return TRUE;
170 }