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)
129 * \param enable boolean to enable or disable deinterlace filter
131 - (void)setDeinterlaceFilter: (NSString *)name enabled: (BOOL)enabled;
133 @property float rate;
135 @property (readonly) VLCAudio * audio;
137 /* Video Information */
140 - (float)framesPerSecond;
143 * Sets the current position (or time) of the feed.
144 * \param value New time to set the current position to. If time is [VLCTime nullTime], 0 is assumed.
146 - (void)setTime:(VLCTime *)value;
149 * Returns the current position (or time) of the feed.
150 * \return VLCTIme object with current time.
154 @property (readonly) VLCTime *remainingTime;
155 @property (readonly) NSUInteger fps;
158 * Return the current video subtitle index
159 * \return 0 if none is set.
163 @property (readwrite) NSUInteger currentVideoSubTitleIndex;
166 * Return the video subtitle tracks
168 * It includes the disabled fake track at index 0.
170 - (NSArray *)videoSubTitles;
173 * Load and set a specific video subtitle, from a file.
174 * \param path to a file
175 * \return if the call succeed..
177 - (BOOL)openVideoSubTitlesFromFile:(NSString *)path;
180 * Chapter selection and enumeration, it is bound
185 * Return the current video subtitle index, or
186 * \return NSNotFound if none is set.
188 * To disable subtitle pass NSNotFound.
190 @property (readwrite) NSUInteger currentChapterIndex;
191 - (void)previousChapter;
193 - (NSArray *)chaptersForTitleIndex:(NSUInteger)titleIndex;
196 * Title selection and enumeration
197 * \return NSNotFound if none is set.
199 @property (readwrite) NSUInteger currentTitleIndex;
205 * Return the current audio track index
206 * \return 0 if none is set.
210 @property (readwrite) NSUInteger currentAudioTrackIndex;
213 * Return the audio tracks
215 * It includes the "Disable" fake track at index 0.
217 - (NSArray *)audioTracks;
219 - (void)setAudioChannel:(NSInteger)value;
220 - (NSInteger)audioChannel;
223 - (void)setMedia:(VLCMedia *)value;
226 /* Playback Operations */
228 * Plays a media resource using the currently selected media controller (or
229 * default controller. If feed was paused then the feed resumes at the position
231 * \return A Boolean determining whether the stream was played or not.
236 * Toggle's the pause state of the feed.
248 - (void)gotoNextFrame;
251 * Fast forwards through the feed at the standard 1x rate.
256 * Fast forwards through the feed at the rate specified.
257 * \param rate Rate at which the feed should be fast forwarded.
259 - (void)fastForwardAtRate:(float)rate;
262 * Rewinds through the feed at the standard 1x rate.
267 * Rewinds through the feed at the rate specified.
268 * \param rate Rate at which the feed should be fast rewound.
270 - (void)rewindAtRate:(float)rate;
273 * Jumps shortly backward in current stream if seeking is supported.
274 * \param interval to skip, in sec.
276 - (void)jumpBackward:(NSInteger)interval;
279 * Jumps shortly forward in current stream if seeking is supported.
280 * \param interval to skip, in sec.
282 - (void)jumpForward:(NSInteger)interval;
285 * Jumps shortly backward in current stream if seeking is supported.
287 - (void)extraShortJumpBackward;
290 * Jumps shortly forward in current stream if seeking is supported.
292 - (void)extraShortJumpForward;
295 * Jumps shortly backward in current stream if seeking is supported.
297 - (void)shortJumpBackward;
300 * Jumps shortly forward in current stream if seeking is supported.
302 - (void)shortJumpForward;
305 * Jumps shortly backward in current stream if seeking is supported.
307 - (void)mediumJumpBackward;
310 * Jumps shortly forward in current stream if seeking is supported.
312 - (void)mediumJumpForward;
315 * Jumps shortly backward in current stream if seeking is supported.
317 - (void)longJumpBackward;
320 * Jumps shortly forward in current stream if seeking is supported.
322 - (void)longJumpForward;
324 /* Playback Information */
326 * Playback state flag identifying that the stream is currently playing.
327 * \return TRUE if the feed is playing, FALSE if otherwise.
332 * Playback state flag identifying wheather the stream will play.
333 * \return TRUE if the feed is ready for playback, FALSE if otherwise.
338 * Playback's current state.
341 - (VLCMediaPlayerState)state;
344 * Returns the receiver's position in the reading.
345 * \return A number between 0 and 1. indicating the position
348 - (void)setPosition:(float)newPosition;