io.lindstrom.mpd.data.MPD Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mpd-parser Show documentation
DASH MPD parser
There is a newer version: 0.13
package io.lindstrom.mpd.data;

import com.fasterxml.jackson.annotation.JsonIgnore;
import io.lindstrom.mpd.data.descriptor.Descriptor;
import io.lindstrom.mpd.support.Utils;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.time.Duration;
import java.time.OffsetDateTime;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

@XmlType(propOrder = {
    "programInformations",
    "baseURLs",
    "locations",
    "periods",
    "metrics",
    "essentialProperties",
    "supplementalProperties",
    "utcTimings"
})
@XmlRootElement(name = "MPD", namespace = io.lindstrom.mpd.data.MPD.NAMESPACE)
public class MPD {
    static final String NAMESPACE = "urn:mpeg:dash:schema:mpd:2011";

    @XmlElement(name = "ProgramInformation", namespace = NAMESPACE)
    private final List programInformations;

    @XmlElement(name = "BaseURL", namespace = NAMESPACE)
    private final List baseURLs;

    @XmlElement(name = "Location", namespace = NAMESPACE)
    private final List locations;

    @XmlElement(name = "Period", required = true, namespace = NAMESPACE)
    private final List periods;

    @XmlElement(name = "Metrics", namespace = NAMESPACE)
    private final List metrics;

    @XmlElement(name = "EssentialProperty", namespace = NAMESPACE)
    private final List essentialProperties;

    @XmlElement(name = "SupplementalProperty", namespace = NAMESPACE)
    private final List supplementalProperties;

    @XmlElement(name = "UTCTiming", namespace = NAMESPACE)
    private final List utcTimings;

    @XmlAttribute(name = "id")
    private final String id;

    @XmlAttribute(name = "profiles", required = true)
    private final Profiles profiles;

    @XmlAttribute(name = "type")
    private final PresentationType type;

    @XmlAttribute(name = "availabilityStartTime")
    private final OffsetDateTime availabilityStartTime;

    @XmlAttribute(name = "availabilityEndTime")
    private final OffsetDateTime availabilityEndTime;

    @XmlAttribute(name = "publishTime")
    private final OffsetDateTime publishTime;

    @XmlAttribute(name = "mediaPresentationDuration")
    private final Duration mediaPresentationDuration;

    @XmlAttribute(name = "minimumUpdatePeriod")
    private final Duration minimumUpdatePeriod;

    @XmlAttribute(name = "minBufferTime", required = true)
    private final Duration minBufferTime;

    @XmlAttribute(name = "timeShiftBufferDepth")
    private final Duration timeShiftBufferDepth;

    @XmlAttribute(name = "suggestedPresentationDelay")
    private final Duration suggestedPresentationDelay;

    @XmlAttribute(name = "maxSegmentDuration")
    private final Duration maxSegmentDuration;

    @XmlAttribute(name = "maxSubsegmentDuration")
    private final Duration maxSubsegmentDuration;

    @XmlAttribute(namespace = "http://www.w3.org/2001/XMLSchema-instance")
    private final String schemaLocation;

    private MPD(List programInformations, List baseURLs, List locations, List periods, List metrics, List essentialProperties, List supplementalProperties, List utcTimings, String id, Profiles profiles, PresentationType type, OffsetDateTime availabilityStartTime, OffsetDateTime availabilityEndTime, OffsetDateTime publishTime, Duration mediaPresentationDuration, Duration minimumUpdatePeriod, Duration minBufferTime, Duration timeShiftBufferDepth, Duration suggestedPresentationDelay, Duration maxSegmentDuration, Duration maxSubsegmentDuration, String schemaLocation) {
        this.programInformations = programInformations;
        this.baseURLs = baseURLs;
        this.locations = locations;
        this.periods = periods;
        this.metrics = metrics;
        this.essentialProperties = essentialProperties;
        this.supplementalProperties = supplementalProperties;
        this.utcTimings = utcTimings;
        this.id = id;
        this.profiles = profiles;
        this.type = type;
        this.availabilityStartTime = availabilityStartTime;
        this.availabilityEndTime = availabilityEndTime;
        this.publishTime = publishTime;
        this.mediaPresentationDuration = mediaPresentationDuration;
        this.minimumUpdatePeriod = minimumUpdatePeriod;
        this.minBufferTime = minBufferTime;
        this.timeShiftBufferDepth = timeShiftBufferDepth;
        this.suggestedPresentationDelay = suggestedPresentationDelay;
        this.maxSegmentDuration = maxSegmentDuration;
        this.maxSubsegmentDuration = maxSubsegmentDuration;
        this.schemaLocation = schemaLocation;
    }

    @SuppressWarnings("unused")
    private MPD() {
        this.programInformations = null;
        this.baseURLs = null;
        this.locations = null;
        this.periods = null;
        this.metrics = null;
        this.essentialProperties = null;
        this.supplementalProperties = null;
        this.utcTimings = null;
        this.id = null;
        this.profiles = null;
        this.type = null;
        this.availabilityStartTime = null;
        this.availabilityEndTime = null;
        this.publishTime = null;
        this.mediaPresentationDuration = null;
        this.minimumUpdatePeriod = null;
        this.minBufferTime = null;
        this.timeShiftBufferDepth = null;
        this.suggestedPresentationDelay = null;
        this.maxSegmentDuration = null;
        this.maxSubsegmentDuration = null;
        this.schemaLocation = null;
    }

    public List getProgramInformations() {
        return Utils.unmodifiableList(programInformations);
    }

    public List getBaseURLs() {
        return Utils.unmodifiableList(baseURLs);
    }

    public List getLocations() {
        return Utils.unmodifiableList(locations);
    }

    public List getPeriods() {
        return Utils.unmodifiableList(periods);
    }

    public List getMetrics() {
        return Utils.unmodifiableList(metrics);
    }

    public List getEssentialProperties() {
        return Utils.unmodifiableList(essentialProperties);
    }

    public List getSupplementalProperties() {
        return Utils.unmodifiableList(supplementalProperties);
    }

    public List getUtcTimings() {
        return Utils.unmodifiableList(utcTimings);
    }

    public String getId() {
        return id;
    }

    @JsonIgnore
    public List getProfiles() {
        if (profiles == null) {
            return Collections.emptyList();
        } else {
            return profiles.getProfiles();
        }
    }

    @JsonIgnore
    public List getInteroperabilityPointsAndExtensions() {
        if (profiles == null) {
            return Collections.emptyList();
        } else {
            return profiles.getInteroperabilityPointsAndExtensions();
        }
    }

    public PresentationType getType() {
        return type;
    }

    public OffsetDateTime getAvailabilityStartTime() {
        return availabilityStartTime;
    }

    public OffsetDateTime getAvailabilityEndTime() {
        return availabilityEndTime;
    }

    public OffsetDateTime getPublishTime() {
        return publishTime;
    }

    public Duration getMediaPresentationDuration() {
        return mediaPresentationDuration;
    }

    public Duration getMinimumUpdatePeriod() {
        return minimumUpdatePeriod;
    }

    public Duration getMinBufferTime() {
        return minBufferTime;
    }

    public Duration getTimeShiftBufferDepth() {
        return timeShiftBufferDepth;
    }

    public Duration getSuggestedPresentationDelay() {
        return suggestedPresentationDelay;
    }

    public Duration getMaxSegmentDuration() {
        return maxSegmentDuration;
    }

    public Duration getMaxSubsegmentDuration() {
        return maxSubsegmentDuration;
    }

    public String getSchemaLocation() {
        return schemaLocation;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        MPD mpd = (MPD) o;
        return Objects.equals(programInformations, mpd.programInformations) &&
                Objects.equals(baseURLs, mpd.baseURLs) &&
                Objects.equals(locations, mpd.locations) &&
                Objects.equals(periods, mpd.periods) &&
                Objects.equals(metrics, mpd.metrics) &&
                Objects.equals(essentialProperties, mpd.essentialProperties) &&
                Objects.equals(supplementalProperties, mpd.supplementalProperties) &&
                Objects.equals(utcTimings, mpd.utcTimings) &&
                Objects.equals(id, mpd.id) &&
                Objects.equals(profiles, mpd.profiles) &&
                type == mpd.type &&
                Objects.equals(availabilityStartTime, mpd.availabilityStartTime) &&
                Objects.equals(availabilityEndTime, mpd.availabilityEndTime) &&
                Objects.equals(publishTime, mpd.publishTime) &&
                Objects.equals(mediaPresentationDuration, mpd.mediaPresentationDuration) &&
                Objects.equals(minimumUpdatePeriod, mpd.minimumUpdatePeriod) &&
                Objects.equals(minBufferTime, mpd.minBufferTime) &&
                Objects.equals(timeShiftBufferDepth, mpd.timeShiftBufferDepth) &&
                Objects.equals(suggestedPresentationDelay, mpd.suggestedPresentationDelay) &&
                Objects.equals(maxSegmentDuration, mpd.maxSegmentDuration) &&
                Objects.equals(maxSubsegmentDuration, mpd.maxSubsegmentDuration) &&
                Objects.equals(schemaLocation, mpd.schemaLocation);
    }

    @Override
    public int hashCode() {
        return Objects.hash(programInformations, baseURLs, locations, periods, metrics, essentialProperties, supplementalProperties, utcTimings, id, profiles, type, availabilityStartTime, availabilityEndTime, publishTime, mediaPresentationDuration, minimumUpdatePeriod, minBufferTime, timeShiftBufferDepth, suggestedPresentationDelay, maxSegmentDuration, maxSubsegmentDuration, schemaLocation);
    }

    @Override
    public String toString() {
        return "MPD{" +
                "programInformations=" + programInformations +
                ", baseURLs=" + baseURLs +
                ", locations=" + locations +
                ", periods=" + periods +
                ", metrics=" + metrics +
                ", essentialProperties=" + essentialProperties +
                ", supplementalProperties=" + supplementalProperties +
                ", utcTimings=" + utcTimings +
                ", id='" + id + '\'' +
                ", profiles='" + profiles + '\'' +
                ", type=" + type +
                ", availabilityStartTime=" + availabilityStartTime +
                ", availabilityEndTime=" + availabilityEndTime +
                ", publishTime=" + publishTime +
                ", mediaPresentationDuration=" + mediaPresentationDuration +
                ", minimumUpdatePeriod=" + minimumUpdatePeriod +
                ", minBufferTime=" + minBufferTime +
                ", timeShiftBufferDepth=" + timeShiftBufferDepth +
                ", suggestedPresentationDelay=" + suggestedPresentationDelay +
                ", maxSegmentDuration=" + maxSegmentDuration +
                ", maxSubsegmentDuration=" + maxSubsegmentDuration +
                ", schemaLocation='" + schemaLocation + '\'' +
                '}';
    }

    public Builder buildUpon() {
        return new Builder()
                .withProgramInformations(programInformations)
                .withBaseURLs(baseURLs)
                .withLocations(locations)
                .withPeriods(periods)
                .withMetrics(metrics)
                .withEssentialProperties(essentialProperties)
                .withSupplementalProperties(supplementalProperties)
                .withUtcTimings(utcTimings)
                .withId(id)
                .withProfiles(profiles)
                .withType(type)
                .withAvailabilityStartTime(availabilityStartTime)
                .withAvailabilityEndTime(availabilityEndTime)
                .withPublishTime(publishTime)
                .withMediaPresentationDuration(mediaPresentationDuration)
                .withMinimumUpdatePeriod(minimumUpdatePeriod)
                .withMinBufferTime(minBufferTime)
                .withTimeShiftBufferDepth(timeShiftBufferDepth)
                .withSuggestedPresentationDelay(suggestedPresentationDelay)
                .withMaxSegmentDuration(maxSegmentDuration)
                .withMaxSubsegmentDuration(maxSubsegmentDuration)
                .withSchemaLocation(schemaLocation);
    }

    public static class Builder {
        private static final String DEFAULT_SCHEMA_LOCATION = "urn:mpeg:dash:schema:mpd:2011 http://standards.iso.org/ittf/PubliclyAvailableStandards/MPEG-DASH_schema_files/DASH-MPD.xsd";

        private List programInformations;
        private List baseURLs;
        private List locations;
        private List periods;
        private List metrics;
        private List essentialProperties;
        private List supplementalProperties;
        private List utcTimings;
        private String id;
        private Profiles profiles;
        private PresentationType type;
        private OffsetDateTime availabilityStartTime;
        private OffsetDateTime availabilityEndTime;
        private OffsetDateTime publishTime;
        private Duration mediaPresentationDuration;
        private Duration minimumUpdatePeriod;
        private Duration minBufferTime;
        private Duration timeShiftBufferDepth;
        private Duration suggestedPresentationDelay;
        private Duration maxSegmentDuration;
        private Duration maxSubsegmentDuration;
        private String schemaLocation;

        public Builder() {
            this.schemaLocation = DEFAULT_SCHEMA_LOCATION;
            this.type = PresentationType.STATIC;
            this.minBufferTime = Duration.ZERO;
        }

        public Builder withProgramInformations(List programInformations) {
            this.programInformations = programInformations;
            return this;
        }

        public Builder withBaseURLs(List baseURLs) {
            this.baseURLs = baseURLs;
            return this;
        }

        public Builder withLocations(List locations) {
            this.locations = locations;
            return this;
        }

        public Builder withPeriods(List periods) {
            this.periods = periods;
            return this;
        }

        public Builder withPeriods(Period period, Period ...morePeriods) {
            this.periods = Utils.varargsToList(period, morePeriods);
            return this;
        }

        public Builder withMetrics(List metrics) {
            this.metrics = metrics;
            return this;
        }

        public Builder withEssentialProperties(List essentialProperties) {
            this.essentialProperties = essentialProperties;
            return this;
        }

        public Builder withSupplementalProperties(List supplementalProperties) {
            this.supplementalProperties = supplementalProperties;
            return this;
        }

        public Builder withUtcTimings(List utcTimings) {
            this.utcTimings = utcTimings;
            return this;
        }

        public Builder withUtcTimings(UTCTiming utcTiming, UTCTiming ...moreUtcTiming) {
            this.utcTimings = Utils.varargsToList(utcTiming, moreUtcTiming);
            return this;
        }

        public Builder withId(String id) {
            this.id = id;
            return this;
        }

        public Builder withProfiles(Profiles profiles) {
            this.profiles = profiles;
            return this;
        }

        public Builder withProfiles(Profile profile, Profile ...moreProfiles) {
            if (this.profiles == null) {
                this.profiles = new Profiles();
            }
            this.profiles = this.profiles.buildUpon()
                    .withProfiles(Utils.varargsToList(profile, moreProfiles))
                    .build();
            return this;
        }

        public Builder withInteroperabilityPointsAndExtensions(String value, String ...moreValues) {
            if (this.profiles == null) {
                this.profiles = new Profiles();
            }
            this.profiles = this.profiles.buildUpon()
                    .withInteroperabilityPointsAndExtensions(Utils.varargsToList(value, moreValues))
                    .build();
            return this;
        }

        public Builder withType(PresentationType type) {
            this.type = type;
            return this;
        }

        public Builder withAvailabilityStartTime(OffsetDateTime availabilityStartTime) {
            this.availabilityStartTime = availabilityStartTime;
            return this;
        }

        public Builder withAvailabilityEndTime(OffsetDateTime availabilityEndTime) {
            this.availabilityEndTime = availabilityEndTime;
            return this;
        }

        public Builder withPublishTime(OffsetDateTime publishTime) {
            this.publishTime = publishTime;
            return this;
        }

        public Builder withMediaPresentationDuration(Duration mediaPresentationDuration) {
            this.mediaPresentationDuration = mediaPresentationDuration;
            return this;
        }

        public Builder withMinimumUpdatePeriod(Duration minimumUpdatePeriod) {
            this.minimumUpdatePeriod = minimumUpdatePeriod;
            return this;
        }

        public Builder withMinBufferTime(Duration minBufferTime) {
            this.minBufferTime = minBufferTime;
            return this;
        }

        public Builder withTimeShiftBufferDepth(Duration timeShiftBufferDepth) {
            this.timeShiftBufferDepth = timeShiftBufferDepth;
            return this;
        }

        public Builder withSuggestedPresentationDelay(Duration suggestedPresentationDelay) {
            this.suggestedPresentationDelay = suggestedPresentationDelay;
            return this;
        }

        public Builder withMaxSegmentDuration(Duration maxSegmentDuration) {
            this.maxSegmentDuration = maxSegmentDuration;
            return this;
        }

        public Builder withMaxSubsegmentDuration(Duration maxSubsegmentDuration) {
            this.maxSubsegmentDuration = maxSubsegmentDuration;
            return this;
        }

        public Builder withSchemaLocation(String schemaLocation) {
            this.schemaLocation = schemaLocation;
            return this;
        }

        public MPD build() {
            return new MPD(programInformations, baseURLs, locations, periods, metrics, essentialProperties, supplementalProperties, utcTimings, id, profiles, type, availabilityStartTime, availabilityEndTime, publishTime, mediaPresentationDuration, minimumUpdatePeriod, minBufferTime, timeShiftBufferDepth, suggestedPresentationDelay, maxSegmentDuration, maxSubsegmentDuration, schemaLocation);
        }
    }
}