Utilities module

Files

file resources.h

Helpers for loading and using resources such as icons.

Classes

struct SupportedFile

Metadata for a supported file.

struct CairoCaches

Caches for cairo.

struct MPMCQueue

Multiple Producer Multiple Consumer lock-free queue.

struct Stack

Stack implementation.

struct GenericProgressInfo

Generic progress info.

struct UiColors

Commonly used UI colors.

struct UiTextures

Commonly used UI textures.

struct UiCursor

Specification for a cursor.

struct UiCaches

Caches.

struct ZrythmObject

Base object for debugging.

Enums

enum ZFileType { FILE_TYPE_MIDI, FILE_TYPE_MP3, FILE_TYPE_FLAC, FILE_TYPE_OGG, FILE_TYPE_WAV, FILE_TYPE_DIR, FILE_TYPE_PARENT_DIR, FILE_TYPE_OTHER, NUM_FILE_TYPES }

File type.

enum BitDepth { BIT_DEPTH_16, BIT_DEPTH_24, BIT_DEPTH_32 }

Bit depth.

enum AudioValueFormat { AUDIO_VALUE_AMPLITUDE, AUDIO_VALUE_DBFS, AUDIO_VALUE_FADER }

enum UiCursorState { UI_CURSOR_STATE_DEFAULT, UI_CURSOR_STATE_RESIZE_L, UI_CURSOR_STATE_REPEAT_L, UI_CURSOR_STATE_RESIZE_R, UI_CURSOR_STATE_REPEAT_R, UI_CURSOR_STATE_RESIZE_UP }

Various cursor states to be shared.

enum UiOverlayAction { UI_OVERLAY_ACTION_NONE, UI_OVERLAY_ACTION_CREATING_RESIZING_R, UI_OVERLAY_ACTION_CREATING_MOVING, UI_OVERLAY_ACTION_RESIZING_L, UI_OVERLAY_ACTION_RESIZING_L_LOOP, UI_OVERLAY_ACTION_RESIZING_L_FADE, UI_OVERLAY_ACTION_RESIZING_R, UI_OVERLAY_ACTION_RESIZING_R_LOOP, UI_OVERLAY_ACTION_RESIZING_R_FADE, UI_OVERLAY_ACTION_RESIZING_UP, UI_OVERLAY_ACTION_RESIZING_UP_FADE_IN, UI_OVERLAY_ACTION_RESIZING_UP_FADE_OUT, UI_OVERLAY_ACTION_STRETCHING_L, UI_OVERLAY_ACTION_STRETCHING_R, UI_OVERLAY_ACTION_AUDITIONING, UI_OVERLAY_ACTION_AUTOFILLING, UI_OVERLAY_ACTION_ERASING, UI_OVERLAY_ACTION_STARTING_ERASING, UI_OVERLAY_ACTION_STARTING_MOVING, UI_OVERLAY_ACTION_STARTING_MOVING_COPY, UI_OVERLAY_ACTION_STARTING_MOVING_LINK, UI_OVERLAY_ACTION_MOVING, UI_OVERLAY_ACTION_MOVING_COPY, UI_OVERLAY_ACTION_MOVING_LINK, UI_OVERLAY_ACTION_STARTING_CHANGING_CURVE, UI_OVERLAY_ACTION_CHANGING_CURVE, UI_OVERLAY_ACTION_STARTING_SELECTION, UI_OVERLAY_ACTION_SELECTING, UI_OVERLAY_ACTION_STARTING_DELETE_SELECTION, UI_OVERLAY_ACTION_DELETE_SELECTING, UI_OVERLAY_ACTION_STARTING_RAMP, UI_OVERLAY_ACTION_RAMPING, UI_OVERLAY_ACTION_CUTTING, UI_OVERLAY_ACTION_RENAMING, NUM_UI_OVERLAY_ACTIONS }

Various overlay actions to be shared.

enum UiDragMode { UI_DRAG_MODE_CURSOR, UI_DRAG_MODE_RELATIVE, UI_DRAG_MODE_RELATIVE_WITH_MULTIPLIER }

Dragging modes for widgets that have click&drag.

Typedefs

using ZFileType = enum ZFileType

File type.

using SupportedFile = struct SupportedFile

Metadata for a supported file.

using BitDepth = enum BitDepth

Bit depth.

using CairoCaches = struct CairoCaches

Caches for cairo.

using MPMCQueue = struct MPMCQueue

Multiple Producer Multiple Consumer lock-free queue.

using Stack = struct Stack

Stack implementation.

using midi_byte_t = uint8_t

MIDI byte.

using nframes_t = uint32_t

Frame count.

using sample_rate_t = uint32_t

Sample rate.

using midi_time_t = uint32_t

MIDI time in global frames.

using channels_t = unsigned int

Number of channels.

using sample_t = float

The sample type.

using bpm_t = float

The BPM type.

using GenericFloatGetter = float(*)(void*object)

Getter prototype for float values.

using GenericFloatSetter = void(*)(void*object, float val)

Setter prototype for float values.

using GenericStringGetter = const char*(*)(void*object)

Getter prototype for strings.

using GenericStringCopyGetter = void(*)(void*object, char*buf)

Getter prototype for strings to be saved in the given buffer.

using GenericStringSetter = void(*)(void*object, const char*val)

Setter prototype for float values.

using GenericCallback = void(*)(void*object)

Generic callback.

using GenericCmpFunc = int(*)(const void*a, const void*b)

Generic comparator.

using GenericPredicateFunc = bool(*)(const void*object, const void*user_data)

Predicate function prototype.

using GenericProgressInfo = struct GenericProgressInfo

Generic progress info.

using UiColors = struct UiColors

Commonly used UI colors.

using UiTextures = struct UiTextures

Commonly used UI textures.

using UiCursor = struct UiCursor

Specification for a cursor.

using UiCaches = struct UiCaches

Caches.

using UiCursorState = enum UiCursorState

Various cursor states to be shared.

using UiOverlayAction = enum UiOverlayAction

Various overlay actions to be shared.

using UiDragMode = enum UiDragMode

Dragging modes for widgets that have click&drag.

using ZrythmObject = struct ZrythmObject

Base object for debugging.

Functions

auto supported_file_new_from_path(const char* path) -> SupportedFile*

Creates a new SupportedFile from the given absolute path.

auto supported_file_type_get_description(ZFileType type) -> char*

Returns a human readable description of the given file type.

auto supported_file_clone(SupportedFile* src) -> SupportedFile*

Clones the given SupportedFile.

auto supported_file_type_is_supported(ZFileType type) -> int

Returns if the given type is supported.

auto supported_file_type_is_audio(ZFileType type) -> int

Returns if the SupportedFile is an audio file.

auto supported_file_type_is_midi(ZFileType type) -> int

Returns if the SupportedFile is a midi file.

auto supported_file_type_get_ext(ZFileType type) -> const char*

Returns the most common extension for the given filetype.

auto supported_file_get_type(const char* file) -> ZFileType

Returns the file type of the given file path.

auto supported_file_should_autoplay(const SupportedFile* self) -> NONNULL bool

Returns whether the given file should auto-play (shorter than 1 min).

auto supported_file_get_icon_name(const SupportedFile*const self) -> const char*

Gets the corresponding icon name for the given SupportedFile's type.

auto supported_file_get_info_text_for_label(const SupportedFile* self) -> NONNULL char*

Returns a pango markup to be used in GTK labels.

void supported_file_free(SupportedFile* self)

Frees the instance and all its members.

auto audio_write_raw_file(float* buff, long frames_already_written, long nframes, uint32_t samplerate, bool flac, BitDepth bit_depth, unsigned int channels, const char* filename) -> int

Writes the buffer as a raw file to the given path.

auto audio_get_num_frames(const char* filepath) -> long

Returns the number of frames in the given audio file.

auto audio_frames_equal(float* src1, float* src2, size_t num_frames, float epsilon) -> bool

Returns whether the frame buffers are equal.

auto audio_frames_empty(float* src, size_t num_frames) -> bool

Returns whether the frame buffer is empty (zero).

auto audio_detect_bpm(float* src, size_t num_frames, unsigned int samplerate, GArray* candidates) -> float

Detect BPM.

auto audio_get_num_cores(void) -> int

Returns the number of CPU cores.

auto _backtrace_get(const char* exe_path, const char* prefix, int max_lines, bool with_lines, bool write_to_file) -> char*

Returns the backtrace with max_lines number of lines and a string prefix.

static void z_cairo_rounded_rectangle(cairo_t* cr, double x, double y, double width, double height, double aspect, double corner_radius)

void _z_cairo_get_text_extents_for_widget(GtkWidget* widget, PangoLayout* layout, const char* text, int* width, int* height)

Gets the width of the given text in pixels for the given widget.

void z_cairo_draw_text_full(cairo_t* cr, GtkWidget* widget, PangoLayout* layout, const char* text, int start_x, int start_y)

Draws the given text using the given font starting at the given position.

static void z_cairo_diamond(cairo_t* cr, double x, double y, double width, double height)

Draws a diamond shape.

auto z_cairo_get_surface_from_icon_name(const char* icon_name, int size, int scale) -> cairo_surface_t*

Returns a surface for the icon name.

auto z_cairo_create_pango_layout_from_string(GtkWidget* widget, const char* font, PangoEllipsizeMode ellipsize_mode, int ellipsize_padding) -> PangoLayout*

Creates a PangoLayout to be cached in widgets based on the given settings.

auto z_cairo_create_pango_layout_from_description(GtkWidget* widget, PangoFontDescription* descr, PangoEllipsizeMode ellipsize_mode, int ellipsize_padding) -> PangoLayout*

Creates a PangoLayout to be cached in widgets based on the given settings.

auto z_cairo_create_default_pango_layout(GtkWidget* widget) -> PangoLayout*

Creates a PangoLayout with default settings.

void z_cairo_reset_caches(cairo_t** cr_cache, cairo_surface_t** surface_cache, int width, int height, cairo_t* new_cr)

Resets a surface and cairo_t with a new surface and cairo_t based on the given rectangle and cairo_t.

void color_brighten(GdkRGBA* src, float val)

Brightens the color by the given amount.

void color_brighten_default(GdkRGBA* src)

Brightens the color by the default amount.

void color_darken(GdkRGBA* src, float val)

Darkens the color by the given amount.

void color_darken_default(GdkRGBA* src)

Darkens the color by the default amount.

auto color_is_same(GdkRGBA* src, GdkRGBA* dest) -> bool

Returns whether the color is the same.

auto color_is_bright(GdkRGBA* src) -> bool

Returns if the color is bright or not.

auto color_is_very_bright(GdkRGBA* src) -> bool

Returns if the color is very bright or not.

auto color_is_very_very_bright(GdkRGBA* src) -> bool

Returns if the color is very very bright or not.

auto color_is_very_dark(GdkRGBA* src) -> bool

Returns if the color is very dark or not.

auto color_is_very_very_dark(GdkRGBA* src) -> bool

Returns if the color is very very dark or not.

void color_morph(GdkRGBA* a, GdkRGBA* b, float amt, GdkRGBA* result)

Morphs from a to b, depending on the given amount.

auto z_curl_get_page_contents(const char* url, int timeout) -> char*

Returns the contents of the page in a newly allocated string.

auto z_curl_get_page_contents_default(const char* url) -> char*

Returns the contents of the page in a newly allocated string.

auto z_curl_post_json_no_auth(const char* url, const char* data, int timeout, GError** error, ...) G_GNUC_NULL_TERMINATED -> int

Posts the given JSON to the URL without any authentication.

auto datetime_get_current_as_string(void) -> char*

Returns the current datetime as a string.

auto datetime_get_for_filename(void) -> char*

Get the current datetime to be used in filenames, eg, for the log file.

auto env_get_string(const char* key, const char* def) -> char*

Returns a newly allocated string.

auto env_get_int(const char* key, int def) -> int

Returns an int for the given environment variable if it exists and is valid, otherwise returns the default int.

auto file_reflink(const char* dest, const char* src) -> int

Do cp –reflink from src to dest.

auto utils_get_uint_from_bitfield_val(unsigned int bitfield) -> unsigned int

From https://graphics.stanford.edu/~seander/bithacks.html#ZerosOnRightLinear.

void z_gtk_widget_remove_all_children(GtkWidget* widget)

auto z_gtk_message_dialog_get_label(GtkMessageDialog* self, const int secondary) -> GtkLabel*

Returns the primary or secondary label of the given GtkMessageDialog.

void z_gtk_configure_simple_combo_box(GtkComboBox* cb, GtkTreeModel* model)

Configures a simple value-text combo box using the given model.

void z_gtk_button_set_icon_name_and_text(GtkButton* btn, const char* name, const char* text, bool icon_first, GtkOrientation orientation, int spacing)

Sets the icon name and optionally text.

auto z_gtk_toggle_button_new_with_icon(const char* name) -> GtkToggleButton*

Creates a toggle button with the given icon name.

auto z_gtk_toggle_button_new_with_icon_and_text(const char* name, const char* text, bool icon_first, GtkOrientation orientation, int spacing) -> GtkToggleButton*

Creates a toggle button with the given icon name.

auto z_gtk_button_new_with_icon_and_text(const char* name, const char* text, bool icon_first, GtkOrientation orientation, int spacing) -> GtkButton*

Creates a button with the given icon name and text.

auto z_gtk_button_new_with_resource(IconType icon_type, const char* name) -> GtkButton*

Creates a button with the given resource name as icon.

auto z_gtk_toggle_button_new_with_resource(IconType icon_type, const char* name) -> GtkToggleButton*

Creates a toggle button with the given resource name as icon.

auto z_gtk_create_menu_item_full(const gchar* label_name, const gchar* icon_name, const char* detailed_action) -> GMenuItem*

Creates a menu item.

auto z_gtk_get_single_selection_pointer(GtkTreeView* tv, int column) -> void*

Returns a pointer stored at the given selection.

auto z_gtk_get_tooltip_for_action(const char* detailed_action, const char* tooltip) -> char*

Gets the tooltip for the given action on the given widget.

void z_gtk_widget_set_tooltip_for_action(GtkWidget* widget, const char* detailed_action, const char* tooltip)

Sets the tooltip for the given action on the given widget.

void z_gtk_set_tooltip_for_actionable(GtkActionable* actionable, const char* tooltip)

Sets the tooltip and finds the accel keys and appends them to the tooltip in small text.

void z_gtk_widget_remove_style_class(GtkWidget* widget, const gchar* class_name)

Removes the given style class from the widget.

static auto z_gtk_widget_get_device(GtkWidget* widget) -> GdkDevice*

Gets the GdkDevice for a GtkWidget.

static void z_gtk_widget_get_mask(GtkWidget* widget, GdkModifierType* mask)

Sets the GdkModifierType given for the widget.

static auto z_gtk_keyval_is_alt(const guint keyval) -> int

Returns if the keyval is an Alt key.

static auto z_gtk_keyval_is_ctrl(const guint keyval) -> int

Returns if the keyval is a Control key.

static auto z_gtk_keyval_is_arrow(const guint keyval) -> int

Returns if the keyval is an arrow key.

static auto z_gtk_keyval_is_shift(const guint keyval) -> int

Returns if the keyval is a Shift key.

auto z_gtk_widget_get_nth_child(GtkWidget* widget, int index) -> GtkWidget*

Returns the nth child of a container.

void z_gtk_combo_box_set_ellipsize_mode(GtkComboBox* self, PangoEllipsizeMode ellipsize)

Sets the ellipsize mode of each text cell renderer in the combo box.

void z_gtk_button_set_emblem(GtkButton* btn, const char* emblem_icon)

Sets the given emblem to the button, or unsets the emblem if emblem_icon is NULL.

void z_gtk_setup_foldable_notebook(GtkNotebook* notebook)

Makes the given notebook foldable.

void z_gtk_widget_set_margin(GtkWidget* widget, int margin)

Sets the margin on all 4 sides on the widget.

auto z_gtk_activate_dir_link_func(GtkLabel* label, char* uri, void* data) -> bool

Callback to use for simple directory links.

void z_gtk_notebook_make_detachable(GtkNotebook* notebook, GtkWindow* parent_window)

Makes the given GtkNotebook detachable to a new window.

void z_gtk_message_dialog_wrap_message_area_in_scroll(GtkMessageDialog* dialog, int min_width, int min_height)

Wraps the message area in a scrolled window.

auto z_gtk_text_buffer_get_full_text(GtkTextBuffer* buffer) -> char*

Returns the full text contained in the text buffer.

void z_gtk_generate_screenshot_image(GtkWidget* widget, GtkWidget* child, const char* type, char** option_keys, char** option_values, char** ret_dir, char** ret_path, bool accept_fallback)

Generates a screenshot image for the given widget.

void z_gtk_actionable_set_action_from_setting(GtkActionable* actionable, GSettings* settings, const char* key)

Sets the action target of the given GtkActionable to be binded to the given setting.

auto z_gtk_tree_view_column_get_column_id(GtkTreeViewColumn* col) -> int

Returns column number or -1 if not found or on error.

void z_gtk_scrolled_window_get_visible_rect(GtkScrolledWindow* scroll, graphene_rect_t* rect)

Gets the visible rectangle from the scrolled window's adjustments.

auto z_gtk_dialog_run(GtkDialog* dialog, bool destroy_on_close) -> int

Mimics the blocking behavior.

void z_gtk_show_context_menu_from_g_menu(GtkPopoverMenu* popover_menu, double x, double y, GMenu* menu)

The popover must already exist as a children of its intended widget (or a common parent).

auto z_gtk_drop_target_get_selected_action(GtkDropTarget* drop_target) -> GdkDragAction

Returns the bitmask of the selected action during a drop (eg, GDK_ACTION_COPY).

auto z_gdk_clipboard_get_text(GdkClipboard* clipboard) -> char*

Returns the text on the clipboard, or NULL if there is nothing or the content is not text.

auto z_gdk_pixbuf_new_from_icon_name(const char* icon_name, int width, int height, int scale) -> GdkPixbuf*

Creates a new pixbuf for the given icon scaled at the given width/height.

auto z_gdk_texture_new_from_icon_name(const char* icon_name, int width, int height, int scale) -> GdkTexture*

Creates a new texture for the given icon scaled at the given width/height.

void z_gtk_widget_print_hierarchy(GtkWidget* widget)

Prints the widget's hierarchy (parents).

auto io_get_dir(const char* filename) -> NONNULL char*

Gets directory part of filename.

auto io_mkdir(const char* dir) -> NONNULL int

Makes directory if doesn't exist.

auto io_touch_file(const char* filename) -> NONNULL FILE*

Creates the file if doesn't exist.

auto io_file_strip_ext(const char* filename) -> NONNULL char*

Strips extensions from given filename.

auto io_file_get_ext(const char* file) -> NONNULL const char*

Returns file extension or NULL.

auto io_path_get_basename_without_ext(const char* filename) -> NONNULL char*

Strips path from given filename.

auto io_remove(const char* path) -> NONNULL int

Removes the given file.

auto io_rmdir(const char* path, bool force) -> NONNULL int

Removes a dir, optionally forcing deletion.

auto io_get_files_in_dir_ending_in(const char* _dir, const int recursive, const char* end_string, bool allow_empty) -> char**

Returns a list of the files in the given directory.

void io_copy_dir(const char* destdir_str, const char* srcdir_str, bool follow_symlinks, bool recursive)

Copies a directory.

auto io_get_next_available_filepath(const char* filepath) -> NONNULL char*

Returns a newly allocated path that is either a copy of the original path if the path does not exist, or the original path appended with (n), where n is a number.

auto io_open_directory(const char* path) -> NONNULL void

Opens the given directory using the default program.

auto io_escape_dir_name(char* dest, const char* dir) -> NONNULL void

Returns a clone of the given string after removing forbidden characters.

auto log_init_writer_idle(Log* self, unsigned int secs) -> NONNULL void

Initializes logging to a file.

auto log_idle_cb(Log* self) -> NONNULL int

Idle callback.

auto log_get_last_n_lines(Log* self, int n) -> NONNULL char*

Returns the last n lines as a newly allocated string.

auto log_generate_compressed_file(Log* self, char** ret_dir, char** ret_path, GError** error) -> bool

Generates a compressed log file (for sending with bug reports).

void log_init_with_file(Log* self, const char* filepath)

Initializes logging to a file.

auto log_new(void) -> Log*

Creates the logger and sets the writer func.

auto log_free(Log* self) -> NONNULL void

Stops logging and frees any allocated memory.

static auto math_fast_log2(float val) -> CONST float

Fast log calculation to be used where precision is not required (like log curves).

static auto math_get_fader_val_from_amp(sample_t amp) -> CONST sample_t

Returns fader value 0.0 to 1.0 from amp value 0.0 to 2.0 (+6 dbFS).

static auto math_get_amp_val_from_fader(sample_t fader) -> CONST sample_t

Returns amp value 0.0 to 2.0 (+6 dbFS) from fader value 0.0 to 1.0.

static auto math_amp_to_dbfs(sample_t amp) -> CONST sample_t

Convert from amplitude 0.0 to 2.0 to dbFS.

auto math_calculate_max_amp(sample_t* buf, const nframes_t nframes) -> sample_t

Gets the digital peak of the given signal as amplitude (0-2).

auto math_calculate_rms_db(sample_t* buf, const nframes_t nframes) -> sample_t

Calculate db using RMS method.

static auto math_dbfs_to_amp(sample_t dbfs) -> CONST sample_t

Convert form dbFS to amplitude 0.0 to 2.0.

static auto math_dbfs_to_fader_val(sample_t dbfs) -> CONST sample_t

Convert form dbFS to fader val 0.0 to 1.0.

auto math_assert_nonnann(float x) -> bool

Asserts that the value is non-nan.

void _free_later(void* object, void(*)(void*) dfunc, const char* file, const char* func, int line)

Frees the object after a while.

auto object_utils_new(void) -> ObjectUtils*

Inits the subsystems for the object utils in this file.

auto resources_get_icon(IconType icon_type, const char* filename) -> GtkWidget*

Creates a GtkImage of from the given information and returns it as a GtkWidget.

void resources_set_class_template(GtkWidgetClass* klass, const char* filename)

Sets class template from resource.

auto resources_get_gl_shader_data(const char* path) -> GBytes*

Returns the bytes of the specified OpenGL shader in RESOURCES_GL_SHADERS_PATH.

auto sort_alphabetical_func(const void* a, const void* b) -> int

Alphabetical sort func.

auto stack_new(int length) -> Stack*

Creates a new stack of the given size.

auto stack_pop_last(Stack* s) -> void*

Pops the last element and moves everything back.

auto string_is_ascii(const char* string) -> int

Returns if the string is ASCII.

auto string_array_contains_substr(char** str_array, int num_str, const char* substr) -> char*

Returns the matched string if the string array contains the given substring.

auto string_contains_substr(const char* str, const char* substr) -> bool

Returns if the given string contains the given substring.

void string_to_upper(const char* in, char* out)

Converts the given string to uppercase in out.

void string_to_lower(const char* in, char* out)

Converts the given string to lowercase in out.

auto string_is_equal_ignore_case(const char* str1, const char* str2) -> bool

Returns if the two strings are equal ignoring case.

auto string_convert_to_filename(const char* str) -> char*

Returns a newly allocated string that is a filename version of the given string.

auto string_get_substr_before_suffix(const char* str, const char* suffix) -> char*

Removes the suffix starting from suffix from full_str and returns a newly allocated string.

auto string_remove_until_after_first_match(const char* str, const char* match) -> char*

Removes everything up to and including the first match of match from the start of the string and returns a newly allocated string.

void string_replace_regex(char** str, const char* regex, const char* replace_str)

Replaces src_str with replace_str in all instances matched by regex.

auto string_get_regex_group(const char* str, const char* regex, int group) -> char*

Gets the string in the given regex group.

auto string_get_regex_group_as_int(const char* str, const char* regex, int group, int def) -> int

Gets the string in the given regex group as an integer.

auto string_get_int_after_last_space(const char* str, char* str_without_num) -> int

Returns the integer found at the end of a string like "My String 3" -> 3, or -1 if no number is found.

auto string_array_sort_and_remove_duplicates(char** str_arr) -> char**

TODO Sorts the given string array and removes duplicates.

void string_copy_w_realloc(char** dest, const char* src)

Copies the string src to the buffer in dest after reallocating the buffer in dest to the length of src.

auto string_symbolify(const char* in) -> char*

Returns a new string with only ASCII alphanumeric characters and replaces ther est with underscore.

auto string_is_empty(const char* str) -> bool

Returns whether the string is NULL or empty.

auto system_run_cmd(const char* cmd, long ms_timer) -> int

Runs the given command in the background, waits for it to finish and returns its exit code.

auto system_get_cmd_output(char** argv, long ms_timer, bool always_wait) -> char*

Runs the command and returns the output, or NULL.

auto system_run_cmd_w_args(const char** args, int ms_to_wait, char** out_stdout, char** out_stderr, bool warn_if_fail) -> int

Runs the given command in the background, waits for it to finish and returns its exit code.

void ui_set_cursor_from_icon_name(GtkWidget* widget, const char* name, int offset_x, int offset_y)

Sets cursor from icon name.

void ui_set_cursor_from_name(GtkWidget* widget, const char* name)

Sets cursor from standard cursor name.

void ui_show_message_full(GtkWindow* parent_window, GtkMessageType type, const char* format, ...) G_GNUC_PRINTF(3

Shows a popup message of the given type with the given message.

auto ui_is_point_in_rect_hit(GdkRectangle* rect, const bool check_x, const bool check_y, double x, double y, double x_padding, double y_padding) -> bool

Returns if rect is hit or not by the given coordinate.

auto ui_is_child_hit(GtkWidget* parent, GtkWidget* child, const int check_x, const int check_y, const double x, const double y, const double x_padding, const double y_padding) -> int

Returns if the child is hit or not by the coordinates in parent.

auto ui_get_hit_child(GtkWidget* parent, double x, double y, GType type) -> GtkWidget*

Returns the matching hit child, or NULL.

auto ui_px_to_pos_timeline(double px, Position* pos, bool has_padding) -> NONNULL void

Converts from pixels to position.

auto ui_px_to_frames_timeline(double px, int has_padding) -> long

Converts from pixels to frames.

auto ui_px_to_frames_editor(double px, int has_padding) -> long

Converts from pixels to frames.

auto ui_pos_to_px_timeline(Position* pos, int use_padding) -> NONNULL int

Converts position to px, optionally adding the ruler padding.

auto ui_pos_to_px_editor(Position* pos, bool use_padding) -> NONNULL int

Converts position to px, optionally adding the ruler padding.

auto ui_px_to_pos_editor(double px, Position* pos, bool has_padding) -> NONNULL void

Converts from pixels to position.

void ui_rgb_to_hex(double red, double green, double blue, char* buf)

Converts RGB to hex string.

void ui_show_notification(const char* msg)

Shows a notification in the revealer.

auto ui_show_notification_idle_func(char* msg) -> int

Show notification from non-GTK threads.

void ui_setup_language_dropdown(GtkDropDown* dropdown)

Sets up a combo box to have a selection of languages.

void ui_setup_audio_backends_combo_box(GtkComboBox* cb)

Sets up an audio backends combo box.

void ui_setup_midi_backends_combo_box(GtkComboBox* cb)

Sets up a MIDI backends combo box.

void ui_setup_pan_algo_combo_box(GtkComboBox* cb)

Sets up a pan algorithm combo box.

void ui_setup_pan_law_combo_box(GtkComboBox* cb)

Sets up a pan law combo box.

void ui_setup_buffer_size_combo_box(GtkComboBox* cb)

Sets up a pan law combo box.

void ui_setup_samplerate_combo_box(GtkComboBox* cb)

Sets up a pan law combo box.

void ui_setup_device_name_combo_box(GtkComboBoxText* cb)

Sets up a pan law combo box.

void ui_setup_vst_paths_entry(GtkEntry* entry)

Sets up the VST paths entry.

void ui_update_vst_paths_from_entry(GtkEntry* entry)

Updates the the VST paths in the gsettings from the text in the entry.

auto ui_get_locale_not_available_string(LocalizationLanguage lang) -> char*

Returns the "a locale for the language you have selected..." text based on the given language.

void ui_get_contrast_color(GdkRGBA* src, GdkRGBA* dest)

Returns the contrasting color (variation of black or white) based on if the given color is dark enough or not.

void ui_get_mid_color(GdkRGBA* dest, const GdkRGBA* c1, const GdkRGBA* c2, const float transition)

Returns the color in-between two colors.

static auto ui_rectangle_overlap(const GdkRectangle*const rect1, const GdkRectangle*const rect2) -> NONNULL static PURE bool

Returns if the 2 rectangles overlay.

void ui_get_arranger_object_color(GdkRGBA* color, const bool is_hovered, const bool is_selected, const bool is_transient, const bool is_muted)

Gets the color the widget should be.

auto ui_get_normalized_draggable_value(double size, double cur_val, double start_px, double cur_px, double last_px, double multiplier, UiDragMode mode) -> double

Gets a draggable value as a normalized value between 0 and 1.

void vamp_print_all(void)

Prints detected vamp plugins.

auto yaml_serialize(void* data, const cyaml_schema_value_t* schema) -> NONNULL char*

Serializes to YAML.

void yaml_cyaml_log_func(cyaml_log_t level, void* ctxt, const char* format, va_list args)

Custom logging function for libcyaml.

Variables

Log* zlog

Global variable, available to all files.

static const char* ui_overlay_strings

Various overlay actions to be shared.

Defines

#define STRIP_SIZE

Number of plugin slots per channel.

#define Z_CAIRO_FONT

Default font for drawing pango text.

#define Z_CAIRO_TEXT_PADDING

Padding to leave from the top/left edges when drawing text.

#define z_cairo_draw_text(cr, widget, layout, text)

Draw text with default padding.

#define file_exists(file)

Returns 1 if the file/dir exists.

#define io_get_files_in_dir(dir, allow_empty)

Returns a list of the files in the given directory.

#define MATH_RMS_FRAMES

Frames to skip when calculating the RMS.

#define MATH_TINY_NUMBER

Tiny number to be used for denormaml prevention (-140dB).

#define math_floats_equal_epsilon(a, b, e)

Checks if 2 doubles are equal.

#define math_floats_equal(a, b)

Checks if 2 doubles are equal.

#define math_round_double_to_type(x, type)

Rounds a double to an int.

#define math_round_double_to_int(x)

Rounds a double to an int.

#define math_round_double_to_size_t(x)

Rounds a double to a size_t.

#define math_round_double_to_long(x)

Rounds a double to a long.

#define math_round_float_to_type(x, type)

Rounds a float to a given type.

#define math_round_float_to_int(x)

Rounds a float to an int.

#define math_round_float_to_long(x)

Rounds a float to a long.

#define free_later(obj, func)

Calls _free_later after doing the casting so the caller doesn't have to.

#define object_new(type)

Allocates memory for an object of type type.

#define object_new_n_sizeof(n, sz)

Calloc equivalent.

#define object_new_n(n, type)

Calloc n blocks for type type.

#define object_realloc_n(obj, prev_n, n, type)

Reallocate memory for obj.

#define object_set_to_zero(ptr)

Zero's out the struct pointed to by ptr.

#define object_zero_and_free(ptr)

Zero's out a struct pointed to by ptr and frees the object.

#define object_free_w_func_and_null(_func, _obj)

Call the function _func to free _obj and set _obj to NULL.

#define g_object_unref_and_null(ptr)

Convenience wrapper.

#define g_free_and_null(ptr)

Convenience wrapper.

#define g_error_free_and_null(ptr)

Convenience wrapper.

#define object_free_w_func_and_null_cast(_func, _cast, _obj)

Convenience wrapper.

#define string_is_equal(str1, str2)

Returns if the two strings are exactly equal.

#define UI_RESIZE_CURSOR_SPACE

Space on the edges to show resize cursors.

#define TARGET_ENTRY_PLUGIN_DESCR

Plugin descriptor, used to instantiate plugins.

#define TARGET_ENTRY_SUPPORTED_FILE

For SupportedFile pointers.

#define TARGET_ENTRY_PLUGIN

Plugin ID, used to move/copy plugins.

#define TARGET_ENTRY_URI_LIST

URI list.

#define TARGET_ENTRY_TRACK

Track target entry.

#define TARGET_ENTRY_CHORD_DESCR

Chord descriptor target entry.

#define ui_show_notification_idle(msg)

Shows the notification when idle.

#define ui_show_error_message(win, msg)

Wrapper to show error message so that no casting of the window is needed on the caller side.

#define ui_show_message_printf(win, type, fmt, ...)

Type can be GTK_MESSAGE_ERROR, etc.

#define YAML_FIELD_MAPPING_EMBEDDED(owner, member, schema)

Mapping embedded inside the struct.

#define YAML_FIELD_MAPPING_PTR(owner, member, schema)

Mapping pointer to a struct.

#define YAML_FIELD_MAPPING_PTR_OPTIONAL(owner, member, schema)

Mapping pointer to a struct.

#define YAML_FIELD_FIXED_SIZE_PTR_ARRAY_VAR_COUNT(owner, member, schema)

Fixed-width array of pointers with variable count.

#define YAML_FIELD_FIXED_SIZE_PTR_ARRAY(owner, member, schema, size)

Fixed-width array of pointers with fixed count.

#define YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT(owner, member, schema)

Dynamic-width (reallocated) array of pointers with variable count.

#define YAML_FIELD_DYN_ARRAY_VAR_COUNT(owner, member, schema)

Dynamic-width (reallocated) array of structs with variable count.

#define YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT_OPT(owner, member, schema)

Dynamic-width (reallocated) array of pointers with variable count, nullable.

#define YAML_FIELD_DYN_ARRAY_VAR_COUNT_PRIMITIVES(owner, member, schema)

Dynamic-width (reallocated) array of primitives with variable count.

#define YAML_FIELD_SEQUENCE_FIXED(owner, member, schema, size)

Fixed sequence of pointers.

#define YAML_VALUE_PTR(cc, fields_schema)

Schema to be used as a pointer.

#define YAML_VALUE_PTR_NULLABLE(cc, fields_schema)

Schema to be used as a pointer that can be NULL.

#define YAML_VALUE_DEFAULT(cc, fields_schema)

Schema to be used for arrays of structs directly (not as pointers).

Enum documentation

Typedef documentation

Function documentation

Variable documentation

Define documentation

 @
MyStruct * my_structs[MAX_STRUCTS];
int        num_my_structs;

 @
MyStruct * my_structs[MAX_STRUCTS_CONST];

 @
AutomationTrack ** ats;
int                num_ats;
int                ats_size;

 @
RegionIdentifier * ids;
int                num_ids;
int                ids_size;

 @
AutomationTrack ** ats;
int                num_ats;
int                ats_size;

 @
int * ids;
int   num_ids;
int   ids_size;