From cb7f04e4d3ff0a14dabb89ff828dde5a4703dc6b Mon Sep 17 00:00:00 2001 From: LukePulverenti Luke Pulverenti luke pulverenti Date: Wed, 29 Aug 2012 08:21:56 -0400 Subject: Upgraded Protobuf, and added api support for it --- MediaBrowser.Model/DTO/AudioInfo.cs | 12 +++- MediaBrowser.Model/DTO/DTOBaseItem.cs | 80 +++++++++++++++++++++--- MediaBrowser.Model/DTO/DTOUser.cs | 18 ++++++ MediaBrowser.Model/DTO/IBNItem.cs | 21 ++++++- MediaBrowser.Model/DTO/PluginInfo.cs | 13 ++++ MediaBrowser.Model/DTO/VideoInfo.cs | 13 ++++ MediaBrowser.Model/Entities/ItemSpecialCounts.cs | 11 +++- MediaBrowser.Model/Entities/UserItemData.cs | 5 ++ MediaBrowser.Model/Entities/Video.cs | 19 ++++++ MediaBrowser.Model/MediaBrowser.Model.csproj | 6 ++ 10 files changed, 186 insertions(+), 12 deletions(-) create mode 100644 MediaBrowser.Model/DTO/DTOUser.cs (limited to 'MediaBrowser.Model') diff --git a/MediaBrowser.Model/DTO/AudioInfo.cs b/MediaBrowser.Model/DTO/AudioInfo.cs index b9a1c4db3..9f7675e17 100644 --- a/MediaBrowser.Model/DTO/AudioInfo.cs +++ b/MediaBrowser.Model/DTO/AudioInfo.cs @@ -1,13 +1,23 @@ - +using ProtoBuf; + namespace MediaBrowser.Model.DTO { + [ProtoContract] public class AudioInfo { + [ProtoMember(1)] public int BitRate { get; set; } + + [ProtoMember(2)] public int Channels { get; set; } + [ProtoMember(3)] public string Artist { get; set; } + + [ProtoMember(4)] public string Album { get; set; } + + [ProtoMember(5)] public string AlbumArtist { get; set; } } } diff --git a/MediaBrowser.Model/DTO/DTOBaseItem.cs b/MediaBrowser.Model/DTO/DTOBaseItem.cs index 53d921d45..7e85cc84e 100644 --- a/MediaBrowser.Model/DTO/DTOBaseItem.cs +++ b/MediaBrowser.Model/DTO/DTOBaseItem.cs @@ -1,6 +1,7 @@ using System; using System.Collections.Generic; using MediaBrowser.Model.Entities; +using ProtoBuf; namespace MediaBrowser.Model.DTO { @@ -8,89 +9,151 @@ namespace MediaBrowser.Model.DTO /// This is strictly used as a data transfer object from the api layer. /// This holds information about a BaseItem in a format that is convenient for the client. /// + [ProtoContract] public class DTOBaseItem : IHasProviderIds { + [ProtoMember(1)] public string Name { get; set; } + + [ProtoMember(2)] public Guid Id { get; set; } + + [ProtoMember(3)] public DateTime DateCreated { get; set; } + [ProtoMember(4)] public string SortName { get; set; } + + [ProtoMember(5)] public DateTime? PremiereDate { get; set; } + + [ProtoMember(6)] public string Path { get; set; } + + [ProtoMember(7)] public string OfficialRating { get; set; } + + [ProtoMember(8)] public string Overview { get; set; } - public IEnumerable Taglines { get; set; } - public IEnumerable Genres { get; set; } + [ProtoMember(9)] + public IList Taglines { get; set; } + + [ProtoMember(10)] + public IList Genres { get; set; } + [ProtoMember(11)] public string DisplayMediaType { get; set; } + [ProtoMember(12)] public float? UserRating { get; set; } + + [ProtoMember(13)] public long? RunTimeTicks { get; set; } + [ProtoMember(14)] public string AspectRatio { get; set; } + + [ProtoMember(15)] public int? ProductionYear { get; set; } + [ProtoMember(16)] public int? IndexNumber { get; set; } + + [ProtoMember(17)] public int? ParentIndexNumber { get; set; } + [ProtoMember(18)] public string TrailerUrl { get; set; } + [ProtoMember(19)] public Dictionary ProviderIds { get; set; } + [ProtoMember(20)] public bool HasBanner { get; set; } + + [ProtoMember(21)] public bool HasArt { get; set; } + + [ProtoMember(22)] public bool HasLogo { get; set; } + + [ProtoMember(23)] public bool HasThumb { get; set; } + + [ProtoMember(24)] public bool HasPrimaryImage { get; set; } + [ProtoMember(25)] public string Language { get; set; } - + + [ProtoMember(26)] public int BackdropCount { get; set; } - public IEnumerable Children { get; set; } + [ProtoMember(27)] + public DTOBaseItem[] Children { get; set; } + [ProtoMember(28)] public bool IsFolder { get; set; } /// /// If the item is a Folder this will determine if it's the Root or not /// + [ProtoMember(29)] public bool? IsRoot { get; set; } /// /// If the item is a Folder this will determine if it's a VF or not /// + [ProtoMember(30)] public bool? IsVirtualFolder { get; set; } - + + [ProtoMember(31)] public Guid? ParentId { get; set; } + [ProtoMember(32)] public string Type { get; set; } - public IEnumerable People { get; set; } - public IEnumerable Studios { get; set; } + [ProtoMember(33)] + public BaseItemPerson[] People { get; set; } + + [ProtoMember(34)] + public BaseItemStudio[] Studios { get; set; } /// /// If the item does not have a logo, this will hold the Id of the Parent that has one. /// + [ProtoMember(35)] public Guid? ParentLogoItemId { get; set; } /// /// If the item does not have any backdrops, this will hold the Id of the Parent that has one. /// + [ProtoMember(36)] public Guid? ParentBackdropItemId { get; set; } + + [ProtoMember(37)] public int? ParentBackdropCount { get; set; } - public IEnumerable LocalTrailers { get; set; } + [ProtoMember(38)] + public DTOBaseItem[] LocalTrailers { get; set; } + + [ProtoMember(39)] public int LocalTrailerCount { get; set; } /// /// User data for this item based on the user it's being requested for /// + [ProtoMember(40)] public UserItemData UserData { get; set; } + [ProtoMember(41)] public ItemSpecialCounts SpecialCounts { get; set; } + [ProtoMember(42)] public AudioInfo AudioInfo { get; set; } + + [ProtoMember(43)] public VideoInfo VideoInfo { get; set; } public bool IsType(Type type) @@ -103,6 +166,7 @@ namespace MediaBrowser.Model.DTO return Type.Equals(type, StringComparison.OrdinalIgnoreCase); } + [ProtoMember(44)] public bool IsNew { get; set; } } } diff --git a/MediaBrowser.Model/DTO/DTOUser.cs b/MediaBrowser.Model/DTO/DTOUser.cs new file mode 100644 index 000000000..512985731 --- /dev/null +++ b/MediaBrowser.Model/DTO/DTOUser.cs @@ -0,0 +1,18 @@ +using System; +using ProtoBuf; + +namespace MediaBrowser.Model.DTO +{ + [ProtoContract] + public class DTOUser + { + [ProtoMember(1)] + public string Name { get; set; } + + [ProtoMember(2)] + public Guid Id { get; set; } + + [ProtoMember(3)] + public bool HasImage { get; set; } + } +} diff --git a/MediaBrowser.Model/DTO/IBNItem.cs b/MediaBrowser.Model/DTO/IBNItem.cs index fa5d72c85..588fe26d6 100644 --- a/MediaBrowser.Model/DTO/IBNItem.cs +++ b/MediaBrowser.Model/DTO/IBNItem.cs @@ -1,48 +1,65 @@ -using MediaBrowser.Model.Entities; -using System; +using System; +using ProtoBuf; namespace MediaBrowser.Model.DTO { /// /// This is a stub class used by the api to get IBN types along with their item counts /// + [ProtoContract] public class IBNItem { /// /// The name of the person, genre, etc /// + [ProtoMember(1)] public string Name { get; set; } /// /// The id of the person, genre, etc /// + [ProtoMember(2)] public Guid Id { get; set; } + [ProtoMember(3)] public bool HasImage { get; set; } /// /// The number of items that have the genre, year, studio, etc /// + [ProtoMember(4)] public int BaseItemCount { get; set; } } /// /// This is used by the api to get information about a Person within a BaseItem /// + [ProtoContract] public class BaseItemPerson { + [ProtoMember(1)] public string Name { get; set; } + + [ProtoMember(2)] public string Overview { get; set; } + + [ProtoMember(3)] public string Type { get; set; } + + [ProtoMember(4)] public bool HasImage { get; set; } } /// /// This is used by the api to get information about a studio within a BaseItem /// + [ProtoContract] public class BaseItemStudio { + [ProtoMember(1)] public string Name { get; set; } + + [ProtoMember(2)] public bool HasImage { get; set; } } } diff --git a/MediaBrowser.Model/DTO/PluginInfo.cs b/MediaBrowser.Model/DTO/PluginInfo.cs index 76e9026a6..9560b4d8b 100644 --- a/MediaBrowser.Model/DTO/PluginInfo.cs +++ b/MediaBrowser.Model/DTO/PluginInfo.cs @@ -1,17 +1,30 @@ using System; +using ProtoBuf; namespace MediaBrowser.Model.DTO { /// /// This is a serializable stub class that is used by the api to provide information about installed plugins. /// + [ProtoContract] public class PluginInfo { + [ProtoMember(1)] public string Name { get; set; } + + [ProtoMember(2)] public string Path { get; set; } + + [ProtoMember(3)] public bool Enabled { get; set; } + + [ProtoMember(4)] public bool DownloadToUI { get; set; } + + [ProtoMember(5)] public DateTime ConfigurationDateLastModified { get; set; } + + [ProtoMember(6)] public Version Version { get; set; } } } diff --git a/MediaBrowser.Model/DTO/VideoInfo.cs b/MediaBrowser.Model/DTO/VideoInfo.cs index 5cff413f2..d55d06626 100644 --- a/MediaBrowser.Model/DTO/VideoInfo.cs +++ b/MediaBrowser.Model/DTO/VideoInfo.cs @@ -1,18 +1,31 @@ using System.Collections.Generic; using MediaBrowser.Model.Entities; +using ProtoBuf; namespace MediaBrowser.Model.DTO { + [ProtoContract] public class VideoInfo { + [ProtoMember(1)] public string Codec { get; set; } + + [ProtoMember(2)] public int Height { get; set; } + + [ProtoMember(3)] public int Width { get; set; } + + [ProtoMember(4)] public string ScanType { get; set; } + [ProtoMember(5)] public VideoType VideoType { get; set; } + [ProtoMember(6)] public IEnumerable Subtitles { get; set; } + + [ProtoMember(7)] public IEnumerable AudioStreams { get; set; } } } diff --git a/MediaBrowser.Model/Entities/ItemSpecialCounts.cs b/MediaBrowser.Model/Entities/ItemSpecialCounts.cs index d5989ef1d..b57be6ca8 100644 --- a/MediaBrowser.Model/Entities/ItemSpecialCounts.cs +++ b/MediaBrowser.Model/Entities/ItemSpecialCounts.cs @@ -1,14 +1,23 @@ - +using ProtoBuf; + namespace MediaBrowser.Model.Entities { /// /// Since it can be slow to collect this data, this class helps provide a way to calculate them all at once. /// + [ProtoContract] public class ItemSpecialCounts { + [ProtoMember(1)] public int RecentlyAddedItemCount { get; set; } + + [ProtoMember(2)] public int RecentlyAddedUnPlayedItemCount { get; set; } + + [ProtoMember(3)] public int InProgressItemCount { get; set; } + + [ProtoMember(4)] public decimal PlayedPercentage { get; set; } } } diff --git a/MediaBrowser.Model/Entities/UserItemData.cs b/MediaBrowser.Model/Entities/UserItemData.cs index 817cf640e..d7b692014 100644 --- a/MediaBrowser.Model/Entities/UserItemData.cs +++ b/MediaBrowser.Model/Entities/UserItemData.cs @@ -1,13 +1,18 @@ using System; +using ProtoBuf; namespace MediaBrowser.Model.Entities { + [ProtoContract] public class UserItemData { + [ProtoMember(1)] public UserItemRating Rating { get; set; } + [ProtoMember(2)] public long PlaybackPositionTicks { get; set; } + [ProtoMember(3)] public int PlayCount { get; set; } } diff --git a/MediaBrowser.Model/Entities/Video.cs b/MediaBrowser.Model/Entities/Video.cs index 874b033ac..5d0e06202 100644 --- a/MediaBrowser.Model/Entities/Video.cs +++ b/MediaBrowser.Model/Entities/Video.cs @@ -1,4 +1,5 @@ using System.Collections.Generic; +using ProtoBuf; namespace MediaBrowser.Model.Entities { @@ -17,20 +18,38 @@ namespace MediaBrowser.Model.Entities public string Codec { get; set; } } + [ProtoContract] public class AudioStream { + [ProtoMember(1)] public string Codec { get; set; } + + [ProtoMember(2)] public string Language { get; set; } + + [ProtoMember(3)] public int BitRate { get; set; } + + [ProtoMember(4)] public int Channels { get; set; } + + [ProtoMember(5)] public int SampleRate { get; set; } + + [ProtoMember(6)] public bool IsDefault { get; set; } } + [ProtoContract] public class SubtitleStream { + [ProtoMember(1)] public string Language { get; set; } + + [ProtoMember(2)] public bool IsDefault { get; set; } + + [ProtoMember(2)] public bool IsForced { get; set; } } diff --git a/MediaBrowser.Model/MediaBrowser.Model.csproj b/MediaBrowser.Model/MediaBrowser.Model.csproj index 38acd3b03..9d9ae9f5f 100644 --- a/MediaBrowser.Model/MediaBrowser.Model.csproj +++ b/MediaBrowser.Model/MediaBrowser.Model.csproj @@ -34,6 +34,7 @@ + @@ -56,6 +57,11 @@ + + + ..\packages\protobuf-net.2.0.0.580\lib\sl4\protobuf-net.dll + +