Overview

The NfoMovieMetadataExtractor extracts metadata from

nfo-files

for movies. It is one of currently two NfoMetadataExtractors. This wiki page describes particularities of the NfoMovieMetadataExtractor. General information applicable to all NfoMetadataExtractors can be found here.

Properties

MetadataExtractorPriority.Extended

true

Movie

MediaAspect

VideoAspect

MovieAspect

ThumbnailLargeAspect

Note: The

metadataExtractorPriority

is intentionally (and incorrectly) set to

Extended

although, depending on the content of the

nfo-file

, it may download thumbs from the internet (and should therefore be

External

. This is a temporary workaround for performance purposes. It ensures that this MetadataExtractor is applied before the VideoThumbnailer (which is intentionally and incorrectly set to

External

although it only uses local files). Creating thumbs with the VideoThumbnailer takes longer than downloading them from the internet.

Settings

Besides the general settings available for all NfoMetadataExtractors, the NfoMovieMetadataExtractor has the following settings:

movie

Resource

NfoFileNameExtensions

nfo-file

Resource

The settings file name for the NfoMovieMetadataExtractor is

MediaPortal.Extensions.MetadataExtractors.NfoMetadataExtractors.Settings.NfoMovieMetadataExtractorSettings.xml

Requirements

Besides the general requirements applicable to all NfoMetadataExtractors the NfoMovieMetadataExtractor has the following requirements to be able to extract metadata:

Other MetadataExtractors

The NfoMovieMetadataExtractor can only extract metadata for video

Resources

. It will therefore only try to extract metadata if any MetadataExtractor applied before the NfoMovieMetadataExtractor (i.e. having

MetadataExtractorPriority.Core

) has recognized the

Resource

as a video and added a

VideoAspect

. This is typically done by the VideoMetadataExtractor. If no

VideoAspect

is present when the NfoMovieMetadataExtractor is called, the NfoMovieMetadataExtractor will do noting.

Directory and File Name Structure

The NfoMovieMetadataExtractor tries to find exactly one

nfo-file

for every

Resource

, the

matching nfo-file

. To be identified as the

matching nfo-file

, it needs to be located at a specific path relative to the

Resource

and its file name needs to follow a certain pattern.

To be identified as

matching nfo-file

for a movie

Resource

, the

nfo-file

needs to be located in the

parent directory

of the

Resource

.

• If the

  Resource

  is a file, the

  parent directory

  is the directory in which the file is located.

  Nfo-files

  for movie files must therefore be located in the same directory as the movie file.

• If the

  Resource

  is the root directory of a

  ChainedResourceProvider

  (such as in case of a DVD iso file), the

  parent directory

  is the directory in which the file that was unfolded by the

  ChainedResourceProvider

  is located.

  Nfo-files

  e.g. for movie iso files must therefore be located in the same directory as the movie iso file.

• If the

  Resource

  is a directory (such as in case of a directory, to which the content of a DVD was copied), the

  parent directory

  is the directory containing that

  Resource

  directory.

The file name of the

matching nfo-file

must be

• either the

  ResourceName

  ;

  • If the

    Resource

    is a file, the

    ResourceName

    is the file name of the

    Resource

    (without file name extension).

  • If the

    Resource

    is the root directory of a

    ChainedResourceProvider

    (such as in case of a DVD iso file), the

    ResourceName

    is the file name of the file that was unfolded by the

    ChainedResourceProvider

    (without file name extension).

  • If the

    Resource

    is a directory (such as in case of a directory, to which the content of a DVD was copied), the

    ResourceName

    is the name of that directory.

• or any of the values of the

  MovieNfoFiles

  settings.

Obviously, for the NfoMetadataExtractor to be able to work correctly, in the second case multiple movie

Resources

each need to be contained in their own directory, whereas in the first case multiple movie

Resources

can be located in the same directory.

The file name extension of the

matching nfo-file

must be any of the values contained in the

NfoFileNameExtensions

settings.

Example:

Assuming you have default settings and the

Resource

is:

D:\Movies\Falling Down.mkv

In this case, the NfoMovieMetadataExtractor would look for the following files to identify a

matching nfo-file

:

D:\Movies\Falling Down.nfo

D:\Movies\Falling Down.xml

D:\Movies\Falling Down.txt

D:\Movies\movie.nfo

D:\Movies\movie.xml

D:\Movies\movie.txt

The file names (and file name extensions) are not case sensitive.

Content of the Nfo-File

The

RootElementName

required for the NfoMovieMetadataExtractor is

movie

. for details on the

RootElementName

please see the general section on the content of

nfo-files

.

The NfoMovieMetadataExtractor has (in the NfoMovieReader class) a separate TryReadXyz method for every child element it can read, where Xyz is the child element name (despite the casing which in the

nfo-file

is always lower case). At the beginning of each TryReadXyz method in the source code there is a comment showing an example on how the content of this child element must be structured so that the NfoMovieMetadataExtractor can understand it.

Imported Attributes:

The following table contains the applied mapping of XML elements to

Attributes

in various

MediaItemAspects

.

If there are multiple XML elements in the "Imported XML Element" column separated by [priority 1], [priority 2], etc., then the value(s) of the XML element(s) under [priority 2] is/are only taken if there is no XML elemet present in the

nfo-file

that is listed under [piority 1] or there is no valid value for the XML element under [priority 1], etc.

If there are multiple XML elements in the "Imported XML Element" column not separated by [piority x] the behavior depends on whether or not the MediaLibrary can store multiple values for the respective

Attribute

. If so, all vaues are taken. If not, a random one is taken, unless specified otherwise in the table below.

Currenty, if a valid value was found for an XML element listed in the "Imported XML Element" column, any value that was stored in the respective

Attribute

by a MetadataExtractor applied before the NfoMovieMetadataExtractor is overwritten. If no valid value was found or there is no XML Element listed in the "Imported XML Element" column, the

Attribute

is not touched.