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_exception_t ex;
115 libvlc_release( LIBVLC_INSTANCE->p_instance, &ex );
116 PyObject_DEL( self );
120 vlcInstance_get_vlc_id( PyObject *self, PyObject *args )
122 return Py_BuildValue( "i", libvlc_get_vlc_id( LIBVLC_INSTANCE->p_instance ) );
125 /* Set loop variable */
127 vlcInstance_playlist_loop( PyObject *self, PyObject *args )
129 libvlc_exception_t ex;
132 if( !PyArg_ParseTuple( args, "i", &i_loop ) )
136 libvlc_playlist_loop( LIBVLC_INSTANCE->p_instance, i_loop, &ex );
139 Py_INCREF( Py_None );
143 /* Playlist play. 2 parameters: i_id, the id to play
144 l_options: a list of options */
146 vlcInstance_playlist_play( PyObject *self, PyObject *args )
148 libvlc_exception_t ex;
150 PyObject *py_options = NULL;
152 char** ppsz_args = NULL;
154 if( !PyArg_ParseTuple( args, "|iO", &i_id, &py_options ) )
159 i_size = pyoptions_to_args( py_options, &ppsz_args );
163 libvlc_playlist_play( LIBVLC_INSTANCE->p_instance, i_id, i_size, ppsz_args, &ex );
164 free_args( i_size, ppsz_args );
167 Py_INCREF( Py_None );
172 vlcInstance_playlist_pause( PyObject *self, PyObject *args )
174 libvlc_exception_t ex;
176 libvlc_playlist_pause( LIBVLC_INSTANCE->p_instance, &ex );
178 Py_INCREF( Py_None );
183 vlcInstance_playlist_isplaying( PyObject *self, PyObject *args )
185 libvlc_exception_t ex;
189 i_ret = libvlc_playlist_isplaying( LIBVLC_INSTANCE->p_instance, &ex );
191 return Py_BuildValue( "i", i_ret );
195 vlcInstance_playlist_items_count( PyObject *self, PyObject *args )
197 libvlc_exception_t ex;
201 i_ret = libvlc_playlist_items_count( LIBVLC_INSTANCE->p_instance, &ex );
203 return Py_BuildValue( "i", i_ret );
207 vlcInstance_playlist_stop( PyObject *self, PyObject *args )
209 libvlc_exception_t ex;
211 libvlc_playlist_stop( LIBVLC_INSTANCE->p_instance, &ex );
213 Py_INCREF( Py_None );
218 vlcInstance_playlist_next( PyObject *self, PyObject *args )
220 libvlc_exception_t ex;
222 libvlc_playlist_next( LIBVLC_INSTANCE->p_instance, &ex );
224 Py_INCREF( Py_None );
229 vlcInstance_playlist_prev( PyObject *self, PyObject *args )
231 libvlc_exception_t ex;
233 libvlc_playlist_prev( LIBVLC_INSTANCE->p_instance, &ex );
235 Py_INCREF( Py_None );
240 vlcInstance_playlist_clear( PyObject *self, PyObject *args )
242 libvlc_exception_t ex;
244 libvlc_playlist_clear( LIBVLC_INSTANCE->p_instance, &ex );
246 Py_INCREF( Py_None );
250 /* Add a playlist item. Main parameter: URI.
251 Optional parameters: name, options */
253 vlcInstance_playlist_add( PyObject *self, PyObject *args)
255 libvlc_exception_t ex;
257 char* psz_uri = NULL;
258 char* psz_name = NULL;
259 PyObject *py_options = NULL;
261 char** ppsz_args = NULL;
263 if( !PyArg_ParseTuple( args, "s|sO", &psz_uri, &psz_name, &py_options ) )
268 /* Set a default name */
269 psz_name = strdup( psz_uri );
274 i_size = pyoptions_to_args( py_options, &ppsz_args );
280 i_ret = libvlc_playlist_add_extended( LIBVLC_INSTANCE->p_instance,
286 free_args( i_size, ppsz_args );
290 i_ret = libvlc_playlist_add( LIBVLC_INSTANCE->p_instance,
297 return Py_BuildValue( "i", i_ret );
301 vlcInstance_playlist_delete_item( PyObject *self, PyObject *args )
303 libvlc_exception_t ex;
307 if( !PyArg_ParseTuple( args, "i", &i_id ) )
311 i_ret = libvlc_playlist_delete_item( LIBVLC_INSTANCE->p_instance, i_id, &ex );
314 return Py_BuildValue( "i", i_ret );
318 vlcInstance_playlist_get_media_instance( PyObject *self, PyObject *args )
320 libvlc_exception_t ex;
321 libvlc_media_instance_t *p_mi;
322 vlcMediaInstance *p_ret;
325 p_mi = libvlc_playlist_get_media_instance( LIBVLC_INSTANCE->p_instance, &ex );
328 p_ret = PyObject_New( vlcMediaInstance, &vlcMediaInstance_Type );
330 Py_INCREF( p_ret ); /* Ah bon ? */
331 return ( PyObject * )p_ret;
335 vlcInstance_video_set_parent( PyObject *self, PyObject *args )
337 libvlc_exception_t ex;
340 if( !PyArg_ParseTuple( args, "i", &i_drawable ) )
344 libvlc_video_set_parent( LIBVLC_INSTANCE->p_instance, (libvlc_drawable_t) i_drawable, &ex );
347 Py_INCREF( Py_None );
352 vlcInstance_video_get_parent( PyObject *self, PyObject *args )
354 libvlc_exception_t ex;
355 libvlc_drawable_t i_ret;
358 i_ret = libvlc_video_get_parent( LIBVLC_INSTANCE->p_instance, &ex );
361 return Py_BuildValue( "L", i_ret );
365 vlcInstance_video_set_size( PyObject *self, PyObject *args )
367 libvlc_exception_t ex;
371 if( !PyArg_ParseTuple( args, "ii", &i_width, &i_height ) )
375 libvlc_video_set_size( LIBVLC_INSTANCE->p_instance, i_width, i_height, &ex );
378 Py_INCREF( Py_None );
383 vlcInstance_audio_toggle_mute( PyObject *self, PyObject *args )
385 libvlc_exception_t ex;
387 libvlc_audio_toggle_mute( LIBVLC_INSTANCE->p_instance, &ex );
389 Py_INCREF( Py_None );
394 vlcInstance_audio_get_mute( PyObject *self, PyObject *args )
396 libvlc_exception_t ex;
400 i_ret = libvlc_audio_get_mute( LIBVLC_INSTANCE->p_instance, &ex );
402 return Py_BuildValue( "i", i_ret );
406 vlcInstance_audio_set_mute( PyObject *self, PyObject *args )
408 libvlc_exception_t ex;
411 if( !PyArg_ParseTuple( args, "i", &i_mute ) )
415 libvlc_audio_set_mute( LIBVLC_INSTANCE->p_instance, i_mute, &ex );
417 Py_INCREF( Py_None );
422 vlcInstance_audio_get_volume( PyObject *self, PyObject *args )
424 libvlc_exception_t ex;
428 i_ret = libvlc_audio_get_volume( LIBVLC_INSTANCE->p_instance, &ex );
430 return Py_BuildValue( "i", i_ret );
434 vlcInstance_audio_set_volume( PyObject *self, PyObject *args )
436 libvlc_exception_t ex;
439 if( !PyArg_ParseTuple( args, "i", &i_volume ) )
443 libvlc_audio_set_volume( LIBVLC_INSTANCE->p_instance, i_volume, &ex );
445 Py_INCREF( Py_None );
450 vlcInstance_audio_get_channel( PyObject *self, PyObject *args )
452 libvlc_exception_t ex;
456 i_ret = libvlc_audio_get_channel( LIBVLC_INSTANCE->p_instance, &ex );
458 return Py_BuildValue( "i", i_ret );
462 vlcInstance_audio_set_channel( PyObject *self, PyObject *args )
464 libvlc_exception_t ex;
467 if( !PyArg_ParseTuple( args, "i", &i_channel ) )
471 libvlc_audio_set_channel( LIBVLC_INSTANCE->p_instance, i_channel, &ex );
473 Py_INCREF( Py_None );
477 /* vlm_add_broadcast : name, input MRL, output MRL
478 Keywords: options, enable, loop */
480 vlcInstance_vlm_add_broadcast( PyObject *self, PyObject *args, PyObject *kwds )
482 libvlc_exception_t ex;
483 static char *kwlist[] = { "name", "input", "output",
484 "options", "enable", "loop", NULL};
485 char* psz_name = NULL;
486 char* psz_input = NULL;
487 char* psz_output = NULL;
488 PyObject* py_options = NULL;
492 char** ppsz_args = NULL;
494 if( !PyArg_ParseTupleAndKeywords( args, kwds, "sss|Oii", kwlist,
496 &psz_input, &psz_output,
497 &py_options, &i_enable, &i_loop ) )
502 i_size = pyoptions_to_args( py_options, &ppsz_args );
506 libvlc_vlm_add_broadcast( LIBVLC_INSTANCE->p_instance,
507 psz_name, psz_input, psz_output,
508 i_size, ppsz_args, i_enable, i_loop, &ex);
509 free_args( i_size, ppsz_args );
511 Py_INCREF( Py_None );
516 vlcInstance_vlm_del_media( PyObject *self, PyObject *args )
518 libvlc_exception_t ex;
521 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
525 libvlc_vlm_del_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
527 Py_INCREF( Py_None );
532 vlcInstance_vlm_set_enabled( PyObject *self, PyObject *args )
534 libvlc_exception_t ex;
538 if( !PyArg_ParseTuple( args, "si", &psz_name, &i_enabled ) )
542 libvlc_vlm_set_enabled( LIBVLC_INSTANCE->p_instance, psz_name, i_enabled, &ex);
544 Py_INCREF( Py_None );
549 vlcInstance_vlm_set_output( PyObject *self, PyObject *args )
551 libvlc_exception_t ex;
555 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_output ) )
559 libvlc_vlm_set_output( LIBVLC_INSTANCE->p_instance, psz_name, psz_output, &ex);
561 Py_INCREF( Py_None );
566 vlcInstance_vlm_set_input( PyObject *self, PyObject *args )
568 libvlc_exception_t ex;
572 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_input ) )
576 libvlc_vlm_set_input( LIBVLC_INSTANCE->p_instance, psz_name, psz_input, &ex);
578 Py_INCREF( Py_None );
583 vlcInstance_vlm_add_input( PyObject *self, PyObject *args )
585 libvlc_exception_t ex;
589 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_input ) )
593 libvlc_vlm_add_input( LIBVLC_INSTANCE->p_instance, psz_name, psz_input, &ex);
595 Py_INCREF( Py_None );
600 vlcInstance_vlm_set_loop( PyObject *self, PyObject *args )
602 libvlc_exception_t ex;
606 if( !PyArg_ParseTuple( args, "si", &psz_name, &i_loop ) )
610 libvlc_vlm_set_loop( LIBVLC_INSTANCE->p_instance, psz_name, i_loop, &ex);
612 Py_INCREF( Py_None );
617 vlcInstance_vlm_change_media( PyObject *self, PyObject *args, PyObject *kwds )
619 libvlc_exception_t ex;
620 static char *kwlist[] = { "name", "input", "output",
621 "options", "enable", "loop", NULL};
622 char* psz_name = NULL;
623 char* psz_input = NULL;
624 char* psz_output = NULL;
625 PyObject* py_options = NULL;
629 char** ppsz_args = NULL;
631 if( !PyArg_ParseTupleAndKeywords( args, kwds, "sss|Oii", kwlist,
633 &psz_input, &psz_output,
634 &py_options, &i_enable, &i_loop ) )
639 i_size = pyoptions_to_args( py_options, &ppsz_args );
643 libvlc_vlm_change_media( LIBVLC_INSTANCE->p_instance,
644 psz_name, psz_input, psz_output,
645 i_size, ppsz_args, i_enable, i_loop, &ex);
646 free_args( i_size, ppsz_args );
648 Py_INCREF( Py_None );
653 vlcInstance_vlm_play_media( PyObject *self, PyObject *args )
655 libvlc_exception_t ex;
658 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
662 libvlc_vlm_play_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
664 Py_INCREF( Py_None );
669 vlcInstance_vlm_stop_media( PyObject *self, PyObject *args )
671 libvlc_exception_t ex;
674 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
678 libvlc_vlm_stop_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
680 Py_INCREF( Py_None );
685 vlcInstance_vlm_pause_media( PyObject *self, PyObject *args )
687 libvlc_exception_t ex;
690 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
694 libvlc_vlm_pause_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
696 Py_INCREF( Py_None );
701 vlcInstance_vlm_seek_media( PyObject *self, PyObject *args )
703 libvlc_exception_t ex;
707 if( !PyArg_ParseTuple( args, "sf", &psz_name, &f_percentage ) )
711 libvlc_vlm_seek_media( LIBVLC_INSTANCE->p_instance, psz_name, f_percentage, &ex);
713 Py_INCREF( Py_None );
718 vlcInstance_vlm_show_media( PyObject *self, PyObject *args )
720 libvlc_exception_t ex;
725 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
728 psz_ret = libvlc_vlm_show_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex );
730 o_ret = Py_BuildValue( "s", psz_ret );
736 vlcInstance_media_descriptor_new( PyObject *self, PyObject *args )
738 libvlc_exception_t ex;
739 libvlc_media_descriptor_t *p_md;
740 char* psz_mrl = NULL;
741 vlcMediaDescriptor *p_ret;
743 if( !PyArg_ParseTuple( args, "s", &psz_mrl ) )
747 p_md = libvlc_media_descriptor_new( LIBVLC_INSTANCE->p_instance, psz_mrl, &ex );
750 p_ret = PyObject_New( vlcMediaDescriptor, &vlcMediaDescriptor_Type );
752 Py_INCREF( p_ret ); /* Ah bon ? */
753 return ( PyObject * )p_ret;
757 static PyMethodDef vlcInstance_methods[] =
759 { "get_vlc_id", vlcInstance_get_vlc_id, METH_VARARGS,
760 "get_vlc_id( ) -> int Get the instance id."},
761 { "playlist_loop", vlcInstance_playlist_loop, METH_VARARGS,
762 "playlist_loop(bool) Set loop variable" },
763 { "playlist_play", vlcInstance_playlist_play, METH_VARARGS,
764 "playlist_play(id=int, options=list) Play the given playlist item (-1 for current item) with optional options (a list of strings)" },
765 { "playlist_pause", vlcInstance_playlist_pause, METH_VARARGS,
766 "playlist_pause() Pause the current stream"},
767 { "playlist_isplaying", vlcInstance_playlist_isplaying, METH_VARARGS,
768 "playlist_isplaying() -> int Return True if the playlist if playing"},
769 { "playlist_items_count", vlcInstance_playlist_items_count, METH_VARARGS,
770 "playlist_items_count() -> int Return the number of items in the playlist"},
771 { "playlist_stop", vlcInstance_playlist_stop, METH_VARARGS,
772 "playlist_stop() Stop the current stream"},
773 { "playlist_next", vlcInstance_playlist_next, METH_VARARGS,
774 "playlist_next() Play the next item"},
775 { "playlist_prev", vlcInstance_playlist_prev, METH_VARARGS,
776 "playlist_prev() Play the previous item"},
777 { "playlist_clear", vlcInstance_playlist_clear, METH_VARARGS,
778 "playlist_clear() Clear the playlist"},
779 { "playlist_add", vlcInstance_playlist_add, METH_VARARGS,
780 "playlist_add(mrl=str, name=str, options=list) -> int Add a new item to the playlist. options is a list of strings."},
781 { "playlist_delete_item", vlcInstance_playlist_delete_item, METH_VARARGS,
782 "playlist_delete_item(id=int) Delete the given item"},
783 { "playlist_get_media_instance", vlcInstance_playlist_get_media_instance, METH_VARARGS,
784 "playlist_get_media_instance() -> object Return the current media instance"},
785 { "video_set_parent", vlcInstance_video_set_parent, METH_VARARGS,
786 "video_set_parent(xid=int) Set the parent xid/HWND/CGrafPort"},
787 { "video_get_parent", vlcInstance_video_get_parent, METH_VARARGS,
788 "video_get_parent(xid=int) Get the parent xid/HWND/CGrafPort"},
789 { "video_set_size", vlcInstance_video_set_size, METH_VARARGS,
790 "video_set_size(width=int, height=int) Set the video width and height"},
791 { "audio_toggle_mute", vlcInstance_audio_toggle_mute, METH_VARARGS,
792 "audio_toggle_mute() Toggle the mute state"},
793 { "audio_get_mute", vlcInstance_audio_get_mute, METH_VARARGS,
794 "audio_get_mute() -> int Get the mute state"},
795 { "audio_set_mute", vlcInstance_audio_set_mute, METH_VARARGS,
796 "audio_set_mute(state=int) Set the mute state"},
797 { "audio_get_volume", vlcInstance_audio_get_volume, METH_VARARGS,
798 "audio_get_volume() -> int Get the audio volume"},
799 { "audio_set_volume", vlcInstance_audio_set_volume, METH_VARARGS,
800 "audio_set_volume(volume=int) Set the audio volume"},
801 { "audio_get_channel", vlcInstance_audio_get_channel, METH_VARARGS,
802 "audio_get_channel() -> int Get current audio channel" },
803 { "audio_set_channel", vlcInstance_audio_set_channel, METH_VARARGS,
804 "audio_set_channel(int) Set current audio channel" },
806 { "media_descriptor_new", vlcInstance_media_descriptor_new, METH_VARARGS,
807 "media_descriptor_new(str) -> object Create a media descriptor with the given mrl."},
809 { "vlm_add_broadcast", vlcInstance_vlm_add_broadcast, METH_VARARGS | METH_KEYWORDS,
810 "vlm_add_broadcast(name=str, input=str, output=str, options=list, enable=int, loop=int) Add a new broadcast" },
811 { "vlm_del_media", vlcInstance_vlm_del_media, METH_VARARGS,
812 "vlm_del_media(name=str) Delete a media" },
813 { "vlm_set_enabled", vlcInstance_vlm_set_enabled, METH_VARARGS,
814 "vlm_set_enabled(name=str, enabled=int) Enable/disable a media" },
815 { "vlm_set_output", vlcInstance_vlm_set_output, METH_VARARGS,
816 "vlm_set_output(name=str, output=str) Set the output" },
817 { "vlm_set_input", vlcInstance_vlm_set_input, METH_VARARGS,
818 "vlm_set_input(name=str, output=str) Set the input" },
819 { "vlm_add_input", vlcInstance_vlm_add_input, METH_VARARGS,
820 "vlm_add_input(name=str, output=str) Add a media's input MRL" },
821 { "vlm_set_loop", vlcInstance_vlm_set_loop, METH_VARARGS,
822 "vlm_set_loop(name=str, loop=int) Change the looping value" },
823 { "vlm_change_media", vlcInstance_vlm_change_media, METH_VARARGS | METH_KEYWORDS,
824 "vlm_change_media(name=str, input=str, output=str, options=list, enable=int, loop=int) Change the broadcast parameters" },
825 { "vlm_play_media", vlcInstance_vlm_play_media, METH_VARARGS,
826 "vlm_play_media(name=str) Plays the named broadcast." },
827 { "vlm_stop_media", vlcInstance_vlm_stop_media, METH_VARARGS,
828 "vlm_stop_media(name=str) Stops the named broadcast." },
829 { "vlm_pause_media", vlcInstance_vlm_pause_media, METH_VARARGS,
830 "vlm_pause_media(name=str) Pauses the named broadcast." },
831 { "vlm_seek_media", vlcInstance_vlm_seek_media, METH_VARARGS,
832 "vlm_seek_media(name=str, percentage=float) Seeks in the named broadcast." },
833 { "vlm_show_media", vlcInstance_vlm_show_media, METH_VARARGS,
834 "vlm_show_media(name=str) Return information of the named broadcast." },
836 { NULL, NULL, 0, NULL },
839 static PyTypeObject vlcInstance_Type =
841 PyObject_HEAD_INIT( NULL )
843 "vlc.Instance", /*tp_name*/
844 sizeof( vlcInstance_Type ), /*tp_basicsize*/
846 ( destructor )vlcInstance_dealloc, /*tp_dealloc*/
853 0, /*tp_as_sequence*/
861 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
862 "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 */
865 0, /* tp_richcompare */
866 0, /* tp_weaklistoffset */
869 vlcInstance_methods, /* tp_methods */
874 0, /* tp_descr_get */
875 0, /* tp_descr_set */
876 0, /* tp_dictoffset */
879 vlcInstance_new, /* tp_new */