SimpleAssetManagerSample/SAMWindowController.m
/* |
File: SAMWindowController.m |
Abstract: SimpleAssetManager document window controller class. |
Version: 1.0 |
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple |
Inc. ("Apple") in consideration of your agreement to the following |
terms, and your use, installation, modification or redistribution of |
this Apple software constitutes acceptance of these terms. If you do |
not agree with these terms, please do not use, install, modify or |
redistribute this Apple software. |
In consideration of your agreement to abide by the following terms, and |
subject to these terms, Apple grants you a personal, non-exclusive |
license, under Apple's copyrights in this original Apple software (the |
"Apple Software"), to use, reproduce, modify and redistribute the Apple |
Software, with or without modifications, in source and/or binary forms; |
provided that if you redistribute the Apple Software in its entirety and |
without modifications, you must retain this notice and the following |
text and disclaimers in all such redistributions of the Apple Software. |
Neither the name, trademarks, service marks or logos of Apple Inc. may |
be used to endorse or promote products derived from the Apple Software |
without specific prior written permission from Apple. Except as |
expressly stated in this notice, no other rights or licenses, express or |
implied, are granted by Apple herein, including but not limited to any |
patent rights that may be infringed by your derivative works or by other |
works in which the Apple Software may be incorporated. |
The Apple Software is provided by Apple on an "AS IS" basis. APPLE |
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION |
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS |
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND |
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. |
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL |
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, |
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED |
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), |
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE |
POSSIBILITY OF SUCH DAMAGE. |
Copyright (C) 2013 Apple Inc. All Rights Reserved. |
*/ |
#import "SAMWindowController.h" |
#import "SAMAsset.h" |
#import "SAMDocument.h" |
#import "MediaAssetHelperKeys.h" |
#import "FCPXMetadataKeys.h" |
@interface SAMWindowController () |
// UI elements on the document window |
@property (weak) IBOutlet NSOutlineView *outlineView; |
@property (weak) IBOutlet NSTextField *selectedAssetTitleField; |
@property (weak) IBOutlet NSTextField *selectedAssetMediaURLField; |
@property (weak) IBOutlet NSTextField *selectedAssetDescURLField; |
// the new asset sheet |
@property IBOutlet NSWindow *sheetForNewAsset; |
@property (weak) IBOutlet NSTextField *nameFieldForNewAsset; |
@property (weak) IBOutlet NSPopUpButton *locationTypePopupForNewAsset; |
@property (weak) IBOutlet NSTextField *locationFolderURLFieldForNewAsset; |
// metadata pane |
@property (weak) IBOutlet NSTextField *descriptionFieldForNewAsset; |
@property (weak) IBOutlet NSDatePicker *expirationDatePickerForNewAsset; |
@property (weak) IBOutlet NSTextField *shareIDFieldForNewAsset; |
@property (weak) IBOutlet NSTextField *episodeIDFieldForNewAsset; |
@property (weak) IBOutlet NSTextField *episodeNumberFieldForNewAsset; |
// data options pane |
@property (weak) IBOutlet NSPopUpButton *metadataSetPopupForNewAsset; |
@property (weak) IBOutlet NSButton *hasDecriptionCheckBoxForNewAsset; |
// the wait sheet |
@property (weak) IBOutlet NSWindow *FCPXWaitSheet; |
@property (weak) IBOutlet NSProgressIndicator *FCPXWaitIndicator; |
@end |
@implementation SAMWindowController |
{ |
BOOL askUserNewAssetPath; |
BOOL newAssetWantsDescription; |
} |
- (instancetype)init |
{ |
self = [super initWithWindowNibName:DOCUMENT_NIB_NAME]; |
if (self) { |
// add more initialization if any |
} |
return self; |
} |
- (instancetype)initWithWindow:(NSWindow *)window |
{ |
self = [super initWithWindow:window]; |
if (self) { |
// add more initialization if any |
} |
return self; |
} |
/* |
update user interface on load |
*/ |
- (void)windowDidLoad |
{ |
[self updateSelectionDetailFields]; |
} |
#pragma mark <<< Managing Text Fields >>> |
/* |
update the outline view |
*/ |
- (void)updateOutlineView:(id)sendor |
{ |
[self.outlineView reloadData]; |
[self.outlineView deselectAll:sendor]; |
} |
/* |
update the text fields that display details about the selected item |
*/ |
- (void)clearDetailFields |
{ |
// these should be localized, but use string constants here for clarity |
[self.selectedAssetTitleField setStringValue:@"No selection"]; |
[self.selectedAssetTitleField setSelectable:NO]; |
[self.selectedAssetMediaURLField setStringValue:@"No selection"]; |
[self.selectedAssetMediaURLField setSelectable:NO]; |
[self.selectedAssetDescURLField setStringValue:@"No selection"]; |
[self.selectedAssetDescURLField setSelectable:NO]; |
} |
- (void)setDetailFieldsWithName:(NSString*)name mediaURL:(NSURL*)mediaURL descURL:(NSURL*)descURL |
{ |
NSString* URLString = nil; |
[self.selectedAssetTitleField setStringValue:name]; |
[self.selectedAssetTitleField setEditable:YES]; |
if ( mediaURL != nil ) { |
URLString = [mediaURL absoluteString]; |
} |
else { |
URLString = @"No URL"; |
} |
[self.selectedAssetMediaURLField setStringValue:URLString]; |
[self.selectedAssetMediaURLField setEditable:YES]; |
if ( descURL != nil ) { |
URLString = [descURL absoluteString]; |
} |
else { |
URLString = @"No URL"; |
} |
[self.selectedAssetDescURLField setStringValue:URLString]; |
[self.selectedAssetDescURLField setEditable:YES]; |
} |
- (void)updateSelectionDetailFields |
{ |
NSInteger selectedRow = [self.outlineView selectedRow]; |
if (selectedRow == -1) |
{ |
[self clearDetailFields]; |
} |
else |
{ |
id selectedItem = [self.outlineView itemAtRow:selectedRow]; // [self.assets objectAtIndex:selectedRow]; |
if ( selectedItem != nil ) { |
if ( [selectedItem isMemberOfClass:[SAMAsset class]] ) { |
SAMAsset* selectedAsset = (SAMAsset*)selectedItem; |
[self setDetailFieldsWithName:[selectedAsset name] mediaURL:[selectedAsset mediaFile] descURL:[selectedAsset descFile]]; |
} |
} |
} |
} |
#pragma mark <<< New Asset >>> |
- (IBAction)newAsset:sender |
{ |
[self newAssetWithName:nil |
metadata:nil |
dataOptions:nil |
completionHandler:^(SAMAsset *newAsset) { |
if ( newAsset != nil ) { |
// update the UI |
[self updateOutlineView:nil]; |
[self updateSelectionDetailFields]; |
} |
}]; |
} |
- (void)newAssetWithName:(NSString*)assetName |
metadata:(NSDictionary*)assetMetadata |
dataOptions:(NSDictionary*)assetDataOptions |
completionHandler:(void (^)(SAMAsset* newAsset))handler |
{ |
if ( assetName ==nil ) |
assetName = @"Untitled"; |
// bring up the custom sheet |
[self invokeNewAssetSheetNamed:assetName |
metadata:assetMetadata |
dataOptions:assetDataOptions |
delegate:self |
didEndSelector:@selector(didEndSheet:returnCode:contextInfo:) |
contextInfo:(void*)CFBridgingRetain(handler)]; |
} |
#pragma mark <<< New Asset Sheet >>> |
- (void)invokeNewAssetSheetNamed:(NSString*)assetName |
metadata:(NSDictionary*)assetMetadata |
dataOptions:(NSDictionary*)assetDataOptions |
delegate:(id)modalDelegate |
didEndSelector:(SEL)didEndSelector contextInfo:(void*)contextInfo |
{ |
SAMDocument* document = [self document]; |
if ( !self.sheetForNewAsset ) { |
[[NSBundle mainBundle] loadNibNamed:@"SAMNewAssetSheet" owner:self topLevelObjects:NULL]; |
} |
[self.nameFieldForNewAsset setStringValue:assetName]; |
[self populateAssetLocation:document.defaultAssetLocation]; |
[self populateNewAssetMetadata:assetMetadata]; |
[self populateNewAssetDataOptions:assetDataOptions]; |
[self selectNewAssetFolder:nil]; |
[self updateNewAssetWantsDescription:nil]; |
NSWindow* docWindow = [self window]; |
[NSApp beginSheet: self.sheetForNewAsset |
modalForWindow: docWindow |
modalDelegate: modalDelegate |
didEndSelector: didEndSelector |
contextInfo: contextInfo]; |
} |
- (IBAction)finishNewAssetSheet:sender |
{ |
[NSApp endSheet:self.sheetForNewAsset returnCode:NSAlertDefaultReturn]; |
} |
- (IBAction)cancelNewAssetSheet:sender |
{ |
[NSApp endSheet:self.sheetForNewAsset returnCode:NSAlertAlternateReturn]; |
} |
- (void)didEndSheet:(NSWindow *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo |
{ |
SAMAsset* newAsset = nil; |
SAMDocument* document = [self document]; |
if ( returnCode == NSAlertDefaultReturn ) { |
NSDictionary *newAssetLocationInfo = [self collectAssetLocation]; |
NSUInteger assetIndex = [document addAssetAtLocation:newAssetLocationInfo |
content:NO |
metadata:[self collectNewAssetMetadata] |
dataOptions:[self collectNewAssetDataOptions]]; |
document.defaultAssetLocation = newAssetLocationInfo; |
newAsset = [document.assets objectAtIndex:assetIndex]; |
} |
[sheet orderOut:self]; |
// update UI |
[self updateOutlineView:nil]; |
[self updateSelectionDetailFields]; |
// invoke the user completion handler |
((void(^)(SAMAsset*))CFBridgingRelease(contextInfo))(newAsset); |
} |
- (IBAction)selectNewAssetFolder:sender |
{ |
NSInteger dirSelector = -1; |
switch ( [self.locationTypePopupForNewAsset indexOfSelectedItem] ) { |
case 0: dirSelector = NSMoviesDirectory; break; |
case 1: dirSelector = NSPicturesDirectory; break; |
case 2: dirSelector = NSDocumentDirectory; break; |
case 3: dirSelector = NSMusicDirectory; break; |
} |
if ( dirSelector == -1 ) { |
// bring up the open panel when invoked from UI |
// otherwise leave the chosen location alone |
if ( sender != nil ) { |
NSOpenPanel *openPanel = [NSOpenPanel openPanel]; |
[openPanel setAllowsMultipleSelection:NO]; |
[openPanel setCanChooseDirectories:YES]; |
[openPanel setCanChooseFiles:NO]; |
[openPanel beginSheetModalForWindow:self.sheetForNewAsset completionHandler:^(NSInteger result) { |
NSURL* folderURL = [[openPanel URLs] objectAtIndex:0]; |
[self.locationFolderURLFieldForNewAsset setStringValue:[folderURL absoluteString]]; |
}]; |
} |
} |
else { |
NSURL *folderURL = [[[NSFileManager defaultManager] URLForDirectory:dirSelector inDomain:NSUserDomainMask appropriateForURL:nil create:YES error:nil] URLByResolvingSymlinksInPath]; |
[self.locationFolderURLFieldForNewAsset setStringValue:[folderURL absoluteString]]; |
} |
} |
/* |
Asset location |
*/ |
- (NSDictionary*)collectAssetLocation |
{ |
return [NSDictionary dictionaryWithObjectsAndKeys: |
[NSURL URLWithString:[self.locationFolderURLFieldForNewAsset stringValue]], kMediaAssetLocationFolderKey, |
[self.nameFieldForNewAsset stringValue], kMediaAssetLocationBasenameKey, |
[NSNumber numberWithBool:YES], kMediaAssetLocationHasMediaKey, |
[NSNumber numberWithBool:self.newAssetWantsDescription], kMediaAssetLocationHasDescriptionKey, |
nil]; |
} |
- (void)populateAssetLocation:(NSDictionary*)locationInfo |
{ |
NSURL *folderURL = [locationInfo objectForKey:kMediaAssetLocationFolderKey]; |
NSNumber *wantsDescription = [locationInfo objectForKey:kMediaAssetLocationHasDescriptionKey]; |
if ( [self.locationTypePopupForNewAsset indexOfSelectedItem] == -1 ) { |
[self.locationFolderURLFieldForNewAsset setStringValue:[folderURL absoluteString]]; |
} |
if ( wantsDescription != NULL && [wantsDescription boolValue] ) { |
self.newAssetWantsDescription = YES; |
} |
} |
/* |
Metadata pane |
*/ |
- (NSDictionary*)collectNewAssetMetadata |
{ |
NSMutableDictionary* metadataset = [NSMutableDictionary dictionaryWithCapacity:0]; |
[metadataset setObject:[self.descriptionFieldForNewAsset stringValue] forKey:kFCPXMetadataKeyDescription]; |
[metadataset setObject:[self.expirationDatePickerForNewAsset dateValue] forKey:kSAMMetadataKeyExpirationDate]; |
[metadataset setObject:[self.shareIDFieldForNewAsset stringValue] forKey:kFCPXShareMetadataKeyShareID]; |
[metadataset setObject:[self.episodeIDFieldForNewAsset stringValue] forKey:kFCPXShareMetadataKeyEpisodeID]; |
[metadataset setObject:@([self.episodeNumberFieldForNewAsset integerValue]) forKey:kFCPXShareMetadataKeyEpisodeNumber]; |
[metadataset setObject:@"1" forKey:kSAMMetadataKeyPreparedAsset]; |
return [NSDictionary dictionaryWithDictionary:metadataset]; |
} |
- (void)populateNewAssetMetadata:(NSDictionary*)metadataset |
{ |
NSString *description = [metadataset objectForKey:kFCPXMetadataKeyDescription]; |
if ( description == nil ) |
description = @""; |
[self.descriptionFieldForNewAsset setStringValue:description]; |
NSDate *expiratinoDate = [metadataset objectForKey:kSAMMetadataKeyExpirationDate]; |
if ( expiratinoDate == nil ) |
expiratinoDate = [NSDate dateWithTimeIntervalSinceNow:0]; |
[self.expirationDatePickerForNewAsset setDateValue:expiratinoDate]; |
NSString* shareID = [metadataset objectForKey:kFCPXShareMetadataKeyShareID]; |
if ( shareID == nil ) |
shareID = @""; |
[self.shareIDFieldForNewAsset setStringValue:shareID]; |
NSString* episodeID = [metadataset objectForKey:kFCPXShareMetadataKeyEpisodeID]; |
if ( episodeID == nil ) |
episodeID = @""; |
[self.episodeIDFieldForNewAsset setStringValue:episodeID]; |
NSString *episodeNumber = [metadataset objectForKey:kFCPXShareMetadataKeyEpisodeNumber]; |
if ( episodeNumber == nil ) |
episodeNumber = @""; |
[self.episodeNumberFieldForNewAsset setStringValue:episodeNumber]; |
} |
/* |
Data options pane |
*/ |
- (NSDictionary*)collectNewAssetDataOptions |
{ |
NSMutableDictionary* dataOptions = [NSMutableDictionary dictionaryWithCapacity:0]; |
NSString* theMetadataSetName = [self.metadataSetPopupForNewAsset titleOfSelectedItem]; |
if ( theMetadataSetName != nil ) { |
[dataOptions setObject:theMetadataSetName forKey:kMediaAssetDataOptionMetadataSetKey]; |
} |
return [NSDictionary dictionaryWithDictionary:dataOptions]; |
} |
- (void)populateNewAssetDataOptions:(NSDictionary*)dataOptions |
{ |
NSArray* availableMetadataSets = [dataOptions objectForKey:kMediaAssetDataOptionAvailableMetadataSetsKey]; |
if ( availableMetadataSets != nil && [availableMetadataSets isKindOfClass:[NSArray class]] ) { |
[self.metadataSetPopupForNewAsset removeAllItems]; |
[self.metadataSetPopupForNewAsset addItemWithTitle:@"None"]; |
[self.metadataSetPopupForNewAsset addItemsWithTitles:availableMetadataSets]; |
} |
} |
- (BOOL)newAssetWantsDescription |
{ |
return newAssetWantsDescription; |
} |
- (void)setNewAssetWantsDescription:(BOOL)newValue |
{ |
newAssetWantsDescription = newValue; |
} |
- (IBAction)updateNewAssetWantsDescription:(id)sender |
{ |
[self setNewAssetWantsDescription:[self.hasDecriptionCheckBoxForNewAsset state]]; |
} |
#pragma mark <<< Add/Remove Assets >>> |
/* |
add a file as a new asset |
*/ |
- (IBAction)addAsset:sender |
{ |
SAMDocument* document = [self document]; |
// Bring up a open panel |
NSOpenPanel* openPanel = [NSOpenPanel openPanel]; |
[openPanel setAllowedFileTypes:[NSArray arrayWithObjects:AVFileTypeQuickTimeMovie, AVFileTypeMPEG4, AVFileTypeAppleM4V, AVFileTypeAIFF, AVFileTypeWAVE, AVFileTypeAppleM4A, @"aiff", nil]]; |
[openPanel setAllowsMultipleSelection:YES]; |
[openPanel setMessage:@"Choose asset media file to add"]; |
[openPanel beginSheetModalForWindow:[self window] completionHandler:^(NSInteger result){ |
if (result == NSOKButton) { |
NSArray *selectedURLs = [openPanel URLs]; |
for ( NSURL* theURL in selectedURLs ) { |
// create a new Asset and add it to the collection |
[document addURL:theURL content:YES metadata:nil dataOptions:nil]; |
} |
// update the UI |
[self updateOutlineView:sender]; |
[self updateSelectionDetailFields]; |
} |
}]; |
} |
/* |
remove asset |
*/ |
- (IBAction)removeSelectedAssets:sender |
{ |
SAMDocument* document = [self document]; |
// find which Assets are selected and remove them |
NSIndexSet *selectedRows = [self.outlineView selectedRowIndexes]; |
NSInteger currentIndex = [selectedRows lastIndex]; |
while (currentIndex != NSNotFound) { |
id selectedItem = [self.outlineView itemAtRow:currentIndex]; |
if ( selectedItem == nil ) |
continue; |
else if ( [selectedItem isMemberOfClass:[SAMAsset class]] ) { |
SAMAsset *asset = (SAMAsset*)selectedItem; |
[document removeAsset:asset]; |
} |
currentIndex = [selectedRows indexLessThanIndex: currentIndex]; |
} |
// update the UI |
[self updateOutlineView:sender]; |
[self updateSelectionDetailFields]; |
} |
#pragma mark <<< Debugging >>> |
#if DEBUG_SHEET_POSITION |
- (NSRect)window:(NSWindow *)window willPositionSheet:(NSWindow *)sheet usingRect:(NSRect)rect |
{ |
NSLog(@"Sheet rectangle: origin: %d, %d, size: %d, %d", (int)rect.origin.x, (int)rect.origin.y, (int)rect.size.width, (int)rect.size.height); |
return rect; |
} |
#endif |
@end |
Copyright © 2013 Apple Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2013-12-19