//---------------------------------------------------------------------------------

//

//  File: CIGLDenoiseView.m

//

// Abstract: Demonstrates how to denoise images using Core image denoise 

//           filters and OpenGL framebuffer objects.

//           

//  Disclaimer: IMPORTANT:  This Apple software is supplied to you by

//  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) 2009, 2011 Apple Inc., All rights reserved.

//

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#import "CIGLDenoiseView.h"

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Private - Enumerated Types

//---------------------------------------------------------------------------------

enum CIDenoiseFilterType

{

    kCIMedianFilter = 1,

    kCINRFilter

};

typedef enum CIDenoiseFilterType CIDenoiseFilterType;

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

//---------------------------------------------------------------------------------

@implementation CIGLDenoiseView

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Public - Designated Initializer

//---------------------------------------------------------------------------------

- (id)initWithFrame:(NSRect)frameRect

{

    self = [super initWithFrame:frameRect];

    if( self )

    {

        pathname = [[[NSBundle mainBundle] pathForResource:@"lena_noisy" 

                                                    ofType:@"png"] retain];

        if( pathname )

        {

            denoise = [[CIGLDenoiseFilter alloc] initDenoiseFilterFromFile:pathname

                                                                   context:[self context] 

                                                                    format:[self pixelFormat]];

            if( denoise )

            {

                [denoise update];

            } // if

            [self setRotating:NO];

            [self setNeedsDisplay:YES];

            [[NSNotificationCenter defaultCenter] addObserver:self

                                                     selector:@selector(denoiseViewWillTerminate:)

                                                         name:@"NSApplicationWillTerminateNotification"

                                                       object:NSApp];

        } // if

    } // if

    return( self );

} // initWithFrame

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Public - Deallocate

//---------------------------------------------------------------------------------

- (void) cleanUp

{

    // Default image pathname

    if( pathname )

    {

        [pathname release];

    } // if

    // Core Image denoise filter

    if( denoise )

    {

        [denoise release];

    } // if

    [super cleanUp];

} // cleanUp

//---------------------------------------------------------------------------------

- (void) dealloc

{

    [self cleanUp];

    [super dealloc];

} // dealloc

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Public - Drawing

//---------------------------------------------------------------------------------

//

// Render the scene

//

//---------------------------------------------------------------------------------

- (void)drawRect:(NSRect)theRect

{   

    // Set the currrent OpenGL context

    [self makeCurrentContext];

    // update the view port

    [self updateViewport];

    // Render using the resulting texture

    [denoise display];

    // Flush the OpenGL context asynchronously

    [self flushBuffer];

} // drawRect

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Public - Utilties

//---------------------------------------------------------------------------------

- (void) updateFilter:(NSImage *)theImage

{

    if( theImage ) 

    {

        // Load a new image

        [denoise updateWithData:[theImage TIFFRepresentation]];

    } // if

    else 

    {       

        if( pathname )

        {

            // Reload the default image

            [denoise updateFromFile:pathname];

        } // if

    } // else

    [self setNeedsDisplay:YES];

} // updateFilter

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Public - View Filters

//---------------------------------------------------------------------------------

//

// Based on selected denoise fiilter, we set the target to the selected filter.

//

//---------------------------------------------------------------------------------

- (void) setFilter:(const NSInteger)theFilter

{

    switch( theFilter )

    {

        case kCIMedianFilter:

            [denoise median];

            break;

        case kCINRFilter:

        default:

            [denoise noiseReduction];

            break;

    } // switch

    [self setNeedsDisplay:YES];

} // setFilter

//---------------------------------------------------------------------------------

- (void) setNoiseLevel:(const CGFloat)theNoiseLevel

{

    [denoise setNoiseLevel:theNoiseLevel];

    [self setNeedsDisplay:YES];

} // setNoiseLevel

//---------------------------------------------------------------------------------

- (void) setSharpness:(const CGFloat)theSharpness

{

    [denoise setSharpness:theSharpness];

    [self setNeedsDisplay:YES];

} // setSharpness

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Public - Saving Image

//---------------------------------------------------------------------------------

- (BOOL) imageSaveAs:(CFStringRef)theName

              UTType:(CFStringRef)theUTType

{

    BOOL success = [denoise readback];

    if( success )

    {

        success = [denoise saveAs:theName 

                           UTType:theUTType];

    } // if

    return( success );

} // imageSaveAs

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------

#pragma mark -

#pragma mark Notification

//---------------------------------------------------------------------------------

//

// It's important to clean up our rendering objects before we terminate -- 

// Cocoa will not specifically release everything on application termination, 

// so we explicitly call our clean up routine ourselves.

//

//---------------------------------------------------------------------------------

- (void) denoiseViewWillTerminate:(NSNotification *)notification

{

    [self cleanUp];

} // denoiseViewWillTerminate

//---------------------------------------------------------------------------------

@end

//---------------------------------------------------------------------------------

//---------------------------------------------------------------------------------