macosx/HBAudioController.m

   1 //
   2 //  HBAudioController.m
   3 //  HandBrake
   4 //
   5 //  Created on 2010-08-24.
   6 //
   7
   8 #import "HBAudioController.h"
   9 #import "Controller.h"
  10 #import "HBAudio.h"
  11 #import "hb.h"
  12
  13 NSString *keyAudioTrackIndex = @"keyAudioTrackIndex";
  14 NSString *keyAudioTrackName = @"keyAudioTrackName";
  15 NSString *keyAudioInputBitrate = @"keyAudioInputBitrate";
  16 NSString *keyAudioInputSampleRate = @"keyAudioInputSampleRate";
  17 NSString *keyAudioInputCodec = @"keyAudioInputCodec";
  18 NSString *keyAudioInputChannelLayout = @"keyAudioInputChannelLayout";
  19 NSString *HBMixdownChangedNotification = @"HBMixdownChangedNotification";
  20
  21 @implementation HBAudioController
  22
  23 #pragma mark -
  24 #pragma mark Accessors
  25
  26 @synthesize masterTrackArray;
  27 @synthesize noneTrack;
  28 @synthesize videoContainerTag;
  29
  30 - (id) init
  31
  32 {
  33         if (self = [super init]) {
  34                 [self setVideoContainerTag: [NSNumber numberWithInt: HB_MUX_MP4]];
  35                 audioArray = [[NSMutableArray alloc] init];
  36         }
  37         return self;
  38 }
  39
  40 - (void) dealloc
  41
  42 {
  43         [[NSNotificationCenter defaultCenter] removeObserver: self];
  44         [masterTrackArray release];
  45         [noneTrack release];
  46         [audioArray release];
  47         [self setVideoContainerTag: nil];
  48         [super dealloc];
  49         return;
  50 }
  51
  52 - (void) setHBController: (id) aController
  53
  54 {
  55         NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
  56         myController = aController;
  57
  58         /* register that we are interested in changes made to the video container */
  59         [center addObserver: self selector: @selector(containerChanged:) name: HBContainerChangedNotification object: aController];
  60         [center addObserver: self selector: @selector(titleChanged:) name: HBTitleChangedNotification object: aController];
  61         return;
  62 }
  63
  64 - (void) _clearAudioArray
  65
  66 {
  67         while (0 < [self countOfAudioArray]) {
  68                 [self removeObjectFromAudioArrayAtIndex: 0];
  69         }
  70         return;
  71 }
  72
  73 #pragma mark -
  74 #pragma mark HBController Support
  75
  76 - (void) prepareAudioForQueueFileJob: (NSMutableDictionary *) aDict
  77
  78 {
  79         unsigned int audioArrayCount = [self countOfAudioArray];
  80         for (unsigned int counter = 0; counter < audioArrayCount; counter++) {
  81                 HBAudio *anAudio = [self objectInAudioArrayAtIndex: counter];
  82                 if (YES == [anAudio enabled]) {
  83                         NSString *prefix = [NSString stringWithFormat: @"Audio%d", counter + 1];
  84                         NSNumber *sampleRateToUse = (0 == [[[anAudio sampleRate] objectForKey: keyAudioSamplerate] intValue]) ?
  85                                                                 [[anAudio track] objectForKey: keyAudioInputSampleRate] :
  86                                                                 [[anAudio sampleRate] objectForKey: keyAudioSamplerate];
  87
  88                         [aDict setObject: [[anAudio track] objectForKey: keyAudioTrackIndex] forKey: [prefix stringByAppendingString: @"Track"]];
  89                         [aDict setObject: [[anAudio track] objectForKey: keyAudioTrackName] forKey: [prefix stringByAppendingString: @"TrackDescription"]];
  90                         [aDict setObject: [[anAudio codec] objectForKey: keyAudioCodecName] forKey: [prefix stringByAppendingString: @"Encoder"]];
  91                         [aDict setObject: [[anAudio mixdown] objectForKey: keyAudioMixdownName] forKey: [prefix stringByAppendingString: @"Mixdown"]];
  92                         [aDict setObject: [[anAudio sampleRate] objectForKey: keyAudioSampleRateName] forKey: [prefix stringByAppendingString: @"Samplerate"]];
  93                         [aDict setObject: [[anAudio bitRate] objectForKey: keyAudioBitrateName] forKey: [prefix stringByAppendingString: @"Bitrate"]];
  94                         [aDict setObject: [anAudio drc] forKey: [prefix stringByAppendingString: @"TrackDRCSlider"]];
  95
  96                         prefix = [NSString stringWithFormat: @"JobAudio%d", counter + 1];
  97                         [aDict setObject: [[anAudio codec] objectForKey: keyAudioCodec] forKey: [prefix stringByAppendingString: @"Encoder"]];
  98                         [aDict setObject: [[anAudio mixdown] objectForKey: keyAudioMixdown] forKey: [prefix stringByAppendingString: @"Mixdown"]];
  99                         [aDict setObject: sampleRateToUse forKey: [prefix stringByAppendingString: @"Samplerate"]];
 100                         [aDict setObject: [[anAudio bitRate] objectForKey: keyAudioBitrate] forKey: [prefix stringByAppendingString: @"Bitrate"]];
 101                 }
 102         }
 103         return;
 104 }
 105
 106 - (void) prepareAudioForJob: (hb_job_t *) aJob
 107
 108 {
 109         unsigned int i;
 110
 111         //      First clear out any audio tracks in the job currently
 112     int audiotrack_count = hb_list_count(aJob->list_audio);
 113     for(i = 0; i < audiotrack_count; i++)
 114     {
 115         hb_audio_t *temp_audio = (hb_audio_t *) hb_list_item(aJob->list_audio, 0);
 116         hb_list_rem(aJob->list_audio, temp_audio);
 117     }
 118
 119         //      Now add audio tracks based on the current settings
 120         unsigned int audioArrayCount = [self countOfAudioArray];
 121         for (i = 0; i < audioArrayCount; i++) {
 122                 HBAudio *anAudio = [self objectInAudioArrayAtIndex: i];
 123                 if (YES == [anAudio enabled]) {
 124                         NSNumber *sampleRateToUse = (0 == [[[anAudio sampleRate] objectForKey: keyAudioSamplerate] intValue]) ?
 125                                                                                 [[anAudio track] objectForKey: keyAudioInputSampleRate] :
 126                                                                                 [[anAudio sampleRate] objectForKey: keyAudioSamplerate];
 127
 128                         hb_audio_config_t *audio = (hb_audio_config_t *) calloc(1, sizeof(*audio));
 129                         hb_audio_config_init(audio);
 130                         audio->in.track = [[[anAudio track] objectForKey: keyAudioTrackIndex] intValue] - 1;
 131                         /* We go ahead and assign values to our audio->out.<properties> */
 132                         audio->out.track = audio->in.track;
 133                         audio->out.codec = [[[anAudio codec] objectForKey: keyAudioCodec] intValue];
 134                         audio->out.mixdown = [[[anAudio mixdown] objectForKey: keyAudioMixdown] intValue];
 135                         audio->out.bitrate = [[[anAudio bitRate] objectForKey: keyAudioBitrate] intValue];
 136                         audio->out.samplerate = [sampleRateToUse intValue];
 137                         audio->out.dynamic_range_compression = [[anAudio drc] floatValue];
 138
 139                         hb_audio_add(aJob, audio);
 140                         free(audio);
 141                 }
 142         }
 143         return;
 144 }
 145
 146 - (void) prepareAudioForPreset: (NSMutableArray *) anArray
 147
 148 {
 149         unsigned int audioArrayCount = [self countOfAudioArray];
 150         unsigned int i;
 151
 152         for (i = 0; i < audioArrayCount; i++) {
 153                 HBAudio *anAudio = [self objectInAudioArrayAtIndex: i];
 154                 if (YES == [anAudio enabled]) {
 155                         NSMutableDictionary *dict = [[NSMutableDictionary alloc] initWithCapacity: 7];
 156                         [dict setObject: [[anAudio track] objectForKey: keyAudioTrackIndex] forKey: @"AudioTrack"];
 157                         [dict setObject: [[anAudio track] objectForKey: keyAudioTrackName] forKey: @"AudioTrackDescription"];
 158                         [dict setObject: [[anAudio codec] objectForKey: keyAudioCodecName] forKey: @"AudioEncoder"];
 159                         [dict setObject: [[anAudio mixdown] objectForKey: keyAudioMixdownName] forKey: @"AudioMixdown"];
 160                         [dict setObject: [[anAudio sampleRate] objectForKey: keyAudioSampleRateName] forKey: @"AudioSamplerate"];
 161                         [dict setObject: [[anAudio bitRate] objectForKey: keyAudioBitrateName] forKey: @"AudioBitrate"];
 162                         [dict setObject: [anAudio drc] forKey: @"AudioTrackDRCSlider"];
 163                         [anArray addObject: dict];
 164                         [dict release];
 165                 }
 166         }
 167         return;
 168 }
 169
 170 - (void) addTracksFromQueue: (NSMutableDictionary *) aQueue
 171
 172 {
 173         NSString *base;
 174         int value;
 175         int maximumNumberOfAllowedAudioTracks = [HBController maximumNumberOfAllowedAudioTracks];
 176
 177         //      Reinitialize the configured list of audio tracks
 178         [self _clearAudioArray];
 179
 180         //      The following is the pattern to follow, but with Audio%dTrack being the key to seek...
 181         //      Can we assume that there will be no skip in the data?
 182         for (unsigned int i = 1; i <= maximumNumberOfAllowedAudioTracks; i++) {
 183                 base = [NSString stringWithFormat: @"Audio%d", i];
 184                 value = [[aQueue objectForKey: [base stringByAppendingString: @"Track"]] intValue];
 185                 if (0 < value) {
 186                         HBAudio *newAudio = [[HBAudio alloc] init];
 187                         [newAudio setController: self];
 188                         [self insertObject: newAudio inAudioArrayAtIndex: [self countOfAudioArray]];
 189                         [newAudio setVideoContainerTag: [self videoContainerTag]];
 190                         [newAudio setTrackFromIndex: value];
 191                         [newAudio setCodecFromName: [aQueue objectForKey: [base stringByAppendingString: @"Encoder"]]];
 192                         [newAudio setMixdownFromName: [aQueue objectForKey: [base stringByAppendingString: @"Mixdown"]]];
 193                         [newAudio setSampleRateFromName: [aQueue objectForKey: [base stringByAppendingString: @"Samplerate"]]];
 194                         [newAudio setBitRateFromName: [aQueue objectForKey: [base stringByAppendingString: @"Bitrate"]]];
 195                         [newAudio setDrc: [aQueue objectForKey: [base stringByAppendingString: @"TrackDRCSlider"]]];
 196                         [newAudio release];
 197                 }
 198         }
 199
 200         [self switchingTrackFromNone: nil];     // see if we need to add one to the list
 201
 202         return;
 203 }
 204
 205 //      This routine takes the preset and will return the value for the key AudioList
 206 //      if it exists, otherwise it creates an array from the data in the present.
 207 - (NSArray *) _presetAudioArrayFromPreset: (NSMutableDictionary *) aPreset
 208
 209 {
 210         NSArray *retval = [aPreset objectForKey: @"AudioList"];
 211
 212         if (nil == retval) {
 213                 int maximumNumberOfAllowedAudioTracks = [HBController maximumNumberOfAllowedAudioTracks];
 214                 NSString *base;
 215                 NSMutableArray *whatToUse = [NSMutableArray array];
 216                 for (unsigned int i = 1; i <= maximumNumberOfAllowedAudioTracks; i++) {
 217                         base = [NSString stringWithFormat: @"Audio%d", i];
 218                         if (nil != [aPreset objectForKey: [base stringByAppendingString: @"Track"]]) {
 219                                 [whatToUse addObject: [NSDictionary dictionaryWithObjectsAndKeys:
 220                                                                            [aPreset objectForKey: [base stringByAppendingString: @"Encoder"]], @"AudioEncoder",
 221                                                                            [aPreset objectForKey: [base stringByAppendingString: @"Mixdown"]], @"AudioMixdown",
 222                                                                            [aPreset objectForKey: [base stringByAppendingString: @"Samplerate"]], @"AudioSamplerate",
 223                                                                            [aPreset objectForKey: [base stringByAppendingString: @"Bitrate"]], @"AudioBitrate",
 224                                                                            [aPreset objectForKey: [base stringByAppendingString: @"TrackDRCSlider"]], @"AudioTrackDRCSlider",
 225                                                                            nil]];
 226                         }
 227                 }
 228                 retval = whatToUse;
 229         }
 230         return retval;
 231 }
 232
 233 //      This uses the templateAudioArray from the preset to create the audios for the specified trackIndex
 234 - (void) _processPresetAudioArray: (NSArray *) templateAudioArray forTrack: (unsigned int) trackIndex andType: (int) aType
 235
 236 {
 237         NSEnumerator *enumerator = [templateAudioArray objectEnumerator];
 238         NSDictionary *dict;
 239         NSString *key;
 240         int maximumNumberOfAllowedAudioTracks = [HBController maximumNumberOfAllowedAudioTracks];
 241
 242         while (nil != (dict = [enumerator nextObject])) {
 243                 if ([self countOfAudioArray] < maximumNumberOfAllowedAudioTracks) {
 244                         HBAudio *newAudio = [[HBAudio alloc] init];
 245                         [newAudio setController: self];
 246                         [self insertObject: newAudio inAudioArrayAtIndex: [self countOfAudioArray]];
 247                         [newAudio setVideoContainerTag: [self videoContainerTag]];
 248                         [newAudio setTrackFromIndex: trackIndex];
 249                         key = [dict objectForKey: @"AudioEncoder"];
 250                         if (0 == aType &&
 251                                 YES == [[NSUserDefaults standardUserDefaults] boolForKey: @"UseCoreAudio"] &&
 252                                 YES == [key isEqualToString: @"AAC (faac)"]
 253                                 ) {
 254                                 key = @"AAC (CoreAudio)";
 255                         }
 256                         //      If our preset wants us to support a codec that the track does not support, instead
 257                         //      of changing the codec we remove the audio instead.
 258                         if (YES == [newAudio setCodecFromName: key]) {
 259                                 [newAudio setMixdownFromName: [dict objectForKey: @"AudioMixdown"]];
 260                                 [newAudio setSampleRateFromName: [dict objectForKey: @"AudioSamplerate"]];
 261                                 [newAudio setBitRateFromName: [dict objectForKey: @"AudioBitrate"]];
 262                                 [newAudio setDrc: [dict objectForKey: @"AudioTrackDRCSlider"]];
 263                         }
 264                         else {
 265                                 [self removeObjectFromAudioArrayAtIndex: [self countOfAudioArray] - 1];
 266                         }
 267                         [newAudio release];
 268                 }
 269         }
 270         return;
 271 }
 272
 273 //      This matches the FIRST track with the specified prefix, otherwise it uses the defaultIfNotFound value
 274 - (unsigned int) _trackWithTitlePrefix: (NSString *) prefix defaultIfNotFound: (unsigned int) defaultIfNotFound
 275
 276 {
 277         unsigned int retval = defaultIfNotFound;
 278         int count = [masterTrackArray count];
 279         NSString *languageTitle;
 280         BOOL found = NO;
 281
 282         //      We search for the prefix noting that our titles have the format %d: %s where the %s is the prefix
 283         for (unsigned int i = 1; i < count && NO == found; i++) {       //      Note that we skip the "None" track
 284                 languageTitle = [[masterTrackArray objectAtIndex: i] objectForKey: keyAudioTrackName];
 285                 if (YES == [[languageTitle substringFromIndex: [languageTitle rangeOfString: @" "].location + 1] hasPrefix: prefix]) {
 286                         retval = i;
 287                         found = YES;
 288                 }
 289         }
 290         return retval;
 291 }
 292
 293 - (void) addTracksFromPreset: (NSMutableDictionary *) aPreset allTracks: (BOOL) allTracks
 294
 295 {
 296         id whatToUse = [self _presetAudioArrayFromPreset: aPreset];
 297         NSString *preferredLanguageName = [[NSUserDefaults standardUserDefaults] stringForKey: @"DefaultLanguage"];
 298         int preferredLanguage = [self _trackWithTitlePrefix: preferredLanguageName defaultIfNotFound: 1];
 299
 300         //      Reinitialize the configured list of audio tracks
 301         [self _clearAudioArray];
 302
 303         [self _processPresetAudioArray: whatToUse forTrack: preferredLanguage andType: [[aPreset objectForKey: @"Type"] intValue]];
 304         if (YES == allTracks) {
 305                 unsigned int count = [masterTrackArray count];
 306                 for (unsigned int i = 1; i < count; i++) {
 307                         if (i != preferredLanguage) {
 308                                 [self _processPresetAudioArray: whatToUse forTrack: i andType: [[aPreset objectForKey: @"Type"] intValue]];
 309                         }
 310                 }
 311         }
 312
 313         [self switchingTrackFromNone: nil];     // see if we need to add one to the list
 314
 315         return;
 316 }
 317
 318 - (void) addTracksFromPreset: (NSMutableDictionary *) aPreset
 319
 320 {
 321         [self addTracksFromPreset: aPreset allTracks: NO];
 322         return;
 323 }
 324
 325 - (void) addAllTracksFromPreset: (NSMutableDictionary *) aPreset
 326
 327 {
 328         [self addTracksFromPreset: aPreset allTracks: YES];
 329         return;
 330 }
 331
 332 - (BOOL) anyCodecMatches: (int) aCodecValue
 333
 334 {
 335         BOOL retval = NO;
 336         unsigned int audioArrayCount = [self countOfAudioArray];
 337         for (unsigned int i = 0; i < audioArrayCount && NO == retval; i++) {
 338                 HBAudio *anAudio = [self objectInAudioArrayAtIndex: i];
 339         if (YES == [anAudio enabled] && aCodecValue == [[[anAudio codec] objectForKey: keyAudioCodec] intValue]) {
 340                         retval = YES;
 341                 }
 342         }
 343         return retval;
 344 }
 345
 346 - (void) addNewAudioTrack
 347
 348 {
 349         HBAudio *newAudio = [[HBAudio alloc] init];
 350         [newAudio setController: self];
 351         [self insertObject: newAudio inAudioArrayAtIndex: [self countOfAudioArray]];
 352         [newAudio setVideoContainerTag: [self videoContainerTag]];
 353         [newAudio setTrack: noneTrack];
 354         [newAudio setDrc: [NSNumber numberWithFloat: 0.0]];
 355         [newAudio release];
 356         return;
 357 }
 358
 359 #pragma mark -
 360 #pragma mark Notification Handling
 361
 362 - (void) settingTrackToNone: (HBAudio *) newNoneTrack
 363
 364 {
 365         //      If this is not the last track in the array we need to remove it.  We then need to see if a new
 366         //      one needs to be added (in the case when we were at maximum count and this switching makes it
 367         //      so we are no longer at maximum.
 368         unsigned int index = [audioArray indexOfObject: newNoneTrack];
 369
 370         if (NSNotFound != index && index < [self countOfAudioArray] - 1) {
 371                 [self removeObjectFromAudioArrayAtIndex: index];
 372         }
 373         [self switchingTrackFromNone: nil];     // see if we need to add one to the list
 374         return;
 375 }
 376
 377 - (void) switchingTrackFromNone: (HBAudio *) noLongerNoneTrack
 378
 379 {
 380         int count = [self countOfAudioArray];
 381         BOOL needToAdd = NO;
 382         int maximumNumberOfAllowedAudioTracks = [HBController maximumNumberOfAllowedAudioTracks];
 383
 384         //      If there is no last track that is None and we are less than our maximum number of permitted tracks, we add one.
 385         if (count < maximumNumberOfAllowedAudioTracks) {
 386                 if (0 < count) {
 387                         HBAudio *lastAudio = [self objectInAudioArrayAtIndex: count - 1];
 388                         if (YES == [lastAudio enabled]) {
 389                                 needToAdd = YES;
 390                         }
 391                 }
 392                 else {
 393                         needToAdd = YES;
 394                 }
 395         }
 396
 397         if (YES == needToAdd) {
 398                 [self addNewAudioTrack];
 399         }
 400         return;
 401 }
 402
 403 //      This gets called whenever the video container changes.
 404 - (void) containerChanged: (NSNotification *) aNotification
 405
 406 {
 407         NSDictionary *notDict = [aNotification userInfo];
 408
 409         [self setVideoContainerTag: [notDict objectForKey: keyContainerTag]];
 410
 411         //      Update each of the instances because this value influences possible settings.
 412         NSEnumerator *enumerator = [audioArray objectEnumerator];
 413         HBAudio *audioObject;
 414
 415         while (nil != (audioObject = [enumerator nextObject])) {
 416                 [audioObject setVideoContainerTag: [self videoContainerTag]];
 417         }
 418         return;
 419 }
 420
 421 - (void) titleChanged: (NSNotification *) aNotification
 422
 423 {
 424         NSDictionary *notDict = [aNotification userInfo];
 425         NSData *theData = [notDict objectForKey: keyTitleTag];
 426         hb_title_t *title = NULL;
 427
 428         [theData getBytes: &title length: sizeof(title)];
 429         if (title) {
 430                 hb_audio_config_t *audio;
 431                 hb_list_t *list = title->list_audio;
 432                 int i, count = hb_list_count(list);
 433
 434                 //      Reinitialize the master list of available audio tracks from this title
 435                 [masterTrackArray release];
 436                 masterTrackArray = [[NSMutableArray alloc] init];
 437                 [noneTrack release];
 438                 noneTrack = [[NSDictionary dictionaryWithObjectsAndKeys:
 439                                          [NSNumber numberWithInt: 0], keyAudioTrackIndex,
 440                                          NSLocalizedString(@"None", @"None"), keyAudioTrackName,
 441                                          [NSNumber numberWithInt: 0], keyAudioInputCodec,
 442                                                          nil] retain];
 443                 [masterTrackArray addObject: noneTrack];
 444                 for (i = 0; i < count; i++) {
 445                         audio = (hb_audio_config_t *) hb_list_audio_config_item(list, i);
 446                         [masterTrackArray addObject: [NSDictionary dictionaryWithObjectsAndKeys:
 447                                                                                   [NSNumber numberWithInt: i + 1], keyAudioTrackIndex,
 448                                                                                   [NSString stringWithFormat: @"%d: %s", i, audio->lang.description], keyAudioTrackName,
 449                                                                                   [NSNumber numberWithInt: audio->in.bitrate / 1000], keyAudioInputBitrate,
 450                                                                                   [NSNumber numberWithInt: audio->in.samplerate], keyAudioInputSampleRate,
 451                                                                                   [NSNumber numberWithInt: audio->in.codec], keyAudioInputCodec,
 452                                                                                   [NSNumber numberWithInt: audio->in.channel_layout], keyAudioInputChannelLayout,
 453                                                                                   nil]];
 454                 }
 455         }
 456
 457         //      Reinitialize the configured list of audio tracks
 458         [self _clearAudioArray];
 459
 460         if (NO == [myController hasValidPresetSelected]) {
 461                 NSString *preferredLanguageName = [[NSUserDefaults standardUserDefaults] stringForKey: @"DefaultLanguage"];
 462                 int preferredLanguage = [self _trackWithTitlePrefix: preferredLanguageName defaultIfNotFound: 1];
 463                 [self addNewAudioTrack];
 464                 HBAudio *anAudio = [self objectInAudioArrayAtIndex: 0];
 465                 [anAudio setTrackFromIndex: preferredLanguage];
 466         }
 467         return;
 468 }
 469
 470 #pragma mark -
 471 #pragma mark KVC
 472
 473 - (unsigned int) countOfAudioArray
 474
 475 {
 476         return [audioArray count];
 477 }
 478
 479 - (HBAudio *) objectInAudioArrayAtIndex: (unsigned int) index
 480
 481 {
 482         return [audioArray objectAtIndex: index];
 483 }
 484
 485 - (void) insertObject: (HBAudio *) audioObject inAudioArrayAtIndex: (unsigned int) index;
 486
 487 {
 488         [audioArray insertObject: audioObject atIndex: index];
 489         return;
 490 }
 491
 492 - (void) removeObjectFromAudioArrayAtIndex: (unsigned int) index
 493
 494 {
 495         [audioArray removeObjectAtIndex: index];
 496         return;
 497 }
 498
 499 @end