VLCMediaPlayer.h

/*****************************************************************************
 * VLCMediaPlayer.h: VLCKit.framework VLCMediaPlayer header
 *****************************************************************************
 * Copyright (C) 2007-2009 Pierre d'Herbemont
 * Copyright (C) 2007-2022 VLC authors and VideoLAN
 * Copyright (C) 2009-2015 Felix Paul Kühne
 * $Id$
 *
 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
 *          Felix Paul Kühne <fkuehne # videolan.org>
 *          Soomin Lee <TheHungryBu # gmail.com>
 *          Maxime Chapelet <umxprime # videolabs.io>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
 
#import <Foundation/Foundation.h>
#if TARGET_OS_IPHONE
# import <CoreGraphics/CoreGraphics.h>
# import <UIKit/UIKit.h>
#endif // TARGET_OS_IPHONE
 
NS_ASSUME_NONNULL_BEGIN
 
@class VLCLibrary, VLCMedia, VLCTime, VLCAudio, VLCMediaPlayer, VLCAdjustFilter, VLCAudioEqualizer;
#if !TARGET_OS_IPHONE
@class VLCVideoView, VLCVideoLayer;
#endif // !TARGET_OS_IPHONE
#if !TARGET_OS_TV
@class VLCRendererItem;
#endif // !TARGET_OS_TV
 
/* Notification Messages */
extern NSString *const VLCMediaPlayerTimeChanged;
extern NSString *const VLCMediaPlayerStateChanged;
extern NSString *const VLCMediaPlayerTitleChanged;
extern NSString *const VLCMediaPlayerChapterChanged;
extern NSString *const VLCMediaPlayerLoudnessChanged;
 
typedef NS_ENUM(NSInteger, VLCMediaPlayerState)
{
    VLCMediaPlayerStateStopped,        
    VLCMediaPlayerStateOpening,        
    VLCMediaPlayerStateBuffering,      
    VLCMediaPlayerStateEnded,          
    VLCMediaPlayerStateError,          
    VLCMediaPlayerStatePlaying,        
    VLCMediaPlayerStatePaused,         
    VLCMediaPlayerStateESAdded         
};
 
typedef NS_ENUM(unsigned, VLCMediaPlaybackNavigationAction)
{
    VLCMediaPlaybackNavigationActionActivate = 0,
    VLCMediaPlaybackNavigationActionUp,
    VLCMediaPlaybackNavigationActionDown,
    VLCMediaPlaybackNavigationActionLeft,
    VLCMediaPlaybackNavigationActionRight
};
 
typedef NS_ENUM(NSInteger, VLCDeinterlace)
{
    VLCDeinterlaceAuto = -1,
    VLCDeinterlaceOn = 1,
    VLCDeinterlaceOff = 0
};
 
@interface VLCMediaLoudness : NSObject
 
@property (readonly, atomic) double loudnessValue;
 
@property (readonly, atomic) int64_t date;
 
@end
 
extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 
@protocol VLCMediaPlayerDelegate <NSObject>
 
@optional
- (void)mediaPlayerStateChanged:(NSNotification *)aNotification;
 
- (void)mediaPlayerTimeChanged:(NSNotification *)aNotification;
 
- (void)mediaPlayerTitleChanged:(NSNotification *)aNotification;
 
- (void)mediaPlayerChapterChanged:(NSNotification *)aNotification;
 
- (void)mediaPlayerLoudnessChanged:(NSNotification *)aNotification;
 
- (void)mediaPlayerSnapshot:(NSNotification *)aNotification;
 
- (void)mediaPlayerStartedRecording:(VLCMediaPlayer *)player;
 
- (void)mediaPlayer:(VLCMediaPlayer *)player recordingStoppedAtPath:(NSString *)path;
 
@end
 
 
@interface VLCMediaPlayer : NSObject
 
@property (nonatomic, readonly) VLCLibrary *libraryInstance;
@property (weak, nonatomic, nullable) id<VLCMediaPlayerDelegate> delegate;
 
#if !TARGET_OS_IPHONE
/* Initializers */
- (instancetype)initWithVideoView:(VLCVideoView *)aVideoView;
- (instancetype)initWithVideoLayer:(VLCVideoLayer *)aVideoLayer;
#endif
 
- (instancetype)initWithLibrary:(VLCLibrary *)library;
- (instancetype)initWithOptions:(NSArray *)options;
- (instancetype)initWithLibVLCInstance:(void *)playerInstance andLibrary:(VLCLibrary *)library;
 
/* Video View Options */
// TODO: Should be it's own object?
 
#pragma mark -
#pragma mark video functionality
 
#if !TARGET_OS_IPHONE
 
- (void)setVideoView:(VLCVideoView *)aVideoView;
- (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer;
#endif
 
@property (strong, nullable) id drawable; /* The videoView or videoLayer */
 
@property (NS_NONATOMIC_IOSONLY, nullable) char *videoAspectRatio;
 
@property (NS_NONATOMIC_IOSONLY, nullable) char *videoCropGeometry;
 
@property (nonatomic) float scaleFactor;
 
- (void)saveVideoSnapshotAt:(NSString *)path withWidth:(int)width andHeight:(int)height;
 
- (void)setDeinterlaceFilter: (nullable NSString *)name;
 
- (void)setDeinterlace:(VLCDeinterlace)deinterlace withFilter:(NSString *)name;
 
@property (nonatomic, readonly) VLCAdjustFilter *adjustFilter;
 
@property (nonatomic) BOOL adjustFilterEnabled __deprecated_msg("Use -[VLCMediaPlayer adjustFilter].enabled instead");
@property (nonatomic) float contrast __deprecated_msg("Use -[VLCMediaPlayer adjustFilter].contrast instead");
@property (nonatomic) float brightness __deprecated_msg("Use -[VLCMediaPlayer adjustFilter].brightness instead");
@property (nonatomic) float hue __deprecated_msg("Use -[VLCMediaPlayer adjustFilter].hue instead");
@property (nonatomic) float saturation __deprecated_msg("Use -[VLCMediaPlayer adjustFilter].saturation instead");
@property (nonatomic) float gamma __deprecated_msg("Use -[VLCMediaPlayer adjustFilter].gamma instead");
 
@property (nonatomic) float rate;
 
@property (nonatomic, readonly, weak) VLCAudio * audio;
 
/* Video Information */
@property (NS_NONATOMIC_IOSONLY, readonly) CGSize videoSize;
 
@property (NS_NONATOMIC_IOSONLY, readonly) BOOL hasVideoOut;
 
@property (NS_NONATOMIC_IOSONLY, readonly) float framesPerSecond __attribute__((deprecated));
 
#pragma mark -
#pragma mark time
 
@property (NS_NONATOMIC_IOSONLY, strong) VLCTime *time;
 
@property (nonatomic, readonly, weak) VLCTime *remainingTime;
 
#pragma mark -
#pragma mark ES track handling
 
@property (readwrite) int currentVideoTrackIndex;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *videoTrackNames;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *videoTrackIndexes;
 
@property (NS_NONATOMIC_IOSONLY, readonly) int numberOfVideoTracks;
 
@property (readwrite) int currentVideoSubTitleIndex;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *videoSubTitlesNames;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *videoSubTitlesIndexes;
 
@property (NS_NONATOMIC_IOSONLY, readonly) int numberOfSubtitlesTracks;
 
- (BOOL)openVideoSubTitlesFromFile:(NSString *)path __attribute__((deprecated));
 
typedef NS_ENUM(unsigned, VLCMediaPlaybackSlaveType)
{
    VLCMediaPlaybackSlaveTypeSubtitle = 0,
    VLCMediaPlaybackSlaveTypeAudio
};
 
- (int)addPlaybackSlave:(NSURL *)slaveURL type:(VLCMediaPlaybackSlaveType)slaveType enforce:(BOOL)enforceSelection;
 
@property (readwrite) NSInteger currentVideoSubTitleDelay;
 
@property (readwrite) int currentChapterIndex;
- (void)previousChapter;
- (void)nextChapter;
- (int)numberOfChaptersForTitle:(int)titleIndex;
 
- (NSArray *)chaptersForTitleIndex:(int)titleIndex __attribute__((deprecated));
 
extern NSString *const VLCChapterDescriptionName;
extern NSString *const VLCChapterDescriptionTimeOffset;
extern NSString *const VLCChapterDescriptionDuration;
 
- (NSArray *)chapterDescriptionsOfTitle:(int)titleIndex;
 
@property (readwrite) int currentTitleIndex;
@property (readonly) int numberOfTitles;
 
@property (readonly) NSUInteger countOfTitles __attribute__((deprecated));
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *titles __attribute__((deprecated));
 
extern NSString *const VLCTitleDescriptionName;
extern NSString *const VLCTitleDescriptionDuration;
extern NSString *const VLCTitleDescriptionIsMenu;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *titleDescriptions;
 
@property (readonly) int indexOfLongestTitle;
 
/* Audio Options */
 
@property (readwrite) int currentAudioTrackIndex;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *audioTrackNames;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *audioTrackIndexes;
 
@property (NS_NONATOMIC_IOSONLY, readonly) int numberOfAudioTracks;
 
#pragma mark -
#pragma mark audio functionality
 
@property (NS_NONATOMIC_IOSONLY) int audioChannel;
 
@property (readwrite) NSInteger currentAudioPlaybackDelay;
 
@property (readonly, nullable) VLCMediaLoudness *momentaryLoudness;
 
#pragma mark -
#pragma mark equalizer
 
@property (nonatomic, nullable) VLCAudioEqualizer *equalizer;
 
@property (weak, readonly) NSArray *equalizerProfiles DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
- (void)resetEqualizerFromProfile:(unsigned)profile DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
@property (readwrite) BOOL equalizerEnabled DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
@property (readwrite) CGFloat preAmplification DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
@property (readonly) unsigned numberOfBands DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
- (CGFloat)frequencyOfBandAtIndex:(unsigned)index DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
- (void)setAmplification:(CGFloat)amplification forBand:(unsigned)index DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
- (CGFloat)amplificationOfBand:(unsigned)index DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMediaPlayer equalizer] instead");
 
#pragma mark -
#pragma mark media handling
 
/* Media Options */
@property (NS_NONATOMIC_IOSONLY, strong, nullable) VLCMedia *media;
 
#pragma mark -
#pragma mark playback operations
 
- (void)play;
 
- (void)pause;
 
- (void)stop;
 
- (void)gotoNextFrame;
 
- (void)fastForward;
 
- (void)fastForwardAtRate:(float)rate;
 
- (void)rewind;
 
- (void)rewindAtRate:(float)rate;
 
- (void)jumpBackward:(int)interval;
 
- (void)jumpForward:(int)interval;
 
- (void)extraShortJumpBackward;
 
- (void)extraShortJumpForward;
 
- (void)shortJumpBackward;
 
- (void)shortJumpForward;
 
- (void)mediumJumpBackward;
 
- (void)mediumJumpForward;
 
- (void)longJumpBackward;
 
- (void)longJumpForward;
 
- (void)performNavigationAction:(VLCMediaPlaybackNavigationAction)action;
 
- (BOOL)updateViewpoint:(float)yaw pitch:(float)pitch roll:(float)roll fov:(float)fov absolute:(BOOL)absolute;
 
@property (nonatomic) float yaw;
 
@property (nonatomic) float pitch;
 
@property (nonatomic) float roll;
 
@property (nonatomic) float fov;
 
#pragma mark -
#pragma mark playback information
 
@property (NS_NONATOMIC_IOSONLY, getter=isPlaying, readonly) BOOL playing;
 
@property (NS_NONATOMIC_IOSONLY, readonly) BOOL willPlay;
 
@property (NS_NONATOMIC_IOSONLY, readonly) VLCMediaPlayerState state;
 
@property (NS_NONATOMIC_IOSONLY) float position;
 
@property (NS_NONATOMIC_IOSONLY, getter=isSeekable, readonly) BOOL seekable;
 
@property (NS_NONATOMIC_IOSONLY, readonly) BOOL canPause;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy, nullable) NSArray *snapshots;
 
#if TARGET_OS_IPHONE
 
@property (NS_NONATOMIC_IOSONLY, readonly, nullable) UIImage *lastSnapshot;
#else
 
@property (NS_NONATOMIC_IOSONLY, readonly, nullable) NSImage *lastSnapshot;
#endif
 
- (BOOL)startRecordingAtPath:(NSString *)path;
 
- (BOOL)stopRecording;
 
#pragma mark -
#pragma mark Renderer
#if !TARGET_OS_TV
 
- (BOOL)setRendererItem:(nullable VLCRendererItem *)item;
#endif // !TARGET_OS_TV
@end
NS_ASSUME_NONNULL_END