]> git.sesse.net Git - vlc/blob - src/control/libvlc_internal.h
libvlc: Rename input to media_instance. And add the possibility to create a medi_inst...
[vlc] / src / control / libvlc_internal.h
1 /*****************************************************************************
2  * libvlc_internal.h : Definition of opaque structures for libvlc exported API
3  * Also contains some internal utility functions
4  *****************************************************************************
5  * Copyright (C) 2005 the VideoLAN team
6  * $Id: control_structures.h 13752 2005-12-15 10:14:42Z oaubert $
7  *
8  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef _LIBVLC_INTERNAL_H
26 #define _LIBVLC_INTERNAL_H 1
27
28 # ifdef __cplusplus
29 extern "C" {
30 # endif
31
32 #include <vlc/vlc.h>
33 #include <vlc/libvlc_structures.h>
34
35 #include <vlc_input.h>
36     
37 /***************************************************************************
38  * Internal creation and destruction functions
39  ***************************************************************************/
40 VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
41 VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, char *ppsz_argv[] ) );
42 VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
43 VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, vlc_bool_t ) );
44
45 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
46                             vlc_bool_t, int, const char *const * ) );
47
48 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *, libvlc_exception_t * ) );
49 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *, libvlc_exception_t * ) );
50
51 /***************************************************************************
52  * Opaque structures for libvlc API
53  ***************************************************************************/
54
55 struct libvlc_callback_entry_t
56 {
57     libvlc_instance_t *p_instance;
58     libvlc_callback_t f_callback;
59     libvlc_event_type_t i_event_type;
60     void *p_user_data;
61 };
62
63 struct libvlc_callback_entry_list_t
64 {
65     struct libvlc_callback_entry_t *elmt;
66     struct libvlc_callback_entry_list_t *next;
67     struct libvlc_callback_entry_list_t *prev;
68 };
69     
70 struct libvlc_instance_t
71 {
72     libvlc_int_t *p_libvlc_int;
73     vlm_t        *p_vlm;
74     int           b_playlist_locked;
75     vlc_mutex_t   instance_lock;
76     vlc_mutex_t   event_callback_lock;
77     struct libvlc_callback_entry_list_t *p_callback_list;
78 };
79
80 struct libvlc_media_descriptor_t
81 {
82     int                b_preparsed;
83     input_item_t      *p_input_item;
84     libvlc_instance_t *p_libvlc_instance;
85 };
86
87 struct libvlc_media_instance_t
88 {
89     int i_input_id;  /* Input object id. We don't use a pointer to
90                         avoid any crash */
91     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
92     libvlc_media_descriptor_t *p_md; /* current media descriptor */
93 };
94
95 /***************************************************************************
96  * Other internal functions
97  ***************************************************************************/
98 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
99                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
100
101 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
102                         ( struct libvlc_instance_t *, input_thread_t * ) );
103
104 VLC_EXPORT (void, libvlc_media_instance_destroy_and_detach,
105                         ( libvlc_media_instance_t * ) );
106
107 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
108                         ( struct libvlc_instance_t *, input_item_t * ) );
109
110 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
111                         ( libvlc_media_descriptor_t * ) );
112
113 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
114                                 return NULL; }
115 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
116                                 return; }
117 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
118                                 return 0; }
119
120 # ifdef __cplusplus
121 }
122 # endif
123
124 #endif