DesktopSDL2.h

Go to the documentation of this file.

 
/* *************************************************************************/
#ifndef DESKTOPINTERFACESDL2
#define DESKTOPINTERFACESDL2
 
#include <thread>
#include <atomic>
#include <memory>
// The following line disables the main() that SDL has
#define SDL_MAIN_HANDLED
#include <SDL2/SDL.h>
#include "DesktopInterface.h"
 
 
class DesktopSDL2; // forward declarations. This class is the main one
class PalWinSDL2;
 
 
/* ****************************************************************************
 
    Singleton class: DesktopSDL2
 
*******************************************************************************/
 
class DesktopSDL2: public DesktopInterface
{
 public:
 
    /* -------------------- Class methods ------------------------------ */
 
    static DesktopSDL2 & theDesktop(const SoundPlayerParms & spps);
 
    DesktopSDL2(const DesktopSDL2 &) = delete;
    DesktopSDL2 & operator=(const DesktopSDL2 &) = delete;
    DesktopSDL2(DesktopSDL2 &&) = delete;
    DesktopSDL2 & operator=(DesktopSDL2 &&) = delete;
    
    virtual ~DesktopSDL2(void);
 
    RGBImage readPNGImageFile(const std::string & filepath);
 
    void writePNGImageFile(const RGBImage & img, 
                           const std::string & filepath);
 
    PalettizedWindow * createWindow(const std::string & title,
                                    unsigned dimw, unsigned dimh,
                                    unsigned scalex, unsigned scaley);
 
    void getDesktopResolution(unsigned &w, unsigned &h);
 
    void playSound(double secs, const SoundMonoProducer & waveprod,
                   bool async);
 
    void pausePlaying(void);
 
    void resumePlaying(void);
 
    bool playingPaused(void) { return(soundpaused_); }
 
    bool soundPlaying(void) const noexcept { return(playing_); }
 
    void nextSoundPlayingTime(double &t) noexcept;
 
    const SoundMonoProducer & lastSoundProducer(void) const { return(smprod_); }
 
    double lastSoundDuration(void) const noexcept { return(sdur_); }
 
    void enableTextEvents(void);
 
    void disableTextEvents(void);
 
    bool textEventsEnabled(void) const { return(txtevsen_); }
 
    std::string copyFromClipboard(void) const;
 
    void copyToClipboard(const std::string & txt) const;
 
 private:
 
    static std::unique_ptr<DesktopSDL2> pgi;
 
    static void audio_callback(void *userdata, Uint8 *buffer, int length);
 
    bool withsound_;
    SDL_AudioSpec soundspecs_;
    SoundMonoProducer smprod_;
    double sdur_;
    uint64_t sind_;
    volatile std::atomic<bool> playing_;
    bool soundpaused_;
    bool txtevsen_;
 
    DesktopSDL2(const SoundPlayerParms & spps);
    // Default constructor: initiate the SDL2 video system and the IMG lib.
 
};
 
 
/* ****************************************************************************
 
    Class: PalWinSDL2
 
*******************************************************************************/
 
class PalWinSDL2: public PalettizedWindow
{
 friend class DesktopSDL2; 
 
 public:
 
        /* -------------------- Constructors ------------------------------ */
 
    virtual ~PalWinSDL2(void);
 
    PalWinSDL2(const PalWinSDL2 &) = delete; 
    PalWinSDL2 & operator=(const PalWinSDL2 &) = delete; 
    PalWinSDL2(PalWinSDL2 &&) = delete; 
    PalWinSDL2 & operator=(PalWinSDL2 &&) = delete; 
 
        /* -------------------- Methods ------------------------------ */
 
    Cursor getCursor(unsigned x = 0, unsigned y = 0) noexcept;
 
    CursorCheck getCursorCheck(unsigned x = 0, unsigned y = 0);
 
    PaletteIndex getPixel(const Cursor & cursor);
 
    void setPixel(const Cursor & cursor, PaletteIndex b);
 
    void fillRect(const Rectangle &r, PaletteIndex c);
 
    void refresh(const Rectangle & rect = Rectangle{});
 
    void serveEvents(const PalettizedWindow::Event::IDSet & whichevents ={true},
                     ListOfEvents * evs = nullptr);
 
    void setPaletteColors(const PaletteLevel * colors,
                          PaletteIndex first,
                          PaletteIndex count);
 
    bool getPointingInWindow(unsigned &x, unsigned &y,
                             bool & leftbutton, bool & rightbutton);
 
    bool keyPressed(DesktopInterface::KeyID k);
 
    void updateKeypressMap(DesktopInterface::KeypressMap & map);
 
 private:
 
    static std::thread::id mainthreadid_;
 
    SDL_Window *window_;
    SDL_Renderer *renderer_;
    SDL_Surface *surfpal_;
    SDL_Surface *surfaux_;
    SDL_Texture *texture_;
    SDL_Color colorpal_[NUMCOLSPAL], auxcolor;
 
    // constructor is private for forcing user to create windows through
    // the DesktopSDL2 class
    PalWinSDL2(const std::string & title, unsigned dimw, unsigned dimh,
               unsigned scalex, unsigned scaley);
 
    void destroy(void) noexcept;
};
 
 
 
#endif
 // DesktopSDL2