//////////

//

//  File:       QTUtilities.h

//

//  Contains:   Some utilities for working with QuickTime movies.

//              All utilities start with the prefix "QTUtils_".

//

/// Copyright:  © 1996-1999 by Apple Computer, Inc., all rights reserved.

//

//  Change History (most recent first):

//

//     <2>      02/03/99    rtm     moved non-QTVR-specific utilities from QTVRUtilities to here

//     <1>      09/10/97    rtm     first file

//     

//////////

/*

    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple Computer, 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 Computer, 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.

*/

#pragma once

//////////

//

// header files

//

//////////

#ifndef __QTUtilities__

#define __QTUtilities__

#ifndef __MOVIES__

#include <Movies.h>

#endif

#ifndef __MOVIESFORMAT__

#include <MoviesFormat.h>

#endif

#ifndef __MEDIAHANDLERS__

#include <MediaHandlers.h>

#endif

#ifndef __NUMBERFORMATTING__

#include <NumberFormatting.h>

#endif

#ifndef __QUICKTIMECOMPONENTS__

#include <QuickTimeComponents.h>

#endif

#ifndef __QUICKTIMEVR__

#include <QuickTimeVR.h>

#endif

//#ifndef __QTSMOVIE__

//#include <QTSMovie.h>

//#endif

#ifndef __ENDIAN__

#include <Endian.h>

#endif

#ifndef __GESTALT__

#include <Gestalt.h>

#endif

#ifndef __FIXMATH__

#include <FixMath.h>

#endif

#ifndef __MACWINDOWS__

#include <MacWindows.h>

#endif

#ifndef __PRINTING__

#include <Printing.h>

#endif

#ifndef __SCRIPT__

#include <Script.h>

#endif

#ifndef __SOUND__

#include <Sound.h>

#endif

#ifndef _STRING_H

#include <string.h>

#endif

#ifndef _STDLIB_H

#include <stdlib.h>

#endif

#ifndef __TEXTUTILS__

#include <TextUtils.h>

#endif

#ifndef __TRAPS__

#include <Traps.h>

#endif

//////////

//

// compiler flags

//

//////////

#define CONTENT_RATING_AVAIL        0           // is movie content-rating capability implemented?

//////////

//

// constants

//

//////////

// constants used for QTUtils_SaveMovie

#define kSavePrompt                 "Save Movie as:"

#define kSaveMovieFileName          "untitled.mov"

#define kSaveResName                "Movie Resource"

// constants used for QTUtils_PrintMoviePICT

enum eQTUPICTPrinting {

    kPrintFrame                     = 1, 

    kPrintPoster                    = 2

};

// constants used for QTUtils_GetMovieFileLoopingInfo

enum {

    kNormalLooping                  = 0, 

    kPalindromeLooping              = 1, 

    kNoLooping                      = 2

};

#define kQTVideoEffectsMinVers      0x0300      // version of QT that first supports QT video effects

#define kQTFullScreenMinVers        0x0209      // version of QT that first supports full-screen calls

#define kQTWiredSpritesMinVers      0x0300      // version of QT that first supports wired sprites

// constants for GetQuickTimePreference/SetQuickTimePreference settings

#define kConnectionSpeedPrefsType   FOUR_CHAR_CODE('cspd')

#define kContentRatingPrefsType     FOUR_CHAR_CODE('crat')

enum {

    kQTVRSpeakerButton      = mcFlagSuppressSpeakerButton,

    kQTVRBackButton         = mcFlagQTVRSuppressBackBtn,

    kQTVRZoomButtons        = mcFlagQTVRSuppressZoomBtns,

    kQTVRHotSpotButton      = mcFlagQTVRSuppressHotSpotBtn,

    kQTVRTranslateButton    = mcFlagQTVRSuppressTranslateBtn,

    kQTVRHelpText           = mcFlagQTVRSuppressHelpText,

    kQTVRHotSpotNames       = mcFlagQTVRSuppressHotSpotNames,

    kQTVRCustomButton       = mcFlagsUseCustomButton

};

//////////

//

// data types

//

//////////

#if CONTENT_RATING_AVAIL

// structure of content rating data for GetQuickTimePreference

struct ContentRatingPrefsRecord {

    UInt16                          fContentRating;

    UInt16                          fContentTypes;

};

typedef struct ContentRatingPrefsRecord ContentRatingPrefsRecord;

#endif

//////////

//

// function prototypes

//

//////////

Boolean                     QTUtils_TrapAvailable (short theTrapWord);

Boolean                     QTUtils_IsQuickTimeInstalled (void); 

Boolean                     QTUtils_IsQuickTimeCFMInstalled (void);

long                        QTUtils_GetQTVersion (void);

Boolean                     QTUtils_HasQuickTimeVideoEffects (void);

Boolean                     QTUtils_HasFullScreenSupport (void);

Boolean                     QTUtils_HasWiredSprites (void);

Boolean                     QTUtils_IsStreamedMovie (Movie theMovie);

Movie                       QTUtils_GetMovie (FSSpec *theFSSpec, short *theRefNum, short *theResID);

OSErr                       QTUtils_SaveMovie (Movie theMovie);

Boolean                     QTUtils_IsControllerBarVisible (MovieController theMC); 

short                       QTUtils_GetControllerBarHeight (MovieController theMC);

void                        QTUtils_HideControllerBar (MovieController theMC);

void                        QTUtils_ShowControllerBar (MovieController theMC);

void                        QTUtils_ToggleControllerBar (MovieController theMC);

void                        QTUtils_HideControllerButton (MovieController theMC, long theButton); 

void                        QTUtils_ShowControllerButton (MovieController theMC, long theButton); 

void                        QTUtils_ToggleControllerButton (MovieController theMC, long theButton);

void                        QTUtils_ResetControllerButton (MovieController theMC, long theButton);

Boolean                     QTUtils_IsControllerButtonVisible (MovieController theMC, long theButton);

Boolean                     QTUtils_IsMediaTypeInMovie (Movie theMovie, OSType theMediaType);

Boolean                     QTUtils_MovieHasTimeCodeTrack (Movie theMovie);

Boolean                     QTUtils_MovieHasSoundTrack (Movie theMovie);

MediaHandler                QTUtils_GetSoundMediaHandler (Movie theMovie);

OSErr                       QTUtils_PrintMoviePICT (Movie theMovie, short x, short y, long PICTUsed);

OSErr                       QTUtils_SelectAllMovie (MovieController mc);

ImageDescriptionHandle      QTUtils_MakeSampleDescription (long theEffectType, short theWidth, short theHeight);

OSErr                       QTUtils_GetContentRatingFromMovie (Movie theMovie, UInt16 *theRating, UInt32 *theReasons);

OSErr                       QTUtils_AddContentRatingToMovie (Movie theMovie, UInt16 theRating, UInt32 theReasons);

OSErr                       QTUtils_AddUserDataTextToMovie (Movie theMovie, char *theText, OSType theType);

OSErr                       QTUtils_AddCopyrightToMovie (Movie theMovie, char *theText);

OSErr                       QTUtils_AddMovieNameToMovie (Movie theMovie, char *theText);

OSErr                       QTUtils_AddMovieInfoToMovie (Movie theMovie, char *theText);

OSErr                       QTUtils_GetMovieFileLoopingInfo (Movie theMovie, long *theLoopInfo);

OSErr                       QTUtils_SetMovieFileLoopingInfo (Movie theMovie, long theLoopInfo);

OSErr                       QTUtils_SetLoopingStateFromFile (Movie theMovie, MovieController theMC);

OSErr                       QTUtils_MakeMovieLoop (Movie theMovie, Boolean isPalindrome);

char *                      QTUtils_GetTrackName (Track theTrack);

OSErr                       QTUtils_SetTrackName (Track theTrack, char *theText);

char *                      QTUtils_MakeTrackNameByType (Track theTrack);

Boolean                     QTUtils_IsImageFile (FSSpec *theFSSpec);

Boolean                     QTUtils_IsMovieFile (FSSpec *theFSSpec);

void                        QTUtils_ConvertFloatToBigEndian (float *theFloat);

StringPtr                   QTUtils_ConvertCToPascalString (char *theString);

char *                      QTUtils_ConvertPascalToCString (StringPtr theString);

OSErr                       QTUtils_DeleteAllReferencesToTrack (Track theTrack);

TimeValue                   QTUtils_GetFrameDuration (Track theTrack);

long                        QTUtils_GetFrameCount (Track theTrack);

void                        QTUtils_GetMaxWindowDepth (CWindowPtr theWindow, short *thePixelType, short *thePixelSize);

void                        QTUtils_GetMaxScreenDepth (Rect *theGlobalRect, short *thePixelType, short *thePixelSize);

long                        QTUtils_GetUsersConnectionSpeed (void);

OSErr                       QTUtils_SetUsersConnectionSpeed (long theSpeed);

OSErr                       QTUtils_GetUsersContentRating (UInt32 *theType, UInt16 *theRating);

OSType                      QTUtils_GetControllerType (Movie theMovie);

OSErr                       QTUtils_SetControllerType (Movie theMovie, OSType theType);

MovieController             QTUtils_ChangeControllerType (MovieController theMC, OSType theType, long theFlags);

#endif  // __QTUtilities__