2 * Copyright (C) 2014 The Android Open Source Project
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #define LOG_TAG "alsa_device_profile"
18 /*#define LOG_NDEBUG 0*/
19 /*#define LOG_PCM_PARAMS 0*/
25 #include <cutils/properties.h>
29 #include "include/alsa_device_profile.h"
30 #include "include/alsa_format.h"
31 #include "include/alsa_logging.h"
33 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
35 #define PERIOD_DURATION_US (5 * 1000)
37 #define DEFAULT_PERIOD_SIZE 1024
39 static const char * const format_string_map[] = {
40 "AUDIO_FORMAT_PCM_16_BIT", /* "PCM_FORMAT_S16_LE", */
41 "AUDIO_FORMAT_PCM_32_BIT", /* "PCM_FORMAT_S32_LE", */
42 "AUDIO_FORMAT_PCM_8_BIT", /* "PCM_FORMAT_S8", */
43 "AUDIO_FORMAT_PCM_8_24_BIT", /* "PCM_FORMAT_S24_LE", */
44 "AUDIO_FORMAT_PCM_24_BIT_PACKED"/* "PCM_FORMAT_S24_3LE" */
47 extern int8_t const pcm_format_value_map[50];
49 /* Sort these in terms of preference (best first).
50 192 kHz is not first because it requires significant resources for possibly worse
51 quality and driver instability (depends on device).
52 The order here determines the default sample rate for the device.
53 AudioPolicyManager may not respect this ordering when picking sample rates.
54 Update MAX_PROFILE_SAMPLE_RATES after changing the array size.
56 TODO: remove 32000, 22050, 12000, 11025? Each sample rate check
57 requires opening the device which may cause pops. */
58 static const unsigned std_sample_rates[] =
59 {96000, 88200, 192000, 176400, 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025, 8000};
61 static void profile_reset(alsa_device_profile* profile)
63 profile->card = profile->device = -1;
65 /* terminate the attribute arrays with invalid values */
66 profile->formats[0] = PCM_FORMAT_INVALID;
67 profile->sample_rates[0] = 0;
68 profile->channel_counts[0] = 0;
70 profile->min_period_size = profile->max_period_size = 0;
71 profile->min_channel_count = profile->max_channel_count = DEFAULT_CHANNEL_COUNT;
73 profile->is_valid = false;
76 void profile_init(alsa_device_profile* profile, int direction)
78 profile->direction = direction;
79 profile_reset(profile);
82 bool profile_is_initialized(alsa_device_profile* profile)
84 return profile->card >= 0 && profile->device >= 0;
87 bool profile_is_valid(alsa_device_profile* profile) {
88 return profile->is_valid;
91 bool profile_is_cached_for(alsa_device_profile* profile, int card, int device) {
92 return card == profile->card && device == profile->device;
95 void profile_decache(alsa_device_profile* profile) {
96 profile_reset(profile);
100 * Returns the supplied value rounded up to the next even multiple of 16
102 static unsigned int round_to_16_mult(unsigned int size)
104 return (size + 15) & ~15; /* 0xFFFFFFF0; */
108 * Returns the system defined minimum period size based on the supplied sample rate.
110 unsigned profile_calc_min_period_size(alsa_device_profile* profile, unsigned sample_rate)
112 ALOGV("profile_calc_min_period_size(%p, rate:%d)", profile, sample_rate);
113 if (profile == NULL) {
114 return DEFAULT_PERIOD_SIZE;
116 unsigned period_us = property_get_int32("ro.audio.usb.period_us", PERIOD_DURATION_US);
117 unsigned num_sample_frames = ((uint64_t)sample_rate * period_us) / 1000000;
119 if (num_sample_frames < profile->min_period_size) {
120 num_sample_frames = profile->min_period_size;
122 return round_to_16_mult(num_sample_frames);
126 unsigned int profile_get_period_size(alsa_device_profile* profile, unsigned sample_rate)
128 unsigned int period_size = profile_calc_min_period_size(profile, sample_rate);
129 ALOGV("profile_get_period_size(rate:%d) = %d", sample_rate, period_size);
136 unsigned profile_get_default_sample_rate(alsa_device_profile* profile)
139 * TODO this won't be right in general. we should store a preferred rate as we are scanning.
140 * But right now it will return the highest rate, which may be correct.
142 return profile_is_valid(profile) ? profile->sample_rates[0] : DEFAULT_SAMPLE_RATE;
145 bool profile_is_sample_rate_valid(alsa_device_profile* profile, unsigned rate)
147 if (profile_is_valid(profile)) {
149 for (index = 0; profile->sample_rates[index] != 0; index++) {
150 if (profile->sample_rates[index] == rate) {
157 return rate == DEFAULT_SAMPLE_RATE;
164 enum pcm_format profile_get_default_format(alsa_device_profile* profile)
167 * TODO this won't be right in general. we should store a preferred format as we are scanning.
169 return profile_is_valid(profile) ? profile->formats[0] : DEFAULT_SAMPLE_FORMAT;
172 bool profile_is_format_valid(alsa_device_profile* profile, enum pcm_format fmt) {
173 if (profile_is_valid(profile)) {
175 for (index = 0; profile->formats[index] != PCM_FORMAT_INVALID; index++) {
176 if (profile->formats[index] == fmt) {
183 return fmt == DEFAULT_SAMPLE_FORMAT;
190 unsigned profile_get_default_channel_count(alsa_device_profile* profile)
192 return profile_is_valid(profile) ? profile->channel_counts[0] : DEFAULT_CHANNEL_COUNT;
195 unsigned profile_get_closest_channel_count(alsa_device_profile* profile, unsigned count)
197 if (profile_is_valid(profile)) {
198 if (count < profile->min_channel_count) {
199 return profile->min_channel_count;
200 } else if (count > profile->max_channel_count) {
201 return profile->max_channel_count;
210 bool profile_is_channel_count_valid(alsa_device_profile* profile, unsigned count)
212 if (profile_is_initialized(profile)) {
213 return count >= profile->min_channel_count && count <= profile->max_channel_count;
215 return count == DEFAULT_CHANNEL_COUNT;
219 static bool profile_test_sample_rate(alsa_device_profile* profile, unsigned rate)
221 struct pcm_config config = profile->default_config;
224 bool works = false; /* let's be pessimistic */
225 struct pcm * pcm = pcm_open(profile->card, profile->device,
226 profile->direction, &config);
229 works = pcm_is_ready(pcm);
236 static unsigned profile_enum_sample_rates(alsa_device_profile* profile, unsigned min, unsigned max)
238 unsigned num_entries = 0;
241 for (index = 0; index < ARRAY_SIZE(std_sample_rates) &&
242 num_entries < ARRAY_SIZE(profile->sample_rates) - 1;
244 if (std_sample_rates[index] >= min && std_sample_rates[index] <= max
245 && profile_test_sample_rate(profile, std_sample_rates[index])) {
246 profile->sample_rates[num_entries++] = std_sample_rates[index];
249 profile->sample_rates[num_entries] = 0; /* terminate */
250 return num_entries; /* return # of supported rates */
253 static unsigned profile_enum_sample_formats(alsa_device_profile* profile, struct pcm_mask * mask)
255 const int num_slots = ARRAY_SIZE(mask->bits);
256 const int bits_per_slot = sizeof(mask->bits[0]) * 8;
258 const int table_size = ARRAY_SIZE(pcm_format_value_map);
260 int slot_index, bit_index, table_index;
263 for (slot_index = 0; slot_index < num_slots && table_index < table_size;
265 unsigned bit_mask = 1;
267 bit_index < bits_per_slot && table_index < table_size;
269 if ((mask->bits[slot_index] & bit_mask) != 0) {
270 enum pcm_format format = pcm_format_value_map[table_index];
271 /* Never return invalid (unrecognized) or 8-bit */
272 if (format != PCM_FORMAT_INVALID && format != PCM_FORMAT_S8) {
273 profile->formats[num_written++] = format;
274 if (num_written == ARRAY_SIZE(profile->formats) - 1) {
275 /* leave at least one PCM_FORMAT_INVALID at the end */
285 profile->formats[num_written] = PCM_FORMAT_INVALID;
289 static unsigned profile_enum_channel_counts(alsa_device_profile* profile, unsigned min,
292 /* modify alsa_device_profile.h if you change the std_channel_counts[] array. */
293 static const unsigned std_channel_counts[] = {8, 7, 6, 5, 4, 3, 2, 1};
295 unsigned num_counts = 0;
297 /* TODO write a profile_test_channel_count() */
298 /* Ensure there is at least one invalid channel count to terminate the channel counts array */
299 for (index = 0; index < ARRAY_SIZE(std_channel_counts) &&
300 num_counts < ARRAY_SIZE(profile->channel_counts) - 1;
302 /* TODO Do we want a channel counts test? */
303 if (std_channel_counts[index] >= min && std_channel_counts[index] <= max /* &&
304 profile_test_channel_count(profile, channel_counts[index])*/) {
305 profile->channel_counts[num_counts++] = std_channel_counts[index];
308 // if we have no match with the standard counts, we use the largest (preferred) std count.
309 if (num_counts == 0) {
310 ALOGW("usb device does not match std channel counts, setting to %d",
311 std_channel_counts[0]);
312 profile->channel_counts[num_counts++] = std_channel_counts[0];
314 profile->channel_counts[num_counts] = 0;
315 return num_counts; /* return # of supported counts */
319 * Reads and decodes configuration info from the specified ALSA card/device.
321 static int read_alsa_device_config(alsa_device_profile * profile, struct pcm_config * config)
323 ALOGV("usb:audio_hw - read_alsa_device_config(c:%d d:%d t:0x%X)",
324 profile->card, profile->device, profile->direction);
326 if (profile->card < 0 || profile->device < 0) {
330 struct pcm_params * alsa_hw_params =
331 pcm_params_get(profile->card, profile->device, profile->direction);
332 if (alsa_hw_params == NULL) {
336 profile->min_period_size = pcm_params_get_min(alsa_hw_params, PCM_PARAM_PERIOD_SIZE);
337 profile->max_period_size = pcm_params_get_max(alsa_hw_params, PCM_PARAM_PERIOD_SIZE);
339 profile->min_channel_count = pcm_params_get_min(alsa_hw_params, PCM_PARAM_CHANNELS);
340 profile->max_channel_count = pcm_params_get_max(alsa_hw_params, PCM_PARAM_CHANNELS);
345 * This Logging will be useful when testing new USB devices.
347 #ifdef LOG_PCM_PARAMS
348 log_pcm_params(alsa_hw_params);
351 config->channels = pcm_params_get_min(alsa_hw_params, PCM_PARAM_CHANNELS);
352 // For output devices, let's make sure we choose at least stereo
353 // (assuming the device supports it).
354 if (profile->direction == PCM_OUT &&
355 config->channels < 2 && pcm_params_get_max(alsa_hw_params, PCM_PARAM_CHANNELS) >= 2) {
356 config->channels = 2;
358 config->rate = pcm_params_get_min(alsa_hw_params, PCM_PARAM_RATE);
359 // Prefer 48K or 44.1K
360 if (config->rate < 48000 &&
361 pcm_params_get_max(alsa_hw_params, PCM_PARAM_RATE) >= 48000) {
362 config->rate = 48000;
363 } else if (config->rate < 44100 &&
364 pcm_params_get_max(alsa_hw_params, PCM_PARAM_RATE) >= 44100) {
365 config->rate = 44100;
367 config->period_size = profile_calc_min_period_size(profile, config->rate);
368 config->period_count = pcm_params_get_min(alsa_hw_params, PCM_PARAM_PERIODS);
369 config->format = get_pcm_format_for_mask(pcm_params_get_mask(alsa_hw_params, PCM_PARAM_FORMAT));
370 #ifdef LOG_PCM_PARAMS
371 log_pcm_config(config, "read_alsa_device_config");
373 if (config->format == PCM_FORMAT_INVALID) {
377 pcm_params_free(alsa_hw_params);
382 bool profile_read_device_info(alsa_device_profile* profile)
384 if (!profile_is_initialized(profile)) {
388 /* let's get some defaults */
389 read_alsa_device_config(profile, &profile->default_config);
390 ALOGV("default_config chans:%d rate:%d format:%d count:%d size:%d",
391 profile->default_config.channels, profile->default_config.rate,
392 profile->default_config.format, profile->default_config.period_count,
393 profile->default_config.period_size);
395 struct pcm_params * alsa_hw_params = pcm_params_get(profile->card,
398 if (alsa_hw_params == NULL) {
403 struct pcm_mask * format_mask = pcm_params_get_mask(alsa_hw_params, PCM_PARAM_FORMAT);
404 profile_enum_sample_formats(profile, format_mask);
407 profile_enum_channel_counts(
408 profile, pcm_params_get_min(alsa_hw_params, PCM_PARAM_CHANNELS),
409 pcm_params_get_max(alsa_hw_params, PCM_PARAM_CHANNELS));
412 profile_enum_sample_rates(
413 profile, pcm_params_get_min(alsa_hw_params, PCM_PARAM_RATE),
414 pcm_params_get_max(alsa_hw_params, PCM_PARAM_RATE));
416 profile->is_valid = true;
418 pcm_params_free(alsa_hw_params);
422 char * profile_get_sample_rate_strs(alsa_device_profile* profile)
424 /* if we assume that rate strings are about 5 characters (48000 is 5), plus ~1 for a
425 * delimiter "|" this buffer has room for about 22 rate strings which seems like
426 * way too much, but it's a stack variable so only temporary.
430 size_t buffSize = ARRAY_SIZE(buffer);
431 size_t curStrLen = 0;
435 size_t numEntries = 0;
437 for (index = 0; profile->sample_rates[index] != 0; index++) {
438 snprintf(numBuffer, sizeof(numBuffer), "%u", profile->sample_rates[index]);
439 // account for both the null, and potentially the bar.
440 if (buffSize - curStrLen < strlen(numBuffer) + (numEntries != 0 ? 2 : 1)) {
441 /* we don't have room for another, so bail at this point rather than
442 * return a malformed rate string
446 if (numEntries++ != 0) {
447 strlcat(buffer, "|", buffSize);
449 curStrLen = strlcat(buffer, numBuffer, buffSize);
452 return strdup(buffer);
455 char * profile_get_format_strs(alsa_device_profile* profile)
457 /* if we assume that format strings are about 24 characters (AUDIO_FORMAT_PCM_16_BIT is 23),
458 * plus ~1 for a delimiter "|" this buffer has room for about 10 format strings which seems
459 * like way too much, but it's a stack variable so only temporary.
463 size_t buffSize = ARRAY_SIZE(buffer);
464 size_t curStrLen = 0;
466 size_t numEntries = 0;
468 for (index = 0; profile->formats[index] != PCM_FORMAT_INVALID; index++) {
469 // account for both the null, and potentially the bar.
470 if (buffSize - curStrLen < strlen(format_string_map[profile->formats[index]])
471 + (numEntries != 0 ? 2 : 1)) {
472 /* we don't have room for another, so bail at this point rather than
473 * return a malformed rate string
477 if (numEntries++ != 0) {
478 strlcat(buffer, "|", buffSize);
480 curStrLen = strlcat(buffer, format_string_map[profile->formats[index]], buffSize);
483 return strdup(buffer);
486 char * profile_get_channel_count_strs(alsa_device_profile* profile)
488 // FIXME implicit fixed channel count assumption here (FCC_8).
489 // we use only the canonical even number channel position masks.
490 static const char * const out_chans_strs[] = {
491 /* 0 */"AUDIO_CHANNEL_NONE", /* will never be taken as this is a terminator */
492 /* 1 */"AUDIO_CHANNEL_OUT_MONO",
493 /* 2 */"AUDIO_CHANNEL_OUT_STEREO",
494 /* 3 */ /* "AUDIO_CHANNEL_OUT_STEREO|AUDIO_CHANNEL_OUT_FRONT_CENTER" */ NULL,
495 /* 4 */"AUDIO_CHANNEL_OUT_QUAD",
496 /* 5 */ /* "AUDIO_CHANNEL_OUT_QUAD|AUDIO_CHANNEL_OUT_FRONT_CENTER" */ NULL,
497 /* 6 */"AUDIO_CHANNEL_OUT_5POINT1",
498 /* 7 */ /* "AUDIO_CHANNEL_OUT_5POINT1|AUDIO_CHANNEL_OUT_BACK_CENTER" */ NULL,
499 /* 8 */"AUDIO_CHANNEL_OUT_7POINT1",
500 /* channel counts greater than this not considered */
503 static const char * const in_chans_strs[] = {
504 /* 0 */"AUDIO_CHANNEL_NONE", /* will never be taken as this is a terminator */
505 /* 1 */"AUDIO_CHANNEL_IN_MONO",
506 /* 2 */"AUDIO_CHANNEL_IN_STEREO",
507 /* channel counts greater than this not considered */
510 static const char * const index_chans_strs[] = {
511 /* 0 */"AUDIO_CHANNEL_NONE", /* will never be taken as this is a terminator */
512 /* 1 */"AUDIO_CHANNEL_INDEX_MASK_1",
513 /* 2 */"AUDIO_CHANNEL_INDEX_MASK_2",
514 /* 3 */"AUDIO_CHANNEL_INDEX_MASK_3",
515 /* 4 */"AUDIO_CHANNEL_INDEX_MASK_4",
516 /* 5 */"AUDIO_CHANNEL_INDEX_MASK_5",
517 /* 6 */"AUDIO_CHANNEL_INDEX_MASK_6",
518 /* 7 */"AUDIO_CHANNEL_INDEX_MASK_7",
519 /* 8 */"AUDIO_CHANNEL_INDEX_MASK_8",
522 const bool isOutProfile = profile->direction == PCM_OUT;
524 const char * const * const chans_strs = isOutProfile ? out_chans_strs : in_chans_strs;
525 const size_t chans_strs_size =
526 isOutProfile ? ARRAY_SIZE(out_chans_strs) : ARRAY_SIZE(in_chans_strs);
529 * If we assume each channel string is 26 chars ("AUDIO_CHANNEL_INDEX_MASK_8" is 26) + 1 for,
530 * the "|" delimiter, then we allocate room for 16 strings.
532 char buffer[27 * 16 + 1]; /* caution, may need to be expanded */
534 size_t buffSize = ARRAY_SIZE(buffer);
535 size_t curStrLen = 0;
537 /* We currently support MONO and STEREO, and always report STEREO but some (many)
538 * USB Audio Devices may only announce support for MONO (a headset mic for example), or
539 * The total number of output channels. SO, if the device itself doesn't explicitly
540 * support STEREO, append to the channel config strings we are generating.
542 * The MONO and STEREO positional channel masks are provided for legacy compatibility.
543 * For multichannel (n > 2) we only expose channel index masks.
545 // Always support stereo
546 curStrLen = strlcat(buffer, chans_strs[2], buffSize);
549 unsigned channel_count;
551 (channel_count = profile->channel_counts[index]) != 0;
554 /* we only show positional information for mono (stereo handled already) */
555 if (channel_count < chans_strs_size
556 && chans_strs[channel_count] != NULL
557 && channel_count < 2 /* positional only for fewer than 2 channels */) {
558 // account for the '|' and the '\0'
559 if (buffSize - curStrLen < strlen(chans_strs[channel_count]) + 2) {
560 /* we don't have room for another, so bail at this point rather than
561 * return a malformed rate string
566 strlcat(buffer, "|", buffSize);
567 curStrLen = strlcat(buffer, chans_strs[channel_count], buffSize);
570 // handle channel index masks for both input and output
571 // +2 to account for the '|' and the '\0'
572 if (buffSize - curStrLen < strlen(index_chans_strs[channel_count]) + 2) {
573 /* we don't have room for another, so bail at this point rather than
574 * return a malformed rate string
579 strlcat(buffer, "|", buffSize);
580 curStrLen = strlcat(buffer, index_chans_strs[channel_count], buffSize);
583 return strdup(buffer);
586 void profile_dump(const alsa_device_profile* profile, int fd)
588 if (profile == NULL) {
589 dprintf(fd, " %s\n", "No USB Profile");
590 return; /* bail early */
593 if (!profile->is_valid) {
594 dprintf(fd, " Profile is INVALID");
597 /* card/device/direction */
598 dprintf(fd, " card:%d, device:%d - %s\n",
599 profile->card, profile->device, profile->direction == PCM_OUT ? "OUT" : "IN");
602 dprintf(fd, " Formats: ");
603 for (int fmtIndex = 0;
604 profile->formats[fmtIndex] != PCM_FORMAT_INVALID && fmtIndex < MAX_PROFILE_FORMATS;
606 dprintf(fd, "%d ", profile->formats[fmtIndex]);
611 dprintf(fd, " Rates: ");
612 for (int rateIndex = 0;
613 profile->sample_rates[rateIndex] != 0 && rateIndex < MAX_PROFILE_SAMPLE_RATES;
615 dprintf(fd, "%u ", profile->sample_rates[rateIndex]);
620 dprintf(fd, " Channel Counts: ");
621 for (int cntIndex = 0;
622 profile->channel_counts[cntIndex] != 0 && cntIndex < MAX_PROFILE_CHANNEL_COUNTS;
624 dprintf(fd, "%u ", profile->channel_counts[cntIndex]);
628 dprintf(fd, " min/max period size [%u : %u]\n",
629 profile->min_period_size,profile-> max_period_size);
630 dprintf(fd, " min/max channel count [%u : %u]\n",
631 profile->min_channel_count, profile->max_channel_count);
633 // struct pcm_config default_config;
634 dprintf(fd, " Default Config:\n");
635 dprintf(fd, " channels: %d\n", profile->default_config.channels);
636 dprintf(fd, " rate: %d\n", profile->default_config.rate);
637 dprintf(fd, " period_size: %d\n", profile->default_config.period_size);
638 dprintf(fd, " period_count: %d\n", profile->default_config.period_count);
639 dprintf(fd, " format: %d\n", profile->default_config.format);