shaka-packager/docs/df/df8/subsample__generator_8h_sou...

174 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/crypto/subsample_generator.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html">packager</a></li><li class="navelem"><a class="el" href="../../dir_f99dae54fe7170f791f339b952d5067a.html">media</a></li><li class="navelem"><a class="el" href="../../dir_aa847bee70cdde822696c7e33a504139.html">crypto</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">subsample_generator.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2018 Google LLC. All rights reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Use of this source code is governed by a BSD-style</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// license that can be found in the LICENSE file or at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// https://developers.google.com/open-source/licenses/bsd</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef PACKAGER_MEDIA_CRYPTO_SUBSAMPLE_GENERATOR_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_CRYPTO_SUBSAMPLE_GENERATOR_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/fourccs.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/stream_info.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/status.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">class </span>AV1Parser;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">class </span>VideoSliceHeaderParser;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">class </span>VPxParser;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">struct </span>SubsampleEntry;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html"> 34</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html">SubsampleGenerator</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#a1674b4a68974db06ad4efa9a9b699a46">SubsampleGenerator</a>(<span class="keywordtype">bool</span> vp9_subsample_encryption);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html">SubsampleGenerator</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#ac4478f9099344a05be5b9b3e4e209817">Initialize</a>(FourCC protection_scheme,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a>&amp; stream_info);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#a8d4d840fd11c1c89b8ed03cdf076c64e">GenerateSubsamples</a>(<span class="keyword">const</span> uint8_t* frame,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">size_t</span> frame_size,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; std::vector&lt;SubsampleEntry&gt;* subsamples);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// Testing injections.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">void</span> InjectVpxParserForTesting(std::unique_ptr&lt;VPxParser&gt; vpx_parser);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">void</span> InjectVideoSliceHeaderParserForTesting(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; std::unique_ptr&lt;VideoSliceHeaderParser&gt; header_parser);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> InjectAV1ParserForTesting(std::unique_ptr&lt;AV1Parser&gt; av1_parser);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#a1674b4a68974db06ad4efa9a9b699a46">SubsampleGenerator</a>(<span class="keyword">const</span> <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html">SubsampleGenerator</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html">SubsampleGenerator</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html">SubsampleGenerator</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> GenerateSubsamplesFromVPxFrame(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">const</span> uint8_t* frame,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">size_t</span> frame_size,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; std::vector&lt;SubsampleEntry&gt;* subsamples);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> GenerateSubsamplesFromH26xFrame(</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> uint8_t* frame,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">size_t</span> frame_size,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; std::vector&lt;SubsampleEntry&gt;* subsamples);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> GenerateSubsamplesFromAV1Frame(</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">const</span> uint8_t* frame,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">size_t</span> frame_size,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; std::vector&lt;SubsampleEntry&gt;* subsamples);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> vp9_subsample_encryption_ = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// Whether the protected portion should be AES block (16 bytes) aligned.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">bool</span> align_protected_data_ = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; Codec codec_ = kUnknownCodec;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// For NAL structured video only, the size of NAL unit length in bytes. Can be</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// 1, 2 or 4 bytes.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; uint8_t nalu_length_size_ = 0;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">// For SAMPLE AES only, 32 bytes for Video and 16 bytes for audio.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">size_t</span> leading_clear_bytes_size_ = 0;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="comment">// For SAMPLE AES only, if the data size is less than this value, none of the</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">// bytes are encrypted. The size is 48+1 bytes for video NAL and 32 bytes for</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// audio according to MPEG-2 Stream Encryption Format for HTTP Live Streaming.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">size_t</span> min_protected_data_size_ = 0;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="comment">// VPx parser for VPx streams.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; std::unique_ptr&lt;VPxParser&gt; vpx_parser_;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="comment">// Video slice header parser for NAL strucutred streams.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; std::unique_ptr&lt;VideoSliceHeaderParser&gt; header_parser_;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="comment">// AV1 parser for AV1 streams.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; std::unique_ptr&lt;AV1Parser&gt; av1_parser_;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;};</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_CRYPTO_SUBSAMPLE_GENERATOR_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceshaka_html"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html">shaka</a></div><div class="ttdoc">All the methods that are virtual are virtual for mocking.</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011">gflags_hex_bytes.cc:11</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1SubsampleGenerator_html"><div class="ttname"><a href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html">shaka::media::SubsampleGenerator</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/df8/subsample__generator_8h_source.html#l00034">subsample_generator.h:34</a></div></div>
<div class="ttc" id="aclassshaka_1_1Status_html"><div class="ttname"><a href="../../d2/d20/classshaka_1_1Status.html">shaka::Status</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d13/status_8h_source.html#l00110">status.h:110</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1SubsampleGenerator_html_a1674b4a68974db06ad4efa9a9b699a46"><div class="ttname"><a href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#a1674b4a68974db06ad4efa9a9b699a46">shaka::media::SubsampleGenerator::SubsampleGenerator</a></div><div class="ttdeci">SubsampleGenerator(bool vp9_subsample_encryption)</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d1e/subsample__generator_8cc_source.html#l00120">subsample_generator.cc:120</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1SubsampleGenerator_html_ac4478f9099344a05be5b9b3e4e209817"><div class="ttname"><a href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#ac4478f9099344a05be5b9b3e4e209817">shaka::media::SubsampleGenerator::Initialize</a></div><div class="ttdeci">virtual Status Initialize(FourCC protection_scheme, const StreamInfo &amp;stream_info)</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d1e/subsample__generator_8cc_source.html#l00125">subsample_generator.cc:125</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1SubsampleGenerator_html_a8d4d840fd11c1c89b8ed03cdf076c64e"><div class="ttname"><a href="../../d0/d9f/classshaka_1_1media_1_1SubsampleGenerator.html#a8d4d840fd11c1c89b8ed03cdf076c64e">shaka::media::SubsampleGenerator::GenerateSubsamples</a></div><div class="ttdeci">virtual Status GenerateSubsamples(const uint8_t *frame, size_t frame_size, std::vector&lt; SubsampleEntry &gt; *subsamples)</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d1e/subsample__generator_8cc_source.html#l00210">subsample_generator.cc:210</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1StreamInfo_html"><div class="ttname"><a href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">shaka::media::StreamInfo</a></div><div class="ttdoc">Abstract class holds stream information.</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/daa/stream__info_8h_source.html#l00065">stream_info.h:65</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:04 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>