VLC 4.0.0-dev
Loading...
Searching...
No Matches
decoder.h
Go to the documentation of this file.
1/*****************************************************************************
2 * decoder.h: Input decoder functions
3 *****************************************************************************
4 * Copyright (C) 1998-2008 VLC authors and VideoLAN
5 * Copyright (C) 2008 Laurent Aimar
6 *
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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_INPUT_DECODER_H
25#define LIBVLC_INPUT_DECODER_H 1
26
27#include <vlc_common.h>
28#include <vlc_codec.h>
29#include <vlc_mouse.h>
30
32 /* notifications */
34 enum vlc_vout_order vout_order,
35 void *userdata);
37 void *userdata);
39 void *userdata);
40
41 void (*on_new_video_stats)(vlc_input_decoder_t *decoder, unsigned decoded,
42 unsigned lost, unsigned displayed, unsigned late,
43 void *userdata);
44 void (*on_new_audio_stats)(vlc_input_decoder_t *decoder, unsigned decoded,
45 unsigned lost, unsigned played, void *userdata);
46
47 /* requests */
49 input_attachment_t ***ppp_attachment,
50 void *userdata);
51};
52
65
68 const struct vlc_input_decoder_cfg *cfg );
69
70/**
71 * This function changes the pause state.
72 * The date parameter MUST hold the exact date at which the change has been
73 * done for proper vout/aout pausing.
74 */
75void vlc_input_decoder_ChangePause( vlc_input_decoder_t *, bool b_paused, vlc_tick_t i_date );
76
77/**
78 * Changes the decoder rate.
79 *
80 * This function changes rate of the intended playback speed to nominal speed.
81 * \param dec decoder
82 * \param rate playback rate (default is 1)
83 */
85
86/**
87 * This function makes the decoder start waiting for a valid data block from its fifo.
88 */
90
91/**
92 * This function waits for the decoder to actually receive data.
93 */
95
96/**
97 * This function exits the waiting mode of the decoder.
98 */
100
101/**
102 * This function returns true if the decoder fifo is empty and false otherwise.
103 */
105
106/**
107 * This function Creates and adds the requested SubDec.
108 *
109 * The sub decoder returned by this function must be deleted with
110 * vlc_input_decoder_Delete() before the parent is deleted.
111 */
114 const struct vlc_input_decoder_cfg *cfg);
115
116/**
117 * This function forces the display of the next picture
118 */
120
126
127void vlc_subdec_desc_Clean(struct vlc_subdec_desc *desc);
128
130{
131 struct {
132 /* True if the ES format or meta data have changed since the last call.
133 * */
135 /* If changed is true, a copy of the current es_format_t, MUST be freed
136 * with es_format_Clean() */
138 /* If changed is true, a copy of the current description, can be NULL,
139 * MUST be freed with vlc_meta_Delete.() */
142
144};
145
146/**
147 * Get the last status of the decoder.
148 */
150 vlc_frame_t *frame, bool do_pace,
151 struct vlc_input_decoder_status *status);
152
153/**
154 * This function returns the current size in bytes of the decoder fifo
155 */
157
161
165
166#endif
void vlc_input_decoder_StopWait(vlc_input_decoder_t *)
This function exits the waiting mode of the decoder.
Definition decoder.c:2663
int vlc_input_decoder_DelVoutOverlay(vlc_input_decoder_t *, size_t)
Definition decoder.c:2801
void vlc_subdec_desc_Clean(struct vlc_subdec_desc *desc)
Definition decoder.c:2330
void vlc_input_decoder_DecodeWithStatus(vlc_input_decoder_t *p_dec, vlc_frame_t *frame, bool do_pace, struct vlc_input_decoder_status *status)
Get the last status of the decoder.
Definition decoder.c:2419
vlc_input_decoder_t * vlc_input_decoder_CreateSubDec(vlc_input_decoder_t *dec, const struct vlc_input_decoder_cfg *cfg)
This function Creates and adds the requested SubDec.
Definition decoder.c:2590
void vlc_input_decoder_StartWait(vlc_input_decoder_t *)
This function makes the decoder start waiting for a valid data block from its fifo.
Definition decoder.c:2647
void vlc_input_decoder_ChangePause(vlc_input_decoder_t *, bool b_paused, vlc_tick_t i_date)
This function changes the pause state.
Definition decoder.c:2619
size_t vlc_input_decoder_GetFifoSize(vlc_input_decoder_t *p_dec)
This function returns the current size in bytes of the decoder fifo.
Definition decoder.c:2721
void vlc_input_decoder_FrameNext(vlc_input_decoder_t *p_dec)
This function forces the display of the next picture.
Definition decoder.c:2703
vlc_input_decoder_t * vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg)
Spawns a new decoder thread from the input thread.
Definition decoder.c:2263
int vlc_input_decoder_AddVoutOverlay(vlc_input_decoder_t *, subpicture_t *, size_t *)
Definition decoder.c:2771
int vlc_input_decoder_GetVbiPage(vlc_input_decoder_t *, bool *opaque)
Definition decoder.c:2732
void vlc_input_decoder_Wait(vlc_input_decoder_t *)
This function waits for the decoder to actually receive data.
Definition decoder.c:2676
void vlc_input_decoder_ChangeRate(vlc_input_decoder_t *dec, float rate)
Changes the decoder rate.
Definition decoder.c:2633
void vlc_input_decoder_SetVoutMouseEvent(vlc_input_decoder_t *, vlc_mouse_event, void *)
Definition decoder.c:2757
bool vlc_input_decoder_IsEmpty(vlc_input_decoder_t *)
This function returns true if the decoder fifo is empty and false otherwise.
Definition decoder.c:2470
int vlc_input_decoder_SetVbiOpaque(vlc_input_decoder_t *, bool opaque)
Definition decoder.c:2749
int vlc_input_decoder_SetVbiPage(vlc_input_decoder_t *, unsigned page)
Definition decoder.c:2741
vlc_vout_order
vout or spu_channel order
Definition vlc_vout.h:70
input_type
Definition input_internal.h:50
Definition vlc_es.h:633
Definition vlc_input.h:169
Definition resource.c:58
Video picture.
Definition vlc_picture.h:130
Definition vlc_sout.h:274
Video subtitle.
Definition vlc_subpicture.h:234
Definition clock.c:88
Definition vlc_frame.h:123
Definition decoder.h:31
void(* on_new_video_stats)(vlc_input_decoder_t *decoder, unsigned decoded, unsigned lost, unsigned displayed, unsigned late, void *userdata)
Definition decoder.h:41
int(* get_attachments)(vlc_input_decoder_t *decoder, input_attachment_t ***ppp_attachment, void *userdata)
Definition decoder.h:48
void(* on_vout_started)(vlc_input_decoder_t *decoder, vout_thread_t *vout, enum vlc_vout_order vout_order, void *userdata)
Definition decoder.h:33
void(* on_new_audio_stats)(vlc_input_decoder_t *decoder, unsigned decoded, unsigned lost, unsigned played, void *userdata)
Definition decoder.h:44
void(* on_vout_stopped)(vlc_input_decoder_t *decoder, vout_thread_t *vout, void *userdata)
Definition decoder.h:36
void(* on_thumbnail_ready)(vlc_input_decoder_t *decoder, picture_t *pic, void *userdata)
Definition decoder.h:38
Definition decoder.h:54
const es_format_t * fmt
Definition decoder.h:55
input_resource_t * resource
Definition decoder.h:58
unsigned cc_decoder
Definition decoder.h:61
sout_stream_t * sout
Definition decoder.h:59
const struct vlc_input_decoder_callbacks * cbs
Definition decoder.h:62
vlc_clock_t * clock
Definition decoder.h:57
const char * str_id
Definition decoder.h:56
enum input_type input_type
Definition decoder.h:60
void * cbs_data
Definition decoder.h:63
Definition decoder.h:130
es_format_t fmt
Definition decoder.h:137
vlc_meta_t * meta
Definition decoder.h:140
bool changed
Definition decoder.h:134
struct vlc_subdec_desc subdec_desc
Definition decoder.h:143
struct vlc_input_decoder_status::@16 format
Definition decoder.c:117
Definition meta.c:40
VLC object common members.
Definition vlc_objects.h:53
Definition decoder.h:122
size_t fmt_count
Definition decoder.h:124
es_format_t * fmt_array
Definition decoder.h:123
Video output thread descriptor.
Definition vlc_vout.h:54
Decoder and encoder modules interface.
This file is a collection of common definitions and types.
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