Vocaluxe/VocaluxeLib/IBasic.cs

#region license
// /*
//     This file is part of Vocaluxe.
// 
//     Vocaluxe 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.
// 
//     Vocaluxe 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 Vocaluxe. If not, see <http://www.gnu.org/licenses/>.
//  */
#endregion

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Drawing;
using VocaluxeLib.Draw;
using VocaluxeLib.Game;
using VocaluxeLib.Menu;
using VocaluxeLib.Profile;
using VocaluxeLib.Songs;

namespace VocaluxeLib
{
    public interface IConfig
    {
        void SetBackgroundMusicVolume(int newVolume);
        int GetBackgroundMusicVolume();

        int GetPreviewMusicVolume();

        EOffOn GetVideosToBackground();
        EOffOn GetVideoBackgrounds();
        EOffOn GetVideoPreview();

        ESongMenu GetSongMenuType();

        EOffOn GetDrawNoteLines();
        EOffOn GetDrawToneHelper();

        int GetCoverSize();

        IEnumerable<string> GetSongFolder();
        ESongSorting GetSongSorting();
        EOffOn GetTabs();
        EOffOn GetIgnoreArticles();

        bool IsMicConfigured(int playerNr);
        int GetMaxNumMics();
    }

    public interface ISettings
    {
        int GetRenderW();
        int GetRenderH();
        bool IsTabNavigation();

        float GetZFar();
        float GetZNear();

        EGameState GetGameState();

        int GetToneMin();
        int GetToneMax();

        int GetNumNoteLines();
        int GetMaxNumPlayer();

        float GetDefaultMedleyFadeInTime();
        float GetDefaultMedleyFadeOutTime();
        int GetMedleyMinSeriesLength();
        float GetMedleyMinDuration();

        string GetFolderProfiles();
    }

    public interface ITheme
    {
        string GetThemeScreensPath(int partyModeID);
        int GetSkinIndex(int partyModeID);
        CTexture GetSkinTexture(string textureName, int partyModeID);
        CTexture GetSkinVideoTexture(string videoName, int partyModeID);

        void SkinVideoResume(string videoName, int partyModeID);
        void SkinVideoPause(string videoName, int partyModeID);

        SColorF GetColor(string colorName, int partyModeID);
        bool GetColor(string colorName, int skinIndex, out SColorF color);
        SColorF GetPlayerColor(int playerNr);

        void UnloadSkins();
        void ListSkins();
        void LoadSkins();
        void LoadTheme();
    }

    public interface IBackgroundMusic
    {
        bool IsDisabled();
        bool IsPlaying();
        bool SongHasVideo();
        bool VideoEnabled();

        void SetStatus(bool disabled);
        void Next();
        void Previous();
        void Pause();
        void Play();

        void ApplyVolume();

        CTexture GetVideoTexture();
    }

    public interface IDrawing
    {
        void DrawTexture(CTexture texture, SRectF rect);
        void DrawTexture(CTexture texture, SRectF rect, SColorF color);
        void DrawTexture(CTexture texture, SRectF rect, SColorF color, SRectF bounds, bool mirrored = false);
        void DrawTextureReflection(CTexture texture, SRectF rect, SColorF color, SRectF bounds, float reflectionSpace, float reflectionHeight);

        CTexture AddTexture(string fileName);
        void RemoveTexture(ref CTexture texture);

        void DrawColor(SColorF color, SRectF rect);
        void DrawColorReflection(SColorF color, SRectF rect, float space, float height);
    }

    public interface IGraphics
    {
        void ReloadTheme();
        void SaveTheme();
        void FadeTo(EScreens nextScreen);

        float GetGlobalAlpha();
    }

    public interface ILog
    {
        void LogError(string errorText);
    }

    public interface IFonts
    {
        void SetFont(string fontName);
        void SetStyle(EStyle fontStyle);

        RectangleF GetTextBounds(CText text);
        RectangleF GetTextBounds(CText text, float textHeight);

        void DrawText(string text, float textHeight, float x, float y, float z, SColorF color);
        void DrawTextReflection(string text, float textHeight, float x, float y, float z, SColorF color, float reflectionSpace, float reflectionHeight);
        void DrawText(string text, float textHeight, float x, float y, float z, SColorF color, float begin, float end);
    }

    public interface ILanguage
    {
        string Translate(string keyWord);
        string Translate(string keyWord, int partyModeID);
        bool TranslationExists(string keyWord);
    }

    public interface IGame
    {
        int GetNumPlayer();
        void SetNumPlayer(int numPlayer);
        SPlayer[] GetPlayers();
        CPoints GetPoints();
        float GetMidBeatD();
        int GetCurrentBeatD();

        int GetRandom(int max);
        double GetRandomDouble();

        float GetTimeFromBeats(float beat, float bpm);

        void AddSong(int songID, EGameMode gameMode);
        void Reset();
        void ClearSongs();
        int GetNumSongs();
    }

    public interface IRecording
    {
        int GetToneAbs(int playerNr);
    }

    public interface IProfiles
    {
        CProfile[] GetProfiles();
        EGameDifficulty GetDifficulty(int profileID);
        string GetPlayerName(int profileID, int playerNum = 0);
        CTexture GetAvatar(int profileID);
    }

    public interface ISongs
    {
        int GetNumSongs();
        int GetNumSongsVisible();
        int GetNumCategories();
        int NumSongsInCategory(int categoryIndex);
        bool IsInCategory();

        int GetCurrentCategoryIndex();
        EOffOn GetTabs();
        string GetSearchFilter();

        void SetCategory(int categoryIndex);
        void UpdateRandomSongList();

        CSong GetVisibleSong(int visibleIndex);
        CSong GetSongByID(int songID);
        ReadOnlyCollection<CSong> GetVisibleSongs();
        CCategory GetCategory(int index);

        void AddPartySongSung(int songID);
        void ResetSongSung(int catIndex = -1);

        void SortSongs(ESongSorting sorting, EOffOn tabs, EOffOn ignoreArticles, String searchString, EDuetOptions duetOptions);

        void NextCategory();
        void PrevCategory();
    }

    public interface IVideo
    {
        int Load(string videoFileName);
        bool Skip(int videoStream, float startPosition, float videoGap);
        bool GetFrame(int videoStream, ref CTexture videoTexture, float time, out float videoTime);
        bool IsFinished(int videoStream);
        bool Close(int videoStream);
    }

    public interface ISound
    {
        int Load(string soundFile, bool prescan);
        void SetPosition(int soundStream, float newPosition);
        void Play(int soundStream);
        void Fade(int soundStream, float targetVolume, float duration);

        bool IsFinished(int soundStream);
        float GetPosition(int soundStream);
        float GetLength(int soundStream);
        void FadeAndStop(int soundStream, float targetVolume, float duration);

        void SetStreamVolume(int soundStream, float volume);
        void SetStreamVolumeMax(int soundStream, float maxVolume);
    }

    public interface ICover
    {
        CTexture GetNoCover();
    }

    public interface IDataBase
    {
        bool GetCover(string fileName, ref CTexture texture, int coverSize);
        bool GetDataBaseSongInfos(string artist, string title, out int numPlayed, out string dateAdded, out int highscoreID);
    }

    public interface IControllers
    {
        void SetRumble(float duration);
    }

    public interface IPlaylist
    {
        string GetPlaylistName(int playlistID);
        List<string> GetPlaylistNames();

        void SetPlaylistName(int playlistID, string name);
        void DeletePlaylist(int playlistID);
        void SavePlaylist(int playlistID);
        int GetNumPlaylists();

        void AddPlaylistSong(int playlistID, int songID);
        void AddPlaylistSong(int playlistID, int songID, EGameMode gameMode);
        void InsertPlaylistSong(int playlistID, int positionIndex, int songID, EGameMode gameMode);

        void MovePlaylistSong(int playlistID, int sourceIndex, int destIndex);
        void MovePlaylistSongDown(int playlistID, int songIndex);
        void MovePlaylistSongUp(int playlistID, int songIndex);
        void DeletePlaylistSong(int playlistID, int songIndex);

        int GetPlaylistSongCount(int playlistID);
        CPlaylistSong GetPlaylistSong(int playlistID, int songIndex);
    }
}