/*
* RED5 Open Source Flash Server - http://code.google.com/p/red5/
*
* Copyright (c) 2006-2011 by respective authors (see below). All rights reserved.
*
* 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, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.red5.server.stream.provider;
import java.io.File;
import java.io.IOException;
import org.red5.io.IStreamableFile;
import org.red5.io.ITag;
import org.red5.io.ITagReader;
import org.red5.io.flv.IKeyFrameDataAnalyzer;
import org.red5.io.flv.IKeyFrameDataAnalyzer.KeyFrameMeta;
import org.red5.server.api.scope.IScope;
import org.red5.server.api.service.IStreamableFileService;
import org.red5.server.api.stream.IStreamableFileFactory;
import org.red5.server.messaging.IMessage;
import org.red5.server.messaging.IMessageComponent;
import org.red5.server.messaging.IPassive;
import org.red5.server.messaging.IPipe;
import org.red5.server.messaging.IPipeConnectionListener;
import org.red5.server.messaging.IPullableProvider;
import org.red5.server.messaging.OOBControlMessage;
import org.red5.server.messaging.PipeConnectionEvent;
import org.red5.server.net.rtmp.event.AudioData;
import org.red5.server.net.rtmp.event.FlexStreamSend;
import org.red5.server.net.rtmp.event.IRTMPEvent;
import org.red5.server.net.rtmp.event.Invoke;
import org.red5.server.net.rtmp.event.Notify;
import org.red5.server.net.rtmp.event.Unknown;
import org.red5.server.net.rtmp.event.VideoData;
import org.red5.server.net.rtmp.message.Constants;
import org.red5.server.stream.ISeekableProvider;
import org.red5.server.stream.IStreamTypeAwareProvider;
import org.red5.server.stream.StreamableFileFactory;
import org.red5.server.stream.message.RTMPMessage;
import org.red5.server.util.ScopeUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Pullable provider for files
*/
public class FileProvider implements IPassive, ISeekableProvider, IPullableProvider, IPipeConnectionListener, IStreamTypeAwareProvider {
/**
* Logger
*/
private static final Logger log = LoggerFactory.getLogger(FileProvider.class);
/**
* Class name
*/
public static final String KEY = FileProvider.class.getName();
/**
* Provider scope
*/
private IScope scope;
/**
* Source file
*/
private File file;
/**
* Consumer pipe
*/
private IPipe pipe;
/**
* Tag reader
*/
private ITagReader reader;
/**
* Keyframe metadata
*/
private KeyFrameMeta keyFrameMeta;
/**
* Position at start
*/
private int start;
/**
* Create file provider for given file and scope
* @param scope Scope
* @param file File
*/
public FileProvider(IScope scope, File file) {
this.scope = scope;
this.file = file;
}
/**
* Setter for start position
*
* @param start Start position
*/
public void setStart(int start) {
this.start = start;
}
/** {@inheritDoc} */
public boolean hasVideo() {
return (reader != null && reader.hasVideo());
}
/** {@inheritDoc} */
public IMessage pullMessage(IPipe pipe) throws IOException {
// there is no need for sync here, the readers use semaphore locks
if (this.pipe == pipe) {
if (reader == null) {
init();
}
if (reader.hasMoreTags()) {
IRTMPEvent msg = null;
ITag tag = reader.readTag();
if (tag != null) {
int timestamp = tag.getTimestamp();
switch (tag.getDataType()) {
case Constants.TYPE_AUDIO_DATA:
msg = new AudioData(tag.getBody());
break;
case Constants.TYPE_VIDEO_DATA:
msg = new VideoData(tag.getBody());
break;
case Constants.TYPE_INVOKE:
msg = new Invoke(tag.getBody());
break;
case Constants.TYPE_NOTIFY:
msg = new Notify(tag.getBody());
break;
case Constants.TYPE_FLEX_STREAM_SEND:
msg = new FlexStreamSend(tag.getBody());
break;
default:
log.warn("Unexpected type? {}", tag.getDataType());
msg = new Unknown(tag.getDataType(), tag.getBody());
}
msg.setTimestamp(timestamp);
RTMPMessage rtmpMsg = RTMPMessage.build(msg);
return rtmpMsg;
} else {
log.debug("Tag was null");
}
} else {
// TODO send OOBCM to notify EOF
// Do not unsubscribe if there aren't any more tags, as this kills VOD seek while in buffer
// this.pipe.unsubscribe(this);
}
}
return null;
}
/** {@inheritDoc} */
public IMessage pullMessage(IPipe pipe, long wait) throws IOException {
return pullMessage(pipe);
}
/** {@inheritDoc} */
public void onPipeConnectionEvent(PipeConnectionEvent event) {
switch (event.getType()) {
case PipeConnectionEvent.PROVIDER_CONNECT_PULL:
if (pipe == null) {
pipe = (IPipe) event.getSource();
}
break;
case PipeConnectionEvent.PROVIDER_DISCONNECT:
if (pipe == event.getSource()) {
this.pipe = null;
uninit();
}
break;
case PipeConnectionEvent.CONSUMER_DISCONNECT:
if (pipe == event.getSource()) {
uninit();
}
default:
}
}
/** {@inheritDoc} */
public void onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg) {
String serviceName = oobCtrlMsg.getServiceName();
String target = oobCtrlMsg.getTarget();
log.debug("onOOBControlMessage - service name: {} target: {}", serviceName, target);
if (serviceName != null) {
if (IPassive.KEY.equals(target)) {
if ("init".equals(serviceName)) {
Integer startTS = (Integer) oobCtrlMsg.getServiceParamMap().get("startTS");
setStart(startTS);
}
} else if (ISeekableProvider.KEY.equals(target)) {
if ("seek".equals(serviceName)) {
Integer position = (Integer) oobCtrlMsg.getServiceParamMap().get("position");
int seekPos = seek(position.intValue());
// Return position we seeked to
oobCtrlMsg.setResult(seekPos);
}
} else if (IStreamTypeAwareProvider.KEY.equals(target)) {
if ("hasVideo".equals(serviceName)) {
oobCtrlMsg.setResult(hasVideo());
}
}
}
}
/**
* Initializes file provider. Creates streamable file factory and service, seeks to start position
*/
private void init() throws IOException {
IStreamableFileFactory factory = (IStreamableFileFactory) ScopeUtils.getScopeService(scope, IStreamableFileFactory.class, StreamableFileFactory.class);
IStreamableFileService service = factory.getService(file);
if (service == null) {
log.error("No service found for {}", file.getAbsolutePath());
return;
}
IStreamableFile streamFile = service.getStreamableFile(file);
reader = streamFile.getReader();
if (start > 0) {
seek(start);
}
}
/**
* Reset
*/
private void uninit() {
if (reader != null) {
reader.close();
reader = null;
}
}
/** {@inheritDoc} */
public int seek(int ts) {
log.trace("Seek ts: {}", ts);
if (keyFrameMeta == null) {
if (!(reader instanceof IKeyFrameDataAnalyzer)) {
// Seeking not supported
return ts;
}
keyFrameMeta = ((IKeyFrameDataAnalyzer) reader).analyzeKeyFrames();
}
if (keyFrameMeta.positions.length == 0) {
// no video keyframe metainfo, it's an audio-only FLV we skip the seek for now.
// TODO add audio-seek capability
return ts;
}
if (ts >= keyFrameMeta.duration) {
// Seek at or beyond EOF
reader.position(Long.MAX_VALUE);
return (int) keyFrameMeta.duration;
}
int frame = -1;
for (int i = 0; i < keyFrameMeta.positions.length; i++) {
if (keyFrameMeta.timestamps[i] > ts) {
frame = i;
break;
}
}
if (frame > -1) {
reader.position(keyFrameMeta.positions[frame]);
return keyFrameMeta.timestamps[frame];
} else {
// Seek at or beyond EOF
reader.position(Long.MAX_VALUE);
return (int) keyFrameMeta.duration;
}
}
}