org.tinymediamanager.core.MediaSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tinyMediaManager Show documentation
The newest version!
/*
 * Copyright 2012 - 2019 Manuel Laggner
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.tinymediamanager.core;

import java.util.Arrays;
import java.util.Comparator;
import java.util.Locale;
import java.util.regex.Pattern;

import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.StringUtils;
import org.tinymediamanager.scraper.DynaEnum;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * The enum MovieMediaSource - to represent all possible media sources for movies
 * 
 * @author Manuel Laggner
 */
public class MediaSource extends DynaEnum {
  private final static Comparator COMPARATOR  = new MediaSourceComparator();

  // the well known and XBMC/Kodi compatible sources
  // tokens taken from http://en.wikipedia.org/wiki/Pirated_movie_release_types
  public final static MediaSource              UHD_BLURAY  = new MediaSource("UHD_BLURAY", 0, "UHD Blu-ray",
      "(uhd|ultrahd)[ .\\-]?(bluray|blueray|bdrip|brrip|dbrip|bd25|bd50|bdmv|blu\\-ray)");
  public final static MediaSource              BLURAY      = new MediaSource("BLURAY", 2, "Blu-ray",
      "(bluray|blueray|bdrip|brrip|dbrip|bd25|bd50|bdmv|blu\\-ray)");
  public final static MediaSource              DVD         = new MediaSource("DVD", 4, "DVD", "(dvd|video_ts|dvdrip|dvdr)");
  public final static MediaSource              HDDVD       = new MediaSource("HDDVD", 6, "HDDVD", "(hddvd|hddvdrip)");
  public final static MediaSource              TV          = new MediaSource("TV", 8, "TV", "(hdtv|pdtv|dsr|dtb|dtt|dttv|dtv|hdtvrip|tvrip|dvbrip)");
  public final static MediaSource              VHS         = new MediaSource("VHS", 10, "VHS", "(vhs)");
  public final static MediaSource              LASERDISC   = new MediaSource("LASERDISC", 12, "LaserDisc", "(laserdisc|ldrip)");
  public final static MediaSource              D_VHS       = new MediaSource("D_VHS", 14, "D-VHS");

  // other sources
  public final static MediaSource              HDRIP       = new MediaSource("HDRIP", 5, "HDRip", "(hdrip)");
  public final static MediaSource              CAM         = new MediaSource("CAM", 6, "Cam", "(cam)");
  public final static MediaSource              TS          = new MediaSource("TS", 7, "Telesync", "(ts|telesync|hdts|ht\\-ts)");
  public final static MediaSource              TC          = new MediaSource("TC", 8, "Telecine", "(tc|telecine|hdtc|ht\\-tc)");
  public final static MediaSource              DVDSCR      = new MediaSource("DVDSCR", 9, "DVD Screener", "(dvdscr)");
  public final static MediaSource              R5          = new MediaSource("R5", 10, "R5", "(r5)");
  public final static MediaSource              WEBRIP      = new MediaSource("WEBRIP", 11, "Webrip", "(webrip)");
  public final static MediaSource              WEB_DL      = new MediaSource("WEB_DL", 12, "Web-DL", "(web-dl|webdl)");
  public final static MediaSource              STREAM      = new MediaSource("STREAM", 13, "Stream");

  // and our fallback
  public final static MediaSource              UNKNOWN     = new MediaSource("UNKNOWN", 14, "");

  private static final String                  START_TOKEN = "[ _\\,\\.\\(\\)\\[\\]\\-]";
  private static final String                  END_TOKEN   = "([ _\\,\\.\\(\\)\\[\\]\\-]|$)";

  private final String                         title;
  private final Pattern                        pattern;

  private MediaSource(String enumName, int ordinal, String title) {
    this(enumName, ordinal, title, "");
  }

  private MediaSource(String enumName, int ordinal, String title, String pattern) {
    super(enumName, ordinal);
    this.title = title;
    if (StringUtils.isNotBlank(pattern)) {
      this.pattern = Pattern.compile(START_TOKEN + pattern + END_TOKEN, Pattern.CASE_INSENSITIVE);
    }
    else {
      this.pattern = null;
    }

    addElement();
  }

  @Override
  public String toString() {
    return title;
  }

  @JsonValue
  public String getName() {
    return name();
  }

  /**
   * get all media sources
   *
   * @return an array of all media sources
   */
  public static MediaSource[] values() {
    MediaSource[] mediaSources = values(MediaSource.class);
    Arrays.sort(mediaSources, COMPARATOR);
    return mediaSources;
  }

  /**
   * Gets the right media source for the given string.
   *
   * @param name
   *          the name
   * @return the media source
   */
  @JsonCreator
  public static MediaSource getMediaSource(String name) {
    for (MediaSource mediaSource : values()) {
      // check if the "enum" name matches
      if (mediaSource.name().equals(name)) {
        return mediaSource;
      }
      // check if the printable name matches
      if (mediaSource.title.equalsIgnoreCase(name)) {
        return mediaSource;
      }
    }

    // dynamically create new one
    return new MediaSource(name, values().length, name, "");
  }

  /**
   * returns the MediaSource if found in file name
   * 
   * @param filename
   *          the filename
   * @return the matching MediaSource or UNKNOWN
   */
  public static MediaSource parseMediaSource(String filename) {
    String fn = filename.toLowerCase(Locale.ROOT);
    String ext = FilenameUtils.getExtension(fn);

    // make sure we try UHD_BLURAY first, since there could be false positives with BLURAY regexp
    if (UHD_BLURAY.pattern.matcher(filename).find()) {
      return UHD_BLURAY;
    }

    for (MediaSource mediaSource : MediaSource.values()) {
      if (mediaSource.pattern != null && mediaSource.pattern.matcher(filename).find()) {
        return mediaSource;
      }
    }

    if (ext.equals("strm")) {
      return STREAM;
    }

    return UNKNOWN;
  }

  /**
   * add a new DynaEnumEventListener. This listener will be informed if any new value has been added
   *
   * @param listener
   *          the new listener to be added
   */
  public static void addListener(DynaEnumEventListener listener) {
    addListener(MediaSource.class, listener);
  }

  /**
   * remove the given DynaEnumEventListener
   *
   * @param listener
   *          the listener to be removed
   */
  public static void removeListener(DynaEnumEventListener listener) {
    removeListener(MediaSource.class, listener);
  }

  /**
   * Comparator for sorting our MediaSource in a localized fashion
   */
  private static class MediaSourceComparator implements Comparator {
    @Override
    public int compare(MediaSource o1, MediaSource o2) {
      // toString is localized name
      if (o1.toString() == null && o2.toString() == null) {
        return 0;
      }
      if (o1.toString() == null) {
        return 1;
      }
      if (o2.toString() == null) {
        return -1;
      }
      return o1.toString().compareTo(o2.toString());
    }
  }
}