aboutsummaryrefslogtreecommitdiff
path: root/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/src/ASF/Object/Marker.php
blob: 697cb4af82d8c671865474f3359fa72c0c18b6ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?php
/**
 * PHP Reader Library
 *
 * Copyright (c) 2008 The PHP Reader Project Workgroup. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the project workgroup nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    php-reader
 * @subpackage ASF
 * @copyright  Copyright (c) 2008 The PHP Reader Project Workgroup
 * @license    http://code.google.com/p/php-reader/wiki/License New BSD License
 * @version    $Id: Marker.php 108 2008-09-05 17:00:05Z svollbehr $
 */

/**#@+ @ignore */
require_once("ASF/Object.php");
/**#@-*/

/**
 * The <i>Marker Object</i> class.
 *
 * @package    php-reader
 * @subpackage ASF
 * @author     Sven Vollbehr <svollbehr@gmail.com>
 * @copyright  Copyright (c) 2008 The PHP Reader Project Workgroup
 * @license    http://code.google.com/p/php-reader/wiki/License New BSD License
 * @version    $Rev: 108 $
 */
final class ASF_Object_Marker extends ASF_Object
{
  /** @var string */
  private $_name;

  /** @var Array */
  private $_markers = array();
  
  /**
   * Constructs the class with given parameters and reads object related data
   * from the ASF file.
   *
   * @param Reader $reader  The reader object.
   * @param Array  $options The options array.
   */
  public function __construct($reader, &$options = array())
  {
    parent::__construct($reader, $options);
    
    $this->_reader->skip(16);
    $markersCount = $this->_reader->readUInt32LE();
    $this->_reader->skip(2);
    $nameLength = $this->_reader->readUInt16LE();
    $this->_name = iconv
      ("utf-16le", $this->getOption("encoding"),
       $this->_reader->readString16LE($nameLength));
    for ($i = 0; $i < $markersCount; $i++) {
      $marker = array
        ("offset" => $this->_reader->readInt64LE(),
         "presentationTime" => $this->_reader->readInt64LE());
      $this->_reader->skip(2);
      $marker["sendTime"] = $this->_reader->readUInt32LE();
      $marker["flags"] = $this->_reader->readUInt32LE();
      $descriptionLength = $this->_reader->readUInt32LE();
      $marker["description"] = iconv
        ("utf-16le", $this->getOption("encoding"),
         $this->_reader->readString16LE($descriptionLength));
      $this->_markers[] = $marker;
    }
  }

  /**
   * Returns the name of the Marker Object.
   *
   * @return Array
   */
  public function getName() { return $this->_name; }
  
  /**
   * Returns an array of markers. Each entry consists of the following keys.
   * 
   *   o offset -- Specifies a byte offset into the <i>Data Object</i> to the
   *     actual position of the marker in the <i>Data Object</i>. ASF parsers
   *     must seek to this position to properly display data at the specified
   *     marker <i>Presentation Time</i>.
   * 
   *   o presentationTime -- Specifies the presentation time of the marker, in
   *     100-nanosecond units.
   * 
   *   o sendTime -- Specifies the send time of the marker entry, in
   *     milliseconds.
   * 
   *   o flags -- Flags are reserved and should be set to 0.
   * 
   *   o description -- Specifies a description of the marker entry.
   *
   * @return Array
   */
  public function getMarkers() { return $this->_markers; }
}