0c528ebc89a324f2cf02203ddd154363e1bf126f
[vlc.git] / bindings / java / core / src / main / java / org / videolan / jvlc / internal / LibVlc.java
1 /*****************************************************************************
2  * LibVlc.java: VLC Java Bindings JNA Glue
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
5  *
6  * Authors: Filippo Carone <filippo@carone.org>
7  *
8  *
9  * $Id $
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
24  *****************************************************************************/
25
26 package org.videolan.jvlc.internal;
27
28 import com.sun.jna.Callback;
29 import com.sun.jna.Library;
30 import com.sun.jna.Native;
31 import com.sun.jna.NativeLong;
32 import com.sun.jna.Platform;
33 import com.sun.jna.Pointer;
34 import com.sun.jna.PointerType;
35 import com.sun.jna.Structure;
36 import com.sun.jna.Union;
37
38
39 public interface LibVlc extends Library
40 {
41     LibVlc INSTANCE = (LibVlc) Native.loadLibrary(Platform.isWindows()? "libvlc" : "vlc", LibVlc.class);
42
43     LibVlc SYNC_INSTANCE = (LibVlc) Native.synchronizedLibrary(INSTANCE);
44     
45     public static class libvlc_exception_t extends Structure
46     {
47
48         public int raised;
49
50         public int code;
51
52         public String message;
53     }
54
55     public static class libvlc_log_message_t extends Structure
56     {
57
58         public int sizeof_msg; /* sizeof() of message structure, must be filled in by user */
59
60         public int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
61
62         public String psz_type; /* module type */
63
64         public String psz_name; /* module name */
65
66         public String psz_header; /* optional header */
67
68         public String psz_message; /* message */
69     }
70
71     public static class libvlc_event_t extends Structure
72     {
73
74         public int type;
75
76         public Pointer obj;
77
78         public event_type_specific event_type_specific;
79
80     }
81
82     public class media_meta_changed extends Structure
83     {
84
85         public Pointer meta_type;
86     }
87
88     public class media_subitem_added extends Structure
89     {
90
91         public LibVlcMediaDescriptor new_child;
92     }
93
94     public class media_duration_changed extends Structure
95     {
96
97         public NativeLong new_duration;
98     }
99
100     public class media_preparsed_changed extends Structure
101     {
102
103         public int new_status;
104     }
105
106     public class media_freed extends Structure
107     {
108
109         public LibVlcMediaDescriptor md;
110     }
111
112     public class media_state_changed extends Structure
113     {
114
115         // @todo: check this one
116         public int new_state;
117     }
118
119     /* media instance */
120
121     public class media_player_position_changed extends Structure
122     {
123
124         public float new_position;
125     }
126
127     public class media_player_time_changed extends Structure
128     {
129
130         // @todo: check this one
131         public long new_time;
132     }
133
134     /* media list */
135     public class media_list_item_added extends Structure
136     {
137
138         public LibVlcMediaDescriptor item;
139
140         public int index;
141     }
142
143     public class media_list_will_add_item extends Structure
144     {
145
146         public LibVlcMediaDescriptor item;
147
148         public int index;
149     }
150
151     public class media_list_item_deleted extends Structure
152     {
153
154         public LibVlcMediaDescriptor item;
155
156         public int index;
157     }
158
159     public class media_list_will_delete_item extends Structure
160     {
161
162         public LibVlcMediaDescriptor item;
163
164         public int index;
165     }
166
167     /* media list view */
168     public class media_list_view_item_added extends Structure
169     {
170
171         public LibVlcMediaDescriptor item;
172
173         public int index;
174     }
175
176     public class media_list_view_will_add_item extends Structure
177     {
178
179         public LibVlcMediaDescriptor item;
180
181         public int index;
182     }
183
184     public class media_list_view_item_deleted extends Structure
185     {
186
187         public LibVlcMediaDescriptor item;
188
189         public int index;
190     }
191
192     public class media_list_view_will_delete_item extends Structure
193     {
194
195         public LibVlcMediaDescriptor item;
196
197         public int index;
198     }
199
200     /* media discoverer */
201     public class media_media_discoverer_started extends Structure
202     {
203
204         public Pointer unused;
205     }
206
207     public class media_media_discoverer_ended extends Structure
208     {
209
210         public Pointer unused;
211     }
212
213     public class event_type_specific extends Union
214     {
215
216         public media_meta_changed media_meta_changed;
217
218         public media_subitem_added media_subitem_added;
219
220         public media_duration_changed media_duration_changed;
221
222         public media_preparsed_changed media_preparsed_changed;
223
224         public media_freed media_freed;
225
226         public media_state_changed media_state_changed;
227
228         public media_player_position_changed media_player_position_changed;
229
230         public media_player_time_changed media_player_time_changed;
231
232         public media_list_item_added media_list_item_added;
233
234         public media_list_will_add_item media_list_will_add_item;
235
236         public media_list_item_deleted media_list_item_deleted;
237
238         public media_list_will_delete_item media_list_will_delete_item;
239
240         public media_list_view_item_added media_list_view_item_added;
241
242         public media_list_view_will_add_item media_list_view_will_add_item;
243
244         public media_list_view_item_deleted media_list_view_item_deleted;
245
246         public media_list_view_will_delete_item media_list_view_will_delete_item;
247     }
248
249     public class LibVlcInstance extends PointerType
250     {
251     }
252
253     public class LibVlcMediaDescriptor extends PointerType
254     {
255     }
256
257     public class LibVlcMediaInstance extends PointerType
258     {
259     }
260
261     public class LibVlcMediaList extends PointerType
262     {
263     }
264
265     public class LibVlcMediaListPlayer extends PointerType
266     {
267     }
268
269     public class LibVlcEventManager extends PointerType
270     {
271     }
272
273     public class LibVlcLog extends PointerType
274     {
275     }
276
277     public class LibVlcLogIterator extends PointerType
278     {
279     }
280
281     // exception handling
282     void libvlc_exception_init(libvlc_exception_t exception);
283
284     int libvlc_exception_raised(final libvlc_exception_t exception);
285
286     void libvlc_exception_raise(libvlc_exception_t exception, String format, Object... args);
287
288     void libvlc_exception_clear(libvlc_exception_t exception);
289
290     String libvlc_exception_get_message(libvlc_exception_t exception);
291
292     // core
293     LibVlcInstance libvlc_new(int argc, String[] argv, libvlc_exception_t exception);
294
295     void libvlc_release(LibVlcInstance libvlc_instance_t);
296     
297     String libvlc_get_version();
298     
299     String libvlc_get_compiler();
300     
301     String libvlc_get_changeset();
302
303     // video
304
305     void libvlc_video_set_parent(LibVlcInstance libvlc_instance, long drawable, libvlc_exception_t exception);
306
307     void libvlc_toggle_fullscreen(LibVlcMediaInstance libvlc_instance);
308
309     void libvlc_set_fullscreen(LibVlcMediaInstance instance, int fullscreen, libvlc_exception_t exception);
310
311     int libvlc_get_fullscreen(LibVlcMediaInstance instance, libvlc_exception_t exception);
312
313     int libvlc_video_get_height(LibVlcMediaInstance instance, libvlc_exception_t exception);
314
315     int libvlc_video_get_width(LibVlcMediaInstance instance, libvlc_exception_t exception);
316
317     String libvlc_video_get_aspect_ration(LibVlcMediaInstance instance, libvlc_exception_t exception);
318
319     void libvlc_video_set_aspect_ration(LibVlcMediaInstance instance, String ratio, libvlc_exception_t exception);
320
321     int libvlc_video_get_spu(LibVlcMediaInstance instance, libvlc_exception_t exception);
322
323     int libvlc_video_set_spu(LibVlcMediaInstance instance, int spu, libvlc_exception_t exception);
324
325     String libvlc_video_get_crop_geometry(LibVlcMediaInstance instance, libvlc_exception_t exception);
326
327     void libvlc_video_set_crop_geometry(LibVlcMediaInstance instance, String geometry, libvlc_exception_t exception);
328
329     void libvlc_video_take_snapshot(LibVlcMediaInstance instance, String filename, int width, int height,
330         libvlc_exception_t exception);
331
332     void libvlc_video_destroy(LibVlcMediaInstance instance, libvlc_exception_t exception);
333
334     void libvlc_video_resize(LibVlcMediaInstance instance, int width, int height, libvlc_exception_t exception);
335
336     void libvlc_video_reparent(LibVlcMediaInstance instance, long drawable, libvlc_exception_t exception);
337
338     void libvlc_video_set_size(LibVlcInstance instance, int width, int height, libvlc_exception_t exception);
339
340     // audio
341
342     void libvlc_audio_toggle_mute(LibVlcInstance instance, libvlc_exception_t exception);
343
344     void libvlc_audio_set_mute(LibVlcInstance instance, int mute, libvlc_exception_t exception);
345
346     int libvlc_audio_get_mute(LibVlcInstance instance, libvlc_exception_t exception);
347
348     int libvlc_audio_get_volume(LibVlcInstance instance, libvlc_exception_t exception);
349
350     int libvlc_audio_set_volume(LibVlcInstance instance, int volume, libvlc_exception_t exception);
351
352     int libvlc_audio_get_track_count(LibVlcMediaInstance mediaInstance, libvlc_exception_t exception);
353
354     int libvlc_audio_get_track(LibVlcMediaInstance mediaInstance, libvlc_exception_t exception);
355
356     void libvlc_audio_set_track(LibVlcMediaInstance mediaInstance, int channel, libvlc_exception_t exception);
357
358     int libvlc_audio_get_channel(LibVlcInstance instance, libvlc_exception_t exception);
359
360     void libvlc_audio_set_channel(LibVlcInstance instance, int channel, libvlc_exception_t exception);
361
362     // playlist
363
364     void libvlc_playlist_loop(LibVlcInstance instance, int loop, libvlc_exception_t exception);
365
366     void libvlc_playlist_play(LibVlcInstance instance, int itemIndex, int optionsCount, String[] options,
367         libvlc_exception_t exception);
368
369     void libvlc_playlist_pause(LibVlcInstance instance, libvlc_exception_t exception);
370
371     void libvlc_playlist_stop(LibVlcInstance instance, libvlc_exception_t exception);
372
373     int libvlc_playlist_isplaying(LibVlcInstance instance, libvlc_exception_t exception);
374
375     int libvlc_playlist_items_count(LibVlcInstance instance, libvlc_exception_t exception);
376
377     void libvlc_playlist_next(LibVlcInstance instance, libvlc_exception_t exception);
378
379     void libvlc_playlist_prev(LibVlcInstance instance, libvlc_exception_t exception);
380
381     void libvlc_playlist_clear(LibVlcInstance instance, libvlc_exception_t exception);
382
383     int libvlc_playlist_add(LibVlcInstance instance, String uri, String name, libvlc_exception_t exception);
384
385     int libvlc_playlist_delete_item(LibVlcInstance instance, int itemIndex, libvlc_exception_t exception);
386
387     LibVlcMediaInstance libvlc_playlist_get_media_player(LibVlcInstance instance, libvlc_exception_t exception);
388
389     int libvlc_media_player_is_seekable(LibVlcMediaInstance instance, libvlc_exception_t exception);
390
391     int libvlc_media_player_can_pause(LibVlcMediaInstance instance, libvlc_exception_t exception);
392
393     // media descriptor
394
395     LibVlcMediaDescriptor libvlc_media_new(LibVlcInstance libvlc_instance, String mrl, libvlc_exception_t exception);
396
397     void libvlc_media_add_option(LibVlcMediaDescriptor media, String option, libvlc_exception_t exception);
398
399     String libvlc_media_get_mrl(LibVlcMediaDescriptor media);
400
401     void libvlc_media_release(LibVlcMediaDescriptor media);
402
403     LibVlcEventManager libvlc_media_event_manager(LibVlcMediaDescriptor media, libvlc_exception_t exception);
404
405     // media player
406
407     LibVlcMediaInstance libvlc_media_player_new(LibVlcInstance instance, libvlc_exception_t exception);
408
409     LibVlcMediaInstance libvlc_media_player_new_from_media(LibVlcMediaDescriptor media, libvlc_exception_t exception);
410
411     void libvlc_media_player_play(LibVlcMediaInstance media_player, libvlc_exception_t exception);
412
413     void libvlc_media_player_pause(LibVlcMediaInstance media_player, libvlc_exception_t exception);
414
415     void libvlc_media_player_stop(LibVlcMediaInstance media_player, libvlc_exception_t exception);
416
417     void libvlc_media_player_set_drawable(LibVlcMediaInstance libvlc_media_player, int drawable,
418         libvlc_exception_t exception);
419
420     long libvlc_media_player_get_length(LibVlcMediaInstance instance, libvlc_exception_t exception);
421
422     long libvlc_media_player_get_time(LibVlcMediaInstance instance, libvlc_exception_t exception);
423
424     void libvlc_media_player_set_time(LibVlcMediaInstance instance, long time, libvlc_exception_t exception);
425
426     float libvlc_media_player_get_position(LibVlcMediaInstance instance, libvlc_exception_t exception);
427
428     void libvlc_media_player_set_position(LibVlcMediaInstance instance, float position, libvlc_exception_t exception);
429
430     int libvlc_media_player_will_play(LibVlcMediaInstance instance, libvlc_exception_t exception);
431
432     void libvlc_media_player_set_rate(LibVlcMediaInstance instance, float rate, libvlc_exception_t exception);
433
434     float libvlc_media_player_get_rate(LibVlcMediaInstance instance, libvlc_exception_t exception);
435
436     int libvlc_media_player_has_vout(LibVlcMediaInstance instance2, libvlc_exception_t exception);
437
438     float libvlc_media_player_get_fps(LibVlcMediaInstance instance2, libvlc_exception_t exception);
439
440     void libvlc_media_player_release(LibVlcMediaInstance instance);
441
442     LibVlcEventManager libvlc_media_player_event_manager(LibVlcMediaInstance media_player, libvlc_exception_t exception);
443
444     // media list
445
446     LibVlcMediaList libvlc_media_list_new(LibVlcInstance libvlc_instance, libvlc_exception_t exception);
447
448     void libvlc_media_list_release(LibVlcMediaList libVlcMediaList);
449
450     void libvlc_media_list_add_file_content(LibVlcMediaList libvlc_media_list, String fileName,
451         libvlc_exception_t exception);
452
453     void libvlc_media_list_set_media(LibVlcMediaList libvlc_media_list, LibVlcMediaDescriptor libvlc_media,
454         libvlc_exception_t exception);
455
456     LibVlcMediaDescriptor libvlc_media_list_media(LibVlcMediaList libvlc_media_list, libvlc_exception_t exception);
457
458     void libvlc_media_list_add_media(LibVlcMediaList libvlc_media_list, LibVlcMediaDescriptor libvlc_media,
459         libvlc_exception_t exception);
460
461     void libvlc_media_list_insert_media(LibVlcMediaList libvlc_media_list, LibVlcMediaDescriptor libvlc_media,
462         int position, libvlc_exception_t exception);
463
464     void libvlc_media_list_remove_index(LibVlcMediaList libvlc_media_list, int position, libvlc_exception_t exception);
465
466     int libvlc_media_list_count(LibVlcMediaList libvlc_media_list, libvlc_exception_t exception);
467
468     LibVlcMediaDescriptor libvlc_media_list_item_at_index(LibVlcMediaList libvlc_media_list, int position,
469         libvlc_exception_t exception);
470
471     int libvlc_media_list_index_of_item(LibVlcMediaList libvlc_media_list, LibVlcMediaDescriptor libvlc_media,
472         libvlc_exception_t exception);
473
474     int libvlc_media_list_is_readonly(LibVlcMediaList libvlc_media_list);
475
476     LibVlcEventManager libvlc_media_list_event_manager(LibVlcMediaList libvlc_media_list, libvlc_exception_t exception);
477
478     // libvlc_media_list_player
479
480     LibVlcMediaListPlayer libvlc_media_list_player_new(LibVlcInstance libvlc_media_player, libvlc_exception_t exception);
481
482     void libvlc_media_list_player_release(LibVlcMediaListPlayer libvlc_media_list_player);
483
484     void libvlc_media_list_player_set_media_player(LibVlcMediaListPlayer libvlc_media_list_player,
485         LibVlcMediaInstance libvlc_media_player, libvlc_exception_t exception);
486
487     void libvlc_media_list_player_set_media_list(LibVlcMediaListPlayer libvlc_media_list_player,
488         LibVlcMediaList libvlc_media_list, libvlc_exception_t exception);
489
490     void libvlc_media_list_player_play(LibVlcMediaListPlayer libvlc_media_list_player, libvlc_exception_t exception);
491
492     void libvlc_media_list_player_pause(LibVlcMediaListPlayer libvlc_media_list_player, libvlc_exception_t exception);
493
494     int libvlc_media_list_player_is_playing(LibVlcMediaListPlayer libvlc_media_list_player, libvlc_exception_t exception);
495
496     int libvlc_media_list_player_get_state(LibVlcMediaListPlayer libvlc_media_list_player, libvlc_exception_t exception);
497
498     void libvlc_media_list_player_play_item_at_index(LibVlcMediaListPlayer libvlc_media_list_player, int position,
499         libvlc_exception_t exception);
500
501     void libvlc_media_list_player_play_item(LibVlcMediaListPlayer libvlc_media_list_player,
502         LibVlcMediaDescriptor libvlc_media, libvlc_exception_t exception);
503
504     void libvlc_media_list_player_stop(LibVlcMediaListPlayer libvlc_media_list_player, libvlc_exception_t exception);
505
506     void libvlc_media_list_player_next(LibVlcMediaListPlayer libvlc_media_list_player, libvlc_exception_t exception);
507
508     // VLM
509
510     void libvlc_vlm_add_broadcast(LibVlcInstance p_instance, String psz_name, String psz_input, String psz_output,
511         int i_options, String[] ppsz_options, int b_enabled, int b_loop, libvlc_exception_t p_e);
512
513     void libvlc_vlm_add_vod(LibVlcInstance p_instance, String psz_name, String psz_input, int i_options,
514         String[] ppsz_options, int b_enabled, String psz_mux, libvlc_exception_t p_e);
515
516     void libvlc_vlm_del_media(LibVlcInstance p_instance, String psz_name, libvlc_exception_t p_e);
517
518     void libvlc_vlm_set_enabled(LibVlcInstance p_instance, String psz_name, int b_enabled, libvlc_exception_t p_e);
519
520     void libvlc_vlm_set_output(LibVlcInstance p_instance, String psz_name, String psz_output, libvlc_exception_t p_e);
521
522     void libvlc_vlm_set_input(LibVlcInstance p_instance, String psz_name, String psz_input, libvlc_exception_t p_e);
523
524     void libvlc_vlm_add_input(LibVlcInstance p_instance, String psz_name, String psz_input, libvlc_exception_t p_e);
525
526     void libvlc_vlm_set_loop(LibVlcInstance p_instance, String psz_name, int b_loop, libvlc_exception_t p_e);
527
528     void libvlc_vlm_set_mux(LibVlcInstance p_instance, String psz_name, String psz_mux, libvlc_exception_t p_e);
529
530     void libvlc_vlm_change_media(LibVlcInstance p_instance, String psz_name, String psz_input, String psz_output,
531         int i_options, String[] ppsz_options, int b_enabled, int b_loop, libvlc_exception_t p_e);
532
533     void libvlc_vlm_play_media(LibVlcInstance p_instance, String psz_name, libvlc_exception_t p_e);
534
535     void libvlc_vlm_stop_media(LibVlcInstance p_instance, String psz_name, libvlc_exception_t p_e);
536
537     void libvlc_vlm_pause_media(LibVlcInstance p_instance, String psz_name, libvlc_exception_t p_e);
538
539     void libvlc_vlm_seek_media(LibVlcInstance p_instance, String psz_name, float f_percentage, libvlc_exception_t p_e);
540
541     String libvlc_vlm_show_media(LibVlcInstance p_instance, String psz_name, libvlc_exception_t p_e);
542
543     void libvlc_vlm_release(LibVlcInstance p_instance, libvlc_exception_t p_e);
544
545     // event manager
546
547     public static interface LibVlcCallback extends Callback
548     {
549
550         void callback(libvlc_event_t libvlc_event, Pointer userData);
551     }
552
553     void libvlc_event_attach(LibVlcEventManager event_manager, int event_type, LibVlcCallback callback,
554         Pointer userData, libvlc_exception_t exception);
555
556     void libvlc_event_detach(LibVlcEventManager event_manager, int event_type, LibVlcCallback callback,
557         Pointer userData, libvlc_exception_t excecption);
558
559     void libvlc_toggle_fullscreen(LibVlcMediaInstance instance, libvlc_exception_t exception);
560
561     // logging
562
563     int libvlc_get_log_verbosity(LibVlcInstance p_instance, libvlc_exception_t p_e);
564
565     void libvlc_set_log_verbosity(LibVlcInstance p_instance, int level, libvlc_exception_t p_e);
566
567     LibVlcLog libvlc_log_open(LibVlcInstance p_instance, libvlc_exception_t p_e);
568
569     void libvlc_log_close(LibVlcLog p_log, libvlc_exception_t p_e);
570
571     int libvlc_log_count(LibVlcLog p_log, libvlc_exception_t p_e);
572
573     void libvlc_log_clear(LibVlcLog p_log, libvlc_exception_t p_e);
574
575     LibVlcLogIterator libvlc_log_get_iterator(LibVlcLog p_log, libvlc_exception_t p_e);
576
577     void libvlc_log_iterator_free(LibVlcLogIterator p_iter, libvlc_exception_t p_e);
578
579     int libvlc_log_iterator_has_next(LibVlcLogIterator p_iter, libvlc_exception_t p_e);
580
581     libvlc_log_message_t libvlc_log_iterator_next(LibVlcLogIterator p_iter, libvlc_log_message_t p_buffer,
582         libvlc_exception_t p_e);
583
584 }