165ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian/* 265ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * Copyright (C) 2007 The Android Open Source Project 365ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * 465ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * Licensed under the Apache License, Version 2.0 (the "License"); 565ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * you may not use this file except in compliance with the License. 665ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * You may obtain a copy of the License at 765ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * 865ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * http://www.apache.org/licenses/LICENSE-2.0 965ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * 1065ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * Unless required by applicable law or agreed to in writing, software 1165ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * distributed under the License is distributed on an "AS IS" BASIS, 1265ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1365ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * See the License for the specific language governing permissions and 1465ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian * limitations under the License. 1565ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian */ 1665ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 1765ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian#ifndef ANDROID_AUDIO_BUFFER_PROVIDER_H 1865ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian#define ANDROID_AUDIO_BUFFER_PROVIDER_H 1965ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 2065ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian#include <utils/Errors.h> 2165ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 2265ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopiannamespace android { 2365ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian// ---------------------------------------------------------------------------- 2465ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 2565ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopianclass AudioBufferProvider 2665ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian{ 2765ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopianpublic: 2865ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME merge with AudioTrackShared::Buffer, AudioTrack::Buffer, and AudioRecord::Buffer 309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // and rename getNextBuffer() to obtainBuffer() 3165ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian struct Buffer { 3201c4ebf6b794493898114a502ed36de13137f7e5Glenn Kasten Buffer() : raw(NULL), frameCount(0) { } 3365ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian union { 3465ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian void* raw; 3565ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian short* i16; 3665ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian int8_t* i8; 3765ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian }; 3865ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian size_t frameCount; 3965ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian }; 4065ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 41409e3749a5627f1b360feb1479fcd341067a90b8Glenn Kasten virtual ~AudioBufferProvider() {} 424ff14bae91075eb274eb1c2975982358946e7e63John Grossman 434ff14bae91075eb274eb1c2975982358946e7e63John Grossman // value representing an invalid presentation timestamp 4401c4ebf6b794493898114a502ed36de13137f7e5Glenn Kasten static const int64_t kInvalidPTS = 0x7FFFFFFFFFFFFFFFLL; // <stdint.h> is too painful 454ff14bae91075eb274eb1c2975982358946e7e63John Grossman 464ff14bae91075eb274eb1c2975982358946e7e63John Grossman // pts is the local time when the next sample yielded by getNextBuffer 474ff14bae91075eb274eb1c2975982358946e7e63John Grossman // will be rendered. 484ff14bae91075eb274eb1c2975982358946e7e63John Grossman // Pass kInvalidPTS if the PTS is unknown or not applicable. 499f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // On entry: 509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer != NULL 519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer->raw unused 529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer->frameCount maximum number of desired frames 539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // On successful return: 549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // status NO_ERROR 559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer->raw non-NULL pointer to buffer->frameCount contiguous available frames 569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer->frameCount number of contiguous available frames at buffer->raw, 579f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // 0 < buffer->frameCount <= entry value 589f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // On error return: 599f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // status != NO_ERROR 609f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer->raw NULL 619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // buffer->frameCount 0 6201c4ebf6b794493898114a502ed36de13137f7e5Glenn Kasten virtual status_t getNextBuffer(Buffer* buffer, int64_t pts = kInvalidPTS) = 0; 634ff14bae91075eb274eb1c2975982358946e7e63John Grossman 6447f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // Release (a portion of) the buffer previously obtained by getNextBuffer(). 6547f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // It is permissible to call releaseBuffer() multiple times per getNextBuffer(). 6647f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // On entry: 6747f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // buffer->frameCount number of frames to release, must be <= number of frames 6847f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // obtained but not yet released 6947f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // buffer->raw unused 7047f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // On return: 7147f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // buffer->frameCount 0; implementation MUST set to zero 7247f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // buffer->raw undefined; implementation is PERMITTED to set to any value, 7347f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // so if caller needs to continue using this buffer it must 7447f3f5a119194d4c06815453be9950ba112c8e3eGlenn Kasten // keep track of the pointer itself 7565ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian virtual void releaseBuffer(Buffer* buffer) = 0; 7665ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian}; 7765ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 7865ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian// ---------------------------------------------------------------------------- 7965ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian}; // namespace android 8065ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian 8165ab47156e1c7dfcd8cc4266253a5ff30219e7f0Mathias Agopian#endif // ANDROID_AUDIO_BUFFER_PROVIDER_H 82