AudioTrackShared.h revision 1a0ae5be3d1273cba12584b33830d859510fbf82
189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project/* 289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * you may not use this file except in compliance with the License. 689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * You may obtain a copy of the License at 789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 1089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 1189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 1289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See the License for the specific language governing permissions and 1489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * limitations under the License. 1589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 1689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 1789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#ifndef ANDROID_AUDIO_TRACK_SHARED_H 1889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#define ANDROID_AUDIO_TRACK_SHARED_H 1989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <stdint.h> 2189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <sys/types.h> 2289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 2489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 2889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// Maximum cumulated timeout milliseconds before restarting audioflinger thread 3089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#define MAX_STARTUP_TIMEOUT_MS 3000 // Longer timeout period at startup to cope with A2DP init time 3189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#define MAX_RUN_TIMEOUT_MS 1000 3289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#define WAIT_PERIOD_MS 10 331703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define RESTORE_TIMEOUT_MS 5000 // Maximum waiting time for a track to be restored 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_UNDERRUN_MSK 0x0001 36d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_UNDERRUN_ON 0x0001 // underrun (out) or overrrun (in) indication 37d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_UNDERRUN_OFF 0x0000 // no underrun 38d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_DIRECTION_MSK 0x0002 39d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_DIRECTION_OUT 0x0002 // this cblk is for an AudioTrack 40d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_DIRECTION_IN 0x0000 // this cblk is for an AudioRecord 41d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_FORCEREADY_MSK 0x0004 42d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_FORCEREADY_ON 0x0004 // track is considered ready immediately by AudioFlinger 43d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_FORCEREADY_OFF 0x0000 // track is ready when buffer full 44d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent#define CBLK_INVALID_MSK 0x0008 4544d9848d6656777a18019223e0d35f2fcc67719aEric Laurent#define CBLK_INVALID_ON 0x0008 // track buffer is invalidated by AudioFlinger: 4644d9848d6656777a18019223e0d35f2fcc67719aEric Laurent#define CBLK_INVALID_OFF 0x0000 // must be re-created 4744d9848d6656777a18019223e0d35f2fcc67719aEric Laurent#define CBLK_DISABLED_MSK 0x0010 4844d9848d6656777a18019223e0d35f2fcc67719aEric Laurent#define CBLK_DISABLED_ON 0x0010 // track disabled by AudioFlinger due to underrun: 4944d9848d6656777a18019223e0d35f2fcc67719aEric Laurent#define CBLK_DISABLED_OFF 0x0000 // must be re-started 501703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define CBLK_RESTORING_MSK 0x0020 511703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define CBLK_RESTORING_ON 0x0020 // track is being restored after invalidation 521703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define CBLK_RESTORING_OFF 0x0000 // by AudioFlinger 531703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define CBLK_RESTORED_MSK 0x0040 541703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define CBLK_RESTORED_ON 0x0040 // track has been restored after invalidation 551703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent#define CBLK_RESTORED_OFF 0x0040 // by AudioFlinger 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 571a0ae5be3d1273cba12584b33830d859510fbf82Glenn Kasten// Important: do not add any virtual methods, including ~ 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectstruct audio_track_cblk_t 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // The data members are grouped so that members accessed frequently and in the same context 6289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // are in the same line of data cache. 63362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten Mutex lock; // sizeof(int) 64362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten Condition cv; // sizeof(int) 6589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project volatile uint32_t user; 6689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project volatile uint32_t server; 6789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t userBase; 6889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t serverBase; 69d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent void* buffers; 70d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t frameCount; 71d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent // Cache line boundary 72d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t loopStart; 73d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t loopEnd; 74d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent int loopCount; 75b1cf75c4935001f61057989ee3cf27bbf09ecd9cGlenn Kasten 76b1cf75c4935001f61057989ee3cf27bbf09ecd9cGlenn Kasten // Channel volumes are fixed point U4.12, so 0x1000 means 1.0. 77b1cf75c4935001f61057989ee3cf27bbf09ecd9cGlenn Kasten // Left channel is in [0:15], right channel is in [16:31]. 78b1cf75c4935001f61057989ee3cf27bbf09ecd9cGlenn Kasten // Always read and write the combined pair atomically. 79b1cf75c4935001f61057989ee3cf27bbf09ecd9cGlenn Kasten // For AudioTrack only, not used by AudioRecord. 8083d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kastenprivate: 8183d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten uint32_t mVolumeLR; 8283d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kastenpublic: 83b1cf75c4935001f61057989ee3cf27bbf09ecd9cGlenn Kasten 84573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent uint32_t sampleRate; 85c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent // NOTE: audio_track_cblk_t::frameSize is not equal to AudioTrack::frameSize() for 86c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent // 8 bit PCM data: in this case, mCblk->frameSize is based on a sample size of 87c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent // 16 bit because data is converted to 16 bit before being stored in buffer 88d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent 89b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten uint8_t frameSize; // would normally be size_t, but 8 bits is plenty 900d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint8_t pad1; 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint16_t bufferTimeoutMs; // Maximum cumulated timeout before restarting audioflinger 92c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 9338ccae2c0324daa305f3fe77d25fdf5edec0b0e1Eric Laurent uint16_t waitTimeMs; // Cumulated wait time 9405632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kastenprivate: 9505632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten uint16_t mSendLevel; // Fixed point U4.12 so 0x1000 means 1.0 9605632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kastenpublic: 9738ccae2c0324daa305f3fe77d25fdf5edec0b0e1Eric Laurent volatile int32_t flags; 9838ccae2c0324daa305f3fe77d25fdf5edec0b0e1Eric Laurent 99d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent // Cache line boundary (32 bytes) 1000d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project audio_track_cblk_t(); 10289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t stepUser(uint32_t frameCount); 10389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stepServer(uint32_t frameCount); 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* buffer(uint32_t offset) const; 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t framesAvailable(); 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t framesAvailable_l(); 10789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t framesReady(); 10838ccae2c0324daa305f3fe77d25fdf5edec0b0e1Eric Laurent bool tryLock(); 10905632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten 11005632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten // No barriers on the following operations, so the ordering of loads/stores 11105632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten // with respect to other parameters is UNPREDICTABLE. That's considered safe. 11205632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten 11305632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten // for AudioTrack client only, caller must limit to 0.0 <= sendLevel <= 1.0 11405632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten void setSendLevel(float sendLevel) { 11505632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten mSendLevel = uint16_t(sendLevel * 0x1000); 11605632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten } 11705632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten 11805632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten // for AudioFlinger only; the return value must be validated by the caller 11905632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten uint16_t getSendLevel_U4_12() const { 12005632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten return mSendLevel; 12105632a5fa4b88ca474294887fc92a9fcdf0e2352Glenn Kasten } 12283d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten 12383d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten // for AudioTrack client only, caller must limit to 0 <= volumeLR <= 0x10001000 12483d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten void setVolumeLR(uint32_t volumeLR) { 12583d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten mVolumeLR = volumeLR; 12683d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten } 12783d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten 12883d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten // for AudioFlinger only; the return value must be validated by the caller 12983d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten uint32_t getVolumeLR() const { 13083d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten return mVolumeLR; 13183d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten } 13283d86538c4c479a9225c75ab27938e8f05abb9c8Glenn Kasten 13389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 13789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 13989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif // ANDROID_AUDIO_TRACK_SHARED_H 141