05．絶対音量対応

送信側（スマートフォン等）が絶対音量(Absolute Volume）でオーディオデータを送信している場合は、受信したオーディオデータを、ボリューム設定に応じたオーディオデータに変更してから、オーディオDACモジュールに送ります。

補足１）
「絶対音量ではないオーディオデータ送信」 : 送信側はオーディオをボリューム値に応じたデータで送信します。受信側は、受信したデータを、そのまま、オーディオDACモジュールに送ります。送信側のボリュームの変更が、再生される音量に反映されます。
「絶対音量でオーディオデータ送信」 : 送信側はオーディオを常に最大音量でのデータで送信します。受信側は、受信したデータを、送信側のボリューム値に応じて変更してから、オーディオDACモジュールに送ります。「送信側のボリューム値に応じたオーディオデータに変更」をしないと、送信側のボリュームを変更しても、再生される音量は常に最大音量となります。

補足２）
デバイスの設定、OSの設定、アプリの設定、に依存するところも大きいですが、手元での確認の結果、
・「Android スマートフォン」は、「絶対音量ではないオーディオデータ送信」です。
・「iphone」は、「絶対音量でオーディオデータ送信」です。
・「Windows パソコン」は、「絶対音量でオーディオデータ送信」です。
・「絶対音量ではないオーディオデータ送信」「絶対音量でオーディオデータ送信」を設定で切り替えることができるデバイスもあります。

補足３）
本項目の内容は、「a2dp_sink example: adds software volume control (IDFGH-4307) by bellatriks · Pull Request #6150 · espressif/esp-idf · GitHub」を参考にしています。

前提

「04．ボリューム変更シミュレーション機能の無効化」を実施していない場合は、実施します。

ボリューム値に応じたデータに変更するための関数の宣言と定義

ボリューム値に応じたオーディオデータに変更するための関数の宣言のファイルを用意します。
ファイル名を「bt_app_volume_control.h」とします。
「bluetooth_audio_receiver」ディレクトリに配置します。

ファイル「bt_app_volume_control.h」の内容は以下のようにします。
#pragma once #include <stdint.h> #define BT_SBC_BITS_PER_SAMPLE 0x10 /* bit depth : 0x10 = 16 = 16bit */ /* * Sets volume. Allowed range is 0-127 */ void bt_app_set_volume(uint32_t level); /* * Changes an input data according to volume level. */ void bt_app_adjust_volume(uint8_t *data, size_t size);

ボリューム値に応じたオーディオデータに変更するための関数の定義のファイルを用意します。
ファイル名を「bt_app_volume_control.c」とします。
「bluetooth_audio_receiver」ディレクトリに配置します。

ファイル「bt_app_volume_control.c」の内容は以下のようにします。
#include <stdint.h> #include "bt_app_av.h" #include "bt_app_volume_control.h" #include "esp_log.h" #define VOLUME_LEVELS 128 // volume is adjusted from 0 to 127 levels #define VOLUME_SCALE_VAL 16 /* y = 65535 * (x/127) */ static const uint16_t gain_presets[VOLUME_LEVELS] = { 0x0000, 0x0204, 0x0408, 0x060c, 0x0810, 0x0a14, 0x0c18, 0x0e1c, 0x1020, 0x1224, 0x1428, 0x162c, 0x1830, 0x1a34, 0x1c38, 0x1e3c, 0x2040, 0x2244, 0x2448, 0x264c, 0x2850, 0x2a54, 0x2c58, 0x2e5c, 0x3060, 0x3264, 0x3468, 0x366c, 0x3870, 0x3a74, 0x3c78, 0x3e7c, 0x4080, 0x4284, 0x4488, 0x468c, 0x4890, 0x4a94, 0x4c98, 0x4e9c, 0x50a0, 0x52a4, 0x54a8, 0x56ad, 0x58b1, 0x5ab5, 0x5cb9, 0x5ebd, 0x60c1, 0x62c5, 0x64c9, 0x66cd, 0x68d1, 0x6ad5, 0x6cd9, 0x6edd, 0x70e1, 0x72e5, 0x74e9, 0x76ed, 0x78f1, 0x7af5, 0x7cf9, 0x7efd, 0x8101, 0x8305, 0x8509, 0x870d, 0x8911, 0x8b15, 0x8d19, 0x8f1d, 0x9121, 0x9325, 0x9529, 0x972d, 0x9931, 0x9b35, 0x9d39, 0x9f3d, 0xa141, 0xa345, 0xa549, 0xa74d, 0xa951, 0xab56, 0xad5a, 0xaf5e, 0xb162, 0xb366, 0xb56a, 0xb76e, 0xb972, 0xbb76, 0xbd7a, 0xbf7e, 0xc182, 0xc386, 0xc58a, 0xc78e, 0xc992, 0xcb96, 0xcd9a, 0xcf9e, 0xd1a2, 0xd3a6, 0xd5aa, 0xd7ae, 0xd9b2, 0xdbb6, 0xddba, 0xdfbe, 0xe1c2, 0xe3c6, 0xe5ca, 0xe7ce, 0xe9d2, 0xebd6, 0xedda, 0xefde, 0xf1e2, 0xf3e6, 0xf5ea, 0xf7ee, 0xf9f2, 0xfbf6, 0xfdfa, 0xffff, }; static int32_t s_volume = VOLUME_LEVELS - 1; // if the volume is not set by host, // the input strem will not be modified. void bt_app_set_volume(uint32_t level) { if(level < VOLUME_LEVELS) { s_volume = level; } } void bt_app_adjust_volume(uint8_t *data, size_t size) { size_t items = size / (BT_SBC_BITS_PER_SAMPLE / 8); // 8 is bits per byte. int16_t* ptr = (int16_t*) data; while(items--) { int32_t fraction = (int32_t)(*ptr * gain_presets[s_volume]) >> VOLUME_SCALE_VAL; *ptr = (int16_t)fraction; ptr++; } }

bt_app_set_volume 関数の呼び出し

送信側でボリュームが変更された際に呼び出される処理に、bt_app_set_volume 関数の呼び出しを追加します。
具体的には、「bt_app_av.c」ファイルの「volume_set_by_controller 関数」に「bt_app_set_volume(volume);」を追加します。
補足）この関数は、「絶対音量ではないオーディオデータ送信」の際には、コールされないので、「絶対音量ではないオーディオデータ送信」の際には、受信したデータは、データ変更処理は行われますが、処理の結果、データは変わらずに、オーディオDACモジュールに送られます。
（・・・略・・・） static void volume_set_by_controller(uint8_t volume) { ESP_LOGI(BT_RC_TG_TAG, "Volume is set by remote controller to: %"PRIu32"%%", (uint32_t)volume * 100 / 0x7f); /* set the volume in protection of lock */ _lock_acquire(&s_volume_lock); s_volume = volume; _lock_release(&s_volume_lock); bt_app_set_volume(volume); /* ソフトウェアボリュームコントロール */ } （・・・略・・・）

送信側にボリューム値の初期値を送信する処理に、bt_app_set_volume 関数の呼び出しを追加します。
具体的には、「bt_app_av.c」ファイルの「bt_av_hdl_avrc_tg_evt 関数」の「ESP_AVRC_TG_REGISTER_NOTIFICATION_EVT」処理に「bt_app_set_volume(volume);」を追加します。
補足）この処理は、「絶対音量ではないオーディオデータ送信」の際には、処理されないので、「絶対音量ではないオーディオデータ送信」の際には、受信したデータは、データ変更処理は行われますが、処理の結果、データは変わらずに、オーディオDACモジュールに送られます。
（・・・略・・・） static void bt_av_hdl_avrc_tg_evt(uint16_t event, void *p_param) { （・・・略・・・） switch (event) { （・・・略・・・） case ESP_AVRC_TG_REGISTER_NOTIFICATION_EVT: { ESP_LOGI(BT_RC_TG_TAG, "AVRC register event notification: %d, param: 0x%"PRIx32, rc->reg_ntf.event_id, rc->reg_ntf.event_parameter); if (rc->reg_ntf.event_id == ESP_AVRC_RN_VOLUME_CHANGE) { s_volume_notify = true; esp_avrc_rn_param_t rn_param; rn_param.volume = s_volume; bt_app_set_volume(rn_param.volume); /* ソフトウェアボリュームコントロール */ esp_avrc_tg_send_rn_rsp(ESP_AVRC_RN_VOLUME_CHANGE, ESP_AVRC_RN_RSP_INTERIM, &rn_param); } break; } （・・・略・・・）

「bt_app_av.c」ファイルのヘッダー部に、「#include "bt_app_volume_control.h"」を追加します。
（・・・略・・・） #include "sys/lock.h" #include "bt_app_volume_control.h" /* ソフトウェアボリュームコントロール */ /* AVRCP used transaction labels */ （・・・略・・・）

bt_app_adjust_volume 関数の呼び出し

オーディオDACモジュールにオーディオデータを送信する処理の直前に、bt_app_adjust_volume 関数の呼び出しを追加します。
具体的には、「bt_app_core.c」ファイルの「bt_i2s_task_handler 関数」に「bt_app_adjust_volume(data, item_size);」を追加します。
（・・・略・・・） static void bt_i2s_task_handler(void *arg) { （・・・略・・・） for (;;) { if (pdTRUE == xSemaphoreTake(s_i2s_write_semaphore, portMAX_DELAY)) { for (;;) { item_size = 0; /* receive data from ringbuffer and write it to I2S DMA transmit buffer */ data = (uint8_t *)xRingbufferReceiveUpTo(s_ringbuf_i2s, &item_size, (TickType_t)pdMS_TO_TICKS(20), item_size_upto); if (item_size == 0) { ESP_LOGI(BT_APP_CORE_TAG, "ringbuffer underflowed! mode changed: RINGBUFFER_MODE_PREFETCHING"); ringbuffer_mode = RINGBUFFER_MODE_PREFETCHING; break; } bt_app_adjust_volume(data, item_size); /* ソフトウェアボリュームコントロール */ #ifdef CONFIG_EXAMPLE_A2DP_SINK_OUTPUT_INTERNAL_DAC dac_continuous_write(tx_chan, data, item_size, &bytes_written, -1); #else i2s_channel_write(tx_chan, data, item_size, &bytes_written, portMAX_DELAY); #endif vRingbufferReturnItem(s_ringbuf_i2s, (void *)data); } } } } （・・・略・・・）

「bt_app_core.c」ファイルのヘッダー部に、「#include "bt_app_volume_control.h"」を追加します。
（・・・略・・・） #include "freertos/ringbuf.h" #include "bt_app_volume_control.h" /* ソフトウェアボリュームコントロール */ #define RINGBUF_HIGHEST_WATER_LEVEL (32 * 1024) （・・・略・・・）

「CMakeLists.txt」ファイルの編集

ボリューム値に応じたオーディオデータに変更するための関数の定義のファイルを、ビルド対象に追加します。

「CMakeLists.txt」ファイルに、「bt_app_volume_control.c」を追加します。
idf_component_register(SRCS "bt_app_av.c" "bt_app_core.c" "bt_app_volume_control.c" "main.c" INCLUDE_DIRS ".")

ビルド

以下のコマンドを実行し、プロジェクトのプログラムをビルドします。

idf.py build

完了するまで、しばらく待ちます。

フラッシュ

ビルド結果を、マイコンに書き込むフラッシュのコマンドは以下の書式です。

idf.py -p シリアル通信デバイス名 flash

シリアル通信デバイス名が「/dev/ttyUSB0」の場合は、以下のコマンドを実行します。

idf.py -p /dev/ttyUSB0 flash

完了するまで、しばらく待ちます。

動作確認

フラッシュが完了すると、マイコンに書き込まれたプログラムが起動します。

Bluetooth機能が搭載されているデバイス（スマートフォンやパソコン）から、作成した「Bluetooth Audio Receiver」にBluetooth接続します。
作成した「Bluetooth Audio Receiver」のデバイス名は「ESP_SPEAKER」です。

作成した「Bluetooth Audio Receiver」のイヤホンジャックに接続したイヤホンやスピーカーから、接続元のデバイスで再生したオーディオを聴くことができます。

送信側（スマートフォン等）が絶対音量(Absolute Volume）でオーディオデータを送信している場合でも、送信側のボリュームの変更が、再生される音量に反映されます。

参考）ゲインプリセット配列の変更

「a2dp_sink example: adds software volume control (IDFGH-4307) by bellatriks · Pull Request #6150 · espressif/esp-idf · GitHub」のオリジナルのコードの場合、ボリューム値が小さいときに、再生される音量が小さかったため、ゲインプリセット配列を変更しています。

オリジナルのコードのゲインプリセットは、
y = a * 10 ^ { (-51 + 51 * x/127 ) / 20 }
の式で表される値の配列となっていました。
（ここで x は、0から127までの値をとります。
　a は、x = 127 のときにとりたい y の値になる値とします。
　x = 127 のとき、y = 65535 をとりたいので、a = 65535 / 10^0 = 65535 となります。
　y = 65535 * 10 ^ { (-51 + 51 * x/127 ) / 20 }
　ミュートのために、y = 0 をゼロ番に加え、式から求まる値の配列番号は、１ずつ、シフトしたものです。127番の値は強制的に、y=65535 です。）

オリジナルのコードのゲインプリセットでは、ボリューム値が小さいときに、再生される音量が小さかったため、ゲインプリセットを、
y = a * (x/127)
の式で表される値の配列としました。
（ここで x は、0から127までの値をとります。
　a は、x = 127のときにとりたい y の値になる値とします。
　x = 127 のとき、y = 65535 をとりたいので、a = 65535 / 1 = 65535 となります。
　y = 65535 * (x/127)
　）

y = a * (x/127)^2
の式で表される値の配列も試しましたが、ボリューム値が小さいときに再生される音量が小さい問題が解消しませんでした。
（ここで x は、0から127までの値をとります。
　a は、x = 127のときにとりたい y の値になる値とします。
　x = 127 のとき、y = 65535 をとりたいので、a = 65535 / 1^2 = 65535 となります。
　y = 65535 * (x/127)^2
　）

参考）「オリジナル」版と「y = 65535 * (x/127)」版と「y = 65535 * (x/127)^2」版のゲインプリセットの配列
/* original : y = 65535 * 10 ^ { (-51 + 51 * x/127 ) / 20 } */ /*static const uint16_t gain_presets[VOLUME_LEVELS] = { 0x0000, 0x00b8, 0x00c1, 0x00ca, 0x00d4, 0x00de, 0x00e8, 0x00f3, 0x00ff, 0x010b, 0x0118, 0x0125, 0x0133, 0x0141, 0x0150, 0x0160, 0x0171, 0x0183, 0x0195, 0x01a8, 0x01bc, 0x01d1, 0x01e7, 0x01fe, 0x0216, 0x0230, 0x024a, 0x0266, 0x0283, 0x02a2, 0x02c1, 0x02e3, 0x0306, 0x032a, 0x0351, 0x0379, 0x03a3, 0x03cf, 0x03fd, 0x042e, 0x0460, 0x0495, 0x04cd, 0x0507, 0x0544, 0x0584, 0x05c7, 0x060d, 0x0656, 0x06a3, 0x06f3, 0x0747, 0x07a0, 0x07fc, 0x085d, 0x08c2, 0x092c, 0x099b, 0x0a10, 0x0a8a, 0x0b09, 0x0b8f, 0x0c1b, 0x0cae, 0x0d47, 0x0de8, 0x0e91, 0x0f41, 0x0ffa, 0x10bb, 0x1186, 0x125a, 0x1339, 0x1422, 0x1515, 0x1615, 0x1720, 0x1839, 0x195e, 0x1a91, 0x1bd3, 0x1d24, 0x1e85, 0x1ff7, 0x217a, 0x2310, 0x24b8, 0x2675, 0x2847, 0x2a2f, 0x2c2e, 0x2e45, 0x3076, 0x32c1, 0x3528, 0x37ac, 0x3a4e, 0x3d10, 0x3ff4, 0x42fb, 0x4626, 0x4978, 0x4cf2, 0x5096, 0x5466, 0x5865, 0x5c93, 0x60f5, 0x658b, 0x6a5a, 0x6f62, 0x74a7, 0x7a2c, 0x7ff4, 0x8602, 0x8c59, 0x92fe, 0x99f2, 0xa13b, 0xa8dc, 0xb0da, 0xb938, 0xc1fc, 0xcb29, 0xd4c6, 0xded8, 0xe963, 0xffff, };*/ /* y = 65535 * (x/127) */ static const uint16_t gain_presets[VOLUME_LEVELS] = { 0x0000, 0x0204, 0x0408, 0x060c, 0x0810, 0x0a14, 0x0c18, 0x0e1c, 0x1020, 0x1224, 0x1428, 0x162c, 0x1830, 0x1a34, 0x1c38, 0x1e3c, 0x2040, 0x2244, 0x2448, 0x264c, 0x2850, 0x2a54, 0x2c58, 0x2e5c, 0x3060, 0x3264, 0x3468, 0x366c, 0x3870, 0x3a74, 0x3c78, 0x3e7c, 0x4080, 0x4284, 0x4488, 0x468c, 0x4890, 0x4a94, 0x4c98, 0x4e9c, 0x50a0, 0x52a4, 0x54a8, 0x56ad, 0x58b1, 0x5ab5, 0x5cb9, 0x5ebd, 0x60c1, 0x62c5, 0x64c9, 0x66cd, 0x68d1, 0x6ad5, 0x6cd9, 0x6edd, 0x70e1, 0x72e5, 0x74e9, 0x76ed, 0x78f1, 0x7af5, 0x7cf9, 0x7efd, 0x8101, 0x8305, 0x8509, 0x870d, 0x8911, 0x8b15, 0x8d19, 0x8f1d, 0x9121, 0x9325, 0x9529, 0x972d, 0x9931, 0x9b35, 0x9d39, 0x9f3d, 0xa141, 0xa345, 0xa549, 0xa74d, 0xa951, 0xab56, 0xad5a, 0xaf5e, 0xb162, 0xb366, 0xb56a, 0xb76e, 0xb972, 0xbb76, 0xbd7a, 0xbf7e, 0xc182, 0xc386, 0xc58a, 0xc78e, 0xc992, 0xcb96, 0xcd9a, 0xcf9e, 0xd1a2, 0xd3a6, 0xd5aa, 0xd7ae, 0xd9b2, 0xdbb6, 0xddba, 0xdfbe, 0xe1c2, 0xe3c6, 0xe5ca, 0xe7ce, 0xe9d2, 0xebd6, 0xedda, 0xefde, 0xf1e2, 0xf3e6, 0xf5ea, 0xf7ee, 0xf9f2, 0xfbf6, 0xfdfa, 0xffff, }; /* y = 65535 * (x/127)^2 */ /*static const uint16_t gain_presets[VOLUME_LEVELS] = { 0x0000, 0x0004, 0x0010, 0x0024, 0x0041, 0x0065, 0x0092, 0x00c7, 0x0104, 0x0149, 0x0196, 0x01eb, 0x0249, 0x02ae, 0x031c, 0x0392, 0x0410, 0x0496, 0x0524, 0x05ba, 0x0659, 0x06ff, 0x07ae, 0x0865, 0x0924, 0x09eb, 0x0aba, 0x0b92, 0x0c71, 0x0d59, 0x0e48, 0x0f40, 0x1040, 0x1148, 0x1259, 0x1371, 0x1491, 0x15ba, 0x16eb, 0x1824, 0x1965, 0x1aae, 0x1bff, 0x1d58, 0x1eba, 0x2023, 0x2195, 0x230f, 0x2491, 0x261b, 0x27ad, 0x2948, 0x2aea, 0x2c95, 0x2e48, 0x3003, 0x31c6, 0x3391, 0x3564, 0x373f, 0x3923, 0x3b0f, 0x3d02, 0x3efe, 0x4102, 0x430e, 0x4523, 0x473f, 0x4964, 0x4b90, 0x4dc5, 0x5002, 0x5247, 0x5494, 0x56e9, 0x5947, 0x5bac, 0x5e1a, 0x6090, 0x630e, 0x6594, 0x6822, 0x6ab8, 0x6d57, 0x6ffd, 0x72ac, 0x7563, 0x7822, 0x7ae9, 0x7db8, 0x808f, 0x836f, 0x8656, 0x8946, 0x8c3e, 0x8f3e, 0x9246, 0x9556, 0x986e, 0x9b8f, 0x9eb7, 0xa1e8, 0xa521, 0xa862, 0xabab, 0xaefc, 0xb255, 0xb5b7, 0xb920, 0xbc92, 0xc00c, 0xc38e, 0xc718, 0xcaaa, 0xce45, 0xd1e7, 0xd592, 0xd944, 0xdcff, 0xe0c2, 0xe48d, 0xe860, 0xec3c, 0xf01f, 0xf40b, 0xf7ff, 0xfbfb, 0xffff, };*/

参考）「オリジナル」版と「y = 65535 * (x/127)」版と「y = 65535 * (x/127)^2」版のゲインプリセットの配列の値のグラフ