src/apps/cortex/addons/common/IParameterSet.h

   1 /*
   2  * Copyright (c) 1999-2000, Eric Moon.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions, and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. The name of the author may not be used to endorse or promote products
  17  *    derived from this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  27  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31
  32 // IParameterSet.h
  33 // * PURPOSE
  34 //   An abstract parameter-collection object.  Can be shared
  35 //   between a media node and one or more operations to simplify
  36 //   realtime parameter automation.
  37 //
  38 // * HISTORY
  39 //   e.moon             26aug99         Begun
  40
  41 #ifndef __IParameterSet_H__
  42 #define __IParameterSet_H__
  43
  44 #include <ParameterWeb.h>
  45 #include <SupportDefs.h>
  46
  47 class IParameterSet {
  48
  49 public:                                                                                 // *** EXTERNAL INTERFACE
  50         virtual ~IParameterSet(); //nyi
  51         IParameterSet(); //nyi
  52
  53         // set parameter if the operation is stopped, or queue
  54         // parameter-change if it's running.
  55         // B_BAD_INDEX: invalid parameter ID
  56         // B_NO_MEMORY: too little data
  57         status_t setValue(
  58                 int32                                                                           parameterID,
  59                 bigtime_t                                                               performanceTime,
  60                 const void*                                                     data,
  61                 size_t                                                                  size); //nyi
  62
  63         // fetch last-changed value for the given parameter
  64         // B_BAD_INDEX: invalid parameter ID
  65         // B_NO_MEMORY: data buffer too small
  66         status_t getValue(
  67                 int32                                                                           parameterID,
  68                 bigtime_t*                                                      lastChangeTime,
  69                 void*                                                                           data,
  70                 size_t*                                                                 ioSize); //nyi
  71
  72 public:                                                                                 // *** INTERNAL INTERFACE (HOOKS)
  73
  74         // write to and from this object (translating parameter ID to
  75         // member variable(s))
  76
  77         virtual status_t store(
  78                 int32                                                                           parameterID,
  79                 const void*                                                     data,
  80                 size_t                                                                  size) =0;
  81
  82         virtual status_t retrieve(
  83                 int32                                                                           parameterID,
  84                 void*                                                                           data,
  85                 size_t*                                                                 ioSize) =0;
  86
  87         // implement this hook to return a BParameterGroup representing
  88         // the parameters represented by this set
  89
  90         virtual void populateGroup(
  91                 BParameterGroup*                                group) =0;
  92
  93 private:                                                                                // *** IMPLEMENTATION
  94
  95         // map of parameter ID -> change time +++++
  96 };
  97
  98 #endif /*__IParameterSet_H__*/