Movist.h

//
//  Movist
//
//  Copyright 2006 ~ 2008 Yong-Hoe Kim. All rights reserved.
//      Yong-Hoe Kim  <cocoable@gmail.com>
//
//  This file is part of Movist.
//
//  Movist 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 3 of the License, or
//  (at your option) any later version.
//
//  Movist 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, see <http://www.gnu.org/licenses/>.
//

#import <Cocoa/Cocoa.h>

#if defined(__cplusplus)
extern "C" {
#endif

#import "MovistExtensions.h"

#pragma mark check-for-updates
enum {
    CHECK_UPDATE_NEVER,
    CHECK_UPDATE_DAILY,
    CHECK_UPDATE_WEEKLY,
    CHECK_UPDATE_MONTHLY,
};

#pragma mark decoder
enum {
    DECODER_QUICKTIME,
    DECODER_FFMPEG,
};

#pragma mark opening view
enum {
    OPENING_VIEW_NONE,
    OPENING_VIEW_HALF_SIZE,
    OPENING_VIEW_NORMAL_SIZE,
    OPENING_VIEW_DOUBLE_SIZE,
    OPENING_VIEW_FIT_TO_SCREEN,
    OPENING_VIEW_FULL_SCREEN,
    OPENING_VIEW_DESKTOP_BACKGROUND,
};

#pragma mark movie resize center
enum {
    MOVIE_RESIZE_CENTER_TM,
    MOVIE_RESIZE_CENTER_TL,
    MOVIE_RESIZE_CENTER_TR,
    MOVIE_RESIZE_CENTER_BM,
    MOVIE_RESIZE_CENTER_BL,
    MOVIE_RESIZE_CENTER_BR,
};

#pragma mark window resize type
enum {
    WINDOW_RESIZE_FREE,
    WINDOW_RESIZE_ADJUST_TO_SIZE,
    WINDOW_RESIZE_ADJUST_TO_WIDTH,
};

#pragma mark full-screen transition
enum {
    FS_EFFECT_NONE,
    FS_EFFECT_FADE,
    FS_EFFECT_ANIMATION,
};

#pragma mark full-screen fill
enum {
    FS_FILL_NEVER,
    FS_FILL_STRETCH,
    FS_FILL_CROP,
};

#pragma mark aspect-ratio
enum {
    ASPECT_RATIO_DAR,   // DAR (Display Aspect Ratio)
    ASPECT_RATIO_SAR,   // SAR (Source Aspect Ratio)
    ASPECT_RATIO_4_3,   //    4 : 3 (TV)
    ASPECT_RATIO_16_9,  //   16 : 9 (HDTV)
    ASPECT_RATIO_1_85,  // 1.85 : 1 (Screen)
    ASPECT_RATIO_2_35,  // 2.35 : 1 (Screen)
};

#pragma mark letter-box height
enum {
    LETTER_BOX_HEIGHT_SAME      =   0,
    LETTER_BOX_HEIGHT_1_LINE    =   1,
    LETTER_BOX_HEIGHT_2_LINES   =   2,
    LETTER_BOX_HEIGHT_3_LINES   =   3,
    LETTER_BOX_HEIGHT_AUTO      = 100,
};

#pragma mark OSD position
enum {
    OSD_HPOSITION_LEFT          = 0,
    OSD_HPOSITION_CENTER        = 1,
    OSD_HPOSITION_RIGHT         = 2,

    OSD_VPOSITION_UBOX          = 0,
    OSD_VPOSITION_TOP           = 1,
    OSD_VPOSITION_CENTER        = 2,
    OSD_VPOSITION_BOTTOM        = 3,
    OSD_VPOSITION_LBOX          = 4,
};

#pragma mark seek tag
enum {
    SEEK_TAG_BEGINNING          = -100,
    SEEK_TAG_PREV_SUBTITLE      =  -40,
    SEEK_TAG_BACKWARD_3         =  -30,
    SEEK_TAG_BACKWARD_2         =  -20,
    SEEK_TAG_BACKWARD_1         =  -10,
    SEEK_TAG_BACKWARD_STEP      =   -1,
    SEEK_TAG_TIME               =    0,
    SEEK_TAG_FORWARD_STEP       =   +1,
    SEEK_TAG_FORWARD_1          =  +10,
    SEEK_TAG_FORWARD_2          =  +20,
    SEEK_TAG_FORWARD_3          =  +30,
    SEEK_TAG_NEXT_SUBTITLE      =  +40,
    SEEK_TAG_END                = +100,
};

#pragma mark subtitle-attributes
typedef struct {
    unsigned int mask;
    NSString* fontName;
    float     fontSize;
    NSColor*  textColor;
    NSColor*  strokeColor;
    float     strokeWidth;
    NSColor*  shadowColor;
    float     shadowBlur;
    float     shadowOffset;
    int       shadowDarkness;
    float     lineSpacing;
    int       hPosition;
    int       vPosition;
    float     hMargin;
    float     vMargin;
    float     sync;
} SubtitleAttributes;

enum {  // for SubtitleAttributes.mask
    SUBTITLE_ATTRIBUTE_FONT             = 1 << 0,
    SUBTITLE_ATTRIBUTE_TEXT_COLOR       = 1 << 1,
    SUBTITLE_ATTRIBUTE_STROKE_COLOR     = 1 << 2,
    SUBTITLE_ATTRIBUTE_STROKE_WIDTH     = 1 << 3,
    SUBTITLE_ATTRIBUTE_SHADOW_COLOR     = 1 << 4,
    SUBTITLE_ATTRIBUTE_SHADOW_BLUR      = 1 << 5,
    SUBTITLE_ATTRIBUTE_SHADOW_OFFSET    = 1 << 6,
    SUBTITLE_ATTRIBUTE_SHADOW_DARKNESS  = 1 << 7,
    SUBTITLE_ATTRIBUTE_LINE_SPACING     = 1 << 8,
    SUBTITLE_ATTRIBUTE_H_POSITION       = 1 << 9,
    SUBTITLE_ATTRIBUTE_V_POSITION       = 1 << 10,
    SUBTITLE_ATTRIBUTE_H_MARGIN         = 1 << 11,
    SUBTITLE_ATTRIBUTE_V_MARGIN         = 1 << 12,
    SUBTITLE_ATTRIBUTE_SYNC             = 1 << 13,
};

#pragma mark view-drag-action
enum {
    VIEW_DRAG_ACTION_NONE,
    VIEW_DRAG_ACTION_MOVE_WINDOW,
    VIEW_DRAG_ACTION_CAPTURE_MOVIE,
};

#pragma mark movie-capture format
enum {
    CAPTURE_FORMAT_TIFF,
    CAPTURE_FORMAT_JPEG,
    CAPTURE_FORMAT_PNG,
    CAPTURE_FORMAT_BMP,
    CAPTURE_FORMAT_GIF,
};

#pragma mark drag & drop
enum {
    DRAG_ACTION_NONE,
    DRAG_ACTION_PLAY_FILES,
    DRAG_ACTION_ADD_FILES,
    DRAG_ACTION_REPLACE_SUBTITLE_FILES,
    DRAG_ACTION_ADD_SUBTITLE_FILES,
    DRAG_ACTION_REORDER_PLAYLIST,
};

#pragma mark error-codes
enum {
    ERROR_FILE_NOT_EXIST = 1,
    ERROR_FILE_NOT_READABLE,

    ERROR_SUBTITLE_NOT_FOUND,
    ERROR_UNSUPPORTED_SUBTITLE_TYPE,

    ERROR_INVALID_VIDEO_DIMENSION,
    ERROR_VISUAL_CONTEXT_CREATE_FAILED,

    ERROR_FFMPEG_FILE_OPEN_FAILED,
    ERROR_FFMPEG_STREAM_INFO_NOT_FOUND,
    ERROR_FFMPEG_VIDEO_STREAM_NOT_FOUND,
    ERROR_FFMPEG_DECODER_NOT_FOUND,
    ERROR_FFMPEG_CODEC_OPEN_FAILED,
    ERROR_FFMPEG_FRAME_ALLOCATE_FAILED,
    ERROR_FFMPEG_SW_SCALER_INIT_FAILED,
    ERROR_FFMPEG_AUDIO_UNIT_CREATE_FAILED,
};

#pragma mark -
#pragma mark codec-id
// how to add codec
// 1. define codec-id constant.
//    . "Movist.h"
//    . enum (here)
//    . such as MCODEC_XXXX
//    . video/audio separated and similar grouped.
//    . constant value should be unique.
//
// 2. add codec-name.
//    . "Movist.m"
//    . NSString* codecName(int codecId);
//    . use CASE_CODEC_STRING() macro.
//
// 3. add to mapping table of [codec-id : ffmpeg-codec-id].
//    . "MMovie_Codec.h"
//    . for video, + (int)videoCodecIdFromFFmpegCodecId:(int)ffmpegCodecId fourCC:(NSString*)fourCC;
//    . for audio, + (int)audioCodecIdFromFFmpegCodecId:(int)ffmpegCodecId;
//    . use CASE_FFCODEC_MCODEC(), CASE_FFCODEC_______() macroes.
//    . use IF_FFCODEC_MCODEC() macro for video fourCC.
//
// 4. add to codec-binding table view.
//    . "PreferenceController_Advanced_Codec.m"
//    . - (void)initCodecBinding.
//    . use MCODEC_ID() macro.
//    . for video codec only
//
// 5. add to user-defaults.
//    . "UserDefaults.m"
//    . - (void)defaultCodecBinding;
//    . use CODEC_BINDING() macro.
//
// 6. add localized codec-description string.
//    . "Localizable.strings" for each language.
//    . cf) localized codec-name string need not.

enum {
    MCODEC_ETC_         = 0,    // for all other codecs

    // video codec //////////////////////////////////////

    MCODEC_MPEG1        = 1,    // MPEG-1
    MCODEC_MPEG2        = 10,   // MPEG-2
    MCODEC_MPEG4        = 100,  // MPEG-4
        MCODEC_DIV1,            // DivX MPEG-4 V3.x
        MCODEC_DIV2,            // DivX MPEG-4 V3.x
        MCODEC_DIV3,            // DivX MPEG-4 V3.x (Low Motion)
        MCODEC_DIV4,            // DivX MPEG-4 V3.x (Fast Motion)
        MCODEC_DIV5,            // DivX MPEG-4 V3.x
        MCODEC_DIV6,            // DivX MPEG-4 V3.x
        MCODEC_DIVX,            // DivX MPEG-4 V4.x
        MCODEC_DX50,            // DivX MPEG-4 V5.x
	  //MCODEC_XVID     = 120,  // Xvid MPEG-4 (removed from FFMPEG)
        MCODEC_MP4V     = 130,  // Apple MPEG-4
        MCODEC_MPG4     = 140,  // Microsoft MPEG-4 V1
        MCODEC_MP42,            // Microsoft MPEG-4 V2
        MCODEC_MP43,            // Microsoft MPEG-4 V3
        MCODEC_MP4S,            // Microsoft ISO MPEG-4 V1
        MCODEC_M4S2,            // Microsoft ISO MPEG-4 V1.1
        MCODEC_AP41     = 150,  // AngelPotion Definitive
        MCODEC_RMP4     = 160,  // REALmagic MPEG-4
        MCODEC_SEDG     = 170,  // Samsung MPEG-4
        MCODEC_FMP4     = 180,  // FFmpeg MPEG-4
        MCODEC_BLZ0,            // DivX for Blizzard

    MCODEC_H263         = 200,  // H.263, H.263+
    MCODEC_H264         = 300,  // H.264/MPEG4 AVC
        MCODEC_AVC1,            // Apple H.264
        MCODEC_X264,            // Open Source H.264
    MCODEC_VC1          = 400,  // VC-1 (SMPTE 421M)

    MCODEC_WMV1         = 500,  // Windows Media Video 7
    MCODEC_WMV2         = 510,  // Windows Media Video 8
    MCODEC_WMV3         = 520,  // Windows Media Video 9
    MCODEC_WVC1         = 530,  // Windows Media Video 9 Advanced Profile

    MCODEC_SVQ1         = 600,  // Sorenson Video 1
    MCODEC_SVQ3         = 610,  // Sorenson Video 3

    MCODEC_VP3          = 700,  // On2 VP3
    MCODEC_VP5          = 710,  // On2 VP5
    MCODEC_VP6          = 720,  // TrueMotion VP6
    MCODEC_VP6F         = 730,  // TrueMotion VP6 Flash

    MCODEC_RV10         = 800,  // RealVideo
    MCODEC_RV20         = 810,  // RealVideo G2
    MCODEC_RV30         = 820,  // RealVideo 8
    MCODEC_RV40         = 830,  // RealVideo 9, 10

    MCODEC_FLV          = 9000, // Flash Video
    MCODEC_THEORA       = 9010, // Theora
    MCODEC_HUFFYUV      = 9020, // Huffyuv
    MCODEC_CINEPAK      = 9030, // Cinepak
    MCODEC_INDEO2       = 9040, // Indeo Video 2
    MCODEC_INDEO3       = 9050, // Indeo Video 3
    MCODEC_MJPEG        = 9060, // Motion-JPEG
    MCODEC_DV           = 9070, // DV Video

    // audio codec //////////////////////////////////////

    MCODEC_PCM          = 50000,// PCM
    MCODEC_DPCM         = 50100,// DPCM
    MCODEC_ADPCM        = 50200,// ADPCM

    MCODEC_MP2          = 50300,// MP2 (MPEG-1 Audio Layer II)
    MCODEC_MP3          = 50400,// MP3 (MPEG-1 Audio Layer 3)
    MCODEC_AAC          = 50500,// AAC (Advanced Audio Coding)

    MCODEC_AC3          = 50600,// AC3 (Dolby Digital)
    MCODEC_DTS          = 50700,// DTS (Digital Theater Systems)
    MCODEC_VORBIS       = 50800,// Vorbis
    MCODEC_DVAUDIO      = 50900,// DV Audio
    MCODEC_WMAV1        = 51000,// Windows Media Audio V1
    MCODEC_WMAV2,               // Windows Media Audio V2
    MCODEC_RA           = 51100,// RealAudio
    MCODEC_AMR          = 51200,// AMR (Adaptive Multi-Rate)
    MCODEC_ALAC         = 51300,// ALAC
    MCODEC_FLAC         = 51400,// FLAC
    MCODEC_QDM2         = 51500,// QDM2 (QDesign Music Codec)
    MCODEC_MACE         = 51600,// MACE (Macintosh Audio Compression and Expansion)
    MCODEC_SPEEX        = 51700,// Speex
    MCODEC_TTA          = 51800,// TTA (True Audio)
    MCODEC_WAVPACK      = 51900,// WavPack
};

#pragma mark -
#define MIN_VOLUME          0.0
#define MAX_VOLUME          4.0
#define DEFAULT_VOLUME      1.0
#define MIN_SYSTEM_VOLUME   0.0
#define MAX_SYSTEM_VOLUME   1.0
#define DIGITAL_VOLUME      1.0

#define MIN_PLAY_RATE       0.5
#define MAX_PLAY_RATE       3.0
#define DEFAULT_PLAY_RATE   1.0

#define MIN_BRIGHTNESS     -1.0
#define MAX_BRIGHTNESS     +1.0
#define DEFAULT_BRIGHTNESS  0.0

#define MIN_SATURATION      0.0
#define MAX_SATURATION      2.0
#define DEFAULT_SATURATION  1.0

#define MIN_CONTRAST        0.0
#define MAX_CONTRAST        2.0
#define DEFAULT_CONTRAST    1.0

#define MIN_HUE            -3.14
#define MAX_HUE            +3.14
#define DEFAULT_HUE         0.0

#define MIN_SUBTITLE_H_MARGIN            0.0
#define MAX_SUBTITLE_H_MARGIN           10.0
#define DEFAULT_SUBTITLE_H_MARGIN        1.0

#define MIN_SUBTITLE_V_MARGIN            0.0
#define MAX_SUBTITLE_V_MARGIN           10.0
#define DEFAULT_SUBTITLE_V_MARGIN        1.0

#define MIN_SUBTITLE_SCREEN_MARGIN       0.0
#define MAX_SUBTITLE_SCREEN_MARGIN      50.0
#define DEFAULT_SUBTITLE_SCREEN_MARGIN   0.0

#define MIN_SUBTITLE_LINE_SPACING        0.0
#define MAX_SUBTITLE_LINE_SPACING       10.0
#define DEFAULT_SUBTITLE_LINE_SPACING    0.0

#define TopMostWindowLevel  kCGUtilityWindowLevel
#define DesktopWindowLevel  kCGDesktopWindowLevel

#pragma mark -
#pragma mark notifications: movie
extern NSString* MMovieIndexedDurationNotification;
extern NSString* MMovieRateChangeNotification;
extern NSString* MMovieCurrentTimeNotification;
extern NSString* MMovieEndNotification;

#pragma mark -
#pragma mark notifications: subtitle
extern NSString* MSubtitleEnableChangeNotification;
extern NSString* MSubtitleTrackWillLoadNotification;
extern NSString* MSubtitleTrackIsLoadingNotification;
extern NSString* MSubtitleTrackDidLoadNotification;

#pragma mark -
#pragma mark notifications: etc
extern NSString* MPlaylistUpdatedNotification;

#pragma mark -
#pragma mark notifications: drag & drop
extern NSString* MPlaylistItemDataType;

#define MOVIST_DRAG_TYPES   movistDragTypes()

////////////////////////////////////////////////////////////////////////////////
#pragma mark -
#pragma mark utilities

void detectOperatingSystem();
BOOL isSystemTiger();
BOOL isSystemLeopard();

#ifdef kHIWindowVisibleInAllSpaces
#undef kHIWindowVisibleInAllSpaces
#define kHIWindowVisibleInAllSpaces     (1 << 8)
#endif

NSArray* movistDragTypes();

#define valueInRange(value, minValue, maxValue)     ((minValue) <= (value) && (value) <= (maxValue))
#define adjustToRange(value, minValue, maxValue)    MIN(MAX((minValue), (value)), (maxValue))

float normalizedFloat1(float value);
float normalizedFloat2(float value);
float normalizedFloat25(float value);

BOOL checkMovieSeries(NSString* filename1, NSString* filename2);

NSString* NSStringFromMovieTime(float time);
NSString* NSStringFromSubtitleEncoding(CFStringEncoding encoding);
NSArray* URLsFromFilenames(NSArray* filenames);

NSString* codecName(int codecId);
NSString* codecDescription(int codecId);

@class MainWindow;
int runAlertPanel(MainWindow* mainWindow, NSString* title, NSString* msg,
                  NSString* defaultButton, NSString* altButton, NSString* otherButton);
void runAlertPanelForOpenError(MainWindow* mainWindow, NSError* error, NSURL* url);

unsigned int dragActionFromPasteboard(NSPasteboard* pboard, BOOL defaultPlay);

void initSubtitleEncodingMenu(NSMenu* menu, SEL action);

////////////////////////////////////////////////////////////////////////////////
#pragma mark -

#if defined(DEBUG)
    void TRACE(NSString* format, ...);
#else
    #define TRACE(...)
#endif

#if defined(__cplusplus)
}   // extern "C"
#endif