org.red5.server.stream.consumer.FileConsumer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server-common Show documentation
Show all versions of ant-media-server-common Show documentation
Classes common for multiple Ant Media projects
/*
* RED5 Open Source Media Server - https://github.com/Red5/
*
* Copyright 2006-2016 by respective authors (see below). All rights reserved.
*
* 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.red5.server.stream.consumer;
import java.io.File;
import java.io.IOException;
import java.nio.channels.ClosedChannelException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.PriorityQueue;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import org.apache.mina.core.buffer.IoBuffer;
import org.red5.io.IStreamableFile;
import org.red5.io.ITag;
import org.red5.io.ITagWriter;
import org.red5.server.api.scope.IScope;
import org.red5.server.api.service.IStreamableFileService;
import org.red5.server.api.stream.IClientStream;
import org.red5.server.api.stream.IStreamableFileFactory;
import org.red5.server.messaging.IMessage;
import org.red5.server.messaging.IMessageComponent;
import org.red5.server.messaging.IPipe;
import org.red5.server.messaging.IPipeConnectionListener;
import org.red5.server.messaging.IPushableConsumer;
import org.red5.server.messaging.OOBControlMessage;
import org.red5.server.messaging.PipeConnectionEvent;
import org.red5.server.net.rtmp.event.FlexStreamSend;
import org.red5.server.net.rtmp.event.IRTMPEvent;
import org.red5.server.net.rtmp.event.VideoData;
import org.red5.server.net.rtmp.event.VideoData.FrameType;
import org.red5.server.net.rtmp.message.Constants;
import org.red5.server.stream.IStreamData;
import org.red5.server.stream.StreamableFileFactory;
import org.red5.server.stream.message.RTMPMessage;
import org.red5.server.stream.message.ResetMessage;
import org.red5.server.util.ScopeUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.scheduling.concurrent.CustomizableThreadFactory;
/**
* Consumer that pushes messages to file. Used when recording live streams.
*
* @author The Red5 Project
* @author Paul Gregoire ([email protected])
* @author Vladimir Hmelyoff ([email protected])
* @author Octavian Naicu ([email protected])
*/
public class FileConsumer implements Constants, IPushableConsumer, IPipeConnectionListener, InitializingBean, DisposableBean {
private static final Logger log = LoggerFactory.getLogger(FileConsumer.class);
/**
* Executor for all instance writer jobs
*/
private ScheduledExecutorService scheduledExecutorService;
/**
* Queue writer thread count
*/
private int schedulerThreadSize = 1;
/**
* Queue to hold data for delayed writing
*/
private PriorityQueue queue;
/**
* Reentrant lock
*/
private ReentrantReadWriteLock reentrantLock;
/**
* Write lock
*/
private volatile Lock writeLock;
/**
* Read lock
*/
private volatile Lock readLock;
/**
* Scope
*/
private IScope scope;
/**
* File
*/
private File file;
/**
* Tag writer
*/
private ITagWriter writer;
/**
* Operation mode
*/
private String mode;
/**
* Start timestamp
*/
private int startTimestamp = -1;
/**
* Last write timestamp
*/
@SuppressWarnings("unused")
private int lastTimestamp;
/**
* Video decoder configuration
*/
private ITag videoConfigurationTag;
/**
* Audio decoder configuration
*/
private ITag audioConfigurationTag;
/**
* Number of queued items needed before writes are initiated
*/
private int queueThreshold = -1;
/**
* Percentage of the queue which is sliced for writing
*/
private int percentage = 25;
/**
* Whether or not to use a queue for delaying file writes. The queue is useful for keeping Tag items in their expected order based on
* their time stamp.
*/
private boolean delayWrite = false;
/**
* Tracks the last timestamp written to prevent backwards time stamped data.
*/
private volatile int lastWrittenTs = -1;
/**
* Keeps track of the last spawned write worker.
*/
private volatile Future writerFuture;
private AtomicBoolean gotVideoKeyFrame = new AtomicBoolean(false);
/**
* Default ctor
*/
public FileConsumer() {
}
/**
* Creates file consumer
*
* @param scope
* Scope of consumer
* @param file
* File
*/
public FileConsumer(IScope scope, File file) {
this();
this.scope = scope;
this.file = file;
}
@Override
public void afterPropertiesSet() throws Exception {
if (delayWrite) {
scheduledExecutorService = Executors.newScheduledThreadPool(schedulerThreadSize, new CustomizableThreadFactory("FileConsumerExecutor-"));
}
}
/**
* Push message through pipe
*
* @param pipe
* Pipe
* @param message
* Message to push
* @throws IOException
* if message could not be written
*/
@SuppressWarnings("rawtypes")
public void pushMessage(IPipe pipe, IMessage message) throws IOException {
if (message instanceof RTMPMessage) {
final IRTMPEvent msg = ((RTMPMessage) message).getBody();
// get the type
byte dataType = msg.getDataType();
// get the timestamp
int timestamp = msg.getTimestamp();
log.debug("Data type: {} timestamp: {}", dataType, timestamp);
// if we're dealing with a FlexStreamSend IRTMPEvent, this avoids
// relative timestamp calculations
if (!(msg instanceof FlexStreamSend)) {
//log.trace("Not FlexStreamSend type");
lastTimestamp = timestamp;
}
// ensure that our first video frame written is a key frame
if (msg instanceof VideoData) {
if (!gotVideoKeyFrame.get()) {
VideoData video = (VideoData) msg;
if (video.getFrameType() == FrameType.KEYFRAME) {
log.debug("Got our first keyframe");
gotVideoKeyFrame.set(true);
} else {
// skip this frame bail out
log.debug("Skipping video data since keyframe has not been written yet");
return;
}
}
}
// initialize a writer
if (writer == null) {
init();
}
// if writes are delayed, queue the data and sort it by time
if (!delayWrite) {
write(timestamp, msg);
} else {
QueuedData queued = null;
if (msg instanceof IStreamData) {
if (log.isTraceEnabled()) {
log.trace("Stream data, body saved. Data type: {} class type: {}", dataType, msg.getClass().getName());
}
queued = new QueuedData(timestamp, dataType, (IStreamData) msg);
} else {
// XXX what type of message are we saving that has no body data??
if (log.isTraceEnabled()) {
log.trace("Non-stream data, body not saved. Data type: {} class type: {}", dataType, msg.getClass().getName());
}
queued = new QueuedData(timestamp, dataType);
}
writeLock.lock();
try {
// add to the queue
queue.add(queued);
} finally {
writeLock.unlock();
}
int queueSize = 0;
readLock.lock();
try {
queueSize = queue.size();
} finally {
readLock.unlock();
}
if (msg instanceof VideoData) {
writeQueuedDataSlice(createTimestampLimitedSlice(msg.getTimestamp()));
} else if (queueThreshold >= 0 && queueSize >= queueThreshold) {
writeQueuedDataSlice(createFixedLengthSlice(queueThreshold / (100 / percentage)));
}
}
} else if (message instanceof ResetMessage) {
startTimestamp = -1;
} else if (log.isDebugEnabled()) {
log.debug("Ignoring pushed message: {}", message);
}
}
private void writeQueuedDataSlice(final QueuedData[] slice) {
if (acquireWriteFuture(slice.length)) {
// spawn a writer
writerFuture = scheduledExecutorService.submit(new Runnable() {
public void run() {
log.trace("Spawning queue writer thread");
doWrites(slice);
}
});
} else {
// since we failed to write, put the sliced data back into the queue
writeLock.lock();
try {
List unwritten = Arrays.asList(slice);
for (QueuedData queued : unwritten) {
if (queued.hasData()) {
queue.add(queued);
}
}
} finally {
writeLock.unlock();
}
}
}
private QueuedData[] createFixedLengthSlice(int sliceLength) {
log.debug("Creating data slice to write of length {}.", sliceLength);
// get the slice
final QueuedData[] slice = new QueuedData[sliceLength];
log.trace("Slice length: {}", slice.length);
writeLock.lock();
try {
// sort the queue
if (log.isTraceEnabled()) {
log.trace("Queue length: {}", queue.size());
}
for (int q = 0; q < sliceLength; q++) {
slice[q] = queue.remove();
}
if (log.isTraceEnabled()) {
log.trace("Queue length (after removal): {}", queue.size());
}
} finally {
writeLock.unlock();
}
return slice;
}
private QueuedData[] createTimestampLimitedSlice(int timestamp) {
log.debug("Creating data slice up until timestamp {}.", timestamp);
// get the slice
final ArrayList slice = new ArrayList();
writeLock.lock();
try {
// sort the queue
if (log.isTraceEnabled()) {
log.trace("Queue length: {}", queue.size());
}
if (!queue.isEmpty()) {
while (!queue.isEmpty() && queue.peek().getTimestamp() <= timestamp) {
slice.add(queue.remove());
}
if (log.isTraceEnabled()) {
log.trace("Queue length (after removal): {}", queue.size());
}
}
} finally {
writeLock.unlock();
}
return slice.toArray(new QueuedData[slice.size()]);
}
/**
* Get the WriteFuture with a timeout based on the length of the slice to write.
*
* @param sliceLength
* @return true if successful and false otherwise
*/
private boolean acquireWriteFuture(int sliceLength) {
if (sliceLength > 0) {
Object writeResult = null;
// determine a good timeout value based on the slice length to write
int timeout = sliceLength * 500;
// check for existing future
if (writerFuture != null) {
try {
// wait for a result from the last writer
writeResult = writerFuture.get(timeout, TimeUnit.MILLISECONDS);
} catch (Exception e) {
log.warn("Exception waiting for write result. Timeout: {}ms", timeout, e);
return false;
}
}
log.debug("Write future result (expect null): {}", writeResult);
return true;
}
return false;
}
/**
* Out-of-band control message handler
*
* @param source
* Source of message
* @param pipe
* Pipe that is used to transmit OOB message
* @param oobCtrlMsg
* OOB control message
*/
public void onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg) {
}
/**
* Pipe connection event handler
*
* @param event
* Pipe connection event
*/
@SuppressWarnings("incomplete-switch")
public void onPipeConnectionEvent(PipeConnectionEvent event) {
switch (event.getType()) {
case CONSUMER_CONNECT_PUSH:
if (event.getConsumer() == this) {
Map paramMap = event.getParamMap();
if (paramMap != null) {
mode = (String) paramMap.get("mode");
}
}
break;
}
}
/**
* Initialization
*
* @throws IOException
* I/O exception
*/
private void init() throws IOException {
log.debug("Init");
// if the "file" is null, the consumer has been uninitialized
if (file != null) {
// if we plan to use a queue, create one
if (delayWrite) {
queue = new PriorityQueue(queueThreshold <= 0 ? 11 : queueThreshold);
// add associated locks
reentrantLock = new ReentrantReadWriteLock();
writeLock = reentrantLock.writeLock();
readLock = reentrantLock.readLock();
}
IStreamableFileFactory factory = (IStreamableFileFactory) ScopeUtils.getScopeService(scope, IStreamableFileFactory.class, StreamableFileFactory.class);
File folder = file.getParentFile();
if (!folder.exists()) {
if (!folder.mkdirs()) {
throw new IOException("Could not create parent folder");
}
}
if (!file.isFile()) {
// Maybe the (previously existing) file has been deleted
file.createNewFile();
} else if (!file.canWrite()) {
throw new IOException("The file is read-only");
}
IStreamableFileService service = factory.getService(file);
IStreamableFile flv = service.getStreamableFile(file);
if (mode == null || mode.equals(IClientStream.MODE_RECORD)) {
writer = flv.getWriter();
// write the decoder config tag if it exists
if (videoConfigurationTag != null) {
writer.writeTag(videoConfigurationTag);
videoConfigurationTag = null;
}
if (audioConfigurationTag != null) {
writer.writeTag(audioConfigurationTag);
audioConfigurationTag = null;
}
} else if (mode.equals(IClientStream.MODE_APPEND)) {
writer = flv.getAppendWriter();
} else {
throw new IllegalStateException(String.format("Illegal mode type: %s", mode));
}
} else {
log.warn("Consumer is uninitialized");
}
}
/**
* Reset or uninitialize
*/
public void uninit() {
log.debug("Uninit");
if (writer != null) {
if (writerFuture != null) {
try {
writerFuture.get();
} catch (Exception e) {
log.warn("Exception waiting for write result on uninit", e);
}
if (writerFuture.cancel(false)) {
log.debug("Future completed");
}
}
writerFuture = null;
if (delayWrite) {
// write all the queued items
doWrites();
// clear the queue
queue.clear();
queue = null;
}
// close the writer
writer.close();
writer = null;
}
// clear file ref
file = null;
}
/**
* Write all the queued items to the writer.
*/
public final void doWrites() {
QueuedData[] slice = null;
writeLock.lock();
try {
slice = queue.toArray(new QueuedData[0]);
if (queue.removeAll(Arrays.asList(slice))) {
log.debug("Queued writes transfered, count: {}", slice.length);
}
} finally {
writeLock.unlock();
}
// sort
Arrays.sort(slice);
// write
doWrites(slice);
}
/**
* Write a slice of the queued items to the writer.
*
* @param slice
* set of queued data
*/
public final void doWrites(QueuedData[] slice) {
// empty the queue
for (QueuedData queued : slice) {
int tmpTs = queued.getTimestamp();
if (lastWrittenTs <= tmpTs) {
if (queued.hasData()) {
// write the data
write(queued);
lastWrittenTs = tmpTs;
// clear the data, because we're done with it
queued.dispose();
} else {
if (log.isTraceEnabled()) {
log.trace("Queued data was not available");
}
}
} else {
// clear the data, since its too old
queued.dispose();
}
}
// clear and null-out
slice = null;
}
/**
* Write incoming data to the file.
*
* @param timestamp
* adjusted timestamp
* @param msg
* stream data
*/
private final void write(int timestamp, IRTMPEvent msg) {
// get data type
byte dataType = msg.getDataType();
log.debug("Write - timestamp: {} type: {}", timestamp, dataType);
// get data bytes
IoBuffer data = ((IStreamData) msg).getData();
if (data != null) {
// if the last message was a reset or we just started, use the header timer
if (startTimestamp == -1) {
startTimestamp = timestamp;
timestamp = 0;
} else {
timestamp -= startTimestamp;
}
// create a tag
ITag tag = ImmutableTag.build(dataType, timestamp, data, 0);
// only allow blank tags if they are of audio type
if (tag.getBodySize() > 0 || dataType == ITag.TYPE_AUDIO) {
try {
if (timestamp >= 0) {
if (!writer.writeTag(tag)) {
log.warn("Tag was not written");
}
} else {
log.warn("Skipping message with negative timestamp.");
}
} catch (IOException e) {
log.error("Error writing tag", e);
} finally {
if (data != null) {
data.clear();
data.free();
}
}
}
}
}
/**
* Adjust timestamp and write to the file.
*
* @param queued
* queued data for write
*/
private final void write(QueuedData queued) {
// get data type
byte dataType = queued.getDataType();
// get timestamp
int timestamp = queued.getTimestamp();
log.debug("Write - timestamp: {} type: {}", timestamp, dataType);
// get queued
ITag tag = queued.getData();
if (tag != null) {
// only allow blank tags if they are of audio type
if (tag.getBodySize() > 0 || dataType == ITag.TYPE_AUDIO) {
// if the last message was a reset or we just started, use the header timer
if (startTimestamp == -1) {
startTimestamp = timestamp;
timestamp = 0;
} else {
timestamp -= startTimestamp;
}
// update the timestamp
tag.setTimestamp(timestamp);
try {
if (timestamp >= 0) {
if (!writer.writeTag(tag)) {
log.warn("Tag was not written");
}
} else {
log.warn("Skipping message with negative timestamp.");
}
} catch (ClosedChannelException cce) {
// the channel we tried to write to is closed, we should not try
// again on that writer
log.error("The writer is no longer able to write to the file: {} writable: {}", file.getName(), file.canWrite());
} catch (IOException e) {
log.warn("Error writing tag", e);
if (e.getCause() instanceof ClosedChannelException) {
// the channel we tried to write to is closed, we should not
// try again on that writer
log.error("The writer is no longer able to write to the file: {} writable: {}", file.getName(), file.canWrite());
}
} finally {
queued.dispose();
}
}
}
}
/**
* Sets a video decoder configuration; some codecs require this, such as AVC.
*
* @param decoderConfig
* video codec configuration
*/
public void setVideoDecoderConfiguration(IRTMPEvent decoderConfig) {
if (decoderConfig instanceof IStreamData) {
IoBuffer data = ((IStreamData) decoderConfig).getData().asReadOnlyBuffer();
videoConfigurationTag = ImmutableTag.build(decoderConfig.getDataType(), 0, data, 0);
}
}
/**
* Sets a audio decoder configuration; some codecs require this, such as AAC.
*
* @param decoderConfig
* audio codec configuration
*/
public void setAudioDecoderConfiguration(IRTMPEvent decoderConfig) {
if (decoderConfig instanceof IStreamData) {
IoBuffer data = ((IStreamData) decoderConfig).getData().asReadOnlyBuffer();
audioConfigurationTag = ImmutableTag.build(decoderConfig.getDataType(), 0, data, 0);
}
}
/**
* Sets the scope for this consumer.
*
* @param scope
* scope
*/
public void setScope(IScope scope) {
this.scope = scope;
}
/**
* Sets the file we're writing to.
*
* @param file
* file
*/
public void setFile(File file) {
this.file = file;
}
/**
* Returns the file.
*
* @return file
*/
public File getFile() {
return file;
}
/**
* Sets the threshold for the queue. When the threshold is met a worker is spawned to empty the sorted queue to the writer.
*
* @param queueThreshold
* number of items to queue before spawning worker
*/
public void setQueueThreshold(int queueThreshold) {
this.queueThreshold = queueThreshold;
}
/**
* Returns the size of the delayed writing queue.
*
* @return queue length
*/
public int getQueueThreshold() {
return queueThreshold;
}
/**
* Whether or not the queue should be utilized.
*
* @return true if using the queue, false if sending directly to the writer
*/
public boolean isDelayWrite() {
return delayWrite;
}
/**
* Sets whether or not to use the queue.
*
* @param delayWrite
* true to use the queue, false if not
*/
public void setDelayWrite(boolean delayWrite) {
this.delayWrite = delayWrite;
}
/**
* @return the schedulerThreadSize
*/
public int getSchedulerThreadSize() {
return schedulerThreadSize;
}
/**
* @param schedulerThreadSize
* the schedulerThreadSize to set
*/
public void setSchedulerThreadSize(int schedulerThreadSize) {
this.schedulerThreadSize = schedulerThreadSize;
}
/**
* Sets the recording mode.
*
* @param mode
* either "record" or "append" depending on the type of action to perform
*/
public void setMode(String mode) {
this.mode = mode;
}
/**
* Queued data wrapper.
*/
private final static class QueuedData implements Comparable {
ITag tag;
QueuedData(int timestamp, byte dataType) {
this.tag = ImmutableTag.build(dataType, timestamp);
}
@SuppressWarnings("rawtypes")
QueuedData(int timestamp, byte dataType, IStreamData streamData) {
this.tag = ImmutableTag.build(dataType, timestamp, streamData.getData());
}
public int getTimestamp() {
return tag.getTimestamp();
}
public byte getDataType() {
return tag.getDataType();
}
public ITag getData() {
return tag;
}
public boolean hasData() {
return tag != null;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + tag.getDataType();
result = prime * result + tag.getTimestamp();
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
QueuedData other = (QueuedData) obj;
if (tag.getDataType() != other.getDataType()) {
return false;
}
if (tag.getTimestamp() != other.getTimestamp()) {
return false;
}
return true;
}
@Override
public int compareTo(QueuedData other) {
if (tag.getTimestamp() > other.getTimestamp()) {
return 1;
} else if (tag.getTimestamp() < other.getTimestamp()) {
return -1;
}
return 0;
}
public void dispose() {
tag = null;
}
}
@Override
public void destroy() throws Exception {
if (scheduledExecutorService != null) {
scheduledExecutorService.shutdown();
}
}
}