cinekey 0.4.1

Fast parser for movie and TV release names
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

use crate::{AudioProfile, Edition, EnumSet, ReleaseFlag, StreamingService};
use serde::{Deserialize, Serialize};

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
/// An optional movie or series hint supplied by the caller.
pub enum ExpectedKind {
    Movie,
    Series,
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
/// The structural interpretation of a media name.
pub enum MediaKind {
    Movie,
    Episode,
    SeasonPack,
    Extra,
    Unknown,
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
/// The numbering system used by a parsed episode.
pub enum EpisodeNumbering {
    SeasonEpisode,
    Absolute,
    SeasonUnspecified,
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ExtraCategory {
    Opening,
    Ending,
    PromotionalVideo,
    Commercial,
    Menu,
    TelevisionSpecial,
    Interview,
    Commentary,
    Chronicle,
    Lecture,
    Event,
    Trailer,
    Preview,
    MakingOf,
    Music,
    Logo,
    MiniAnime,
    Prelude,
    Other,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExtraInfo {
    pub category: ExtraCategory,
    pub number: Option<u16>,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
/// Identification and technical metadata parsed from one media name.
pub struct ParsedMedia {
    pub kind: MediaKind,
    pub title: Option<String>,
    /// Parenthesized names and qualifiers accompanying the primary title.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub title_annotations: Vec<String>,
    pub year: Option<u16>,
    #[serde(default, skip_serializing_if = "EnumSet::is_empty")]
    pub edition: EnumSet<Edition>,
    pub season: Option<u16>,
    pub episodes: Vec<u16>,
    pub absolute_episodes: Vec<u16>,
    pub episode_numbering: Option<EpisodeNumbering>,
    pub episode_title: Option<String>,
    pub extra: Option<ExtraInfo>,
    pub resolution: Option<String>,
    pub source: Option<String>,
    pub streaming_service: Option<StreamingService>,
    pub video_codec: Option<String>,
    /// Whether release-name markers indicate that the publisher transcoded the video.
    /// `None` represents insufficient or conflicting evidence.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub video_transcoded: Option<bool>,
    pub dynamic_range: Vec<String>,
    pub audio_codec: Vec<String>,
    #[serde(default, skip_serializing_if = "EnumSet::is_empty")]
    pub audio_profile: EnumSet<AudioProfile>,
    pub audio_channels: Option<String>,
    #[serde(default, skip_serializing_if = "EnumSet::is_empty")]
    pub release_flags: EnumSet<ReleaseFlag>,
    pub release_group: Option<String>,
}

#[derive(Clone, Debug, Default)]
/// Hints and ancestors belonging to the input's own directory path.
pub struct ParseContext<'a> {
    pub expected_kind: Option<ExpectedKind>,
    /// Ancestor directory names, ordered nearest first.
    pub ancestors: Vec<&'a str>,
}