shaka-packager/docs/d2/dd6/mkv__writer_8h_source.html

89 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/formats/webm/mkv_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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_b23f8e22c8c095d1c8c0cb8f88104a00.html">webm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">mkv_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 2015 Google Inc. 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_WEBM_MKV_WRITER_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_WEBM_MKV_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 &lt;memory&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;string&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/file/file_closer.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/status.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/third_party/libwebm/src/mkvmuxer.hpp&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="l00021"></a><span class="lineno"><a class="line" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html">MkvWriter</a> : <span class="keyword">public</span> mkvmuxer::IMkvWriter {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html">MkvWriter</a>();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; ~<a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html">MkvWriter</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a9490dbf4bc02903484acb68f038f7fe2">Open</a>(<span class="keyword">const</span> std::string&amp; name);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#af560b12e0298ca3dcd8f88fddff1443b">Close</a>();</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; mkvmuxer::int32 <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a2468514d1d9efdb15a9e4df2e44b75d8">Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buf, mkvmuxer::uint32 len) <span class="keyword">override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; mkvmuxer::int64 <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a468dcd83a7c087cc83e755703488e92b">Position</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; mkvmuxer::int32 <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a468dcd83a7c087cc83e755703488e92b">Position</a>(mkvmuxer::int64 position) <span class="keyword">override</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a8d0429e7922752db3f01d43e6340465a">Seekable</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a6603ba573e802e660921f329192738f3">ElementStartNotify</a>(mkvmuxer::uint64 element_id,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; mkvmuxer::int64 position) <span class="keyword">override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; int64_t <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#ab331684a758a93bf0c77fa224fe429ea">WriteFromFile</a>(<a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a>* source);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; int64_t <a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#ab331684a758a93bf0c77fa224fe429ea">WriteFromFile</a>(<a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a>* source, int64_t max_copy);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a>* file() { <span class="keywordflow">return</span> file_.get(); }</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="keyword">private</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::unique_ptr&lt;File, FileCloser&gt; file_;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// Keep track of the position and whether we can seek.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; mkvmuxer::int64 position_;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> seekable_;</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; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html">MkvWriter</a>);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;};</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;} <span class="comment">// namespace media</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_FORMATS_WEBM_MKV_WRITER_H_</span></div><div class="ttc" id="classshaka_1_1File_html"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html">shaka::File</a></div><div class="ttdoc">Define an abstract file interface. </div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d4d/file_8h_source.html#l00026">file.h:26</a></div></div>
<div class="ttc" id="namespaceshaka_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="classshaka_1_1media_1_1MkvWriter_html_ab331684a758a93bf0c77fa224fe429ea"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#ab331684a758a93bf0c77fa224fe429ea">shaka::media::MkvWriter::WriteFromFile</a></div><div class="ttdeci">int64_t WriteFromFile(File *source)</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00059">mkv_writer.cc:59</a></div></div>
<div class="ttc" id="classshaka_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="classshaka_1_1media_1_1MkvWriter_html_a6603ba573e802e660921f329192738f3"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a6603ba573e802e660921f329192738f3">shaka::media::MkvWriter::ElementStartNotify</a></div><div class="ttdeci">void ElementStartNotify(mkvmuxer::uint64 element_id, mkvmuxer::int64 position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00093">mkv_writer.cc:93</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MkvWriter_html_a468dcd83a7c087cc83e755703488e92b"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a468dcd83a7c087cc83e755703488e92b">shaka::media::MkvWriter::Position</a></div><div class="ttdeci">mkvmuxer::int64 Position() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00074">mkv_writer.cc:74</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MkvWriter_html"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html">shaka::media::MkvWriter</a></div><div class="ttdoc">An implementation of IMkvWriter using our File type. </div><div class="ttdef"><b>Definition:</b> <a href="../../d2/dd6/mkv__writer_8h_source.html#l00021">mkv_writer.h:21</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MkvWriter_html_a8d0429e7922752db3f01d43e6340465a"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a8d0429e7922752db3f01d43e6340465a">shaka::media::MkvWriter::Seekable</a></div><div class="ttdeci">bool Seekable() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00089">mkv_writer.cc:89</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MkvWriter_html_a9490dbf4bc02903484acb68f038f7fe2"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a9490dbf4bc02903484acb68f038f7fe2">shaka::media::MkvWriter::Open</a></div><div class="ttdeci">Status Open(const std::string &amp;name)</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00016">mkv_writer.cc:16</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MkvWriter_html_af560b12e0298ca3dcd8f88fddff1443b"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#af560b12e0298ca3dcd8f88fddff1443b">shaka::media::MkvWriter::Close</a></div><div class="ttdeci">Status Close()</div><div class="ttdoc">Closes the file. MUST call Open before calling any other methods. </div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00029">mkv_writer.cc:29</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MkvWriter_html_a2468514d1d9efdb15a9e4df2e44b75d8"><div class="ttname"><a href="../../d1/d0a/classshaka_1_1media_1_1MkvWriter.html#a2468514d1d9efdb15a9e4df2e44b75d8">shaka::media::MkvWriter::Write</a></div><div class="ttdeci">mkvmuxer::int32 Write(const void *buf, mkvmuxer::uint32 len) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/dc8/mkv__writer_8cc_source.html#l00040">mkv_writer.cc:40</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 28 2018 17:32:56 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.13
</small></address>
</body>
</html>