DOUAudioEventLoop.m 17.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
/* vim: set ft=objc fenc=utf-8 sw=2 ts=2 et: */
/*
 *  DOUAudioStreamer - A Core Audio based streaming audio player for iOS/Mac:
 *
 *      https://github.com/douban/DOUAudioStreamer
 *
 *  Copyright 2013-2016 Douban Inc.  All rights reserved.
 *
 *  Use and distribution licensed under the BSD license.  See
 *  the LICENSE file for full text.
 *
 *  Authors:
 *      Chongyu Zhu <i@lembacon.com>
 *
 */

#import "DOUAudioEventLoop.h"
#import "DOUAudioStreamer.h"
#import "DOUAudioStreamer_Private.h"
#import "DOUAudioStreamer+Options.h"
#import "DOUAudioFileProvider.h"
#import "DOUAudioPlaybackItem.h"
#import "DOUAudioLPCM.h"
#import "DOUAudioDecoder.h"
#import "DOUAudioRenderer.h"
#include <sys/types.h>
#include <sys/event.h>
#include <sys/time.h>
#include <pthread.h>
#include <sched.h>

typedef NS_ENUM(uint64_t, event_type) {
  event_play,
  event_pause,
  event_stop,
  event_seek,
  event_streamer_changed,
  event_provider_events,
  event_finalizing,
#if TARGET_OS_IPHONE
  event_interruption_begin,
  event_interruption_end,
  event_old_device_unavailable,
#endif /* TARGET_OS_IPHONE */

  event_first = event_play,
#if TARGET_OS_IPHONE
  event_last = event_old_device_unavailable,
#else /* TARGET_OS_IPHONE */
  event_last = event_finalizing,
#endif /* TARGET_OS_IPHONE */

  event_timeout
};

@interface DOUAudioEventLoop () {
@private
  DOUAudioRenderer *_renderer;
  DOUAudioStreamer *_currentStreamer;

  NSUInteger _decoderBufferSize;
  DOUAudioFileProviderEventBlock _fileProviderEventBlock;

  int _kq;
  void *_lastKQUserData;
  pthread_mutex_t _mutex;
  pthread_t _thread;
}
@end

@implementation DOUAudioEventLoop

@synthesize currentStreamer = _currentStreamer;
@dynamic analyzers;

+ (instancetype)sharedEventLoop
{
  static DOUAudioEventLoop *sharedEventLoop = nil;

  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    sharedEventLoop = [[DOUAudioEventLoop alloc] init];
  });

  return sharedEventLoop;
}

- (instancetype)init
{
  self = [super init];
  if (self) {
    _kq = kqueue();
    pthread_mutex_init(&_mutex, NULL);

#if TARGET_OS_IPHONE
    [self _setupAudioSession];
#endif /* TARGET_OS_IPHONE */

    _renderer = [DOUAudioRenderer rendererWithBufferTime:kDOUAudioStreamerBufferTime];
    [_renderer setUp];

    if ([[NSUserDefaults standardUserDefaults] objectForKey:kDOUAudioStreamerVolumeKey] != nil) {
      [self setVolume:[[NSUserDefaults standardUserDefaults] doubleForKey:kDOUAudioStreamerVolumeKey]];
    }
    else {
      [self setVolume:1.0];
    }

    _decoderBufferSize = [[self class] _decoderBufferSize];
    [self _setupFileProviderEventBlock];
    [self _enableEvents];
    [self _createThread];
  }

  return self;
}

- (void)dealloc
{
  [self _sendEvent:event_finalizing];
  pthread_join(_thread, NULL);

  close(_kq);
  pthread_mutex_destroy(&_mutex);
}

+ (NSUInteger)_decoderBufferSize
{
  AudioStreamBasicDescription format = [DOUAudioDecoder defaultOutputFormat];
  return kDOUAudioStreamerBufferTime * format.mSampleRate * format.mChannelsPerFrame * format.mBitsPerChannel / 8 / 1000;
}

#if TARGET_OS_IPHONE

- (void)_handleAudioSessionInterruptionWithState:(UInt32)state
{
  if (state == kAudioSessionBeginInterruption) {
    [_renderer setInterrupted:YES];
    [_renderer stop];
    [self _sendEvent:event_interruption_begin];
  }
  else if (state == kAudioSessionEndInterruption) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
    AudioSessionInterruptionType interruptionType = kAudioSessionInterruptionType_ShouldNotResume;
    UInt32 interruptionTypeSize = sizeof(interruptionType);
    OSStatus status;
    status = AudioSessionGetProperty(kAudioSessionProperty_InterruptionType,
                                     &interruptionTypeSize,
                                     &interruptionType);
    NSAssert(status == noErr, @"failed to get interruption type");
#pragma clang diagnostic pop

    [self _sendEvent:event_interruption_end
            userData:(void *)(uintptr_t)interruptionType];
  }
}

- (void)_handleAudioRouteChangeWithDictionary:(NSDictionary *)routeChangeDictionary
{
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"

  NSUInteger reason = [[routeChangeDictionary objectForKey:(__bridge NSString *)kAudioSession_RouteChangeKey_Reason] unsignedIntegerValue];
  if (reason != kAudioSessionRouteChangeReason_OldDeviceUnavailable) {
    return;
  }

  NSDictionary *previousRouteDescription = [routeChangeDictionary objectForKey:(__bridge NSString *)kAudioSession_AudioRouteChangeKey_PreviousRouteDescription];
  NSArray *previousOutputRoutes = [previousRouteDescription objectForKey:(__bridge NSString *)kAudioSession_AudioRouteKey_Outputs];
  if ([previousOutputRoutes count] == 0) {
    return;
  }

  NSString *previousOutputRouteType = [[previousOutputRoutes objectAtIndex:0] objectForKey:(__bridge NSString *)kAudioSession_AudioRouteKey_Type];
  if (previousOutputRouteType == nil ||
      (![previousOutputRouteType isEqualToString:(__bridge NSString *)kAudioSessionOutputRoute_Headphones] &&
       ![previousOutputRouteType isEqualToString:(__bridge NSString *)kAudioSessionOutputRoute_BluetoothA2DP])) {
    return;
  }

#pragma clang diagnostic pop

  [self _sendEvent:event_old_device_unavailable];
}

static void audio_session_interruption_listener(void *inClientData, UInt32 inInterruptionState)
{
  __unsafe_unretained DOUAudioEventLoop *eventLoop = (__bridge DOUAudioEventLoop *)inClientData;
  [eventLoop _handleAudioSessionInterruptionWithState:inInterruptionState];
}

static void audio_route_change_listener(void *inClientData,
                                        AudioSessionPropertyID inID,
                                        UInt32 inDataSize,
                                        const void *inData)
{
  if (inID != kAudioSessionProperty_AudioRouteChange) {
    return;
  }

  __unsafe_unretained DOUAudioEventLoop *eventLoop = (__bridge DOUAudioEventLoop *)inClientData;
  [eventLoop _handleAudioRouteChangeWithDictionary:(__bridge NSDictionary *)inData];
}

- (void)_setupAudioSession
{
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"

  AudioSessionInitialize(NULL, NULL, audio_session_interruption_listener, (__bridge void *)self);

  UInt32 audioCategory = kAudioSessionCategory_MediaPlayback;
  AudioSessionSetProperty(kAudioSessionProperty_AudioCategory, sizeof(audioCategory), &audioCategory);

  AudioSessionAddPropertyListener(kAudioSessionProperty_AudioRouteChange, audio_route_change_listener, (__bridge void *)self);

  AudioSessionSetActive(TRUE);

#pragma clang diagnostic pop
}

#endif /* TARGET_OS_IPHONE */

- (void)_setupFileProviderEventBlock
{
  __unsafe_unretained DOUAudioEventLoop *eventLoop = self;
  _fileProviderEventBlock = ^{
    [eventLoop _sendEvent:event_provider_events];
  };
}

- (void)_enableEvents
{
  for (uint64_t event = event_first; event <= event_last; ++event) {
    struct kevent kev;
    EV_SET(&kev, event, EVFILT_USER, EV_ADD | EV_ENABLE | EV_CLEAR, 0, 0, NULL);
    kevent(_kq, &kev, 1, NULL, 0, NULL);
  }
}

- (void)_sendEvent:(event_type)event
{
  [self _sendEvent:event userData:NULL];
}

- (void)_sendEvent:(event_type)event userData:(void *)userData
{
  struct kevent kev;
  EV_SET(&kev, event, EVFILT_USER, 0, NOTE_TRIGGER, 0, userData);
  kevent(_kq, &kev, 1, NULL, 0, NULL);
}

- (event_type)_waitForEvent
{
  return [self _waitForEventWithTimeout:NSUIntegerMax];
}

- (event_type)_waitForEventWithTimeout:(NSUInteger)timeout
{
  struct timespec _ts;
  struct timespec *ts = NULL;
  if (timeout != NSUIntegerMax) {
    ts = &_ts;

    ts->tv_sec = timeout / 1000;
    ts->tv_nsec = (timeout % 1000) * 1000;
  }

  while (1) {
    struct kevent kev;
    int n = kevent(_kq, NULL, 0, &kev, 1, ts);
    if (n > 0) {
      if (kev.filter == EVFILT_USER &&
          kev.ident >= event_first &&
          kev.ident <= event_last) {
        _lastKQUserData = kev.udata;
        return kev.ident;
      }
    }
    else {
      break;
    }
  }

  return event_timeout;
}

- (BOOL)_handleEvent:(event_type)event withStreamer:(DOUAudioStreamer **)streamer
{
  if (event == event_play) {
    if (*streamer != nil &&
        ([*streamer status] == DOUAudioStreamerPaused ||
         [*streamer status] == DOUAudioStreamerIdle ||
         [*streamer status] == DOUAudioStreamerFinished)) {
      if ([_renderer isInterrupted]) {
#if TARGET_OS_IPHONE
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wdeprecated"
        const OSStatus status = AudioSessionSetActive(TRUE);
# pragma clang diagnostic pop
        if (status == noErr) {
#endif /* TARGET_OS_IPHONE */
          [*streamer setStatus:DOUAudioStreamerPlaying];
          [_renderer setInterrupted:NO];
#if TARGET_OS_IPHONE
        }
#endif /* TARGET_OS_IPHONE */
      }
      else {
        [*streamer setStatus:DOUAudioStreamerPlaying];
      }
    }
  }
  else if (event == event_pause) {
    if (*streamer != nil &&
        ([*streamer status] != DOUAudioStreamerPaused &&
         [*streamer status] != DOUAudioStreamerIdle &&
         [*streamer status] != DOUAudioStreamerFinished)) {
      [_renderer stop];
      [*streamer setStatus:DOUAudioStreamerPaused];
    }
  }
  else if (event == event_stop) {
    if (*streamer != nil &&
        [*streamer status] != DOUAudioStreamerIdle) {
      if ([*streamer status] != DOUAudioStreamerPaused) {
        [_renderer stop];
      }
      [_renderer flush];
      [*streamer setDecoder:nil];
      [*streamer setPlaybackItem:nil];
      [*streamer setStatus:DOUAudioStreamerIdle];
    }
  }
  else if (event == event_seek) {
    if (*streamer != nil &&
        [*streamer decoder] != nil) {
      NSUInteger milliseconds = MIN((NSUInteger)(uintptr_t)_lastKQUserData,
                                    [[*streamer playbackItem] estimatedDuration]);
      [*streamer setTimingOffset:(NSInteger)milliseconds - (NSInteger)[_renderer currentTime]];
      [[*streamer decoder] seekToTime:milliseconds];
      [_renderer flushShouldResetTiming:NO];
    }
  }
  else if (event == event_streamer_changed) {
    [_renderer stop];
    [_renderer flush];

    [[*streamer fileProvider] setEventBlock:NULL];
    *streamer = _currentStreamer;
    [[*streamer fileProvider] setEventBlock:_fileProviderEventBlock];
  }
  else if (event == event_provider_events) {
    if (*streamer != nil &&
        [*streamer status] == DOUAudioStreamerBuffering) {
      [*streamer setStatus:DOUAudioStreamerPlaying];
    }

    [*streamer setBufferingRatio:(double)[[*streamer fileProvider] receivedLength] / [[*streamer fileProvider] expectedLength]];
  }
  else if (event == event_finalizing) {
    return NO;
  }
#if TARGET_OS_IPHONE
  else if (event == event_interruption_begin) {
    if (*streamer != nil &&
        ([*streamer status] != DOUAudioStreamerPaused &&
         [*streamer status] != DOUAudioStreamerIdle &&
         [*streamer status] != DOUAudioStreamerFinished)) {
      [self performSelector:@selector(pause) onThread:[NSThread mainThread] withObject:nil waitUntilDone:NO];
      [*streamer setPausedByInterruption:YES];
    }
  }
  else if (event == event_interruption_end) {
    const AudioSessionInterruptionType interruptionType = (AudioSessionInterruptionType)(uintptr_t)_lastKQUserData;
    NSAssert(interruptionType == kAudioSessionInterruptionType_ShouldResume ||
             interruptionType == kAudioSessionInterruptionType_ShouldNotResume,
             @"invalid interruption type");

    if (interruptionType == kAudioSessionInterruptionType_ShouldResume) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
      OSStatus status;
      status = AudioSessionSetActive(TRUE);
      NSAssert(status == noErr, @"failed to activate audio session");
#pragma clang diagnostic pop
      if (status == noErr) {
        [_renderer setInterrupted:NO];

        if (*streamer != nil &&
            [*streamer status] == DOUAudioStreamerPaused &&
            [*streamer isPausedByInterruption]) {
          [*streamer setPausedByInterruption:NO];
          [self performSelector:@selector(play) onThread:[NSThread mainThread] withObject:nil waitUntilDone:NO];
        }
      }
    }
  }
  else if (event == event_old_device_unavailable) {
    if (*streamer != nil) {
      if ([*streamer status] != DOUAudioStreamerPaused &&
          [*streamer status] != DOUAudioStreamerIdle &&
          [*streamer status] != DOUAudioStreamerFinished) {
        [self performSelector:@selector(pause)
                     onThread:[NSThread mainThread]
                   withObject:nil
                waitUntilDone:NO];
      }

      [*streamer setPausedByInterruption:NO];
    }
  }
#endif /* TARGET_OS_IPHONE */
  else if (event == event_timeout) {
  }

  return YES;
}

- (void)_handleStreamer:(DOUAudioStreamer *)streamer
{
  if (streamer == nil) {
    return;
  }

  if ([streamer status] != DOUAudioStreamerPlaying) {
    return;
  }

  if ([[streamer fileProvider] isFailed]) {
    [streamer setError:[NSError errorWithDomain:kDOUAudioStreamerErrorDomain
                                           code:DOUAudioStreamerNetworkError
                                       userInfo:nil]];
    [streamer setStatus:DOUAudioStreamerError];
    return;
  }

  if (![[streamer fileProvider] isReady]) {
    [streamer setStatus:DOUAudioStreamerBuffering];
    return;
  }

  if ([streamer playbackItem] == nil) {
    [streamer setPlaybackItem:[DOUAudioPlaybackItem playbackItemWithFileProvider:[streamer fileProvider]]];
    if (![[streamer playbackItem] open]) {
      [streamer setError:[NSError errorWithDomain:kDOUAudioStreamerErrorDomain
                                             code:DOUAudioStreamerDecodingError
                                         userInfo:nil]];
      [streamer setStatus:DOUAudioStreamerError];
      return;
    }

    [streamer setDuration:(NSTimeInterval)[[streamer playbackItem] estimatedDuration] / 1000.0];
  }

  if ([streamer decoder] == nil) {
    [streamer setDecoder:[DOUAudioDecoder decoderWithPlaybackItem:[streamer playbackItem]
                                                       bufferSize:_decoderBufferSize]];
    if (![[streamer decoder] setUp]) {
      [streamer setError:[NSError errorWithDomain:kDOUAudioStreamerErrorDomain
                                             code:DOUAudioStreamerDecodingError
                                         userInfo:nil]];
      [streamer setStatus:DOUAudioStreamerError];
      return;
    }
  }

  switch ([[streamer decoder] decodeOnce]) {
  case DOUAudioDecoderSucceeded:
    break;

  case DOUAudioDecoderFailed:
    [streamer setError:[NSError errorWithDomain:kDOUAudioStreamerErrorDomain
                                           code:DOUAudioStreamerDecodingError
                                       userInfo:nil]];
    [streamer setStatus:DOUAudioStreamerError];
    return;

  case DOUAudioDecoderEndEncountered:
    [_renderer stop];
    [streamer setDecoder:nil];
    [streamer setPlaybackItem:nil];
    [streamer setStatus:DOUAudioStreamerFinished];
    return;

  case DOUAudioDecoderWaiting:
    [streamer setStatus:DOUAudioStreamerBuffering];
    return;
  }

  void *bytes = NULL;
  NSUInteger length = 0;
  [[[streamer decoder] lpcm] readBytes:&bytes length:&length];
  if (bytes != NULL) {
    [_renderer renderBytes:bytes length:length];
    free(bytes);
  }
}

- (void)_eventLoop
{
  DOUAudioStreamer *streamer = nil;

  while (1) {
    @autoreleasepool {
      if (streamer != nil) {
        switch ([streamer status]) {
        case DOUAudioStreamerPaused:
        case DOUAudioStreamerIdle:
        case DOUAudioStreamerFinished:
        case DOUAudioStreamerBuffering:
        case DOUAudioStreamerError:
          if (![self _handleEvent:[self _waitForEvent]
                     withStreamer:&streamer]) {
            return;
          }
          break;

        default:
          break;
        }
      }
      else {
        if (![self _handleEvent:[self _waitForEvent]
                   withStreamer:&streamer]) {
          return;
        }
      }

      if (![self _handleEvent:[self _waitForEventWithTimeout:0]
                 withStreamer:&streamer]) {
        return;
      }

      if (streamer != nil) {
        [self _handleStreamer:streamer];
      }
    }
  }
}

static void *event_loop_main(void *info)
{
  pthread_setname_np("com.douban.audio-streamer.event-loop");

  __unsafe_unretained DOUAudioEventLoop *eventLoop = (__bridge DOUAudioEventLoop *)info;
  @autoreleasepool {
    [eventLoop _eventLoop];
  }

  return NULL;
}

- (void)_createThread
{
  pthread_attr_t attr;
  struct sched_param sched_param;
  int sched_policy = SCHED_FIFO;

  pthread_attr_init(&attr);
  pthread_attr_setschedpolicy(&attr, sched_policy);
  sched_param.sched_priority = sched_get_priority_max(sched_policy);
  pthread_attr_setschedparam(&attr, &sched_param);

  pthread_create(&_thread, &attr, event_loop_main, (__bridge void *)self);

  pthread_attr_destroy(&attr);
}

- (void)setCurrentStreamer:(DOUAudioStreamer *)currentStreamer
{
  if (_currentStreamer != currentStreamer) {
    _currentStreamer = currentStreamer;
    [self _sendEvent:event_streamer_changed];
  }
}

- (NSTimeInterval)currentTime
{
  return (NSTimeInterval)((NSUInteger)[[self currentStreamer] timingOffset] + [_renderer currentTime]) / 1000.0;
}

- (void)setCurrentTime:(NSTimeInterval)currentTime
{
  NSUInteger milliseconds = (NSUInteger)lrint(currentTime * 1000.0);
  [self _sendEvent:event_seek userData:(void *)(uintptr_t)milliseconds];
}

- (double)volume
{
  return [_renderer volume];
}

- (void)setVolume:(double)volume
{
  [_renderer setVolume:volume];

  if ([DOUAudioStreamer options] & DOUAudioStreamerKeepPersistentVolume) {
    [[NSUserDefaults standardUserDefaults] setDouble:volume
                                              forKey:kDOUAudioStreamerVolumeKey];
  }
}

- (void)play
{
  [self _sendEvent:event_play];
}

- (void)pause
{
  [self _sendEvent:event_pause];
}

- (void)stop
{
  [self _sendEvent:event_stop];
}

- (id)forwardingTargetForSelector:(SEL)aSelector
{
  if (aSelector == @selector(analyzers) ||
      aSelector == @selector(setAnalyzers:)) {
    return _renderer;
  }

  return [super forwardingTargetForSelector:aSelector];
}

@end