include/sound/pcm_params.h

   1 #ifndef __SOUND_PCM_PARAMS_H
   2 #define __SOUND_PCM_PARAMS_H
   3
   4 /*
   5  *  PCM params helpers
   6  *  Copyright (c) by Abramo Bagnara <abramo@alsa-project.org>
   7  *
   8  *
   9  *   This program is free software; you can redistribute it and/or modify
  10  *   it under the terms of the GNU General Public License as published by
  11  *   the Free Software Foundation; either version 2 of the License, or
  12  *   (at your option) any later version.
  13  *
  14  *   This program is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *   GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *   along with this program; if not, write to the Free Software
  21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  22  *
  23  */
  24
  25 #include <sound/pcm.h>
  26
  27 int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm,
  28                            struct snd_pcm_hw_params *params,
  29                            snd_pcm_hw_param_t var, int *dir);
  30 int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm,
  31                           struct snd_pcm_hw_params *params,
  32                           snd_pcm_hw_param_t var, int *dir);
  33 int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
  34                            snd_pcm_hw_param_t var, int *dir);
  35
  36 #define SNDRV_MASK_BITS 64      /* we use so far 64bits only */
  37 #define SNDRV_MASK_SIZE (SNDRV_MASK_BITS / 32)
  38 #define MASK_OFS(i)     ((i) >> 5)
  39 #define MASK_BIT(i)     (1U << ((i) & 31))
  40
  41 static inline size_t snd_mask_sizeof(void)
  42 {
  43         return sizeof(struct snd_mask);
  44 }
  45
  46 static inline void snd_mask_none(struct snd_mask *mask)
  47 {
  48         memset(mask, 0, sizeof(*mask));
  49 }
  50
  51 static inline void snd_mask_any(struct snd_mask *mask)
  52 {
  53         memset(mask, 0xff, SNDRV_MASK_SIZE * sizeof(u_int32_t));
  54 }
  55
  56 static inline int snd_mask_empty(const struct snd_mask *mask)
  57 {
  58         int i;
  59         for (i = 0; i < SNDRV_MASK_SIZE; i++)
  60                 if (mask->bits[i])
  61                         return 0;
  62         return 1;
  63 }
  64
  65 static inline unsigned int snd_mask_min(const struct snd_mask *mask)
  66 {
  67         int i;
  68         for (i = 0; i < SNDRV_MASK_SIZE; i++) {
  69                 if (mask->bits[i])
  70                         return __ffs(mask->bits[i]) + (i << 5);
  71         }
  72         return 0;
  73 }
  74
  75 static inline unsigned int snd_mask_max(const struct snd_mask *mask)
  76 {
  77         int i;
  78         for (i = SNDRV_MASK_SIZE - 1; i >= 0; i--) {
  79                 if (mask->bits[i])
  80                         return __fls(mask->bits[i]) + (i << 5);
  81         }
  82         return 0;
  83 }
  84
  85 static inline void snd_mask_set(struct snd_mask *mask, unsigned int val)
  86 {
  87         mask->bits[MASK_OFS(val)] |= MASK_BIT(val);
  88 }
  89
  90 static inline void snd_mask_reset(struct snd_mask *mask, unsigned int val)
  91 {
  92         mask->bits[MASK_OFS(val)] &= ~MASK_BIT(val);
  93 }
  94
  95 static inline void snd_mask_set_range(struct snd_mask *mask,
  96                                       unsigned int from, unsigned int to)
  97 {
  98         unsigned int i;
  99         for (i = from; i <= to; i++)
 100                 mask->bits[MASK_OFS(i)] |= MASK_BIT(i);
 101 }
 102
 103 static inline void snd_mask_reset_range(struct snd_mask *mask,
 104                                         unsigned int from, unsigned int to)
 105 {
 106         unsigned int i;
 107         for (i = from; i <= to; i++)
 108                 mask->bits[MASK_OFS(i)] &= ~MASK_BIT(i);
 109 }
 110
 111 static inline void snd_mask_leave(struct snd_mask *mask, unsigned int val)
 112 {
 113         unsigned int v, bits_index;
 114
 115         bits_index = MASK_OFS(val);
 116         if (bits_index < ((SNDRV_MASK_MAX+31)/32)) {
 117                 v = mask->bits[bits_index] & MASK_BIT(val);
 118                 snd_mask_none(mask);
 119                 mask->bits[bits_index] = v;
 120         }
 121 }
 122
 123 static inline void snd_mask_intersect(struct snd_mask *mask,
 124                                       const struct snd_mask *v)
 125 {
 126         int i;
 127         for (i = 0; i < SNDRV_MASK_SIZE; i++)
 128                 mask->bits[i] &= v->bits[i];
 129 }
 130
 131 static inline int snd_mask_eq(const struct snd_mask *mask,
 132                               const struct snd_mask *v)
 133 {
 134         return ! memcmp(mask, v, SNDRV_MASK_SIZE * sizeof(u_int32_t));
 135 }
 136
 137 static inline void snd_mask_copy(struct snd_mask *mask,
 138                                  const struct snd_mask *v)
 139 {
 140         *mask = *v;
 141 }
 142
 143 static inline int snd_mask_test(const struct snd_mask *mask, unsigned int val)
 144 {
 145         return mask->bits[MASK_OFS(val)] & MASK_BIT(val);
 146 }
 147
 148 static inline int snd_mask_single(const struct snd_mask *mask)
 149 {
 150         int i, c = 0;
 151         for (i = 0; i < SNDRV_MASK_SIZE; i++) {
 152                 if (! mask->bits[i])
 153                         continue;
 154                 if (mask->bits[i] & (mask->bits[i] - 1))
 155                         return 0;
 156                 if (c)
 157                         return 0;
 158                 c++;
 159         }
 160         return 1;
 161 }
 162
 163 static inline int snd_mask_refine(struct snd_mask *mask,
 164                                   const struct snd_mask *v)
 165 {
 166         struct snd_mask old;
 167         snd_mask_copy(&old, mask);
 168         snd_mask_intersect(mask, v);
 169         if (snd_mask_empty(mask))
 170                 return -EINVAL;
 171         return !snd_mask_eq(mask, &old);
 172 }
 173
 174 static inline int snd_mask_refine_first(struct snd_mask *mask)
 175 {
 176         if (snd_mask_single(mask))
 177                 return 0;
 178         snd_mask_leave(mask, snd_mask_min(mask));
 179         return 1;
 180 }
 181
 182 static inline int snd_mask_refine_last(struct snd_mask *mask)
 183 {
 184         if (snd_mask_single(mask))
 185                 return 0;
 186         snd_mask_leave(mask, snd_mask_max(mask));
 187         return 1;
 188 }
 189
 190 static inline int snd_mask_refine_min(struct snd_mask *mask, unsigned int val)
 191 {
 192         if (snd_mask_min(mask) >= val)
 193                 return 0;
 194         snd_mask_reset_range(mask, 0, val - 1);
 195         if (snd_mask_empty(mask))
 196                 return -EINVAL;
 197         return 1;
 198 }
 199
 200 static inline int snd_mask_refine_max(struct snd_mask *mask, unsigned int val)
 201 {
 202         if (snd_mask_max(mask) <= val)
 203                 return 0;
 204         snd_mask_reset_range(mask, val + 1, SNDRV_MASK_BITS);
 205         if (snd_mask_empty(mask))
 206                 return -EINVAL;
 207         return 1;
 208 }
 209
 210 static inline int snd_mask_refine_set(struct snd_mask *mask, unsigned int val)
 211 {
 212         int changed;
 213         changed = !snd_mask_single(mask);
 214         snd_mask_leave(mask, val);
 215         if (snd_mask_empty(mask))
 216                 return -EINVAL;
 217         return changed;
 218 }
 219
 220 static inline int snd_mask_value(const struct snd_mask *mask)
 221 {
 222         return snd_mask_min(mask);
 223 }
 224
 225 static inline void snd_interval_any(struct snd_interval *i)
 226 {
 227         i->min = 0;
 228         i->openmin = 0;
 229         i->max = UINT_MAX;
 230         i->openmax = 0;
 231         i->integer = 0;
 232         i->empty = 0;
 233 }
 234
 235 static inline void snd_interval_none(struct snd_interval *i)
 236 {
 237         i->empty = 1;
 238 }
 239
 240 static inline int snd_interval_checkempty(const struct snd_interval *i)
 241 {
 242         return (i->min > i->max ||
 243                 (i->min == i->max && (i->openmin || i->openmax)));
 244 }
 245
 246 static inline int snd_interval_empty(const struct snd_interval *i)
 247 {
 248         return i->empty;
 249 }
 250
 251 static inline int snd_interval_single(const struct snd_interval *i)
 252 {
 253         return (i->min == i->max ||
 254                 (i->min + 1 == i->max && (i->openmin || i->openmax)));
 255 }
 256
 257 static inline int snd_interval_value(const struct snd_interval *i)
 258 {
 259         if (i->openmin && !i->openmax)
 260                 return i->max;
 261         return i->min;
 262 }
 263
 264 static inline int snd_interval_min(const struct snd_interval *i)
 265 {
 266         return i->min;
 267 }
 268
 269 static inline int snd_interval_max(const struct snd_interval *i)
 270 {
 271         unsigned int v;
 272         v = i->max;
 273         if (i->openmax)
 274                 v--;
 275         return v;
 276 }
 277
 278 static inline int snd_interval_test(const struct snd_interval *i, unsigned int val)
 279 {
 280         return !((i->min > val || (i->min == val && i->openmin) ||
 281                   i->max < val || (i->max == val && i->openmax)));
 282 }
 283
 284 static inline void snd_interval_copy(struct snd_interval *d, const struct snd_interval *s)
 285 {
 286         *d = *s;
 287 }
 288
 289 static inline int snd_interval_setinteger(struct snd_interval *i)
 290 {
 291         if (i->integer)
 292                 return 0;
 293         if (i->openmin && i->openmax && i->min == i->max)
 294                 return -EINVAL;
 295         i->integer = 1;
 296         return 1;
 297 }
 298
 299 static inline int snd_interval_eq(const struct snd_interval *i1, const struct snd_interval *i2)
 300 {
 301         if (i1->empty)
 302                 return i2->empty;
 303         if (i2->empty)
 304                 return i1->empty;
 305         return i1->min == i2->min && i1->openmin == i2->openmin &&
 306                 i1->max == i2->max && i1->openmax == i2->openmax;
 307 }
 308
 309 /**
 310  * params_access - get the access type from the hw params
 311  * @p: hw params
 312  */
 313 static inline snd_pcm_access_t params_access(const struct snd_pcm_hw_params *p)
 314 {
 315         return (__force snd_pcm_access_t)snd_mask_min(hw_param_mask_c(p,
 316                 SNDRV_PCM_HW_PARAM_ACCESS));
 317 }
 318
 319 /**
 320  * params_format - get the sample format from the hw params
 321  * @p: hw params
 322  */
 323 static inline snd_pcm_format_t params_format(const struct snd_pcm_hw_params *p)
 324 {
 325         return (__force snd_pcm_format_t)snd_mask_min(hw_param_mask_c(p,
 326                 SNDRV_PCM_HW_PARAM_FORMAT));
 327 }
 328
 329 /**
 330  * params_subformat - get the sample subformat from the hw params
 331  * @p: hw params
 332  */
 333 static inline snd_pcm_subformat_t
 334 params_subformat(const struct snd_pcm_hw_params *p)
 335 {
 336         return (__force snd_pcm_subformat_t)snd_mask_min(hw_param_mask_c(p,
 337                 SNDRV_PCM_HW_PARAM_SUBFORMAT));
 338 }
 339
 340 /**
 341  * params_period_bytes - get the period size (in bytes) from the hw params
 342  * @p: hw params
 343  */
 344 static inline unsigned int
 345 params_period_bytes(const struct snd_pcm_hw_params *p)
 346 {
 347         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_BYTES)->min;
 348 }
 349
 350 /**
 351  * params_width - get the number of bits of the sample format from the hw params
 352  * @p: hw params
 353  *
 354  * This function returns the number of bits per sample that the selected sample
 355  * format of the hw params has.
 356  */
 357 static inline int params_width(const struct snd_pcm_hw_params *p)
 358 {
 359         return snd_pcm_format_width(params_format(p));
 360 }
 361
 362 /*
 363  * params_physical_width - get the storage size of the sample format from the hw params
 364  * @p: hw params
 365  *
 366  * This functions returns the number of bits per sample that the selected sample
 367  * format of the hw params takes up in memory. This will be equal or larger than
 368  * params_width().
 369  */
 370 static inline int params_physical_width(const struct snd_pcm_hw_params *p)
 371 {
 372         return snd_pcm_format_physical_width(params_format(p));
 373 }
 374
 375 static inline void
 376 params_set_format(struct snd_pcm_hw_params *p, snd_pcm_format_t fmt)
 377 {
 378         snd_mask_set(hw_param_mask(p, SNDRV_PCM_HW_PARAM_FORMAT),
 379                 (__force int)fmt);
 380 }
 381
 382 #endif /* __SOUND_PCM_PARAMS_H */