snap_grid.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_SNAP_GRID_H__
#define __AUDIO_SNAP_GRID_H__
 
#include <stdbool.h>
 
#include "dsp/position.h"
 
#include <glib/gi18n.h>
 
#define SNAP_GRID_TIMELINE (PROJECT->snap_grid_timeline)
#define SNAP_GRID_EDITOR (PROJECT->snap_grid_editor)
 
#define SNAP_GRID_IS_EDITOR(sg) (SNAP_GRID_EDITOR == sg)
#define SNAP_GRID_IS_TIMELINE(sg) (SNAP_GRID_TIMELINE == sg)
/* if any snapping is enabled */
#define SNAP_GRID_ANY_SNAP(sg) (sg->snap_to_grid || sg->snap_to_events)
#define SNAP_GRID_DEFAULT_MAX_BAR 10000
 
typedef enum NoteLength
{
  NOTE_LENGTH_BAR,
  NOTE_LENGTH_BEAT,
  NOTE_LENGTH_2_1,
  NOTE_LENGTH_1_1,
  NOTE_LENGTH_1_2,
  NOTE_LENGTH_1_4,
  NOTE_LENGTH_1_8,
  NOTE_LENGTH_1_16,
  NOTE_LENGTH_1_32,
  NOTE_LENGTH_1_64,
  NOTE_LENGTH_1_128
} NoteLength;
 
const char **
note_length_get_strings (void);
const char *
note_length_to_str (NoteLength len);
 
typedef enum NoteType
{
  NOTE_TYPE_NORMAL,
  NOTE_TYPE_DOTTED, 
  NOTE_TYPE_TRIPLET 
} NoteType;
 
const char **
note_type_get_strings (void);
const char *
note_type_to_str (NoteType type);
 
typedef enum NoteLengthType
{
  NOTE_LENGTH_LINK,
 
  NOTE_LENGTH_LAST_OBJECT,
 
  NOTE_LENGTH_CUSTOM,
} NoteLengthType;
 
typedef enum SnapGridType
{
  SNAP_GRID_TYPE_TIMELINE,
  SNAP_GRID_TYPE_EDITOR,
} SnapGridType;
 
typedef struct SnapGrid
{
  SnapGridType type;
 
  bool snap_adaptive;
 
  NoteLength snap_note_length;
 
  NoteType snap_note_type;
 
  bool snap_to_grid;
 
  bool snap_to_grid_keep_offset;
 
  bool snap_to_events;
 
  NoteLength default_note_length;
  NoteType default_note_type;
 
  bool default_adaptive;
 
  NoteLengthType length_type;
} SnapGrid;
 
void
snap_grid_init (
  SnapGrid *   self,
  SnapGridType type,
  NoteLength   note_length,
  bool         adaptive);
 
int
snap_grid_get_ticks_from_length_and_type (NoteLength length, NoteType type);
 
NONNULL int
snap_grid_get_snap_ticks (const SnapGrid * self);
 
NONNULL double
snap_grid_get_snap_frames (const SnapGrid * self);
 
int
snap_grid_get_default_ticks (SnapGrid * self);
 
char *
snap_grid_stringize_length_and_type (NoteLength note_length, NoteType note_type);
 
char *
snap_grid_stringize (SnapGrid * self);
 
NONNULL bool
snap_grid_get_nearby_snap_point (
  Position *             ret_pos,
  const SnapGrid * const self,
  const Position *       pos,
  const bool             return_prev);
 
SnapGrid *
snap_grid_clone (SnapGrid * src);
 
SnapGrid *
snap_grid_new (void);
 
void
snap_grid_free (SnapGrid * self);
 
#endif