git.sesse.net Git - vlc/blob - projects/macosx/framework/Headers/Internal/VLCLibVLCBridging.h

   1 /*****************************************************************************
   2 * VLCLibVLCbridging.h: VLCKit.framework VLCLibVLCBridging (Private) header
   3 *****************************************************************************
   4 * Copyright (C) 2007 Pierre d'Herbemont
   5 * Copyright (C) 2007 the VideoLAN team
   6 * $Id$
   7 *
   8 * Authors: Pierre d'Herbemont <pdherbemont # 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 #import "VLCLibrary.h"
  26 #import "VLCMediaListAspect.h"
  27 #import "VLCStreamOutput.h"
  28
  29 /* Utility functions */
  30 /**
  31  * \function catch_execption( ex )
  32  * Utility function that catches a LibVLC generated exception by throwing a Cocoa based NSException.
  33  * \param ex LibVLC exception returned by LibVLC internal functions.
  34  */
  35 #define catch_exception( ex ) __catch_exception( (void *)(ex), __FUNCTION__, __FILE__, __LINE__ )
  36 extern void __catch_exception( void * e, const char * function, const char * file, int line_number );
  37
  38 /**
  39  * Bridges functionality between libvlc and VLCMediaList implementation.
  40  */
  41 @interface VLCMediaList (LibVLCBridging)
  42 /* Factories */
  43 /**
  44  * Manufactures new object wrapped around specified media list.
  45  * \param p_new_mlist LibVLC media list pointer.
  46  * \return Newly create media list instance using specified media list
  47  * pointer.
  48  */
  49 + (id)mediaListWithLibVLCMediaList:(void *)p_new_mlist;
  50
  51 /* Initializers */
  52 /**
  53  * Initializes new object wrapped around specified media list.
  54  * \param p_new_mlist LibVLC media list pointer.
  55  * \return Newly create media list instance using specified media list
  56  * pointer.
  57  */
  58 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
  59
  60 /* Properties */
  61 @property (readonly) void * libVLCMediaList;    //< LibVLC media list pointer.
  62 @end
  63
  64 /**
  65  * Bridges functionality between libvlc and VLCMedia implementation.
  66  */
  67 @interface VLCMedia (LibVLCBridging)
  68 /* Factories */
  69 /**
  70  * Manufactures new object wrapped around specified media descriptor.
  71  * \param md LibVLC media descriptor pointer.
  72  * \return Newly created media instance using specified descriptor.
  73  */
  74 + (id)mediaWithLibVLCMediaDescriptor:(void *)md;
  75
  76 /* Initializers */
  77 /**
  78  * Initializes new object wrapped around specified media descriptor.
  79  * \param md LibVLC media descriptor pointer.
  80  * \return Newly created media instance using specified descriptor.
  81  */
  82 - (id)initWithLibVLCMediaDescriptor:(void *)md;
  83
  84 + (id)mediaWithMedia:(VLCMedia *)media andLibVLCOptions:(NSDictionary *)options;
  85
  86 /**
  87  * Returns the receiver's internal media descriptor pointer.
  88  * \return The receiver's internal media descriptor pointer.
  89  */
  90 @property (readonly) void * libVLCMediaDescriptor;
  91 @end
  92
  93 /**
  94  * Bridges functionality between VLCMedia and VLCMediaPlayer
  95  */
  96 @interface VLCMedia (VLCMediaPlayerBridging)
  97 /**
  98  * Set's the length of the media object.  This value becomes available once the
  99  * media object is being played.
 100  * \param value
 101  */
 102 - (void)setLength:(VLCTime *)value;
 103 @end
 104
 105 /**
 106  * Bridges functionality between VLCLibrary and LibVLC core.
 107  */
 108 @interface VLCLibrary (VLCLibVLCBridging)
 109 /**
 110  * Shared singleton instance of libvlc library instance.
 111  * \return libvlc pointer of library instance.
 112  */
 113 + (void *)sharedInstance;
 114
 115 /**
 116  * Instance of libvlc library instance.
 117  * \return libvlc pointer of library instance.
 118  */
 119 @property (readonly) void * instance;
 120 @end
 121
 122 /**
 123  * Bridges functionality between VLCMediaListAspect and libvlc.
 124  */
 125 @interface VLCMediaListAspect (VLCLibVLCBridging)
 126 /* Factories */
 127 /**
 128  * Manufactures a new media list aspect object with libvlc media list view instance.
 129  * \return Newly created media list aspect using specified libvlc media list view.
 130  */
 131 + (id)mediaListAspectWithLibVLCMediaListView:(libvlc_media_list_view_t *)p_new_mlv;
 132
 133 /**
 134  * Manufactures a new media list aspect object with libvlc media list view instance.
 135  * \return Newly created media list aspect using specified libvlc media list view.
 136  */
 137 + (id)mediaListAspectWithLibVLCMediaListView:(libvlc_media_list_view_t *)p_new_mlv andMediaList:(VLCMediaList*)mediaList;
 138
 139 /* Initializers */
 140 /**
 141  * Initializes a new media list aspect object with libvlc media list view instance.
 142  * \return Newly created media list aspect using specified libvlc media list view.
 143  */
 144 - (id)initWithLibVLCMediaListView:(libvlc_media_list_view_t *)p_new_mlv andMediaList:(VLCMediaList*)mediaList;
 145
 146 /* Properties */
 147 @property (readonly) libvlc_media_list_view_t * libVLCMediaListView; //< Libvlc pointer to media list view instance.
 148 @end
 149
 150 /**
 151  * Bridges functionality between VLCLibrary and VLCAudio.
 152  */
 153 @interface VLCLibrary (VLCAudioBridging)
 154 /**
 155  * Called by VLCAudio, each library has a singleton VLCaudio instance.  VLCAudio
 156  * calls this function to let the VLCLibrary instance know how to get in touch
 157  * with the VLCAudio instance.  TODO: Each media player instance should have it's
 158  * own audio instance...not each library instance.
 159  */
 160 - (void)setAudio:(VLCAudio *)value;
 161 @end
 162
 163 /**
 164  * Bridges functionality between VLCAudio and VLCLibrary.
 165  */
 166 @interface VLCAudio (VLCAudioBridging)
 167 /* Initializers */
 168 /**
 169  * Initializes a new object using the specified library instance.
 170  * \return Newly created audio object using specified VLCLibrary instance.
 171  */
 172 - (id)initWithLibrary:(VLCLibrary *)library;
 173 @end
 174
 175 /**
 176  * TODO: Documentation
 177  */
 178 @interface VLCStreamOutput (LibVLCBridge)
 179 - (NSString *)representedLibVLCOptions;
 180 @end