AudioTrack.h revision 2799d743ee2ae5a25fe869a7f9c052acc029559f
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_AUDIOTRACK_H 18#define ANDROID_AUDIOTRACK_H 19 20#include <stdint.h> 21#include <sys/types.h> 22 23#include <media/IAudioFlinger.h> 24#include <media/IAudioTrack.h> 25#include <media/AudioSystem.h> 26 27#include <utils/RefBase.h> 28#include <utils/Errors.h> 29#include <binder/IInterface.h> 30#include <binder/IMemory.h> 31#include <cutils/sched_policy.h> 32#include <utils/threads.h> 33 34namespace android { 35 36// ---------------------------------------------------------------------------- 37 38class audio_track_cblk_t; 39class AudioTrackClientProxy; 40 41// ---------------------------------------------------------------------------- 42 43class AudioTrack : virtual public RefBase 44{ 45public: 46 enum channel_index { 47 MONO = 0, 48 LEFT = 0, 49 RIGHT = 1 50 }; 51 52 /* Events used by AudioTrack callback function (audio_track_cblk_t). 53 * Keep in sync with frameworks/base/media/java/android/media/AudioTrack.java NATIVE_EVENT_*. 54 */ 55 enum event_type { 56 EVENT_MORE_DATA = 0, // Request to write more data to buffer. 57 // If this event is delivered but the callback handler 58 // does not want to write more data, the handler must explicitly 59 // ignore the event by setting frameCount to zero. 60 EVENT_UNDERRUN = 1, // Buffer underrun occurred. 61 EVENT_LOOP_END = 2, // Sample loop end was reached; playback restarted from 62 // loop start if loop count was not 0. 63 EVENT_MARKER = 3, // Playback head is at the specified marker position 64 // (See setMarkerPosition()). 65 EVENT_NEW_POS = 4, // Playback head is at a new position 66 // (See setPositionUpdatePeriod()). 67 EVENT_BUFFER_END = 5 // Playback head is at the end of the buffer. 68 }; 69 70 /* Client should declare Buffer on the stack and pass address to obtainBuffer() 71 * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 72 */ 73 74 class Buffer 75 { 76 public: 77 size_t frameCount; // number of sample frames corresponding to size; 78 // on input it is the number of frames desired, 79 // on output is the number of frames actually filled 80 81 size_t size; // input/output in byte units 82 union { 83 void* raw; 84 short* i16; // signed 16-bit 85 int8_t* i8; // unsigned 8-bit, offset by 0x80 86 }; 87 }; 88 89 90 /* As a convenience, if a callback is supplied, a handler thread 91 * is automatically created with the appropriate priority. This thread 92 * invokes the callback when a new buffer becomes available or various conditions occur. 93 * Parameters: 94 * 95 * event: type of event notified (see enum AudioTrack::event_type). 96 * user: Pointer to context for use by the callback receiver. 97 * info: Pointer to optional parameter according to event type: 98 * - EVENT_MORE_DATA: pointer to AudioTrack::Buffer struct. The callback must not write 99 * more bytes than indicated by 'size' field and update 'size' if fewer bytes are 100 * written. 101 * - EVENT_UNDERRUN: unused. 102 * - EVENT_LOOP_END: pointer to an int indicating the number of loops remaining. 103 * - EVENT_MARKER: pointer to an uint32_t containing the marker position in frames. 104 * - EVENT_NEW_POS: pointer to an uint32_t containing the new position in frames. 105 * - EVENT_BUFFER_END: unused. 106 */ 107 108 typedef void (*callback_t)(int event, void* user, void *info); 109 110 /* Returns the minimum frame count required for the successful creation of 111 * an AudioTrack object. 112 * Returned status (from utils/Errors.h) can be: 113 * - NO_ERROR: successful operation 114 * - NO_INIT: audio server or audio hardware not initialized 115 */ 116 117 static status_t getMinFrameCount(size_t* frameCount, 118 audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 119 uint32_t sampleRate = 0); 120 121 /* Constructs an uninitialized AudioTrack. No connection with 122 * AudioFlinger takes place. Use set() after this. 123 */ 124 AudioTrack(); 125 126 /* Creates an AudioTrack object and registers it with AudioFlinger. 127 * Once created, the track needs to be started before it can be used. 128 * Unspecified values are set to appropriate default values. 129 * With this constructor, the track is configured for streaming mode. 130 * Data to be rendered is supplied by write() or by the callback EVENT_MORE_DATA. 131 * Intermixing a combination of write() and non-ignored EVENT_MORE_DATA is deprecated. 132 * 133 * Parameters: 134 * 135 * streamType: Select the type of audio stream this track is attached to 136 * (e.g. AUDIO_STREAM_MUSIC). 137 * sampleRate: Track sampling rate in Hz. 138 * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 139 * 16 bits per sample). 140 * channelMask: Channel mask. 141 * frameCount: Minimum size of track PCM buffer in frames. This defines the 142 * application's contribution to the 143 * latency of the track. The actual size selected by the AudioTrack could be 144 * larger if the requested size is not compatible with current audio HAL 145 * configuration. Zero means to use a default value. 146 * flags: See comments on audio_output_flags_t in <system/audio.h>. 147 * cbf: Callback function. If not null, this function is called periodically 148 * to provide new data and inform of marker, position updates, etc. 149 * user: Context for use by the callback receiver. 150 * notificationFrames: The callback function is called each time notificationFrames PCM 151 * frames have been consumed from track input buffer. 152 * sessionId: Specific session ID, or zero to use default. 153 * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 154 * If not present in parameter list, then fixed at false. 155 */ 156 157 AudioTrack( audio_stream_type_t streamType, 158 uint32_t sampleRate = 0, 159 audio_format_t format = AUDIO_FORMAT_DEFAULT, 160 audio_channel_mask_t channelMask = 0, 161 int frameCount = 0, 162 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 163 callback_t cbf = NULL, 164 void* user = NULL, 165 int notificationFrames = 0, 166 int sessionId = 0); 167 168 /* Creates an audio track and registers it with AudioFlinger. 169 * With this constructor, the track is configured for static buffer mode. 170 * The format must not be 8-bit linear PCM. 171 * Data to be rendered is passed in a shared memory buffer 172 * identified by the argument sharedBuffer, which must be non-0. 173 * The memory should be initialized to the desired data before calling start(). 174 * The write() method is not supported in this case. 175 * It is recommended to pass a callback function to be notified of playback end by an 176 * EVENT_UNDERRUN event. 177 * FIXME EVENT_MORE_DATA still occurs; it must be ignored. 178 */ 179 180 AudioTrack( audio_stream_type_t streamType, 181 uint32_t sampleRate = 0, 182 audio_format_t format = AUDIO_FORMAT_DEFAULT, 183 audio_channel_mask_t channelMask = 0, 184 const sp<IMemory>& sharedBuffer = 0, 185 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 186 callback_t cbf = NULL, 187 void* user = NULL, 188 int notificationFrames = 0, 189 int sessionId = 0); 190 191 /* Terminates the AudioTrack and unregisters it from AudioFlinger. 192 * Also destroys all resources associated with the AudioTrack. 193 */ 194protected: 195 virtual ~AudioTrack(); 196public: 197 198 /* Initialize an uninitialized AudioTrack. 199 * Returned status (from utils/Errors.h) can be: 200 * - NO_ERROR: successful initialization 201 * - INVALID_OPERATION: AudioTrack is already initialized 202 * - BAD_VALUE: invalid parameter (channelMask, format, sampleRate...) 203 * - NO_INIT: audio server or audio hardware not initialized 204 * If sharedBuffer is non-0, the frameCount parameter is ignored and 205 * replaced by the shared buffer's total allocated size in frame units. 206 */ 207 status_t set(audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 208 uint32_t sampleRate = 0, 209 audio_format_t format = AUDIO_FORMAT_DEFAULT, 210 audio_channel_mask_t channelMask = 0, 211 int frameCount = 0, 212 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 213 callback_t cbf = NULL, 214 void* user = NULL, 215 int notificationFrames = 0, 216 const sp<IMemory>& sharedBuffer = 0, 217 bool threadCanCallJava = false, 218 int sessionId = 0); 219 220 /* Result of constructing the AudioTrack. This must be checked 221 * before using any AudioTrack API (except for set()), because using 222 * an uninitialized AudioTrack produces undefined results. 223 * See set() method above for possible return codes. 224 */ 225 status_t initCheck() const { return mStatus; } 226 227 /* Returns this track's estimated latency in milliseconds. 228 * This includes the latency due to AudioTrack buffer size, AudioMixer (if any) 229 * and audio hardware driver. 230 */ 231 uint32_t latency() const { return mLatency; } 232 233 /* getters, see constructors and set() */ 234 235 audio_stream_type_t streamType() const { return mStreamType; } 236 audio_format_t format() const { return mFormat; } 237 238 /* Return frame size in bytes, which for linear PCM is channelCount * (bit depth per channel / 8). 239 * channelCount is determined from channelMask, and bit depth comes from format. 240 * For non-linear formats, the frame size is typically 1 byte. 241 */ 242 uint32_t channelCount() const { return mChannelCount; } 243 244 uint32_t frameCount() const { return mFrameCount; } 245 size_t frameSize() const { return mFrameSize; } 246 247 /* Return the static buffer specified in constructor or set(), or 0 for streaming mode */ 248 sp<IMemory> sharedBuffer() const { return mSharedBuffer; } 249 250 /* After it's created the track is not active. Call start() to 251 * make it active. If set, the callback will start being called. 252 * If the track was previously paused, volume is ramped up over the first mix buffer. 253 */ 254 void start(); 255 256 /* Stop a track. 257 * In static buffer mode, the track is stopped immediately. 258 * In streaming mode, the callback will cease being called and 259 * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 260 * and will fill up buffers until the pool is exhausted. 261 * The stop does not occur immediately: any data remaining in the buffer 262 * is first drained, mixed, and output, and only then is the track marked as stopped. 263 */ 264 void stop(); 265 bool stopped() const; 266 267 /* Flush a stopped or paused track. All previously buffered data is discarded immediately. 268 * This has the effect of draining the buffers without mixing or output. 269 * Flush is intended for streaming mode, for example before switching to non-contiguous content. 270 * This function is a no-op if the track is not stopped or paused, or uses a static buffer. 271 */ 272 void flush(); 273 274 /* Pause a track. After pause, the callback will cease being called and 275 * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 276 * and will fill up buffers until the pool is exhausted. 277 * Volume is ramped down over the next mix buffer following the pause request, 278 * and then the track is marked as paused. It can be resumed with ramp up by start(). 279 */ 280 void pause(); 281 282 /* Set volume for this track, mostly used for games' sound effects 283 * left and right volumes. Levels must be >= 0.0 and <= 1.0. 284 * This is the older API. New applications should use setVolume(float) when possible. 285 */ 286 status_t setVolume(float left, float right); 287 288 /* Set volume for all channels. This is the preferred API for new applications, 289 * especially for multi-channel content. 290 */ 291 status_t setVolume(float volume); 292 293 /* Set the send level for this track. An auxiliary effect should be attached 294 * to the track with attachEffect(). Level must be >= 0.0 and <= 1.0. 295 */ 296 status_t setAuxEffectSendLevel(float level); 297 void getAuxEffectSendLevel(float* level) const; 298 299 /* Set sample rate for this track in Hz, mostly used for games' sound effects 300 */ 301 status_t setSampleRate(uint32_t sampleRate); 302 303 /* Return current sample rate in Hz, or 0 if unknown */ 304 uint32_t getSampleRate() const; 305 306 /* Enables looping and sets the start and end points of looping. 307 * Only supported for static buffer mode. 308 * 309 * FIXME The comments below are for the new planned interpretation which is not yet implemented. 310 * Currently the legacy behavior is still implemented, where loopStart and loopEnd 311 * are in wrapping (overflow) frame units like the return value of getPosition(). 312 * The plan is to fix all callers to use the new version at same time implementation changes. 313 * 314 * Parameters: 315 * 316 * loopStart: loop start in frames relative to start of buffer. 317 * loopEnd: loop end in frames relative to start of buffer. 318 * loopCount: number of loops to execute. Calling setLoop() with loopCount == 0 cancels any 319 * pending or active loop. loopCount == -1 means infinite looping. 320 * 321 * For proper operation the following condition must be respected: 322 * loopCount != 0 implies 0 <= loopStart < loopEnd <= frameCount(). 323 * 324 * If the loop period (loopEnd - loopStart) is too small for the implementation to support, 325 * setLoop() will return BAD_VALUE. 326 * 327 */ 328 status_t setLoop(uint32_t loopStart, uint32_t loopEnd, int loopCount); 329 330 /* Sets marker position. When playback reaches the number of frames specified, a callback with 331 * event type EVENT_MARKER is called. Calling setMarkerPosition with marker == 0 cancels marker 332 * notification callback. To set a marker at a position which would compute as 0, 333 * a workaround is to the set the marker at a nearby position such as -1 or 1. 334 * If the AudioTrack has been opened with no callback function associated, the operation will 335 * fail. 336 * 337 * Parameters: 338 * 339 * marker: marker position expressed in wrapping (overflow) frame units, 340 * like the return value of getPosition(). 341 * 342 * Returned status (from utils/Errors.h) can be: 343 * - NO_ERROR: successful operation 344 * - INVALID_OPERATION: the AudioTrack has no callback installed. 345 */ 346 status_t setMarkerPosition(uint32_t marker); 347 status_t getMarkerPosition(uint32_t *marker) const; 348 349 /* Sets position update period. Every time the number of frames specified has been played, 350 * a callback with event type EVENT_NEW_POS is called. 351 * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 352 * callback. 353 * If the AudioTrack has been opened with no callback function associated, the operation will 354 * fail. 355 * Extremely small values may be rounded up to a value the implementation can support. 356 * 357 * Parameters: 358 * 359 * updatePeriod: position update notification period expressed in frames. 360 * 361 * Returned status (from utils/Errors.h) can be: 362 * - NO_ERROR: successful operation 363 * - INVALID_OPERATION: the AudioTrack has no callback installed. 364 */ 365 status_t setPositionUpdatePeriod(uint32_t updatePeriod); 366 status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 367 368 /* Sets playback head position. 369 * Only supported for static buffer mode. 370 * 371 * FIXME The comments below are for the new planned interpretation which is not yet implemented. 372 * Currently the legacy behavior is still implemented, where the new position 373 * is in wrapping (overflow) frame units like the return value of getPosition(). 374 * The plan is to fix all callers to use the new version at same time implementation changes. 375 * 376 * Parameters: 377 * 378 * position: New playback head position in frames relative to start of buffer. 379 * 0 <= position <= frameCount(). Note that end of buffer is permitted, 380 * but will result in an immediate underrun if started. 381 * 382 * Returned status (from utils/Errors.h) can be: 383 * - NO_ERROR: successful operation 384 * - INVALID_OPERATION: the AudioTrack is not stopped or paused, or is streaming mode. 385 * - BAD_VALUE: The specified position is beyond the number of frames present in AudioTrack 386 * buffer 387 */ 388 status_t setPosition(uint32_t position); 389 390 /* Return the total number of frames played since playback start. 391 * The counter will wrap (overflow) periodically, e.g. every ~27 hours at 44.1 kHz. 392 * It is reset to zero by flush(), reload(), and stop(). 393 */ 394 status_t getPosition(uint32_t *position); 395 396#if 0 397 /* For static buffer mode only, this returns the current playback position in frames 398 * relative to start of buffer. It is analogous to the new API for 399 * setLoop() and setPosition(). After underrun, the position will be at end of buffer. 400 */ 401 status_t getBufferPosition(uint32_t *position); 402#endif 403 404 /* Forces AudioTrack buffer full condition. When playing a static buffer, this method avoids 405 * rewriting the buffer before restarting playback after a stop. 406 * This method must be called with the AudioTrack in paused or stopped state. 407 * Not allowed in streaming mode. 408 * 409 * Returned status (from utils/Errors.h) can be: 410 * - NO_ERROR: successful operation 411 * - INVALID_OPERATION: the AudioTrack is not stopped or paused, or is streaming mode. 412 */ 413 status_t reload(); 414 415 /* Returns a handle on the audio output used by this AudioTrack. 416 * 417 * Parameters: 418 * none. 419 * 420 * Returned value: 421 * handle on audio hardware output 422 */ 423 audio_io_handle_t getOutput(); 424 425 /* Returns the unique session ID associated with this track. 426 * 427 * Parameters: 428 * none. 429 * 430 * Returned value: 431 * AudioTrack session ID. 432 */ 433 int getSessionId() const { return mSessionId; } 434 435 /* Attach track auxiliary output to specified effect. Use effectId = 0 436 * to detach track from effect. 437 * 438 * Parameters: 439 * 440 * effectId: effectId obtained from AudioEffect::id(). 441 * 442 * Returned status (from utils/Errors.h) can be: 443 * - NO_ERROR: successful operation 444 * - INVALID_OPERATION: the effect is not an auxiliary effect. 445 * - BAD_VALUE: The specified effect ID is invalid 446 */ 447 status_t attachAuxEffect(int effectId); 448 449 /* Obtains a buffer of "frameCount" frames. The buffer must be 450 * filled entirely, and then released with releaseBuffer(). 451 * If the track is stopped, obtainBuffer() returns 452 * STOPPED instead of NO_ERROR as long as there are buffers available, 453 * at which point NO_MORE_BUFFERS is returned. 454 * Buffers will be returned until the pool 455 * is exhausted, at which point obtainBuffer() will either block 456 * or return WOULD_BLOCK depending on the value of the "blocking" 457 * parameter. 458 * 459 * obtainBuffer() and releaseBuffer() are deprecated for direct use by applications, 460 * which should use write() or callback EVENT_MORE_DATA instead. 461 * 462 * Interpretation of waitCount: 463 * +n limits wait time to n * WAIT_PERIOD_MS, 464 * -1 causes an (almost) infinite wait time, 465 * 0 non-blocking. 466 * 467 * Buffer fields 468 * On entry: 469 * frameCount number of frames requested 470 * After error return: 471 * frameCount 0 472 * size 0 473 * raw undefined 474 * After successful return: 475 * frameCount actual number of frames available, <= number requested 476 * size actual number of bytes available 477 * raw pointer to the buffer 478 */ 479 480 enum { 481 NO_MORE_BUFFERS = 0x80000001, // same name in AudioFlinger.h, ok to be different value 482 STOPPED = 1 483 }; 484 485 status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 486 487 /* Release a filled buffer of "frameCount" frames for AudioFlinger to process. */ 488 void releaseBuffer(Buffer* audioBuffer); 489 490 /* As a convenience we provide a write() interface to the audio buffer. 491 * This is implemented on top of obtainBuffer/releaseBuffer. For best 492 * performance use callbacks. Returns actual number of bytes written >= 0, 493 * or one of the following negative status codes: 494 * INVALID_OPERATION AudioTrack is configured for shared buffer mode 495 * BAD_VALUE size is invalid 496 * STOPPED AudioTrack was stopped during the write 497 * NO_MORE_BUFFERS when obtainBuffer() returns same 498 * or any other error code returned by IAudioTrack::start() or restoreTrack_l(). 499 * Not supported for static buffer mode. 500 */ 501 ssize_t write(const void* buffer, size_t size); 502 503 /* 504 * Dumps the state of an audio track. 505 */ 506 status_t dump(int fd, const Vector<String16>& args) const; 507 508protected: 509 /* copying audio tracks is not allowed */ 510 AudioTrack(const AudioTrack& other); 511 AudioTrack& operator = (const AudioTrack& other); 512 513 /* a small internal class to handle the callback */ 514 class AudioTrackThread : public Thread 515 { 516 public: 517 AudioTrackThread(AudioTrack& receiver, bool bCanCallJava = false); 518 519 // Do not call Thread::requestExitAndWait() without first calling requestExit(). 520 // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 521 virtual void requestExit(); 522 523 void pause(); // suspend thread from execution at next loop boundary 524 void resume(); // allow thread to execute, if not requested to exit 525 526 private: 527 friend class AudioTrack; 528 virtual bool threadLoop(); 529 AudioTrack& mReceiver; 530 ~AudioTrackThread(); 531 Mutex mMyLock; // Thread::mLock is private 532 Condition mMyCond; // Thread::mThreadExitedCondition is private 533 bool mPaused; // whether thread is currently paused 534 }; 535 536 // body of AudioTrackThread::threadLoop() 537 bool processAudioBuffer(const sp<AudioTrackThread>& thread); 538 539 // caller must hold lock on mLock for all _l methods 540 status_t createTrack_l(audio_stream_type_t streamType, 541 uint32_t sampleRate, 542 audio_format_t format, 543 size_t frameCount, 544 audio_output_flags_t flags, 545 const sp<IMemory>& sharedBuffer, 546 audio_io_handle_t output); 547 548 // can only be called when !mActive 549 void flush_l(); 550 551 status_t setLoop_l(uint32_t loopStart, uint32_t loopEnd, int loopCount); 552 audio_io_handle_t getOutput_l(); 553 status_t restoreTrack_l(audio_track_cblk_t*& cblk, bool fromStart); 554 bool stopped_l() const { return !mActive; } 555 556 sp<IAudioTrack> mAudioTrack; 557 sp<IMemory> mCblkMemory; 558 sp<AudioTrackThread> mAudioTrackThread; 559 560 float mVolume[2]; 561 float mSendLevel; 562 uint32_t mSampleRate; 563 size_t mFrameCount; // corresponds to current IAudioTrack 564 size_t mReqFrameCount; // frame count to request the next time a new 565 // IAudioTrack is needed 566 567 audio_track_cblk_t* mCblk; // re-load after mLock.unlock() 568 569 // Starting address of buffers in shared memory. If there is a shared buffer, mBuffers 570 // is the value of pointer() for the shared buffer, otherwise mBuffers points 571 // immediately after the control block. This address is for the mapping within client 572 // address space. AudioFlinger::TrackBase::mBuffer is for the server address space. 573 void* mBuffers; 574 575 audio_format_t mFormat; // as requested by client, not forced to 16-bit 576 audio_stream_type_t mStreamType; 577 uint32_t mChannelCount; 578 audio_channel_mask_t mChannelMask; 579 580 // mFrameSize is equal to mFrameSizeAF for non-PCM or 16-bit PCM data. 581 // For 8-bit PCM data, mFrameSizeAF is 582 // twice as large because data is expanded to 16-bit before being stored in buffer. 583 size_t mFrameSize; // app-level frame size 584 size_t mFrameSizeAF; // AudioFlinger frame size 585 586 status_t mStatus; 587 uint32_t mLatency; 588 589 bool mActive; // protected by mLock 590 591 callback_t mCbf; // callback handler for events, or NULL 592 void* mUserData; // for client callback handler 593 594 // for notification APIs 595 uint32_t mNotificationFramesReq; // requested number of frames between each 596 // notification callback 597 uint32_t mNotificationFramesAct; // actual number of frames between each 598 // notification callback 599 sp<IMemory> mSharedBuffer; 600 int mLoopCount; 601 uint32_t mRemainingFrames; 602 uint32_t mMarkerPosition; // in wrapping (overflow) frame units 603 bool mMarkerReached; 604 uint32_t mNewPosition; // in frames 605 uint32_t mUpdatePeriod; // in frames 606 607 bool mFlushed; // FIXME will be made obsolete by making flush() synchronous 608 audio_output_flags_t mFlags; 609 int mSessionId; 610 int mAuxEffectId; 611 612 // When locking both mLock and mCblk->lock, must lock in this order to avoid deadlock: 613 // 1. mLock 614 // 2. mCblk->lock 615 // It is OK to lock only mCblk->lock. 616 mutable Mutex mLock; 617 618 bool mIsTimed; 619 int mPreviousPriority; // before start() 620 SchedPolicy mPreviousSchedulingGroup; 621 AudioTrackClientProxy* mProxy; 622 bool mAwaitBoost; // thread should wait for priority boost before running 623}; 624 625class TimedAudioTrack : public AudioTrack 626{ 627public: 628 TimedAudioTrack(); 629 630 /* allocate a shared memory buffer that can be passed to queueTimedBuffer */ 631 status_t allocateTimedBuffer(size_t size, sp<IMemory>* buffer); 632 633 /* queue a buffer obtained via allocateTimedBuffer for playback at the 634 given timestamp. PTS units are microseconds on the media time timeline. 635 The media time transform (set with setMediaTimeTransform) set by the 636 audio producer will handle converting from media time to local time 637 (perhaps going through the common time timeline in the case of 638 synchronized multiroom audio case) */ 639 status_t queueTimedBuffer(const sp<IMemory>& buffer, int64_t pts); 640 641 /* define a transform between media time and either common time or 642 local time */ 643 enum TargetTimeline {LOCAL_TIME, COMMON_TIME}; 644 status_t setMediaTimeTransform(const LinearTransform& xform, 645 TargetTimeline target); 646}; 647 648}; // namespace android 649 650#endif // ANDROID_AUDIOTRACK_H 651