supported_file.h

Go to the documentation of this file.

// clang-format off
// SPDX-FileCopyrightText: © 2019-2021, 2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
// clang-format on
 
#ifndef __AUDIO_SUPPORTED_FILE_H__
#define __AUDIO_SUPPORTED_FILE_H__
 
#include <glib.h>
 
typedef struct _WrappedObjectWithChangeSignal WrappedObjectWithChangeSignal;
 
#define SUPPORTED_FILE_DND_PREFIX Z_DND_STRING_PREFIX "SupportedFile::"
 
enum class 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,
};
 
typedef struct SupportedFile
{
  char * abs_path;
 
  ZFileType type;
 
  char * label;
 
  int hidden;
 
  // MidiFile *     midi_file;
 
  // AudioFile *    midi_file;
 
  WrappedObjectWithChangeSignal * gobj;
} SupportedFile;
 
SupportedFile *
supported_file_new_from_path (const char * path);
 
SupportedFile *
supported_file_new_from_uri (const char * uri, GError ** error);
 
char *
supported_file_type_get_description (ZFileType type);
 
SupportedFile *
supported_file_clone (const SupportedFile * src);
 
int
supported_file_type_is_supported (ZFileType type);
 
int
supported_file_type_is_audio (ZFileType type);
 
int
supported_file_type_is_midi (ZFileType type);
 
const char *
supported_file_type_get_ext (ZFileType type);
 
NONNULL ZFileType
supported_file_get_type (const char * file);
 
NONNULL bool
supported_file_should_autoplay (const SupportedFile * self);
 
const char *
supported_file_get_icon_name (const SupportedFile * const self);
 
NONNULL char *
supported_file_get_info_text_for_label (const SupportedFile * self);
 
void
supported_file_free (SupportedFile * self);
 
#endif