git.sesse.net Git - vlc/blob - projects/macosx/framework/Headers/Public/VLCMediaPlayer.h

   1 /*****************************************************************************
   2  * VLCMediaPlayer.h: VLCKit.framework VLCMediaPlayer header
   3  *****************************************************************************
   4  * Copyright (C) 2007-2009 Pierre d'Herbemont
   5  * Copyright (C) 2007-2009 the VideoLAN team
   6  * Partial Copyright (C) 2009 Felix Paul Kühne
   7  * $Id$
   8  *
   9  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
  10  *          Felix Paul Kühne <fkuehne # videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #import "VLCMedia.h"
  28 #import "VLCVideoView.h"
  29 #import "VLCVideoLayer.h"
  30 #import "VLCTime.h"
  31 #import "VLCAudio.h"
  32
  33 /* Notification Messages */
  34 extern NSString * VLCMediaPlayerTimeChanged;
  35 extern NSString * VLCMediaPlayerStateChanged;
  36
  37 /**
  38  * VLCMediaPlayerState describes the state of the media player.
  39  */
  40 typedef enum VLCMediaPlayerState
  41 {
  42     VLCMediaPlayerStateStopped,        //< Player has stopped
  43     VLCMediaPlayerStateOpening,        //< Stream is opening
  44     VLCMediaPlayerStateBuffering,      //< Stream is buffering
  45     VLCMediaPlayerStateEnded,          //< Stream has ended
  46     VLCMediaPlayerStateError,          //< Player has generated an error
  47     VLCMediaPlayerStatePlaying,        //< Stream is playing
  48     VLCMediaPlayerStatePaused          //< Stream is paused
  49 } VLCMediaPlayerState;
  50
  51 /**
  52  * Returns the name of the player state as a string.
  53  * \param state The player state.
  54  * \return A string containing the name of state. If state is not a valid state, returns nil.
  55  */
  56 extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
  57
  58 /**
  59  * Formal protocol declaration for playback delegates.  Allows playback messages
  60  * to be trapped by delegated objects.
  61  */
  62 @protocol VLCMediaPlayerDelegate
  63 /**
  64  * Sent by the default notification center whenever the player's time has changed.
  65  * \details Discussion The value of aNotification is always an VLCMediaPlayerTimeChanged notification. You can retrieve
  66  * the VLCMediaPlayer object in question by sending object to aNotification.
  67  */
  68 - (void)mediaPlayerTimeChanged:(NSNotification *)aNotification;
  69
  70 /**
  71  * Sent by the default notification center whenever the player's state has changed.
  72  * \details Discussion The value of aNotification is always an VLCMediaPlayerStateChanged notification. You can retrieve
  73  * the VLCMediaPlayer object in question by sending object to aNotification.
  74  */
  75 - (void)mediaPlayerStateChanged:(NSNotification *)aNotification;
  76 @end
  77
  78 // TODO: Should we use medialist_player or our own flavor of media player?
  79 @interface VLCMediaPlayer : NSObject
  80 {
  81     id delegate;                        //< Object delegate
  82     void * instance;                    //  Internal
  83     VLCMedia * media;                   //< Current media being played
  84     VLCTime * cachedTime;               //< Cached time of the media being played
  85     VLCMediaPlayerState cachedState;    //< Cached state of the media being played
  86     float position;                     //< The position of the media being played
  87     id drawable;                        //< The drawable associated to this media player
  88 }
  89
  90 /* Initializers */
  91 - (id)initWithVideoView:(VLCVideoView *)aVideoView;
  92 - (id)initWithVideoLayer:(VLCVideoLayer *)aVideoLayer;
  93
  94 /* Properties */
  95 - (void)setDelegate:(id)value;
  96 - (id)delegate;
  97
  98 /* Video View Options */
  99 // TODO: Should be it's own object?
 100
 101 - (void)setVideoView:(VLCVideoView *)aVideoView;
 102 - (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer;
 103
 104 @property (retain) id drawable; /* The videoView or videoLayer */
 105
 106 - (void)setVideoAspectRatio:(char *)value;
 107 - (char *)videoAspectRatio;
 108
 109 - (void)setVideoCropGeometry:(char *)value;
 110 - (char *)videoCropGeometry;
 111
 112 - (void)setVideoTeleText:(int)value;
 113 - (int)videoTeleText;
 114
 115 /**
 116  * Take a snapshot of the current video.
 117  *
 118  * If width AND height is 0, original size is used.
 119  * If width OR height is 0, original aspect-ratio is preserved.
 120  *
 121  * \param path the path where to save the screenshot to
 122  * \param width the snapshot's width
 123  * \param height the snapshot's height
 124  */
 125 - (void)saveVideoSnapshotAt: (NSString *)path withWidth:(NSUInteger)width andHeight:(NSUInteger)height;
 126
 127 /**
 128  * Enable or disable deinterlace filter
 129  *
 130  * \param name of deinterlace filter to use (availability depends on underlying VLC version)
 131  * \param enable boolean to enable or disable deinterlace filter
 132  */
 133 - (void)setDeinterlaceFilter: (NSString *)name enabled: (BOOL)enabled;
 134
 135 @property float rate;
 136
 137 @property (readonly) VLCAudio * audio;
 138
 139 /* Video Information */
 140 - (NSSize)videoSize;
 141 - (BOOL)hasVideoOut;
 142 - (float)framesPerSecond;
 143
 144 /**
 145  * Sets the current position (or time) of the feed.
 146  * \param value New time to set the current position to.  If time is [VLCTime nullTime], 0 is assumed.
 147  */
 148 - (void)setTime:(VLCTime *)value;
 149
 150 /**
 151  * Returns the current position (or time) of the feed.
 152  * \return VLCTIme object with current time.
 153  */
 154 - (VLCTime *)time;
 155
 156 @property (readonly) VLCTime *remainingTime;
 157 @property (readonly) int fps;
 158
 159 /**
 160  * Return the current video subtitle index, or
 161  * \return NSNotFound if none is set.
 162  *
 163  * To disable subtitle pass NSNotFound.
 164  */
 165 @property (readwrite) NSUInteger currentVideoSubTitleIndex;
 166 - (NSArray *)videoSubTitles;
 167
 168 /**
 169  * Load and set a specific video subtitle, from a file.
 170  * \param path to a file
 171  * \return if the call succeed..
 172  */
 173 - (BOOL)openVideoSubTitlesFromFile:(NSString *)path;
 174
 175 /**
 176  * Chapter selection and enumeration, it is bound
 177  * to a title option.
 178  */
 179
 180 /**
 181  * Return the current video subtitle index, or
 182  * \return NSNotFound if none is set.
 183  *
 184  * To disable subtitle pass NSNotFound.
 185  */
 186 @property (readwrite) NSUInteger currentChapterIndex;
 187 - (void)previousChapter;
 188 - (void)nextChapter;
 189 - (NSArray *)chaptersForTitleIndex:(NSUInteger)titleIndex;
 190
 191 /**
 192  * Title selection and enumeration
 193  * \return NSNotFound if none is set.
 194  */
 195 @property (readwrite) NSUInteger currentTitleIndex;
 196 - (NSArray *)titles;
 197
 198 /* Audio Options */
 199 @property (readwrite) NSUInteger currentAudioTrackIndex;
 200 - (NSArray *)audioTracks;
 201
 202 - (void)setAudioChannel:(int)value;
 203 - (int)audioChannel;
 204
 205 /* Media Options */
 206 - (void)setMedia:(VLCMedia *)value;
 207 - (VLCMedia *)media;
 208
 209 /* Playback Operations */
 210 /**
 211  * Plays a media resource using the currently selected media controller (or
 212  * default controller.  If feed was paused then the feed resumes at the position
 213  * it was paused in.
 214  * \return A Boolean determining whether the stream was played or not.
 215  */
 216 - (BOOL)play;
 217
 218 /**
 219  * Toggle's the pause state of the feed.
 220  */
 221 - (void)pause;
 222
 223 /**
 224  * Stop the playing.
 225  */
 226 - (void)stop;
 227
 228 /**
 229  * Fast forwards through the feed at the standard 1x rate.
 230  */
 231 - (void)fastForward;
 232
 233 /**
 234  * Fast forwards through the feed at the rate specified.
 235  * \param rate Rate at which the feed should be fast forwarded.
 236  */
 237 - (void)fastForwardAtRate:(float)rate;
 238
 239 /**
 240  * Rewinds through the feed at the standard 1x rate.
 241  */
 242 - (void)rewind;
 243
 244 /**
 245  * Rewinds through the feed at the rate specified.
 246  * \param rate Rate at which the feed should be fast rewound.
 247  */
 248 - (void)rewindAtRate:(float)rate;
 249
 250 /**
 251  * Jumps shortly backward in current stream if seeking is supported.
 252  * \param interval to skip, in sec.
 253  */
 254 - (void)jumpBackward:(NSInteger)interval;
 255
 256 /**
 257  * Jumps shortly forward in current stream if seeking is supported.
 258  * \param interval to skip, in sec.
 259  */
 260 - (void)jumpForward:(NSInteger)interval;
 261
 262 /**
 263  * Jumps shortly backward in current stream if seeking is supported.
 264  */
 265 - (void)extraShortJumpBackward;
 266
 267 /**
 268  * Jumps shortly forward in current stream if seeking is supported.
 269  */
 270 - (void)extraShortJumpForward;
 271
 272 /**
 273  * Jumps shortly backward in current stream if seeking is supported.
 274  */
 275 - (void)shortJumpBackward;
 276
 277 /**
 278  * Jumps shortly forward in current stream if seeking is supported.
 279  */
 280 - (void)shortJumpForward;
 281
 282 /**
 283  * Jumps shortly backward in current stream if seeking is supported.
 284  */
 285 - (void)mediumJumpBackward;
 286
 287 /**
 288  * Jumps shortly forward in current stream if seeking is supported.
 289  */
 290 - (void)mediumJumpForward;
 291
 292 /**
 293  * Jumps shortly backward in current stream if seeking is supported.
 294  */
 295 - (void)longJumpBackward;
 296
 297 /**
 298  * Jumps shortly forward in current stream if seeking is supported.
 299  */
 300 - (void)longJumpForward;
 301
 302 /* Playback Information */
 303 /**
 304  * Playback state flag identifying that the stream is currently playing.
 305  * \return TRUE if the feed is playing, FALSE if otherwise.
 306  */
 307 - (BOOL)isPlaying;
 308
 309 /**
 310  * Playback state flag identifying wheather the stream will play.
 311  * \return TRUE if the feed is ready for playback, FALSE if otherwise.
 312  */
 313 - (BOOL)willPlay;
 314
 315 /**
 316  * Playback's current state.
 317  * \see VLCMediaState
 318  */
 319 - (VLCMediaPlayerState)state;
 320
 321 /**
 322  * Returns the receiver's position in the reading.
 323  * \return A number between 0 and 1. indicating the position
 324  */
 325 - (float)position;
 326 - (void)setPosition:(float)newPosition;
 327
 328 - (BOOL)isSeekable;
 329
 330 - (BOOL)canPause;
 331
 332 @end