caesura 0.31.0

An all-in-one command line tool to transcode FLAC audio files and upload to gazelle based indexers/trackers
Documentation 
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

//! Command enum as the single source of truth for CLI structure.

use crate::prelude::*;
use caesura_macros::CommandEnum;

/// Concrete [`ArgsProvider`] wired to the caesura CLI parser and command enum.
pub type ArgumentsProvider = ArgsProvider<Cli, Command>;

/// An all-in-one command line tool to transcode FLAC audio files
/// and upload to gazelle based indexers/trackers
#[derive(CommandEnum, Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Command {
    /// Scan `.torrent` files, or a single torrent by tracker id, for problematic file paths.
    #[options(AuditArgs, AuditOptions, ConfigOptions)]
    Audit,

    /// Verify, transcode, and upload from multiple FLAC sources in one command.
    #[options(
        ConfigOptions,
        SharedOptions,
        VerifyOptions,
        TargetOptions,
        SpectrogramOptions,
        SoxOptions,
        CopyOptions,
        FileOptions,
        RunnerOptions,
        UploadOptions,
        QbitOptions,
        QbitUploadOptions,
        CacheOptions,
        BatchOptions,
        ReportOptions
    )]
    Batch,

    /// Read the config file if it exists and concatenate default values.
    #[options(ConfigOptions)]
    Config,

    /// Find a source on the primary indexer and look up cross-seeds on the cross indexer.
    #[options(
        SourceArg,
        ConfigOptions,
        SharedOptions,
        CacheOptions,
        FileOptions,
        TargetOptions,
        CrossConfigOptions,
        CrossOptions,
        QbitOptions,
        QbitCrossOptions,
        CopyOptions
    )]
    Cross,

    /// Generate markdown documentation for configuration options.
    Docs,

    /// Inspect audio file metadata in a directory.
    #[options(InspectArg)]
    Inspect,

    /// Add FLAC sources to the queue without transcoding
    #[command(subcommand_required = true, arg_required_else_help = true)]
    Queue(QueueCommand),

    /// Generate spectrograms for each track of a FLAC source.
    #[options(
        SourceArg,
        ConfigOptions,
        SharedOptions,
        SpectrogramOptions,
        SoxOptions,
        RunnerOptions
    )]
    Spectrogram,

    /// Transcode each track of a FLAC source to the target formats.
    #[options(
        SourceArg,
        ConfigOptions,
        SharedOptions,
        TargetOptions,
        SoxOptions,
        CopyOptions,
        FileOptions,
        RunnerOptions
    )]
    Transcode,

    /// Upload transcodes of a FLAC source.
    ///
    /// `FileOptions` is not listed despite `TranscodeJobFactory` depending on
    /// `PathManager` which injects it. Upload only uses `TranscodeJobFactory`
    /// to generate command strings for the description, where the output paths
    /// are overridden with placeholders (`output.{ext}`), so `rename_tracks`
    /// has no effect.
    #[options(
        SourceArg,
        ConfigOptions,
        SharedOptions,
        TargetOptions,
        UploadOptions,
        QbitOptions,
        QbitUploadOptions,
        CopyOptions
    )]
    Upload,

    /// Verify a FLAC source is suitable for transcoding.
    #[options(
        SourceArg,
        ConfigOptions,
        SharedOptions,
        CacheOptions,
        TargetOptions,
        VerifyOptions,
        ReportOptions
    )]
    Verify,

    /// Display version information for caesura and dependencies.
    #[command(short_flag = 'V', long_flag = "version")]
    #[options(SoxOptions)]
    Version,
}

/// Sub-commands for the `queue` command group.
#[derive(CommandEnum, Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[command_enum(parent = "queue")]
pub enum QueueCommand {
    /// Add a directory of `.torrent` files to the queue
    #[options(ConfigOptions, SharedOptions, CacheOptions, QueueAddArgs)]
    Add,

    /// Discover torrents via the qBittorrent API and add them to the queue.
    #[options(
        ConfigOptions,
        SharedOptions,
        CacheOptions,
        QbitOptions,
        QueueFetchOptions
    )]
    Fetch,

    /// List the sources in the queue
    #[options(ConfigOptions, SharedOptions, CacheOptions, BatchOptions)]
    List,

    /// Remove an item from the queue
    #[cli_name = "rm"]
    #[options(QueueRemoveArgs, ConfigOptions, SharedOptions, CacheOptions)]
    Remove,

    /// Summarize the sources in the queue
    #[options(ConfigOptions, SharedOptions, CacheOptions)]
    Summary,
}