TV_IMDB(1)

πŸ“¦ version 1.4.0, in alpine 3.24

πŸŽ€ TV_IMDB(1) β€” tv_imdb πŸŽ€

okay so this is the User Contributed Perl Documentation page for TV_IMDB(1), aka tv_imdb, and it's here to make your XMLTV listings file glow up with imdb.com data. bestie, let's go. πŸ’…βœ¨

🌸 NAME 🌸

tv_imdb β€” Augment XMLTV listings files with imdb.com data.

πŸ¦‹ SYNOPSIS πŸ¦‹

tv_imdb --imdbdir <dir> [--help] [--quiet] [--download]
       [--movies-only] [--filesort] [--nosystemsort]
       [--prepStage (1-9,all)]

tv_imdb --imdbdir <dir> [--help] [--quiet]
       [--with-keywords] [--with-plot]
       [--movies-only] [--actors NUMBER]
       [--stats] [--debug]
       [--output FILE] [FILE...]

tv_imdb --imdbdir <dir>
        --validate-title 'movie title'
        --validate-year 2004
        [--with-keywords] [--with-plot]
        [--debug]

πŸ’– DESCRIPTION πŸ’–

okay so picture tv_cat but make it makeover era: tv_imdb is very similar to tv_cat in semantics (see tv_cat), except whenever a programme appears with "date" entry the title and date are used to look up extra data using XMLTV::IMDB. iconic.

  • --output FILE β€” write to FILE rather than standard output.
  • --with-keywords β€” include IMDb keywords in the output file.
  • --with-plot β€” include IMDb plot summary in the output file.
  • --actors NUMBER β€” number of actors from IMDb to add (default=3).
  • --quiet β€” disable all status messages (that normally appear on stderr).
  • --download β€” try to download data files if they are missing (in --prepStage).
  • --stats β€” output grab stats (stats output disabled in --quiet mode).
  • --debug β€” output info from movie matching.
  • --movies-only β€” only augment programs that look like movie listings (4 digit 'date' field).

Also, yes: --imdbdir <dir> is the database directory from the synopsis, and --help is the help flag the prep-stage note tells you to check. The synopsis and HOWTO also carry --prepStage (1-9,all), --filesort, and --nosystemsort β€” those sorting/prep details live in the HOWTO note below.

All programs are checked against imdb.com data (unless --movies-only is used).

For the purposes of tv_imdb, an "exact" match is defined as a case insensitive match against imdb.com data (which may or may not include the transformation of '&' to 'and' and vice-versa).

If the program includes a 4 digit 'date' field the following matches are attempted, with the first successful match being used:

  1. an "exact" title/year match against movie titles is done
  2. an "exact" title match against tv series (and tv mini series)
  3. an "exact" title match against movie titles with production dates within 2 years of the 'date' value.

Unless --movies-only is used, if the program does not include a 4 digit 'date' field the following matches are attempted, the first succeeding match is used:

  1. an "exact" title match against tv series (and tv mini series)

When a match is found in the imdb.com data the following is applied:

  1. the 'title' field is set to match exactly the title from the imdb.com data. This includes modification of the case to match and any transformations mentioned above.
  2. if the match is a movie, the 'date' field is set to imdb.com 4 digit year of production.
  3. the type of match found (Movie, TV Movie, Video Movie, TV Series, or TV Mini Series) is placed in the 'categories' field.
  4. the url to the www.imdb.com page is added
  5. the director is added if the match was a movie or if only one director is listed in the imdb.com data (because some tv series have > 30 directors)
  6. the top 3 billing actors are added (use -actors [num] to adjust).
  7. genres added to 'categories' field (current list of genres are Short, Drama, Comedy, Documentary, Animation, Adult, Action, Family, Romance, Crime, Thriller, Musical, Adventure, Western, Horror, Sci-Fi, Fantasy, Mystery, War, Film-Noir, Music)
  8. imdb user ratings added to 'star-ratings' field.
  9. imdb keywords added to 'keyword' fields (if --with-keywords used).
  10. imdb plot summary is added (if --with-plot used).

🧚 HOWTO 🧚

In order to use tv_imdb, you need:

  1. choose a directory location to use for the tv_imdb database (you'll need about 1 GB of free space), 2a. run tv_imdb --imdbdir <dir> --prepStage all --download to download the list files from imdb.com. Or, 2b. If you have a slow network connection you may prefer to omit the --download flag and be prompted for what you need to download by hand. See http://www.imdb.com/interfaces for the download sites. Then once you have the files rerun without --download.
  2. Once you have the database loaded try cat tv.xml | tv_imdb --imdbdir <dir> > tv1.xml.
Note: --prepStage requires up to 520MB of memory. This can be reduced a little by running each prepStage separately, using --prepStage with each of the stages individually (see --help for details). Memory use can be reduced further by using --filesort option when building the database. This will try to use the operating system to sort the interim data files rather than sorting in memory. If this system sort does not work for you then you can use the File::Sort package if it is installed on your system, by also adding the option --nosystemsort (however this method of sorting is very slow). If you specify neither option then Perl will sort the files in memory.

If you are only interested in movies, you can reduce the memory required and the size of the database by passing the --movies-only option to the database build, which will exclude tv-series from the database.

Feel free to report any problems with these steps at https://github.com/XMLTV/xmltv/issues.

πŸ§ͺ TESTING πŸ§ͺ

The --validate-title and --validate-year flags can be used to validate the information in the tv_imdb database. For example:

tv_imdb --imdbdir . --validate-title 'Army of Darkness' --validate-year 1994

πŸ’€ BUGS πŸ’€

Could use a --configure step just like the grabbers so you do not have to specify the --imdbdir on the command line every time. Also this could step you through the prep stages with more description of what is being done and what is required. Configure could also control the number of actors to add (since some movies have an awful lot), currently we are adding the top 3.

How and what to look up needs to be option driven.

Needs some more controls for fine tuning "close" matches. For instance, currently it looks like the North America grabber only has date entries for movies, but the imdb.com data contains made for video movies as well as real movies, so it's possible to get the wrong data to be inserted. In this case we may want to say "ignore tv series" and "ignore tv mini series". Along with this, we'd want to define what a "close" match is. For instance does a movie by the same title with a date out by 1 year or 2 years considered a match (currently we're using 2).

Nice to haves include: verification/addition of programme MPAA/VCHIP ratings, addition of imdb.com user ratings (by votes) to programmes. Potentially we could expand to include "country of origin", "description", "writer" and "producer" credits, maybe even "commentator".

Heh, if the XMLTV.dtd supported it, we could even include urls to head shots of the actors :)

πŸ‘€ SEE ALSO πŸ‘€

xmltv(5)

πŸ’Œ AUTHOR πŸ’Œ

Jerry Veldhuis, jerry@matilda.com


🫢 cute sign-off: this page is from perl v5.42.2, dated 2025-06-30, manual tag TV_IMDB(1). byeeee πŸ’–βœ¨
πŸ“¦ where this page comes from