RetroArch/menu/menu_animation.h

/*  RetroArch - A frontend for libretro.
 *  Copyright (C) 2014-2017 - Jean-André Santoni
 *  Copyright (C) 2011-2017 - Daniel De Matteis
 *
 *  RetroArch 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 Found-
 *  ation, either version 3 of the License, or (at your option) any later version.
 *
 *  RetroArch 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 RetroArch.
 *  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _MENU_ANIMATION_H
#define _MENU_ANIMATION_H

#include <stdint.h>
#include <stdlib.h>

#include <boolean.h>
#include <retro_common_api.h>

#include "../gfx/font_driver.h"

RETRO_BEGIN_DECLS

#define TICKER_SPACER_DEFAULT "   |   "

typedef float (*easing_cb) (float, float, float, float);
typedef void  (*tween_cb)  (void*);

enum menu_animation_ctl_state
{
   MENU_ANIMATION_CTL_NONE = 0,
   MENU_ANIMATION_CTL_DEINIT,
   MENU_ANIMATION_CTL_CLEAR_ACTIVE,
   MENU_ANIMATION_CTL_SET_ACTIVE
};

enum menu_animation_easing_type
{
   /* Linear */
   EASING_LINEAR    = 0,
   /* Quad */
   EASING_IN_QUAD,
   EASING_OUT_QUAD,
   EASING_IN_OUT_QUAD,
   EASING_OUT_IN_QUAD,
   /* Cubic */
   EASING_IN_CUBIC,
   EASING_OUT_CUBIC,
   EASING_IN_OUT_CUBIC,
   EASING_OUT_IN_CUBIC,
   /* Quart */
   EASING_IN_QUART,
   EASING_OUT_QUART,
   EASING_IN_OUT_QUART,
   EASING_OUT_IN_QUART,
   /* Quint */
   EASING_IN_QUINT,
   EASING_OUT_QUINT,
   EASING_IN_OUT_QUINT,
   EASING_OUT_IN_QUINT,
   /* Sine */
   EASING_IN_SINE,
   EASING_OUT_SINE,
   EASING_IN_OUT_SINE,
   EASING_OUT_IN_SINE,
   /* Expo */
   EASING_IN_EXPO,
   EASING_OUT_EXPO,
   EASING_IN_OUT_EXPO,
   EASING_OUT_IN_EXPO,
   /* Circ */
   EASING_IN_CIRC,
   EASING_OUT_CIRC,
   EASING_IN_OUT_CIRC,
   EASING_OUT_IN_CIRC,
   /* Bounce */
   EASING_IN_BOUNCE,
   EASING_OUT_BOUNCE,
   EASING_IN_OUT_BOUNCE,
   EASING_OUT_IN_BOUNCE,

   EASING_LAST
};

/* TODO:
 * Add a reverse loop ticker for languages
 * that read right to left */
enum menu_animation_ticker_type
{
   TICKER_TYPE_BOUNCE = 0,
   TICKER_TYPE_LOOP,
   TICKER_TYPE_LAST
};

typedef uintptr_t menu_animation_ctx_tag;

typedef struct menu_animation_ctx_subject
{
   size_t count;
   const void *data;
} menu_animation_ctx_subject_t;

typedef struct menu_animation_ctx_entry
{
   enum menu_animation_easing_type easing_enum;
   uintptr_t tag;
   float duration;
   float target_value;
   float *subject;
   tween_cb cb;
   void *userdata;
} menu_animation_ctx_entry_t;

typedef struct menu_animation_ctx_ticker
{
   bool selected;
   size_t len;
   uint64_t idx;
   enum menu_animation_ticker_type type_enum;
   char *s;
   const char *str;
   const char *spacer;
} menu_animation_ctx_ticker_t;

typedef struct menu_animation_ctx_ticker_smooth
{
   bool selected;
   font_data_t *font;
   float font_scale;
   unsigned glyph_width; /* Fallback if font == NULL */
   unsigned field_width;
   enum menu_animation_ticker_type type_enum;
   uint64_t idx;
   const char *src_str;
   const char *spacer;
   char *dst_str;
   size_t dst_str_len;
   unsigned *dst_str_width; /* May be set to NULL (RGUI + XMB do not require this info) */
   unsigned *x_offset;
} menu_animation_ctx_ticker_smooth_t;

typedef struct menu_animation_ctx_line_ticker
{
   size_t line_len;
   size_t max_lines;
   uint64_t idx;
   enum menu_animation_ticker_type type_enum;
   char *s;
   size_t len;
   const char *str;
} menu_animation_ctx_line_ticker_t;

typedef struct menu_animation_ctx_line_ticker_smooth
{
   bool scissor_enabled;
   font_data_t *font;
   float font_scale;
   unsigned field_width;
   unsigned field_height;
   enum menu_animation_ticker_type type_enum;
   uint64_t idx;
   const char *src_str;
   char *dst_str;
   size_t dst_str_len;
   unsigned *line_height;
   unsigned *num_lines;
   float *y_offset;
} menu_animation_ctx_line_ticker_smooth_t;

typedef float menu_timer_t;

typedef struct menu_timer_ctx_entry
{
   float duration;
   tween_cb cb;
   void *userdata;
} menu_timer_ctx_entry_t;

typedef struct menu_delayed_animation
{
   menu_timer_t timer;
   menu_animation_ctx_entry_t entry;
} menu_delayed_animation_t;

void menu_timer_start(menu_timer_t *timer, menu_timer_ctx_entry_t *timer_entry);

void menu_timer_kill(menu_timer_t *timer);

bool menu_animation_update(unsigned video_width, unsigned video_height);

bool menu_animation_ticker(menu_animation_ctx_ticker_t *ticker);

bool menu_animation_ticker_smooth(menu_animation_ctx_ticker_smooth_t *ticker);

bool menu_animation_line_ticker(menu_animation_ctx_line_ticker_t *line_ticker);

/* Note: When line_ticker->scissor_enabled is true,
 * resultant string must be drawn in conjunction with
 * menu_display_scissor_*()
 * i.e. draw area must be scissored vertically by
 * (line_ticker->line_height * line_ticker->num_lines),
 * with a scissor y start position of text y postion
 * (ignoring line_ticker->y_offset) *minus*
 * (line_ticker->line_height - font_descender_size).
 * font_descender_size is typically 20-30% of the line
 * height... */
bool menu_animation_line_ticker_smooth(menu_animation_ctx_line_ticker_smooth_t *line_ticker);

float menu_animation_get_delta_time(void);

bool menu_animation_is_active(void);

bool menu_animation_kill_by_tag(menu_animation_ctx_tag *tag);

void menu_animation_kill_by_subject(menu_animation_ctx_subject_t *subject);

bool menu_animation_push(menu_animation_ctx_entry_t *entry);

void menu_animation_push_delayed(unsigned delay, menu_animation_ctx_entry_t *entry);

bool menu_animation_ctl(enum menu_animation_ctl_state state, void *data);

uint64_t menu_animation_get_ticker_idx(void);

uint64_t menu_animation_get_ticker_slow_idx(void);

uint64_t menu_animation_get_ticker_pixel_idx(void);

RETRO_END_DECLS

#endif