1 /*****************************************************************************
2 * vlc_vlm.h: VLM core structures
3 *****************************************************************************
4 * Copyright (C) 2000, 2001 the VideoLAN team
7 * Authors: Simon Latapie <garf@videolan.org>
8 * Laurent Aimar <fenrir@videolan.org>
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.
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.
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 *****************************************************************************/
30 * This file defines VLM core functions and structures in vlc
33 #include <vlc_input.h>
36 * \defgroup server VLM
37 * VLM is the server core in vlc that allows streaming of multiple media streams
38 * at the same time. It provides broadcast, schedule and video on demand features
39 * for streaming using several streaming and network protocols.
46 int64_t id
; /*< numeric id for vlm_media_t item */
47 bool b_enabled
; /*< vlm_media_t is enabled */
49 char *psz_name
; /*< descriptive name of vlm_media_t item */
51 int i_input
; /*< number of input options */
52 char **ppsz_input
; /*< array of input options */
54 int i_option
; /*< number of output options */
55 char **ppsz_option
; /*< array of output options */
57 char *psz_output
; /*< */
59 bool b_vod
; /*< vlm_media_t is of type VOD */
62 bool b_loop
; /*< this vlc_media_t broadcast item should loop */
63 } broadcast
; /*< Broadcast specific information */
66 char *psz_mux
; /*< name of muxer to use */
67 } vod
; /*< VOD specific information */
71 /** VLM media instance */
74 char *psz_name
; /*< vlm media instance descriptive name */
76 int64_t i_time
; /*< vlm media instance vlm media current time */
77 int64_t i_length
; /*< vlm media instance vlm media item length */
78 double d_position
; /*< vlm media instance position in stream */
79 bool b_paused
; /*< vlm media instance is paused */
80 int i_rate
; // normal is INPUT_RATE_DEFAULT
81 } vlm_media_instance_t
;
91 * You can catch vlm event by adding a callback on the variable "intf-event"
93 * This variable is an address that will hold a vlm_event_t* value.
98 VLM_EVENT_MEDIA_ADDED
= 0x100,
99 VLM_EVENT_MEDIA_REMOVED
,
100 VLM_EVENT_MEDIA_CHANGED
,
103 VLM_EVENT_MEDIA_INSTANCE_STARTED
= 0x200,
104 VLM_EVENT_MEDIA_INSTANCE_STOPPED
,
105 VLM_EVENT_MEDIA_INSTANCE_STATE
,
110 int i_type
; /* a vlm_event_type_e value */
111 int64_t id
; /* Media ID */
112 const char *psz_name
; /* Media name */
113 const char *psz_instance_name
; /* Instance name or NULL */
114 input_state_e input_state
; /* Input instance event type */
117 /** VLM control query */
120 /* --- Media control */
122 VLM_GET_MEDIAS
, /* arg1=vlm_media_t ***, int *pi_media */
123 /* Delete all medias */
124 VLM_CLEAR_MEDIAS
, /* no arg */
126 /* Add a new media */
127 VLM_ADD_MEDIA
, /* arg1=vlm_media_t* arg2=int64_t *p_id res=can fail */
128 /* Delete an existing media */
129 VLM_DEL_MEDIA
, /* arg1=int64_t id */
130 /* Change properties of an existing media (all fields but id and b_vod) */
131 VLM_CHANGE_MEDIA
, /* arg1=vlm_media_t* res=can fail */
132 /* Get 1 media by it's ID */
133 VLM_GET_MEDIA
, /* arg1=int64_t id arg2=vlm_media_t ** */
134 /* Get media ID from its name */
135 VLM_GET_MEDIA_ID
, /* arg1=const char *psz_name arg2=int64_t* */
137 /* Media instance control XXX VOD control are for internal use only */
138 /* Get all media instances */
139 VLM_GET_MEDIA_INSTANCES
, /* arg1=int64_t id arg2=vlm_media_instance_t *** arg3=int *pi_instance */
140 /* Delete all media instances */
141 VLM_CLEAR_MEDIA_INSTANCES
, /* arg1=int64_t id */
142 /* Control broadcast instance */
143 VLM_START_MEDIA_BROADCAST_INSTANCE
, /* arg1=int64_t id, arg2=const char *psz_instance_name, int i_input_index res=can fail */
144 /* Control VOD instance */
145 VLM_START_MEDIA_VOD_INSTANCE
, /* arg1=int64_t id, arg2=const char *psz_instance_name, int i_input_index char *psz_vod_output res=can fail */
146 /* Stop an instance */
147 VLM_STOP_MEDIA_INSTANCE
, /* arg1=int64_t id, arg2=const char *psz_instance_name res=can fail */
148 /* Pause an instance */
149 VLM_PAUSE_MEDIA_INSTANCE
, /* arg1=int64_t id, arg2=const char *psz_instance_name res=can fail */
150 /* Get instance position time (in microsecond) */
151 VLM_GET_MEDIA_INSTANCE_TIME
, /* arg1=int64_t id, arg2=const char *psz_instance_name arg3=int64_t * */
152 /* Set instance position time (in microsecond) */
153 VLM_SET_MEDIA_INSTANCE_TIME
, /* arg1=int64_t id, arg2=const char *psz_instance_name arg3=int64_t */
154 /* Get instance position ([0.0 .. 1.0]) */
155 VLM_GET_MEDIA_INSTANCE_POSITION
, /* arg1=int64_t id, arg2=const char *psz_instance_name arg3=double * */
156 /* Set instance position ([0.0 .. 1.0]) */
157 VLM_SET_MEDIA_INSTANCE_POSITION
, /* arg1=int64_t id, arg2=const char *psz_instance_name arg3=double */
159 /* Schedule control */
160 VLM_CLEAR_SCHEDULES
, /* no arg */
161 /* TODO: missing schedule control */
167 /* VLM specific - structures and functions */
169 /* ok, here is the structure of a vlm_message:
170 The parent node is ( name_of_the_command , NULL ), or
171 ( name_of_the_command , message_error ) on error.
172 If a node has children, it should not have a value (=NULL).*/
175 char *psz_name
; /*< message name */
176 char *psz_value
; /*< message value */
178 int i_child
; /*< number of child messages */
179 vlm_message_t
**child
; /*< array of vlm_message_t */
187 #define vlm_New( a ) __vlm_New( VLC_OBJECT(a) )
188 VLC_EXPORT( vlm_t
*, __vlm_New
, ( vlc_object_t
* ) );
189 VLC_EXPORT( void, vlm_Delete
, ( vlm_t
* ) );
190 VLC_EXPORT( int, vlm_ExecuteCommand
, ( vlm_t
*, const char *, vlm_message_t
** ) );
191 VLC_EXPORT( int, vlm_Control
, ( vlm_t
*p_vlm
, int i_query
, ... ) );
193 VLC_EXPORT( vlm_message_t
*, vlm_MessageSimpleNew
, ( const char * ) );
194 VLC_EXPORT( vlm_message_t
*, vlm_MessageNew
, ( const char *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
195 VLC_EXPORT( vlm_message_t
*, vlm_MessageAdd
, ( vlm_message_t
*, vlm_message_t
* ) );
196 VLC_EXPORT( void, vlm_MessageDelete
, ( vlm_message_t
* ) );
201 * Initialize a vlm_media_t instance
202 * \param p_media vlm_media_t instance to initialize
204 static inline void vlm_media_Init( vlm_media_t
*p_media
)
206 memset( p_media
, 0, sizeof(vlm_media_t
) );
207 p_media
->id
= 0; // invalid id
208 p_media
->psz_name
= NULL
;
209 TAB_INIT( p_media
->i_input
, p_media
->ppsz_input
);
210 TAB_INIT( p_media
->i_option
, p_media
->ppsz_option
);
211 p_media
->psz_output
= NULL
;
212 p_media
->b_vod
= false;
214 p_media
->vod
.psz_mux
= NULL
;
215 p_media
->broadcast
.b_loop
= false;
219 * Copy a vlm_media_t instance into another vlm_media_t instance
220 * \param p_dst vlm_media_t instance to copy to
221 * \param p_src vlm_media_t instance to copy from
223 static inline void vlm_media_Copy( vlm_media_t
*p_dst
, vlm_media_t
*p_src
)
227 memset( p_dst
, 0, sizeof(vlm_media_t
) );
228 p_dst
->id
= p_src
->id
;
229 p_dst
->b_enabled
= p_src
->b_enabled
;
230 if( p_src
->psz_name
)
231 p_dst
->psz_name
= strdup( p_src
->psz_name
);
233 for( i
= 0; i
< p_src
->i_input
; i
++ )
234 TAB_APPEND_CPP( char, p_dst
->i_input
, p_dst
->ppsz_input
, strdup(p_src
->ppsz_input
[i
]) );
235 for( i
= 0; i
< p_src
->i_option
; i
++ )
236 TAB_APPEND_CPP( char, p_dst
->i_option
, p_dst
->ppsz_option
, strdup(p_src
->ppsz_option
[i
]) );
238 if( p_src
->psz_output
)
239 p_dst
->psz_output
= strdup( p_src
->psz_output
);
241 p_dst
->b_vod
= p_src
->b_vod
;
244 if( p_src
->vod
.psz_mux
)
245 p_dst
->vod
.psz_mux
= strdup( p_src
->vod
.psz_mux
);
249 p_dst
->broadcast
.b_loop
= p_src
->broadcast
.b_loop
;
254 * Cleanup and release memory associated with this vlm_media_t instance.
255 * You still need to release p_media itself with vlm_media_Delete().
256 * \param p_media vlm_media_t to cleanup
258 static inline void vlm_media_Clean( vlm_media_t
*p_media
)
261 free( p_media
->psz_name
);
263 for( i
= 0; i
< p_media
->i_input
; i
++ )
264 free( p_media
->ppsz_input
[i
]) ;
265 TAB_CLEAN(p_media
->i_input
, p_media
->ppsz_input
);
267 for( i
= 0; i
< p_media
->i_option
; i
++ )
268 free( p_media
->ppsz_option
[i
]) ;
269 TAB_CLEAN(p_media
->i_option
, p_media
->ppsz_option
);
271 free( p_media
->psz_output
);
273 free( p_media
->vod
.psz_mux
);
277 * Allocate a new vlm_media_t instance
278 * \return vlm_media_t instance
280 static inline vlm_media_t
*vlm_media_New(void)
282 vlm_media_t
*p_media
= (vlm_media_t
*)malloc( sizeof(vlm_media_t
) );
284 vlm_media_Init( p_media
);
289 * Delete a vlm_media_t instance
290 * \param p_media vlm_media_t instance to delete
292 static inline void vlm_media_Delete( vlm_media_t
*p_media
)
294 vlm_media_Clean( p_media
);
299 * Copy a vlm_media_t instance
300 * \param p_src vlm_media_t instance to copy
301 * \return vlm_media_t duplicate of p_src
303 static inline vlm_media_t
*vlm_media_Duplicate( vlm_media_t
*p_src
)
305 vlm_media_t
*p_dst
= vlm_media_New();
307 vlm_media_Copy( p_dst
, p_src
);
311 /* media instance helpers */
313 * Initialize vlm_media_instance_t
314 * \param p_instance vlm_media_instance_t to initialize
316 static inline void vlm_media_instance_Init( vlm_media_instance_t
*p_instance
)
318 memset( p_instance
, 0, sizeof(vlm_media_instance_t
) );
319 p_instance
->psz_name
= NULL
;
320 p_instance
->i_time
= 0;
321 p_instance
->i_length
= 0;
322 p_instance
->d_position
= 0.0;
323 p_instance
->b_paused
= false;
324 p_instance
->i_rate
= INPUT_RATE_DEFAULT
;
328 * Cleanup vlm_media_instance_t
329 * \param p_instance vlm_media_instance_t to cleanup
331 static inline void vlm_media_instance_Clean( vlm_media_instance_t
*p_instance
)
333 free( p_instance
->psz_name
);
337 * Allocate a new vlm_media_instance_t
338 * \return a new vlm_media_instance_t
340 static inline vlm_media_instance_t
*vlm_media_instance_New(void)
342 vlm_media_instance_t
*p_instance
= (vlm_media_instance_t
*) malloc( sizeof(vlm_media_instance_t
) );
344 vlm_media_instance_Init( p_instance
);
349 * Delete a vlm_media_instance_t
350 * \param p_instance vlm_media_instance_t to delete
352 static inline void vlm_media_instance_Delete( vlm_media_instance_t
*p_instance
)
354 vlm_media_instance_Clean( p_instance
);