UserDataBox.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.restcomm.media.resource.player.video.mpeg;

import java.io.DataInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * <b>8.10.1.1 Definition</b>
 * <ul>
 * <li>Box Type: �?udta’</li>
 * <li>Container: Movie Box (�?moov’) or Track Box (�?trak’)</li>
 * <li>Mandatory: No</li>
 * <li>Quantity: Zero or one</li>
 * </ul>
 * <p>
 * This box contains objects that declare user information about the containing box and its data (presentation or
 * track).
 * </p>
 * <p>
 * The User Data Box is a container box for informative user-data. This user data is formatted as a set of boxes with
 * more specific box types, which declare more precisely their content.
 * </p>
 * <p>
 * Only a copyright notice is defined in this specification.
 * </p>
 * 
 * @author amit bhayani
 * 
 */
public class UserDataBox extends Box {

	// File Type = udta
	static byte[] TYPE = new byte[] { AsciiTable.ALPHA_u, AsciiTable.ALPHA_d, AsciiTable.ALPHA_t, AsciiTable.ALPHA_a };
	static String TYPE_S = "udta";
	static {
		bytetoTypeMap.put(TYPE, TYPE_S);
	}

	private List<Box> userDefinedBoxes = new ArrayList<Box>();
	private boolean isTrackParent;

	public UserDataBox(long size, boolean isTrackParent) {
		super(size, TYPE_S);
		this.isTrackParent = isTrackParent;
	}

	@Override
	protected int load(DataInputStream fin) throws IOException {
		int count = 8;

		if (this.getSize() > 16) {
			while ((count + 8) < this.getSize()) {
				long len = readU32(fin);
				byte[] type = read(fin);
				Box box = null;
				if (comparebytes(type, CopyrightBox.TYPE)) {
					box = new CopyrightBox(len);
					count += box.load(fin);
				} else if (comparebytes(type, TrackHintInformation.TYPE) && this.isTrackParent) {
					box = new TrackHintInformation(len);
					count += box.load(fin);
				} else if (comparebytes(type, MovieHintInformation.TYPE)) {
					box = new MovieHintInformation(len);
					count += box.load(fin);
				} else {
					box = new UndefinedBox(len, new String(type));
					count += box.load(fin);
				}

				userDefinedBoxes.add(box);
			}
			
			if(count < this.getSize()){
				int skip = (int)this.getSize() - count;
				fin.skipBytes(skip);
			}
		} else {
			int skip = (int)this.getSize() - 8;
			fin.skipBytes(skip);
		}
		return (int) this.getSize();
	}

	public List<Box> getUserDefinedBoxes() {
		return userDefinedBoxes;
	}
}