/*****************************************************************************
 * NSImage+VLCAdditions.h: MacOS X interface module
 *****************************************************************************
 * Copyright (C) 2023 VLC authors and VideoLAN
 *
 * Authors: Claudio Cambra <developer@claudiocambra.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 * You should have received a copy of the GNU 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 <Cocoa/Cocoa.h>

NS_ASSUME_NONNULL_BEGIN

struct picture_t;
struct vlc_object_t;

@interface NSImage (VLCAdditions)

// App images
@property (class, readonly) NSImage *VLCAppIconImage;
@property (class, readonly) NSImage *VLCXmasAppIconImage;
@property (class, readonly) NSImage *VLCStatusBarIconImage;

// Sidebar images
@property (class, readonly) NSImage *VLCSidebarMovieImage;
@property (class, readonly) NSImage *VLCSidebarMusicImage;

// B&W media source images
@property (class, readonly) NSImage *VLCBWHomeImage;
@property (class, readonly) NSImage *VLCBWMusicImage;
@property (class, readonly) NSImage *VLCBWServer1Image;
@property (class, readonly) NSImage *VLCBWServer2Image;
@property (class, readonly) NSImage *VLCBWUsb1Image;
@property (class, readonly) NSImage *VLCBWUsb2Image;
@property (class, readonly) NSImage *VLCDefaultAppIconImage;
@property (class, readonly) NSImage *VLCFollowImage;

// Placeholder images
@property (class, readonly) NSImage *VLCNoArtImage;
@property (class, readonly) NSImage *VLCPlaceholderVideoImage;
@property (class, readonly) NSImage *VLCPlaceholderGroupImage;
@property (class, readonly) NSImage *VLCPlaceholderMusicImage;
@property (class, readonly) NSImage *VLCGenericImage;

// Playback control images
@property (class, readonly) NSImage *VLCPlayTemplateImage;
@property (class, readonly) NSImage *VLCPauseTemplateImage;
@property (class, readonly) NSImage *VLCBackwardTemplateImage;
@property (class, readonly) NSImage *VLCForwardTemplateImage;
@property (class, readonly) NSImage *VLCFullscreenOffTemplateImage;
@property (class, readonly) NSImage *VLCVolumeOnTemplateImage;
@property (class, readonly) NSImage *VLCVolumeOffTemplateImage;
@property (class, readonly) NSImage *VLCStopImage;
@property (class, readonly) NSImage *VLCStopPressedImage;
@property (class, readonly) NSImage *VLCShuffleOffImage;
@property (class, readonly) NSImage *VLCShuffleOnImage;
@property (class, readonly) NSImage *VLCRepeatAllImage;
@property (class, readonly) NSImage *VLCRepeatOneImage;
@property (class, readonly) NSImage *VLCRepeatOffImage;

+ (void)quickLookPreviewForLocalPath:(NSString *)path
                            withSize:(NSSize)size 
                   completionHandler:(void (^)(NSImage * _Nullable))completionHandler;
+ (void)quickLookPreviewForLocalURL:(NSURL *)url 
                           withSize:(NSSize)size 
                  completionHandler:(void (^)(NSImage * _Nullable))completionHandler;
+ (instancetype)quickLookPreviewForLocalPath:(NSString*)path withSize:(NSSize)size;
+ (instancetype)quickLookPreviewForLocalURL:(NSURL*)url withSize:(NSSize)size;
+ (nullable NSImage *)imageFromVLCPicture:(struct picture_t *)picture
                                vlcObject:(struct vlc_object_t *)object
                                     size:(NSSize)size;
+ (instancetype)compositeImageWithImages:(NSArray<NSImage *> * const)images
                                  frames:(NSArray<NSValue *> * const)frames
                                    size:(const NSSize)size;
+ (NSArray<NSValue *> *)framesForCompositeImageSquareGridWithImages:(NSArray<NSImage *> * const)images
                                                               size:(const NSSize)size
                                                      gridItemCount:(const NSUInteger)gridItemCount;
+ (nullable NSImage *)flagImageForCountryCode:(NSString *)countryCode
                                         size:(NSSize)size;

- (instancetype)imageTintedWithColor:(NSColor *)color;

@end

NS_ASSUME_NONNULL_END