1 /*****************************************************************************
2 * vlc_instance.c: vlc.Instance binding
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
7 * Authors: Olivier Aubert <oaubert at bat710.univ-lyon1.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 /* Helper functions */
27 pyoptions_to_args(PyObject *py_options, char*** pppsz_args)
31 char** ppsz_args = *pppsz_args;
35 Py_INCREF( py_options );
36 if( ! PySequence_Check( py_options ) )
38 PyErr_SetString( PyExc_TypeError, "Parameter must be a sequence." );
41 i_size = PySequence_Size( py_options );
42 ppsz_args = malloc( ( i_size + 1 ) * sizeof( char * ) );
45 PyErr_SetString( PyExc_MemoryError, "Out of memory" );
49 for ( i_index = 0; i_index < i_size; i_index++ )
52 strdup( PyString_AsString( PyObject_Str(
53 PySequence_GetItem( py_options,
56 ppsz_args[i_size] = NULL;
57 Py_DECREF( py_options );
62 free_args(int i_size, char** ppsz_args)
66 for ( i_index = 0; i_index < i_size; i_index++ )
67 if( ppsz_args[i_index] )
68 free(ppsz_args[i_index]);
72 /*****************************************************************************
73 * Instance object implementation
74 *****************************************************************************/
77 vlcInstance_new( PyTypeObject *type, PyObject *args, PyObject *kwds )
80 libvlc_exception_t ex;
81 PyObject* py_list = NULL;
82 char** ppsz_args = NULL;
85 if( PyArg_ParseTuple( args, "O", &py_list ) )
87 i_size = pyoptions_to_args( py_list, &ppsz_args );
93 /* No arguments were given. Clear the exception raised
94 by PyArg_ParseTuple. */
98 self = PyObject_New( vlcInstance, &vlcInstance_Type );
100 Py_BEGIN_ALLOW_THREADS
102 LIBVLC_INSTANCE->p_instance = libvlc_new( i_size, ppsz_args, &ex );
103 free_args( i_size, ppsz_args );
108 return ( PyObject * )self;
112 vlcInstance_dealloc( PyObject *self )
114 libvlc_release( LIBVLC_INSTANCE->p_instance );
115 PyObject_DEL( self );
119 vlcInstance_get_vlc_id( PyObject *self, PyObject *args )
121 return Py_BuildValue( "i", libvlc_get_vlc_id( LIBVLC_INSTANCE->p_instance ) );
124 /* Set loop variable */
126 vlcInstance_playlist_loop( PyObject *self, PyObject *args )
128 libvlc_exception_t ex;
131 if( !PyArg_ParseTuple( args, "i", &i_loop ) )
135 libvlc_playlist_loop( LIBVLC_INSTANCE->p_instance, i_loop, &ex );
138 Py_INCREF( Py_None );
142 /* Playlist play. 2 parameters: i_id, the id to play
143 l_options: a list of options */
145 vlcInstance_playlist_play( PyObject *self, PyObject *args )
147 libvlc_exception_t ex;
149 PyObject *py_options = NULL;
151 char** ppsz_args = NULL;
153 if( !PyArg_ParseTuple( args, "|iO", &i_id, &py_options ) )
158 i_size = pyoptions_to_args( py_options, &ppsz_args );
162 libvlc_playlist_play( LIBVLC_INSTANCE->p_instance, i_id, i_size, ppsz_args, &ex );
163 free_args( i_size, ppsz_args );
166 Py_INCREF( Py_None );
171 vlcInstance_playlist_pause( PyObject *self, PyObject *args )
173 libvlc_exception_t ex;
175 libvlc_playlist_pause( LIBVLC_INSTANCE->p_instance, &ex );
177 Py_INCREF( Py_None );
182 vlcInstance_playlist_isplaying( PyObject *self, PyObject *args )
184 libvlc_exception_t ex;
188 i_ret = libvlc_playlist_isplaying( LIBVLC_INSTANCE->p_instance, &ex );
190 return Py_BuildValue( "i", i_ret );
194 vlcInstance_playlist_items_count( PyObject *self, PyObject *args )
196 libvlc_exception_t ex;
200 i_ret = libvlc_playlist_items_count( LIBVLC_INSTANCE->p_instance, &ex );
202 return Py_BuildValue( "i", i_ret );
206 vlcInstance_playlist_stop( PyObject *self, PyObject *args )
208 libvlc_exception_t ex;
210 libvlc_playlist_stop( LIBVLC_INSTANCE->p_instance, &ex );
212 Py_INCREF( Py_None );
217 vlcInstance_playlist_next( PyObject *self, PyObject *args )
219 libvlc_exception_t ex;
221 libvlc_playlist_next( LIBVLC_INSTANCE->p_instance, &ex );
223 Py_INCREF( Py_None );
228 vlcInstance_playlist_prev( PyObject *self, PyObject *args )
230 libvlc_exception_t ex;
232 libvlc_playlist_prev( LIBVLC_INSTANCE->p_instance, &ex );
234 Py_INCREF( Py_None );
239 vlcInstance_playlist_clear( PyObject *self, PyObject *args )
241 libvlc_exception_t ex;
243 libvlc_playlist_clear( LIBVLC_INSTANCE->p_instance, &ex );
245 Py_INCREF( Py_None );
249 /* Add a playlist item. Main parameter: URI.
250 Optional parameters: name, options */
252 vlcInstance_playlist_add( PyObject *self, PyObject *args)
254 libvlc_exception_t ex;
256 char* psz_uri = NULL;
257 char* psz_name = NULL;
258 PyObject *py_options = NULL;
260 char** ppsz_args = NULL;
262 if( !PyArg_ParseTuple( args, "s|sO", &psz_uri, &psz_name, &py_options ) )
267 /* Set a default name */
268 psz_name = strdup( psz_uri );
273 i_size = pyoptions_to_args( py_options, &ppsz_args );
279 i_ret = libvlc_playlist_add_extended( LIBVLC_INSTANCE->p_instance,
285 free_args( i_size, ppsz_args );
289 i_ret = libvlc_playlist_add( LIBVLC_INSTANCE->p_instance,
296 return Py_BuildValue( "i", i_ret );
300 vlcInstance_playlist_delete_item( PyObject *self, PyObject *args )
302 libvlc_exception_t ex;
306 if( !PyArg_ParseTuple( args, "i", &i_id ) )
310 i_ret = libvlc_playlist_delete_item( LIBVLC_INSTANCE->p_instance, i_id, &ex );
313 return Py_BuildValue( "i", i_ret );
317 vlcInstance_playlist_get_media_instance( PyObject *self, PyObject *args )
319 libvlc_exception_t ex;
320 libvlc_media_instance_t *p_mi;
321 vlcMediaInstance *p_ret;
324 p_mi = libvlc_playlist_get_media_instance( LIBVLC_INSTANCE->p_instance, &ex );
327 p_ret = PyObject_New( vlcMediaInstance, &vlcMediaInstance_Type );
329 Py_INCREF( p_ret ); /* Ah bon ? */
330 return ( PyObject * )p_ret;
334 vlcInstance_video_set_parent( PyObject *self, PyObject *args )
336 libvlc_exception_t ex;
339 if( !PyArg_ParseTuple( args, "i", &i_drawable ) )
343 libvlc_video_set_parent( LIBVLC_INSTANCE->p_instance, (libvlc_drawable_t) i_drawable, &ex );
346 Py_INCREF( Py_None );
351 vlcInstance_video_get_parent( PyObject *self, PyObject *args )
353 libvlc_exception_t ex;
354 libvlc_drawable_t i_ret;
357 i_ret = libvlc_video_get_parent( LIBVLC_INSTANCE->p_instance, &ex );
360 return Py_BuildValue( "L", i_ret );
364 vlcInstance_video_set_size( PyObject *self, PyObject *args )
366 libvlc_exception_t ex;
370 if( !PyArg_ParseTuple( args, "ii", &i_width, &i_height ) )
374 libvlc_video_set_size( LIBVLC_INSTANCE->p_instance, i_width, i_height, &ex );
377 Py_INCREF( Py_None );
382 vlcInstance_audio_toggle_mute( PyObject *self, PyObject *args )
384 libvlc_exception_t ex;
386 libvlc_audio_toggle_mute( LIBVLC_INSTANCE->p_instance, &ex );
388 Py_INCREF( Py_None );
393 vlcInstance_audio_get_mute( PyObject *self, PyObject *args )
395 libvlc_exception_t ex;
399 i_ret = libvlc_audio_get_mute( LIBVLC_INSTANCE->p_instance, &ex );
401 return Py_BuildValue( "i", i_ret );
405 vlcInstance_audio_set_mute( PyObject *self, PyObject *args )
407 libvlc_exception_t ex;
410 if( !PyArg_ParseTuple( args, "i", &i_mute ) )
414 libvlc_audio_set_mute( LIBVLC_INSTANCE->p_instance, i_mute, &ex );
416 Py_INCREF( Py_None );
421 vlcInstance_audio_get_volume( PyObject *self, PyObject *args )
423 libvlc_exception_t ex;
427 i_ret = libvlc_audio_get_volume( LIBVLC_INSTANCE->p_instance, &ex );
429 return Py_BuildValue( "i", i_ret );
433 vlcInstance_audio_set_volume( PyObject *self, PyObject *args )
435 libvlc_exception_t ex;
438 if( !PyArg_ParseTuple( args, "i", &i_volume ) )
442 libvlc_audio_set_volume( LIBVLC_INSTANCE->p_instance, i_volume, &ex );
444 Py_INCREF( Py_None );
449 vlcInstance_audio_get_channel( PyObject *self, PyObject *args )
451 libvlc_exception_t ex;
455 i_ret = libvlc_audio_get_channel( LIBVLC_INSTANCE->p_instance, &ex );
457 return Py_BuildValue( "i", i_ret );
461 vlcInstance_audio_set_channel( PyObject *self, PyObject *args )
463 libvlc_exception_t ex;
466 if( !PyArg_ParseTuple( args, "i", &i_channel ) )
470 libvlc_audio_set_channel( LIBVLC_INSTANCE->p_instance, i_channel, &ex );
472 Py_INCREF( Py_None );
476 /* vlm_add_broadcast : name, input MRL, output MRL
477 Keywords: options, enable, loop */
479 vlcInstance_vlm_add_broadcast( PyObject *self, PyObject *args, PyObject *kwds )
481 libvlc_exception_t ex;
482 static char *kwlist[] = { "name", "input", "output",
483 "options", "enable", "loop", NULL};
484 char* psz_name = NULL;
485 char* psz_input = NULL;
486 char* psz_output = NULL;
487 PyObject* py_options = NULL;
491 char** ppsz_args = NULL;
493 if( !PyArg_ParseTupleAndKeywords( args, kwds, "sss|Oii", kwlist,
495 &psz_input, &psz_output,
496 &py_options, &i_enable, &i_loop ) )
501 i_size = pyoptions_to_args( py_options, &ppsz_args );
505 libvlc_vlm_add_broadcast( LIBVLC_INSTANCE->p_instance,
506 psz_name, psz_input, psz_output,
507 i_size, ppsz_args, i_enable, i_loop, &ex);
508 free_args( i_size, ppsz_args );
510 Py_INCREF( Py_None );
515 vlcInstance_vlm_del_media( PyObject *self, PyObject *args )
517 libvlc_exception_t ex;
520 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
524 libvlc_vlm_del_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
526 Py_INCREF( Py_None );
531 vlcInstance_vlm_set_enabled( PyObject *self, PyObject *args )
533 libvlc_exception_t ex;
537 if( !PyArg_ParseTuple( args, "si", &psz_name, &i_enabled ) )
541 libvlc_vlm_set_enabled( LIBVLC_INSTANCE->p_instance, psz_name, i_enabled, &ex);
543 Py_INCREF( Py_None );
548 vlcInstance_vlm_set_output( PyObject *self, PyObject *args )
550 libvlc_exception_t ex;
554 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_output ) )
558 libvlc_vlm_set_output( LIBVLC_INSTANCE->p_instance, psz_name, psz_output, &ex);
560 Py_INCREF( Py_None );
565 vlcInstance_vlm_set_input( PyObject *self, PyObject *args )
567 libvlc_exception_t ex;
571 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_input ) )
575 libvlc_vlm_set_input( LIBVLC_INSTANCE->p_instance, psz_name, psz_input, &ex);
577 Py_INCREF( Py_None );
582 vlcInstance_vlm_add_input( PyObject *self, PyObject *args )
584 libvlc_exception_t ex;
588 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_input ) )
592 libvlc_vlm_add_input( LIBVLC_INSTANCE->p_instance, psz_name, psz_input, &ex);
594 Py_INCREF( Py_None );
599 vlcInstance_vlm_set_loop( PyObject *self, PyObject *args )
601 libvlc_exception_t ex;
605 if( !PyArg_ParseTuple( args, "si", &psz_name, &i_loop ) )
609 libvlc_vlm_set_loop( LIBVLC_INSTANCE->p_instance, psz_name, i_loop, &ex);
611 Py_INCREF( Py_None );
616 vlcInstance_vlm_change_media( PyObject *self, PyObject *args, PyObject *kwds )
618 libvlc_exception_t ex;
619 static char *kwlist[] = { "name", "input", "output",
620 "options", "enable", "loop", NULL};
621 char* psz_name = NULL;
622 char* psz_input = NULL;
623 char* psz_output = NULL;
624 PyObject* py_options = NULL;
628 char** ppsz_args = NULL;
630 if( !PyArg_ParseTupleAndKeywords( args, kwds, "sss|Oii", kwlist,
632 &psz_input, &psz_output,
633 &py_options, &i_enable, &i_loop ) )
638 i_size = pyoptions_to_args( py_options, &ppsz_args );
642 libvlc_vlm_change_media( LIBVLC_INSTANCE->p_instance,
643 psz_name, psz_input, psz_output,
644 i_size, ppsz_args, i_enable, i_loop, &ex);
645 free_args( i_size, ppsz_args );
647 Py_INCREF( Py_None );
652 vlcInstance_vlm_play_media( PyObject *self, PyObject *args )
654 libvlc_exception_t ex;
657 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
661 libvlc_vlm_play_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
663 Py_INCREF( Py_None );
668 vlcInstance_vlm_stop_media( PyObject *self, PyObject *args )
670 libvlc_exception_t ex;
673 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
677 libvlc_vlm_stop_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
679 Py_INCREF( Py_None );
684 vlcInstance_vlm_pause_media( PyObject *self, PyObject *args )
686 libvlc_exception_t ex;
689 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
693 libvlc_vlm_pause_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
695 Py_INCREF( Py_None );
700 vlcInstance_vlm_seek_media( PyObject *self, PyObject *args )
702 libvlc_exception_t ex;
706 if( !PyArg_ParseTuple( args, "sf", &psz_name, &f_percentage ) )
710 libvlc_vlm_seek_media( LIBVLC_INSTANCE->p_instance, psz_name, f_percentage, &ex);
712 Py_INCREF( Py_None );
717 vlcInstance_vlm_show_media( PyObject *self, PyObject *args )
719 libvlc_exception_t ex;
724 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
727 psz_ret = libvlc_vlm_show_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex );
729 o_ret = Py_BuildValue( "s", psz_ret );
735 vlcInstance_media_descriptor_new( PyObject *self, PyObject *args )
737 libvlc_exception_t ex;
738 libvlc_media_descriptor_t *p_md;
739 char* psz_mrl = NULL;
740 vlcMediaDescriptor *p_ret;
742 if( !PyArg_ParseTuple( args, "s", &psz_mrl ) )
746 p_md = libvlc_media_descriptor_new( LIBVLC_INSTANCE->p_instance, psz_mrl, &ex );
749 p_ret = PyObject_New( vlcMediaDescriptor, &vlcMediaDescriptor_Type );
751 Py_INCREF( p_ret ); /* Ah bon ? */
752 return ( PyObject * )p_ret;
756 static PyMethodDef vlcInstance_methods[] =
758 { "get_vlc_id", vlcInstance_get_vlc_id, METH_VARARGS,
759 "get_vlc_id( ) -> int Get the instance id."},
760 { "playlist_loop", vlcInstance_playlist_loop, METH_VARARGS,
761 "playlist_loop(bool) Set loop variable" },
762 { "playlist_play", vlcInstance_playlist_play, METH_VARARGS,
763 "playlist_play(id=int, options=list) Play the given playlist item (-1 for current item) with optional options (a list of strings)" },
764 { "playlist_pause", vlcInstance_playlist_pause, METH_VARARGS,
765 "playlist_pause() Pause the current stream"},
766 { "playlist_isplaying", vlcInstance_playlist_isplaying, METH_VARARGS,
767 "playlist_isplaying() -> int Return True if the playlist if playing"},
768 { "playlist_items_count", vlcInstance_playlist_items_count, METH_VARARGS,
769 "playlist_items_count() -> int Return the number of items in the playlist"},
770 { "playlist_stop", vlcInstance_playlist_stop, METH_VARARGS,
771 "playlist_stop() Stop the current stream"},
772 { "playlist_next", vlcInstance_playlist_next, METH_VARARGS,
773 "playlist_next() Play the next item"},
774 { "playlist_prev", vlcInstance_playlist_prev, METH_VARARGS,
775 "playlist_prev() Play the previous item"},
776 { "playlist_clear", vlcInstance_playlist_clear, METH_VARARGS,
777 "playlist_clear() Clear the playlist"},
778 { "playlist_add", vlcInstance_playlist_add, METH_VARARGS,
779 "playlist_add(mrl=str, name=str, options=list) -> int Add a new item to the playlist. options is a list of strings."},
780 { "playlist_delete_item", vlcInstance_playlist_delete_item, METH_VARARGS,
781 "playlist_delete_item(id=int) Delete the given item"},
782 { "playlist_get_media_instance", vlcInstance_playlist_get_media_instance, METH_VARARGS,
783 "playlist_get_media_instance() -> object Return the current media instance"},
784 { "video_set_parent", vlcInstance_video_set_parent, METH_VARARGS,
785 "video_set_parent(xid=int) Set the parent xid/HWND/CGrafPort"},
786 { "video_get_parent", vlcInstance_video_get_parent, METH_VARARGS,
787 "video_get_parent(xid=int) Get the parent xid/HWND/CGrafPort"},
788 { "video_set_size", vlcInstance_video_set_size, METH_VARARGS,
789 "video_set_size(width=int, height=int) Set the video width and height"},
790 { "audio_toggle_mute", vlcInstance_audio_toggle_mute, METH_VARARGS,
791 "audio_toggle_mute() Toggle the mute state"},
792 { "audio_get_mute", vlcInstance_audio_get_mute, METH_VARARGS,
793 "audio_get_mute() -> int Get the mute state"},
794 { "audio_set_mute", vlcInstance_audio_set_mute, METH_VARARGS,
795 "audio_set_mute(state=int) Set the mute state"},
796 { "audio_get_volume", vlcInstance_audio_get_volume, METH_VARARGS,
797 "audio_get_volume() -> int Get the audio volume"},
798 { "audio_set_volume", vlcInstance_audio_set_volume, METH_VARARGS,
799 "audio_set_volume(volume=int) Set the audio volume"},
800 { "audio_get_channel", vlcInstance_audio_get_channel, METH_VARARGS,
801 "audio_get_channel() -> int Get current audio channel" },
802 { "audio_set_channel", vlcInstance_audio_set_channel, METH_VARARGS,
803 "audio_set_channel(int) Set current audio channel" },
805 { "media_descriptor_new", vlcInstance_media_descriptor_new, METH_VARARGS,
806 "media_descriptor_new(str) -> object Create a media descriptor with the given mrl."},
808 { "vlm_add_broadcast", vlcInstance_vlm_add_broadcast, METH_VARARGS | METH_KEYWORDS,
809 "vlm_add_broadcast(name=str, input=str, output=str, options=list, enable=int, loop=int) Add a new broadcast" },
810 { "vlm_del_media", vlcInstance_vlm_del_media, METH_VARARGS,
811 "vlm_del_media(name=str) Delete a media" },
812 { "vlm_set_enabled", vlcInstance_vlm_set_enabled, METH_VARARGS,
813 "vlm_set_enabled(name=str, enabled=int) Enable/disable a media" },
814 { "vlm_set_output", vlcInstance_vlm_set_output, METH_VARARGS,
815 "vlm_set_output(name=str, output=str) Set the output" },
816 { "vlm_set_input", vlcInstance_vlm_set_input, METH_VARARGS,
817 "vlm_set_input(name=str, output=str) Set the input" },
818 { "vlm_add_input", vlcInstance_vlm_add_input, METH_VARARGS,
819 "vlm_add_input(name=str, output=str) Add a media's input MRL" },
820 { "vlm_set_loop", vlcInstance_vlm_set_loop, METH_VARARGS,
821 "vlm_set_loop(name=str, loop=int) Change the looping value" },
822 { "vlm_change_media", vlcInstance_vlm_change_media, METH_VARARGS | METH_KEYWORDS,
823 "vlm_change_media(name=str, input=str, output=str, options=list, enable=int, loop=int) Change the broadcast parameters" },
824 { "vlm_play_media", vlcInstance_vlm_play_media, METH_VARARGS,
825 "vlm_play_media(name=str) Plays the named broadcast." },
826 { "vlm_stop_media", vlcInstance_vlm_stop_media, METH_VARARGS,
827 "vlm_stop_media(name=str) Stops the named broadcast." },
828 { "vlm_pause_media", vlcInstance_vlm_pause_media, METH_VARARGS,
829 "vlm_pause_media(name=str) Pauses the named broadcast." },
830 { "vlm_seek_media", vlcInstance_vlm_seek_media, METH_VARARGS,
831 "vlm_seek_media(name=str, percentage=float) Seeks in the named broadcast." },
832 { "vlm_show_media", vlcInstance_vlm_show_media, METH_VARARGS,
833 "vlm_show_media(name=str) Return information of the named broadcast." },
835 { NULL, NULL, 0, NULL },
838 static PyTypeObject vlcInstance_Type =
840 PyObject_HEAD_INIT( NULL )
842 "vlc.Instance", /*tp_name*/
843 sizeof( vlcInstance_Type ), /*tp_basicsize*/
845 ( destructor )vlcInstance_dealloc, /*tp_dealloc*/
852 0, /*tp_as_sequence*/
860 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
861 "VLC Instance(args)\n\nNote: if args is specified, the first arg is interpreted as an executable name to get the directory of the VLC plugins.", /* tp_doc */
864 0, /* tp_richcompare */
865 0, /* tp_weaklistoffset */
868 vlcInstance_methods, /* tp_methods */
873 0, /* tp_descr_get */
874 0, /* tp_descr_set */
875 0, /* tp_dictoffset */
878 vlcInstance_new, /* tp_new */