VLC  4.0.0-dev
player.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * player.h: Player internal interface
3  *****************************************************************************
4  * Copyright © 2018-2019 VLC authors and VideoLAN
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20 
21 #ifndef VLC_PLAYER_INTERNAL_H
22 #define VLC_PLAYER_INTERNAL_H
23 
24 #include <vlc_player.h>
25 #include <vlc_list.h>
26 #include <vlc_vector.h>
27 #include <vlc_atomic.h>
28 #include <vlc_media_library.h>
29 
30 #include "input/input_internal.h"
31 
33 {
35  vout_thread_t *vout; /* weak reference */
37  /* only valid if selected and if category is VIDEO_ES or SPU_ES */
39 };
40 
41 typedef struct VLC_VECTOR(struct vlc_player_program *)
43 
44 typedef struct VLC_VECTOR(struct vlc_player_track_priv *)
46 
48 {
50  size_t count;
51  struct vlc_player_title array[];
52 };
53 
54 struct vlc_player_input
55 {
58  bool started;
59 
61  enum vlc_player_error error;
62  float rate;
65 
66  float position;
69 
71 
72  bool recording;
73 
76  float cache;
77 
78  struct input_stats_t stats;
79 
80  vlc_tick_t cat_delays[DATA_ES];
81 
87 
89 
92 
93  struct vlc_list node;
94 
97  unsigned teletext_page;
98 
99  struct
100  {
101  vlc_tick_t time;
102  float pos;
103  bool set;
104  } abloop_state[2];
105 
106  struct
107  {
112  } ml;
113 };
114 
116 {
117  const struct vlc_player_cbs *cbs;
118  void *cbs_data;
119  struct vlc_list node;
120 };
121 
123 {
124  const struct vlc_player_vout_cbs *cbs;
125  void *cbs_data;
126  struct vlc_list node;
127 };
128 
130 {
131  const struct vlc_player_aout_cbs *cbs;
132  void *cbs_data;
133  struct vlc_list node;
134 };
135 
137 {
141 };
142 
144 {
147 
148  union
149  {
150  const struct vlc_player_timer_cbs *cbs;
152  };
153  void *data;
154 
155  struct vlc_list node;
156 };
157 
159 {
160  struct vlc_list listeners; /* list of struct vlc_player_timer_id */
161  vlc_es_id_t *es; /* weak reference */
163  union
164  {
165  struct {
166  unsigned long last_framenum;
167  unsigned frame_rate;
168  unsigned frame_rate_base;
170  unsigned df_fps;
171  int df;
173  } smpte;
174  };
175 };
176 
178 {
182 };
183 
185 {
187 
189  bool seeking;
190 
195 
197 #define best_source sources[VLC_PLAYER_TIMER_TYPE_BEST]
198 #define smpte_source sources[VLC_PLAYER_TIMER_TYPE_SMPTE]
199 };
200 
202 {
208 
209  enum vlc_player_media_stopped_action media_stopped_action;
211 
214 
216  bool corked;
217 
218  struct vlc_list listeners;
219  struct vlc_list aout_listeners;
220  struct vlc_list vout_listeners;
221 
224 
226  struct vlc_player_input *input;
227 
231 
232  enum vlc_player_state global_state;
233  bool started;
234 
235  unsigned error_count;
236 
237  bool deleting;
238  struct
239  {
243  struct vlc_list inputs;
244  struct vlc_list stopping_inputs;
245  struct vlc_list joinable_inputs;
246  } destructor;
247 
248  struct vlc_player_timer timer;
249 };
250 
251 #ifndef NDEBUG
252 /*
253  * Assert that the player mutex is locked.
254  *
255  * This is exposed in this internal header because the playlist and its
256  * associated player share the lock to avoid lock-order inversion issues.
257  */
258 static inline void
260 {
261  assert(player);
262  vlc_mutex_assert(&player->lock);
263 }
264 #else
265 #define vlc_player_assert_locked(x) ((void) (0))
266 #endif
267 
268 static inline struct vlc_player_input *
270 {
271  vlc_player_assert_locked(player);
272  return player->input;
273 }
274 
275 #define vlc_player_SendEvent(player, event, ...) do { \
276  vlc_player_listener_id *listener; \
277  vlc_list_foreach(listener, &player->listeners, node) \
278  { \
279  if (listener->cbs->event) \
280  listener->cbs->event(player, ##__VA_ARGS__, listener->cbs_data); \
281  } \
282 } while(0)
283 
284 static inline const char *
286 {
287  switch (cat)
288  {
289  case VIDEO_ES: return "Video";
290  case AUDIO_ES: return "Audio";
291  case SPU_ES: return "Subtitle";
292  default: return NULL;
293  }
294 }
295 
296 /*
297  * player.c
298  */
299 
300 vlc_object_t *
302 
303 int
305 
306 void
308 
309 void
311  struct vlc_player_input *input);
312 
313 void
315  struct vlc_player_input *input);
316 
317 /*
318  * player_track.c
319  */
320 
321 struct vlc_player_program *
322 vlc_player_program_New(int id, const char *name);
323 
324 int
325 vlc_player_program_Update(struct vlc_player_program *prgm, int id,
326  const char *name);
327 
328 struct vlc_player_program *
330  size_t *idx);
331 
332 struct vlc_player_track_priv *
333 vlc_player_track_priv_New(vlc_es_id_t *id, const char *name, const es_format_t *fmt);
334 
335 void
337 
338 int
340  const char *name, const es_format_t *fmt);
341 
342 struct vlc_player_track_priv *
344  size_t *idx);
345 
346 int
348 
349 /*
350  * player_title.c
351  */
352 
353 struct vlc_player_title_list *
354 vlc_player_title_list_Create(input_title_t *const *array, size_t count,
355  int title_offset, int chapter_offset);
356 
357 /*
358  * player_input.c
359  */
360 
361 static inline vlc_player_track_vector *
362 vlc_player_input_GetTrackVector(struct vlc_player_input *input,
363  enum es_format_category_e cat)
364 {
365  switch (cat)
366  {
367  case VIDEO_ES:
368  return &input->video_track_vector;
369  case AUDIO_ES:
370  return &input->audio_track_vector;
371  case SPU_ES:
372  return &input->spu_track_vector;
373  default:
374  return NULL;
375  }
376 }
377 
378 struct vlc_player_track_priv *
379 vlc_player_input_FindTrackById(struct vlc_player_input *input, vlc_es_id_t *id,
380  size_t *idx);
381 
382 struct vlc_player_input *
384 
385 void
386 vlc_player_input_Delete(struct vlc_player_input *input);
387 
389 vlc_player_input_GetTime(struct vlc_player_input *input);
390 
391 float
392 vlc_player_input_GetPos(struct vlc_player_input *input);
393 
394 int
395 vlc_player_input_Start(struct vlc_player_input *input);
396 
397 void
398 vlc_player_input_HandleState(struct vlc_player_input *, enum vlc_player_state,
399  vlc_tick_t state_date);
400 
402 vlc_player_input_GetTimerValue(struct vlc_player_input *input);
403 
404 /*
405  * player_timer.c
406 */
407 
408 void
410 
411 void
413 
414 void
416 
417 void
421 
422 void
424  bool es_source_is_master,
425  const struct vlc_player_timer_point *point,
426  vlc_tick_t normal_time,
427  unsigned frame_rate, unsigned frame_rate_base);
428 
429 void
431 
432 int
434  vlc_tick_t *out_ts, float *out_pos);
435 
436 /*
437  * player_vout.c
438  */
439 
440 void
442 
443 void
445 
446 /*
447  * player_aout.c
448  */
449 
450 void
452 
453 void
455 
456 /*
457  * player_osd.c
458  */
459 
460 void
461 vlc_player_osd_Message(vlc_player_t *player, const char *fmt, ...);
462 
463 void
464 vlc_player_osd_Icon(vlc_player_t *player, short type);
465 
466 void
468  struct vlc_player_input *input, vlc_tick_t time,
469  float position, enum vlc_player_whence whence);
470 void
471 vlc_player_osd_Volume(vlc_player_t *player, bool mute_action);
472 
473 int
474 vlc_player_vout_OSDCallback(vlc_object_t *this, const char *var,
475  vlc_value_t oldval, vlc_value_t newval, void *data);
476 
477 void
478 vlc_player_osd_Track(vlc_player_t *player, vlc_es_id_t *id, bool select);
479 
480 void
481 vlc_player_osd_Program(vlc_player_t *player, const char *name);
482 
483 /*
484  * player/medialib.c
485  */
486 
487 void
488 vlc_player_input_RestoreMlStates(struct vlc_player_input* input,
489  const input_item_t* item);
490 
491 void
492 vlc_player_UpdateMLStates(vlc_player_t *player, struct vlc_player_input* input);
493 
494 #endif
void vlc_player_osd_Position(vlc_player_t *player, struct vlc_player_input *input, vlc_tick_t time, float position, enum vlc_player_whence whence)
Definition: osd.c:119
Definition: player.h:32
bool deleting
Definition: player.h:237
Definition: resource.c:47
size_t chapter_selected
Definition: player.h:91
vlc_tick_t vlc_player_input_GetTime(struct vlc_player_input *input)
Definition: input.c:61
void vlc_player_destructor_AddJoinableInput(vlc_player_t *player, struct vlc_player_input *input)
Definition: player.c:168
vlc_object_t * vlc_player_GetObject(vlc_player_t *player)
Definition: player.c:2001
bool releasing_media
Definition: player.h:228
float signal_quality
Definition: player.h:74
Player timer point.
Definition: vlc_player.h:3066
struct vlc_player_input * vlc_player_input_New(vlc_player_t *player, input_item_t *item)
Definition: input.c:830
const struct vlc_player_aout_cbs * cbs
Definition: player.h:131
int vlc_player_input_Start(struct vlc_player_input *input)
Definition: input.c:93
unsigned teletext_page
Definition: player.h:97
struct vlc_player_track_priv * vlc_player_input_FindTrackById(struct vlc_player_input *input, vlc_es_id_t *id, size_t *idx)
Definition: input.c:30
#define vlc_mutex_assert(m)
Asserts that a mutex is locked by the calling thread.
Definition: vlc_threads.h:462
const struct vlc_player_cbs * cbs
Definition: player.h:117
int default_audio_track
Definition: player.h:110
vout_thread_t * vout
Definition: player.h:35
unsigned long last_framenum
Definition: player.h:166
Definition: vlc_es.h:604
Definition: player.h:201
int vlc_player_track_priv_Update(struct vlc_player_track_priv *trackpriv, const char *name, const es_format_t *fmt)
Definition: track.c:168
vlc_player_program_vector program_vector
Definition: player.h:82
vlc_thread_t thread
Definition: player.h:240
Definition: vlc_atomic.h:63
void vlc_player_osd_Icon(vlc_player_t *player, short type)
Definition: osd.c:108
void vlc_player_osd_Program(vlc_player_t *player, const char *name)
Definition: osd.c:203
Describes an input and is used to spawn input_thread_t objects.
Definition: vlc_input_item.h:77
vlc_tick_t last_update_date
Definition: player.h:146
pthread_mutex_t vlc_mutex_t
Mutex.
Definition: vlc_threads.h:278
vlc_mutex_t vout_listeners_lock
Definition: player.h:206
Definition: player.h:180
Player vout callbacks.
Definition: vlc_player.h:2338
static thread_local struct @77 state
struct vlc_player_program * vlc_player_program_New(int id, const char *name)
Definition: track.c:42
int vlc_player_GetFirstSelectedTrackId(const vlc_player_track_vector *tracks)
Definition: track.c:211
Definition: player.h:184
static void vlc_player_assert_locked(vlc_player_t *player)
Definition: player.h:259
VLC Player API.
vlc_cond_t wait
Definition: player.h:241
void vlc_player_PrepareNextMedia(vlc_player_t *player)
Definition: player.c:53
bool teletext_enabled
Definition: player.h:95
vlc_tick_t normal_time
Definition: player.h:68
vlc_tick_t input_normal_time
Definition: player.h:192
unsigned frame_resolution
Definition: player.h:169
vlc_tick_t delay
Definition: player.h:36
bool recording
Definition: player.h:72
vlc_tick_t system_date
System date of this record (always valid), this date can be in the future or in the past...
Definition: vlc_player.h:3082
vlc_mutex_t aout_listeners_lock
Definition: player.h:205
unsigned error_count
Definition: player.h:235
Definition: player.h:129
Player aout callbacks.
Definition: vlc_player.h:2122
const struct vlc_player_media_provider * media_provider
Definition: player.h:212
void * cbs_data
Definition: player.h:118
Player smpte timer callbacks.
Definition: vlc_player.h:3151
vlc_player_track_vector audio_track_vector
Definition: player.h:84
Definition: player.h:179
void vlc_player_RemoveTimerSource(vlc_player_t *player, vlc_es_id_t *es_source)
Definition: timer.c:372
vlc_player_timer_state
Definition: player.h:177
Player track structure.
Definition: vlc_player.h:1312
struct vlc_player_program * vlc_player_program_vector_FindById(vlc_player_program_vector *vec, int id, size_t *idx)
Definition: track.c:89
int vlc_player_GetTimerPoint(vlc_player_t *player, vlc_tick_t system_now, vlc_tick_t *out_ts, float *out_pos)
Definition: timer.c:389
float signal_strength
Definition: player.h:75
void vlc_player_vout_AddCallbacks(vlc_player_t *player, vout_thread_t *vout)
Definition: vout.c:137
vlc_player_error
Error of the player.
Definition: vlc_player.h:289
float pos
Definition: player.h:102
Player timer callbacks.
Definition: vlc_player.h:3111
Definition: vlc_es.h:605
vlc_es_id_t * es
Definition: player.h:161
VLC value structure.
Definition: vlc_common.h:455
size_t title_selected
Definition: player.h:90
float position
Definition: player.h:66
void * cbs_data
Definition: player.h:125
enum vlc_vout_order vout_order
Definition: player.h:38
Definition: player.h:138
Definition: renderer_discovery.c:34
vlc_atomic_rc_t rc
Definition: player.h:49
const char var[sizeof("video")]
Definition: player.c:1699
es_format_category_e
ES Categories.
Definition: vlc_es.h:600
struct vlc_player_input * input
Definition: player.h:226
bool start_paused
Definition: player.h:210
vlc_renderer_item_t * renderer
Definition: player.h:223
This provides convenience helpers for linked lists.
struct vlc_player_title_list * vlc_player_title_list_Create(input_title_t *const *array, size_t count, int title_offset, int chapter_offset)
Definition: title.c:98
void vlc_player_input_HandleState(struct vlc_player_input *, enum vlc_player_state, vlc_tick_t state_date)
Definition: input.c:126
void vlc_player_DestroyTimer(vlc_player_t *player)
Definition: timer.c:535
Player program structure.
Definition: vlc_player.h:1159
Definition: player.h:122
int64_t vlc_tick_t
High precision date or time interval.
Definition: vlc_tick.h:45
void vlc_player_UpdateMLStates(vlc_player_t *player, struct vlc_player_input *input)
Definition: medialib.c:113
struct vlc_player_track_priv * vlc_player_track_vector_FindById(vlc_player_track_vector *vec, vlc_es_id_t *id, size_t *idx)
Definition: track.c:193
void vlc_player_input_RestoreMlStates(struct vlc_player_input *input, const input_item_t *item)
Definition: medialib.c:30
static const char * es_format_category_to_string(enum es_format_category_e cat)
Definition: player.h:285
vlc_player_media_stopped_action
Action when the player is stopped.
Definition: vlc_player.h:96
void * cbs_data
Definition: player.h:132
vlc_player_whence
Player seek/delay directive.
Definition: vlc_player.h:316
Atomic operations do not require locking, but they are not very powerful.
Definition: player.h:47
input_thread_t * thread
Definition: player.h:56
struct vlc_object_marker * obj
Definition: vlc_objects.h:48
float vlc_player_input_GetPos(struct vlc_player_input *input)
Definition: input.c:73
int capabilities
Definition: player.h:63
Definition: player.h:115
bool pause_on_cork
Definition: player.h:215
Definition: vlc_es.h:603
Thread handle.
Definition: vlc_threads.h:263
vlc_tick_t period
Definition: player.h:145
Definition: vlc_es.h:617
int default_subtitle_track
Definition: player.h:111
unsigned frame_rate_base
Definition: player.h:168
vlc_tick_t time
Definition: player.h:67
Player callbacks.
Definition: vlc_player.h:2568
vlc_tick_t last_ts
Definition: player.h:193
size_t count
Definition: core.c:402
Video output thread descriptor.
Definition: vlc_vout.h:60
Definition: player.h:139
vlc_player_track_vector spu_track_vector
Definition: player.h:85
bool next_media_requested
Definition: player.h:229
Definition: player.h:158
Definition: player.h:41
Definition: player.h:44
#define VLC_VECTOR(type)
Vector struct body.
Definition: vlc_vector.h:65
input_item_t * next_media
Definition: player.h:230
void vlc_player_UpdateTimer(vlc_player_t *player, vlc_es_id_t *es_source, bool es_source_is_master, const struct vlc_player_timer_point *point, vlc_tick_t normal_time, unsigned frame_rate, unsigned frame_rate_base)
Definition: timer.c:254
struct vlc_player_title_list * titles
Definition: player.h:88
Player title structure.
Definition: vlc_player.h:941
const struct vlc_player_timer_cbs * cbs
Definition: player.h:150
int vlc_player_OpenNextMedia(vlc_player_t *player)
Definition: player.c:69
static vlc_player_track_vector * vlc_player_input_GetTrackVector(struct vlc_player_input *input, enum es_format_category_e cat)
Definition: player.h:362
float rate
Definition: player.h:62
vlc_ml_playback_states_all states
Definition: player.h:108
Opaque structure representing an ES (Elementary Stream) track.
Definition: es_out.c:88
unsigned frame_rate
Definition: player.h:167
bool corked
Definition: player.h:216
const char name[16]
Definition: httpd.c:1236
pthread_cond_t vlc_cond_t
Condition variable.
Definition: vlc_threads.h:290
void vlc_player_aout_DelCallbacks(vlc_player_t *player)
Definition: aout.c:210
bool started
Definition: player.h:233
vlc_player_timer_source_type
Definition: player.h:136
void vlc_player_InitTimer(vlc_player_t *player)
Definition: timer.c:521
void vlc_player_track_priv_Delete(struct vlc_player_track_priv *trackpriv)
Definition: track.c:138
bool teletext_transparent
Definition: player.h:96
bool started
Definition: player.h:58
vlc_vout_order
vout or spu_channel order
Definition: vlc_vout.h:78
vlc_tick_t input_length
Definition: player.h:191
static struct vlc_player_input * vlc_player_get_input_locked(vlc_player_t *player)
Definition: player.h:269
int vlc_player_vout_OSDCallback(vlc_object_t *this, const char *var, vlc_value_t oldval, vlc_value_t newval, void *data)
Definition: osd.c:239
Main structure representing an input thread.
Definition: input_internal.h:47
Definition: player.h:140
vlc_tick_t length
Definition: player.h:64
vlc_mutex_t lock
Definition: player.h:204
Definition: player.h:143
Definition: player.h:181
Definition: vlc_media_library.h:505
bool seeking
Definition: player.h:189
const struct vlc_player_timer_smpte_cbs * smpte_cbs
Definition: player.h:151
vlc_player_track_vector video_track_vector
Definition: player.h:83
void vlc_player_destructor_AddStoppingInput(vlc_player_t *player, struct vlc_player_input *input)
Definition: player.c:154
Definition: vlc_es.h:606
void vlc_player_input_Delete(struct vlc_player_input *input)
Definition: input.c:918
vlc_cond_t start_delay_cond
Definition: player.h:207
vlc_cond_t notify
Definition: player.h:242
vlc_tick_t pause_date
Definition: player.h:70
Doubly-linked list node.
Definition: vlc_list.h:43
unsigned df_fps
Definition: player.h:170
void vlc_player_aout_AddCallbacks(vlc_player_t *player)
Definition: aout.c:196
This provides convenience helpers for vectors.
float position
Position in the range [0.0f;1.0].
Definition: vlc_player.h:3069
int default_video_track
Definition: player.h:109
vlc_player_state
State of the player.
Definition: vlc_player.h:243
struct vlc_player_track_priv * teletext_menu
Definition: player.h:86
Definition: vlc_input_item.h:504
void vlc_player_osd_Volume(vlc_player_t *player, bool mute_action)
Definition: osd.c:169
void vlc_player_osd_Track(vlc_player_t *player, vlc_es_id_t *id, bool select)
Definition: osd.c:189
void * media_provider_data
Definition: player.h:213
void vlc_player_ResetTimer(vlc_player_t *player)
Definition: timer.c:30
int frames_per_10mins
Definition: player.h:172
size_t count
Definition: player.h:50
input_resource_t * resource
Definition: player.h:222
VLC object common members.
Definition: vlc_objects.h:43
void vlc_player_osd_Message(vlc_player_t *player, const char *fmt,...)
Definition: osd.c:88
struct vlc_player_track_priv * vlc_player_track_priv_New(vlc_es_id_t *id, const char *name, const es_format_t *fmt)
Definition: track.c:106
int vlc_player_program_Update(struct vlc_player_program *prgm, int id, const char *name)
Definition: track.c:60
void vlc_player_UpdateTimerState(vlc_player_t *player, vlc_es_id_t *es_source, enum vlc_player_timer_state state, vlc_tick_t system_date)
Definition: timer.c:175
Callbacks for the owner of the player.
Definition: vlc_player.h:117
input_item_t * media
Definition: player.h:225
Definition: vlc_input.h:94
const struct vlc_player_vout_cbs * cbs
Definition: player.h:124
float input_position
Definition: player.h:194
struct vlc_player_track t
Definition: player.h:34
void vlc_player_vout_DelCallbacks(vlc_player_t *player, vout_thread_t *vout)
Definition: vout.c:147
void * data
Definition: player.h:153
vlc_player_t * player
Definition: player.h:57
vlc_mutex_t lock
Definition: player.h:186
float cache
Definition: player.h:76
int df
Definition: player.h:171