PDFSlideController.m

//
//  PDFSlideController.m
//  PDFSlide
//
//  Created by David on 2009/05/16.
//  Copyright 2009 David Ellefsen. All rights reserved.
//
// This file is part of PDFSlide.
//
// PDFSlide is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// PDFSlide is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with PDFSlide.  If not, see <http://www.gnu.org/licenses/>.
//

#import "PDFSlideController.h"

//define the notifications
NSString * const ControllerSlideNumberNotification = @"ControllerSlideNumberChanged";
NSString * const ControllerSlideObjectNotification = @"ControllerSlideObjectChange";
NSString * const ControllerSlideStopNotification = @"ControllerSlideStop";

/* Globals for screen fades */
CGGammaValue redMin, redMax, redGamma, greenMin, greenMax, greenGamma,blueMin, blueMax, blueGamma;

@implementation PDFSlideController

- (void)dealloc {
	NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
	[nc removeObserver:self];
	[super dealloc];
}

/**
 * Will execute once the nib file has loaded
 */
- (void) awakeFromNib {
	//set the defaults
	NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
	NSMutableDictionary* appDefaults = [[NSMutableDictionary alloc] init];
	[appDefaults setObject:[NSNumber numberWithInt:10] forKey:@"PSPointerSize"];
	[appDefaults setObject:[NSNumber numberWithInt:0] forKey:@"PSPointerStyle"];
	[appDefaults setObject:[NSNumber numberWithInt:1] forKey:@"PSAnnotatePenSize"];
	[appDefaults setObject:[NSNumber numberWithInt:0] forKey:@"PSAnnotateTool"];
	[appDefaults setObject:[NSNumber numberWithBool:FALSE] forKey:@"PSAutoScreen"];
	[defaults registerDefaults:appDefaults];
	
	slides = nil;
	faded = NO;
	
	//center the controller
	[[self window] center];
	
	//listen for apple remote events
	remoteControl = [[AppleRemote alloc] initWithDelegate: self];
	[remoteControl startListening: self];
	
	//start the current time timer
	[currentTime startTimer:1];

	//populate the Displays pop-up
	[self detectDisplays:self];
	
	//TODO FOR TESTING ANNOTATIONS
	//[currentSlide setCanSendNotifications:YES];
	//[nextSlide setCanRecieveNotifications:YES];
}

#pragma mark Sheets

/**
 * Shows a sheet to display the "encrypted" dialog
 */
- (void) showEncryptedSheet {
	[pdfPassword setStringValue:@""];
	
	[NSApp beginSheet:PDFPasswordWindow
	   modalForWindow:[self window]
		modalDelegate:nil
	   didEndSelector:NULL
		  contextInfo:NULL];
}

/**
 * Closes the "encrypted" sheet
 */
- (IBAction) endEncryptedSheet:(id)sender {
	[slides decryptPDF:[pdfPassword stringValue]];
	[NSApp endSheet:PDFPasswordWindow];
	[PDFPasswordWindow orderOut:sender];
	
	//init the window - if the slides have been unlocked
	if (slides && ![slides isLocked])
		[self initiliseWindow];
}

#pragma mark Remote Control

/**
 * Handles any actions from the Apple Remote
 */
- (void) sendRemoteButtonEvent: (RemoteControlEventIdentifier) event 
                   pressedDown: (BOOL) pressedDown 
                 remoteControl: (RemoteControl*) remoteControl 
{
    NSLog(@"Button %d pressed down %d", event, pressedDown);
	
	if (!pressedDown) {
		//the button has been released
		switch (event) {
			case kRemoteButtonLeft:
				[self reverseSlides:self];
				break;
			case kRemoteButtonRight:
				[self advanceSlides:self];
				break;
			default:
				break;
		}
	} else {
		//the button is being held down
	}
}

#pragma mark Open Actions

- (BOOL)performOpenPDF:(NSString *)filename {
	//add the filename to the reciently opened menu
	// TODO: fix open recent
	//[[NSDocumentController sharedDocumentController] noteNewRecentDocumentURL:[NSURL fileURLWithPath:filename]];
	
	slides = [[PSSlide alloc] initWithURL:[NSURL fileURLWithPath:filename]];
	
	//display the window if needed
	[[self window] makeKeyAndOrderFront:self];
	
	//check to see if the PDF is encrypted
	if ([slides isEncrypted]) {
		//show the encrypted sheet - then perform the init
		[self showEncryptedSheet];
	} else {
		//init the window directly
		[self initiliseWindow];
	}
	
	return YES;
}

/*
 * Show the open dialog button to allow the user to select a PDF file to open
 */
- (IBAction)openDocument:(id)sender {
	NSLog(@"Open Document Clicked");
	
	//Show the NSOpenPanel to open a PDF Document
	NSOpenPanel *openPanel = [NSOpenPanel openPanel];
	NSArray *fileTypes = [NSArray arrayWithObject:@"pdf"];

	int result = 0;
	
	result = [openPanel runModalForDirectory:nil file:nil types:fileTypes];
	if (result == NSOKButton) {
		NSString *filename = [openPanel filename];
		
		[self performOpenPDF:filename];
	} 
}

/**
 * Open a document when the reciently opened document is chosen.
 */
// TODO: Fix Open Recent menu
/*
- (BOOL)application:(NSApplication *)theApplication openFile:(NSString *)filename {
	return [self performOpenPDF:filename];
}
 */

#pragma mark Window Actions

/**
 * Shows the About window
 */
- (IBAction)showAboutWindow:(id)sender {
	aboutWindow = [[PDFAboutController alloc] init];
	[aboutWindow showWindow:self];
}

/**
 * Show the Preferences window
 */
- (IBAction)showPreferencesWindow:(id)sender {
	[[self window] makeKeyWindow];	//make the controller the key window
	[[PDFPreferencesController sharedPrefsWindowController] showWindow:nil];
}

/**
 * End the display of the Annoated Sheet
 */
/*
- (void)endAnnotatedSheet:(NSWindow *)sheet returnCode:(int)returnCode contextInfo:(void *)contextInfo {
}
 */

/**
 * Show the Annotated window
 */
- (IBAction)showAnnotateWindow:(id)sender {
	if (!annotatedWindow)
		annotatedWindow = [[PDFAnnotatedController alloc] init];
	
	//[[self window] makeKeyWindow];
	NSWindow* awindow = [annotatedWindow window];	//load the window into memory
	[annotatedWindow setSlides:slides slideNumber:[currentSlide slideNumber]];
	[annotatedWindow redraw];
	
	//[NSApp runModalForWindow:awindow];
	//	[[annotatedWindow window] center];
	//	[[annotatedWindow window] makeKeyAndOrderFront:self];
	
	[NSApp beginSheet:awindow
	   modalForWindow:[self window]
		modalDelegate:self
	   didEndSelector:nil
		  contextInfo:NULL];
}

/*
 * Setup all the window components once a slide has been opened
 */
- (void) initiliseWindow {
	//check to see if the slide object exists
	if (slides) {
		
		//setup the level indicator
		[pageLevel setMaxValue:((double)[slides pageCount]+1)];
		[pageLevel setIntValue:1];
		
		//view the slide access to the slides object
		[currentSlide setSlide:slides];
		[currentSlide setSlideNumber:0];
		[nextSlide setSlide:slides];
		[nextSlide setSlideNumber:1];
		
		//redraw the slides
		[currentSlide setNeedsDisplay:YES];
		[nextSlide setNeedsDisplay:YES];
		
		//restart the counter
		//set the counter to zero and display
		[counterView setAsCounter:YES];
		[counterView setNeedsDisplay:YES];
		
		//if the display window is open then notify it of the new slides
		[self postSlideObjectChangeNotification];
		[self postSlideChangeNotification];
	}
}

/**
 * Detect the screens if they have changed
 */
- (IBAction)detectDisplays:(id)sender {
	//get the screen information in the display toolbar item
	NSArray *screens = [NSScreen screens];
	NSUserDefaults *sharedDefaults = [NSUserDefaults standardUserDefaults];
	
	[displayMenu removeAllItems];
	NSUInteger i, count = [screens count];
	NSMenu *popup = [displayMenu menu];
	for (i = 0; i < count; i++) {
		[popup addItemWithTitle:[NSString stringWithFormat:@"Screen %u",i]
						 action:nil 
				  keyEquivalent:@""];
	}
	
	//if PSAutoScreen option is set... set to screen 1 automatically
	BOOL autoScreen = [sharedDefaults boolForKey:@"PSAutoScreen"];
	if (autoScreen && count >= 2) {
		[displayMenu selectItemAtIndex:1];
	}
}

#pragma mark Notification Handlers

/*
 * Callback - handle a slide change notification
 */
- (void)handleSlideChange:(NSNotification *)note {
	NSLog(@"Nofity Controller: Display Change Notification Recieved");
	NSNumber *slideNum = [[note userInfo] objectForKey:@"SlideNumber"];
	
	//display the slide
	[self displaySlide:[slideNum intValue]];
}

/*
 * Callback - handle a key press notification
 */
- (void)handleKeyPress:(NSNotification *)note {
	NSLog(@"Nofity Controller: Display key pressed");
	[self manageKeyDown:[[[note userInfo] objectForKey:@"KeyCode"] intValue]];
}


/*
 * Post a notification that the slide object has changed
 */
- (void)postSlideObjectChangeNotification {
	//nofity the display that the slide obj has changed
	if (pdfDisplay) {
		NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
		NSLog(@"Notify Controller: Slide Object Changed");
		
		NSDictionary *d = [NSDictionary dictionaryWithObject:slides
													  forKey:@"SlideObject"];
		
		[nc postNotificationName:ControllerSlideObjectNotification
						  object:self
						userInfo:d];
	}
}


/*
 * Post a notification informating objservers that the slide has changed.
 */
- (void)postSlideChangeNotification {
	//Send a notification to the main window that the slide has changed
	if (pdfDisplay) {
		NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
		NSLog(@"Notify Controller: Slide Changed");
		
		NSDictionary *d = [NSDictionary dictionaryWithObject:[NSNumber numberWithInt:[currentSlide slideNumber]] 
													  forKey:@"SlideNumber"];
		
		[nc postNotificationName:ControllerSlideNumberNotification
						  object:self
						userInfo:d];	
	}
}

/*
 * Post a notification informating objservers that the slide has changed.
 */
- (void)postSlideStopNotification {
	//Send a notification to the main window that the slide has changed
	if (pdfDisplay) {
		NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
		NSLog(@"Notify Controller: Slide Stopped");
		
		[nc postNotificationName:ControllerSlideStopNotification
						  object:self
						userInfo:nil];	
	}
}

#pragma mark Slide Setup and Navigation

/**
 * Tell the screen to fade to black
 */
- (void)fadeOut {
	const double kMyFadeTime = 1.0; /* fade time in seconds */
	const int kMyFadeSteps = 100;
	const double kMyFadeInterval = (kMyFadeTime / (double) kMyFadeSteps);
	const useconds_t kMySleepTime = (1000000 * kMyFadeInterval); /* delay in microseconds */
	
	int step;
	double fade;
	CGDisplayErr err;
	NSUInteger displayScreen = [displayMenu indexOfSelectedItem];
	
	err = CGGetDisplayTransferByFormula (displayScreen,
										 &redMin, &redMax, &redGamma,
										 &greenMin, &greenMax, &greenGamma,
										 &blueMin, &blueMax, &blueGamma);
	
	for (step = 0; step < kMyFadeSteps; ++step) {
		fade = 1.0 - (step * kMyFadeInterval);
		err = CGSetDisplayTransferByFormula (displayScreen,
											 redMin, fade*redMax, redGamma,
											 greenMin, fade*greenMax, greenGamma,
											 blueMin, fade*blueMax, blueGamma);
		usleep (kMySleepTime);
	}
	
	err = CGDisplayCapture ([displayMenu indexOfSelectedItem]);
	faded = YES;
}

/**
 * Tell the screen to fade to normal
 */
- (void)fadeIn {
	//These fades are ugly and hacky... but they are from the apple docs
	// the fade-in effect "flickers" as the coloursync profile is restored
	// but it works quite nicely
	const double kMyFadeTime = 1.0; /* fade time in seconds */
	const int kMyFadeSteps = 100;
	const double kMyFadeInterval = (kMyFadeTime / (double) kMyFadeSteps);
	const useconds_t kMySleepTime = (1000000 * kMyFadeInterval); /* delay in microseconds */
	
	int step;
	double fade;
	CGDisplayErr err;
	NSUInteger displayScreen = [displayMenu indexOfSelectedItem];
	
	for (step = 0; step < kMyFadeSteps; ++step) {
		fade = (step * kMyFadeInterval);
		err = CGSetDisplayTransferByFormula (displayScreen,
											 redMin, fade*redMax, redGamma,
											 greenMin, fade*greenMax, greenGamma,
											 blueMin, fade*blueMax, blueGamma);
		usleep (kMySleepTime);
	}
	CGDisplayRestoreColorSyncSettings(); 
	faded=NO;
}

/*
 * Play the slide show in the primary or secondary screen
 */
- (IBAction)playSlides:(id)sender {
	//do nothing if the pdfdisplay is already loaded
	//show the display window
	if (!pdfDisplay && slides!=nil) {
		//get the selected display window
		[self fadeOut];	//fade out the correct screen
		pdfDisplay = [[PDFDisplayController alloc] initWithSlidesScreenPos:slides
																	screen:[displayMenu indexOfSelectedItem]
																	   pos:[currentSlide slideNumber]];
	} else {
		return; 
	}
	
	//register as an observer to listen for notifications
	NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
	[nc addObserver:self
		   selector:@selector(handleKeyPress:)
			   name:PDFViewKeyPressNotification
			 object:nil];
	NSLog(@"Nofity Controller: Key Press PDFDisplay Notification Observer Registered");
	
	//Load the window - but do not show it
	[pdfDisplay window];
	
	//display the current slide
	[self postSlideChangeNotification];
	[self fadeIn];	//fade in the correct screen
}

/**
 * Stop the slide show and kill the slideshow windoe
 */
- (IBAction)stopSlides:(id)sender {
	//close the display, it is exists, and set to nil
	if (pdfDisplay) {
		[self fadeOut]; //fade out the correct screen
		[self postSlideStopNotification];
		[pdfDisplay close];
		pdfDisplay = nil;	//gc will clean up!
		[self fadeIn];	//fade in the correct screen
		
		//stop the counter
		[counterView stopTimer];
		
		//unregister the notification observer
		NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
		[nc removeObserver:self
					  name:PDFViewKeyPressNotification
					object:nil];
		
		//hint for the garbage collector to run
		NSGarbageCollector *gc = [NSGarbageCollector defaultCollector];
		[gc collectIfNeeded];
	}
}

/*
 * Display a specific slide number
 */
- (void)displaySlide:(NSUInteger)slideNum {
	[currentSlide setSlideNumber:slideNum];
	[nextSlide setSlideNumber:([currentSlide slideNumber]+1)];
	
	//set the level indicator
	if ([pageLevel intValue] < [pageLevel maxValue])
		[pageLevel setIntValue:(slideNum+1)];
	
	//redraw the views
	[currentSlide setNeedsDisplay:YES];
	[nextSlide setNeedsDisplay:YES];
}

/*
 * Move to the next slide
 */
- (IBAction)advanceSlides:(id)sender {
	[currentSlide incrSlide:self];
	[nextSlide setSlideNumber:([currentSlide slideNumber]+1)];
	
	//move the level indicator
	if ([pageLevel intValue] < [pageLevel maxValue])
		[pageLevel setIntValue:[pageLevel intValue]+1];
	
	//redraw the views
	[currentSlide setNeedsDisplay:YES];
	[nextSlide setNeedsDisplay:YES];
	
	//start the counter if needed
	if (![counterView isCounting] && pdfDisplay)
		[counterView startTimer:1];
	
	[self postSlideChangeNotification];
}

/*
 * Move back to the previous slide
 */
- (IBAction)reverseSlides:(id)sender {
	[currentSlide decrSlide:self];
	[nextSlide setSlideNumber:([currentSlide slideNumber]+1)];
	
	//move the level indicator
	if ([pageLevel intValue] > 1)
		[pageLevel setIntValue:[pageLevel intValue]-1];
	
	//redraw the views
	[currentSlide setNeedsDisplay:YES];
	[nextSlide setNeedsDisplay:YES];
	
	//start the counter if needed only if the display is active
	if (![counterView isCounting] && pdfDisplay)
		[counterView startTimer:1];
	
	[self postSlideChangeNotification];
}

#pragma mark Keyboard Handlers

/*
 * Manage the keydown event.
 */
- (void)manageKeyDown:(NSUInteger)keycode {
	//are we faded out - if so fade in
	if (pdfDisplay && faded && keycode!=11)
		[self fadeIn];
	
	switch (keycode) {
		case 125:   /* DOWN ARROW */
		case 123:	/* LEFT ARROW */
			NSLog(@"Keydown Event - Left/Down Arrow");
			[self reverseSlides:self];
			break;
		case 126:	/*UP ARROW*/
		case 124:	/*RIGHT ARROW*/
			NSLog(@"Keydown Event - Right/Up Arrow");
			[self advanceSlides:self];
			break;
		case 12:	/* Q KEY */
			[self stopSlides:self];
			break;
		case 11:	/* B KEY */
			if (pdfDisplay)
				if (!faded)
					[self fadeOut];
				else
					[self fadeIn];
			
			break;
			
		default:
			NSLog(@"Keydown Event - %d", keycode);
			break;
	}
}

/*
 *	Handle the keydown events on the main window
 */
- (void)keyDown:(NSEvent *)theEvent {
	unsigned int keycode = [theEvent keyCode];
	[self manageKeyDown:keycode];
}

#pragma mark Control Handlers

/**
 * Handle the "return" key press on the encrypted sheet
 */
- (void)controlTextDidEndEditing:(NSNotification *)note {
	[self endEncryptedSheet:self];
}

@end