Release 4.0.0-preview1-00235
[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia / MediaTool / MediaPacketVideoPlane.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 using System;
18 using System.Diagnostics;
19
20 namespace Tizen.Multimedia
21 {
22     /// <summary>
23     /// Represents a video plane for the <see cref="MediaPacket"/>.
24     /// This class is used if and only if the format of the packet is the raw video.
25     /// </summary>
26     public class MediaPacketVideoPlane
27     {
28         private readonly MediaPacket _packet;
29         private readonly int _strideWidth;
30         private readonly int _strideHeight;
31         private readonly IMediaBuffer _buffer;
32
33         internal MediaPacketVideoPlane(MediaPacket packet, int index)
34         {
35             Debug.Assert(packet != null, "The packet is null!");
36             Debug.Assert(!packet.IsDisposed, "Packet is already disposed!");
37             Debug.Assert(index >= 0, "Video plane index must not be negative!");
38
39             _packet = packet;
40
41             int ret = Interop.MediaPacket.GetVideoStrideWidth(packet.GetHandle(), index, out _strideWidth);
42             MultimediaDebug.AssertNoError(ret);
43
44             ret = Interop.MediaPacket.GetVideoStrideWidth(packet.GetHandle(), index, out _strideHeight);
45             MultimediaDebug.AssertNoError(ret);
46
47             Debug.Assert(_strideWidth >= 0 && _strideHeight >= 0, "size must not be negative!");
48
49             IntPtr dataHandle;
50             ret = Interop.MediaPacket.GetVideoPlaneData(packet.GetHandle(), index, out dataHandle);
51             MultimediaDebug.AssertNoError(ret);
52
53             Debug.Assert(dataHandle != IntPtr.Zero, "Data handle is invalid!");
54
55             _buffer = new DependentMediaBuffer(packet, dataHandle, _strideWidth * _strideHeight);
56         }
57
58         /// <summary>
59         /// Gets the buffer of the current video plane.
60         /// </summary>
61         /// <exception cref="ObjectDisposedException">The MediaPacket that owns the current buffer has already been disposed of.</exception>
62         public IMediaBuffer Buffer
63         {
64             get
65             {
66                 _packet.EnsureReadableState();
67                 return _buffer;
68             }
69         }
70
71         /// <summary>
72         /// Gets the stride width of the current video plane.
73         /// </summary>
74         /// <exception cref="ObjectDisposedException">The MediaPacket that owns the current buffer has already been disposed of.</exception>
75         public int StrideWidth
76         {
77             get
78             {
79                 _packet.EnsureReadableState();
80                 return _strideWidth;
81             }
82         }
83
84         /// <summary>
85         /// Gets the stride height of the current video plane.
86         /// </summary>
87         /// <exception cref="ObjectDisposedException">The MediaPacket that owns the current buffer has already been disposed of.</exception>
88         public int StrideHeight
89         {
90             get
91             {
92                 _packet.EnsureReadableState();
93                 return _strideHeight;
94             }
95         }
96     }
97 }