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
9 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
10 * Felix Paul Kühne <fkuehne # videolan.org>
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.
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.
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 *****************************************************************************/
28 #import "VLCVideoView.h"
29 #import "VLCVideoLayer.h"
33 /* Notification Messages */
34 extern NSString * VLCMediaPlayerTimeChanged;
35 extern NSString * VLCMediaPlayerStateChanged;
38 * VLCMediaPlayerState describes the state of the media player.
40 typedef enum VLCMediaPlayerState
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;
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.
56 extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
59 * Formal protocol declaration for playback delegates. Allows playback messages
60 * to be trapped by delegated objects.
62 @protocol VLCMediaPlayerDelegate
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.
68 - (void)mediaPlayerTimeChanged:(NSNotification *)aNotification;
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.
75 - (void)mediaPlayerStateChanged:(NSNotification *)aNotification;
78 // TODO: Should we use medialist_player or our own flavor of media player?
79 @interface VLCMediaPlayer : NSObject
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 VLCTime * cachedRemainingTime; //< Cached remaining time of the media being played
86 VLCMediaPlayerState cachedState; //< Cached state of the media being played
87 float position; //< The position of the media being played
88 id drawable; //< The drawable associated to this media player
92 - (id)initWithVideoView:(VLCVideoView *)aVideoView;
93 - (id)initWithVideoLayer:(VLCVideoLayer *)aVideoLayer;
96 - (void)setDelegate:(id)value;
99 /* Video View Options */
100 // TODO: Should be it's own object?
102 - (void)setVideoView:(VLCVideoView *)aVideoView;
103 - (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer;
105 @property (retain) id drawable; /* The videoView or videoLayer */
107 - (void)setVideoAspectRatio:(char *)value;
108 - (char *)videoAspectRatio;
110 - (void)setVideoCropGeometry:(char *)value;
111 - (char *)videoCropGeometry;
114 * Take a snapshot of the current video.
116 * If width AND height is 0, original size is used.
117 * If width OR height is 0, original aspect-ratio is preserved.
119 * \param path the path where to save the screenshot to
120 * \param width the snapshot's width
121 * \param height the snapshot's height
123 - (void)saveVideoSnapshotAt: (NSString *)path withWidth:(NSUInteger)width andHeight:(NSUInteger)height;
126 * Enable or disable deinterlace filter
128 * \param name of deinterlace filter to use (availability depends on underlying VLC version), NULL to disable.
130 - (void)setDeinterlaceFilter: (NSString *)name;
132 @property float rate;
134 @property (readonly) VLCAudio * audio;
136 /* Video Information */
139 - (float)framesPerSecond;
142 * Sets the current position (or time) of the feed.
143 * \param value New time to set the current position to. If time is [VLCTime nullTime], 0 is assumed.
145 - (void)setTime:(VLCTime *)value;
148 * Returns the current position (or time) of the feed.
149 * \return VLCTIme object with current time.
153 @property (readonly) VLCTime *remainingTime;
154 @property (readonly) NSUInteger fps;
157 * Return the current video subtitle index
158 * \return 0 if none is set.
162 @property (readwrite) NSUInteger currentVideoSubTitleIndex;
165 * Return the video subtitle tracks
167 * It includes the disabled fake track at index 0.
169 - (NSArray *)videoSubTitles;
172 * Load and set a specific video subtitle, from a file.
173 * \param path to a file
174 * \return if the call succeed..
176 - (BOOL)openVideoSubTitlesFromFile:(NSString *)path;
179 * Chapter selection and enumeration, it is bound
184 * Return the current video subtitle index, or
185 * \return NSNotFound if none is set.
187 * To disable subtitle pass NSNotFound.
189 @property (readwrite) NSUInteger currentChapterIndex;
190 - (void)previousChapter;
192 - (NSArray *)chaptersForTitleIndex:(NSUInteger)titleIndex;
195 * Title selection and enumeration
196 * \return NSNotFound if none is set.
198 @property (readwrite) NSUInteger currentTitleIndex;
204 * Return the current audio track index
205 * \return 0 if none is set.
209 @property (readwrite) NSUInteger currentAudioTrackIndex;
212 * Return the audio tracks
214 * It includes the "Disable" fake track at index 0.
216 - (NSArray *)audioTracks;
218 - (void)setAudioChannel:(NSInteger)value;
219 - (NSInteger)audioChannel;
222 - (void)setMedia:(VLCMedia *)value;
225 /* Playback Operations */
227 * Plays a media resource using the currently selected media controller (or
228 * default controller. If feed was paused then the feed resumes at the position
230 * \return A Boolean determining whether the stream was played or not.
235 * Toggle's the pause state of the feed.
247 - (void)gotoNextFrame;
250 * Fast forwards through the feed at the standard 1x rate.
255 * Fast forwards through the feed at the rate specified.
256 * \param rate Rate at which the feed should be fast forwarded.
258 - (void)fastForwardAtRate:(float)rate;
261 * Rewinds through the feed at the standard 1x rate.
266 * Rewinds through the feed at the rate specified.
267 * \param rate Rate at which the feed should be fast rewound.
269 - (void)rewindAtRate:(float)rate;
272 * Jumps shortly backward in current stream if seeking is supported.
273 * \param interval to skip, in sec.
275 - (void)jumpBackward:(NSInteger)interval;
278 * Jumps shortly forward in current stream if seeking is supported.
279 * \param interval to skip, in sec.
281 - (void)jumpForward:(NSInteger)interval;
284 * Jumps shortly backward in current stream if seeking is supported.
286 - (void)extraShortJumpBackward;
289 * Jumps shortly forward in current stream if seeking is supported.
291 - (void)extraShortJumpForward;
294 * Jumps shortly backward in current stream if seeking is supported.
296 - (void)shortJumpBackward;
299 * Jumps shortly forward in current stream if seeking is supported.
301 - (void)shortJumpForward;
304 * Jumps shortly backward in current stream if seeking is supported.
306 - (void)mediumJumpBackward;
309 * Jumps shortly forward in current stream if seeking is supported.
311 - (void)mediumJumpForward;
314 * Jumps shortly backward in current stream if seeking is supported.
316 - (void)longJumpBackward;
319 * Jumps shortly forward in current stream if seeking is supported.
321 - (void)longJumpForward;
323 /* Playback Information */
325 * Playback state flag identifying that the stream is currently playing.
326 * \return TRUE if the feed is playing, FALSE if otherwise.
331 * Playback state flag identifying wheather the stream will play.
332 * \return TRUE if the feed is ready for playback, FALSE if otherwise.
337 * Playback's current state.
340 - (VLCMediaPlayerState)state;
343 * Returns the receiver's position in the reading.
344 * \return A number between 0 and 1. indicating the position
347 - (void)setPosition:(float)newPosition;