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;
 114         v = mask->bits[MASK_OFS(val)] & MASK_BIT(val);
 115         snd_mask_none(mask);
 116         mask->bits[MASK_OFS(val)] = v;
 117 }
 118
 119 static inline void snd_mask_intersect(struct snd_mask *mask,
 120                                       const struct snd_mask *v)
 121 {
 122         int i;
 123         for (i = 0; i < SNDRV_MASK_SIZE; i++)
 124                 mask->bits[i] &= v->bits[i];
 125 }
 126
 127 static inline int snd_mask_eq(const struct snd_mask *mask,
 128                               const struct snd_mask *v)
 129 {
 130         return ! memcmp(mask, v, SNDRV_MASK_SIZE * sizeof(u_int32_t));
 131 }
 132
 133 static inline void snd_mask_copy(struct snd_mask *mask,
 134                                  const struct snd_mask *v)
 135 {
 136         *mask = *v;
 137 }
 138
 139 static inline int snd_mask_test(const struct snd_mask *mask, unsigned int val)
 140 {
 141         return mask->bits[MASK_OFS(val)] & MASK_BIT(val);
 142 }
 143
 144 static inline int snd_mask_single(const struct snd_mask *mask)
 145 {
 146         int i, c = 0;
 147         for (i = 0; i < SNDRV_MASK_SIZE; i++) {
 148                 if (! mask->bits[i])
 149                         continue;
 150                 if (mask->bits[i] & (mask->bits[i] - 1))
 151                         return 0;
 152                 if (c)
 153                         return 0;
 154                 c++;
 155         }
 156         return 1;
 157 }
 158
 159 static inline int snd_mask_refine(struct snd_mask *mask,
 160                                   const struct snd_mask *v)
 161 {
 162         struct snd_mask old;
 163         snd_mask_copy(&old, mask);
 164         snd_mask_intersect(mask, v);
 165         if (snd_mask_empty(mask))
 166                 return -EINVAL;
 167         return !snd_mask_eq(mask, &old);
 168 }
 169
 170 static inline int snd_mask_refine_first(struct snd_mask *mask)
 171 {
 172         if (snd_mask_single(mask))
 173                 return 0;
 174         snd_mask_leave(mask, snd_mask_min(mask));
 175         return 1;
 176 }
 177
 178 static inline int snd_mask_refine_last(struct snd_mask *mask)
 179 {
 180         if (snd_mask_single(mask))
 181                 return 0;
 182         snd_mask_leave(mask, snd_mask_max(mask));
 183         return 1;
 184 }
 185
 186 static inline int snd_mask_refine_min(struct snd_mask *mask, unsigned int val)
 187 {
 188         if (snd_mask_min(mask) >= val)
 189                 return 0;
 190         snd_mask_reset_range(mask, 0, val - 1);
 191         if (snd_mask_empty(mask))
 192                 return -EINVAL;
 193         return 1;
 194 }
 195
 196 static inline int snd_mask_refine_max(struct snd_mask *mask, unsigned int val)
 197 {
 198         if (snd_mask_max(mask) <= val)
 199                 return 0;
 200         snd_mask_reset_range(mask, val + 1, SNDRV_MASK_BITS);
 201         if (snd_mask_empty(mask))
 202                 return -EINVAL;
 203         return 1;
 204 }
 205
 206 static inline int snd_mask_refine_set(struct snd_mask *mask, unsigned int val)
 207 {
 208         int changed;
 209         changed = !snd_mask_single(mask);
 210         snd_mask_leave(mask, val);
 211         if (snd_mask_empty(mask))
 212                 return -EINVAL;
 213         return changed;
 214 }
 215
 216 static inline int snd_mask_value(const struct snd_mask *mask)
 217 {
 218         return snd_mask_min(mask);
 219 }
 220
 221 static inline void snd_interval_any(struct snd_interval *i)
 222 {
 223         i->min = 0;
 224         i->openmin = 0;
 225         i->max = UINT_MAX;
 226         i->openmax = 0;
 227         i->integer = 0;
 228         i->empty = 0;
 229 }
 230
 231 static inline void snd_interval_none(struct snd_interval *i)
 232 {
 233         i->empty = 1;
 234 }
 235
 236 static inline int snd_interval_checkempty(const struct snd_interval *i)
 237 {
 238         return (i->min > i->max ||
 239                 (i->min == i->max && (i->openmin || i->openmax)));
 240 }
 241
 242 static inline int snd_interval_empty(const struct snd_interval *i)
 243 {
 244         return i->empty;
 245 }
 246
 247 static inline int snd_interval_single(const struct snd_interval *i)
 248 {
 249         return (i->min == i->max ||
 250                 (i->min + 1 == i->max && (i->openmin || i->openmax)));
 251 }
 252
 253 static inline int snd_interval_value(const struct snd_interval *i)
 254 {
 255         if (i->openmin && !i->openmax)
 256                 return i->max;
 257         return i->min;
 258 }
 259
 260 static inline int snd_interval_min(const struct snd_interval *i)
 261 {
 262         return i->min;
 263 }
 264
 265 static inline int snd_interval_max(const struct snd_interval *i)
 266 {
 267         unsigned int v;
 268         v = i->max;
 269         if (i->openmax)
 270                 v--;
 271         return v;
 272 }
 273
 274 static inline int snd_interval_test(const struct snd_interval *i, unsigned int val)
 275 {
 276         return !((i->min > val || (i->min == val && i->openmin) ||
 277                   i->max < val || (i->max == val && i->openmax)));
 278 }
 279
 280 static inline void snd_interval_copy(struct snd_interval *d, const struct snd_interval *s)
 281 {
 282         *d = *s;
 283 }
 284
 285 static inline int snd_interval_setinteger(struct snd_interval *i)
 286 {
 287         if (i->integer)
 288                 return 0;
 289         if (i->openmin && i->openmax && i->min == i->max)
 290                 return -EINVAL;
 291         i->integer = 1;
 292         return 1;
 293 }
 294
 295 static inline int snd_interval_eq(const struct snd_interval *i1, const struct snd_interval *i2)
 296 {
 297         if (i1->empty)
 298                 return i2->empty;
 299         if (i2->empty)
 300                 return i1->empty;
 301         return i1->min == i2->min && i1->openmin == i2->openmin &&
 302                 i1->max == i2->max && i1->openmax == i2->openmax;
 303 }
 304
 305 /**
 306  * params_access - get the access type from the hw params
 307  * @p: hw params
 308  */
 309 static inline snd_pcm_access_t params_access(const struct snd_pcm_hw_params *p)
 310 {
 311         return (__force snd_pcm_access_t)snd_mask_min(hw_param_mask_c(p,
 312                 SNDRV_PCM_HW_PARAM_ACCESS));
 313 }
 314
 315 /**
 316  * params_format - get the sample format from the hw params
 317  * @p: hw params
 318  */
 319 static inline snd_pcm_format_t params_format(const struct snd_pcm_hw_params *p)
 320 {
 321         return (__force snd_pcm_format_t)snd_mask_min(hw_param_mask_c(p,
 322                 SNDRV_PCM_HW_PARAM_FORMAT));
 323 }
 324
 325 /**
 326  * params_subformat - get the sample subformat from the hw params
 327  * @p: hw params
 328  */
 329 static inline snd_pcm_subformat_t
 330 params_subformat(const struct snd_pcm_hw_params *p)
 331 {
 332         return (__force snd_pcm_subformat_t)snd_mask_min(hw_param_mask_c(p,
 333                 SNDRV_PCM_HW_PARAM_SUBFORMAT));
 334 }
 335
 336 /**
 337  * params_period_bytes - get the period size (in bytes) from the hw params
 338  * @p: hw params
 339  */
 340 static inline unsigned int
 341 params_period_bytes(const struct snd_pcm_hw_params *p)
 342 {
 343         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_BYTES)->min;
 344 }
 345
 346 /**
 347  * params_width - get the number of bits of the sample format from the hw params
 348  * @p: hw params
 349  *
 350  * This function returns the number of bits per sample that the selected sample
 351  * format of the hw params has.
 352  */
 353 static inline int params_width(const struct snd_pcm_hw_params *p)
 354 {
 355         return snd_pcm_format_width(params_format(p));
 356 }
 357
 358 /*
 359  * params_physical_width - get the storage size of the sample format from the hw params
 360  * @p: hw params
 361  *
 362  * This functions returns the number of bits per sample that the selected sample
 363  * format of the hw params takes up in memory. This will be equal or larger than
 364  * params_width().
 365  */
 366 static inline int params_physical_width(const struct snd_pcm_hw_params *p)
 367 {
 368         return snd_pcm_format_physical_width(params_format(p));
 369 }
 370
 371 static inline void
 372 params_set_format(struct snd_pcm_hw_params *p, snd_pcm_format_t fmt)
 373 {
 374         snd_mask_set(hw_param_mask(p, SNDRV_PCM_HW_PARAM_FORMAT),
 375                 (__force int)fmt);
 376 }
 377
 378 #endif /* __SOUND_PCM_PARAMS_H */