git.sesse.net Git - vlc/blob - src/video_output/control.h

   1 /*****************************************************************************
   2  * control.h : vout internal control
   3  *****************************************************************************
   4  * Copyright (C) 2009-2010 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  25 # error This header file can only be included from LibVLC.
  26 #endif
  27
  28 #ifndef _VOUT_INTERNAL_CONTROL_H
  29 #define _VOUT_INTERNAL_CONTROL_H
  30
  31 /* */
  32 enum {
  33     VOUT_CONTROL_INIT,
  34     VOUT_CONTROL_CLEAN,
  35     VOUT_CONTROL_REINIT,                /* cfg */
  36
  37 #if 0
  38     /* */
  39     VOUT_CONTROL_START,
  40     VOUT_CONTROL_STOP,
  41 #endif
  42     VOUT_CONTROL_SUBPICTURE,            /* subpicture */
  43     VOUT_CONTROL_FLUSH_SUBPICTURE,      /* integer */
  44     VOUT_CONTROL_REGISTER_SUBPICTURE,   /* integer_ptr */
  45     VOUT_CONTROL_OSD_TITLE,             /* string */
  46     VOUT_CONTROL_CHANGE_FILTERS,        /* string */
  47     VOUT_CONTROL_CHANGE_SUB_FILTERS,    /* string */
  48
  49     VOUT_CONTROL_PAUSE,
  50     VOUT_CONTROL_RESET,
  51     VOUT_CONTROL_FLUSH,                 /* time */
  52     VOUT_CONTROL_STEP,                  /* time_ptr */
  53
  54     VOUT_CONTROL_FULLSCREEN,            /* bool */
  55     VOUT_CONTROL_ON_TOP,                /* bool */
  56     VOUT_CONTROL_DISPLAY_FILLED,        /* bool */
  57     VOUT_CONTROL_ZOOM,                  /* pair */
  58
  59     VOUT_CONTROL_ASPECT_RATIO,          /* pair */
  60     VOUT_CONTROL_CROP_BORDER,           /* border */
  61     VOUT_CONTROL_CROP_RATIO,            /* pair */
  62     VOUT_CONTROL_CROP_WINDOW,           /* window */
  63 };
  64
  65 typedef struct {
  66     int type;
  67
  68     union {
  69         bool    boolean;
  70         mtime_t time;
  71         mtime_t *time_ptr;
  72         char    *string;
  73         int     integer;
  74         int     *integer_ptr;
  75         struct {
  76             int a;
  77             int b;
  78         } pair;
  79         struct {
  80             bool is_on;
  81             mtime_t date;
  82         } pause;
  83         struct {
  84             int channel;
  85             char *string;
  86         } message;
  87         struct {
  88             unsigned left;
  89             unsigned top;
  90             unsigned right;
  91             unsigned bottom;
  92         } border;
  93         struct {
  94             unsigned x;
  95             unsigned y;
  96             unsigned width;
  97             unsigned height;
  98         } window;
  99         const vout_configuration_t *cfg;
 100         subpicture_t *subpicture;
 101     } u;
 102 } vout_control_cmd_t;
 103
 104 void vout_control_cmd_Init(vout_control_cmd_t *, int type);
 105 void vout_control_cmd_Clean(vout_control_cmd_t *);
 106
 107 typedef struct {
 108     vlc_mutex_t lock;
 109     vlc_cond_t  wait_request;
 110     vlc_cond_t  wait_acknowledge;
 111
 112     /* */
 113     bool is_dead;
 114     bool is_sleeping;
 115     bool can_sleep;
 116     bool is_processing;
 117     DECL_ARRAY(vout_control_cmd_t) cmd;
 118 } vout_control_t;
 119
 120 /* */
 121 void vout_control_Init(vout_control_t *);
 122 void vout_control_Clean(vout_control_t *);
 123
 124 /* controls outside of the vout thread */
 125 void vout_control_WaitEmpty(vout_control_t *);
 126
 127 void vout_control_Push(vout_control_t *, vout_control_cmd_t *);
 128 void vout_control_PushVoid(vout_control_t *, int type);
 129 void vout_control_PushBool(vout_control_t *, int type, bool boolean);
 130 void vout_control_PushInteger(vout_control_t *, int type, int integer);
 131 void vout_control_PushTime(vout_control_t *, int type, mtime_t time);
 132 void vout_control_PushMessage(vout_control_t *, int type, int channel, const char *string);
 133 void vout_control_PushPair(vout_control_t *, int type, int a, int b);
 134 void vout_control_PushString(vout_control_t *, int type, const char *string);
 135 void vout_control_Wake(vout_control_t *);
 136
 137 /* control inside of the vout thread */
 138 int vout_control_Pop(vout_control_t *, vout_control_cmd_t *, mtime_t deadline, mtime_t timeout);
 139 void vout_control_Dead(vout_control_t *);
 140
 141 #endif
 142