meta

type BasicCastMember struct {
	Name_  string      `json:"name"`
	Role_  string      `json:"role"`
	Image_ *BasicImage `json:"image"`
}

type BasicEpisodeMetadata struct {
	*BasicMetadata

	Series_  *BasicMovieOrSeriesMetadata `json:"series"`
	Season_  int                         `json:"season"`
	Episode_ int                         `json:"episode"`
}

type BasicImage struct {
	Type_        ImageType `json:"type"`
	Path_        string    `json:"path"`
	Remote_      bool      `json:"remote"`
	Description_ string    `json:"description"`
}

type BasicMetadata struct {
	Type_          Type          `json:"type"`
	Title_         string        `json:"title"`
	OriginalTitle_ string        `json:"original_title"`
	Overview_      string        `json:"overview"`
	ReleaseDate_   time.Time     `json:"release_date"`
	VoteRating_    float32       `json:"vote_rating"`
	Images_        []*BasicImage `json:"images"`
}

type BasicMovieOrSeriesMetadata struct {
	*BasicMetadata

	Genres_    []string           `json:"genres"`
	Cast_      []*BasicCastMember `json:"cast"`
	Languages_ []string           `json:"languages"`
	Countries_ []string           `json:"countries"`
}

type CastMember interface {
	// Name returns the real name of the cast member.
	Name() string
	// Role returns the name of the cast character.
	Role() string
	// Image returns the image of the cast member.
	Image() Image
}

type EpisodeMetadata interface {
	Metadata

	// Series returns the underlying series' metadata.
	Series() MovieOrSeriesMetadata
	// Season returns the season number, such as 1.
	Season() int
	// Episode returns the episode number, such as 1.
	Episode() int
}

type ErrInvalidQuery struct {
	// Query is the string query.
	Query string
	// Type is the targeted metadata type.
	Type Type
}

type Image interface {
	// Type returns the image's type.
	Type() ImageType
	// Path returns the image's path.
	Path() string
	// Remote returns whether Path returns a remote URL.
	Remote() bool
	// Description returns the image's description.
	Description() string
}

type ImageType uint

type Metadata interface {
	// Type returns the type of metadata.
	Type() Type
	// Title returns the title, such as "Bocchi the Rock!".
	Title() string
	// OriginalTitle returns the title as in the original release, such as "ぼっち・ざ・ろっく！".
	OriginalTitle() string
	// Overview returns the plot overview, such as "Hitori Gotoh, a shy, awkward, and lonely high school student dreams of being in a band despite her doubts and worries, but when she is recruited to be the guitarist of a group looking to make it big, she realises her dream may be able to be fulfilled and come true.".
	Overview() string
	// ReleaseDate returns the date of release, such as "2022-10-09".
	ReleaseDate() time.Time
	// VoteRating returns the average rating of the media, between 0 and 10, such as 8.7.
	VoteRating() float32
	// Images returns the promotional images of the media.
	Images() []Image
}

type MovieOrSeriesMetadata interface {
	Metadata

	// Genres returns the genre names.
	Genres() []string
	// Cast returns the cast members.
	Cast() []CastMember
	// Languages returns tags of the languages spoken in the movie or series.
	Languages() []language.Tag
	// Countries returns tags of the regions that took part in producing the movie or series.
	Countries() []language.Region
}

type Query struct {
	// Query is the string used for searching the movie or series.
	Query string `json:"query"`
	// Type is the type of metadata to search for, 0 (TypeUnknown) searches for all media.
	Type Type `json:"type"`
	// Season is the season number, 0 means don't search for a specific episode.
	Season int `json:"season"`
	// Episode is the episode number in the season, 0 means don't search for a specific episode.
	Episode int `json:"episode"`
}

type Source interface {
	// FromFile tries to resolve metadata for a media file, may return nil.
	FromFile(path string) (Metadata, error)
	// FromQuery tries to resolve metadata for a custom query, may return nil.
	FromQuery(query *Query) (Metadata, error)
}

type Type uint