[Mac] Add classes to manage audio samples
[WebKit-https.git] / Source / WebCore / platform / audio / mac / AudioSampleBufferList.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(MEDIA_STREAM)
29
30 #include "CARingBuffer.h"
31 #include <CoreAudio/CoreAudioTypes.h>
32 #include <wtf/Lock.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35
36 typedef struct AudioStreamBasicDescription AudioStreamBasicDescription;
37 typedef struct OpaqueAudioConverter* AudioConverterRef;
38
39 namespace WebCore {
40
41 class AudioSampleBufferList : public RefCounted<AudioSampleBufferList> {
42 public:
43     static Ref<AudioSampleBufferList> create(const CAAudioStreamDescription&, size_t);
44
45     ~AudioSampleBufferList();
46
47     static void configureBufferListForStream(AudioBufferList&, const CAAudioStreamDescription&, uint8_t*, size_t);
48     static inline size_t audioBufferListSizeForStream(const CAAudioStreamDescription&);
49
50     static void applyGain(AudioBufferList&, float, AudioStreamDescription::PCMFormat);
51     void applyGain(float);
52
53     OSStatus copyFrom(const AudioSampleBufferList&, size_t count = SIZE_MAX);
54     OSStatus copyFrom(AudioBufferList&, AudioConverterRef);
55     OSStatus copyFrom(AudioSampleBufferList&, AudioConverterRef);
56     OSStatus copyFrom(CARingBuffer&, size_t frameCount, uint64_t startFrame, CARingBuffer::FetchMode);
57
58     OSStatus mixFrom(const AudioSampleBufferList&, size_t count = SIZE_MAX);
59
60     OSStatus copyTo(AudioBufferList&, size_t count = SIZE_MAX);
61
62     const AudioStreamBasicDescription& streamDescription() const { return m_internalFormat->streamDescription(); }
63     AudioBufferList& bufferList() const { return *m_bufferList.get(); }
64
65     uint32_t sampleCapacity() const { return m_sampleCapacity; }
66     uint32_t sampleCount() const { return m_sampleCount; }
67     void setSampleCount(size_t);
68
69     uint64_t timestamp() const { return m_timestamp; }
70     double hostTime() const { return m_hostTime; }
71     void setTimes(uint64_t time, double hostTime) { m_timestamp = time; m_hostTime = hostTime; }
72
73     void reset();
74
75     static void zeroABL(AudioBufferList&, size_t);
76     void zero();
77
78 protected:
79     AudioSampleBufferList(const CAAudioStreamDescription&, size_t);
80
81     static OSStatus audioConverterCallback(AudioConverterRef, UInt32*, AudioBufferList*, AudioStreamPacketDescription**, void*);
82     OSStatus convertInput(UInt32*, AudioBufferList*);
83
84     std::unique_ptr<CAAudioStreamDescription> m_internalFormat;
85
86     AudioSampleBufferList* m_converterInputBuffer2 { nullptr };
87     AudioBufferList* m_converterInputBuffer { nullptr };
88     uint32_t m_converterInputBytesPerPacket { 0 };
89
90     uint64_t m_timestamp { 0 };
91     double m_hostTime { -1 };
92     size_t m_sampleCount { 0 };
93     size_t m_sampleCapacity { 0 };
94     size_t m_maxBufferSizePerChannel { 0 };
95     size_t m_bufferListBaseSize { 0 };
96     std::unique_ptr<AudioBufferList> m_bufferList;
97 };
98
99 inline size_t AudioSampleBufferList::audioBufferListSizeForStream(const CAAudioStreamDescription& description)
100 {
101     return offsetof(AudioBufferList, mBuffers) + (sizeof(AudioBuffer) * std::max<uint32_t>(1, description.numberOfChannelStreams()));
102 }
103
104 } // namespace WebCore
105
106 #endif // ENABLE(MEDIA_STREAM)