/*
 *  MusicTag Copyright (C)2003,2004
 *
 *  This library 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 library 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 library; if not,
 *  you can get a copy from http://www.opensource.org/licenses/lgpl-license.php or write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package org.jaudiotagger.tag.id3.framebody;

import org.jaudiotagger.tag.InvalidTagException;
import org.jaudiotagger.tag.datatype.ByteArraySizeTerminated;
import org.jaudiotagger.tag.datatype.DataTypes;
import org.jaudiotagger.tag.datatype.NumberFixedLength;
import org.jaudiotagger.tag.datatype.StringNullTerminated;
import org.jaudiotagger.tag.id3.ID3v24Frames;

import java.nio.ByteBuffer;

/**
 * Audio encryption Frame.
 * <p/>
 * <p/>
 * This frame indicates if the actual audio stream is encrypted, and by
 * whom. Since standardisation of such encrypion scheme is beyond this
 * document, all "AENC" frames begin with a terminated string with a
 * URL containing an email address, or a link to a location where an
 * email address can be found, that belongs to the organisation
 * responsible for this specific encrypted audio file. Questions
 * regarding the encrypted audio should be sent to the email address
 * specified. If a $00 is found directly after the 'Frame size' and the
 * audiofile indeed is encrypted, the whole file may be considered
 * useless.
 * </p><p>
 * After the 'Owner identifier', a pointer to an unencrypted part of the
 * audio can be specified. The 'Preview start' and 'Preview length' is
 * described in frames. If no part is unencrypted, these fields should
 * be left zeroed. After the 'preview length' field follows optionally a
 * datablock required for decryption of the audio. There may be more
 * than one "AENC" frames in a tag, but only one with the same 'Owner
 * identifier'.
 * </p><p><table border=0 width="70%">
 * <tr><td colspan=2><Header for 'Audio encryption', ID: "AENC"></td></tr>
 * <tr><td>Owner identifier  </td><td><text string> $00    </td></tr>
 * <tr><td>Preview start     </td><td>$xx xx                     </td></tr>
 * <tr><td>Preview length    </td><td>$xx xx                     </td></tr>
 * <tr><td>Encryption info   </td><td><binary data>        </td></tr>
 * </table></p>
 * <p/>
 * <p>For more details, please refer to the ID3 specifications:
 * <ul>
 * <li><a href="http://www.id3.org/id3v2.3.0.txt">ID3 v2.3.0 Spec</a>
 * </ul>
 *
 * @author : Paul Taylor
 * @author : Eric Farng
 * @version $Id: FrameBodyAENC.java 832 2009-11-12 13:25:38Z paultaylor $
 */
public class FrameBodyAENC extends AbstractID3v2FrameBody implements ID3v24FrameBody, ID3v23FrameBody
{

    /**
     * Creates a new FrameBodyAENC datatype.
     */
    public FrameBodyAENC()
    {
        this.setObjectValue(DataTypes.OBJ_OWNER, "");
        this.setObjectValue(DataTypes.OBJ_PREVIEW_START, (short) 0);
        this.setObjectValue(DataTypes.OBJ_PREVIEW_LENGTH, (short) 0);
        this.setObjectValue(DataTypes.OBJ_ENCRYPTION_INFO, new byte[0]);
    }

    public FrameBodyAENC(FrameBodyAENC body)
    {
        super(body);
    }

    /**
     * Creates a new FrameBodyAENC datatype.
     *
     * @param owner
     * @param previewStart
     * @param previewLength
     * @param data
     */
    public FrameBodyAENC(String owner, short previewStart, short previewLength, byte[] data)
    {
        this.setObjectValue(DataTypes.OBJ_OWNER, owner);
        this.setObjectValue(DataTypes.OBJ_PREVIEW_START, previewStart);
        this.setObjectValue(DataTypes.OBJ_PREVIEW_LENGTH, previewLength);
        this.setObjectValue(DataTypes.OBJ_ENCRYPTION_INFO, data);
    }

    /**
     * Creates a new FrameBodyAENC datatype.
     *
     * @param byteBuffer
     * @param frameSize
     * @throws InvalidTagException if unable to create framebody from buffer
     */
    public FrameBodyAENC(ByteBuffer byteBuffer, int frameSize) throws InvalidTagException
    {
        super(byteBuffer, frameSize);
    }

    /**
     * The ID3v2 frame identifier
     *
     * @return the ID3v2 frame identifier  for this frame type
     */
    public String getIdentifier()
    {
        return ID3v24Frames.FRAME_ID_AUDIO_ENCRYPTION;
    }

    /**
     * @return owner
     */
    public String getOwner()
    {
        return (String) getObjectValue(DataTypes.OBJ_OWNER);
    }

    /**
     * @param description
     */
    public void getOwner(String description)
    {
        setObjectValue(DataTypes.OBJ_OWNER, description);
    }

    /**
     *
     */
    protected void setupObjectList()
    {
        objectList.add(new StringNullTerminated(DataTypes.OBJ_OWNER, this));
        objectList.add(new NumberFixedLength(DataTypes.OBJ_PREVIEW_START, this, 2));
        objectList.add(new NumberFixedLength(DataTypes.OBJ_PREVIEW_LENGTH, this, 2));
        objectList.add(new ByteArraySizeTerminated(DataTypes.OBJ_ENCRYPTION_INFO, this));
    }
}