SndView.h

//
//  $Id: SndView.h 3449 2009-04-04 16:52:47Z leighsmith $
//
//  Description: Class defining an AppKit view of a Snd object.
//
//  Original Author: Stephen Brandon
//
//  Design substantially based on ideas from Sound Kit, Release 2.0, Copyright (c) 1988, 1989, 1990, NeXT, Inc.  All rights reserved.
//  Additions Copyright (c) 1999 Stephen Brandon and the University of Glasgow
//  Additions Copyright (c) 2001, The MusicKit Project.  All rights reserved.
//
//  Legal Statement Covering Additions by Stephen Brandon and the University of Glasgow:
//
//  This framework and all source code supplied with it, except where specified, are
//  Copyright Stephen Brandon and the University of Glasgow, 1999. You are free to use
//  the source code for any purpose, including commercial applications, as long as you
//  reproduce this notice on all such software.
//
//  Software production is complex and we cannot warrant that the Software will be
//  error free.  Further, we will not be liable to you if the Software is not fit
//  for the purpose for which you acquired it, or of satisfactory quality. 
//
//  WE SPECIFICALLY EXCLUDE TO THE FULLEST EXTENT PERMITTED BY THE COURTS ALL
//  WARRANTIES IMPLIED BY LAW INCLUDING (BUT NOT LIMITED TO) IMPLIED WARRANTIES
//  OF QUALITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF THIRD
//  PARTIES RIGHTS.
//
//  If a court finds that we are liable for death or personal injury caused by our
//  negligence our liability shall be unlimited.  
//
//  WE SHALL HAVE NO LIABILITY TO YOU FOR LOSS OF PROFITS, LOSS OF CONTRACTS, LOSS
//  OF DATA, LOSS OF GOODWILL, OR WORK STOPPAGE, WHICH MAY ARISE FROM YOUR POSSESSION
//  OR USE OF THE SOFTWARE OR ASSOCIATED DOCUMENTATION.  WE SHALL HAVE NO LIABILITY
//  IN RESPECT OF ANY USE OF THE SOFTWARE OR THE ASSOCIATED DOCUMENTATION WHERE SUCH
//  USE IS NOT IN COMPLIANCE WITH THE TERMS AND CONDITIONS OF THIS AGREEMENT.
//
// Legal Statement Covering Additions by The MusicKit Project:
//
//    Permission is granted to use and modify this code for commercial and
//    non-commercial purposes so long as the author attribution and copyright
//    messages remain intact and accompany all relevant code.
//

#ifndef __SNDVIEW_H__
#define __SNDVIEW_H__

#import <AppKit/AppKit.h>

#import "SndDisplayDataList.h"
#import "SndDisplayData.h"
#import "Snd.h"

enum SndViewStereoMode {
    SNDVIEW_LEFTONLY = 0,
    SNDVIEW_RIGHTONLY = 1,
    SNDVIEW_STEREOMODE = 256  /* (open the way for up to 8 channel sound) */
};

#define SND_SOUNDVIEW_MINMAX 0
#define SND_SOUNDVIEW_WAVE 1

// Legacy definitions
#define NX_SOUNDVIEW_MINMAX SND_SOUNDVIEW_MINMAX
#define NX_SOUNDVIEW_WAVE SND_SOUNDVIEW_WAVE

@interface SndView: NSView <NSCoding>
{
    Snd         *sound;
    Snd         *pasteboardSound;
    id          delegate;
    NSRange     selectedFrames;
    int         displayMode;
    NSColor     *backgroundColour;
    NSColor     *foregroundColour;
    NSColor     *selectionColour;
    float       reductionFactor;
    float       amplitudeZoom;

    struct {
        unsigned int  disabled:1;
        unsigned int  continuousSelectionUpdates:1;
        unsigned int  cursorOn:1;
        unsigned int  drawsCrosses:1;
        unsigned int  autoscale:1;
        unsigned int  bezeled:1;
        unsigned int  notEditable:1;
        unsigned int  notOptimizedForSpeed:1;
    } svFlags;
    
    NSTimer     *cursorFlashTimer;
    NSImage     *dragIcon;
    
    int         optThreshold;
    int         optSkip;
    float       peakFraction;

    int         stereoMode;

    int         defaultRecordFormat;
    int         defaultRecordChannelCount;
    double      defaultRecordSampleRate;
    float       defaultRecordSeconds;
    Snd *recordingSound;
    
    NSRect      cachedSelectionRect;
    NSRange     previousSelectedFrames;

    int         lastPasteCount;
    int         lastCopyCount;
    BOOL        notProvidedData;
    BOOL        noSelectionDraw;
    BOOL        firstDraw; // flag indicating lack of initialisation within drawRect:

    SndDisplayDataList *dataList;
    
@private
    float ampScaler;
    float amplitudeDisplayHeight;
    NSArray *validPasteboardSendTypes;
    NSArray *validPasteboardReturnTypes;
}

- hideCursor;

- showCursor;

- (BOOL) resignFirstResponder;

- (BOOL) becomeFirstResponder;

- (void) copy: (id) sender;

- (void) cut: (id) sender;

- (void) delete: (id) sender;

- (void) paste: (id) sender;

- (void) selectAll: (id) sender;

- delegate;

- didPlay: (id) sender duringPerformance: (SndPerformance *) performance;

- didRecord: (id) sender;

- (int) displayMode;

- (void) drawRect: (NSRect) rects;

- (void) getSelection: (unsigned int *) firstSample size: (unsigned int *) sampleCount;

- (void) setSelection: (int) firstSample size: (int) sampleCount;

- hadError: (id) sender;

- initWithFrame: (NSRect) frameRect;

- (BOOL) isAutoScale;

- (BOOL) isBezeled;

- (BOOL) isContinuousSelectionUpdates;

- (BOOL) isEditable;

- (BOOL) isEnabled;

- (BOOL) isOptimizedForSpeed;

- (BOOL) isPlayable;

- (BOOL) isEntireSoundVisible;

- (float) getDefaultRecordTime;
- (void) setDefaultRecordTime: (float) seconds;

- (void) selectionChanged;

- (void) mouseDown: (NSEvent *) theEvent;

- (void) pasteboard: (NSPasteboard *) thePasteboard provideDataForType: (NSString *) pboardType;

- (void) pause: (id) sender;

- (void) play: (id) sender;

- (void) resume: (id) sender;

- (void) record: (id) sender;

- (void) stop: (id) sender;

- (BOOL) readSelectionFromPasteboard: (NSPasteboard *) thePasteboard;

- (void) setAmplitudeZoom: (float) newAmplitudeZoom;

- (float) amplitudeZoom;

- (float) reductionFactor;

- (BOOL) setReductionFactor: (float) reductionFactor;

- (void) scaleTo: (float) scaleRatio;

- (void) scaleToFit;

- (void) resizeToFit;

- (void) resizeToFit: (BOOL) withAutoscaling;

- (void) resizeToScale: (float) scaleRatio;

- setAutoscale: (BOOL) aFlag;

- (void) setBezeled: (BOOL) aFlag;

- (void) setContinuousSelectionUpdates: (BOOL) aFlag;

- (void) setDelegate: (id) anObject;

- (void) setDisplayMode: (int) aMode;

- (void) setEditable: (BOOL) aFlag;

- (void) setEnabled: (BOOL) aFlag;

- (void) setOptimizedForSpeed: (BOOL) flag;

- (void) setSound: (Snd *) aSound;

- (Snd *) sound;

- (void) setFrameSize: (NSSize) newSize;

- (Snd *) soundBeingProcessed;

- (void) tellDelegate: (SEL) theMessage;

- (void) tellDelegate: (SEL) theMessage duringPerformance: (SndPerformance *) performance;

- validRequestorForSendType: (NSString *) sendType returnType: (NSString *) returnType;

- (void) willPlay: sender duringPerformance: (SndPerformance *) performance;

- (void) willRecord: (id) sender;

- (BOOL) writeSelectionToPasteboard: (NSPasteboard *) thePasteboard types: (NSArray *) pboardTypes;
- (BOOL) writeSelectionToPasteboardNoProvide: (NSPasteboard *) thePasteboard types: (NSArray *) pboardTypes;

- (id) initWithCoder: (NSCoder *) aDecoder;
- (void) encodeWithCoder: (NSCoder *) aCoder;


/*************************
 * these methods are unique to SndKit.
 *************************/

- (BOOL) invalidateCacheStartPixel: (int) start end: (int) end;
        /* if end == -1, invalidates to end of last cache*/
- (BOOL) invalidateCacheStartSample: (int) start end: (int) end;
        /* start and end are samples. Must be exact. */

- (void) invalidateCache;

- (void) setDrawsCrosses: (BOOL) aFlag;

- (BOOL) drawsCrosses;

/* see class description for explanation of optimisation thresholds and skips, and peak fractions */
- (void) setOptThreshold: (int) threshold;
- (int) getOptThreshold;
- (void) setOptSkip: (int) skip;
- (int) getOptSkip;
- (void) setPeakFraction: (float) fraction;
- (float) getPeakFraction;

- (BOOL) setStereoMode: (enum SndViewStereoMode) stereoMode;

- (enum SndViewStereoMode) getStereoMode;

- (void) setSelectionColor: (NSColor *) color;

- (NSColor *) selectionColor;

- (void) setBackgroundColor: (NSColor *) color;

- (NSColor *) backgroundColor;

- (void) setForegroundColor: (NSColor *) color;

- (NSColor *) foregroundColor;

- (void) setDragIcon: (NSImage *) newDragIcon;

- (NSImage *) dragIcon;

@end

#endif

---