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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?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 ID3
* @copyright Copyright (c) 2008 The PHP Reader Project Workgroup
* @license http://code.google.com/p/php-reader/wiki/License New BSD License
* @version $Id: ETCO.php 105 2008-07-30 14:56:47Z svollbehr $
*/
/**#@+ @ignore */
require_once("ID3/Frame.php");
require_once("ID3/Timing.php");
/**#@-*/
/**
* The <i>Event timing codes</i> allows synchronisation with key events in the
* audio.
*
* The events are an array of timestamp and type pairs. The time stamp is set to
* zero if directly at the beginning of the sound or after the previous event.
* All events are sorted in chronological order.
*
* The events $E0-EF are for user events. You might want to synchronise your
* music to something, like setting off an explosion on-stage, activating a
* screensaver etc.
*
* There may only be one ETCO frame in each tag.
*
* @package php-reader
* @subpackage ID3
* @author Sven Vollbehr <svollbehr@gmail.com>
* @author Ryan Butterfield <buttza@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: 105 $
*/
final class ID3_Frame_ETCO extends ID3_Frame
implements ID3_Timing
{
/**
* The list of event types.
*
* @var Array
*/
public static $types = array
("Padding", "End of initial silence", "Intro start", "Main part start",
"Outro start", "Outro end", "Verse start","Refrain start",
"Interlude start", "Theme start", "Variation start", "Key change",
"Time change", "Momentary unwanted noise", "Sustained noise",
"Sustained noise end", "Intro end", "Main part end", "Verse end",
"Refrain end", "Theme end", "Profanity", "Profanity end",
0xe0 => "User event", "User event", "User event", "User event",
"User event", "User event", "User event", "User event", "User event",
"User event", "User event", "User event", "User event", "User event",
0xfd => "Audio end (start of silence)", "Audio file ends",
"One more byte of events follows");
/** @var integer */
private $_format = ID3_Timing::MPEG_FRAMES;
/** @var Array */
private $_events = array();
/**
* Constructs the class with given parameters and parses object related data.
*
* @param Reader $reader The reader object.
* @param Array $options The options array.
*/
public function __construct($reader = null, &$options = array())
{
parent::__construct($reader, $options);
if ($reader === null)
return;
$this->_format = Transform::fromUInt8($this->_data[0]);
for ($i = 1; $i < $this->getSize(); $i += 5) {
$this->_events[Transform::fromUInt32BE(substr($this->_data, $i + 1, 4))] =
$data = Transform::fromUInt8($this->_data[$i]);
if ($data == 0xff)
break;
}
ksort($this->_events);
}
/**
* Returns the timing format.
*
* @return integer
*/
public function getFormat() { return $this->_format; }
/**
* Sets the timing format.
*
* @see ID3_Timing
* @param integer $format The timing format.
*/
public function setFormat($format) { $this->_format = $format; }
/**
* Returns the events as an associated array having the timestamps as keys and
* the event types as values.
*
* @return Array
*/
public function getEvents() { return $this->_events; }
/**
* Sets the events using given format. The value must be an associated array
* having the timestamps as keys and the event types as values.
*
* @param Array $events The events array.
* @param integer $format The timing format.
*/
public function setEvents($events, $format = false)
{
$this->_events = $events;
if ($format !== false)
$this->_format = $format;
ksort($this->_events);
}
/**
* Returns the frame raw data.
*
* @return string
*/
public function __toString()
{
$data = Transform::toUInt8($this->_format);
foreach ($this->_events as $timestamp => $type)
$data .= Transform::toUInt8($type) . Transform::toUInt32BE($timestamp);
$this->setData($data);
return parent::__toString();
}
}
|
