package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install 

dune-project
 Dependency

codeberg.org Readme Edit opam file Versions (5)

Authors

  1. E
    EruEri <nayinayu@mailo.com>

Maintainers

  1. E
    EruEri <nayinayu@mailo.com>

Sources

0.1.0.tar.gz
sha256=bb7f91cc44c09f922d2a614e9e01fd0d2976840bacf839a8b99de63c6fc5b3b8
sha512=f02827db4228b017bb2ad7d64cb1c0667831ec2341e6f759266ec834e40627c2affeace143c6d5e769b3acce63f889b3cbd1a9ca4768091840e8fce1d4750f86

doc/src/shakuhachi.plugin/plugin.ml.html

Source file plugin.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
(**********************************************************************************************)
(*                                                                                            *)
(* This file is part of shakuhachi: a music collection manager                                *)
(* Copyright (C) 2025 Yves Ndiaye                                                             *)
(*                                                                                            *)
(* shakuhachi is free software: you can redistribute it and/or modify it under the terms      *)
(* of the GNU General Public License as published by the Free Software Foundation,            *)
(* either version 3 of the License, or (at your option) any later version.                    *)
(*                                                                                            *)
(* shakuhachi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;    *)
(* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR           *)
(* PURPOSE.  See the GNU General Public License for more details.                             *)
(* You should have received a copy of the GNU General Public License along with shakuhachi.   *)
(* If not, see <http://www.gnu.org/licenses/>.                                                *)
(*                                                                                            *)
(**********************************************************************************************)

(** Operations for plugin. *)

(** Signature of a shakuhachi plugin. *)
module type S = sig
  val name : string
  (** Plugin's name. This name should match the one inside the configuration
      file. *)

  val on_loaded :
    (Skhclibs.Collection.t -> SkhcConfig.Plugin.Config.t -> bool) option
  (** [on_loaded collection plg_conf] is called when the module is successfully
      loaded.*)

  val on_scan_file : (Skhclibs.Collection.t -> string -> string) option
  (** [on_scan_file collection path] is called when a file at [path] will be
      treated for importing. [on_scan_file] returns the path to the file that
      have to being imported. Useful if your want to transcode audiofile before
      importing. *)

  val on_scan_metadata :
    (Skhclibs.Collection.t ->
    string ->
    SkhcMetadata.Metadata.t ->
    SkhcMetadata.Metadata.t
    )
    option
  (** [on_metadata collection path metadata] is called right after the medadata
      being extracted from the audio file at [path] when importing. *)

  val on_file_moved : (Skhclibs.Collection.t -> string -> string -> unit) option
  (** [on_file_moved collection src dst] is called when a file within a
      collection is moved from [src] to [dst] *)

  val on_music_modified :
    (Skhclibs.Collection.t -> SkhcDb.MusicFile.t -> SkhcDb.MusicFile.t -> unit)
    option
  (** [on_music_modified collection old new'] is called when [old] is modified.
      At least a field, other than {i id} and {i updated_at} is different
      between [old] and [new']. *)

  val on_artist_modified :
    (Skhclibs.Collection.t -> SkhcDb.Artist.t -> SkhcDb.Artist.t -> unit) option
  (** [on_artist_modified collection old new'] is called when [old] is modified.
      At least a field, other than {i id} and {i updated_at} is different
      between [old] and [new']. *)

  val on_album_modified :
    (Skhclibs.Collection.t -> SkhcDb.Album.t -> SkhcDb.Album.t -> unit) option
  (** [on_album_modified collection old new'] is called when [old] is modified.
      At least a field, other than {i id} and {i updated_at} is different
      between [old] and [new']. *)

  val on_playlist_modified :
    (Skhclibs.Collection.t -> SkhcDb.Playlist.t -> SkhcDb.Playlist.t -> unit)
    option
  (** [on_playlist_modified collection old new'] is called when [old] is
      modified. At least a field, other than {i id} and {i updated_at} is
      different between [old] and [new']. *)

  val on_playlist_tracks_updated :
    (Skhclibs.Collection.t ->
    SkhcDb.Playlist.t ->
    ( SkhcDb.MusicFile.t
    * SkhcDb.Album.t
    * (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
    * SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t
    )
    list ->
    unit
    )
    option
  (** [on_playlist_tracks_updated collection playlist musics] is called when the
      musics inside of [playlist] has been updated. *)
end

let plugins : (module S) list ref = ref []

(** [register plugin] registers [plugin] to be loaded by [skhc]. *)
let register plugin = plugins := plugin :: !plugins

(** [plugins ()] returns all the plugins currently loaded. *)
let plugins () = !plugins