1.1　オーディオオブジェクトからプロパティーのデータを取得する

　AudioObjectID型を介して情報を操作するために、AudioObjectGetPropertyData()という関数が、CoreAudio.frameworkには用意されています。

リスト1.1: AudioObjectGetPropertyData()のインターフェース

OSStatus
AudioObjectGetPropertyData(
  AudioObjectID                       inObjectID,
  const AudioObjectPropertyAddress*   inAddress,
  UInt32                              inQualifierDataSize,
  const void*                         inQualifierData,
  UInt32*                             ioDataSize,
  void*                               outData);

　この関数の戻り値の型はOSStatusですが、CoreAudio.frameworkに定義されている関数の戻り値はほとんどOSStatus型となっており、関数の失敗要因のエラーコードを返します。プロダクトコードではこの戻り値を見た上で適切なエラー処理をする必要がありますが、本書でそれを行うと、例示するコードが煩雑になってしまいます。そのため、他書の例に漏れず、必要な場合以外は戻り値の確認は行いません。

　この関数が要求する引数は、それぞれ次のようになっています。

　第二引数のプロパティーアドレスは、指定したオーディオオブジェクトのどのプロパティーに対して操作したいかを表します。

　AudioObjectPropertyAddressは、以下のような要素を持つ構造体として定義されています。

　セレクターの型であるAudioObjectPropertySelectorは、その実際の型としてはUInt32で、各クラスが所有しているプロパティーに対応する数値として定義されています。

　たとえば、オーディオオブジェクトクラスのセレクターには、その名前を取得するための kAudioObjectPropertyNameや、オーディオオブジェクトが持っているオーディオオブジェクトの一覧を取得するためのkAudioObjectPropertyOwnedObjectsなどがあります。

　スコープの型であるAudioObjectPropertyScopeもUInt32の別名で、以下の4種類の識別子が定義されています。全てのプロパティーは少なくともGlobalスコープに属しており、その他はプロパティー毎に属し方が異なります。

　最後、エレメントを表すAudioPropertyElement型はUInt32の別名として定義されており、実態としては、配列のインデックスのようなものです。複数のエレメントがある場合にその何番目のエレメントのプロパティーを取得したいのかを指定するためにあります。なお、最初の要素を示す0だけは別名がkAudioObjectPropertyElementMainとして定義されており、全てのプロパティーは少なくともこのメインエレメントを有しています。

　では、実際にプロパティーのデータを取得してみましょう。ここでは例として、デフォルトの出力デバイスを表すAudioObjectIDを取得してみます。

　システムに存在する全てのオーディオオブジェクトのルートとなるオブジェクトは、システムオブジェクトです。このシステムオブジェクトを表すAudioObjectIDとして、kAudioObjectSystemObjectが定義されています。このシステムオブジェクトは、デフォルトの出力デバイスを表すオーディオオブジェクトをプロパティーとして持っているので、システムオブジェクトからデフォルトの出力デバイスのオーディオオブジェクトを取得します。

リスト1.2: システムオブジェクトからデフォルトの出力デバイスを取得する

// (1) ヘッダをインクルード
#include <CoreFoundation/CoreFoundation.h>
#include <CoreAudio/CoreAudio.h>
#include <iostream>

int main()
{
    // (2) 取得したいプロパティーのプロパティーアドレスを設定
    auto address = AudioObjectPropertyAddress
    {
        .mSelector = kAudioHardwarePropertyDefaultOutputDevice,
        .mScope = kAudioObjectPropertyScopeGlobal,
        .mElement = kAudioObjectPropertyElementMain,
    };

    AudioObjectID id = kAudioObjectUnknown; // (3) 取得するAudioObjectIDの受け皿を用意
    UInt32 size = sizeof(id); //(4) 取得するデータサイズを設定

    // (5) AudioObjectIDを取得する
    auto result = AudioObjectGetPropertyData(
                      kAudioObjectSystemObject,
                      &address,
                      0,
                      nullptr,
                      &size,
                      &id);
    if (result == kAudioHardwareNoError)
    {
        std::cout << "device id: " << id << std::endl;
    }
    else
    {
        std::cerr << "error: " << result << std::endl;
    }

    return result;
}

　最初に、(1)で利用するヘッダをインクルードします。CoreAudio.frameworkを利用する場合、インクルードすべきヘッダは以下のふたつです。

　・CoreFoundation/CoreFoundation.h

　・CoreAudio/CoreAudio.h

　ヘッダのインクルードをすることで宣言、定義されている型や関数が利用できるようになったところで、(2)のようにデフォルト出力デバイスを取得するためのプロパティーアドレスを作ります。システムオブジェクトのセレクターのスコープは全てグローバルで、エレメントに関してもデフォルト出力デバイスはひとつしかありませんので、メインエレメントを指定します。

　そして、(3)で要求するプロパティーの受け皿としてAudioObjectIDの変数を用意し、(4)でそのサイズもUInt32型の変数として用意します。

　(5)実際にAudioObjectGetPropertyData()を呼び出し、成功すると(3)で用意した変数にデフォルト出力デバイスのAudioObjectIDが入っています。

1.2　プロパティーのデータが必要とするデータサイズを取得する

　取得対象のプロパティーのデータサイズが不変である場合は、先のコード例のように、直接AudioObjectGetPropertyData()関数を呼び出すこともできますが、プロパティーによってはデータサイズが可変の場合もあります。たとえば、システムに接続されているデバイスの一覧を取得したい場合、データサイズはデバイス数に依存するため、一意には定まりません。そういうとき、まずデータサイズだけを取得してからプロパティーのデータを取得する手法を取る必要があります。このデータサイズを取得する専用の関数として、AudioObjectGetPropertyDataSize()が定義されています。

リスト1.3: AudioObjectGetPropertyDataSize()のインターフェース

OSStatus
AudioObjectGetPropertyDataSize(
  AudioObjectID                       inObjectID,
  const AudioObjectPropertyAddress*   inAddress,
  UInt32                              inQualifierDataSize,
  const void*                         inQualifierData,
  UInt32*                             outDataSize);

　では、実際にシステムに接続されている全てのオーディオデバイスのオーディオオブジェクトを取得してみましょう。

リスト1.4: システムに接続されている全てのオーディオデバイスの取得

// (1) プロパティーアドレスを設定
auto address = AudioObjectPropertyAddress
{
    .mSelector = kAudioHardwarePropertyDevices,
    .mScope = kAudioObjectPropertyScopeGlobal,
    .mElement = kAudioObjectPropertyElementMain,
};

// (2) データサイズを取得
UInt32 size = 0;
AudioObjectGetPropertyDataSize(
    kAudioObjectSystemObject,
    &address,
    0,
    nullptr,
    &size);

// (3) オーディオデバイスのリストを格納するメモリーを確保して
auto device_list = std::vector<AudioObjectID>(size / sizeof(AudioObjectID));

// (4) オーディオデバイスのリストを取得する
AudioObjectGetPropertyData(
    kAudioObjectSystemObject,
    &address,
    0,
    nullptr,
    &size,
    &device_list[0]);

for (auto device_id : device_list)
{
    std::cout << "device id: " << device_id << std::endl;
}

　基本的な流れは先程と同じですが、このプロパティーはデータサイズがシステムの状態によって異なりますので、プロパティーのデータを取得する前に、(2)でデータサイズを確定させています。