shaka-packager/docs/d5/d4b/packed__audio__writer_8h_so...

148 lines
16 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/formats/packed_audio/packed_audio_writer.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_375ba2cfd8fd5b05c50b92d996b9d386.html">formats</a></li><li class="navelem"><a class="el" href="../../dir_c727d19e3a8f99ea2539fb71bdb2ad10.html">packed_audio</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">packed_audio_writer.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_FORMATS_PACKED_AUDIO_PACKED_AUDIO_WRITER_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_PACKED_AUDIO_PACKED_AUDIO_WRITER_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 &quot;packager/file/file_closer.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/muxer.h&quot;</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="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">class </span>BufferWriter;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">class </span>PackedAudioSegmenter;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html">PackedAudioWriter</a> : <span class="keyword">public</span> <a class="code" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html#a8454bb12d56cb1e209822363ad3b0bc5">PackedAudioWriter</a>(<span class="keyword">const</span> <a class="code" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">MuxerOptions</a>&amp; muxer_options);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; ~<a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html">PackedAudioWriter</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>PackedAudioWriterTest;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html#a8454bb12d56cb1e209822363ad3b0bc5">PackedAudioWriter</a>(<span class="keyword">const</span> <a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html">PackedAudioWriter</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html">PackedAudioWriter</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html">PackedAudioWriter</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// Muxer implementations.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> InitializeMuxer() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> Finalize() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> AddMediaSample(<span class="keywordtype">size_t</span> stream_id, <span class="keyword">const</span> <a class="code" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a>&amp; sample) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> FinalizeSegment(<span class="keywordtype">size_t</span> stream_id, <span class="keyword">const</span> <a class="code" href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">SegmentInfo</a>&amp; sample) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> WriteSegment(<span class="keyword">const</span> std::string&amp; segment_path,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="../../dc/d41/classshaka_1_1media_1_1BufferWriter.html">BufferWriter</a>* segment_buffer);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> CloseFile(std::unique_ptr&lt;File, FileCloser&gt; file);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> uint32_t transport_stream_timestamp_offset_ = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; std::unique_ptr&lt;PackedAudioSegmenter&gt; segmenter_;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// Used in single segment mode.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::unique_ptr&lt;File, FileCloser&gt; output_file_;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Keeps track of segment ranges in single segment mode.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="../../d1/d03/structshaka_1_1media_1_1MuxerListener_1_1MediaRanges.html">MuxerListener::MediaRanges</a> media_ranges_;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint64_t total_duration_ = 0;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// Used in multi-segment mode for segment template.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint64_t segment_number_ = 0;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_FORMATS_PACKED_AUDIO_PACKED_AUDIO_WRITER_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassshaka_1_1media_1_1BufferWriter_html"><div class="ttname"><a href="../../dc/d41/classshaka_1_1media_1_1BufferWriter.html">shaka::media::BufferWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dd/dd2/buffer__writer_8h_source.html#l00023">buffer_writer.h:23</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1Muxer_html"><div class="ttname"><a href="../../df/d46/classshaka_1_1media_1_1Muxer.html">shaka::media::Muxer</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/df6/muxer_8h_source.html#l00030">muxer.h:30</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1PackedAudioWriter_html"><div class="ttname"><a href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html">shaka::media::PackedAudioWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d5/d4b/packed__audio__writer_8h_source.html#l00023">packed_audio_writer.h:23</a></div></div>
<div class="ttc" id="astructshaka_1_1media_1_1SegmentInfo_html"><div class="ttname"><a href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">shaka::media::SegmentInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00055">media_handler.h:55</a></div></div>
<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_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="astructshaka_1_1media_1_1MuxerOptions_html"><div class="ttname"><a href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">shaka::media::MuxerOptions</a></div><div class="ttdoc">This structure contains the list of configuration options for Muxer.</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d0e/muxer__options_8h_source.html#l00020">muxer_options.h:20</a></div></div>
<div class="ttc" id="astructshaka_1_1media_1_1MuxerListener_1_1MediaRanges_html"><div class="ttname"><a href="../../d1/d03/structshaka_1_1media_1_1MuxerListener_1_1MediaRanges.html">shaka::media::MuxerListener::MediaRanges</a></div><div class="ttdef"><b>Definition:</b> <a href="../../de/dfa/muxer__listener_8h_source.html#l00046">muxer_listener.h:46</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1PackedAudioWriter_html_a8454bb12d56cb1e209822363ad3b0bc5"><div class="ttname"><a href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html#a8454bb12d56cb1e209822363ad3b0bc5">shaka::media::PackedAudioWriter::PackedAudioWriter</a></div><div class="ttdeci">PackedAudioWriter(const MuxerOptions &amp;muxer_options)</div><div class="ttdoc">Create a MP4Muxer object from MuxerOptions.</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/deb/packed__audio__writer_8cc_source.html#l00016">packed_audio_writer.cc:16</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1MediaSample_html"><div class="ttname"><a href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">shaka::media::MediaSample</a></div><div class="ttdoc">Class to hold a media sample.</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d80/media__sample_8h_source.html#l00022">media_sample.h:22</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>