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_destroy( 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_input( PyObject *self, PyObject *args )
320 libvlc_exception_t ex;
321 libvlc_media_instance_t *p_md;
325 p_md = libvlc_playlist_get_media_instance( LIBVLC_INSTANCE->p_instance, &ex );
328 p_ret = PyObject_New( vlcInput, &vlcInput_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_set_size( PyObject *self, PyObject *args )
354 libvlc_exception_t ex;
358 if( !PyArg_ParseTuple( args, "ii", &i_width, &i_height ) )
362 libvlc_video_set_size( LIBVLC_INSTANCE->p_instance, i_width, i_height, &ex );
365 Py_INCREF( Py_None );
370 vlcInstance_audio_toggle_mute( PyObject *self, PyObject *args )
372 libvlc_exception_t ex;
374 libvlc_audio_toggle_mute( LIBVLC_INSTANCE->p_instance, &ex );
376 Py_INCREF( Py_None );
381 vlcInstance_audio_get_mute( PyObject *self, PyObject *args )
383 libvlc_exception_t ex;
387 i_ret = libvlc_audio_get_mute( LIBVLC_INSTANCE->p_instance, &ex );
389 return Py_BuildValue( "i", i_ret );
393 vlcInstance_audio_set_mute( PyObject *self, PyObject *args )
395 libvlc_exception_t ex;
398 if( !PyArg_ParseTuple( args, "i", &i_mute ) )
402 libvlc_audio_set_mute( LIBVLC_INSTANCE->p_instance, i_mute, &ex );
404 Py_INCREF( Py_None );
409 vlcInstance_audio_get_volume( PyObject *self, PyObject *args )
411 libvlc_exception_t ex;
415 i_ret = libvlc_audio_get_volume( LIBVLC_INSTANCE->p_instance, &ex );
417 return Py_BuildValue( "i", i_ret );
421 vlcInstance_audio_set_volume( PyObject *self, PyObject *args )
423 libvlc_exception_t ex;
426 if( !PyArg_ParseTuple( args, "i", &i_volume ) )
430 libvlc_audio_set_volume( LIBVLC_INSTANCE->p_instance, i_volume, &ex );
432 Py_INCREF( Py_None );
437 vlcInstance_audio_get_channel( PyObject *self, PyObject *args )
439 libvlc_exception_t ex;
443 i_ret = libvlc_audio_get_channel( LIBVLC_INSTANCE->p_instance, &ex );
445 return Py_BuildValue( "i", i_ret );
449 vlcInstance_audio_set_channel( PyObject *self, PyObject *args )
451 libvlc_exception_t ex;
454 if( !PyArg_ParseTuple( args, "i", &i_channel ) )
458 libvlc_audio_set_channel( LIBVLC_INSTANCE->p_instance, i_channel, &ex );
460 Py_INCREF( Py_None );
464 /* vlm_add_broadcast : name, input MRL, output MRL
465 Keywords: options, enable, loop */
467 vlcInstance_vlm_add_broadcast( PyObject *self, PyObject *args, PyObject *kwds )
469 libvlc_exception_t ex;
470 static char *kwlist[] = { "name", "input", "output",
471 "options", "enable", "loop", NULL};
472 char* psz_name = NULL;
473 char* psz_input = NULL;
474 char* psz_output = NULL;
475 PyObject* py_options = NULL;
479 char** ppsz_args = NULL;
481 if( !PyArg_ParseTupleAndKeywords( args, kwds, "sss|Oii", kwlist,
483 &psz_input, &psz_output,
484 &py_options, &i_enable, &i_loop ) )
489 i_size = pyoptions_to_args( py_options, &ppsz_args );
493 libvlc_vlm_add_broadcast( LIBVLC_INSTANCE->p_instance,
494 psz_name, psz_input, psz_output,
495 i_size, ppsz_args, i_enable, i_loop, &ex);
496 free_args( i_size, ppsz_args );
498 Py_INCREF( Py_None );
503 vlcInstance_vlm_del_media( PyObject *self, PyObject *args )
505 libvlc_exception_t ex;
508 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
512 libvlc_vlm_del_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
514 Py_INCREF( Py_None );
519 vlcInstance_vlm_set_enabled( PyObject *self, PyObject *args )
521 libvlc_exception_t ex;
525 if( !PyArg_ParseTuple( args, "si", &psz_name, &i_enabled ) )
529 libvlc_vlm_set_enabled( LIBVLC_INSTANCE->p_instance, psz_name, i_enabled, &ex);
531 Py_INCREF( Py_None );
536 vlcInstance_vlm_set_output( PyObject *self, PyObject *args )
538 libvlc_exception_t ex;
542 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_output ) )
546 libvlc_vlm_set_output( LIBVLC_INSTANCE->p_instance, psz_name, psz_output, &ex);
548 Py_INCREF( Py_None );
553 vlcInstance_vlm_set_input( PyObject *self, PyObject *args )
555 libvlc_exception_t ex;
559 if( !PyArg_ParseTuple( args, "ss", &psz_name, &psz_input ) )
563 libvlc_vlm_set_input( LIBVLC_INSTANCE->p_instance, psz_name, psz_input, &ex);
565 Py_INCREF( Py_None );
570 vlcInstance_vlm_set_loop( PyObject *self, PyObject *args )
572 libvlc_exception_t ex;
576 if( !PyArg_ParseTuple( args, "si", &psz_name, &i_loop ) )
580 libvlc_vlm_set_loop( LIBVLC_INSTANCE->p_instance, psz_name, i_loop, &ex);
582 Py_INCREF( Py_None );
587 vlcInstance_vlm_change_media( PyObject *self, PyObject *args, PyObject *kwds )
589 libvlc_exception_t ex;
590 static char *kwlist[] = { "name", "input", "output",
591 "options", "enable", "loop", NULL};
592 char* psz_name = NULL;
593 char* psz_input = NULL;
594 char* psz_output = NULL;
595 PyObject* py_options = NULL;
599 char** ppsz_args = NULL;
601 if( !PyArg_ParseTupleAndKeywords( args, kwds, "sss|Oii", kwlist,
603 &psz_input, &psz_output,
604 &py_options, &i_enable, &i_loop ) )
609 i_size = pyoptions_to_args( py_options, &ppsz_args );
613 libvlc_vlm_change_media( LIBVLC_INSTANCE->p_instance,
614 psz_name, psz_input, psz_output,
615 i_size, ppsz_args, i_enable, i_loop, &ex);
616 free_args( i_size, ppsz_args );
618 Py_INCREF( Py_None );
623 vlcInstance_vlm_play_media( PyObject *self, PyObject *args )
625 libvlc_exception_t ex;
628 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
632 libvlc_vlm_play_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
634 Py_INCREF( Py_None );
639 vlcInstance_vlm_stop_media( PyObject *self, PyObject *args )
641 libvlc_exception_t ex;
644 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
648 libvlc_vlm_stop_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
650 Py_INCREF( Py_None );
655 vlcInstance_vlm_pause_media( PyObject *self, PyObject *args )
657 libvlc_exception_t ex;
660 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
664 libvlc_vlm_pause_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex);
666 Py_INCREF( Py_None );
671 vlcInstance_vlm_seek_media( PyObject *self, PyObject *args )
673 libvlc_exception_t ex;
677 if( !PyArg_ParseTuple( args, "sf", &psz_name, &f_percentage ) )
681 libvlc_vlm_seek_media( LIBVLC_INSTANCE->p_instance, psz_name, f_percentage, &ex);
683 Py_INCREF( Py_None );
688 vlcInstance_vlm_show_media( PyObject *self, PyObject *args )
690 libvlc_exception_t ex;
695 if( !PyArg_ParseTuple( args, "s", &psz_name ) )
698 psz_ret = libvlc_vlm_show_media( LIBVLC_INSTANCE->p_instance, psz_name, &ex );
700 o_ret = Py_BuildValue( "s", psz_ret );
706 static PyMethodDef vlcInstance_methods[] =
708 { "get_vlc_id", vlcInstance_get_vlc_id, METH_VARARGS,
709 "get_vlc_id( ) -> int Get the instance id."},
710 { "playlist_loop", vlcInstance_playlist_loop, METH_VARARGS,
711 "playlist_loop(bool) Set loop variable" },
712 { "playlist_play", vlcInstance_playlist_play, METH_VARARGS,
713 "playlist_play(id=int, options=list) Play the given playlist item (-1 for current item) with optional options (a list of strings)" },
714 { "playlist_pause", vlcInstance_playlist_pause, METH_VARARGS,
715 "playlist_pause() Pause the current stream"},
716 { "playlist_isplaying", vlcInstance_playlist_isplaying, METH_VARARGS,
717 "playlist_isplaying() -> int Return True if the playlist if playing"},
718 { "playlist_items_count", vlcInstance_playlist_items_count, METH_VARARGS,
719 "playlist_items_count() -> int Return the number of items in the playlist"},
720 { "playlist_stop", vlcInstance_playlist_stop, METH_VARARGS,
721 "playlist_stop() Stop the current stream"},
722 { "playlist_next", vlcInstance_playlist_next, METH_VARARGS,
723 "playlist_next() Play the next item"},
724 { "playlist_prev", vlcInstance_playlist_prev, METH_VARARGS,
725 "playlist_prev() Play the previous item"},
726 { "playlist_clear", vlcInstance_playlist_clear, METH_VARARGS,
727 "playlist_clear() Clear the playlist"},
728 { "playlist_add", vlcInstance_playlist_add, METH_VARARGS,
729 "playlist_add(mrl=str, name=str, options=list) -> int Add a new item to the playlist. options is a list of strings."},
730 { "playlist_delete_item", vlcInstance_playlist_delete_item, METH_VARARGS,
731 "playlist_delete_item(id=int) Delete the given item"},
732 { "playlist_get_input", vlcInstance_playlist_get_input, METH_VARARGS,
733 "playlist_get_input() -> object Return the current input"},
734 { "video_set_parent", vlcInstance_video_set_parent, METH_VARARGS,
735 "video_set_parent(xid=int) Set the parent xid or HWND"},
736 { "video_set_size", vlcInstance_video_set_size, METH_VARARGS,
737 "video_set_size(width=int, height=int) Set the video width and height"},
738 { "audio_toggle_mute", vlcInstance_audio_toggle_mute, METH_VARARGS,
739 "audio_toggle_mute() Toggle the mute state"},
740 { "audio_get_mute", vlcInstance_audio_get_mute, METH_VARARGS,
741 "audio_get_mute() -> int Get the mute state"},
742 { "audio_set_mute", vlcInstance_audio_set_mute, METH_VARARGS,
743 "audio_set_mute(state=int) Set the mute state"},
744 { "audio_get_volume", vlcInstance_audio_get_volume, METH_VARARGS,
745 "audio_get_volume() -> int Get the audio volume"},
746 { "audio_set_volume", vlcInstance_audio_set_volume, METH_VARARGS,
747 "audio_set_volume(volume=int) Set the audio volume"},
748 { "audio_get_channel", vlcInstance_audio_get_channel, METH_VARARGS,
749 "audio_get_channel() -> int Get current audio channel" },
750 { "audio_set_channel", vlcInstance_audio_set_channel, METH_VARARGS,
751 "audio_set_channel(int) Set current audio channel" },
752 { "vlm_add_broadcast", vlcInstance_vlm_add_broadcast, METH_VARARGS | METH_KEYWORDS,
753 "vlm_add_broadcast(name=str, input=str, output=str, options=list, enable=int, loop=int) Add a new broadcast" },
754 { "vlm_del_media", vlcInstance_vlm_del_media, METH_VARARGS,
755 "vlm_del_media(name=str) Delete a media" },
756 { "vlm_set_enabled", vlcInstance_vlm_set_enabled, METH_VARARGS,
757 "vlm_set_enabled(name=str, enabled=int) Enable/disable a media" },
758 { "vlm_set_output", vlcInstance_vlm_set_output, METH_VARARGS,
759 "vlm_set_output(name=str, output=str) Set the output" },
760 { "vlm_set_input", vlcInstance_vlm_set_input, METH_VARARGS,
761 "vlm_set_input(name=str, output=str) Set the input" },
762 { "vlm_set_loop", vlcInstance_vlm_set_loop, METH_VARARGS,
763 "vlm_set_loop(name=str, loop=int) Change the looping value" },
764 { "vlm_change_media", vlcInstance_vlm_change_media, METH_VARARGS | METH_KEYWORDS,
765 "vlm_change_media(name=str, input=str, output=str, options=list, enable=int, loop=int) Change the broadcast parameters" },
766 { "vlm_play_media", vlcInstance_vlm_play_media, METH_VARARGS,
767 "vlm_play_media(name=str) Plays the named broadcast." },
768 { "vlm_stop_media", vlcInstance_vlm_stop_media, METH_VARARGS,
769 "vlm_stop_media(name=str) Stops the named broadcast." },
770 { "vlm_pause_media", vlcInstance_vlm_pause_media, METH_VARARGS,
771 "vlm_pause_media(name=str) Pauses the named broadcast." },
772 { "vlm_seek_media", vlcInstance_vlm_seek_media, METH_VARARGS,
773 "vlm_seek_media(name=str, percentage=float) Seeks in the named broadcast." },
774 { "vlm_show_media", vlcInstance_vlm_show_media, METH_VARARGS,
775 "vlm_show_media(name=str) Return information of the named broadcast." },
777 { NULL, NULL, 0, NULL },
780 static PyTypeObject vlcInstance_Type =
782 PyObject_HEAD_INIT( NULL )
784 "vlc.Instance", /*tp_name*/
785 sizeof( vlcInstance_Type ), /*tp_basicsize*/
787 ( destructor )vlcInstance_dealloc, /*tp_dealloc*/
794 0, /*tp_as_sequence*/
802 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
803 "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 */
806 0, /* tp_richcompare */
807 0, /* tp_weaklistoffset */
810 vlcInstance_methods, /* tp_methods */
815 0, /* tp_descr_get */
816 0, /* tp_descr_set */
817 0, /* tp_dictoffset */
820 vlcInstance_new, /* tp_new */