1 /*****************************************************************************
2 * VLCMediaPlayer.m: VLCKit.framework VLCMediaPlayer implementation
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 * Faustion Osuna <enrique.osuna # gmail.com>
11 * Felix Paul Kühne <fkuehne # videolan.org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
28 #import "VLCLibrary.h"
29 #import "VLCMediaPlayer.h"
30 #import "VLCEventManager.h"
31 #import "VLCLibVLCBridging.h"
32 #import "VLCVideoView.h"
37 /* prevent system sleep */
38 #import <CoreServices/CoreServices.h>
39 /* FIXME: Ugly hack! */
41 #import <CoreServices/../Frameworks/OSServices.framework/Headers/Power.h>
46 /* Notification Messages */
47 NSString * VLCMediaPlayerTimeChanged = @"VLCMediaPlayerTimeChanged";
48 NSString * VLCMediaPlayerStateChanged = @"VLCMediaPlayerStateChanged";
50 NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state)
52 static NSString * stateToStrings[] = {
53 [VLCMediaPlayerStateStopped] = @"VLCMediaPlayerStateStopped",
54 [VLCMediaPlayerStateOpening] = @"VLCMediaPlayerStateOpening",
55 [VLCMediaPlayerStateBuffering] = @"VLCMediaPlayerStateBuffering",
56 [VLCMediaPlayerStateEnded] = @"VLCMediaPlayerStateEnded",
57 [VLCMediaPlayerStateError] = @"VLCMediaPlayerStateError",
58 [VLCMediaPlayerStatePlaying] = @"VLCMediaPlayerStatePlaying",
59 [VLCMediaPlayerStatePaused] = @"VLCMediaPlayerStatePaused"
61 return stateToStrings[state];
64 /* libvlc event callback */
65 static void HandleMediaInstanceVolumeChanged(const libvlc_event_t * event, void * self)
67 [[VLCEventManager sharedManager] callOnMainThreadDelegateOfObject:self
68 withDelegateMethod:@selector(mediaPlayerVolumeChanged:)
69 withNotificationName:VLCMediaPlayerVolumeChanged];
72 static void HandleMediaTimeChanged(const libvlc_event_t * event, void * self)
74 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
75 [[VLCEventManager sharedManager] callOnMainThreadObject:self
76 withMethod:@selector(mediaPlayerTimeChanged:)
77 withArgumentAsObject:[NSNumber numberWithLongLong:event->u.media_player_time_changed.new_time]];
79 [[VLCEventManager sharedManager] callOnMainThreadDelegateOfObject:self
80 withDelegateMethod:@selector(mediaPlayerTimeChanged:)
81 withNotificationName:VLCMediaPlayerTimeChanged];
85 static void HandleMediaPositionChanged(const libvlc_event_t * event, void * self)
87 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
89 [[VLCEventManager sharedManager] callOnMainThreadObject:self
90 withMethod:@selector(mediaPlayerPositionChanged:)
91 withArgumentAsObject:[NSNumber numberWithFloat:event->u.media_player_position_changed.new_position]];
95 static void HandleMediaInstanceStateChanged(const libvlc_event_t * event, void * self)
97 VLCMediaPlayerState newState;
99 if( event->type == libvlc_MediaPlayerPlaying )
100 newState = VLCMediaPlayerStatePlaying;
101 else if( event->type == libvlc_MediaPlayerPaused )
102 newState = VLCMediaPlayerStatePaused;
103 else if( event->type == libvlc_MediaPlayerEndReached )
104 newState = VLCMediaPlayerStateStopped;
105 else if( event->type == libvlc_MediaPlayerEncounteredError )
106 newState = VLCMediaPlayerStateError;
109 NSLog(@"%s: Unknown event", __FUNCTION__);
113 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
115 [[VLCEventManager sharedManager] callOnMainThreadObject:self
116 withMethod:@selector(mediaPlayerStateChanged:)
117 withArgumentAsObject:[NSNumber numberWithInt:newState]];
119 [[VLCEventManager sharedManager] callOnMainThreadDelegateOfObject:self
120 withDelegateMethod:@selector(mediaPlayerStateChanged:)
121 withNotificationName:VLCMediaPlayerStateChanged];
127 static void HandleMediaPlayerMediaChanged(const libvlc_event_t * event, void * self)
129 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
131 [[VLCEventManager sharedManager] callOnMainThreadObject:self
132 withMethod:@selector(mediaPlayerMediaChanged:)
133 withArgumentAsObject:[VLCMedia mediaWithLibVLCMediaDescriptor:event->u.media_player_media_changed.new_media]];
140 // TODO: Documentation
141 @interface VLCMediaPlayer (Private)
142 - (id)initWithDrawable:(id)aDrawable;
144 - (void)registerObservers;
145 - (void)unregisterObservers;
146 - (void)mediaPlayerTimeChanged:(NSNumber *)newTime;
147 - (void)mediaPlayerPositionChanged:(NSNumber *)newTime;
148 - (void)mediaPlayerStateChanged:(NSNumber *)newState;
149 - (void)mediaPlayerMediaChanged:(VLCMedia *)media;
152 @implementation VLCMediaPlayer
155 + (NSSet *)keyPathsForValuesAffectingValueForKey:(NSString *)key
157 static NSDictionary * dict = nil;
158 NSSet * superKeyPaths;
161 dict = [[NSDictionary dictionaryWithObjectsAndKeys:
162 [NSSet setWithObject:@"state"], @"playing",
163 [NSSet setWithObjects:@"state", @"media", nil], @"seekable",
164 [NSSet setWithObjects:@"state", @"media", nil], @"canPause",
165 [NSSet setWithObjects:@"state", @"media", nil], @"description",
168 if( (superKeyPaths = [super keyPathsForValuesAffectingValueForKey: key]) )
170 NSMutableSet * ret = [NSMutableSet setWithSet:[dict objectForKey: key]];
171 [ret unionSet:superKeyPaths];
174 return [dict objectForKey: key];
180 return [self initWithDrawable:nil];
183 - (id)initWithVideoView:(VLCVideoView *)aVideoView
185 return [self initWithDrawable: aVideoView];
188 - (id)initWithVideoLayer:(VLCVideoLayer *)aVideoLayer
190 return [self initWithDrawable: aVideoLayer];
197 if([self retainCount] <= 1)
199 /* We must make sure we won't receive new event after an upcoming dealloc
200 * We also may receive a -retain in some event callback that may occcur
201 * Before libvlc_event_detach. So this can't happen in dealloc */
202 [self unregisterObservers];
210 NSAssert(libvlc_media_player_get_state(instance) == libvlc_Stopped, @"You released the media player before ensuring that it is stopped");
212 // Always get rid of the delegate first so we can stop sending messages to it
213 // TODO: Should we tell the delegate that we're shutting down?
216 // Clear our drawable as we are going to release it, we don't
217 // want the core to use it from this point. This won't happen as
218 // the media player must be stopped.
219 libvlc_media_player_set_nsobject(instance, nil);
221 libvlc_media_player_release(instance);
223 // Get rid of everything else
225 [cachedTime release];
226 [cachedRemainingTime release];
232 - (void)setDelegate:(id)value
242 - (void)setVideoView:(VLCVideoView *)aVideoView
244 [self setDrawable: aVideoView];
247 - (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer
249 [self setDrawable: aVideoLayer];
252 - (void)setDrawable:(id)aDrawable
254 // Make sure that this instance has been associated with the drawing canvas.
255 libvlc_media_player_set_nsobject(instance, aDrawable);
260 return libvlc_media_player_get_nsobject(instance);
265 return [[VLCLibrary sharedLibrary] audio];
269 #pragma mark Subtitles
271 - (void)setCurrentVideoSubTitleIndex:(NSUInteger)index
273 libvlc_exception_t ex;
274 libvlc_exception_init( &ex );
275 libvlc_video_set_spu( instance, (int)index, &ex );
276 catch_exception( &ex );
279 - (NSUInteger)currentVideoSubTitleIndex
281 libvlc_exception_t ex;
282 libvlc_exception_init( &ex );
283 NSInteger count = libvlc_video_get_spu_count( instance, &ex );
284 if (libvlc_exception_raised( &ex ))
286 libvlc_exception_clear( &ex );
291 NSUInteger result = libvlc_video_get_spu( instance, &ex );
292 if (libvlc_exception_raised( &ex ))
294 libvlc_exception_clear( &ex );
301 - (BOOL)openVideoSubTitlesFromFile:(NSString *)path
303 return libvlc_video_set_subtitle_file(instance, [path UTF8String]);
306 - (NSArray *)videoSubTitles
308 libvlc_track_description_t *currentTrack = libvlc_video_get_spu_description(instance);
310 NSMutableArray *tempArray = [NSMutableArray array];
311 while (currentTrack) {
312 [tempArray addObject:[NSString stringWithUTF8String:currentTrack->psz_name]];
313 currentTrack = currentTrack->p_next;
315 libvlc_track_description_release(currentTrack);
316 return [NSArray arrayWithArray: tempArray];
321 #pragma mark Video Crop geometry
323 - (void)setVideoCropGeometry:(char *)value
325 libvlc_exception_t ex;
326 libvlc_exception_init( &ex );
327 libvlc_video_set_crop_geometry( instance, value, &ex );
328 catch_exception( &ex );
331 - (char *)videoCropGeometry
333 libvlc_exception_t ex;
334 libvlc_exception_init( &ex );
335 char * result = libvlc_video_get_crop_geometry( instance, &ex );
336 catch_exception( &ex );
340 - (void)setVideoAspectRatio:(char *)value
342 libvlc_exception_t ex;
343 libvlc_exception_init( &ex );
344 libvlc_video_set_aspect_ratio( instance, value, &ex );
345 catch_exception( &ex );
348 - (char *)videoAspectRatio
350 libvlc_exception_t ex;
351 libvlc_exception_init( &ex );
352 char * result = libvlc_video_get_aspect_ratio( instance, &ex );
353 catch_exception( &ex );
357 - (void)saveVideoSnapshotAt: (NSString *)path withWidth:(NSUInteger)width andHeight:(NSUInteger)height
359 libvlc_exception_t ex;
360 libvlc_exception_init( &ex );
361 libvlc_video_take_snapshot( instance, [path UTF8String], width, height, &ex );
362 catch_exception( &ex );
365 - (void)setDeinterlaceFilter: (NSString *)name enabled: (BOOL)enabled
367 libvlc_exception_t ex;
368 libvlc_exception_init( &ex );
369 libvlc_video_set_deinterlace( instance, (int)enabled , [name UTF8String], &ex );
370 catch_exception( &ex );
373 - (void)setRate:(float)value
375 libvlc_media_player_set_rate(instance, value);
380 return libvlc_media_player_get_rate(instance);
385 libvlc_exception_t ex;
386 libvlc_exception_init( &ex );
387 NSSize result = NSMakeSize(libvlc_video_get_height((libvlc_media_player_t *)instance, &ex),
388 libvlc_video_get_width((libvlc_media_player_t *)instance, &ex));
389 catch_exception( &ex );
395 return libvlc_media_player_has_vout(instance);
398 - (float)framesPerSecond
400 return libvlc_media_player_get_fps(instance);
403 - (void)setTime:(VLCTime *)value
405 // Time is managed in seconds, while duration is managed in microseconds
406 // TODO: Redo VLCTime to provide value numberAsMilliseconds, numberAsMicroseconds, numberAsSeconds, numberAsMinutes, numberAsHours
407 libvlc_media_player_set_time(instance, value ? [[value numberValue] longLongValue] : 0);
415 - (VLCTime *)remainingTime
417 return cachedRemainingTime;
422 return libvlc_media_player_get_fps(instance);
426 #pragma mark Chapters
427 - (void)setCurrentChapterIndex:(NSUInteger)value;
429 libvlc_media_player_set_chapter(instance, value);
432 - (NSUInteger)currentChapterIndex
434 NSInteger count = libvlc_media_player_get_chapter_count(instance);
437 NSUInteger result = libvlc_media_player_get_chapter(instance);
443 libvlc_media_player_next_chapter(instance);
446 - (void)previousChapter
448 libvlc_media_player_previous_chapter(instance);
451 - (NSArray *)chaptersForTitleIndex:(NSUInteger)title
453 NSInteger count = libvlc_media_player_get_chapter_count(instance);
455 return [NSArray array];
457 libvlc_track_description_t *tracks = libvlc_video_get_chapter_description(instance, title);
458 NSMutableArray *tempArray = [NSMutableArray array];
460 for (i = 0; i < count ; i++)
462 [tempArray addObject:[NSString stringWithUTF8String:tracks->psz_name]];
463 tracks = tracks->p_next;
465 libvlc_track_description_release(tracks);
466 return [NSArray arrayWithArray:tempArray];
472 - (void)setCurrentTitleIndex:(NSUInteger)value
474 libvlc_media_player_set_title(instance, value);
477 - (NSUInteger)currentTitleIndex
479 NSInteger count = libvlc_media_player_get_title_count(instance);
483 return libvlc_media_player_get_title(instance);
486 - (NSUInteger)countOfTitles
488 NSUInteger result = libvlc_media_player_get_title_count(instance);
494 libvlc_track_description_t *tracks = libvlc_video_get_title_description(instance);
495 NSMutableArray *tempArray = [NSMutableArray array];
497 for (i = 0; i < [self countOfTitles] ; i++)
499 [tempArray addObject:[NSString stringWithUTF8String: tracks->psz_name]];
500 tracks = tracks->p_next;
502 libvlc_track_description_release(tracks);
503 return [NSArray arrayWithArray: tempArray];
507 #pragma mark Audio tracks
508 - (void)setCurrentAudioTrackIndex:(NSUInteger)value
510 libvlc_audio_set_track( instance, (int)value);
513 - (NSUInteger)currentAudioTrackIndex
515 NSInteger count = libvlc_audio_get_track_count(instance);
519 NSUInteger result = libvlc_audio_get_track(instance);
523 - (NSArray *)audioTracks
525 NSInteger count = libvlc_audio_get_track_count(instance);
527 return [NSArray array];
529 libvlc_track_description_t *tracks = libvlc_audio_get_track_description(instance);
530 NSMutableArray *tempArray = [NSMutableArray array];
532 for (i = 0; i < count ; i++)
534 [tempArray addObject:[NSString stringWithUTF8String: tracks->psz_name]];
535 tracks = tracks->p_next;
537 libvlc_track_description_release(tracks);
539 return [NSArray arrayWithArray: tempArray];
542 - (void)setAudioChannel:(NSInteger)value
544 libvlc_audio_set_channel(instance, value);
547 - (NSInteger)audioChannel
549 return libvlc_audio_get_channel(instance);
552 - (void)setMedia:(VLCMedia *)value
556 if (media && [media compare:value] == NSOrderedSame)
560 media = [value retain];
562 libvlc_media_player_set_media(instance, [media libVLCMediaDescriptor]);
573 libvlc_media_player_play(instance);
579 if( [NSThread isMainThread] )
581 /* Hack because we create a dead lock here, when the vout is stopped
582 * and tries to recontact us on the main thread */
583 /* FIXME: to do this properly we need to do some locking. We may want
584 * to move that to libvlc */
585 [self performSelectorInBackground:@selector(pause) withObject:nil];
590 libvlc_media_player_pause(instance);
595 libvlc_media_player_stop(instance);
598 - (void)gotoNextFrame
600 libvlc_media_player_next_frame(instance);
606 [self fastForwardAtRate: 2.0];
609 - (void)fastForwardAtRate:(float)rate
616 [self rewindAtRate: 2.0];
619 - (void)rewindAtRate:(float)rate
621 [self setRate: -rate];
624 - (void)jumpBackward:(NSInteger)interval
626 if( [self isSeekable] )
628 interval = interval * 1000;
629 [self setTime: [VLCTime timeWithInt: ([[self time] intValue] - interval)]];
633 - (void)jumpForward:(NSInteger)interval
635 if( [self isSeekable] )
637 interval = interval * 1000;
638 [self setTime: [VLCTime timeWithInt: ([[self time] intValue] + interval)]];
642 - (void)extraShortJumpBackward
644 [self jumpBackward:3];
647 - (void)extraShortJumpForward
649 [self jumpForward:3];
652 - (void)shortJumpBackward
654 [self jumpBackward:10];
657 - (void)shortJumpForward
659 [self jumpForward:10];
662 - (void)mediumJumpBackward
664 [self jumpBackward:60];
667 - (void)mediumJumpForward
669 [self jumpForward:60];
672 - (void)longJumpBackward
674 [self jumpBackward:300];
677 - (void)longJumpForward
679 [self jumpForward:300];
682 + (NSSet *)keyPathsForValuesAffectingIsPlaying
684 return [NSSet setWithObjects:@"state", nil];
689 VLCMediaPlayerState state = [self state];
690 return ((state == VLCMediaPlayerStateOpening) || (state == VLCMediaPlayerStateBuffering) ||
691 (state == VLCMediaPlayerStatePlaying));
696 return libvlc_media_player_will_play(instance);
699 static const VLCMediaPlayerState libvlc_to_local_state[] =
701 [libvlc_Stopped] = VLCMediaPlayerStateStopped,
702 [libvlc_Opening] = VLCMediaPlayerStateOpening,
703 [libvlc_Buffering] = VLCMediaPlayerStateBuffering,
704 [libvlc_Playing] = VLCMediaPlayerStatePlaying,
705 [libvlc_Paused] = VLCMediaPlayerStatePaused,
706 [libvlc_Ended] = VLCMediaPlayerStateEnded,
707 [libvlc_Error] = VLCMediaPlayerStateError
710 - (VLCMediaPlayerState)state
720 - (void)setPosition:(float)newPosition
722 libvlc_media_player_set_position(instance, newPosition);
727 return libvlc_media_player_is_seekable(instance);
732 return libvlc_media_player_can_pause(instance);
735 - (void *)libVLCMediaPlayer
741 @implementation VLCMediaPlayer (Private)
742 - (id)initWithDrawable:(id)aDrawable
744 if (self = [super init])
748 cachedTime = [[VLCTime nullTime] retain];
749 cachedRemainingTime = [[VLCTime nullTime] retain];
751 cachedState = VLCMediaPlayerStateStopped;
753 // Create a media instance, it doesn't matter what library we start off with
754 // it will change depending on the media descriptor provided to the media
756 libvlc_exception_t ex;
757 libvlc_exception_init( &ex );
758 instance = libvlc_media_player_new([VLCLibrary sharedInstance]);
759 catch_exception( &ex );
761 [self registerObservers];
763 [self setDrawable:aDrawable];
768 - (void)registerObservers
770 // Attach event observers into the media instance
771 libvlc_event_manager_t * p_em = libvlc_media_player_event_manager(instance);
772 libvlc_event_attach(p_em, libvlc_MediaPlayerPlaying, HandleMediaInstanceStateChanged, self);
773 libvlc_event_attach(p_em, libvlc_MediaPlayerPaused, HandleMediaInstanceStateChanged, self);
774 libvlc_event_attach(p_em, libvlc_MediaPlayerEncounteredError, HandleMediaInstanceStateChanged, self);
775 libvlc_event_attach(p_em, libvlc_MediaPlayerEndReached, HandleMediaInstanceStateChanged, self);
776 /* FIXME: We may want to turn that off when none is interested by that */
777 libvlc_event_attach(p_em, libvlc_MediaPlayerPositionChanged, HandleMediaPositionChanged, self);
778 libvlc_event_attach(p_em, libvlc_MediaPlayerTimeChanged, HandleMediaTimeChanged, self);
779 libvlc_event_attach(p_em, libvlc_MediaPlayerMediaChanged, HandleMediaPlayerMediaChanged, self);
782 - (void)unregisterObservers
784 libvlc_event_manager_t * p_em = libvlc_media_player_event_manager(instance);
785 libvlc_event_detach(p_em, libvlc_MediaPlayerPlaying, HandleMediaInstanceStateChanged, self);
786 libvlc_event_detach(p_em, libvlc_MediaPlayerPaused, HandleMediaInstanceStateChanged, self);
787 libvlc_event_detach(p_em, libvlc_MediaPlayerEncounteredError, HandleMediaInstanceStateChanged, self);
788 libvlc_event_detach(p_em, libvlc_MediaPlayerEndReached, HandleMediaInstanceStateChanged, self);
789 libvlc_event_detach(p_em, libvlc_MediaPlayerPositionChanged, HandleMediaPositionChanged, self);
790 libvlc_event_detach(p_em, libvlc_MediaPlayerTimeChanged, HandleMediaTimeChanged, self);
791 libvlc_event_detach(p_em, libvlc_MediaPlayerMediaChanged, HandleMediaPlayerMediaChanged, self);
794 - (void)mediaPlayerTimeChanged:(NSNumber *)newTime
796 [self willChangeValueForKey:@"time"];
797 [self willChangeValueForKey:@"remainingTime"];
798 [cachedTime release];
799 cachedTime = [[VLCTime timeWithNumber:newTime] retain];
800 [cachedRemainingTime release];
801 double currentTime = [[cachedTime numberValue] doubleValue];
802 double remaining = currentTime / position * (1 - position);
803 cachedRemainingTime = [[VLCTime timeWithNumber:[NSNumber numberWithDouble:-remaining]] retain];
804 [self didChangeValueForKey:@"remainingTime"];
805 [self didChangeValueForKey:@"time"];
810 UpdateSystemActivity(UsrActivity);
813 - (void)mediaPlayerPositionChanged:(NSNumber *)newPosition
815 // This seems to be the most relevant place to delay sleeping and screen saver.
818 [self willChangeValueForKey:@"position"];
819 position = [newPosition floatValue];
820 [self didChangeValueForKey:@"position"];
823 - (void)mediaPlayerStateChanged:(NSNumber *)newState
825 [self willChangeValueForKey:@"state"];
826 cachedState = [newState intValue];
827 [self didChangeValueForKey:@"state"];
830 - (void)mediaPlayerMediaChanged:(VLCMedia *)newMedia
832 [self willChangeValueForKey:@"media"];
833 if (media != newMedia)
836 media = [newMedia retain];
838 [self didChangeValueForKey:@"media"];