Home | History | Annotate | Download | only in media
      1 /*
      2  * Copyright (C) 2007 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 ANDROID_AUDIO_TRACK_SHARED_H
     18 #define ANDROID_AUDIO_TRACK_SHARED_H
     19 
     20 #include <stdint.h>
     21 #include <sys/types.h>
     22 
     23 #include <utils/threads.h>
     24 
     25 namespace android {
     26 
     27 // ----------------------------------------------------------------------------
     28 
     29 // Maximum cumulated timeout milliseconds before restarting audioflinger thread
     30 #define MAX_STARTUP_TIMEOUT_MS  3000    // Longer timeout period at startup to cope with A2DP init time
     31 #define MAX_RUN_TIMEOUT_MS      1000
     32 #define WAIT_PERIOD_MS          10
     33 #define RESTORE_TIMEOUT_MS      5000    // Maximum waiting time for a track to be restored
     34 
     35 #define CBLK_UNDERRUN_MSK       0x0001
     36 #define CBLK_UNDERRUN_ON        0x0001  // underrun (out) or overrrun (in) indication
     37 #define CBLK_UNDERRUN_OFF       0x0000  // no underrun
     38 #define CBLK_DIRECTION_MSK      0x0002
     39 #define CBLK_DIRECTION_OUT      0x0002  // this cblk is for an AudioTrack
     40 #define CBLK_DIRECTION_IN       0x0000  // this cblk is for an AudioRecord
     41 #define CBLK_FORCEREADY_MSK     0x0004
     42 #define CBLK_FORCEREADY_ON      0x0004  // track is considered ready immediately by AudioFlinger
     43 #define CBLK_FORCEREADY_OFF     0x0000  // track is ready when buffer full
     44 #define CBLK_INVALID_MSK        0x0008
     45 #define CBLK_INVALID_ON         0x0008  // track buffer is invalidated by AudioFlinger:
     46 #define CBLK_INVALID_OFF        0x0000  // must be re-created
     47 #define CBLK_DISABLED_MSK       0x0010
     48 #define CBLK_DISABLED_ON        0x0010  // track disabled by AudioFlinger due to underrun:
     49 #define CBLK_DISABLED_OFF       0x0000  // must be re-started
     50 #define CBLK_RESTORING_MSK      0x0020
     51 #define CBLK_RESTORING_ON       0x0020  // track is being restored after invalidation
     52 #define CBLK_RESTORING_OFF      0x0000  // by AudioFlinger
     53 #define CBLK_RESTORED_MSK       0x0040
     54 #define CBLK_RESTORED_ON        0x0040  // track has been restored after invalidation
     55 #define CBLK_RESTORED_OFF       0x0040  // by AudioFlinger
     56 
     57 struct audio_track_cblk_t
     58 {
     59 
     60     // The data members are grouped so that members accessed frequently and in the same context
     61     // are in the same line of data cache.
     62                 Mutex       lock;
     63                 Condition   cv;
     64     volatile    uint32_t    user;
     65     volatile    uint32_t    server;
     66                 uint32_t    userBase;
     67                 uint32_t    serverBase;
     68                 void*       buffers;
     69                 uint32_t    frameCount;
     70                 // Cache line boundary
     71                 uint32_t    loopStart;
     72                 uint32_t    loopEnd;
     73                 int         loopCount;
     74     volatile    union {
     75                     uint16_t    volume[2];
     76                     uint32_t    volumeLR;
     77                 };
     78                 uint32_t    sampleRate;
     79                 // NOTE: audio_track_cblk_t::frameSize is not equal to AudioTrack::frameSize() for
     80                 // 8 bit PCM data: in this case,  mCblk->frameSize is based on a sample size of
     81                 // 16 bit because data is converted to 16 bit before being stored in buffer
     82 
     83                 uint8_t     frameSize;
     84                 uint8_t     pad1;
     85                 uint16_t    bufferTimeoutMs; // Maximum cumulated timeout before restarting audioflinger
     86 
     87                 uint16_t    waitTimeMs;      // Cumulated wait time
     88                 uint16_t    sendLevel;
     89     volatile    int32_t     flags;
     90 
     91                 // Cache line boundary (32 bytes)
     92 
     93                             audio_track_cblk_t();
     94                 uint32_t    stepUser(uint32_t frameCount);
     95                 bool        stepServer(uint32_t frameCount);
     96                 void*       buffer(uint32_t offset) const;
     97                 uint32_t    framesAvailable();
     98                 uint32_t    framesAvailable_l();
     99                 uint32_t    framesReady();
    100                 bool        tryLock();
    101 };
    102 
    103 
    104 // ----------------------------------------------------------------------------
    105 
    106 }; // namespace android
    107 
    108 #endif // ANDROID_AUDIO_TRACK_SHARED_H
    109