xref: /aosp_15_r20/external/oboe/src/common/FixedBlockWriter.h (revision 05767d913155b055644481607e6fa1e35e2fe72c)
1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
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
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 
17 #ifndef AAUDIO_FIXED_BLOCK_WRITER_H
18 #define AAUDIO_FIXED_BLOCK_WRITER_H
19 
20 #include <stdint.h>
21 
22 #include "FixedBlockAdapter.h"
23 
24 /**
25  * This can be used to convert a push data flow from variable sized buffers to fixed sized buffers.
26  * An example would be an audio input callback.
27  */
28 class FixedBlockWriter : public FixedBlockAdapter
29 {
30 public:
31     FixedBlockWriter(FixedBlockProcessor &fixedBlockProcessor);
32 
33     virtual ~FixedBlockWriter() = default;
34 
35     /**
36      * Write from a variable sized block.
37      *
38      * Note that if the fixed-sized blocks must be aligned, then the variable-sized blocks
39      * must have the same alignment.
40      * For example, if the fixed-size blocks must be a multiple of 8, then the variable-sized
41      * blocks must also be a multiple of 8.
42      *
43      * @param buffer
44      * @param numBytes
45      * @return Number of bytes written or a negative error code.
46      */
47     int32_t write(uint8_t *buffer, int32_t numBytes);
48 
49 private:
50 
51     int32_t writeToStorage(uint8_t *buffer, int32_t numBytes);
52 };
53 
54 #endif /* AAUDIO_FIXED_BLOCK_WRITER_H */
55