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_SCHEMA_VERSION 1
 
#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;
 
static const cyaml_strval_t note_length_strings[] = {
  {N_ ("bar"),   NOTE_LENGTH_BAR  },
  { N_ ("beat"), NOTE_LENGTH_BEAT },
  { "2/1",       NOTE_LENGTH_2_1  },
  { "1/1",       NOTE_LENGTH_1_1  },
  { "1/2",       NOTE_LENGTH_1_2  },
  { "1/4",       NOTE_LENGTH_1_4  },
  { "1/8",       NOTE_LENGTH_1_8  },
  { "1/16",      NOTE_LENGTH_1_16 },
  { "1/32",      NOTE_LENGTH_1_32 },
  { "1/64",      NOTE_LENGTH_1_64 },
  { "1/128",     NOTE_LENGTH_1_128},
};
 
typedef enum NoteType
{
  NOTE_TYPE_NORMAL,
  NOTE_TYPE_DOTTED, 
  NOTE_TYPE_TRIPLET 
} NoteType;
 
static const cyaml_strval_t note_type_strings[] = {
  {N_ ("normal"),   NOTE_TYPE_NORMAL },
  { N_ ("dotted"),  NOTE_TYPE_DOTTED },
  { N_ ("triplet"), NOTE_TYPE_TRIPLET},
};
 
static const cyaml_strval_t note_type_short_strings[] = {
  {"",   NOTE_TYPE_NORMAL },
  { ".", NOTE_TYPE_DOTTED },
  { "t", NOTE_TYPE_TRIPLET},
};
 
typedef enum NoteLengthType
{
  NOTE_LENGTH_LINK,
 
  NOTE_LENGTH_LAST_OBJECT,
 
  NOTE_LENGTH_CUSTOM,
} NoteLengthType;
 
static const cyaml_strval_t note_length_type_strings[] = {
  {"link",         NOTE_LENGTH_LINK       },
  { "last object", NOTE_LENGTH_LAST_OBJECT},
  { "custom",      NOTE_LENGTH_CUSTOM     },
};
 
typedef enum SnapGridType
{
  SNAP_GRID_TYPE_TIMELINE,
  SNAP_GRID_TYPE_EDITOR,
} SnapGridType;
 
static const cyaml_strval_t snap_grid_type_strings[] = {
  {"timeline", SNAP_GRID_TYPE_TIMELINE},
  { "editor",  SNAP_GRID_TYPE_EDITOR  },
};
 
typedef struct SnapGrid
{
  int          schema_version;
  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;
 
static const cyaml_schema_field_t snap_grid_fields_schema[] = {
  YAML_FIELD_INT (SnapGrid, schema_version),
  YAML_FIELD_ENUM (SnapGrid, type, snap_grid_type_strings),
  YAML_FIELD_ENUM (
    SnapGrid,
    snap_note_length,
    note_length_strings),
  YAML_FIELD_ENUM (SnapGrid, snap_note_type, note_type_strings),
  YAML_FIELD_INT (SnapGrid, snap_adaptive),
  YAML_FIELD_ENUM (
    SnapGrid,
    default_note_length,
    note_length_strings),
  YAML_FIELD_ENUM (
    SnapGrid,
    default_note_type,
    note_type_strings),
  YAML_FIELD_INT (SnapGrid, default_adaptive),
  YAML_FIELD_ENUM (
    SnapGrid,
    length_type,
    note_length_type_strings),
  YAML_FIELD_INT (SnapGrid, snap_to_grid),
  YAML_FIELD_INT (SnapGrid, snap_to_grid_keep_offset),
  YAML_FIELD_INT (SnapGrid, snap_to_events),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t snap_grid_schema = {
  CYAML_VALUE_MAPPING (
    CYAML_FLAG_POINTER,
    SnapGrid,
    snap_grid_fields_schema),
};
 
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