VLC 4.0.0-dev
Loading...
Searching...
No Matches
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#include <vlc_clock.h>
29
32
33///< Use the aspect ratio from the source video format
34#define VLC_DAR_FROM_SOURCE ((vlc_rational_t){0, 0})
35///< Use the whole display area to show the video
36#define VLC_DAR_FILL_DISPLAY ((vlc_rational_t){1, 0})
37
38#define VLC_DAR_IS_FROM_SOURCE(r) \
39 ((r).num == VLC_DAR_FROM_SOURCE.num && (r).den == VLC_DAR_FROM_SOURCE.den)
40
41#define VLC_DAR_IS_FILL_DISPLAY(r) \
42 ((r).num == VLC_DAR_FILL_DISPLAY.num && (r).den == VLC_DAR_FILL_DISPLAY.den)
43
44/**
45 * Vout configuration
46 */
55
56/**
57 * Creates a video output.
58 */
60
62
63/**
64 * Setup the vout for the given configuration and get an associated decoder device.
65 *
66 * \param vout the video configuration requested.
67 * \return pointer to a decoder device reference to use with the vout or NULL
68 */
70
71/**
72 * Returns a suitable vout or release the given one.
73 *
74 * If cfg->fmt is non NULL and valid, a vout will be returned, reusing cfg->vout
75 * is possible, otherwise it returns NULL.
76 * If cfg->vout is not used, it will be closed and released.
77 *
78 * You can release the returned value either by vout_Request() or vout_Close().
79 *
80 * \param cfg the video configuration requested.
81 * \param input used to get attachments for spu filters
82 * \param vctx pointer to the video context to use with the vout or NULL
83 * \retval 0 on success
84 * \retval -1 on error
85 */
87
88/**
89 * Disables a vout.
90 *
91 * This disables a vout, but keeps it for later reuse.
92 */
94
95/**
96 * Stop the display plugin, but keep its window plugin for later reuse.
97 */
99
100/**
101 * Set the new source format for a started vout
102 *
103 * \retval 0 on success
104 * \retval -1 on error, the vout needs to be restarted to handle the format
105 */
106int vout_ChangeSource( vout_thread_t *p_vout, const video_format_t *fmt,
107 const vlc_video_context * );
108
112
113struct vout_crop {
115 union {
117 struct {
118 unsigned x;
119 unsigned y;
120 unsigned width;
121 unsigned height;
123 struct {
124 unsigned left;
125 unsigned right;
126 unsigned top;
127 unsigned bottom;
129 };
130};
131
132static inline bool vout_CropEqual(const struct vout_crop *a,
133 const struct vout_crop *b)
134{
135 if (a->mode != b->mode)
136 return false;
137
138 switch (a->mode) {
139 case VOUT_CROP_NONE:
140 return true;
141 case VOUT_CROP_RATIO:
142 return a->ratio.num * b->ratio.den == b->ratio.num * a->ratio.den;
143 case VOUT_CROP_WINDOW:
144 return memcmp(&a->window, &b->window, sizeof (a->window)) == 0;
145 case VOUT_CROP_BORDER:
146 return memcmp(&a->border, &b->border, sizeof (a->border)) == 0;
147 default:
149 }
150}
151
152bool vout_ParseCrop(struct vout_crop *, const char *crop_str);
153bool GetAspectRatio(const char *ar_str, vlc_rational_t *ar);
154
155/* TODO to move them to vlc_vout.h */
156void vout_ChangeFullscreen(vout_thread_t *, const char *id);
159void vout_ChangeDisplaySize(vout_thread_t *, unsigned width, unsigned height,
160 void (*ack_cb)(void *), void *opaque);
162void vout_ChangeZoom(vout_thread_t *, unsigned num, unsigned den);
163void vout_ChangeDisplayAspectRatio(vout_thread_t *, unsigned num, unsigned den);
165void vout_ControlChangeFilters(vout_thread_t *, const char *);
167void vout_ControlChangeSubSources(vout_thread_t *, const char *);
168void vout_ControlChangeSubFilters(vout_thread_t *, const char *);
174void vout_ToggleProjection(vout_thread_t *, bool enabled);
176
177/**
178 * Passes mouse events through the video filter chains and updates the mouse state.
179 *
180 * \return true if any filter in the chain consumed the mouse event, false otherwise.
181 */
182bool vout_FilterMouse(vout_thread_t *vout, vlc_mouse_t *mouse);
183
184/* */
190
191/* */
193 vlc_clock_t *clock,
194 enum vlc_vout_order *out_order );
196void spu_Attach( spu_t *, input_thread_t *input );
197void spu_Detach( spu_t * );
198void spu_SetClockDelay(spu_t *spu, size_t channel_id, vlc_tick_t delay);
199void spu_SetClockRate(spu_t *spu, size_t channel_id, float rate);
202
203/**
204 * This function will (un)pause the display of pictures.
205 * It is thread safe
206 */
207void vout_ChangePause( vout_thread_t *, bool b_paused, vlc_tick_t i_date );
208
209/**
210 * This function will change the rate of the vout
211 * It is thread safe
212 */
213void vout_ChangeRate( vout_thread_t *, float rate );
214
215/**
216 * This function will change the delay of the vout
217 * It is thread safe
218 */
220
221/**
222 * This function will change the rate of the spu channel
223 * It is thread safe
224 */
225void vout_ChangeSpuRate( vout_thread_t *, size_t channel_id, float rate );
226/**
227 * This function will change the delay of the spu channel
228 * It is thread safe
229 */
230void vout_ChangeSpuDelay( vout_thread_t *, size_t channel_id, vlc_tick_t delay );
231
232
233/**
234 * This function will return and reset internal statistics.
235 */
236void vout_GetResetStatistic( vout_thread_t *p_vout, unsigned *pi_displayed,
237 unsigned *pi_lost, unsigned *pi_late );
238
239/**
240 * This function will force to display the next picture while paused
241 */
242void vout_NextPicture( vout_thread_t *p_vout );
243
244/**
245 * This function will ask the display of the input title
246 */
247void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title );
248
249/**
250 * This function will return true if no more pictures are to be displayed.
251 */
252bool vout_IsEmpty( vout_thread_t *p_vout );
253
255
256#endif // LIBVLC_VOUT_INTERNAL_H
#define VLC_USED
Definition fourcc_gen.c:32
#define vlc_assert_unreachable()
Impossible branch assertion.
Definition vlc_common.h:274
vlc_video_fitting
Video automatic scale fitting.
Definition vlc_vout_display.h:84
vlc_stereoscopic_mode_t
Stereoscopic display mode.
Definition vlc_vout.h:92
vlc_vout_order
vout or spu_channel order
Definition vlc_vout.h:70
static thread_local struct @82 state
Main structure representing an input thread.
Definition input_internal.h:44
Subpicture unit descriptor.
Definition vlc_spu.h:51
video format description
Definition vlc_es.h:337
Definition clock.c:127
Decoder context struct.
Definition vlc_codec.h:618
Definition vlc_ancillary.h:319
Mouse state.
Definition vlc_mouse.h:46
VLC object common members.
Definition vlc_objects.h:53
Definition fourcc_gen.c:34
unsigned num
Definition fourcc_gen.c:34
unsigned den
Definition fourcc_gen.c:34
Definition vlc_subpicture.h:109
Definition decoder_device.c:98
Viewpoints.
Definition vlc_viewpoint.h:41
Vout configuration.
Definition vout_internal.h:47
vout_thread_t * vout
Definition vout_internal.h:48
vlc_mouse_event mouse_event
Definition vout_internal.h:52
const video_format_t * fmt
Definition vout_internal.h:51
vlc_clock_t * clock
Definition vout_internal.h:49
const char * str_id
Definition vout_internal.h:50
void * mouse_opaque
Definition vout_internal.h:53
Definition vout_internal.h:113
unsigned width
Definition vout_internal.h:120
struct vout_crop::@128::@130 window
unsigned right
Definition vout_internal.h:125
unsigned y
Definition vout_internal.h:119
unsigned x
Definition vout_internal.h:118
unsigned left
Definition vout_internal.h:124
enum vout_crop_mode mode
Definition vout_internal.h:114
vlc_rational_t ratio
Definition vout_internal.h:116
unsigned bottom
Definition vout_internal.h:127
unsigned height
Definition vout_internal.h:121
unsigned top
Definition vout_internal.h:126
struct vout_crop::@128::@131 border
Video output thread descriptor.
Definition vlc_vout.h:54
video_projection_mode_t
Video projection mode.
Definition vlc_es.h:242
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:48
Video output display modules interface.
ssize_t spu_RegisterChannelInternal(spu_t *, vlc_clock_t *, enum vlc_vout_order *)
Definition vout_subpictures.c:2352
static bool vout_CropEqual(const struct vout_crop *a, const struct vout_crop *b)
Definition vout_internal.h:132
ssize_t vout_RegisterSubpictureChannelInternal(vout_thread_t *, vlc_clock_t *clock, enum vlc_vout_order *out_order)
Definition video_output.c:357
bool GetAspectRatio(const char *ar_str, vlc_rational_t *ar)
Definition vout_intf.c:614
void vout_IntfInit(vout_thread_t *)
Definition vout_intf.c:369
void vout_ResetProjection(vout_thread_t *)
Definition video_output.c:703
void vout_ToggleProjection(vout_thread_t *, bool enabled)
Definition video_output.c:684
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:1792
void vout_ChangeSpuChannelMargin(vout_thread_t *, enum vlc_vout_order order, int)
Definition video_output.c:643
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:292
void vout_ControlChangeSubFilters(vout_thread_t *, const char *)
Definition video_output.c:635
void vout_CreateVars(vout_thread_t *)
Definition vout_intf.c:205
void vout_ControlChangeStereo(vout_thread_t *vout, vlc_stereoscopic_mode_t)
Definition video_output.c:728
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:1678
vout_crop_mode
Definition vout_internal.h:109
@ VOUT_CROP_RATIO
Definition vout_internal.h:110
@ VOUT_CROP_NONE
Definition vout_internal.h:110
@ VOUT_CROP_BORDER
Definition vout_internal.h:110
@ VOUT_CROP_WINDOW
Definition vout_internal.h:110
void vout_ControlChangeFilters(vout_thread_t *, const char *)
Definition video_output.c:596
enum vlc_video_fitting var_InheritFit(vlc_object_t *)
Definition vout_intf.c:190
void vout_ChangeZoom(vout_thread_t *, unsigned num, unsigned den)
Definition video_output.c:518
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:1768
void vout_ChangeFullscreen(vout_thread_t *, const char *id)
Definition video_output.c:448
void vout_ChangeViewpoint(vout_thread_t *, const vlc_viewpoint_t *)
Definition video_output.c:652
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:1782
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:282
void spu_ChangeChannelOrderMargin(spu_t *, enum vlc_vout_order, int)
Definition vout_subpictures.c:2450
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:2444
void vout_ChangeWindowed(vout_thread_t *)
Definition video_output.c:457
void vout_ControlChangeInterlacing(vout_thread_t *, bool)
Definition video_output.c:618
void vout_ChangeWindowState(vout_thread_t *, unsigned state)
Definition video_output.c:468
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:2350
void vout_ChangeDisplayFitting(vout_thread_t *, enum vlc_video_fitting)
Definition video_output.c:501
void vout_Stop(vout_thread_t *)
Disables a vout.
Definition video_output.c:2083
void spu_SetClockDelay(spu_t *spu, size_t channel_id, vlc_tick_t delay)
Definition vout_subpictures.c:2019
vout_thread_t * vout_Create(vlc_object_t *obj)
Creates a video output.
Definition video_output.c:2171
void spu_SetHighlight(spu_t *, const vlc_spu_highlight_t *)
Definition vout_subpictures.c:2470
void spu_SetClockRate(spu_t *spu, size_t channel_id, float rate)
Definition vout_subpictures.c:2033
void vout_IntfReinit(vout_thread_t *)
Definition vout_intf.c:394
void vout_ChangeProjection(vout_thread_t *, video_projection_mode_t projection)
Definition video_output.c:712
void vout_ControlChangeSubSources(vout_thread_t *, const char *)
Definition video_output.c:627
void spu_Attach(spu_t *, input_thread_t *input)
Attach the SPU to an input.
Definition vout_subpictures.c:1989
void vout_ChangeIccProfile(vout_thread_t *, vlc_icc_profile_t *)
Definition video_output.c:670
vout_thread_t * vout_CreateDummy(vlc_object_t *obj)
Definition video_output.c:2160
void vout_NextPicture(vout_thread_t *p_vout)
This function will force to display the next picture while paused.
Definition video_output.c:1756
void vout_IntfDeinit(vlc_object_t *)
Definition vout_intf.c:411
void vout_ChangeDisplayAspectRatio(vout_thread_t *, unsigned num, unsigned den)
Definition video_output.c:559
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:2274
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:1801
bool vout_FilterMouse(vout_thread_t *vout, vlc_mouse_t *mouse)
Passes mouse events through the video filter chains and updates the mouse state.
Definition video_output.c:305
void spu_Detach(spu_t *)
Detach the SPU from its attached input.
Definition vout_subpictures.c:2010
void vout_ChangeDisplaySize(vout_thread_t *, unsigned width, unsigned height, void(*ack_cb)(void *), void *opaque)
Definition video_output.c:477
void vout_StopDisplay(vout_thread_t *)
Stop the display plugin, but keep its window plugin for later reuse.
Definition video_output.c:2061
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:387