Microsoft-3D-Movie-Maker/INC/BROWSER.H
2022-05-03 16:31:19 -07:00

760 lines
18 KiB
C++

/* Copyright (c) Microsoft Corporation.
Licensed under the MIT License. */
/**************************************************************
Browser Class
Author : *****
Review Status: Reviewed
Studio Independent Browsers:
BASE --> CMH --> GOK --> BRWD (Browser display class)
BRWD --> BRWL (Browser list class; chunky based)
BRWD --> BRWT (Browser text class)
BRWD --> BRWL --> BRWN (Browser named list class)
Studio Dependent Browsers:
BRWD --> BRWR (Roll call class)
BRWD --> BRWT --> BRWA (Browser action class)
BRWD --> BRWL --> BRWP (Browser prop/actor class)
BRWD --> BRWL --> BRWB (Browser background class)
BRWD --> BRWL --> BRWC (Browser camera class)
BRWD --> BRWL --> BRWN --> BRWM (Browser music class)
BRWD --> BRWL --> BRWN --> BRWM --> BRWI (Browser import sound class)
Note: An "frm" refers to the displayed frames on any page.
A "thum" is a generic Browser Thumbnail, which may be a
chid, cno, cnoPar, gob, stn, etc. A browser will display,
over multiple pages, as many browser entities as there are
thum's.
***************************************************************/
#ifndef BRWD_H
#define BRWD_H
const long kcmhlBrowser = 0x11000; // nice medium level for the Browser
const long kcbMaxCrm = 300000;
const long kdwTotalPhysLim = 10240000; // 10MB heuristic
const long kdwAvailPhysLim = 1024000; // 1MB heuristic
const kBrwsScript = (kstDefault << 16) | kchidBrowserDismiss;
/************************************
Browser Context CLass
Optional context to carry over
between successive instantiations
of the same browser
*************************************/
#define BRCN_PAR BASE
#define kclsBRCN 'BRCN'
typedef class BRCN *PBRCN;
class BRCN : public BRCN_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
BRCN(void) {};
public:
long brwdid;
long ithumPageFirst;
};
/************************************
Browser ThumbFile Cki Struct
*************************************/
struct TFC
{
short bo;
short osk;
union
{
struct
{
CTG ctg;
CNO cno;
};
struct
{
ulong grfontMask;
ulong grfont;
};
struct
{
CTG ctg;
CHID chid;
};
};
};
const BOM kbomTfc = 0x5f000000;
/************************************
Browser Display Class
*************************************/
#define BRWD_PAR GOK
#define kclsBRWD 'BRWD'
#define brwdidNil ivNil
typedef class BRWD *PBRWD;
class BRWD : public BRWD_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
CMD_MAP_DEC(BRWD)
protected:
long _kidFrmFirst; // kid of first frame
long _kidControlFirst; // kid of first control button
long _dxpFrmOffset; // x inset of thumb in frame
long _dypFrmOffset; // y inset of thumb in frame
long _sidDefault; // default sid
long _thumDefault; // default thum
PBRCN _pbrcn; // context carryover
long _idsFont; // string id of Font
long _kidThumOverride; // projects may override one thum gobid
long _ithumOverride; // projects may override one thum gobid
PTGOB _ptgobPage; // for page numbers
PSTDIO _pstdio;
// Display State variables
long _cthumCD; // Non-user content
long _ithumSelect; // Hilited frame
long _ithumPageFirst;// Index to thd of first frame on current page
long _cfrmPageCur; // Number of visible thumbnails per current page
long _cfrm; // Total frames possible per page
long _cthumScroll; // #items to scroll on fwd/back. default ivNil -> page scrolling
bool _fWrapScroll; // Wrap around. Default = fTrue;
bool _fNoRepositionSel; // Don't reposition selection : default = fFalse;
protected:
void _SetScrollState(void);
long _CfrmCalc(void);
static bool _FBuildGcb(GCB *pgcb, long kidPar, long kidBrws);
bool _FInitGok(PRCA prca, long kidGlass);
void _SetVarForOverride(void);
virtual long _Cthum(void) {AssertThis(0); return 0;}
virtual bool _FSetThumFrame(long ithum, PGOB pgobPar) {AssertThis(0); return fFalse;}
virtual bool _FClearHelp(long ifrm) { return fTrue;}
virtual void _ReleaseThumFrame(long ifrm) {}
virtual long _IthumFromThum(long thum, long sid) { return thum; }
virtual void _GetThumFromIthum(long ithum, void *pThumSelect, long *psid);
virtual void _ApplySelection(long thumSelect, long sid) {}
virtual void _ProcessSelection(void) {}
virtual bool _FUpdateLists() { return fTrue;}
virtual void _SetCbPcrmMin(void) {}
void _CalcIthumPageFirst(void);
bool _FIsIthumOverride(long ithum) { return FPure(ithum == _ithumOverride); }
PGOB _PgobFromIfrm(long ifrm);
long _KidThumFromIfrm(long ifrm);
void _UnhiliteCurFrm(void);
bool _FHiliteFrm(long ifrmSelect);
void _InitStateVars(PCMD pcmd, PSTDIO pstdio, bool fWrapScroll, long cthumScroll);
void _InitFromData(PCMD pcmd, long ithumSelect, long ithumDisplay);
virtual void _CacheContext(void);
public:
//
// Constructors and destructors
//
BRWD(PGCB pgcb) : BRWD_PAR(pgcb) { _ithumOverride = -1; _kidThumOverride = -1;}
~BRWD(void);
static PBRWD PbrwdNew(PRCA prca, long kidPar, long kidBrwd);
void Init(PCMD pcmd, long ithumSelect, long ithumDisplay, PSTDIO pstdio,
bool fWrapScroll = fTrue, long cthumScroll = ivNil);
bool FDraw(void);
bool FCreateAllTgob(void); // For any text based browsers
//
// Command Handlers
// Selection does not exit the browser
//
bool FCmdFwd(PCMD pcmd); // Page fwd
bool FCmdBack(PCMD pcmd); // Page back
bool FCmdSelect(PCMD pcmd);
bool FCmdSelectThum(PCMD pcmd); // Set viewing page
virtual void Release(void);
virtual bool FCmdCancel(PCMD pcmd); // See brwb
virtual bool FCmdDel(PCMD pcmd) { return fTrue; } // See brwm
virtual bool FCmdOk(PCMD pcmd);
virtual bool FCmdFile(PCMD pcmd) { return fTrue; } // See brwm
virtual bool FCmdChangeCel(PCMD pcmd) { return fTrue; } // See brwa
};
/************************************
Browser List Context CLass
Optional context to carry over
between successive instantiations
of the same browser
*************************************/
#define BRCNL_PAR BRCN
#define kclsBRCNL 'brcl'
typedef class BRCNL *PBRCNL;
class BRCNL : public BRCNL_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
~BRCNL(void);
public:
long cthumCD;
CKI ckiRoot;
PGL pglthd;
PGST pgst;
PCRM pcrm;
};
//
// Thumbnail descriptors : one per thumbnail
//
const long kglstnGrow = 5;
const long kglthdGrow= 10;
struct THD
{
union
{
TAG tag; // TAG pointing to content
struct
{
long lwFill1; // sid
long lwFill2; // pcrf
ulong grfontMask;
ulong grfont;
};
struct
{
long lwFill1;
long lwFill2;
CTG ctg;
CHID chid; // CHID of CD content
};
};
CNO cno; // GOKD cno
CHID chidThum; // GOKD's parent's CHID (relative to GOKD parent's parent)
long ithd; // Original index for this THD, before sorting (used to
// retrieve proper STN for the BRWN-derived browsers)
};
/* Browser Content List Base -- create one of these when you want a list of a
specific kind of content and you don't care about the names. */
#define BCL_PAR BASE
typedef class BCL *PBCL;
#define kclsBCL 'BCL'
class BCL : public BCL_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
CTG _ctgRoot;
CNO _cnoRoot;
CTG _ctgContent;
bool _fDescend;
PGL _pglthd;
protected:
BCL(void) { _pglthd = pvNil; }
~BCL(void) { ReleasePpo(&_pglthd); }
bool _FInit(PCRM pcrm, CKI *pckiRoot, CTG ctgContent, PGL pglthd);
bool _FAddGokdToThd(PCFL pcfl, long sid, CKI *pcki);
bool _FAddFileToThd(PCFL pcfl, long sid);
bool _FBuildThd(PCRM pcrm);
virtual bool _FAddGokdToThd(PCFL pcfl, long sid, KID *pkid);
public:
static PBCL PbclNew(PCRM pcrm, CKI *pckiRoot, CTG ctgContent,
PGL pglthd = pvNil, bool fOnlineOnly = fFalse);
PGL Pglthd(void) { return _pglthd; }
void GetThd(long ithd, THD *pthd) { _pglthd->Get(ithd, pthd); }
long IthdMac(void) { return _pglthd->IvMac(); }
};
/* Browser Content List with Strings -- create one of these when you need to
browse content by name */
#define BCLS_PAR BCL
typedef class BCLS *PBCLS;
#define kclsBCLS 'BCLS'
class BCLS : public BCLS_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
PGST _pgst;
protected:
BCLS(void) { _pgst = pvNil; }
~BCLS(void) { ReleasePpo(&_pgst); }
bool _FInit(PCRM pcrm, CKI *pckiRoot, CTG ctgContent, PGST pgst, PGL pglthd);
bool _FSetNameGst(PCFL pcfl, CTG ctg, CNO cno);
virtual bool _FAddGokdToThd(PCFL pcfl, long sid, KID *pkid);
public:
static PBCLS PbclsNew(PCRM pcrm, CKI *pckiRoot, CTG ctgContent,
PGL pglthd = pvNil, PGST pgst = pvNil, bool fOnlineOnly = fFalse);
PGST Pgst(void) { return _pgst; }
};
/************************************
Browser List Class
Derived from the Display Class
*************************************/
#define BRWL_PAR BRWD
#define kclsBRWL 'BRWL'
typedef class BRWL *PBRWL;
// Browser Selection Flags
// This specifies what the sorting is based on
enum BWS
{
kbwsIndex = 1,
kbwsChid = 2,
kbwsCnoRoot = 3, // defaults to CnoRoot if ctg of Par is ctgNil
kbwsLim
};
class BRWL : public BRWL_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
bool _fEnableAccel;
// Thumnail descriptor lists
PCRM _pcrm; // Chunky resource manager
PGL _pglthd; // Thumbnail descriptor gl
PGST _pgst; // Chunk name
// Browser Search (List) parameters
BWS _bws; // Selection type flag
bool _fSinglePar; // Single parent search
CKI _ckiRoot; // Grandparent cno=cnoNil => global search
CTG _ctgContent; // Parent
protected:
// BRWL List
bool _FInitNew(PCMD pcmd, BWS bws, long ThumSelect,
CKI ckiRoot, CTG ctgContent);
bool _FCreateBuildThd(CKI ckiRoot, CTG ctgContent, bool fBuildGl = fTrue);
virtual bool _FGetContent(PCRM pcrm, CKI *pcki, CTG ctg, bool fBuildGl);
virtual long _Cthum(void) { AssertThis(0); return _pglthd->IvMac(); }
virtual bool _FSetThumFrame(long ithd, PGOB pgobPar);
virtual bool _FUpdateLists() { return fTrue; } // Eg, to include user sounds
// BRWL util
void _SortThd(void);
virtual void _GetThumFromIthum(long ithum, void *pThumSelect, long *psid);
virtual void _ReleaseThumFrame(long ifrm);
virtual long _IthumFromThum(long thum, long sid);
virtual void _CacheContext(void);
virtual void _SetCbPcrmMin(void);
public:
//
// Constructors and destructors
//
BRWL(PGCB pgcb) : BRWL_PAR(pgcb) {}
~BRWL(void);
static PBRWL PbrwlNew(PRCA prca, long kidPar, long kidBrwl);
virtual bool FInit(PCMD pcmd, BWS bws, long ThumSelect, long sidSelect,
CKI ckiRoot, CTG ctgContent, PSTDIO pstdio, PBRCNL pbrcnl = pvNil,
bool fWrapScroll = fTrue, long cthumScroll = ivNil);
};
/************************************
Browser Text Class
Derived from the Display Class
*************************************/
#define BRWT_PAR BRWD
#define kclsBRWT 'BRWT'
typedef class BRWT *PBRWT;
class BRWT : public BRWT_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
PGST _pgst;
bool _fEnableAccel;
virtual long _Cthum(void) { AssertThis(0); return _pgst->IvMac(); }
virtual bool _FSetThumFrame(long istn, PGOB pgobPar);
virtual void _ReleaseThumFrame(long ifrm) {} // No gob to release
public:
//
// Constructors and destructors
//
BRWT(PGCB pgcb) : BRWT_PAR(pgcb) { _idsFont = idsNil; }
~BRWT(void);
static PBRWT PbrwtNew(PRCA prca, long kidPar, long kidBrwt);
void SetGst(PGST pgst);
bool FInit(PCMD pcmd, long thumSelect, long thumDisplay, PSTDIO pstdio,
bool fWrapScroll = fTrue, long cthumScroll = ivNil);
};
/************************************
Browser Named List Class
Derived from the Browser List Class
*************************************/
#define BRWN_PAR BRWL
#define kclsBRWN 'BRWN'
typedef class BRWN *PBRWN;
class BRWN : public BRWN_PAR
{
RTCLASS_DEC
protected:
virtual bool _FGetContent(PCRM pcrm, CKI *pcki, CTG ctg, bool fBuildGl);
virtual long _Cthum(void) { return _pglthd->IvMac(); }
virtual bool _FSetThumFrame(long ithd, PGOB pgobPar);
virtual void _ReleaseThumFrame(long ifrm);
public:
//
// Constructors and destructors
//
BRWN(PGCB pgcb) : BRWN_PAR(pgcb) {}
~BRWN(void) {};
virtual bool FInit(PCMD pcmd, BWS bws, long ThumSelect, long sidSelect,
CKI ckiRoot, CTG ctgContent, PSTDIO pstdio, PBRCNL pbrcnl = pvNil,
bool fWrapScroll = fTrue, long cthumScroll = ivNil);
virtual bool FCmdOk(PCMD pcmd);
};
/************************************
Studio Specific Browser Classes
*************************************/
/************************************
Browser Action Class
Derived from the Browser Text Class
Actions are separately classed for
previews
*************************************/
#define BRWA_PAR BRWT
#define kclsBRWA 'BRWA'
typedef class BRWA *PBRWA;
class BRWA : public BRWA_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
long _celnStart; // Starting cel number
PAPE _pape; // Actor Preview Entity
void _ProcessSelection(void); // Action Preview
virtual void _ApplySelection(long thumSelect, long sid);
public:
//
// Constructors and destructors
//
BRWA(PGCB pgcb) : BRWA_PAR(pgcb) { _idsFont = idsActionFont; _celnStart = 0;}
~BRWA(void) {}
static PBRWA PbrwaNew(PRCA prca);
bool FBuildApe(PACTR pactr);
bool FBuildGst(PSCEN pscen);
virtual bool FCmdChangeCel(PCMD pcmd);
};
/************************************
Browser Prop & Actor Class
Derived from the Browser List Class
*************************************/
#define BRWP_PAR BRWL
#define kclsBRWP 'BRWP'
typedef class BRWP *PBRWP;
class BRWP : public BRWP_PAR
{
RTCLASS_DEC
protected:
virtual void _ApplySelection(long thumSelect, long sid);
public:
//
// Constructors and destructors
//
BRWP(PGCB pgcb) : BRWP_PAR(pgcb) {}
~BRWP(void) {};
static PBRWP PbrwpNew(PRCA prca, long kidGlass);
};
/************************************
Browser Background Class
Derived from the Browser List Class
*************************************/
#define BRWB_PAR BRWL
#define kclsBRWB 'BRWB'
typedef class BRWB *PBRWB;
class BRWB : public BRWB_PAR
{
RTCLASS_DEC
protected:
virtual void _ApplySelection(long thumSelect, long sid);
public:
//
// Constructors and destructors
//
BRWB(PGCB pgcb) : BRWB_PAR(pgcb) {}
~BRWB(void) {};
static PBRWB PbrwbNew(PRCA prca);
virtual bool FCmdCancel(PCMD pcmd);
};
/************************************
Browser Camera Class
Derived from the Browser List Class
*************************************/
#define BRWC_PAR BRWL
#define kclsBRWC 'BRWC'
typedef class BRWC *PBRWC;
class BRWC : public BRWC_PAR
{
RTCLASS_DEC
protected:
virtual void _ApplySelection(long thumSelect, long sid);
virtual void _SetCbPcrmMin(void) {}
public:
//
// Constructors and destructors
//
BRWC(PGCB pgcb) : BRWC_PAR(pgcb) {}
~BRWC(void) {};
static PBRWC PbrwcNew(PRCA prca);
virtual bool FCmdCancel(PCMD pcmd);
};
/************************************
Browser Music Class (midi, speech & fx)
Derived from the Browser Named List Class
*************************************/
#define BRWM_PAR BRWN
#define kclsBRWM 'brwm'
typedef class BRWM *PBRWM;
class BRWM : public BRWM_PAR
{
RTCLASS_DEC
protected:
long _sty; // Identifies type of sound
PCRF _pcrf; // NOT created here (autosave or BRWI file)
virtual void _ApplySelection(long thumSelect, long sid);
virtual bool _FUpdateLists(); // By all entries in pcrf of correct type
void _ProcessSelection(void); // Sound Preview
bool _FAddThd(STN *pstn, CKI *pcki);
bool _FSndListed(CNO cno, long *pithd = pvNil);
public:
//
// Constructors and destructors
//
BRWM(PGCB pgcb) : BRWM_PAR(pgcb) { _idsFont = idsSoundFont; }
~BRWM(void) {};
static PBRWM PbrwmNew(PRCA prca, long kidGlass, long sty, PSTDIO pstdio);
virtual bool FCmdFile(PCMD pcmd); // Upon portfolio completion
virtual bool FCmdDel(PCMD pcmd); // Delete user sound
};
/************************************
Browser Import Sound Class
Derived from the Browser List Class
Note: Inherits pgst from the list class
*************************************/
#define BRWI_PAR BRWM
#define kclsBRWI 'BRWI'
typedef class BRWI *PBRWI;
class BRWI : public BRWI_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
// The following are already handled by BRWM
//virtual void _ProcessSelection(void);
virtual void _ApplySelection(long thumSelect, long sid);
public:
//
// Constructors and destructors
//
BRWI(PGCB pgcb) : BRWI_PAR(pgcb) { _idsFont = idsSoundFont; }
~BRWI(void);
static PBRWI PbrwiNew(PRCA prca, long kidGlass, long sty);
bool FInit(PCMD pcmd, CKI cki, PSTDIO pstdio);
};
/************************************
Browser Roll Call Class
Derived from the Display Class
*************************************/
#define BRWR_PAR BRWD
#define kclsBRWR 'BRWR'
typedef class BRWR *PBRWR;
class BRWR : public BRWR_PAR
{
RTCLASS_DEC
ASSERT
MARKMEM
protected:
CTG _ctg;
PCRM _pcrm; // Chunky resource manager
bool _fApplyingSel;
protected:
virtual long _Cthum(void);
virtual bool _FSetThumFrame(long istn, PGOB pgobPar);
virtual void _ReleaseThumFrame(long ifrm);
virtual void _ApplySelection(long thumSelect, long sid);
virtual void _ProcessSelection(void);
virtual bool _FClearHelp(long ifrm);
long _IaridFromIthum(long ithum, long iaridFirst = 0);
long _IthumFromArid(long arid);
public:
//
// Constructors and destructors
//
BRWR(PGCB pgcb) : BRWR_PAR(pgcb) { _fApplyingSel = fFalse; _idsFont = idsRollCallFont;}
~BRWR(void);
static PBRWR PbrwrNew(PRCA prca, long kid);
void Init(PCMD pcmd, long thumSelect, long thumDisplay, PSTDIO pstdio,
bool fWrapScroll = fTrue, long cthumScroll = ivNil);
bool FInit(PCMD pcmd, CTG ctg, long ithumDisplay, PSTDIO pstdio);
bool FUpdate(long arid, PSTDIO pstdio);
bool FApplyingSel(void) { AssertBaseThis(0); return _fApplyingSel; }
};
const long kglcmgGrow = 8;
struct CMG // Gokd Cno Map
{
CNO cnoTmpl; // Content cno
CNO cnoGokd; // Thumbnail gokd cno
};
/************************************
Fne for Thumbnails
Enumerates current product first
*************************************/
#define FNET_PAR BASE
#define kclsFNET 'FNET'
typedef class FNET *PFNET;
class FNET : public FNET_PAR
{
RTCLASS_DEC
protected:
bool _fInitMSKDir;
FNE _fne;
FNE _fneDir;
FNI _fniDirMSK;
FNI _fniDir;
FNI _fniDirProduct;
bool _fInited;
protected:
bool _FNextFni(FNI *pfni, long *psid);
public:
//
// Constructors and destructors
//
FNET(void) : FNET_PAR() {_fInited = fFalse;}
~FNET(void) {};
bool FInit(void);
bool FNext(FNI *pfni, long *psid = pvNil);
};
#endif