MacOSX/Framework: Minor various spaces/comment cleanup.
authorPierre d'Herbemont <pdherbemont@videolan.org>
Sat, 20 Oct 2007 17:09:37 +0000 (17:09 +0000)
committerPierre d'Herbemont <pdherbemont@videolan.org>
Sat, 20 Oct 2007 17:09:37 +0000 (17:09 +0000)
19 files changed:
extras/MacOSX/Framework/Headers/Internal/VLCEventManager.h
extras/MacOSX/Framework/Headers/Internal/VLCLibVLCBridging.h
extras/MacOSX/Framework/Headers/Internal/VLCLibrary.h
extras/MacOSX/Framework/Headers/Public/VLCAudio.h
extras/MacOSX/Framework/Headers/Public/VLCMedia.h
extras/MacOSX/Framework/Headers/Public/VLCMediaLibrary.h
extras/MacOSX/Framework/Headers/Public/VLCMediaList.h
extras/MacOSX/Framework/Headers/Public/VLCMediaPlayer.h
extras/MacOSX/Framework/Headers/Public/VLCTime.h
extras/MacOSX/Framework/Headers/Public/VLCVideoView.h
extras/MacOSX/Framework/Sources/VLCAudio.m
extras/MacOSX/Framework/Sources/VLCEventManager.m
extras/MacOSX/Framework/Sources/VLCLibrary.m
extras/MacOSX/Framework/Sources/VLCMedia.m
extras/MacOSX/Framework/Sources/VLCMediaLibrary.m
extras/MacOSX/Framework/Sources/VLCMediaList.m
extras/MacOSX/Framework/Sources/VLCMediaPlayer.m
extras/MacOSX/Framework/Sources/VLCTime.m
extras/MacOSX/Framework/Sources/VLCVideoView.m

index 8f4f04d..4afa06a 100644 (file)
@@ -43,5 +43,4 @@
 - (void)callOnMainThreadObject:(id)aTarget 
                     withMethod:(SEL)aSelector 
           withArgumentAsObject:(id)arg;
-
 @end
index 72a36ab..a123d29 100644 (file)
 
 // TODO: Documentation
 @interface VLCMediaList (LibVLCBridging)
-
 + (id)medialistWithLibVLCMediaList:(void *)p_new_mlist;
 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
 - (void *)libVLCMediaList;
-
 @end
 
 /**
 * Bridges functionality between libvlc and VLCMedia implementation.
  */
 @interface VLCMedia (LibVLCBridging)
-
 /* Object Factory */
 /**
  * Manufactures new object wrapped around specified media descriptor.
  * \return The receiver's internal media descriptor pointer.
  */
 - (void *)libVLCMediaDescriptor;
-
 @end
 
 // TODO: Documentation
 @interface VLCMedia (VLCMediaPlayerBridging)
-
 - (void)setLength:(VLCTime *)value;
-
 @end
 
 // TODO: Documentation
 @interface VLCLibrary (VLCAudioBridging)
-
 - (void)setAudio:(VLCAudio *)value;
-
 @end
 
index 0506f4d..6078dda 100644 (file)
@@ -38,7 +38,6 @@ extern NSString *VLCMediaPlayerVolumeChanged;
 {
     VLCLibrary *library;    //< Library to control audio for
 }
-
 /* Initializers */
 - (id)initWithLibrary:(VLCLibrary *)library;
 
@@ -48,5 +47,4 @@ extern NSString *VLCMediaPlayerVolumeChanged;
 
 - (void)setVolume:(int)value;
 - (int)volume;
-
 @end
index 41b45a1..f490d0e 100644 (file)
@@ -66,7 +66,6 @@ extern NSString *VLCMediaMetaChanged;        //< Notification message for when t
  * trapped.
  */
 @protocol VLCMediaDelegate
-
 // TODO: SubItemAdded/SubItemRemoved implementation.  Not sure if we really want to implement this.
 ///**
 // * Delegate method called whenever a sub item has been added to the specified VLCMedia.
@@ -91,7 +90,6 @@ extern NSString *VLCMediaMetaChanged;        //< Notification message for when t
  * \param key The key of the value that was changed.
  */
 - (void)media:(VLCMedia *)aMedia metaValueChangedFrom:(id)oldValue forKey:(NSString *)key;
-
 @end
 
 /**
@@ -103,13 +101,13 @@ extern NSString *VLCMediaMetaChanged;        //< Notification message for when t
  */
 @interface VLCMedia : NSObject
 {
-    void                *p_md;                //< Internal media descriptor instance
-    NSString            *url;                //< URL for this media resource
-    VLCMediaList        *subitems;            //< Sub list of items
-    VLCTime                *length;            //< Duration of the media
-    NSMutableDictionary *metaDictionary;    //< Meta data storage
-    id                     delegate;            //< Delegate object
-    BOOL                 preparsed;            //< Value used to determine of the file has been preparsed
+    void *                p_md;              //< Internal media descriptor instance
+    NSString *            url;               //< URL for this media resource
+    VLCMediaList *        subitems;          //< Sub list of items
+    VLCTime *             length;            //< Duration of the media
+    NSMutableDictionary * metaDictionary;    //< Meta data storage
+    id                    delegate;          //< Delegate object
+    BOOL                  preparsed;         //< Value used to determine of the file has been preparsed
 }
 
 /* Object Factories */
@@ -193,5 +191,4 @@ extern NSString *VLCMediaMetaChanged;        //< Notification message for when t
  * \return The receiver's meta data as a NSDictionary object.
  */
 - (NSDictionary *)metaDictionary;
-
 @end
\ No newline at end of file
index b42c9cc..08f103a 100644 (file)
     void *mlib;
     VLCMediaList *allMedia;
 }
-
 + (id)sharedMediaLibrary;
 
 - (VLCMediaList *)allMedia;
 - (NSArray *)playlists;
-
 @end
index 3f25fc3..9433f34 100644 (file)
@@ -33,16 +33,14 @@ extern NSString *VLCMediaListItemDeleted;
 
 // TODO: Documentation
 @protocol VLCMediaListDelegate
-
 - (void)mediaList:(VLCMediaList *) mediaAdded:(VLCMedia *)media atIndex:(int)index;
 - (void)mediaList:(VLCMediaList *) mediaRemovedAtIndex:(int)index;
-
 @end
 
 // TODO: Documentation
 @interface VLCMediaList : NSObject
 {
-    void *p_mlist;                //< Internal instance of media list
+    void * p_mlist;                //< Internal instance of media list
     id delegate;                //< Delegate object
 }
 
@@ -61,8 +59,9 @@ extern NSString *VLCMediaListItemDeleted;
 - (int)indexOfMedia:(VLCMedia *)media;
 - (int)count;
 
-- (NSArray *)sublists;                    // I don't see why this would be useful
-//- (VLCMediaList *)flatPlaylist;        // nore this one
-//- (VLCMedia *)providerMedia;            // I have no clue what this does
-
+#if 0 /* Disabled until this get fixed in libvlc
+- (NSArray *)sublists; //< A way to see the same media list. Only sub media list.
+- (NSArray *)flatMediaView; //< A way to see the same media list. Only media.
+- (VLCMedia *)providerMedia;  //< If a media was at the origin of this media list, here it is.
+#endif
 @end
\ No newline at end of file
index 5092e90..2acf708 100644 (file)
@@ -34,11 +34,11 @@ typedef enum VLCMediaPlayerState
 {
     VLCMediaPlayerStateStopped,        //< Player has stopped
     VLCMediaPlayerStateOpening,        //< Stream is opening
-    VLCMediaPlayerStateBuffering,    //< Stream is buffering
-    VLCMediaPlayerStateEnded,        //< Stream has ended
-    VLCMediaPlayerStateError,        //< Player has generated an error
+    VLCMediaPlayerStateBuffering,      //< Stream is buffering
+    VLCMediaPlayerStateEnded,          //< Stream has ended
+    VLCMediaPlayerStateError,          //< Player has generated an error
     VLCMediaPlayerStatePlaying,        //< Stream is playing
-    VLCMediaPlayerStatePaused        //< Stream is paused
+    VLCMediaPlayerStatePaused          //< Stream is paused
 } VLCMediaPlayerState;
 
 extern NSString *VLCMediaPlayerStateToString(VLCMediaPlayerState state);
@@ -48,10 +48,8 @@ extern NSString *VLCMediaPlayerStateToString(VLCMediaPlayerState state);
  * to be trapped by delegated objects.
  */
 @protocol VLCMediaPlayerDelegate
-
 - (void)mediaPlayerTimeChanged:(NSNotification *)aNotification;
 - (void)mediaPlayerStateChanged:(NSNotification *)aNotification;
-
 @end
 
 // TODO: Should we use medialist_player or our own flavor of media player?
@@ -177,5 +175,4 @@ extern NSString *VLCMediaPlayerStateToString(VLCMediaPlayerState state);
  * \see VLCMediaState
  */
 - (VLCMediaPlayerState)state;
-     
 @end
index 494abc0..c885e27 100644 (file)
@@ -28,7 +28,6 @@
 {
     NSNumber *value;
 }
-
 + (VLCTime *)nullTime;
 + (VLCTime *)timeWithNumber:(NSNumber *)aNumber;
 //+ (VLCTime *)timeWithString:(NSString *)aString;
@@ -40,5 +39,4 @@
 - (NSString *)stringValue;
 
 - (NSComparisonResult)compare:(VLCTime *)aTime;
-
 @end
index 5c526e8..37531b9 100644 (file)
@@ -29,15 +29,12 @@ extern NSString *VLCVideoViewEnteredFullScreen;
 extern NSString *VLCVideoViewLeftFullScreen;
 
 @protocol VLCVideoViewDelegate
-
 // Notifications defined in VLCVideoView.h
 - (void)videoEnteredFullscreen:(NSNotification *)aNotification;
 - (void)videoLeftFullscreen:(NSNotification *)aNotification;
-
 @end
 
 @protocol VLCOpenGLVoutEmbedding
-
 - (void)addVoutSubview:(NSView *)view;
 - (void)removeVoutSubview:(NSView *)view;
 
@@ -47,7 +44,6 @@ extern NSString *VLCVideoViewLeftFullScreen;
 - (BOOL)stretchesVideo;
 
 //- (void)setOnTop: (BOOL)ontop; /* Do we really want that in protocol? */
-
 @end
 
 @interface VLCVideoView : NSView <VLCOpenGLVoutEmbedding>
@@ -79,5 +75,4 @@ extern NSString *VLCVideoViewLeftFullScreen;
 
 // The media controls that were here previously should be moved elsewhere.  This
 // View is just that, a view not a controller. -- Moved to VLCMediaPlayer
-
 @end
index e7ef4da..5b52fa2 100644 (file)
@@ -80,5 +80,4 @@ NSString *VLCMediaPlayerVolumeChanged = @"VLCMediaPlayerVolumeChanged";
     quit_on_exception(&ex);
     return result;
 }
-
-@end
\ No newline at end of file
+@end
index e0eed6f..c5abdd4 100644 (file)
@@ -45,14 +45,12 @@ struct message {
 };
 
 @interface VLCEventManager (Private)
-
 - (void)callDelegateOfObjectAndSendNotificationWithArgs:(NSData*)data;
 - (void)callObjectMethodWithArgs:(NSData*)data;
 - (void)callDelegateOfObject:(id) aTarget withDelegateMethod:(SEL)aSelector withNotificationName: (NSString *)aNotificationName;
 - (pthread_cond_t *)signalData;
 - (pthread_mutex_t *)queueLock;
 - (NSMutableArray *)messageQueue;
-
 @end
 
 static void * EventDispatcherMainLoop(void * user_data)
@@ -114,7 +112,6 @@ static void * EventDispatcherMainLoop(void * user_data)
 }
 
 @implementation VLCEventManager
-
 + (id)sharedManager
 {
     /* We do want a lock here to avoid leaks */
@@ -189,7 +186,6 @@ static void * EventDispatcherMainLoop(void * user_data)
 @end
 
 @implementation VLCEventManager (Private)
-
 - (void)callDelegateOfObjectAndSendNotificationWithArgs:(NSData*)data
 {
     struct message * message = (struct message *)[data bytes];
@@ -236,5 +232,4 @@ static void * EventDispatcherMainLoop(void * user_data)
     void (*method)(id, SEL, id) = (void (*)(id, SEL, id))[[aTarget delegate] methodForSelector: aSelector];
     method( [aTarget delegate], aSelector, [NSNotification notificationWithName:aNotificationName object:aTarget]);
 }
-
 @end
index 14e7a31..dbc2ba4 100644 (file)
@@ -53,7 +53,6 @@ static void *DestroySharedLibraryAtExit()
 }
 
 @implementation VLCLibrary
-
 + (VLCLibrary *)sharedLibrary
 {
     if (!sharedLibrary) 
@@ -137,16 +136,13 @@ static void *DestroySharedLibraryAtExit()
 {
     return audio;
 }
-
 @end
 
 @implementation VLCLibrary (VLCAudioBridging)
-
 - (void)setAudio:(VLCAudio *)value
 {
     if (!audio)
         audio = value;
 }
-
 @end
 
index ccdabff..8aada4b 100644 (file)
@@ -93,7 +93,6 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
 
 // TODO: Documentation
 @interface VLCMedia (Private)
-
 /* Statics */
 + (libvlc_meta_t)stringToMetaType:(NSString *)string;
 + (NSString *)metaTypeToString:(libvlc_meta_t)type;
@@ -111,11 +110,9 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
 //- (void)subItemAdded:(libvlc_media_descriptor_t *)child;
 //- (void)subItemRemoved:(libvlc_media_descriptor_t *)child;
 - (void)metaChanged:(NSNumber *)metaType;
-
 @end
 
 @implementation VLCMedia
-
 + (id)mediaWithURL:(NSString *)aURL;
 {
     // For some unknown reason, compiler kept shooting me a warning saying:
@@ -257,9 +254,6 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
 
 - (VLCTime *)length
 {
-    // TODO: Value is updated whenever the item is updated in the libvlc 
-    // (var_Addcallback(instance, "item-changed", callback)) would work but 
-    // that's not authorized from here.
     if (!length) 
     {
         // Try figuring out what the length is
@@ -273,11 +267,11 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
     return [VLCTime nullTime];
 }
 
+- (VLCTime *)lengthWaitUntilDate:(NSDate *)aDate
+{
 #define CLOCK_FREQ      1000000
 #define THREAD_SLEEP    ((long long)(0.010*CLOCK_FREQ))
 
-- (VLCTime *)lengthWaitUntilDate:(NSDate *)aDate
-{
     if (![url hasPrefix:@"file://"])
         return [self length];
     else if (!length)
@@ -293,6 +287,8 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
         if (!length)
             return [self length];
     }
+#undef CLOCK_FREQ
+#undef THREAD_SLEEP
     return [[length retain] autorelease];
 }
 
@@ -315,7 +311,6 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
 {
     return delegate;
 }
-
 @end
 
 @implementation VLCMedia (LibVLCBridging)
@@ -372,16 +367,12 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
 {
     return p_md;
 }
-
 @end
 
 @implementation VLCMedia (Private)
-
-#define VLCStringToMeta( name, string ) if ([VLCMetaInformation##name compare:string] == NSOrderedSame) return libvlc_meta_##name;
-#define VLCMetaToString( name, type )   if (libvlc_meta_##name == type) return VLCMetaInformation##name;
-
 + (libvlc_meta_t)stringToMetaType:(NSString *)string
 {
+#define VLCStringToMeta( name, string ) if ([VLCMetaInformation##name compare:string] == NSOrderedSame) return libvlc_meta_##name;
     VLCStringToMeta(Title, string);
     VLCStringToMeta(Artist, string);
     VLCStringToMeta(Genre, string);
@@ -398,11 +389,13 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
     VLCStringToMeta(Publisher, string);
     VLCStringToMeta(ArtworkURL, string);
     VLCStringToMeta(TrackID, string);
+#undef VLCStringToMeta
     return -1;
 }
 
 + (NSString *)metaTypeToString:(libvlc_meta_t)type
 {
+#define VLCMetaToString( name, type )   if (libvlc_meta_##name == type) return VLCMetaInformation##name;
     VLCMetaToString(Title, type);
     VLCMetaToString(Artist, type);
     VLCMetaToString(Genre, type);
@@ -419,6 +412,7 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
     VLCMetaToString(Publisher, type);
     VLCMetaToString(ArtworkURL, type);
     VLCMetaToString(TrackID, type);
+#undef VLCMetaToString
     return nil;
 }
 
@@ -563,7 +557,6 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
         // There was actually a change, send out the notifications
         [self notifyChangeForKey:key withOldValue:oldValue];
 }
-
 @end
 
 @implementation VLCMedia (VLCMediaPlayerBridging)
@@ -588,5 +581,4 @@ static void HandleMediaDurationChanged(const libvlc_event_t *event, void *self)
         [self didChangeValueForKey:@"length"];
     }
 }
-
 @end
index f290daf..5532267 100644 (file)
@@ -32,7 +32,6 @@
 static VLCMediaLibrary * sharedMediaLibrary = nil;
 
 @implementation VLCMediaLibrary
-
 + (id)sharedMediaLibrary
 {
     if(!sharedMediaLibrary)
index d617f88..d779eb6 100644 (file)
@@ -35,14 +35,12 @@ NSString *VLCMediaListItemDeleted    = @"VLCMediaListItemDeleted";
 
 // TODO: Documentation
 @interface VLCMediaList (Private)
-
 /* Initializers */
 - (void)initInternalMediaList;
 
 /* Libvlc event bridges */
 - (void)mediaListItemAdded:(NSArray *)args;
 - (void)mediaListItemRemoved:(NSNumber *)index;
-
 @end
 
 /* libvlc event callback */
@@ -72,7 +70,6 @@ static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * use
 }
 
 @implementation VLCMediaList
-
 - (id)init
 {
     if (self = [super init])
@@ -245,11 +242,9 @@ static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * use
 //    quit_on_exception( &p_e );
 //    return ret;
 //}
-
 @end
 
 @implementation VLCMediaList (LibVLCBridging)
-
 + (id)medialistWithLibVLCMediaList:(void *)p_new_mlist;
 {
     return [[[VLCMediaList alloc] initWithLibVLCMediaList:p_new_mlist] autorelease];
@@ -270,11 +265,9 @@ static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * use
 {
     return p_mlist;
 }
-
 @end
 
 @implementation VLCMediaList (Private)
-
 - (void)initInternalMediaList
 {
     // Add event callbacks
@@ -321,6 +314,5 @@ static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * use
     if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaRemovedAtIndex:)])
         [delegate mediaList:self mediaRemovedAtIndex:index];
 }
-
 @end
 
index 5514720..dce5210 100644 (file)
@@ -71,15 +71,12 @@ NSString *VLCMediaPlayerStateToString(VLCMediaPlayerState state)
 }
 
 // TODO: Documentation
-@interface VLCMediaPlayer (PrivateAPI)
-
+@interface VLCMediaPlayer (Private)
 - (void)registerObservers;
 - (void)unregisterObservers;
-
 @end
 
 @implementation VLCMediaPlayer
-
 - (id)init
 {
     self = [self initWithVideoView:nil];
@@ -476,11 +473,9 @@ static VLCMediaPlayerState libvlc_to_local_state [] =
     else
         return libvlc_to_local_state[libvlc_state];
 }
-
 @end
 
-@implementation VLCMediaPlayer (PrivateAPI)
-
+@implementation VLCMediaPlayer (Private)
 - (void)registerObservers
 {
     libvlc_exception_t ex;
@@ -503,5 +498,4 @@ static VLCMediaPlayerState libvlc_to_local_state [] =
     libvlc_event_detach(p_em, libvlc_MediaInstanceReachedEnd,      HandleMediaInstanceStateChanged, self, NULL);
     libvlc_event_detach(p_em, libvlc_MediaInstancePositionChanged, HandleMediaTimeChanged,            self, NULL);
 }
-
 @end
\ No newline at end of file
index 67b4310..d5faa6e 100644 (file)
@@ -27,7 +27,6 @@
 static VLCTime *nullTime = nil;
 
 @implementation VLCTime
-
 + (VLCTime *)nullTime
 {
     if (!nullTime)
@@ -114,5 +113,4 @@ static VLCTime *nullTime = nil;
 {
     return [self stringValue];
 }
-
 @end
index 993c938..20e6c4d 100644 (file)
@@ -38,13 +38,10 @@ NSString *VLCVideoViewLeftFullScreen = @"VLCVideoViewLeftFullScreen";
    library.  We could get rid of this, but it prevents warnings from the 
    compiler. */
 @interface VLCOpenGLVoutView : NSView
-
 - (void)detachFromVout;
-
 @end
 
 @implementation VLCVideoView
-
 - (id)initWithFrame:(NSRect)rect
 {
     if (self = [super initWithFrame:rect]) 
@@ -163,5 +160,4 @@ NSString *VLCVideoViewLeftFullScreen = @"VLCVideoViewLeftFullScreen";
 {
     return YES;
 }
-
 @end