region.h File Reference

A region in the timeline. More...

#include "dsp/automation_point.h"
#include "dsp/chord_object.h"
#include "dsp/midi_note.h"
#include "dsp/position.h"
#include "dsp/region_identifier.h"
#include "gui/backend/arranger_object.h"
#include "utils/yaml.h"
#include <glib/gi18n.h>

Include dependency graph for region.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Region
	A region (clip) is an object on the timeline that contains either MidiNote's or AudioClip's. More...

Macros
#define	REGION_MAGIC   93075327
#define	IS_REGION(x)   (((Region *) x)->magic == REGION_MAGIC)
#define	IS_REGION_AND_NONNULL(x)   (x && IS_REGION (x))
#define	REGION_PRINTF_FILENAME   "%s_%s.mid"
#define	region_is_selected(r)   arranger_object_is_selected ((ArrangerObject *) r)
#define	region_type_can_fade(rtype)   (rtype == RegionType::REGION_TYPE_AUDIO)
	Returns if the given Region type can have fades.

Enumerations
enum class	RegionMusicalMode { RegionMusicalMode::REGION_MUSICAL_MODE_INHERIT , RegionMusicalMode::REGION_MUSICAL_MODE_OFF , RegionMusicalMode::REGION_MUSICAL_MODE_ON }
	Musical mode setting for audio regions. More...

Functions
const char *	region_musical_mode_to_str (RegionMusicalMode mode)
void	region_init (Region *region, const Position *start_pos, const Position *end_pos, unsigned int track_name_hash, int lane_pos, int idx_inside_lane)
	Only to be used by implementing structs.
HOT NONNULL Region *	region_find (const RegionIdentifier *const id)
	Looks for the Region matching the identifier.
NONNULL void	region_print_to_str (const Region *self, char *buf, const size_t buf_size)
NONNULL bool	region_has_link_group (Region *region)
void	region_copy (Region *src, Region *dest)
	Copies the data from src to dest.
Region *	region_at_position (const Track *track, const AutomationTrack *at, const Position *pos)
	Returns the region at the given position in the given Track.
void	region_get_type_as_string (RegionType type, char *buf)
void	region_create_link_group_if_none (Region *region)
void	region_copy_children (Region *dest, Region *src)
	Clones and copies all children from src to dest.
NONNULL bool	region_is_looped (const Region *const self)

Detailed Description

A region in the timeline.

Definition in file region.h.