Added GetVideoStreamUrl to ApiClient

This commit is contained in:
LukePulverenti Luke Pulverenti luke pulverenti 2012-09-09 11:15:22 -04:00
parent 86f162fd7c
commit 8e9571e828
8 changed files with 181 additions and 37 deletions

View File

@ -1,7 +1,6 @@
using MediaBrowser.Common.Net.Handlers; using MediaBrowser.Common.Net.Handlers;
using MediaBrowser.Model.DTO; using MediaBrowser.Model.DTO;
using MediaBrowser.Model.Entities; using MediaBrowser.Model.Entities;
using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.ComponentModel.Composition; using System.ComponentModel.Composition;
using System.IO; using System.IO;
@ -27,7 +26,7 @@ namespace MediaBrowser.Api.HttpHandlers
{ {
get get
{ {
return new AudioOutputFormats[] { AudioOutputFormats.Aac, AudioOutputFormats.Flac, AudioOutputFormats.Wav, AudioOutputFormats.Wma }; return new AudioOutputFormats[] { AudioOutputFormats.Aac, AudioOutputFormats.Flac, AudioOutputFormats.Wma };
} }
} }

View File

@ -83,7 +83,7 @@ namespace MediaBrowser.Api.HttpHandlers
if (string.IsNullOrEmpty(val)) if (string.IsNullOrEmpty(val))
{ {
return null; return 44100;
} }
return int.Parse(val); return int.Parse(val);

View File

@ -1,5 +1,6 @@
using MediaBrowser.Common.Drawing; using MediaBrowser.Common.Drawing;
using MediaBrowser.Common.Net.Handlers; using MediaBrowser.Common.Net.Handlers;
using MediaBrowser.Model.DTO;
using MediaBrowser.Model.Entities; using MediaBrowser.Model.Entities;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
@ -15,7 +16,7 @@ namespace MediaBrowser.Api.HttpHandlers
/// Supported output formats: mkv,m4v,mp4,asf,wmv,mov,webm,ogv,3gp,avi,ts,flv /// Supported output formats: mkv,m4v,mp4,asf,wmv,mov,webm,ogv,3gp,avi,ts,flv
/// </summary> /// </summary>
[Export(typeof(BaseHandler))] [Export(typeof(BaseHandler))]
class VideoHandler : BaseMediaHandler<Video, string> class VideoHandler : BaseMediaHandler<Video, VideoOutputFormats>
{ {
public override bool HandlesRequest(HttpListenerRequest request) public override bool HandlesRequest(HttpListenerRequest request)
{ {
@ -25,17 +26,20 @@ namespace MediaBrowser.Api.HttpHandlers
/// <summary> /// <summary>
/// We can output these files directly, but we can't encode them /// We can output these files directly, but we can't encode them
/// </summary> /// </summary>
protected override IEnumerable<string> UnsupportedOutputEncodingFormats protected override IEnumerable<VideoOutputFormats> UnsupportedOutputEncodingFormats
{ {
get get
{ {
// mp4, 3gp, mov - muxer does not support non-seekable output // mp4, 3gp, mov - muxer does not support non-seekable output
// avi, mov, mkv, m4v - can't stream these when encoding. the player will try to download them completely before starting playback. // avi, mov, mkv, m4v - can't stream these when encoding. the player will try to download them completely before starting playback.
// wmv - can't seem to figure out the output format name // wmv - can't seem to figure out the output format name
return new string[] { "mp4", "3gp", "m4v", "mkv", "avi", "mov", "wmv" }; return new VideoOutputFormats[] { VideoOutputFormats.Mp4, VideoOutputFormats.ThreeGP, VideoOutputFormats.M4v, VideoOutputFormats.Mkv, VideoOutputFormats.Avi, VideoOutputFormats.Mov, VideoOutputFormats.Wmv };
} }
} }
/// <summary>
/// Determines whether or not we can just output the original file directly
/// </summary>
protected override bool RequiresConversion() protected override bool RequiresConversion()
{ {
string currentFormat = Path.GetExtension(LibraryItem.Path).Replace(".", string.Empty); string currentFormat = Path.GetExtension(LibraryItem.Path).Replace(".", string.Empty);
@ -52,11 +56,13 @@ namespace MediaBrowser.Api.HttpHandlers
return true; return true;
} }
// See if the video requires conversion
if (RequiresVideoConversion()) if (RequiresVideoConversion())
{ {
return true; return true;
} }
// See if the audio requires conversion
AudioStream audioStream = (LibraryItem.AudioStreams ?? new List<AudioStream>()).FirstOrDefault(); AudioStream audioStream = (LibraryItem.AudioStreams ?? new List<AudioStream>()).FirstOrDefault();
if (audioStream != null) if (audioStream != null)
@ -72,24 +78,24 @@ namespace MediaBrowser.Api.HttpHandlers
} }
/// <summary> /// <summary>
/// Translates the file extension to the format param that follows "-f" on the ffmpeg command line /// Translates the output file extension to the format param that follows "-f" on the ffmpeg command line
/// </summary> /// </summary>
private string GetFFMpegOutputFormat(string outputFormat) private string GetFFMpegOutputFormat(VideoOutputFormats outputFormat)
{ {
if (outputFormat.Equals("mkv", StringComparison.OrdinalIgnoreCase)) if (outputFormat == VideoOutputFormats.Mkv)
{ {
return "matroska"; return "matroska";
} }
else if (outputFormat.Equals("ts", StringComparison.OrdinalIgnoreCase)) else if (outputFormat == VideoOutputFormats.Ts)
{ {
return "mpegts"; return "mpegts";
} }
else if (outputFormat.Equals("ogv", StringComparison.OrdinalIgnoreCase)) else if (outputFormat == VideoOutputFormats.Ogv)
{ {
return "ogg"; return "ogg";
} }
return outputFormat; return outputFormat.ToString().ToLower();
} }
/// <summary> /// <summary>
@ -99,7 +105,7 @@ namespace MediaBrowser.Api.HttpHandlers
{ {
List<string> audioTranscodeParams = new List<string>(); List<string> audioTranscodeParams = new List<string>();
string outputFormat = GetConversionOutputFormat(); VideoOutputFormats outputFormat = GetConversionOutputFormat();
return string.Format("-i \"{0}\" -threads 0 {1} {2} -f {3} -", return string.Format("-i \"{0}\" -threads 0 {1} {2} -f {3} -",
LibraryItem.Path, LibraryItem.Path,
@ -109,14 +115,20 @@ namespace MediaBrowser.Api.HttpHandlers
); );
} }
private string GetVideoArguments(string outputFormat) /// <summary>
/// Gets video arguments to pass to ffmpeg
/// </summary>
private string GetVideoArguments(VideoOutputFormats outputFormat)
{ {
// Get the output codec name
string codec = GetVideoCodec(outputFormat); string codec = GetVideoCodec(outputFormat);
string args = "-vcodec " + codec; string args = "-vcodec " + codec;
// If we're encoding video, add additional params
if (!codec.Equals("copy", StringComparison.OrdinalIgnoreCase)) if (!codec.Equals("copy", StringComparison.OrdinalIgnoreCase))
{ {
// Add resolution params, if specified
if (Width.HasValue || Height.HasValue || MaxHeight.HasValue || MaxWidth.HasValue) if (Width.HasValue || Height.HasValue || MaxHeight.HasValue || MaxWidth.HasValue)
{ {
Size size = DrawingUtils.Resize(LibraryItem.Width, LibraryItem.Height, Width, Height, MaxWidth, MaxHeight); Size size = DrawingUtils.Resize(LibraryItem.Width, LibraryItem.Height, Width, Height, MaxWidth, MaxHeight);
@ -128,21 +140,28 @@ namespace MediaBrowser.Api.HttpHandlers
return args; return args;
} }
private string GetAudioArguments(string outputFormat) /// <summary>
/// Gets audio arguments to pass to ffmpeg
/// </summary>
private string GetAudioArguments(VideoOutputFormats outputFormat)
{ {
AudioStream audioStream = (LibraryItem.AudioStreams ?? new List<AudioStream>()).FirstOrDefault(); AudioStream audioStream = (LibraryItem.AudioStreams ?? new List<AudioStream>()).FirstOrDefault();
// If the video doesn't have an audio stream, return empty
if (audioStream == null) if (audioStream == null)
{ {
return string.Empty; return string.Empty;
} }
// Get the output codec name
string codec = GetAudioCodec(audioStream, outputFormat); string codec = GetAudioCodec(audioStream, outputFormat);
string args = "-acodec " + codec; string args = "-acodec " + codec;
// If we're encoding audio, add additional params
if (!codec.Equals("copy", StringComparison.OrdinalIgnoreCase)) if (!codec.Equals("copy", StringComparison.OrdinalIgnoreCase))
{ {
// Add the number of audio channels
int? channels = GetNumAudioChannelsParam(codec, audioStream.Channels); int? channels = GetNumAudioChannelsParam(codec, audioStream.Channels);
if (channels.HasValue) if (channels.HasValue)
@ -150,6 +169,7 @@ namespace MediaBrowser.Api.HttpHandlers
args += " -ac " + channels.Value; args += " -ac " + channels.Value;
} }
// Add the audio sample rate
int? sampleRate = GetSampleRateParam(audioStream.SampleRate); int? sampleRate = GetSampleRateParam(audioStream.SampleRate);
if (sampleRate.HasValue) if (sampleRate.HasValue)
@ -162,26 +182,32 @@ namespace MediaBrowser.Api.HttpHandlers
return args; return args;
} }
private string GetVideoCodec(string outputFormat) /// <summary>
/// Gets the name of the output video codec
/// </summary>
private string GetVideoCodec(VideoOutputFormats outputFormat)
{ {
if (outputFormat.Equals("webm")) // Some output containers require specific codecs
if (outputFormat == VideoOutputFormats.Webm)
{ {
// Per webm specification, it must be vpx // Per webm specification, it must be vpx
return "libvpx"; return "libvpx";
} }
else if (outputFormat.Equals("asf")) else if (outputFormat == VideoOutputFormats.Asf)
{ {
return "wmv2"; return "wmv2";
} }
else if (outputFormat.Equals("wmv")) else if (outputFormat == VideoOutputFormats.Wmv)
{ {
return "wmv2"; return "wmv2";
} }
else if (outputFormat.Equals("ogv")) else if (outputFormat == VideoOutputFormats.Ogv)
{ {
return "libtheora"; return "libtheora";
} }
// Skip encoding when possible
if (!RequiresVideoConversion()) if (!RequiresVideoConversion())
{ {
return "copy"; return "copy";
@ -190,27 +216,32 @@ namespace MediaBrowser.Api.HttpHandlers
return "libx264"; return "libx264";
} }
private string GetAudioCodec(AudioStream audioStream, string outputFormat) /// <summary>
/// Gets the name of the output audio codec
/// </summary>
private string GetAudioCodec(AudioStream audioStream, VideoOutputFormats outputFormat)
{ {
if (outputFormat.Equals("webm")) // Some output containers require specific codecs
if (outputFormat == VideoOutputFormats.Webm)
{ {
// Per webm specification, it must be vorbis // Per webm specification, it must be vorbis
return "libvorbis"; return "libvorbis";
} }
else if (outputFormat.Equals("asf")) else if (outputFormat == VideoOutputFormats.Asf)
{ {
return "wmav2"; return "wmav2";
} }
else if (outputFormat.Equals("wmv")) else if (outputFormat == VideoOutputFormats.Wmv)
{ {
return "wmav2"; return "wmav2";
} }
else if (outputFormat.Equals("ogv")) else if (outputFormat == VideoOutputFormats.Ogv)
{ {
return "libvorbis"; return "libvorbis";
} }
// See if we can just copy the stream // Skip encoding when possible
if (!RequiresAudioConversion(audioStream)) if (!RequiresAudioConversion(audioStream))
{ {
return "copy"; return "copy";
@ -219,6 +250,9 @@ namespace MediaBrowser.Api.HttpHandlers
return "libvo_aacenc"; return "libvo_aacenc";
} }
/// <summary>
/// Gets the number of audio channels to specify on the command line
/// </summary>
private int? GetNumAudioChannelsParam(string audioCodec, int libraryItemChannels) private int? GetNumAudioChannelsParam(string audioCodec, int libraryItemChannels)
{ {
if (libraryItemChannels > 2) if (libraryItemChannels > 2)
@ -238,9 +272,14 @@ namespace MediaBrowser.Api.HttpHandlers
return GetNumAudioChannelsParam(libraryItemChannels); return GetNumAudioChannelsParam(libraryItemChannels);
} }
/// <summary>
/// Determines if the video stream requires encoding
/// </summary>
private bool RequiresVideoConversion() private bool RequiresVideoConversion()
{ {
// Check dimensions // Check dimensions
// If a specific width is required, validate that
if (Width.HasValue) if (Width.HasValue)
{ {
if (Width.Value != LibraryItem.Width) if (Width.Value != LibraryItem.Width)
@ -248,6 +287,8 @@ namespace MediaBrowser.Api.HttpHandlers
return true; return true;
} }
} }
// If a specific height is required, validate that
if (Height.HasValue) if (Height.HasValue)
{ {
if (Height.Value != LibraryItem.Height) if (Height.Value != LibraryItem.Height)
@ -255,6 +296,8 @@ namespace MediaBrowser.Api.HttpHandlers
return true; return true;
} }
} }
// If a max width is required, validate that
if (MaxWidth.HasValue) if (MaxWidth.HasValue)
{ {
if (MaxWidth.Value < LibraryItem.Width) if (MaxWidth.Value < LibraryItem.Width)
@ -262,6 +305,8 @@ namespace MediaBrowser.Api.HttpHandlers
return true; return true;
} }
} }
// If a max height is required, validate that
if (MaxHeight.HasValue) if (MaxHeight.HasValue)
{ {
if (MaxHeight.Value < LibraryItem.Height) if (MaxHeight.Value < LibraryItem.Height)
@ -270,6 +315,7 @@ namespace MediaBrowser.Api.HttpHandlers
} }
} }
// If the codec is already h264, don't encode
if (LibraryItem.Codec.IndexOf("264", StringComparison.OrdinalIgnoreCase) != -1 || LibraryItem.Codec.IndexOf("avc", StringComparison.OrdinalIgnoreCase) != -1) if (LibraryItem.Codec.IndexOf("264", StringComparison.OrdinalIgnoreCase) != -1 || LibraryItem.Codec.IndexOf("avc", StringComparison.OrdinalIgnoreCase) != -1)
{ {
return false; return false;
@ -278,8 +324,13 @@ namespace MediaBrowser.Api.HttpHandlers
return false; return false;
} }
/// <summary>
/// Determines if the audio stream requires encoding
/// </summary>
private bool RequiresAudioConversion(AudioStream audio) private bool RequiresAudioConversion(AudioStream audio)
{ {
// If the input stream has more audio channels than the client can handle, we need to encode
if (AudioChannels.HasValue) if (AudioChannels.HasValue)
{ {
if (audio.Channels > AudioChannels.Value) if (audio.Channels > AudioChannels.Value)
@ -288,14 +339,18 @@ namespace MediaBrowser.Api.HttpHandlers
} }
} }
// Aac, ac-3 and mp3 are all pretty much universally supported. No need to encode them
if (audio.Codec.IndexOf("aac", StringComparison.OrdinalIgnoreCase) != -1) if (audio.Codec.IndexOf("aac", StringComparison.OrdinalIgnoreCase) != -1)
{ {
return false; return false;
} }
if (audio.Codec.IndexOf("ac-3", StringComparison.OrdinalIgnoreCase) != -1 || audio.Codec.IndexOf("ac3", StringComparison.OrdinalIgnoreCase) != -1) if (audio.Codec.IndexOf("ac-3", StringComparison.OrdinalIgnoreCase) != -1 || audio.Codec.IndexOf("ac3", StringComparison.OrdinalIgnoreCase) != -1)
{ {
return false; return false;
} }
if (audio.Codec.IndexOf("mpeg", StringComparison.OrdinalIgnoreCase) != -1 || audio.Codec.IndexOf("mp3", StringComparison.OrdinalIgnoreCase) != -1) if (audio.Codec.IndexOf("mpeg", StringComparison.OrdinalIgnoreCase) != -1 || audio.Codec.IndexOf("mp3", StringComparison.OrdinalIgnoreCase) != -1)
{ {
return false; return false;
@ -304,6 +359,9 @@ namespace MediaBrowser.Api.HttpHandlers
return true; return true;
} }
/// <summary>
/// Gets the fixed output video height, in pixels
/// </summary>
private int? Height private int? Height
{ {
get get
@ -319,6 +377,9 @@ namespace MediaBrowser.Api.HttpHandlers
} }
} }
/// <summary>
/// Gets the fixed output video width, in pixels
/// </summary>
private int? Width private int? Width
{ {
get get
@ -334,6 +395,9 @@ namespace MediaBrowser.Api.HttpHandlers
} }
} }
/// <summary>
/// Gets the maximum output video height, in pixels
/// </summary>
private int? MaxHeight private int? MaxHeight
{ {
get get
@ -349,6 +413,9 @@ namespace MediaBrowser.Api.HttpHandlers
} }
} }
/// <summary>
/// Gets the maximum output video width, in pixels
/// </summary>
private int? MaxWidth private int? MaxWidth
{ {
get get

View File

@ -356,27 +356,83 @@ namespace MediaBrowser.ApiInteraction
/// </summary> /// </summary>
/// <param name="itemId">The id of the item</param> /// <param name="itemId">The id of the item</param>
/// <param name="supportedOutputFormats">List all the output formats the decice is capable of playing. The more, the better, as it will decrease the likelyhood of having to encode, which will put a load on the server.</param> /// <param name="supportedOutputFormats">List all the output formats the decice is capable of playing. The more, the better, as it will decrease the likelyhood of having to encode, which will put a load on the server.</param>
/// <param name="maxChannels">The maximum number of channels that the device can play. Omit this if it doesn't matter. Phones and tablets should generally specify 2.</param> /// <param name="maxAudioChannels">The maximum number of channels that the device can play. Omit this if it doesn't matter. Phones and tablets should generally specify 2.</param>
/// <param name="maxSampleRate">The maximum sample rate that the device can play. This should generally be omitted. If there's a problem, try 44100.</param> /// <param name="maxAudioSampleRate">The maximum sample rate that the device can play. This should generally be omitted. The server will default this to 44100, so only override if a different max is needed.</param>
public string GetAudioStreamUrl(Guid itemId, IEnumerable<AudioOutputFormats> supportedOutputFormats, int? maxChannels = null, int? maxSampleRate = null) public string GetAudioStreamUrl(Guid itemId, IEnumerable<AudioOutputFormats> supportedOutputFormats, int? maxAudioChannels = null, int? maxAudioSampleRate = null)
{ {
string url = ApiUrl + "/audio"; string url = ApiUrl + "/audio";
url += "?outputformats=" + string.Join(",", supportedOutputFormats.Select(s => s.ToString()).ToArray()); url += "?outputformats=" + string.Join(",", supportedOutputFormats.Select(s => s.ToString()).ToArray());
if (maxChannels.HasValue) if (maxAudioChannels.HasValue)
{ {
url += "&audiochannels=" + maxChannels.Value; url += "&audiochannels=" + maxAudioChannels.Value;
} }
if (maxSampleRate.HasValue) if (maxAudioSampleRate.HasValue)
{ {
url += "&audiosamplerate=" + maxSampleRate.Value; url += "&audiosamplerate=" + maxAudioSampleRate.Value;
} }
return url; return url;
} }
/// <summary>
/// Gets the url needed to stream a video file
/// </summary>
/// <param name="itemId">The id of the item</param>
/// <param name="supportedOutputFormats">List all the output formats the decice is capable of playing. The more, the better, as it will decrease the likelyhood of having to encode, which will put a load on the server.</param>
/// <param name="maxAudioChannels">The maximum number of channels that the device can play. Omit this if it doesn't matter. Phones and tablets should generally specify 2.</param>
/// <param name="maxAudioSampleRate">The maximum sample rate that the device can play. This should generally be omitted. The server will default this to 44100, so only override if a different max is needed.</param>
/// <param name="width">Specify this is a fixed video width is required</param>
/// <param name="height">Specify this is a fixed video height is required</param>
/// <param name="maxWidth">Specify this is a max video width is required</param>
/// <param name="maxHeight">Specify this is a max video height is required</param>
public string GetVideoStreamUrl(Guid itemId,
IEnumerable<VideoOutputFormats> supportedOutputFormats,
int? maxAudioChannels = null,
int? maxAudioSampleRate = null,
int? width = null,
int? height = null,
int? maxWidth = null,
int? maxHeight = null)
{
string url = ApiUrl + "/video";
url += "?outputformats=" + string.Join(",", supportedOutputFormats.Select(s => s.ToString()).ToArray());
if (maxAudioChannels.HasValue)
{
url += "&audiochannels=" + maxAudioChannels.Value;
}
if (maxAudioSampleRate.HasValue)
{
url += "&audiosamplerate=" + maxAudioSampleRate.Value;
}
if (width.HasValue)
{
url += "&width=" + width.Value;
}
if (height.HasValue)
{
url += "&height=" + height.Value;
}
if (maxWidth.HasValue)
{
url += "&maxWidth=" + maxWidth.Value;
}
if (maxHeight.HasValue)
{
url += "&maxHeight=" + maxHeight.Value;
}
return url;
}
protected T DeserializeFromStream<T>(Stream stream) protected T DeserializeFromStream<T>(Stream stream)
where T : class where T : class
{ {

View File

@ -1,7 +1,7 @@
using System.ComponentModel.Composition; using MediaBrowser.Controller.Library;
using System.IO;
using MediaBrowser.Controller.Library;
using MediaBrowser.Model.Entities; using MediaBrowser.Model.Entities;
using System.ComponentModel.Composition;
using System.IO;
namespace MediaBrowser.Controller.Resolvers namespace MediaBrowser.Controller.Resolvers
{ {

View File

@ -10,7 +10,6 @@ namespace MediaBrowser.Model.DTO
Aac, Aac,
Flac, Flac,
Mp3, Mp3,
Wav,
Wma Wma
} }
} }

View File

@ -0,0 +1,22 @@

namespace MediaBrowser.Model.DTO
{
/// <summary>
/// These are the audio output formats that the api is cabaple of streaming
/// This does not limit the inputs, only the outputs.
/// </summary>
public enum VideoOutputFormats
{
Avi,
Asf,
M4v,
Mkv,
Mov,
Mp4,
Ogv,
ThreeGP,
Ts,
Webm,
Wmv
}
}

View File

@ -41,6 +41,7 @@
<Compile Include="DTO\DTOBaseItem.cs" /> <Compile Include="DTO\DTOBaseItem.cs" />
<Compile Include="DTO\DTOUser.cs" /> <Compile Include="DTO\DTOUser.cs" />
<Compile Include="DTO\VideoInfo.cs" /> <Compile Include="DTO\VideoInfo.cs" />
<Compile Include="DTO\VideoOutputFormats.cs" />
<Compile Include="Entities\Audio.cs" /> <Compile Include="Entities\Audio.cs" />
<Compile Include="Entities\BaseEntity.cs" /> <Compile Include="Entities\BaseEntity.cs" />
<Compile Include="Entities\BaseItem.cs" /> <Compile Include="Entities\BaseItem.cs" />