• Home
• org.kurento
• kurento-room-sdk
• 6.5.0
• source code
• Room.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.kurento.room.internal.Room Maven / Gradle / Ivy

/*
 * (C) Copyright 2014 Kurento (http://kurento.org/)
 *
 * 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.kurento.room.internal;

import java.util.Collection;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

import org.kurento.client.Continuation;
import org.kurento.client.ErrorEvent;
import org.kurento.client.EventListener;
import org.kurento.client.IceCandidate;
import org.kurento.client.KurentoClient;
import org.kurento.client.MediaPipeline;
import org.kurento.room.api.RoomHandler;
import org.kurento.room.exception.RoomException;
import org.kurento.room.exception.RoomException.Code;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author Ivan Gracia ([email protected])
 * @author Micael Gallego ([email protected])
 * @author Radu Tom Vlad ([email protected])
 * @since 1.0.0
 */
public class Room {
  public static final int ASYNC_LATCH_TIMEOUT = 30;

  private final static Logger log = LoggerFactory.getLogger(Room.class);

  private final ConcurrentMap participants = new ConcurrentHashMap();
  private final String name;

  private MediaPipeline pipeline;
  private CountDownLatch pipelineLatch = new CountDownLatch(1);

  private KurentoClient kurentoClient;

  private RoomHandler roomHandler;

  private volatile boolean closed = false;

  private AtomicInteger activePublishers = new AtomicInteger(0);

  private Object pipelineCreateLock = new Object();
  private Object pipelineReleaseLock = new Object();
  private volatile boolean pipelineReleased = false;
  private boolean destroyKurentoClient;

  public Room(String roomName, KurentoClient kurentoClient, RoomHandler roomHandler,
      boolean destroyKurentoClient) {
    this.name = roomName;
    this.kurentoClient = kurentoClient;
    this.destroyKurentoClient = destroyKurentoClient;
    this.roomHandler = roomHandler;
    log.debug("New ROOM instance, named '{}'", roomName);
  }

  public String getName() {
    return name;
  }

  public MediaPipeline getPipeline() {
    try {
      pipelineLatch.await(Room.ASYNC_LATCH_TIMEOUT, TimeUnit.SECONDS);
    } catch (InterruptedException e) {
      throw new RuntimeException(e);
    }
    return this.pipeline;
  }

  public void join(String participantId, String userName, boolean webParticipant)
      throws RoomException {

    checkClosed();

    if (userName == null || userName.isEmpty()) {
      throw new RoomException(Code.GENERIC_ERROR_CODE, "Empty user name is not allowed");
    }
    for (Participant p : participants.values()) {
      if (p.getName().equals(userName)) {
        throw new RoomException(Code.EXISTING_USER_IN_ROOM_ERROR_CODE, "User '" + userName
            + "' already exists in room '" + name + "'");
      }
    }

    createPipeline();

    participants.put(participantId, new Participant(participantId, userName, this, getPipeline(),
        webParticipant));

    log.info("ROOM {}: Added participant {}", name, userName);
  }

  public void newPublisher(Participant participant) {
    registerPublisher();

    // pre-load endpoints to recv video from the new publisher
    for (Participant participant1 : participants.values()) {
      if (participant.equals(participant1)) {
        continue;
      }
      participant1.getNewOrExistingSubscriber(participant.getName());
    }

    log.debug("ROOM {}: Virtually subscribed other participants {} to new publisher {}", name,
        participants.values(), participant.getName());
  }

  public void cancelPublisher(Participant participant) {
    deregisterPublisher();

    // cancel recv video from this publisher
    for (Participant subscriber : participants.values()) {
      if (participant.equals(subscriber)) {
        continue;
      }
      subscriber.cancelReceivingMedia(participant.getName());
    }

    log.debug("ROOM {}: Unsubscribed other participants {} from the publisher {}", name,
        participants.values(), participant.getName());

  }

  public void leave(String participantId) throws RoomException {

    checkClosed();

    Participant participant = participants.get(participantId);
    if (participant == null) {
      throw new RoomException(Code.USER_NOT_FOUND_ERROR_CODE, "User #" + participantId
          + " not found in room '" + name + "'");
    }
    log.info("PARTICIPANT {}: Leaving room {}", participant.getName(), this.name);
    if (participant.isStreaming()) {
      this.deregisterPublisher();
    }
    this.removeParticipant(participant);
    participant.close();
  }

  public Collection getParticipants() {

    checkClosed();

    return participants.values();
  }

  public Set getParticipantIds() {

    checkClosed();

    return participants.keySet();
  }

  public Participant getParticipant(String participantId) {

    checkClosed();

    return participants.get(participantId);
  }

  public Participant getParticipantByName(String userName) {

    checkClosed();

    for (Participant p : participants.values()) {
      if (p.getName().equals(userName)) {
        return p;
      }
    }

    return null;
  }

  public void close() {
    if (!closed) {

      for (Participant user : participants.values()) {
        user.close();
      }

      participants.clear();

      closePipeline();

      log.debug("Room {} closed", this.name);

      if (destroyKurentoClient) {
        kurentoClient.destroy();
      }

      this.closed = true;
    } else {
      log.warn("Closing an already closed room '{}'", this.name);
    }
  }

  public void sendIceCandidate(String participantId, String endpointName, IceCandidate candidate) {
    this.roomHandler.onIceCandidate(name, participantId, endpointName, candidate);
  }

  public void sendMediaError(String participantId, String description) {
    this.roomHandler.onMediaElementError(name, participantId, description);
  }

  public boolean isClosed() {
    return closed;
  }

  private void checkClosed() {
    if (closed) {
      throw new RoomException(Code.ROOM_CLOSED_ERROR_CODE, "The room '" + name + "' is closed");
    }
  }

  private void removeParticipant(Participant participant) {

    checkClosed();

    participants.remove(participant.getId());

    log.debug("ROOM {}: Cancel receiving media from user '{}' for other users", this.name,
        participant.getName());
    for (Participant other : participants.values()) {
      other.cancelReceivingMedia(participant.getName());
    }
  }

  public int getActivePublishers() {
    return activePublishers.get();
  }

  public void registerPublisher() {
    this.activePublishers.incrementAndGet();
  }

  public void deregisterPublisher() {
    this.activePublishers.decrementAndGet();
  }

  private void createPipeline() {
    synchronized (pipelineCreateLock) {
      if (pipeline != null) {
        return;
      }
      log.info("ROOM {}: Creating MediaPipeline", name);
      try {
        kurentoClient.createMediaPipeline(new Continuation() {
          @Override
          public void onSuccess(MediaPipeline result) throws Exception {
            pipeline = result;
            pipelineLatch.countDown();
            log.debug("ROOM {}: Created MediaPipeline", name);
          }

          @Override
          public void onError(Throwable cause) throws Exception {
            pipelineLatch.countDown();
            log.error("ROOM {}: Failed to create MediaPipeline", name, cause);
          }
        });
      } catch (Exception e) {
        log.error("Unable to create media pipeline for room '{}'", name, e);
        pipelineLatch.countDown();
      }
      if (getPipeline() == null) {
        throw new RoomException(Code.ROOM_CANNOT_BE_CREATED_ERROR_CODE,
            "Unable to create media pipeline for room '" + name + "'");
      }

      pipeline.addErrorListener(new EventListener() {
        @Override
        public void onEvent(ErrorEvent event) {
          String desc = event.getType() + ": " + event.getDescription() + "(errCode="
              + event.getErrorCode() + ")";
          log.warn("ROOM {}: Pipeline error encountered: {}", name, desc);
          roomHandler.onPipelineError(name, getParticipantIds(), desc);
        }
      });
    }
  }

  private void closePipeline() {
    synchronized (pipelineReleaseLock) {
      if (pipeline == null || pipelineReleased) {
        return;
      }
      getPipeline().release(new Continuation() {

        @Override
        public void onSuccess(Void result) throws Exception {
          log.debug("ROOM {}: Released Pipeline", Room.this.name);
          pipelineReleased = true;
        }

        @Override
        public void onError(Throwable cause) throws Exception {
          log.warn("ROOM {}: Could not successfully release Pipeline", Room.this.name, cause);
          pipelineReleased = true;
        }
      });
    }
  }
}