prj/cam/src/sound/schprop.cpp

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 // $Header: r:/t2repos/thief2/src/sound/schprop.cpp,v 1.19 1999/04/24 15:47:56 Justin Exp $
   7
   8 #include <property.h>
   9 #include <propbase.h>
  10 #include <propface.h>
  11 #include <propert_.h>
  12 #include <dataops_.h>
  13 #include <prophash.h>
  14 #include <sdesc.h>
  15 #include <sdestype.h>
  16 #include <sdesbase.h>
  17
  18 #include <schbase.h>
  19 #include <schprop.h>
  20
  21 #include <tag.h>
  22 #include <tagbase.h>
  23
  24 // Must be last header
  25 #include <dbmem.h>
  26
  27 ////////////////////////////////
  28 // Schema play parameters property
  29
  30 // This listener is only being used to try to catch a particular
  31 // error, in which the base schema's volume is set to 0x10040.
  32 #ifndef SHIP
  33 static void LGAPI PlayParamsListener(sPropertyListenMsg * msg,
  34                                      PropListenerData data)
  35 {
  36    if (!msg->value.ptrval)
  37       return;
  38
  39    sSchemaPlayParams *pParams = (sSchemaPlayParams *) msg->value.ptrval;
  40
  41    // creation
  42    if (msg->type & kListenPropSet) {
  43       AssertMsg1(pParams->volume <= 0,
  44                  "Schema volume should be negative, but we have one at %d",
  45                  pParams->volume);
  46    }
  47 }
  48 #endif // ~SHIP
  49
  50 ISchemaPlayParamsProperty *g_schemaPlayParamsProperty;
  51
  52 static const char* flag_names[] =
  53 {
  54    "Retrigger",
  55    "Pan position",
  56    "Pan Range",
  57    "No Repeate",
  58    "No Cache",
  59    "Stream",
  60    "Play Once",
  61    "No Combat",
  62    "Net Ambient",
  63    "Local Spatial",
  64    "","",  // 6 unused bits
  65    "","","","",
  66    "Noise",
  67    "Speech",
  68    "Ambient",
  69    "Music",
  70    "MetaUI",
  71 };
  72
  73 #define NUM_FLAGS (sizeof(flag_names)/sizeof(flag_names[0]))
  74
  75 static sFieldDesc SchemaPlayParamsFields[] =
  76 {
  77    {"Flags", kFieldTypeBits, FieldLocation(sSchemaPlayParams, flags), kFieldFlagNone, 0, NUM_FLAGS, NUM_FLAGS, flag_names},
  78    {"Volume", kFieldTypeInt, FieldLocation(sSchemaPlayParams, volume),},
  79    {"Initial Delay", kFieldTypeShort, FieldLocation(sSchemaPlayParams, initialDelay),},
  80    {"Pan", kFieldTypeInt, FieldLocation(sSchemaPlayParams, pan),},
  81    {"Fade", kFieldTypeInt, FieldLocation(sSchemaPlayParams, fade),},
  82 };
  83
  84 static sStructDesc SchemaPlayParamsStructDesc =
  85    StructDescBuild(sSchemaPlayParams, kStructFlagNone, SchemaPlayParamsFields);
  86
  87 class cSchemaPlayOps : public cClassDataOps<sSchemaPlayParams>
  88 {
  89
  90 };
  91
  92 class cSchemaPlayStore: public cHashPropertyStore<cSchemaPlayOps>
  93 {
  94 };
  95
  96 class cSchemaPlayProp : public cSpecificProperty<ISchemaPlayParamsProperty,&IID_ISchemaPlayParamsProperty,sSchemaPlayParams*, cSchemaPlayStore>
  97 {
  98    typedef cSpecificProperty<ISchemaPlayParamsProperty,&IID_ISchemaPlayParamsProperty,sSchemaPlayParams*, cSchemaPlayStore> cParent;
  99
 100 public:
 101    cSchemaPlayProp(const sPropertyDesc* desc)
 102       : cParent(desc)
 103    {
 104    }
 105
 106    STANDARD_DESCRIBE_TYPE(sSchemaPlayParams);
 107
 108 };
 109
 110
 111 static sPropertyDesc schemaPlayParamsDesc =
 112 {
 113    PROP_SCHEMA_PLAY_PARAMS, 0, NULL, 0, 0, { "Schema", "Play Params" },
 114 };
 115
 116 void SchemaPlayParamsPropertyInit()
 117 {
 118    StructDescRegister(&SchemaPlayParamsStructDesc);
 119
 120    g_schemaPlayParamsProperty
 121       = new cSchemaPlayProp(&schemaPlayParamsDesc);
 122 #ifndef SHIP
 123    g_schemaPlayParamsProperty->Listen(kListenPropSet,
 124                                       PlayParamsListener, NULL);
 125 #endif // ~SHIP
 126 }
 127
 128 sSchemaPlayParams *SchemaPlayParamsGet(ObjID objID)
 129 {
 130    sSchemaPlayParams *pParams;
 131
 132    if (g_schemaPlayParamsProperty->Get(objID, &pParams))
 133       return pParams;
 134    return NULL;
 135 }
 136
 137 ////////////////////////////////
 138 // Schema loop parameters property
 139
 140 ISchemaLoopParamsProperty *g_schemaLoopParamsProperty;
 141
 142 static sFieldDesc SchemaLoopParamsFields[] =
 143 {
 144    {"Flags", kFieldTypeBits, FieldLocation(sSchemaLoopParams, flags),},
 145    {"Max Samples", kFieldTypeInt, FieldLocation(sSchemaLoopParams, maxSamples),},
 146    {"Interval Min", kFieldTypeInt, FieldLocation(sSchemaLoopParams, intervalMin),},
 147    {"Interval Max", kFieldTypeInt, FieldLocation(sSchemaLoopParams, intervalMax),},
 148 };
 149
 150 static sStructDesc SchemaLoopParamsStructDesc =
 151    StructDescBuild(sSchemaLoopParams, kStructFlagNone, SchemaLoopParamsFields);
 152
 153 class cSchLoopOps : public cClassDataOps<sSchemaLoopParams>
 154 {
 155 };
 156
 157 class cSchLoopStore : public cHashPropertyStore<cSchLoopOps>
 158 {
 159
 160 };
 161
 162 class cSchemaLoopProp : public cSpecificProperty<ISchemaLoopParamsProperty,&IID_ISchemaLoopParamsProperty, sSchemaLoopParams*, cSchLoopStore>
 163 {
 164    typedef cSpecificProperty<ISchemaLoopParamsProperty,&IID_ISchemaLoopParamsProperty, sSchemaLoopParams*, cSchLoopStore> cParent;
 165
 166 public:
 167    cSchemaLoopProp(const sPropertyDesc* desc)
 168       : cParent(desc)
 169    {
 170    };
 171
 172    STANDARD_DESCRIBE_TYPE(sSchemaLoopParams);
 173
 174 };
 175
 176 static sPropertyDesc schemaLoopParamsDesc =
 177 {
 178    PROP_SCHEMA_LOOP_PARAMS, 0, NULL, 0, 0, { "Schema", "Loop Params" },
 179 };
 180
 181 void SchemaLoopParamsPropertyInit()
 182 {
 183    StructDescRegister(&SchemaLoopParamsStructDesc);
 184
 185    g_schemaLoopParamsProperty = new cSchemaLoopProp(&schemaLoopParamsDesc);
 186 }
 187
 188 sSchemaLoopParams *SchemaLoopParamsGet(ObjID objID)
 189 {
 190    sSchemaLoopParams *pParams;
 191
 192    if (g_schemaLoopParamsProperty->Get(objID, &pParams))
 193       return pParams;
 194    return NULL;
 195 }
 196
 197 ////////////////////////////////
 198 // Schema priority property
 199 IIntProperty *g_pPropSchemaPriority;
 200
 201 static sPropertyDesc SchemaPriorityDesc =
 202 {
 203    PROP_SCHEMA_PRIORITY, 0, NULL, 0, 0, { "Schema", "Priority" },
 204 };
 205
 206 #define SCHEMA_PRIORITY_IMPL kPropertyImplDense
 207
 208 void SchemaPriorityPropertyInit(void)
 209 {
 210    g_pPropSchemaPriority = CreateIntProperty(&SchemaPriorityDesc, SCHEMA_PRIORITY_IMPL);
 211 }
 212
 213 int SchemaPriorityGet(ObjID objID)
 214 {
 215    int pri = SCH_PRIORITY_NORMAL;
 216    g_pPropSchemaPriority->Get(objID, &pri);
 217    return pri;
 218 }
 219
 220 ////////////////////////////////
 221 // Schema messages
 222
 223 ILabelProperty *g_pPropSchemaMessage;
 224
 225 static sPropertyDesc SchemaMessageDesc =
 226 {
 227    PROP_SCHEMA_MESSAGE, 0, NULL, 0, 0, { "Schema", "Message" },
 228 };
 229
 230 void SchemaMessagePropertyInit(void)
 231 {
 232    g_pPropSchemaMessage = CreateLabelProperty(&SchemaMessageDesc, kPropertyImplDense);
 233 }
 234
 235 // get voice
 236 Label *SchemaMessageGet(ObjID objID)
 237 {
 238    Label *pMessage;
 239
 240    if (g_pPropSchemaMessage->Get(objID, &pMessage))
 241       return pMessage;
 242    else
 243       return NULL;
 244 }
 245
 246 ////////////////////////////////
 247 // Schema "action" sounds
 248
 249 ILabelProperty *g_pPropSchemaActionSnd;
 250
 251 static sPropertyDesc SchemaActionSndDesc =
 252 {
 253    PROP_SCHEMA_ACTION_SND, 0, NULL, 0, 0, { "Schema", "Action" },
 254 };
 255
 256 void SchemaActionSndPropertyInit(void)
 257 {
 258    g_pPropSchemaActionSnd = CreateLabelProperty(&SchemaActionSndDesc, kPropertyImplDense);
 259 }
 260
 261 Label *SchemaActionSndGet(ObjID objID)
 262 {
 263    Label *pActionSnd;
 264
 265    if (g_pPropSchemaActionSnd->Get(objID, &pActionSnd))
 266       return pActionSnd;
 267    else
 268       return NULL;
 269 }
 270
 271 ////////////////////////////////
 272 // Schema attenuation factor
 273 IFloatProperty *g_pPropSchemaAttFac;
 274
 275 static sPropertyDesc SchemaAttenuationDesc =
 276 {
 277    PROP_SCHEMA_ATTFAC, 0, NULL, 0, 0, { "Schema", "Attenuation Factor" },
 278 };
 279
 280 #define SCHEMA_ATTFAC_IMPL kPropertyImplVerySparse
 281
 282 void SchemaAttFacPropertyInit(void)
 283 {
 284    g_pPropSchemaAttFac = CreateFloatProperty(&SchemaAttenuationDesc, SCHEMA_PRIORITY_IMPL);
 285 }
 286
 287 float SchemaAttFacGet(ObjID objID)
 288 {
 289    float fac = 1.0;
 290    g_pPropSchemaAttFac->Get(objID, &fac);
 291    return fac;
 292 }
 293
 294 // Schema LastSample property
 295 IIntProperty *g_pPropSchemaLastSample;
 296
 297 static sPropertyDesc SchemaLastSampleDesc =
 298 {
 299    PROP_SCHEMA_LAST_SAMPLE, kPropertyTransient,
 300    NULL, 0, 0, { "Schema", "Last Sample" },
 301    kPropertyChangeLocally,
 302 };
 303
 304 #define SCHEMA_LAST_SAMPLE_IMPL kPropertyImplDense
 305
 306 void SchemaLastSamplePropertyInit(void)
 307 {
 308    g_pPropSchemaLastSample = CreateIntProperty(&SchemaLastSampleDesc, SCHEMA_LAST_SAMPLE_IMPL);
 309 }
 310
 311 int SchemaLastSampleGet(ObjID objID)
 312 {
 313    int lastSample = -1;
 314    g_pPropSchemaLastSample->Get(objID, &lastSample);
 315    return lastSample;
 316 }
 317
 318 // Initialize all schema properties
 319 void SchemaPropsInit(void)
 320 {
 321    SchemaLoopParamsPropertyInit();
 322    SchemaPlayParamsPropertyInit();
 323    SchemaPriorityPropertyInit();
 324    SchemaMessagePropertyInit();
 325    SchemaActionSndPropertyInit();
 326    SchemaLastSamplePropertyInit();
 327    SchemaAttFacPropertyInit();
 328 }
 329
 330 void SchemaPropsTerm(void)
 331 {
 332    SafeRelease(g_pPropSchemaAttFac);
 333    SafeRelease(g_pPropSchemaLastSample);
 334    SafeRelease(g_schemaPlayParamsProperty);
 335    SafeRelease(g_schemaLoopParamsProperty);
 336    SafeRelease(g_pPropSchemaPriority);
 337    SafeRelease(g_pPropSchemaMessage);
 338    SafeRelease(g_pPropSchemaActionSnd);
 339 }