org.jitsi.service.neomedia.control.KeyFrameControlAdapter Maven / Gradle / Ivy

Go to download
/*
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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.jitsi.service.neomedia.control;

import java.util.*;

/**
 * Provides a default implementation of {@link KeyFrameControl}.
 *
 * @author Lyubomir Marinov
 */
public class KeyFrameControlAdapter
    implements KeyFrameControl
{
    /**
     * The KeyFrameRequestees made available by this
     * KeyFrameControl.
     */
    private List keyFrameRequestees
        = new ArrayList(0);

    /**
     * The KeyFrameRequesters made available by this
     * KeyFrameControl.
     */
    private List keyFrameRequesters
        = new ArrayList(0);

    /**
     * An unmodifiable view of {@link #keyFrameRequestees} appropriate to be
     * returned by {@link #getKeyFrameRequestees()}.
     */
    private List unmodifiableKeyFrameRequestees;

    /**
     * An unmodifiable view of {@link #keyFrameRequesters} appropriate to be
     * returned by {@link #getKeyFrameRequesters()}.
     */
    private List unmodifiableKeyFrameRequesters;

    /**
     * Implements
     * {@link KeyFrameControl#addKeyFrameRequestee(int, KeyFrameRequestee)}.
     *
     * {@inheritDoc}
     */
    public void addKeyFrameRequestee(
            int index,
            KeyFrameRequestee keyFrameRequestee)
    {
        if (keyFrameRequestee == null)
            throw new NullPointerException("keyFrameRequestee");
        synchronized (this)
        {
            if (!keyFrameRequestees.contains(keyFrameRequestee))
            {
                List newKeyFrameRequestees
                    = new ArrayList(
                            keyFrameRequestees.size() + 1);

                newKeyFrameRequestees.addAll(keyFrameRequestees);
                /*
                 * If this KeyFrameControl is to determine the index at which
                 * keyFrameRequestee is to be added according to its own
                 * internal logic, then it will prefer KeyFrameRequestee
                 * implementations from outside of neomedia rather than from its
                 * inside.
                 */
                if (-1 == index)
                {
                    if (keyFrameRequestee.getClass().getName().contains(
                            ".neomedia."))
                        index = newKeyFrameRequestees.size();
                    else
                        index = 0;
                }
                newKeyFrameRequestees.add(index, keyFrameRequestee);

                keyFrameRequestees = newKeyFrameRequestees;
                unmodifiableKeyFrameRequestees = null;
            }
        }
    }

    /**
     * Implements
     * {@link KeyFrameControl#addKeyFrameRequester(int, KeyFrameRequester)}.
     *
     * {@inheritDoc}
     */
    public void addKeyFrameRequester(
            int index,
            KeyFrameRequester keyFrameRequester)
    {
        if (keyFrameRequester == null)
            throw new NullPointerException("keyFrameRequester");
        synchronized (this)
        {
            if (!keyFrameRequesters.contains(keyFrameRequester))
            {
                List newKeyFrameRequesters
                    = new ArrayList(
                            keyFrameRequesters.size() + 1);

                newKeyFrameRequesters.addAll(keyFrameRequesters);
                /*
                 * If this KeyFrameControl is to determine the index at which
                 * keyFrameRequester is to be added according to its own
                 * internal logic, then it will prefer KeyFrameRequester
                 * implementations from outside of neomedia rather than from its
                 * inside.
                 */
                if (-1 == index)
                {
                    if (keyFrameRequester.getClass().getName().contains(
                            ".neomedia."))
                        index = newKeyFrameRequesters.size();
                    else
                        index = 0;
                }
                newKeyFrameRequesters.add(index, keyFrameRequester);

                keyFrameRequesters = newKeyFrameRequesters;
                unmodifiableKeyFrameRequesters = null;
            }
        }
    }

    /**
     * Implements {@link KeyFrameControl#getKeyFrameRequestees()}.
     *
     * {@inheritDoc}
     */
    public List getKeyFrameRequestees()
    {
        synchronized (this)
        {
            if (unmodifiableKeyFrameRequestees == null)
            {
                unmodifiableKeyFrameRequestees
                    = Collections.unmodifiableList(keyFrameRequestees);
            }
            return unmodifiableKeyFrameRequestees;
        }
    }

    /**
     * Implements {@link KeyFrameControl#getKeyFrameRequesters()}.
     *
     * {@inheritDoc}
     */
    public List getKeyFrameRequesters()
    {
        synchronized (this)
        {
            if (unmodifiableKeyFrameRequesters == null)
            {
                unmodifiableKeyFrameRequesters
                    = Collections.unmodifiableList(keyFrameRequesters);
            }
            return unmodifiableKeyFrameRequesters;
        }
    }

    /**
     * Implements {@link KeyFrameControl#keyFrameRequest()}.
     *
     * {@inheritDoc}
     */
    public boolean keyFrameRequest()
    {
        for (KeyFrameRequestee keyFrameRequestee : getKeyFrameRequestees())
        {
            try
            {
                if (keyFrameRequestee.keyFrameRequest())
                    return true;
            }
            catch (Exception e)
            {
                /*
                 * A KeyFrameRequestee has malfunctioned, do not let it
                 * interfere with the others.
                 */
            }
        }
        return false;
    }

    /**
     * Implements
     * {@link KeyFrameControl#removeKeyFrameRequestee(KeyFrameRequestee)}.
     *
     * {@inheritDoc}
     */
    public boolean removeKeyFrameRequestee(KeyFrameRequestee keyFrameRequestee)
    {
        synchronized (this)
        {
            int index = keyFrameRequestees.indexOf(keyFrameRequestee);

            if (-1 != index)
            {
                List newKeyFrameRequestees
                    = new ArrayList(keyFrameRequestees);

                newKeyFrameRequestees.remove(index);

                keyFrameRequestees = newKeyFrameRequestees;
                unmodifiableKeyFrameRequestees = null;

                return true;
            }
            else
                return false;
        }
    }

    /**
     * Implements
     * {@link KeyFrameControl#removeKeyFrameRequester(KeyFrameRequester)}.
     *
     * {@inheritDoc}
     */
    public boolean removeKeyFrameRequester(KeyFrameRequester keyFrameRequester)
    {
        synchronized (this)
        {
            int index = keyFrameRequesters.indexOf(keyFrameRequester);

            if (-1 != index)
            {
                List newKeyFrameRequesters
                    = new ArrayList(keyFrameRequesters);

                newKeyFrameRequesters.remove(index);

                keyFrameRequesters = newKeyFrameRequesters;
                unmodifiableKeyFrameRequesters = null;

                return true;
            }
            else
                return false;
        }
    }

    /**
     * Implements {@link KeyFrameControl#requestKeyFrame(boolean)}.
     *
     * {@inheritDoc}
     */
    public boolean requestKeyFrame(boolean urgent)
    {
        for (KeyFrameRequester keyFrameRequester : getKeyFrameRequesters())
        {
            try
            {
                if (keyFrameRequester.requestKeyFrame())
                    return true;
            }
            catch (Exception e)
            {
                /*
                 * A KeyFrameRequestee has malfunctioned, do not let it
                 * interfere with the others.
                 */
            }
        }
        return false;
    }
}