org.wicketstuff.html5.media.webrtc.WebRTC Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-html5 Show documentation
Some simple components and behaviors to support HTML5
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.wicketstuff.html5.media.webrtc;

import java.io.IOException;

import org.apache.commons.io.IOUtils;
import org.apache.wicket.Application;
import org.apache.wicket.Page;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.markup.head.CssReferenceHeaderItem;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.JavaScriptHeaderItem;
import org.apache.wicket.markup.head.JavaScriptReferenceHeaderItem;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.media.video.Video;
import org.apache.wicket.model.IModel;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.resource.PackageResourceReference;
import org.apache.wicket.request.resource.ResourceReference;

/**
 * A WebRTC component to create a video conference based on SimpleWebRTC.
 *
 * http://www.html5rocks.com/en/tutorials/webrtc/basics/

 * https://github.com/andyet/signalmaster

 * https://github.com/HenrikJoreteg/SimpleWebRTC

 * https://github.com/HenrikJoreteg/webrtc.js
 *
 * @author Tobias Soloschenko
 *
 */
public abstract class WebRTC extends WebMarkupContainer
{
	private static final long serialVersionUID = 1L;

	private Boolean debug;

	private Boolean volumeBars;

	private Integer framesPerSeconds;

	private Integer maxWidth;

	private Integer maxHeight;

	public WebRTC(String id)
	{
		super(id);
		setOutputMarkupId(true);
		setOutputMarkupPlaceholderTag(true);
	}

	public WebRTC(String id, IModel model)
	{
		super(id, model);
		setOutputMarkupId(true);
		setOutputMarkupPlaceholderTag(true);
	}

	@Override
	public void renderHead(IHeaderResponse response)
	{
		try
		{
			Video localVideo = configureVideo();
			response.render(JavaScriptHeaderItem.forReference(Application.get().getJavaScriptLibrarySettings().getJQueryReference()));
			response.render(JavaScriptHeaderItem.forReference(new PackageResourceReference(
				WebRTC.class, debug != null && debug ? "simplewebrtc.bundle.js" : "latest.js")));
			String initializejs = IOUtils.toString(WebRTC.class.getResourceAsStream("WebRTC.js"));
			initializejs = initializejs.replaceAll("%\\(markupid\\)", getMarkupId());
			initializejs = initializejs.replaceAll("%\\(localvideoid\\)", localVideo.getMarkupId());
			initializejs = initializejs.replaceAll("%\\(roomname\\)", getRoomName());
			initializejs = initializejs.replaceAll("%\\(socketiourl\\)", getSocketIOUrl());
			initializejs = initializejs.replaceAll("%\\(volumebars\\)", getVolumeBars().toString());
			initializejs = initializejs.replaceAll("%\\(framesperseconds\\)",
				getFramesPerSeconds().toString());
			initializejs = initializejs.replaceAll("%\\(maxwidth\\)", getMaxWidth().toString());
			initializejs = initializejs.replaceAll("%\\(maxheight\\)", getMaxHeight().toString());
			initializejs = initializejs.replaceAll("%\\(poster\\)",
				RequestCycle.get().urlFor(getNoVideoResourceReference(), null).toString());
			initializejs = initializejs.replaceAll("%\\(errorurl\\)", (getErrorPage() != null
				? RequestCycle.get().urlFor(getErrorPage(), null) : "").toString());

			response.render(JavaScriptReferenceHeaderItem.forScript(initializejs, getMarkupId() +
				"script"));
			String css = IOUtils.toString(WebRTC.class.getResourceAsStream("WebRTC.css"));
			css = css.replaceAll("%\\(maxwidth\\)", getMaxWidth().toString());
			css = css.replaceAll("%\\(maxheight\\)", getMaxHeight().toString());
			response.render(CssReferenceHeaderItem.forCSS(css, getMarkupId() + "css"));
		}
		catch (IOException e)
		{
			throw new WicketRuntimeException(e);
		}
	}

	/**
	 * Configures the given video for web rtc. If the video and mic are rejected for usage a dummy
	 * picture is going to be shown.
	 *
	 * @return the configured video
	 */
	private Video configureVideo()
	{
		Video localVideo = getLocalVideo();
		localVideo.setOutputMarkupId(true);
		localVideo.setPoster(getNoVideoResourceReference());
		return localVideo;
	}

	/**
	 * Gets the resource reference which is going to be shown if the access to the mic and the cam
	 * is not allowed by the user.
	 *
	 * @return the resource reference to be used if no access to mic and the cam is not allowed
	 */
	protected ResourceReference getNoVideoResourceReference()
	{
		return new PackageResourceReference(WebRTC.class, "novideo.gif");
	}

	/**
	 * Gets the local video id of the video element which is going to display the local video
	 * recording
	 *
	 * @return the id of the local video
	 */
	public abstract Video getLocalVideo();

	/**
	 * Gets the room name to which the users are joining
	 *
	 * @return the room name
	 */
	public abstract String getRoomName();

	/**
	 * Gets the url of the signal server based on socket.io. Important the URL must not contain a
	 * namespace like /socket.io at the end, because the signal server then never calls the connect
	 * event.
	 *
	 * @return the url of the socket io server
	 */
	public abstract String getSocketIOUrl();

	/**
	 * If the debug mode is enabled - this is causing the uncompressed version of the javascript
	 * files is going to be loaded
	 *
	 * @return if the debug mode is enabled
	 */
	public Boolean isDebug()
	{
		return debug;
	}

	/**
	 * Sets the debug mode to be enabled - this is causing the uncompressed version of the
	 * javascript files is going to be loaded
	 *
	 * @param debug
	 *            if the debug mode is enabled
	 */
	public void setDebug(Boolean debug)
	{
		this.debug = debug;
	}

	/**
	 * If the volume bars are enabled or disabled
	 *
	 * @return if the volume bars are enabled or disabled
	 */
	public Boolean getVolumeBars()
	{
		return volumeBars != null ? volumeBars : true;
	}

	/**
	 * Sets the volume bars to be enabled or disabled
	 *
	 * @param volumeBars
	 *            if the volume bars are enabled or disabled
	 */
	public void setVolumeBars(Boolean volumeBars)
	{
		this.volumeBars = volumeBars;
	}

	/**
	 * Gets the frames per seconds which are going to be used for the videos
	 *
	 * @return the frames per seconds
	 */
	public Integer getFramesPerSeconds()
	{
		return framesPerSeconds != null ? framesPerSeconds : 10;
	}

	/**
	 * Sets the frames per seconds which are going to be used for the videos
	 *
	 * @param framesPerSeconds
	 *            the frames per seconds as short
	 */
	public void setFramesPerSeconds(Integer framesPerSeconds)
	{
		this.framesPerSeconds = framesPerSeconds;
	}

	/**
	 * Gets the max width of the videos - if the width is smaller less band width is used
	 *
	 * @return the max width of the videos
	 */
	public Integer getMaxWidth()
	{
		return maxWidth != null ? maxWidth : 320;
	}

	/**
	 * Sets the max width of the videos - if the width is smaller less band width is used
	 *
	 * @param maxWidth
	 *            the max width the videos should be
	 */
	public void setMaxWidth(Integer maxWidth)
	{
		this.maxWidth = maxWidth;
	}

	/**
	 * Gets the max height of the videos - if the height is smaller less band width is used
	 *
	 * @return the max height of the videos
	 */
	public Integer getMaxHeight()
	{
		return maxHeight != null ? maxHeight : 240;
	}

	/**
	 * Sets the max height of the videos - if the height is smaller less band width is used
	 *
	 * @param maxHeight
	 *            the max height the videos should be
	 */
	public void setMaxHeight(Integer maxHeight)
	{
		this.maxHeight = maxHeight;
	}

	/**
	 * Override this to provide an error page if video / audio is not available. If only audio is
	 * available getNoVideoResourceReference() is called and the image received by this method is
	 * shown.
	 *
	 * @return the page if video / audio is not available
	 */
	public Class getErrorPage()
	{
		return null;
	}

}