QAudioSource Class

QFile destinationFile;// クラスメンバ
QAudioSource*audio;   // クラスのメンバ
{
    destinationFile.setFileName("/tmp/test.raw");
    destinationFile.open( QIODevice::WriteOnly|QIODevice::Truncate );

    QAudioFormat format;
    // 希望するフォーマットを設定します。例：
    format.setSampleRate(44100);
    format.setChannelCount(1);
    format.setSampleFormat(QAudioFormat::Int16);

    QAudioDevice info=QMediaDevices::defaultAudioInput();
    if(!info.isFormatSupported(format)) {
        qWarning() << "Default format not supported, trying to use the nearest.";
    }

    audio= newQAudioSource(format, this);
    connect(audio, &QAudioSource::stateChanged, this, &AudioInputExample::handleStateChanged);

    QTimer::singleShot(3000, this, &AudioInputExample::stopRecording);
    audio->start(&destinationFile);
    // 3000ms間、音声を録音します
}

void AudioInputExample::stopRecording()
{
    audio->stop();
    destinationFile.close();
    delete audio;
}

QAudioSource*audio;          // クラスメンバー。
std::atomic<float>peakLevel;// クラスメンバー。
{
    QAudioFormat format;
    // フォーマットを設定します。例：
    format.setSampleRate(44100);
    format.setChannelCount(2);
    format.setSampleFormat(QAudioFormat::Float);

    QAudioDevice info(QMediaDevices::defaultAudioOutput());
    if(!info.isFormatSupported(format)) {
        qWarning() << "Raw audio format not supported by backend, cannot capture audio.";
       return;
    }

    audio= newQAudioSource(format, this);
    audio->start([&peakLevel](QSpan<float>interleavedAudioBuffer) {
        floatlevel=peakLevel.load();

        for(floatsample : interleavedAudioBuffer) {
            // オーディオサンプルからピークレベルを計算する
            level=std::max(level,std::abs(sample));
        }

        peakLevel.store(level);
        // 注：アプリケーションスレッドへの通知が必要な場合は注意が必要です。
        // オーディオコールバックでは 、 ブロックする可能性のあるシステムコールを一切使用してはなりません。
       // 適切な選択肢としては、オートリセットイベント（Windows）、eventfd（Linux）、または macOS での kqueue/EVFILT_USER などがあります。
    });

    if(!audio->error()== QtAudio::Error::NoError) {
       // 他の start() のシグネチャに加え、以下の場合はオーディオコールバックの起動に失敗します。
        // * バックエンドがコールバックベースの I/O を実装していない場合（この API はすべての主要な
        //   プラットフォームで 利用可能です ）
        // * オーディオコールバックのシグネチャが format.sampleFormat() と一致しない場合

        qWarning() << "Error starting audio output:" << audio->errorString();
    }
}

void AudioInputExample::handleStateChanged(QtAudio::State newState)
{
    switch (newState) {
        case QtAudio::StoppedState:
            if (audio->error() != QtAudio::NoError) {
                // Error handling
            } else {
                // Finished recording
            }
            break;

        case QtAudio::ActiveState:
            // Started recording - read from IO device
            break;

        default:
            // ... other cases as appropriate
            break;
    }
}

メンバー関数のドキュメント

[explicit] QAudioSource::QAudioSource(const QAudioFormat &format = QAudioFormat(), QObject *parent = nullptr)

新しいオーディオ入力を作成し、それをparent に接続します。出力パラメータformat には、デフォルトのオーディオ入力デバイスが使用されます。format がデフォルトで初期化されている場合、フォーマットはオーディオデバイスの推奨フォーマットに設定されます。

[explicit] QAudioSource::QAudioSource(const QAudioDevice &audioDevice, const QAudioFormat &format = QAudioFormat(), QObject *parent = nullptr)

新しいオーディオ入力を作成し、それをparent に接続します。audioDevice で参照されるデバイスは、入力パラメータformat とともに使用されます。format がデフォルトで初期化されている場合、フォーマットはaudioDevice の推奨フォーマットに設定されます。

[override virtual noexcept] QAudioSource::~QAudioSource()

このオーディオ入力を破棄してください。

[since 6.10] qsizetype QAudioSource::bufferFrameCount() const

オーディオバッファのサイズをフレーム単位で返します。

start() の呼び出し前に呼び出された場合、プラットフォームのデフォルト値を返します。start() の呼び出し前に呼び出されたが、その前にsetBufferSize() またはsetBufferFrameCount() が呼び出されていた場合、setBufferSize() またはsetBufferFrameCount() で設定された値を返します。start() の呼び出し後に呼び出された場合、実際に使用されているバッファサイズを返します。これは、setBufferSize() またはsetBufferFrameCount() で以前に設定された値とは異なる場合があります。

この関数は Qt 6.10 で導入されました。

setBufferFrameCount() およびbufferSizeも参照してください 。

qsizetype QAudioSource::bufferSize() const

オーディオバッファのサイズ（バイト単位）を返します。

start() の呼び出し前に呼び出された場合、プラットフォームのデフォルト値を返します。start() の呼び出し前に呼び出され、かつsetBufferSize() またはsetBufferFrameCount() が先に呼び出されていた場合、setBufferSize() またはsetBufferFrameCount() で設定された値を返します。start() の呼び出し後に呼び出された場合、実際に使用されているバッファサイズを返します。これは、setBufferSize() またはsetBufferFrameCount() で以前に設定された値とは異なる場合があります。

setBufferSize() およびbufferFrameCountも参照してください 。

qsizetype QAudioSource::bytesAvailable() const

読み取り可能なオーディオデータの量をバイト単位で返します。

「framesAvailable」も参照してください 。

qint64 QAudioSource::elapsedUSecs() const

start() が呼び出されてからの経過時間をマイクロ秒単位で返します。これには、アイドル状態およびサスペンド状態での時間も含まれます。

QtAudio::Error QAudioSource::error() const

エラーの状態を返します。

QAudioFormat QAudioSource::format() const

使用中のQAudioFormat を返します。

[since 6.10] qsizetype QAudioSource::framesAvailable() const

読み取り可能なオーディオデータの量をフレーム単位で返します。

注：戻り値は、QtAudio::ActiveState またはQtAudio::IdleState の状態にある間のみ有効です。それ以外の場合はゼロを返します。

この関数はQt 6.10で導入されました。

bytesAvailableも参照してください 。

bool QAudioSource::isNull() const

オーディオソースが `null` の場合は `true ` を返し、それ以外の場合は `false` を返します。

[since 6.12] qsizetype QAudioSource::nativePeriodFrameCount() const

ネイティブの期間フレーム数を返します。

設定されていない場合は -1 を返し、それ以外の場合はsetNativePeriodFrameCount() で以前に設定された値を返します。

この関数は Qt 6.12 で導入されました。

setNativePeriodFrameCountも参照してください 。

qint64 QAudioSource::processedUSecs() const

start() の呼び出し以降に処理されたオーディオデータの量をマイクロ秒単位で返します。

void QAudioSource::reset()

バッファ内のすべてのオーディオデータを破棄し、バッファをゼロにリセットします。

void QAudioSource::resume()

suspend() の実行後に、オーディオデータの処理を再開します。

state() を、suspend() が呼び出された時点でのシンクの状態に設定します。オーディオシンクの状態がQtAudio::SuspendedState でない場合、この関数は何も行いません。

[since 6.10] void QAudioSource::setBufferFrameCount(qsizetype value)

オーディオバッファのサイズを、フレーム数でvalue に設定します。

bufferFrameCount() およびbufferSize() プロパティは、QIODevice API を使用する際のリングバッファのサイズを表します。ネイティブの周期サイズは、setNativePeriodFrameCount() によって制御されます。

この関数は Qt 6.10 で導入されました。

bufferFrameCount() およびsetBufferSizeも参照してください 。

void QAudioSource::setBufferSize(qsizetype value)

オーディオバッファのサイズをvalue バイトに設定します。

bufferFrameCount() およびbufferSize() プロパティは、QIODevice API を使用する際のリングバッファサイズを示します。ネイティブの周期サイズは、setNativePeriodFrameCount() によって制御されます。

bufferSize() およびsetBufferFrameCountも参照してください 。

[since 6.12] void QAudioSource::setNativePeriodFrameCount(qsizetype frameCount)

ネイティブの周期フレーム数をframeCount に設定します。

オペレーティングシステムおよびハードウェアが使用するオーディオバッファサイズを調整します。デフォルト（設定されていない場合）では、システムはプラットフォームに依存する値（通常は1024フレーム、44100 Hzで約23 ms）を使用します。

レイテンシを低減するには小さい値（64～256）を、バッファオーバーラン（ドロップアウト）のリスクを低減するには大きい値（2048～4096）を使用します。

有効な値は、32 から 4096 までの 2 の冪（両端を含む）または、設定を解除する -1 です。オーディオソースが停止しているときにのみ呼び出すことができます。

プラットフォーム固有の設定への対応関係：kAudioDevicePropertyBufferFrameSize (macOS)、IAudioClient::bufferDuration (Windows)、PW_KEY_NODE_FORCE_QUANTUM (PipeWire/Linux)、AAudioStreamBuilder_setBufferCapacityInFrames (Android)。

この関数は Qt 6.12 で導入されました。

nativePeriodFrameCountも参照してください 。

void QAudioSource::setVolume(qreal volume)

入力音量をvolume に設定します。

音量は、0.0 （無音）から1.0 （最大音量）まで直線的にスケーリングされます。この範囲外の値はクリップされます。

デバイスが入力音量の調整に対応していない場合、volume は無視され、入力音量は 1.0 のままになります。

デフォルトの音量は1.0 です。

volume()も参照してください 。

QIODevice *QAudioSource::start()

システムのオーディオ入力からデータを転送するために使用されている内部のQIODevice へのポインタを返します。デバイスはすでに開かれているため、read() を使用してそこから直接データを読み取ることができます。

QAudioSource がシステムのオーディオデバイスにアクセスできる場合、state() はQtAudio::IdleState を返し、error() はQtAudio::NoError を返し、stateChanged() シグナルが発行されます。

この処理中に問題が発生した場合、error() はQtAudio::OpenError を返し、state() はQtAudio::StoppedState を返し、stateChanged() シグナルが発信されます。

QIODevice およびQIODevice interfaceも参照してください 。

[since 6.11] template <typename Callback> requires QtAudio::if_audio_source_callback<Callback> void QAudioSource::start(Callback &&cb)

QAudioSource を、ソフトリアルタイムオーディオスレッド上で呼び出されるコールバック関数とともに起動します。このコールバックは、QSpan<const SampleType>を引数として受け取るコールアブルです。SampleTypeは、QAudioSource のフォーマットで定義されたQAudioFormat::SampleFormat と一致している必要があります。spanには、インターリーブされたオーディオデータが含まれています。

QAudioSource が正常に開始できた場合、error()はQtAudio::NoError を返します。

この処理中に問題が発生した場合、error()はQtAudio::OpenError を返し、state()はQtAudio::StoppedState を返し、stateChanged()シグナルが発信されます。

この関数は Qt 6.11 で導入されました。

Callback interfaceも参照してください 。

void QAudioSource::start(QIODevice *device)

システムのオーディオ入力からdevice へのオーディオデータの転送を開始します。device は、WriteOnly 、Append 、またはReadWrite モードで開かれている必要があります。

QAudioSource がオーディオデータを正常に取得できた場合、state()はQtAudio::ActiveState またはQtAudio::IdleState を返し、error()はQtAudio::NoError を返し、stateChanged()シグナルが発行されます。

この処理中に問題が発生した場合、error() はQtAudio::OpenError を返し、state() はQtAudio::StoppedState を返し、stateChanged() シグナルが発行されます。

QIODevice およびQIODevice interfaceも参照してください 。

QtAudio::State QAudioSource::state() const

オーディオ処理の状態を返します。

[signal] void QAudioSource::stateChanged(QtAudio::State state)

このシグナルは、デバイス「state 」の状態が変更されたときに発火します。

void QAudioSource::stop()

オーディオ入力を停止し、システムリソースからの接続を解除します。

error()をQtAudio::NoError に、state()をQtAudio::StoppedState に設定し、stateChanged()シグナルを発生させます。

void QAudioSource::suspend()

オーディオデータの処理を停止し、バッファに保存されたオーディオデータを保持します。

error()をQtAudio::NoError に、state()をQtAudio::SuspendedState に設定し、stateChanged()シグナルを発行します。

qreal QAudioSource::volume() const

入力音量を返します。

デバイスが入力音量の調整に対応していない場合、戻り値は 1.0 になります。

setVolume()も参照してください 。