mecomp-cli 0.1.0

CLI frontend for the MECOMP music player daemon
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
pub mod implementations;
pub mod printing;
pub mod utils;

#[cfg(test)]
mod smoke_tests;

use clap::{Subcommand, ValueEnum};

pub trait CommandHandler {
    type Output;

    async fn handle(
        &self,
        ctx: tarpc::context::Context,
        client: mecomp_core::rpc::MusicPlayerClient,
    ) -> Self::Output;
}

#[derive(Debug, Subcommand)]
pub enum Command {
    /// Ping the daemon
    Ping,
    /// Stop the daemon
    #[clap(alias = "exit")]
    Stop,
    /// Library commands
    Library {
        #[clap(subcommand)]
        command: LibraryCommand,
    },
    /// Status commands (get the status of a running rescan, analysis, or reclustering)
    Status {
        #[clap(subcommand)]
        command: StatusCommand,
    },
    /// State commands
    State,
    /// Current (audio state)
    Current { target: CurrentTarget },
    /// Rand (audio state)
    Rand { target: RandTarget },
    /// Search (fuzzy keys)
    #[clap(hide = true)]
    Search {
        /// What we're searching for
        target: SearchTarget,

        /// The search query
        query: String,

        /// The number of results to return
        #[clap(default_value = "10")]
        limit: u32,
    },
    /// Playback control
    Playback {
        #[clap(subcommand)]
        command: PlaybackCommand,
    },
    /// Queue control
    Queue {
        #[clap(subcommand)]
        command: QueueCommand,
    },
    /// Playlist control
    Playlist {
        #[clap(subcommand)]
        command: PlaylistCommand,
    },
    /// Collection control
    Collection {
        #[clap(subcommand)]
        command: CollectionCommand,
    },
    /// Radio control
    Radio {
        #[clap(subcommand)]
        command: RadioCommand,
    },
}

#[derive(Debug, Subcommand)]
pub enum LibraryCommand {
    /// Rescan the library
    Rescan,
    /// Analyze the library
    Analyze,
    /// Recluster the library
    Recluster,
    /// Get brief library info
    Brief,
    /// Get detailed library info
    Full,
    /// Get library health info
    Health,
    /// List of stuff in the library
    List {
        /// List detailed info
        #[clap(long)]
        full: bool,
        /// What to list (artists, albums, songs)
        target: LibraryListTarget,
    },
    /// Get a db item by its id
    Get {
        /// What to get (artist, album, song, playlist)
        target: LibraryGetTarget,
        /// The id of the item
        id: String,
    },
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum LibraryListTarget {
    Artists,
    Albums,
    Songs,
}
#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum LibraryGetTarget {
    Artist,
    Album,
    Song,
    Playlist,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum CurrentTarget {
    Artist,
    Album,
    Song,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum RandTarget {
    Artist,
    Album,
    Song,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum SearchTarget {
    All,
    Artist,
    Album,
    Song,
}

#[derive(Debug, Subcommand)]
pub enum StatusCommand {
    /// Get the status of a rescan
    Rescan,
    /// Get the status of an analysis
    Analyze,
    /// Get the status of a recluster
    Recluster,
}

#[derive(Debug, Subcommand)]
pub enum PlaybackCommand {
    /// Toggle play/pause
    Toggle,
    /// Play
    Play,
    /// Pause
    Pause,
    /// Stop
    Stop,
    /// Restart
    Restart,
    /// Next
    Next,
    /// Previous
    Previous,
    /// Seek
    Seek {
        #[clap(subcommand)]
        command: SeekCommand,
    },
    /// Set volume
    Volume {
        #[clap(subcommand)]
        command: VolumeCommand,
    },
    /// Set repeat mode
    Repeat {
        /// The repeat mode to set to (none, once, continuous)
        mode: RepeatMode,
    },
    /// Shuffle the queue
    Shuffle,
}

#[derive(Debug, Subcommand)]
pub enum SeekCommand {
    /// Seek forwards by a given amount (in seconds)
    #[clap(alias = "f", alias = "+", alias = "ahead")]
    Forward {
        /// The amount to seek by
        amount: f32,
    },
    /// Seek backwards by a given amount
    #[clap(alias = "b", alias = "-", alias = "back")]
    Backward {
        /// The amount to seek by
        amount: f32,
    },
    /// Seek to a given position
    #[clap(alias = "a", alias = "=", alias = "to")]
    Absolute {
        /// The position to seek to
        position: f32,
    },
}

#[derive(Debug, Subcommand)]
pub enum VolumeCommand {
    /// Set the volume
    Set {
        /// The volume to set to (0 is mute, 100 is max)
        volume: f32,
    },
    /// Increase the volume
    #[clap(alias = "up")]
    Increase {
        /// The amount to increase the volume by (0-100)
        amount: f32,
    },
    /// Decrease the volume
    #[clap(alias = "down")]
    Decrease {
        /// The amount to decrease the volume by (0-100)
        amount: f32,
    },
    /// Mute the volume
    Mute,
    /// Unmute the volume
    Unmute,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum RepeatMode {
    None,
    Once,
    Continuous,
}

impl From<RepeatMode> for mecomp_core::state::RepeatMode {
    fn from(mode: RepeatMode) -> Self {
        match mode {
            RepeatMode::None => Self::None,
            RepeatMode::Once => Self::Once,
            RepeatMode::Continuous => Self::Continuous,
        }
    }
}

#[derive(Debug, Subcommand)]
pub enum QueueCommand {
    /// Clear the queue
    Clear,
    /// List the queue
    List,
    /// Add to the queue
    Add {
        /// What to add (artist, album, song, playlist)
        target: QueueAddTarget,
        /// The id of the item
        id: String,
    },
    /// Remove a range of items from the queue
    Remove {
        /// The start index of the range to remove
        start: usize,
        /// The end index of the range to remove
        end: usize,
    },
    /// set the current song to the given index
    Set {
        /// The index to set the current song to
        index: usize,
    },
    /// Add a list of items to the queue (from a pipe)
    /// ex:
    /// ```sh, ignore
    /// mecomp-cli search all "the beatles" -q | mecomp-cli queue pipe
    /// ```
    /// This will add all the results of the search to the queue
    Pipe,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum QueueAddTarget {
    Artist,
    Album,
    Song,
    Playlist,
    Collection,
}

#[derive(Debug, Subcommand)]
pub enum PlaylistCommand {
    /// List playlists
    List,
    /// Get a playlist by its id or name
    Get {
        /// What to get by (id, name)
        method: PlaylistGetMethod,
        /// The id or name of the playlist
        target: String,
    },
    /// Create a playlist
    Create {
        /// The name of the playlist
        name: String,
    },
    /// Delete a playlist
    Delete {
        /// The id of the playlist
        id: String,
    },
    /// Add to a playlist
    Add {
        #[clap(subcommand)]
        command: PlaylistAddCommand,
    },
    /// Remove from a playlist
    Remove {
        /// The id of the playlist
        id: String,
        /// The id of the songs(s) to remove
        item_ids: Vec<String>,
    },
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, ValueEnum)]
pub enum PlaylistGetMethod {
    Id,
    Name,
}

#[derive(Debug, Subcommand)]
pub enum PlaylistAddCommand {
    /// Add an artist to a playlist
    Artist {
        /// The id of the playlist
        id: String,
        /// The id of the artist
        artist_id: String,
    },
    /// Add an album to a playlist
    Album {
        /// The id of the playlist
        id: String,
        /// The id of the album
        album_id: String,
    },
    /// Add a song to a playlist
    Song {
        /// The id of the playlist
        id: String,
        /// The ids of the song(s) to add
        song_ids: Vec<String>,
    },
    /// Add a list of items to the playlist (from a pipe)
    /// ex:
    /// ```sh, ignore
    /// mecomp-cli search all "the beatles" -q | mecomp-cli playlist add pipe
    /// ```
    /// This will add all the results of the search to the playlist
    Pipe {
        /// The id of the playlist
        id: String,
    },
}

#[derive(Debug, Subcommand)]
pub enum CollectionCommand {
    /// List collections
    List,
    /// Get a collection by its id
    Get {
        /// The id of the collection
        id: String,
    },
    /// Recluster collections
    Recluster,
    /// Freeze a collection
    Freeze {
        /// The id of the collection
        id: String,
        /// The new name of the collection
        name: String,
    },
}

#[derive(Debug, Subcommand)]
pub enum RadioCommand {
    /// get the 'n' most similar songs to the given song
    Song {
        /// The id of the song
        id: String,
        /// The number of songs to get
        n: u32,
    },
    /// get the 'n' most similar songs to the given artist
    Artist {
        /// The id of the artist
        id: String,
        /// The number of songs to get
        n: u32,
    },
    /// get the 'n' most similar songs to the given album
    Album {
        /// The id of the album
        id: String,
        /// The number of songs to get
        n: u32,
    },
    /// get the 'n' most similar songs to the given playlist
    Playlist {
        /// The id of the playlist
        id: String,
        /// The number of songs to get
        n: u32,
    },
    /// Add a list of items to the radio (from a pipe)
    /// ex:
    /// ```sh, ignore
    /// mecomp-cli search all "the beatles" -q | mecomp-cli radio pipe
    /// ```
    /// This will add all the results of the search to the radio
    Pipe {
        /// The number of songs to get
        n: u32,
    },
}