clip.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_CLIP_H__
#define __AUDIO_CLIP_H__
 
#include <stdbool.h>
 
#include "utils/audio.h"
#include "utils/types.h"
#include "utils/yaml.h"
 
#define AUDIO_CLIP_SCHEMA_VERSION 1
 
typedef struct AudioClip
{
  int schema_version;
 
  char * name;
 
  sample_t * frames;
 
  unsigned_frame_t num_frames;
 
  sample_t * ch_frames[16];
 
  channels_t channels;
 
  bpm_t bpm;
 
  int samplerate;
 
  BitDepth bit_depth;
 
  bool use_flac;
 
  int pool_id;
 
  char * file_hash;
 
  unsigned_frame_t frames_written;
 
  gint64 last_write;
} AudioClip;
 
static const cyaml_schema_field_t audio_clip_fields_schema[] = {
  YAML_FIELD_INT (AudioClip, schema_version),
  YAML_FIELD_STRING_PTR (AudioClip, name),
  YAML_FIELD_STRING_PTR_OPTIONAL (AudioClip, file_hash),
  YAML_FIELD_FLOAT (AudioClip, bpm),
  YAML_FIELD_ENUM (AudioClip, bit_depth, bit_depth_strings),
  YAML_FIELD_INT (AudioClip, use_flac),
  YAML_FIELD_INT (AudioClip, samplerate),
  YAML_FIELD_INT (AudioClip, pool_id),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t audio_clip_schema = {
  YAML_VALUE_PTR_NULLABLE (AudioClip, audio_clip_fields_schema),
};
 
static inline bool
audio_clip_use_flac (BitDepth bd)
{
  return false;
  /* FLAC seems to fail writing sometimes so disable for now */
#if 0
  return bd < BIT_DEPTH_32;
#endif
}
 
COLD NONNULL bool
audio_clip_init_loaded (AudioClip * self, GError ** error);
 
NONNULL_ARGS (1)
AudioClip * audio_clip_new_from_file (const char * full_path, GError ** error);
 
AudioClip *
audio_clip_new_from_float_array (
  const float *          arr,
  const unsigned_frame_t nframes,
  const channels_t       channels,
  BitDepth               bit_depth,
  const char *           name);
 
AudioClip *
audio_clip_new_recording (
  const channels_t       channels,
  const unsigned_frame_t nframes,
  const char *           name);
 
NONNULL void
audio_clip_update_channel_caches (AudioClip * self, size_t start_from);
 
NONNULL AudioClip *
audio_clip_edit_in_ext_program (AudioClip * self, GError ** error);
 
WARN_UNUSED_RESULT NONNULL bool
audio_clip_write_to_file (
  AudioClip *  self,
  const char * filepath,
  bool         parts,
  GError **    error);
 
WARN_UNUSED_RESULT NONNULL bool
audio_clip_write_to_pool (
  AudioClip * self,
  bool        parts,
  bool        is_backup,
  GError **   error);
 
NONNULL char *
audio_clip_get_path_in_pool_from_name (
  const char * name,
  bool         use_flac,
  bool         is_backup);
 
NONNULL char *
audio_clip_get_path_in_pool (AudioClip * self, bool is_backup);
 
NONNULL bool
audio_clip_is_in_use (AudioClip * self, bool check_undo_stack);
 
NONNULL void
audio_clip_remove_and_free (AudioClip * self, bool backup);
 
NONNULL AudioClip *
audio_clip_clone (AudioClip * src);
 
NONNULL void
audio_clip_free (AudioClip * self);
 
#endif