VLCMedia.h

/*****************************************************************************
 * VLCMedia.h: VLCKit.framework VLCMedia header
 *****************************************************************************
 * Copyright (C) 2007 Pierre d'Herbemont
 * Copyright (C) 2013 Felix Paul Kühne
 * Copyright (C) 2007-2013 VLC authors and VideoLAN
 * $Id$
 *
 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
 *          Felix Paul Kühne <fkuehne # videolan.org>
 *          Soomin Lee <TheHungryBu # gmail.com>
 *
 * 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>
 
@class VLCTime, VLCMediaMetaData;
 
NS_ASSUME_NONNULL_BEGIN
 
/* Meta Dictionary Keys */
extern NSString *const VLCMetaInformationTitle __attribute__((deprecated));          /* NSString */
extern NSString *const VLCMetaInformationArtist __attribute__((deprecated));         /* NSString */
extern NSString *const VLCMetaInformationGenre __attribute__((deprecated));          /* NSString */
extern NSString *const VLCMetaInformationCopyright __attribute__((deprecated));      /* NSString */
extern NSString *const VLCMetaInformationAlbum __attribute__((deprecated));          /* NSString */
extern NSString *const VLCMetaInformationTrackNumber __attribute__((deprecated));    /* NSString */
extern NSString *const VLCMetaInformationDescription __attribute__((deprecated));    /* NSString */
extern NSString *const VLCMetaInformationRating __attribute__((deprecated));         /* NSString */
extern NSString *const VLCMetaInformationDate __attribute__((deprecated));           /* NSString */
extern NSString *const VLCMetaInformationSetting __attribute__((deprecated));        /* NSString */
extern NSString *const VLCMetaInformationURL __attribute__((deprecated));            /* NSString */
extern NSString *const VLCMetaInformationLanguage __attribute__((deprecated));       /* NSString */
extern NSString *const VLCMetaInformationNowPlaying __attribute__((deprecated));     /* NSString */
extern NSString *const VLCMetaInformationPublisher __attribute__((deprecated));      /* NSString */
extern NSString *const VLCMetaInformationEncodedBy __attribute__((deprecated));      /* NSString */
extern NSString *const VLCMetaInformationArtworkURL __attribute__((deprecated));     /* NSString */
extern NSString *const VLCMetaInformationArtwork __attribute__((deprecated));        /* NSImage  */
extern NSString *const VLCMetaInformationTrackID __attribute__((deprecated));        /* NSString */
extern NSString *const VLCMetaInformationTrackTotal __attribute__((deprecated));     /* NSString */
extern NSString *const VLCMetaInformationDirector __attribute__((deprecated));       /* NSString */
extern NSString *const VLCMetaInformationSeason __attribute__((deprecated));         /* NSString */
extern NSString *const VLCMetaInformationEpisode __attribute__((deprecated));        /* NSString */
extern NSString *const VLCMetaInformationShowName __attribute__((deprecated));       /* NSString */
extern NSString *const VLCMetaInformationActors __attribute__((deprecated));         /* NSString */
extern NSString *const VLCMetaInformationAlbumArtist __attribute__((deprecated));    /* NSString */
extern NSString *const VLCMetaInformationDiscNumber __attribute__((deprecated));     /* NSString */
 
/* Notification Messages */
extern NSString *const VLCMediaMetaChanged;  
 
// Forward declarations, supresses compiler error messages
@class VLCMediaList;
@class VLCMedia;
 
typedef NS_ENUM(NSInteger, VLCMediaState) {
    VLCMediaStateNothingSpecial,        
    VLCMediaStateBuffering,             
    VLCMediaStatePlaying,               
    VLCMediaStateError,                 
};
 
@protocol VLCMediaDelegate <NSObject>
 
@optional
 
- (void)mediaMetaDataDidChange:(VLCMedia *)aMedia;
 
- (void)mediaDidFinishParsing:(VLCMedia *)aMedia;
@end
 
@interface VLCMedia : NSObject
 
/* Factories */
+ (instancetype)mediaWithURL:(NSURL *)anURL;
 
+ (instancetype)mediaWithPath:(NSString *)aPath;
 
+ (NSString *)codecNameForFourCC:(uint32_t)fourcc trackType:(NSString *)trackType;
 
+ (instancetype)mediaAsNodeWithName:(NSString *)aName;
 
/* Initializers */
- (instancetype)initWithURL:(NSURL *)anURL;
 
- (instancetype)initWithPath:(NSString *)aPath;
 
- (instancetype)initWithStream:(NSInputStream *)stream;
 
- (instancetype)initAsNodeWithName:(NSString *)aName;
 
typedef NS_ENUM(NSUInteger, VLCMediaOrientation) {
    VLCMediaOrientationTopLeft,
    VLCMediaOrientationTopRight,
    VLCMediaOrientationBottomLeft,
    VLCMediaOrientationBottomRight,
    VLCMediaOrientationLeftTop,
    VLCMediaOrientationLeftBottom,
    VLCMediaOrientationRightTop,
    VLCMediaOrientationRightBottom
};
 
typedef NS_ENUM(NSUInteger, VLCMediaProjection) {
    VLCMediaProjectionRectangular,
    VLCMediaProjectionEquiRectangular,
    VLCMediaProjectionCubemapLayoutStandard = 0x100
};
 
typedef NS_ENUM(NSUInteger, VLCMediaType) {
    VLCMediaTypeUnknown,
    VLCMediaTypeFile,
    VLCMediaTypeDirectory,
    VLCMediaTypeDisc,
    VLCMediaTypeStream,
    VLCMediaTypePlaylist,
};
 
@property (readonly) VLCMediaType mediaType;
 
- (NSComparisonResult)compare:(nullable VLCMedia *)media;
 
/* Properties */
@property (nonatomic, weak, nullable) id<VLCMediaDelegate> delegate;
 
@property (nonatomic, readwrite, strong) VLCTime * length;
 
- (VLCTime *)lengthWaitUntilDate:(NSDate *)aDate;
 
@property (nonatomic, readonly) BOOL isParsed __attribute__((deprecated));
 
typedef NS_ENUM(unsigned, VLCMediaParsedStatus)
{
    VLCMediaParsedStatusInit = 0,
    VLCMediaParsedStatusSkipped,
    VLCMediaParsedStatusFailed,
    VLCMediaParsedStatusTimeout,
    VLCMediaParsedStatusDone
};
@property (nonatomic, readonly) VLCMediaParsedStatus parsedStatus;
 
@property (nonatomic, readonly, strong, nullable) NSURL * url;
 
@property (nonatomic, readonly, strong, nullable) VLCMediaList * subitems;
 
- (nullable NSString *)metadataForKey:(NSString *)key __attribute__((deprecated));
 
- (void)setMetadata:(NSString *)data forKey:(NSString *)key __attribute__((deprecated));
 
@property (NS_NONATOMIC_IOSONLY, readonly) BOOL saveMetadata __attribute__((deprecated));
 
@property (nonatomic, readonly, copy) NSDictionary * metaDictionary __attribute__((deprecated));
 
@property (nonatomic, readonly) VLCMediaMetaData *metaData;
 
@property (nonatomic, readonly) VLCMediaState state;
 
@property (NS_NONATOMIC_IOSONLY, getter=isMediaSizeSuitableForDevice, readonly) BOOL mediaSizeSuitableForDevice;
 
extern NSString *const VLCMediaTracksInformationCodec;
 
extern NSString *const VLCMediaTracksInformationId;
extern NSString *const VLCMediaTracksInformationType;
 
extern NSString *const VLCMediaTracksInformationCodecProfile;
extern NSString *const VLCMediaTracksInformationCodecLevel;
 
extern NSString *const VLCMediaTracksInformationBitrate;
extern NSString *const VLCMediaTracksInformationLanguage;
extern NSString *const VLCMediaTracksInformationDescription;
 
extern NSString *const VLCMediaTracksInformationAudioChannelsNumber;
extern NSString *const VLCMediaTracksInformationAudioRate;
 
extern NSString *const VLCMediaTracksInformationVideoHeight;
extern NSString *const VLCMediaTracksInformationVideoWidth;
 
extern NSString *const VLCMediaTracksInformationVideoOrientation;
extern NSString *const VLCMediaTracksInformationVideoProjection;
 
extern NSString *const VLCMediaTracksInformationSourceAspectRatio;
extern NSString *const VLCMediaTracksInformationSourceAspectRatioDenominator;
 
extern NSString *const VLCMediaTracksInformationFrameRate;
extern NSString *const VLCMediaTracksInformationFrameRateDenominator;
 
extern NSString *const VLCMediaTracksInformationTextEncoding;
 
extern NSString *const VLCMediaTracksInformationTypeAudio;
extern NSString *const VLCMediaTracksInformationTypeVideo;
extern NSString *const VLCMediaTracksInformationTypeText;
extern NSString *const VLCMediaTracksInformationTypeUnknown;
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *tracksInformation;
 
@property (nonatomic, nullable) id userData;
 
- (void)parse __attribute__((deprecated));
 
- (void)synchronousParse __attribute__((deprecated));
 
typedef NS_OPTIONS(int, VLCMediaParsingOptions) {
    VLCMediaParseLocal          = 0x00,     
    VLCMediaParseNetwork        = 0x01,     
    VLCMediaFetchLocal          = 0x02,     
    VLCMediaFetchNetwork        = 0x04,     
    VLCMediaDoInteract          = 0x08,     
};
 
- (int)parseWithOptions:(VLCMediaParsingOptions)options;
 
- (int)parseWithOptions:(VLCMediaParsingOptions)options timeout:(int)timeoutValue;
 
- (void)parseStop;
 
- (void)addOption:(NSString *)option;
- (void)addOptions:(NSDictionary*)options;
 
- (int)storeCookie:(NSString *)cookie
           forHost:(NSString *)host
              path:(NSString *)path;
 
- (void)clearStoredCookies;
 
struct VLCMediaStats
{
    /* Input */
    const int         readBytes;
    const float       inputBitrate;
    /* Demux */
    const int         demuxReadBytes;
    const float       demuxBitrate;
    const int         demuxCorrupted;
    const int         demuxDiscontinuity;
    /* Decoders */
    const int         decodedVideo;
    const int         decodedAudio;
    /* Video Output */
    const int         displayedPictures;
    const int         lostPictures;
    /* Audio output */
    const int         playedAudioBuffers;
    const int         lostAudioBuffers;
    /* Stream output */
    const int         sentPackets;
    const int         sentBytes;
    const float       sendBitrate;
} NS_SWIFT_NAME(VLCMedia.Stats);
typedef struct VLCMediaStats VLCMediaStats;
 
@property (nonatomic, readonly) VLCMediaStats statistics;
 
@end
 
#pragma mark - VLCMedia+Deprecated
 
@interface VLCMedia (Deprecated)
 
@property (NS_NONATOMIC_IOSONLY, readonly, copy, nullable) NSDictionary *stats DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfReadBytesOnInput DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) float inputBitrate DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfReadBytesOnDemux DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) float demuxBitrate DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfDecodedVideoBlocks DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfDecodedAudioBlocks DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfDisplayedPictures DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfLostPictures DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfPlayedAudioBuffers DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfLostAudioBuffers DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfSentPackets DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfSentBytes DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) float streamOutputBitrate DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfCorruptedDataPackets DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
@property (NS_NONATOMIC_IOSONLY, readonly) NSInteger numberOfDiscontinuties DEPRECATED_MSG_ATTRIBUTE("Use -[VLCMedia statistics] instead");
 
@end
 
NS_ASSUME_NONNULL_END