1e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman/* 2e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Copyright (C) 2007 The Android Open Source Project 3e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 4e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Licensed under the Apache License, Version 2.0 (the "License"); 5e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * you may not use this file except in compliance with the License. 6e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * You may obtain a copy of the License at 7e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 8e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * http://www.apache.org/licenses/LICENSE-2.0 9e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * 10e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * Unless required by applicable law or agreed to in writing, software 11e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * distributed under the License is distributed on an "AS IS" BASIS, 12e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * See the License for the specific language governing permissions and 14e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman * limitations under the License. 15e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman */ 16e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 17e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#ifndef ANDROID_AUDIO_BUFFER_PROVIDER_H 18e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#define ANDROID_AUDIO_BUFFER_PROVIDER_H 19e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 20e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#include <utils/Errors.h> 21e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 22e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramannamespace android { 23e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// ---------------------------------------------------------------------------- 24e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 25e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanclass AudioBufferProvider 26e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman{ 27e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatramanpublic: 28e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 29e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // FIXME merge with AudioTrackShared::Buffer, AudioTrack::Buffer, and AudioRecord::Buffer 30e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // and rename getNextBuffer() to obtainBuffer() 31e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman struct Buffer { 32e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman Buffer() : raw(NULL), frameCount(0) { } 33e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman union { 34e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman void* raw; 35e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman short* i16; 36e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman int8_t* i8; 37e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman }; 38e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman size_t frameCount; 39e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman }; 40e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 41e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual ~AudioBufferProvider() {} 42e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 43e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // On entry: 44e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer != NULL 45e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->raw unused 46e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->frameCount maximum number of desired frames 47e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // On successful return: 48e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // status NO_ERROR 49e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->raw non-NULL pointer to buffer->frameCount contiguous available frames 50e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->frameCount number of contiguous available frames at buffer->raw, 51e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // 0 < buffer->frameCount <= entry value 52e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // On error return: 53e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // status != NO_ERROR 54e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->raw NULL 55e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->frameCount 0 56e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual status_t getNextBuffer(Buffer* buffer) = 0; 57e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 58e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // Release (a portion of) the buffer previously obtained by getNextBuffer(). 59e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // It is permissible to call releaseBuffer() multiple times per getNextBuffer(). 60e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // On entry: 61e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->frameCount number of frames to release, must be <= number of frames 62e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // obtained but not yet released 63e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->raw unused 64e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // On return: 65e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->frameCount 0; implementation MUST set to zero 66e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // buffer->raw undefined; implementation is PERMITTED to set to any value, 67e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // so if caller needs to continue using this buffer it must 68e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman // keep track of the pointer itself 69e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman virtual void releaseBuffer(Buffer* buffer) = 0; 70e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman}; 71e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 72e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman// ---------------------------------------------------------------------------- 73e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman}; // namespace android 74e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman 75e2b43843fd12783188edd2c54188ea8d26864788Vijay Venkatraman#endif // ANDROID_AUDIO_BUFFER_PROVIDER_H 76