/lib/getid3/write.id3v2.php
PHP | 1164 lines | 623 code | 135 blank | 406 comment | 172 complexity | d8cf661ad545bdabb98d786e15b3d0b3 MD5 | raw file
Possible License(s): LGPL-2.1
Large files files are truncated, but you can click here to view the full file
- <?php
- // +----------------------------------------------------------------------+
- // | PHP version 5 |
- // +----------------------------------------------------------------------+
- // | Copyright (c) 2002-2006 James Heinrich, Allan Hansen |
- // +----------------------------------------------------------------------+
- // | This source file is subject to version 2 of the GPL license, |
- // | that is bundled with this package in the file license.txt and is |
- // | available through the world-wide-web at the following url: |
- // | http://www.gnu.org/copyleft/gpl.html |
- // +----------------------------------------------------------------------+
- // | getID3() - http://getid3.sourceforge.net or http://www.getid3.org |
- // +----------------------------------------------------------------------+
- // | Authors: James Heinrich <info?getid3*org> |
- // | Allan Hansen <ah?artemis*dk> |
- // +----------------------------------------------------------------------+
- // | write.id3v1.php |
- // | writing module for id3v1 tags |
- // | dependencies: module.tag.id3v1.php. |
- // +----------------------------------------------------------------------+
- //
- // $Id: write.id3v2.php,v 1.9 2006/12/25 23:44:23 ah Exp $
- class getid3_write_id3v2 extends getid3_handler_write
- {
- // NOTE: This module ONLY writes tags in UTF-8. All strings must be UTF-8 encoded.
-
- // For multiple values, specify "array of type" instead of type for all T??? and IPLS params except TXXX.
- /**2.4
- // For multiple values, specify "array of type" instead of type for all T??? params except TXXX.
- */
-
- // Identification frames
- public $content_group_description; // TIT1 string
- public $title; // TIT2 string
- public $subtitle; // TIT3 string
- public $album; // TALB string
- public $original_album_title; // TOAL string
- public $track; // TRCK integer or "integer/integer" e.g. "10/12"
- public $part_of_set; // TPOS integer or "integer/integer" e.g. "10/12"
- public $isrc; // TSRC string
- // Involved persons frames
- public $artist; // TPE1 string
- public $band; // TPE2 string
- public $conductor; // TPE3 string
- public $remixer; // TPE4 string
- public $original_artist; // TOPE string
- public $lyricist; // TEXT string
- public $original_lyricist; // TOLY string
- public $composer; // TCOM string
- public $encoded_by; // TENC string
- // Derived and subjective properties frames
- public $beats_per_minute; // TBPM integer
- public $length; // TLEN integer
- public $initial_key; // TKEY string
- public $language; // TLAN string - ISO-639-2
- public $genre; // TCON string or integer
- public $file_type; // TFLT string
- public $media_type; // TMED string
- // Rights and license frames
- public $copyright; // TCOP string - must begin with YEAR and a space
- public $date; // TDAT string - DDMM
- public $year; // TYER string - YYYY
- public $original_release_year; // TORY string - YYYY
- public $recording_dates; // TRDA string
- public $time; // TIME string - HHMM
- public $publisher; // TPUB string
- public $file_owner; // TOWN string
- public $internet_radio_station_name; // TRSN string
- public $internet_radio_station_owner; // TRSO string
- public $involved_people_list; // IPLS string
- // Other text frames
- public $original_filename; // TOFN string
- public $playlist_delay; // TDLY integer
- public $encoder_settings; // TSSE string
- // User defined text information frame
- public $user_text; // TXXX array of ( unique_description(string) => value(string) )
- // Comments
- public $comment; // COMM
- // URL link frames - details
- public $commercial_information; // WCOM url(string)
- public $copyright_information; // WCOP url(string)
- public $url_file; // WOAF url(string)
- public $url_artist; // WOAR url(string)
- public $url_source; // WOAS url(string)
- public $url_station; // WORS url(string)
- public $payment; // WPAY url(string)
- public $url_publisher; // WPUB url(string)
- // User defined URL link frame
- public $url_user; // WXXX array of ( unique_description(string) => url(string) )
- // Unique file identifier
- public $unique_file_identifier; // UFID
- // Music CD identifier
- public $music_cd_identifier; // MCDI
- // Event timing codes
- public $event_timing_codes; // ETCO
- // MPEG location lookup table
- public $mpeg_location_lookup_table; // MLLT
- // Synchronised tempo codes
- public $synchronised_tempo_codes; // SYTC
- // Unsynchronised lyrics/text transcription
- public $unsynchronised_lyrics; // USLT
- // Synchronised lyrics/text
- public $synchronised_lyrics; // SYLT
- // Relative volume adjustment (1)
- public $relative_volume_adjustment; // RVAD
- // Equalisation (1)
- public $equalisation; // EQUA
- // Reverb
- public $reverb; // RVRB
- // Attached picture
- public $attached_picture; // APIC
- // General encapsulated object
- public $general_encapsulated_object; // GEOB
- // Play counter
- public $play_counter; // PCNT
- // Popularimeter
- public $popularimeter; // POPM
- // Recommended buffer size
- public $recommended_buffer_size; // RBUF
- // Audio encryption
- public $audio_encryption; // AENC
- // Linked information
- public $linked_information; // LINK
- // Position synchronisation frame
- public $position_synchronisation; // POSS
- // Terms of use frame
- public $terms_of_use; // USER
- // Ownership frame
- public $ownership; // OWNE
- // Commercial frame
- public $commercial; // COMR
- // Encryption method registration
- public $encryption_method_registration; // ENCR
- // Group identification registration
- public $group_identification_registration; // GRID
- // Private frame
- public $private; // PRIV
- /**2.4
- // Identification frames
- public $content_group_description; // TIT1 string
- public $title; // TIT2 string
- public $subtitle; // TIT3 string
- public $album; // TALB string
- public $original_album_title; // TOAL string
- public $track; // TRCK integer or "integer/integer" e.g. "10/12"
- public $part_of_set; // TPOS integer or "integer/integer" e.g. "10/12"
- public $set_subtitle; // TSST string
- public $isrc; // TSRC string
- // Involved persons frames
- public $artist; // TPE1 string
- public $band; // TPE2 string
- public $conductor; // TPE3 string
- public $remixer; // TPE4 string
- public $original_artist; // TOPE string
- public $lyricist; // TEXT string
- public $original_lyricist; // TOLY string
- public $composer; // TCOM string
- public $musician_credits_list; // TMCL string
- public $involved_people_list; // TIPL string
- public $encoded_by; // TENC string
- // Derived and subjective properties frames
- public $beats_per_minute; // TBPM integer
- public $length; // TLEN integer
- public $initial_key; // TKEY string
- public $language; // TLAN string - ISO-639-2
- public $genre; // TCON string or integer
- public $file_type; // TFLT string
- public $media_type; // TMED string
- public $mood; // TMOO string
- // Rights and license frames
- public $copyright; // TCOP string - must begin with YEAR and a space
- // TPRO strign - must begin with YEAR and a space
- public $publisher; // TPUB string
- public $file_owner; // TOWN string
- public $internet_radio_station_name; // TRSN string
- public $internet_radio_station_owner; // TRSO string
- // Other text frames
- public $original_filename; // TOFN string
- public $playlist_delay; // TDLY integer
- public $encoding_time; // TDEN timestamp(string) - yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss. All time stamps are UTC.
- public $original_release_time; // TDOR timestamp(string) - yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss. All time stamps are UTC.
- public $recording_time; // TDRC timestamp(string) - yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss. All time stamps are UTC.
- public $release_time; // TDRL timestamp(string) - yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss. All time stamps are UTC.
- public $tagging_time; // TDTG timestamp(string) - yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss. All time stamps are UTC.
- public $encoder_settings; // TSSE string
- public $album_sort_order; // TSOA string
- public $performer_sort_order; // TSOP string
- public $title_sort_order; // TSOT string
- // User defined text information frame
- public $user_text; // TXXX array of ( unique_description(string) => value(string) )
- // Comments
- public $comment; // COMM
- // URL link frames - details
- public $commercial_information; // WCOM url(string)
- public $copyright_information; // WCOP url(string)
- public $url_file; // WOAF url(string)
- public $url_artist; // WOAR url(string)
- public $url_source; // WOAS url(string)
- public $url_station; // WORS url(string)
- public $payment; // WPAY url(string)
- public $url_publisher; // WPUB url(string)
- // User defined URL link frame
- public $url_user; // WXXX array of ( unique_description(string) => url(string) )
- // Unique file identifier
- public $unique_file_identifier; // UFID
- // Music CD identifier
- public $music_cd_identifier; // MCDI
- // Event timing codes
- public $event_timing_codes; // ETCO
- // MPEG location lookup table
- public $mpeg_location_lookup_table; // MLLT
- // Synchronised tempo codes
- public $synchronised_tempo_codes; // SYTC
- // Unsynchronised lyrics/text transcription
- public $unsynchronised_lyrics; // USLT
- // Synchronised lyrics/text
- public $synchronised_lyrics; // SYLT
- // Relative volume adjustment (2)
- public $relative_volume_adjustment; // RVA2
- // Equalisation (2)
- public $equalisation; // EQU2
- // Reverb
- public $reverb; // RVRB
- // Attached picture
- public $attached_picture; // APIC
- // General encapsulated object
- public $general_encapsulated_object; // GEOB
- // Play counter
- public $play_counter; // PCNT
- // Popularimeter
- public $popularimeter; // POPM
- // Recommended buffer size
- public $recommended_buffer_size; // RBUF
- // Audio encryption
- public $audio_encryption; // AENC
- // Linked information
- public $linked_information; // LINK
- // Position synchronisation frame
- public $position_synchronisation; // POSS
- // Terms of use frame
- public $terms_of_use; // USER
- // Ownership frame
- public $ownership; // OWNE
- // Commercial frame
- public $commercial; // COMR
- // Encryption method registration
- public $encryption_method_registration; // ENCR
- // Group identification registration
- public $group_identification_registration; // GRID
- // Private frame
- public $private; // PRIV
- // Signature frame
- public $signature; // SIGN
- // Seek frame
- public $seek; // SEEK
- // Audio seek point index
- public $audio_seek_point_index; // ASPI
- */
-
-
- // internal logic
- protected $padded_length = 4096; // minimum length of ID3v2 tag in bytes
- protected $previous_frames = array ();
- const major_version = 3;
-
- public function read() {
- }
- public function write() {
- $engine = new getid3;
- $engine->filename = $this->filename;
- $engine->fp = fopen($this->filename, 'rb');
- $engine->include_module('tag.id3v2');
- $tag = new getid3_id3v2($engine);
- $tag->Analyze();
- if (!(int)@$engine->info['avdataoffset']) {
- throw new getid3_exception('No audio data found.');
- }
- $this->padded_length = max(@$engine->info['id3v2']['headerlength'], $this->padded_length);
- $tag = $this->generate_tag();
- // insert-overwrite existing tag (padded to length of old tag if neccesary)
- if (@$engine->info['id3v2']['headerlength'] && ($engine->info['id3v2']['headerlength'] == strlen($tag))) {
- if (!$fp = fopen($this->filename, 'r+b')) {
- throw new getid3_exception('Could not open '.$this->filename.' mode "r+b"');
- }
- fwrite($fp, $tag, strlen($tag));
- fclose($fp);
- }
- // rewrite file - no tag present or new tag longer than old tag
- else
- if (!$fp_source = @fopen($this->filename, 'rb')) {
- throw new getid3_exception('Could not open '.$this->filename.' mode "rb"');
- }
- fseek($fp_source, $engine->info['avdataoffset'], SEEK_SET);
- if (!$fp_temp = @fopen($this->filename.'getid3tmp', 'w+b')) {
- throw new getid3_exception('Could not open '.$this->filename.'getid3tmp mode "w+b"');
- }
- fwrite($fp, $tag, strlen($tag));
- while ($buffer = fread($fp_source, 16384)) {
- fwrite($fp_temp, $buffer, strlen($buffer));
- }
- fclose($fp_temp);
- fclose($fp_source);
- $this->save_permissions();
- unlink($this->filename);
- rename($this->filename.'getid3tmp', $this->filename);
- $this->restore_permissions();
- }
- clearstatcache();
- return true;
- }
- public function remove() {
- $engine = new getid3;
- $engine->filename = $this->filename;
- $engine->fp = fopen($this->filename, 'rb');
- $engine->include_module('tag.id3v2');
- $tag = new getid3_id3v2($engine);
- $tag->Analyze();
- if ((int)@$engine->info['avdataoffset']) {
- if (!$fp_source = @fopen($this->filename, 'rb')) {
- throw new getid3_exception('Could not open '.$this->filename.' mode "rb"');
- }
- fseek($fp_source, $engine->info['avdataoffset'], SEEK_SET);
- if (!$fp_temp = @fopen($this->filename.'getid3tmp', 'w+b')) {
- throw new getid3_exception('Could not open '.$this->filename.'getid3tmp mode "w+b"');
- }
- while ($buffer = fread($fp_source, 16384)) {
- fwrite($fp_temp, $buffer, strlen($buffer));
- }
- fclose($fp_temp);
- fclose($fp_source);
- $this->save_permissions();
- unlink($this->filename);
- rename($this->filename.'getid3tmp', $this->filename);
- $this->restore_permissions();
- clearstatcache();
- }
- // success when removing non-existant tag
- return true;
- }
- protected function generate_tag() {
- $result = '';
-
- $some_array = array (
- 'content_group_description' => 'TIT1',
- 'title' => 'TIT2',
- 'subtitle' => 'TIT3',
- );
-
- foreach ($some_array as $key => $frame_name) {
-
-
- if ($frame_data = $this->generate_frame_data($frame_name, $this->$key)) {
-
- $frame_length = $this->BigEndian2String(strlen($frame_data), 4, false);
- $frame_flags = $this->generate_frame_flags();
- }
-
- $result .= $frame_name.$frame_length.$frame_flags.$frame_data;
- }
-
- // calc padded length of tag
- while ($this->padded_length < (strlen($result) + 10)) {
- $this->padded_length += 1024;
- }
- // pad up to $padded_length bytes if unpadded tag is shorter than $padded_length
- if ($this->padded_length > (strlen($result) + 10)) {
- $result .= @str_repeat("\x00", $this->padded_length - strlen($result) - 10);
- }
-
- $header = 'ID3';
- $header .= chr(getid3_id3v2_write::major_version);
- $header .= chr(0);
- $header .= $this->generate_tag_flags();
- $header .= getid3_lib::BigEndian2String(strlen($result), 4, true);
- return $header.$result;
- }
- protected function generate_tag_flags($flags) {
- // %abc00000
- $flag = (@$flags['unsynchronisation'] ? '1' : '0'); // a - Unsynchronisation
- $flag .= (@$flags['extendedheader'] ? '1' : '0'); // b - Extended header
- $flag .= (@$flags['experimental'] ? '1' : '0'); // c - Experimental indicator
- $flag .= '00000';
- /**2.4
- // %abcd0000
- $flag = (@$flags['unsynchronisation'] ? '1' : '0'); // a - Unsynchronisation
- $flag .= (@$flags['extendedheader'] ? '1' : '0'); // b - Extended header
- $flag .= (@$flags['experimental'] ? '1' : '0'); // c - Experimental indicator
- $flag .= (@$flags['footer'] ? '1' : '0'); // d - Footer present
- $flag .= '0000';
- */
- return chr(bindec($flag));
- }
- protected function generate_frame_flags($flags) {
-
- // %abc00000 %ijk00000
- $flag1 = (@$flags['tag_alter'] ? '1' : '0'); // a - Tag alter preservation (true == discard)
- $flag1 .= (@$flags['file_alter'] ? '1' : '0'); // b - File alter preservation (true == discard)
- $flag1 .= (@$flags['read_only'] ? '1' : '0'); // c - Read only (true == read only)
- $flag1 .= '00000';
-
- $flag2 = (@$flags['compression'] ? '1' : '0'); // i - Compression (true == compressed)
- $flag2 .= (@$flags['encryption'] ? '1' : '0'); // j - Encryption (true == encrypted)
- $flag2 .= (@$flags['grouping_identity'] ? '1' : '0'); // k - Grouping identity (true == contains group information)
- $flag2 .= '00000';
-
- /**2.4
- // %0abc0000 %0h00kmnp
- $flag1 = '0';
- $flag1 = (@$flags['tag_alter'] ? '1' : '0'); // a - Tag alter preservation (true == discard)
- $flag1 .= (@$flags['file_alter'] ? '1' : '0'); // b - File alter preservation (true == discard)
- $flag1 .= (@$flags['read_only'] ? '1' : '0'); // c - Read only (true == read only)
- $flag1 .= '0000';
-
- $flag2 = '0';
- $flag2 .= (@$flags['grouping_identity'] ? '1' : '0'); // h - Grouping identity (true == contains group information)
- $flag2 .= '00';
- $flag2 = (@$flags['compression'] ? '1' : '0'); // k - Compression (true == compressed)
- $flag2 .= (@$flags['encryption'] ? '1' : '0'); // m - Encryption (true == encrypted)
- $flag2 .= (@$flags['unsynchronisation'] ? '1' : '0'); // n - Unsynchronisation (true == unsynchronised)
- $flag2 .= (@$flags['data_length_indicator'] ? '1' : '0'); // p - Data length indicator (true == data length indicator added)
- */
- return chr(bindec($flag1)).chr(bindec($flag2));
- }
- protected function generate_frame_data($frame_name, $source_data_array) {
- $frame_data = '';
- switch ($frame_name) {
- case 'UFID':
- // 4.1 UFID Unique file identifier
- // Owner identifier <text string> $00
- // Identifier <up to 64 bytes binary data>
- if (strlen($source_data_array['data']) > 64) {
- throw new getid3_exception('Identifier not allowed to be longer than 64 bytes in '.$frame_name.' (supplied data was '.strlen($source_data_array['data']).' bytes long)');
- }
- $frame_data .= str_replace("\x00", '', $source_data_array['ownerid'])."\x00";
- $frame_data .= substr($source_data_array['data'], 0, 64); // max 64 bytes - truncate anything longer
- break;
- case 'TXXX':
- // 4.2.2 TXXX User defined text information frame
- // Text encoding $xx
- // Description <text string according to encoding> $00 (00)
- // Value <text string according to encoding>
- $frame_data .= chr(3); // UTF-8 encoding
- $frame_data .= $source_data_array['description']."\x00";
- $frame_data .= $source_data_array['data'];
- break;
- case 'WXXX':
- // 4.3.2 WXXX User defined URL link frame
- // Text encoding $xx
- // Description <text string according to encoding> $00 (00)
- // URL <text string>
- if (!isset($source_data_array['data']) || !$this->valid_url($source_data_array['data'], false, false)) {
- throw new getid3_exception('Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')');
- }
- $frame_data .= chr(3); // UTF-8 encoding
- $frame_data .= $source_data_array['description']."\x00";
- $frame_data .= $source_data_array['data'];
- break;
- case 'IPLS':
- // 4.4 IPLS Involved people list (ID3v2.3 only)
- // Text encoding $xx
- // People list strings <textstrings>
- $frame_data .= chr(3); // UTF-8 encoding
- $frame_data .= $source_data_array['data'];
- break;
- case 'MCDI':
- // 4.4 MCDI Music CD identifier
- // CD TOC <binary data>
- $frame_data .= $source_data_array['data'];
- break;
- case 'ETCO':
- // 4.5 ETCO Event timing codes
- // Time stamp format $xx
- // Where time stamp format is:
- // $01 (32-bit value) MPEG frames from beginning of file
- // $02 (32-bit value) milliseconds from beginning of file
- // Followed by a list of key events in the following format:
- // Type of event $xx
- // Time stamp $xx (xx ...)
- // The 'Time stamp' is set to zero if directly at the beginning of the sound
- // or after the previous event. All events MUST be sorted in chronological order.
- if (($source_data_array['timestampformat'] > 2) || ($source_data_array['timestampformat'] < 1)) {
- throw new getid3_exception('Invalid Time Stamp Format byte in '.$frame_name.' ('.$source_data_array['timestampformat'].')');
- }
- $frame_data .= chr($source_data_array['timestampformat']);
- foreach ($source_data_array as $key => $val) {
- if (!$this->ID3v2IsValidETCOevent($val['typeid'])) {
- throw new getid3_exception('Invalid Event Type byte in '.$frame_name.' ('.$val['typeid'].')');
- }
- if (($key != 'timestampformat') && ($key != 'flags')) {
- if (($val['timestamp'] > 0) && ($previousETCOtimestamp >= $val['timestamp'])) {
- // The 'Time stamp' is set to zero if directly at the beginning of the sound
- // or after the previous event. All events MUST be sorted in chronological order.
- throw new getid3_exception('Out-of-order timestamp in '.$frame_name.' ('.$val['timestamp'].') for Event Type ('.$val['typeid'].')');
- }
- $frame_data .= chr($val['typeid']);
- $frame_data .= getid3_lib::BigEndian2String($val['timestamp'], 4, false);
- }
- }
- break;
- case 'MLLT':
- // 4.6 MLLT MPEG location lookup table
- // MPEG frames between reference $xx xx
- // Bytes between reference $xx xx xx
- // Milliseconds between reference $xx xx xx
- // Bits for bytes deviation $xx
- // Bits for milliseconds dev. $xx
- // Then for every reference the following data is included;
- // Deviation in bytes %xxx....
- // Deviation in milliseconds %xxx....
- if (($source_data_array['framesbetweenreferences'] > 0) && ($source_data_array['framesbetweenreferences'] <= 65535)) {
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['framesbetweenreferences'], 2, false);
- }
- else {
- throw new getid3_exception('Invalid MPEG Frames Between References in '.$frame_name.' ('.$source_data_array['framesbetweenreferences'].')');
- }
- if (($source_data_array['bytesbetweenreferences'] > 0) && ($source_data_array['bytesbetweenreferences'] <= 16777215)) {
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['bytesbetweenreferences'], 3, false);
- }
- else {
- throw new getid3_exception('Invalid bytes Between References in '.$frame_name.' ('.$source_data_array['bytesbetweenreferences'].')');
- }
- if (($source_data_array['msbetweenreferences'] > 0) && ($source_data_array['msbetweenreferences'] <= 16777215)) {
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['msbetweenreferences'], 3, false);
- }
- else {
- throw new getid3_exception('Invalid Milliseconds Between References in '.$frame_name.' ('.$source_data_array['msbetweenreferences'].')');
- }
- if (!$this->IsWithinBitRange($source_data_array['bitsforbytesdeviation'], 8, false)) {
- if (($source_data_array['bitsforbytesdeviation'] % 4) == 0) {
- $frame_data .= chr($source_data_array['bitsforbytesdeviation']);
- }
- else {
- throw new getid3_exception('Bits For Bytes Deviation in '.$frame_name.' ('.$source_data_array['bitsforbytesdeviation'].') must be a multiple of 4.');
- }
- }
- else {
- throw new getid3_exception('Invalid Bits For Bytes Deviation in '.$frame_name.' ('.$source_data_array['bitsforbytesdeviation'].')');
- }
- if (!$this->IsWithinBitRange($source_data_array['bitsformsdeviation'], 8, false)) {
- if (($source_data_array['bitsformsdeviation'] % 4) == 0) {
- $frame_data .= chr($source_data_array['bitsformsdeviation']);
- }
- else {
- throw new getid3_exception('Bits For Milliseconds Deviation in '.$frame_name.' ('.$source_data_array['bitsforbytesdeviation'].') must be a multiple of 4.');
- }
- }
- else {
- throw new getid3_exception('Invalid Bits For Milliseconds Deviation in '.$frame_name.' ('.$source_data_array['bitsformsdeviation'].')');
- }
- foreach ($source_data_array as $key => $val) {
- if (($key != 'framesbetweenreferences') && ($key != 'bytesbetweenreferences') && ($key != 'msbetweenreferences') && ($key != 'bitsforbytesdeviation') && ($key != 'bitsformsdeviation') && ($key != 'flags')) {
- $unwritten_bit_stream .= str_pad(getid3_lib::Dec2Bin($val['bytedeviation']), $source_data_array['bitsforbytesdeviation'], '0', STR_PAD_LEFT);
- $unwritten_bit_stream .= str_pad(getid3_lib::Dec2Bin($val['msdeviation']), $source_data_array['bitsformsdeviation'], '0', STR_PAD_LEFT);
- }
- }
- for ($i = 0; $i < strlen($unwritten_bit_stream); $i += 8) {
- $high_nibble = bindec(substr($unwritten_bit_stream, $i, 4)) << 4;
- $low_nibble = bindec(substr($unwritten_bit_stream, $i + 4, 4));
- $frame_data .= chr($high_nibble & $low_nibble);
- }
- break;
- case 'SYTC':
- // 4.7 SYTC Synchronised tempo codes
- // Time stamp format $xx
- // Tempo data <binary data>
- // Where time stamp format is:
- // $01 (32-bit value) MPEG frames from beginning of file
- // $02 (32-bit value) milliseconds from beginning of file
- if (($source_data_array['timestampformat'] > 2) || ($source_data_array['timestampformat'] < 1)) {
- throw new getid3_exception('Invalid Time Stamp Format byte in '.$frame_name.' ('.$source_data_array['timestampformat'].')');
- }
- $frame_data .= chr($source_data_array['timestampformat']);
- foreach ($source_data_array as $key => $val) {
- if (!$this->ID3v2IsValidETCOevent($val['typeid'])) {
- throw new getid3_exception('Invalid Event Type byte in '.$frame_name.' ('.$val['typeid'].')');
- }
- if (($key != 'timestampformat') && ($key != 'flags')) {
- if (($val['tempo'] < 0) || ($val['tempo'] > 510)) {
- throw new getid3_exception('Invalid Tempo (max = 510) in '.$frame_name.' ('.$val['tempo'].') at timestamp ('.$val['timestamp'].')');
- }
- if ($val['tempo'] > 255) {
- $frame_data .= chr(255);
- $val['tempo'] -= 255;
- }
- $frame_data .= chr($val['tempo']);
- $frame_data .= getid3_lib::BigEndian2String($val['timestamp'], 4, false);
- }
- }
- break;
- case 'USLT':
- // 4.8 USLT Unsynchronised lyric/text transcription
- // Text encoding $xx
- // Language $xx xx xx
- // Content descriptor <text string according to encoding> $00 (00)
- // Lyrics/text <full text string according to encoding>
- if (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- throw new getid3_exception('Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')');
- }
- $frame_data .= chr(3); // UTF-8 encoding
- $frame_data .= strtolower($source_data_array['language']);
- $frame_data .= $source_data_array['description']."\x00";
- $frame_data .= $source_data_array['data'];
- break;
- case 'SYLT':
- // 4.9 SYLT Synchronised lyric/text
- // Text encoding $xx
- // Language $xx xx xx
- // Time stamp format $xx
- // $01 (32-bit value) MPEG frames from beginning of file
- // $02 (32-bit value) milliseconds from beginning of file
- // Content type $xx
- // Content descriptor <text string according to encoding> $00 (00)
- // Terminated text to be synced (typically a syllable)
- // Sync identifier (terminator to above string) $00 (00)
- // Time stamp $xx (xx ...)
- if (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- throw new getid3_exception('Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')');
- }
- if (($source_data_array['timestampformat'] > 2) || ($source_data_array['timestampformat'] < 1)) {
- throw new getid3_exception('Invalid Time Stamp Format byte in '.$frame_name.' ('.$source_data_array['timestampformat'].')');
- }
- if (!$this->ID3v2IsValidSYLTtype($source_data_array['contenttypeid'])) {
- throw new getid3_exception('Invalid Content Type byte in '.$frame_name.' ('.$source_data_array['contenttypeid'].')');
- }
- if (!is_array($source_data_array['data'])) {
- throw new getid3_exception('Invalid Lyric/Timestamp data in '.$frame_name.' (must be an array)');
- }
- $frame_data .= chr(3); // UTF-8 encoding
- $frame_data .= strtolower($source_data_array['language']);
- $frame_data .= chr($source_data_array['timestampformat']);
- $frame_data .= chr($source_data_array['contenttypeid']);
- $frame_data .= $source_data_array['description']."\x00";
- ksort($source_data_array['data']);
- foreach ($source_data_array['data'] as $key => $val) {
- $frame_data .= $val['data']."\x00";
- $frame_data .= getid3_lib::BigEndian2String($val['timestamp'], 4, false);
- }
- break;
- case 'COMM':
- // 4.10 COMM Comments
- // Text encoding $xx
- // Language $xx xx xx
- // Short content descrip. <text string according to encoding> $00 (00)
- // The actual text <full text string according to encoding>
- if (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- throw new getid3_exception('Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')');
- }
- $frame_data .= chr(3); // UTF-8 encoding
- $frame_data .= strtolower($source_data_array['language']);
- $frame_data .= $source_data_array['description']."\x00";
- $frame_data .= $source_data_array['data'];
- break;
- case 'RVA2':
- // 4.11 RVA2 Relative volume adjustment (2) (ID3v2.4+ only)
- // Identification <text string> $00
- // The 'identification' string is used to identify the situation and/or
- // device where this adjustment should apply. The following is then
- // repeated for every channel:
- // Type of channel $xx
- // Volume adjustment $xx xx
- // Bits representing peak $xx
- // Peak volume $xx (xx ...)
- $frame_data .= str_replace("\x00", '', $source_data_array['description'])."\x00";
- foreach ($source_data_array as $key => $val) {
- if ($key != 'description') {
- $frame_data .= chr($val['channeltypeid']);
- $frame_data .= getid3_lib::BigEndian2String($val['volumeadjust'], 2, false, true); // signed 16-bit
- if (!$this->IsWithinBitRange($source_data_array['bitspeakvolume'], 8, false)) {
- $frame_data .= chr($val['bitspeakvolume']);
- if ($val['bitspeakvolume'] > 0) {
- $frame_data .= getid3_lib::BigEndian2String($val['peakvolume'], ceil($val['bitspeakvolume'] / 8), false, false);
- }
- } else {
- throw new getid3_exception('Invalid Bits Representing Peak Volume in '.$frame_name.' ('.$val['bitspeakvolume'].') (range = 0 to 255)');
- }
- }
- }
- break;
- case 'RVAD':
- // 4.12 RVAD Relative volume adjustment (ID3v2.3 only)
- // Increment/decrement %00fedcba
- // Bits used for volume descr. $xx
- // Relative volume change, right $xx xx (xx ...) // a
- // Relative volume change, left $xx xx (xx ...) // b
- // Peak volume right $xx xx (xx ...)
- // Peak volume left $xx xx (xx ...)
- // Relative volume change, right back $xx xx (xx ...) // c
- // Relative volume change, left back $xx xx (xx ...) // d
- // Peak volume right back $xx xx (xx ...)
- // Peak volume left back $xx xx (xx ...)
- // Relative volume change, center $xx xx (xx ...) // e
- // Peak volume center $xx xx (xx ...)
- // Relative volume change, bass $xx xx (xx ...) // f
- // Peak volume bass $xx xx (xx ...)
- if (!$this->IsWithinBitRange($source_data_array['bitsvolume'], 8, false)) {
- throw new getid3_exception('Invalid Bits For Volume Description byte in '.$frame_name.' ('.$source_data_array['bitsvolume'].') (range = 1 to 255)');
- } else {
- $inc_dec_flag .= '00';
- $inc_dec_flag .= $source_data_array['incdec']['right'] ? '1' : '0'; // a - Relative volume change, right
- $inc_dec_flag .= $source_data_array['incdec']['left'] ? '1' : '0'; // b - Relative volume change, left
- $inc_dec_flag .= $source_data_array['incdec']['rightrear'] ? '1' : '0'; // c - Relative volume change, right back
- $inc_dec_flag .= $source_data_array['incdec']['leftrear'] ? '1' : '0'; // d - Relative volume change, left back
- $inc_dec_flag .= $source_data_array['incdec']['center'] ? '1' : '0'; // e - Relative volume change, center
- $inc_dec_flag .= $source_data_array['incdec']['bass'] ? '1' : '0'; // f - Relative volume change, bass
- $frame_data .= chr(bindec($inc_dec_flag));
- $frame_data .= chr($source_data_array['bitsvolume']);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['volumechange']['right'], ceil($source_data_array['bitsvolume'] / 8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['volumechange']['left'], ceil($source_data_array['bitsvolume'] / 8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['right'], ceil($source_data_array['bitsvolume'] / 8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['left'], ceil($source_data_array['bitsvolume'] / 8), false);
- if ($source_data_array['volumechange']['rightrear'] || $source_data_array['volumechange']['leftrear'] ||
- $source_data_array['peakvolume']['rightrear'] || $source_data_array['peakvolume']['leftrear'] ||
- $source_data_array['volumechange']['center'] || $source_data_array['peakvolume']['center'] ||
- $source_data_array['volumechange']['bass'] || $source_data_array['peakvolume']['bass']) {
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['volumechange']['rightrear'], ceil($source_data_array['bitsvolume']/8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['volumechange']['leftrear'], ceil($source_data_array['bitsvolume']/8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['rightrear'], ceil($source_data_array['bitsvolume']/8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['leftrear'], ceil($source_data_array['bitsvolume']/8), false);
- }
- if ($source_data_array['volumechange']['center'] || $source_data_array['peakvolume']['center'] ||
- $source_data_array['volumechange']['bass'] || $source_data_array['peakvolume']['bass']) {
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['volumechange']['center'], ceil($source_data_array['bitsvolume']/8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['center'], ceil($source_data_array['bitsvolume']/8), false);
- }
- if ($source_data_array['volumechange']['bass'] || $source_data_array['peakvolume']['bass']) {
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['volumechange']['bass'], ceil($source_data_array['bitsvolume']/8), false);
- $frame_data .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['bass'], ceil($source_data_array['bitsvolume']/8), false);
- }
- }
- break;
- case 'EQU2':
- // 4.12 EQU2 Equalisation (2) (ID3v2.4+ only)
- // Interpolation method $xx
- // $00 Band
- // $01 Linear
- // Identification <text string> $00
- // The following is then repeated for every adjustment point
- // Frequency $xx xx
- // Volume adjustment $xx xx
- if (($source_data_array['interpolationmethod'] < 0) || ($source_data_array['interpolationmethod'] > 1)) {
- throw new getid3_exception('Invalid Interpolation Method byte in '.$frame_name.' ('.$source_data_array['interpolationmethod'].') (valid = 0 or 1)');
- }
- $frame_data .= chr($source_data_array['interpolationmethod']);
- $frame_data .= str_replace("\x00", '', $source_data_array['description'])."\x00";
- foreach ($source_data_array['data'] as $key => $val) {
- $frame_data .= getid3_lib::BigEndian2String(intval(round($key * 2)), 2, false);
- $frame_data .= getid3_lib::BigEndian2String($val, 2, false, true); // signed 16-bit
- }
- break;
- case 'EQUA':
- // 4.12 EQUA Equalisation (ID3v2.3 only)
- // Adjustment bits $xx
- // This is followed by 2 bytes + ('adjustment bits' rounded up to the
- // nearest byte) for every equalisation band in the following format,
- // giving a frequency range of 0 - 32767Hz:
- // Increment/decrement %x (MSB of the Frequency)
- // Frequency (lower 15 bits)
- // Adjustment $xx (xx ...)
- if (!$this->IsWithinBitRange($source_data_array['bitsvolume'], 8, false)) {
- throw new getid3_exception('Invalid Adjustment Bits byte in '.$frame_name.' ('.$source_data_array['bitsvolume'].') (range = 1 to 255)');
- }
- $frame_data .= chr($source_data_array['adjustmentbits']);
- foreach ($source_data_array as $key => $val) {
- if ($key != 'bitsvolume') {
- if (($key > 32767) || ($key < 0)) {
- throw new getid3_exception('Invalid Frequency in '.$frame_name.' ('.$key.') (range = 0 to 32767)');
- } else {
- if ($val >= 0) {
- // put MSB of frequency to 1 if increment, 0 if decrement
- $key |= 0x8000;
- }
- $frame_data .= getid3_lib::BigEndian2String($key, 2, false);
- $frame_data .= getid3_lib::BigEndian2String($val, ceil($source_data_array['adjustmentbits'] / 8), false);
- }
- }
- }
- break;
- case 'RVRB':
- // 4.13 RVRB Reverb
- // Reverb left (ms) $xx xx
- // Reverb right (ms) $xx xx
- // Reverb bounces, left $xx
- // Reverb bounces, right $xx
- // Reverb feedback, left to left $xx
- // Reverb feedback, left to right $xx
- // Reverb feedback, right to right $xx
- // Reverb feedback, right to left $xx
- …
Large files files are truncated, but you can click here to view the full file