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 #if 0
  34     VOUT_CONTROL_INIT,
  35     VOUT_CONTROL_EXIT,
  36
  37     /* */
  38     VOUT_CONTROL_START,
  39     VOUT_CONTROL_STOP,
  40
  41     /* Controls */
  42
  43
  44     /* OSD */
  45     VOUT_CONTROL_OSD_MESSAGE,
  46     VOUT_CONTROL_OSD_TEXT,
  47     VOUT_CONTROL_OSD_SLIDER,
  48     VOUT_CONTROL_OSD_ICON,
  49     VOUT_CONTROL_OSD_SUBPICTURE,
  50 #endif
  51     VOUT_CONTROL_OSD_TITLE,             /* string */
  52     VOUT_CONTROL_CHANGE_FILTERS,        /* string */
  53
  54     VOUT_CONTROL_PAUSE,
  55     VOUT_CONTROL_RESET,
  56     VOUT_CONTROL_FLUSH,                 /* time */
  57     VOUT_CONTROL_STEP,                  /* time_ptr */
  58
  59     VOUT_CONTROL_FULLSCREEN,            /* bool */
  60     VOUT_CONTROL_ON_TOP,                /* bool */
  61     VOUT_CONTROL_DISPLAY_FILLED,        /* bool */
  62     VOUT_CONTROL_ZOOM,                  /* pair */
  63
  64     VOUT_CONTROL_ASPECT_RATIO,          /* pair */
  65     VOUT_CONTROL_CROP_BORDER,           /* border */
  66     VOUT_CONTROL_CROP_RATIO,            /* pair */
  67     VOUT_CONTROL_CROP_WINDOW,           /* window */
  68 };
  69
  70 typedef struct {
  71     int type;
  72
  73     union {
  74         bool    boolean;
  75         mtime_t time;
  76         mtime_t *time_ptr;
  77         char    *string;
  78         struct {
  79             int a;
  80             int b;
  81         } pair;
  82         struct {
  83             bool is_on;
  84             mtime_t date;
  85         } pause;
  86         struct {
  87             int channel;
  88             char *string;
  89         } message;
  90         struct {
  91             unsigned left;
  92             unsigned top;
  93             unsigned right;
  94             unsigned bottom;
  95         } border;
  96         struct {
  97             unsigned x;
  98             unsigned y;
  99             unsigned width;
 100             unsigned height;
 101         } window;
 102     } u;
 103 } vout_control_cmd_t;
 104
 105 void vout_control_cmd_Init(vout_control_cmd_t *, int type);
 106 void vout_control_cmd_Clean(vout_control_cmd_t *);
 107
 108 typedef struct {
 109     vlc_mutex_t lock;
 110     vlc_cond_t  wait_request;
 111     vlc_cond_t  wait_acknowledge;
 112
 113     /* */
 114     bool is_dead;
 115     bool is_sleeping;
 116     bool can_sleep;
 117     bool is_processing;
 118     DECL_ARRAY(vout_control_cmd_t) cmd;
 119 } vout_control_t;
 120
 121 /* */
 122 void vout_control_Init(vout_control_t *);
 123 void vout_control_Clean(vout_control_t *);
 124
 125 /* controls outside of the vout thread */
 126 void vout_control_WaitEmpty(vout_control_t *);
 127
 128 void vout_control_Push(vout_control_t *, vout_control_cmd_t *);
 129 void vout_control_PushVoid(vout_control_t *, int type);
 130 void vout_control_PushBool(vout_control_t *, int type, bool boolean);
 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