git.sesse.net Git - vlc/blob - src/control/libvlc_internal.h

   1 /*****************************************************************************
   2  * libvlc_internal.h : Definition of opaque structures for libvlc exported API
   3  * Also contains some internal utility functions
   4  *****************************************************************************
   5  * Copyright (C) 2005-2009 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Clément Stenac <zorglub@videolan.org>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 #ifndef _LIBVLC_INTERNAL_H
  26 #define _LIBVLC_INTERNAL_H 1
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc/libvlc_structures.h>
  33 #include <vlc/libvlc.h>
  34 #include <vlc/libvlc_media.h>
  35 #include <vlc/libvlc_events.h>
  36
  37 #include <vlc_common.h>
  38
  39 /***************************************************************************
  40  * Internal creation and destruction functions
  41  ***************************************************************************/
  42 VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
  43 VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, const char *ppsz_argv[] ) );
  44 VLC_EXPORT (void, libvlc_InternalCleanup, ( libvlc_int_t * ) );
  45 VLC_EXPORT (void, libvlc_InternalDestroy, ( libvlc_int_t * ) );
  46
  47 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char * ) );
  48 VLC_EXPORT (void, libvlc_InternalWait, ( libvlc_int_t * ) );
  49
  50 typedef void (*libvlc_vlm_release_func_t)( libvlc_instance_t * ) ;
  51
  52 /***************************************************************************
  53  * Opaque structures for libvlc API
  54  ***************************************************************************/
  55
  56 typedef enum libvlc_lock_state_t
  57 {
  58     libvlc_Locked,
  59     libvlc_UnLocked
  60 } libvlc_lock_state_t;
  61
  62 typedef struct libvlc_vlm_t
  63 {
  64     vlm_t                  *p_vlm;
  65     libvlc_event_manager_t *p_event_manager;
  66     libvlc_vlm_release_func_t pf_release;
  67 } libvlc_vlm_t;
  68
  69 struct libvlc_instance_t
  70 {
  71     libvlc_int_t *p_libvlc_int;
  72     libvlc_vlm_t  libvlc_vlm;
  73     int           b_playlist_locked;
  74     unsigned      ref_count;
  75     int           verbosity;
  76     vlc_mutex_t   instance_lock;
  77     vlc_mutex_t   event_callback_lock;
  78     struct libvlc_callback_entry_list_t *p_callback_list;
  79 };
  80
  81
  82 /***************************************************************************
  83  * Other internal functions
  84  ***************************************************************************/
  85
  86 /* Thread context */
  87 void libvlc_init_threads (void);
  88 void libvlc_deinit_threads (void);
  89
  90 /* Events */
  91 libvlc_event_manager_t * libvlc_event_manager_new(
  92         void * p_obj, libvlc_instance_t * p_libvlc_inst,
  93         libvlc_exception_t *p_e );
  94
  95 void libvlc_event_manager_release(
  96         libvlc_event_manager_t * p_em );
  97
  98 void libvlc_event_manager_register_event_type(
  99         libvlc_event_manager_t * p_em,
 100         libvlc_event_type_t event_type,
 101         libvlc_exception_t * p_e );
 102
 103 void libvlc_event_send(
 104         libvlc_event_manager_t * p_em,
 105         libvlc_event_t * p_event );
 106
 107 void libvlc_event_attach_async( libvlc_event_manager_t * p_event_manager,
 108                                libvlc_event_type_t event_type,
 109                                libvlc_callback_t pf_callback,
 110                                void *p_user_data,
 111                                libvlc_exception_t *p_e );
 112
 113 /* Exception shorcuts */
 114
 115 #define RAISENULL( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 116                            return NULL; }
 117 #define RAISEZERO( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 118                            return 0; }
 119
 120 #endif