VLC  4.0.0-dev
vout_internal.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * vout_internal.h : Internal vout definitions
3  *****************************************************************************
4  * Copyright (C) 2008-2018 VLC authors and VideoLAN
5  * Copyright (C) 2008 Laurent Aimar
6  *
7  * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23 
24 #ifndef LIBVLC_VOUT_INTERNAL_H
25 #define LIBVLC_VOUT_INTERNAL_H 1
26 
27 #include <vlc_vout_display.h>
28 
29 typedef struct input_thread_t input_thread_t;
30 typedef struct vlc_clock_t vlc_clock_t;
31 
32 /* It should be high enough to absorbe jitter due to difficult picture(s)
33  * to decode but not too high as memory is not that cheap.
34  *
35  * It can be made lower at compilation time if needed, but performance
36  * may be degraded.
37  */
38 #define VOUT_MAX_PICTURES (20)
39 
40 /**
41  * Vout configuration
42  */
43 typedef struct {
46  const char *str_id;
49  void *mouse_opaque;
51 
52 /**
53  * Creates a video output.
54  */
56 
58 
59 /**
60  * Setup the vout for the given configuration and get an associated decoder device.
61  *
62  * \param vout the video configuration requested.
63  * \return pointer to a decoder device reference to use with the vout or NULL
64  */
66 
67 /**
68  * Returns a suitable vout or release the given one.
69  *
70  * If cfg->fmt is non NULL and valid, a vout will be returned, reusing cfg->vout
71  * is possible, otherwise it returns NULL.
72  * If cfg->vout is not used, it will be closed and released.
73  *
74  * You can release the returned value either by vout_Request() or vout_Close().
75  *
76  * \param cfg the video configuration requested.
77  * \param input used to get attachments for spu filters
78  * \param vctx pointer to the video context to use with the vout or NULL
79  * \retval 0 on success
80  * \retval -1 on error
81  */
83 
84 /**
85  * Disables a vout.
86  *
87  * This disables a vout, but keeps it for later reuse.
88  */
89 void vout_Stop(vout_thread_t *);
90 
91 /**
92  * Stop the display plugin, but keep its window plugin for later reuse.
93  */
95 
96 /**
97  * Set the new source format for a started vout
98  *
99  * \retval 0 on success
100  * \retval -1 on error, the vout needs to be restarted to handle the format
101  */
102 int vout_ChangeSource( vout_thread_t *p_vout, const video_format_t *fmt,
103  const vlc_video_context * );
104 
107 };
108 
109 struct vout_crop {
110  enum vout_crop_mode mode;
111  union {
113  struct {
114  unsigned x;
115  unsigned y;
116  unsigned width;
117  unsigned height;
119  struct {
120  unsigned left;
121  unsigned right;
122  unsigned top;
123  unsigned bottom;
125  };
126 };
127 
128 static inline bool vout_CropEqual(const struct vout_crop *a,
129  const struct vout_crop *b)
130 {
131  if (a->mode != b->mode)
132  return false;
133 
134  switch (a->mode) {
135  case VOUT_CROP_NONE:
136  return true;
137  case VOUT_CROP_RATIO:
138  return a->ratio.num * b->ratio.den == b->ratio.num * a->ratio.den;
139  case VOUT_CROP_WINDOW:
140  return memcmp(&a->window, &b->window, sizeof (a->window)) == 0;
141  case VOUT_CROP_BORDER:
142  return memcmp(&a->border, &b->border, sizeof (a->border)) == 0;
143  default:
145  }
146 }
147 
148 bool vout_ParseCrop(struct vout_crop *, const char *crop_str);
149 bool GetAspectRatio(const char *ar_str, unsigned *num, unsigned *den);
150 
151 /* TODO to move them to vlc_vout.h */
152 void vout_ChangeFullscreen(vout_thread_t *, const char *id);
154 void vout_ChangeWindowState(vout_thread_t *, unsigned state);
155 void vout_ChangeDisplaySize(vout_thread_t *, unsigned width, unsigned height,
156  void (*ack_cb)(void *), void *opaque);
158 void vout_ChangeZoom(vout_thread_t *, unsigned num, unsigned den);
159 void vout_ChangeDisplayAspectRatio(vout_thread_t *, unsigned num, unsigned den);
160 void vout_ChangeCrop(vout_thread_t *, const struct vout_crop *);
161 void vout_ControlChangeFilters(vout_thread_t *, const char *);
163 void vout_ControlChangeSubSources(vout_thread_t *, const char *);
164 void vout_ControlChangeSubFilters(vout_thread_t *, const char *);
168 
169 void vout_FilterMouse(vout_thread_t *vout, vlc_mouse_t *mouse);
170 
171 /* */
173 void vout_IntfInit( vout_thread_t * );
177 
178 /* */
180  vlc_clock_t *clock,
181  enum vlc_vout_order *out_order );
183 void spu_Attach( spu_t *, input_thread_t *input );
184 void spu_Detach( spu_t * );
185 void spu_SetClockDelay(spu_t *spu, size_t channel_id, vlc_tick_t delay);
186 void spu_SetClockRate(spu_t *spu, size_t channel_id, float rate);
189 
190 /**
191  * This function will (un)pause the display of pictures.
192  * It is thread safe
193  */
194 void vout_ChangePause( vout_thread_t *, bool b_paused, vlc_tick_t i_date );
195 
196 /**
197  * This function will change the rate of the vout
198  * It is thread safe
199  */
200 void vout_ChangeRate( vout_thread_t *, float rate );
201 
202 /**
203  * This function will change the delay of the vout
204  * It is thread safe
205  */
206 void vout_ChangeDelay( vout_thread_t *, vlc_tick_t delay );
207 
208 /**
209  * This function will change the rate of the spu channel
210  * It is thread safe
211  */
212 void vout_ChangeSpuRate( vout_thread_t *, size_t channel_id, float rate );
213 /**
214  * This function will change the delay of the spu channel
215  * It is thread safe
216  */
217 void vout_ChangeSpuDelay( vout_thread_t *, size_t channel_id, vlc_tick_t delay );
218 
219 
220 /**
221  * This function will return and reset internal statistics.
222  */
223 void vout_GetResetStatistic( vout_thread_t *p_vout, unsigned *pi_displayed,
224  unsigned *pi_lost, unsigned *pi_late );
225 
226 /**
227  * This function will force to display the next picture while paused
228  */
229 void vout_NextPicture( vout_thread_t *p_vout, vlc_tick_t *pi_duration );
230 
231 /**
232  * This function will ask the display of the input title
233  */
234 void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title );
235 
236 /**
237  * This function will return true if no more pictures are to be displayed.
238  */
239 bool vout_IsEmpty( vout_thread_t *p_vout );
240 
242 
243 #endif // LIBVLC_VOUT_INTERNAL_H
#define VLC_USED
Definition: fourcc_gen.c:32
#define vlc_assert_unreachable()
Impossible branch assertion.
Definition: vlc_common.h:290
vlc_video_fitting
Video automatic scale fitting.
Definition: vlc_vout_display.h:84
vlc_vout_order
vout or spu_channel order
Definition: vlc_vout.h:71
static thread_local struct @79 state
Main structure representing an input thread.
Definition: input_internal.h:49
Subpicture unit descriptor.
Definition: vlc_spu.h:48
video format description
Definition: vlc_es.h:352
Definition: clock.c:65
Decoder context struct.
Definition: vlc_codec.h:598
Definition: vlc_es.h:612
Mouse state.
Definition: vlc_mouse.h:46
VLC object common members.
Definition: vlc_objects.h:45
Definition: fourcc_gen.c:34
unsigned num
Definition: fourcc_gen.c:34
unsigned den
Definition: fourcc_gen.c:34
Definition: vlc_subpicture.h:86
Definition: decoder_device.c:97
Viewpoints.
Definition: vlc_viewpoint.h:41
Vout configuration.
Definition: vout_internal.h:43
vout_thread_t * vout
Definition: vout_internal.h:44
vlc_mouse_event mouse_event
Definition: vout_internal.h:48
const video_format_t * fmt
Definition: vout_internal.h:47
vlc_clock_t * clock
Definition: vout_internal.h:45
const char * str_id
Definition: vout_internal.h:46
Definition: vout_internal.h:109
unsigned width
Definition: vout_internal.h:116
struct vout_crop::@126::@129 border
unsigned right
Definition: vout_internal.h:121
unsigned y
Definition: vout_internal.h:115
unsigned x
Definition: vout_internal.h:114
unsigned left
Definition: vout_internal.h:120
enum vout_crop_mode mode
Definition: vout_internal.h:110
vlc_rational_t ratio
Definition: vout_internal.h:112
struct vout_crop::@126::@128 window
unsigned bottom
Definition: vout_internal.h:123
unsigned height
Definition: vout_internal.h:117
unsigned top
Definition: vout_internal.h:122
Video output thread descriptor.
Definition: vlc_vout.h:55
void(* vlc_mouse_event)(const vlc_mouse_t *mouse, void *user_data)
Mouse event callback.
Definition: vlc_mouse.h:62
int64_t vlc_tick_t
High precision date or time interval.
Definition: vlc_tick.h:35
Video output display modules interface.
ssize_t spu_RegisterChannelInternal(spu_t *, vlc_clock_t *, enum vlc_vout_order *)
Definition: vout_subpictures.c:2006
static bool vout_CropEqual(const struct vout_crop *a, const struct vout_crop *b)
Definition: vout_internal.h:128
ssize_t vout_RegisterSubpictureChannelInternal(vout_thread_t *, vlc_clock_t *clock, enum vlc_vout_order *out_order)
Definition: video_output.c:342
void vout_IntfInit(vout_thread_t *)
Definition: vout_intf.c:302
void vout_ChangeSpuDelay(vout_thread_t *, size_t channel_id, vlc_tick_t delay)
This function will change the delay of the spu channel It is thread safe.
Definition: video_output.c:1636
void vout_ChangeSpuChannelMargin(vout_thread_t *, enum vlc_vout_order order, int)
Definition: video_output.c:651
bool vout_ParseCrop(struct vout_crop *, const char *crop_str)
void vout_DisplayTitle(vout_thread_t *p_vout, const char *psz_title)
This function will ask the display of the input title.
Definition: video_output.c:284
bool GetAspectRatio(const char *ar_str, unsigned *num, unsigned *den)
Definition: vout_intf.c:536
vlc_decoder_device * vout_GetDevice(vout_thread_t *vout)
Setup the vout for the given configuration and get an associated decoder device.
Definition: video_output.c:2222
void vout_ControlChangeSubFilters(vout_thread_t *, const char *)
Definition: video_output.c:643
void vout_CreateVars(vout_thread_t *)
Definition: vout_intf.c:169
void vout_FilterMouse(vout_thread_t *vout, vlc_mouse_t *mouse)
Definition: video_output.c:297
void vout_GetResetStatistic(vout_thread_t *p_vout, unsigned *pi_displayed, unsigned *pi_lost, unsigned *pi_late)
This function will return and reset internal statistics.
void vout_ChangePause(vout_thread_t *, bool b_paused, vlc_tick_t i_date)
This function will (un)pause the display of pictures.
Definition: video_output.c:1510
vout_crop_mode
Definition: vout_internal.h:105
@ VOUT_CROP_RATIO
Definition: vout_internal.h:106
@ VOUT_CROP_NONE
Definition: vout_internal.h:106
@ VOUT_CROP_BORDER
Definition: vout_internal.h:106
@ VOUT_CROP_WINDOW
Definition: vout_internal.h:106
vout_thread_t * vout_CreateDummy(vlc_object_t *obj) VLC_USED
Definition: video_output.c:1980
void vout_ControlChangeFilters(vout_thread_t *, const char *)
Definition: video_output.c:604
enum vlc_video_fitting var_InheritFit(vlc_object_t *)
Definition: vout_intf.c:154
void vout_ChangeZoom(vout_thread_t *, unsigned num, unsigned den)
Definition: video_output.c:526
void vout_ChangeDelay(vout_thread_t *, vlc_tick_t delay)
This function will change the delay of the vout It is thread safe.
Definition: video_output.c:1614
void vout_ChangeFullscreen(vout_thread_t *, const char *id)
Definition: video_output.c:456
void vout_ChangeViewpoint(vout_thread_t *, const vlc_viewpoint_t *)
Definition: video_output.c:660
void vout_ChangeRate(vout_thread_t *, float rate)
This function will change the rate of the vout It is thread safe.
Definition: video_output.c:1626
bool vout_IsEmpty(vout_thread_t *p_vout)
This function will return true if no more pictures are to be displayed.
Definition: video_output.c:274
void spu_ChangeChannelOrderMargin(spu_t *, enum vlc_vout_order, int)
Definition: vout_subpictures.c:2111
void vout_ChangeWindowed(vout_thread_t *)
Definition: video_output.c:465
void vout_ControlChangeInterlacing(vout_thread_t *, bool)
Definition: video_output.c:626
void vout_ChangeWindowState(vout_thread_t *, unsigned state)
Definition: video_output.c:476
int vout_Request(const vout_configuration_t *cfg, vlc_video_context *vctx, input_thread_t *input)
Returns a suitable vout or release the given one.
Definition: video_output.c:2150
void vout_ChangeDisplayFitting(vout_thread_t *, enum vlc_video_fitting)
Definition: video_output.c:509
void vout_Stop(vout_thread_t *)
Disables a vout.
Definition: video_output.c:1902
void spu_SetClockDelay(spu_t *spu, size_t channel_id, vlc_tick_t delay)
Definition: vout_subpictures.c:1754
void spu_SetHighlight(spu_t *, const vlc_spu_highlight_t *)
Definition: vout_subpictures.c:2131
void spu_SetClockRate(spu_t *spu, size_t channel_id, float rate)
Definition: vout_subpictures.c:1766
void vout_IntfReinit(vout_thread_t *)
Definition: vout_intf.c:323
void vout_ControlChangeSubSources(vout_thread_t *, const char *)
Definition: video_output.c:635
void vout_NextPicture(vout_thread_t *p_vout, vlc_tick_t *pi_duration)
This function will force to display the next picture while paused.
Definition: video_output.c:1591
void spu_Attach(spu_t *, input_thread_t *input)
Attach the SPU to an input.
Definition: vout_subpictures.c:1726
vout_thread_t * vout_Create(vlc_object_t *obj) VLC_USED
Creates a video output.
Definition: video_output.c:1991
void vout_ChangeIccProfile(vout_thread_t *, vlc_icc_profile_t *)
Definition: video_output.c:678
void vout_IntfDeinit(vlc_object_t *)
Definition: vout_intf.c:337
void vout_ChangeDisplayAspectRatio(vout_thread_t *, unsigned num, unsigned den)
Definition: video_output.c:567
int vout_ChangeSource(vout_thread_t *p_vout, const video_format_t *fmt, const vlc_video_context *)
Set the new source format for a started vout.
Definition: video_output.c:2091
void vout_ChangeSpuRate(vout_thread_t *, size_t channel_id, float rate)
This function will change the rate of the spu channel It is thread safe.
Definition: video_output.c:1645
void spu_Detach(spu_t *)
Detach the SPU from its attached input.
Definition: vout_subpictures.c:1746
void vout_ChangeDisplaySize(vout_thread_t *, unsigned width, unsigned height, void(*ack_cb)(void *), void *opaque)
Definition: video_output.c:485
void vout_StopDisplay(vout_thread_t *)
Stop the display plugin, but keep its window plugin for later reuse.
Definition: video_output.c:1880
void vout_ChangeCrop(vout_thread_t *, const struct vout_crop *)
void vout_SetSpuHighlight(vout_thread_t *p_vout, const vlc_spu_highlight_t *)
Definition: video_output.c:372