m_property.h

   1
   2 // Get the current value
   3 #define M_PROPERTY_GET         0
   4 // Get a string representing the current value
   5 #define M_PROPERTY_PRINT       1
   6 // Set a new value
   7 #define M_PROPERTY_SET         2
   8 // Set a new value from a string
   9 #define M_PROPERTY_PARSE       3
  10 // Increment the property
  11 #define M_PROPERTY_STEP_UP     4
  12 // Decrement the property
  13 #define M_PROPERTY_STEP_DOWN   5
  14
  15 // Return values for the control function
  16 #define M_PROPERTY_OK                1
  17 #define M_PROPERTY_ERROR             0
  18 // Returned when the property can't be used, for ex something about
  19 // the subs while playing audio only
  20 #define M_PROPERTY_UNAVAILABLE      -1
  21 // Returned if the requested action is not implemented
  22 #define M_PROPERTY_NOT_IMPLEMENTED  -2
  23 // Returned when asking for a property that doesn't exist
  24 #define M_PROPERTY_UNKNOWN          -3
  25 // Returned when the action can't be done (like setting the volume when edl mute)
  26 #define M_PROPERTY_DISABLED         -4
  27
  28 typedef int(*m_property_ctrl_f)(m_option_t* prop,int action,void* arg);
  29
  30 int m_property_do(m_option_t* prop, int action, void* arg);
  31
  32 char* m_property_print(m_option_t* prop);
  33
  34 int m_property_parse(m_option_t* prop, char* txt);
  35
  36 void m_properties_print_help_list(m_option_t* list);
  37
  38 char* m_properties_expand_string(m_option_t* prop_list,char* str);
  39
  40 // Helpers to use MPlayer's properties
  41
  42 m_option_t*  mp_property_find(char* name);
  43
  44 int mp_property_do(char* name,int action, void* val);
  45
  46 // Helpers for property implementations
  47
  48 #define M_PROPERTY_CLAMP(prop,val) do {                                 \
  49         if(((prop)->flags & M_OPT_MIN) && (val) < (prop)->min)          \
  50             (val) = (prop)->min;                                        \
  51         else if(((prop)->flags & M_OPT_MAX) && (val) > (prop)->max)     \
  52             (val) = (prop)->max;                                        \
  53     } while(0)
  54
  55 // Implement get
  56 int m_property_int_ro(m_option_t* prop,int action,
  57                       void* arg,int var);
  58
  59 // Implement set, get and step up/down
  60 int m_property_int_range(m_option_t* prop,int action,
  61                          void* arg,int* var);
  62
  63 // Same but cycle
  64 int m_property_choice(m_option_t* prop,int action,
  65                       void* arg,int* var);
  66
  67 // Switch betwen min and max
  68 int m_property_flag(m_option_t* prop,int action,
  69                     void* arg,int* var);
  70
  71 // Implement get, print
  72 int m_property_float_ro(m_option_t* prop,int action,
  73                         void* arg,float var);
  74
  75 // Implement set, get and step up/down
  76 int m_property_float_range(m_option_t* prop,int action,
  77                            void* arg,float* var);
  78
  79 // float with a print function which print the time in ms
  80 int m_property_delay(m_option_t* prop,int action,
  81                      void* arg,float* var);
  82
  83 // Implement get, print
  84 int m_property_double_ro(m_option_t* prop,int action,
  85                          void* arg,double var);
  86
  87 // get/print the string
  88 int m_property_string_ro(m_option_t* prop,int action,void* arg, char* str);