media_output_handler.h

Go to the documentation of this file.

#ifndef MEDIA_OUTPUT_HANDLER_H
#define MEDIA_OUTPUT_HANDLER_H
 
#include <notcurses/notcurses.h>
#include <stdbool.h>
 
// Scale types for display functions
typedef enum {
    SCALE_NONE,     // No scaling, use original size
    SCALE_PRESERVE, // Scale preserving aspect ratio
    SCALE_STRETCH,  // Stretch to exact dimensions
    SCALE_CELL,     // Scale to fit in a single cell
    SCALE_FULLSCREEN// Scale to fill the entire screen
} scale_type_t;
 
// Media types enumeration
typedef enum {
    MEDIA_PNG,
    MEDIA_GIF,
    MEDIA_MP4,
    MEDIA_UNSUPPORTED
} media_type_t;

typedef enum media_blitter {
    MEDIA_BLITTER_DEFAULT = NCBLIT_DEFAULT,// Use terminal's best option
    MEDIA_BLITTER_ASCII = NCBLIT_1x1,      // Use ASCII only
    MEDIA_BLITTER_HALF = NCBLIT_2x1,       // Use half blocks (▀ ▄)
    MEDIA_BLITTER_QUAD = NCBLIT_2x2,       // Use quadrant blocks (▖ ▗ ▘ ▙)
    MEDIA_BLITTER_BRAILLE = NCBLIT_BRAILLE,// Use braille (⠀⠁⠂⠃...)
    MEDIA_BLITTER_PIXEL = NCBLIT_PIXEL,    // Use pixel graphics if available
} media_blitter_t;
 
/* =========================================================================
 * CONSTANTS AND DEFINITIONS
 * ========================================================================= */

 
typedef struct loaded_visual_s {
    struct ncvisual* visual;        // The Notcurses visual
    struct ncplane* plane;          // The plane for rendering the visual
    struct ncvisual_options options;// Display options
    media_type_t media_type;        // Type of media (PNG, GIF, MP4)
    unsigned int og_width;          // Original width
    unsigned int og_height;         // Original height
    unsigned int frames;            // Number of frames (for animations)
    bool is_playing;                // Whether an animation is currently playing
    bool is_loaded;                 // Whether the visual is loaded
    char* path;                     // Path to the file (for reloading)
} loaded_visual_t;
 
/* =========================================================================
 * INITIALIZATION AND CLEANUP
 * ========================================================================= */

bool init_media_output(void);

void shutdown_media_output(void);
 
/***
 * @brief Clean up all loaded media resources
 *
 * Frees all loaded media resources and resets the handler.
 */
void media_cleanup(void);

void destroy_media(loaded_visual_t* media);

bool refresh_media_display(void);
 
/* =========================================================================
 * LOAD AND READY FUNCTIONS
 * ========================================================================= */

loaded_visual_t* load_media(const char* filename);

loaded_visual_t* ready_media(const char* filename, int x, int y, int height, int width, scale_type_t scale_type);
 
/* =========================================================================
 * RESOURCE MANAGEMENT FUNCTIONS
 * ========================================================================= */

bool unload_media(const char* filename);

bool preload_media(const char* filename);

bool reload_media_after_resize(void);
 
 
/* =========================================================================
 * REENDERING AND DISPLAY FUNCTIONS
 * ========================================================================= */

bool media_output_render(loaded_visual_t* media);

bool media_output_render_next_frame(loaded_visual_t* media);

bool media_output_can_display_images(void);

bool media_output_can_display_videos(void);
 
/* =========================================================================
 * SCALING FUNCTIONS
 * ========================================================================= */

void setup_scaling_options(loaded_visual_t* visual, scale_type_t scale_type, int target_width, int target_height);
 
/* =========================================================================
 * FILE AND PATH HANDLING FUNCTIONS
 * ========================================================================= */

bool directory_exists(const char* path);

media_type_t get_file_type(const char* filename);

bool is_file_extension(const char* filename, const char* extension);

char* build_filepath(const char* filename, media_type_t media_type);
 
#endif /* MEDIA_OUTPUT_HANDLER_H */