id3taginator 0.8

data/lib/id3taginator/frames/url/wxxx_user_url_link_frame.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class UserUrlLinkFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WXX, :WXXX, :WXXX
+
+        attr_accessor :description, :url
+
+        # builds the custom user url link frame
+        #
+        # @param description [String] the description
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(description, url, options = nil, id3_version: 3)
+          supported?('WXXX', id3_version, options)
+
+          argument_not_nil(description, 'description')
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.description = description
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          content_io = StringIO.new(content)
+          encoding_byte = content_io.getbyte
+          encoding = find_encoding(encoding_byte)
+
+          encoded_description = read_stream_until(content_io, zero_byte(encoding))
+          @description = decode(encoded_description, encoding)
+          @url = content_io.read
+        end
+
+        def content_to_bytes
+          encoded_description = encode(@description, null_terminated: true)
+          merge(default_encoding_destination_byte, encoded_description, @url)
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url_frames.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module UrlFrames
+      include Frames::Frameable
+
+      # extracts the commercial information url (WCOM/WCM)
+      #
+      # @return [String, nil] returns the URL
+      def commercial_information_url
+        find_frame(Url::CommercialUrlFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the commercial information url (WCOM/WCM)
+      #
+      # @param url [String] the url
+      def commercial_information_url=(url)
+        set_frame_fields(Url::CommercialUrlFrame, [:@url], url)
+      end
+
+      # removes the commercial information url frame
+      def remove_commercial_information_url
+        @frames.delete_if { |f| f.frame_id == Url::CommercialUrlFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the copyright information url (WCOP/WCP)
+      #
+      # @return [String, nil] returns the URL
+      def copyright_information_url
+        find_frame(Url::CopyrightUrlFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the copyright information url (WCOP/WCP)
+      #
+      # @param url [String] the url
+      def copyright_information_url=(url)
+        set_frame_fields(Url::CopyrightUrlFrame, [:@url], url)
+      end
+
+      # removes the copyright information url frame
+      def remove_copyright_information_url
+        @frames.delete_if { |f| f.frame_id == Url::CopyrightUrlFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the official audio file url (WOAF/WAF)
+      #
+      # @return [String, nil] returns the URL
+      def official_audio_file_url
+        find_frame(Url::OfficialFileWebpageFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the official audio file url (WOAF/WAF)
+      #
+      # @param url [String] the url
+      def official_audio_file_url=(url)
+        set_frame_fields(Url::OfficialFileWebpageFrame, [:@url], url)
+      end
+
+      # removes the official audio file url frame
+      def remove_official_audio_file_url
+        @frames.delete_if { |f| f.frame_id == Url::OfficialFileWebpageFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the official artist url (WOAR/WAR)
+      #
+      # @return [String, nil] returns the URL
+      def official_artist_url
+        find_frame(Url::OfficialArtistWebpageFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the official artist url (WOAR/WAR)
+      #
+      # @param url [String] the url
+      def official_artist_url=(url)
+        set_frame_fields(Url::OfficialArtistWebpageFrame, [:@url], url)
+      end
+
+      # removes the official artist url frame
+      def remove_official_artist_url
+        @frames.delete_if { |f| f.frame_id == Url::OfficialArtistWebpageFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the official source url (WOAS/WAS)
+      #
+      # @return [String, nil] returns the URL
+      def official_source_url
+        find_frame(Url::OfficialSourceWebpageFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the official source url (WOAS/WAS)
+      #
+      # @param url [String] the url
+      def official_source_url=(url)
+        set_frame_fields(Url::OfficialSourceWebpageFrame, [:@url], url)
+      end
+
+      # removes the official source url frame
+      def remove_official_source_url
+        @frames.delete_if { |f| f.frame_id == Url::OfficialSourceWebpageFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the official radio station url (WORS)
+      #
+      # @return [String, nil] returns the URL
+      def official_radio_station_homepage
+        find_frame(Url::OfficialAudioRadioStationHomepageFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the official radio station url (WORS)
+      #
+      # @param url [String] the url
+      def official_radio_station_homepage=(url)
+        set_frame_fields(Url::OfficialAudioRadioStationHomepageFrame, [:@url], url)
+      end
+
+      # removes the official radio station homepage frame
+      def remove_official_radio_station_homepage
+        @frames.delete_if do |f|
+          f.frame_id == Url::OfficialAudioRadioStationHomepageFrame.frame_id(@major_version, @options)
+        end
+      end
+
+      # extracts the official radio station url (WPAY)
+      #
+      # @return [String, nil] returns the URL
+      def payment_url
+        find_frame(Url::PaymentUrlFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the payment url (WPAY)
+      #
+      # @param url [String] the url
+      def payment_url=(url)
+        set_frame_fields(Url::PaymentUrlFrame, [:@url], url)
+      end
+
+      # removes the payment frame
+      def remove_payment_url
+        @frames.delete_if { |f| f.frame_id == Url::PaymentUrlFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the official publisher url (WPUB/WPB)
+      #
+      # @return [String, nil] returns the URL
+      def official_publisher_webpage
+        find_frame(Url::OfficialPublisherWebpageFrame.frame_id(@major_version, @options))&.url
+      end
+
+      # sets the official publisher url (WPUB/WPB)
+      #
+      # @param url [String] the url
+      def official_publisher_webpage=(url)
+        set_frame_fields(Url::OfficialPublisherWebpageFrame, [:@url], url)
+      end
+
+      # removes the official publisher webpage frame
+      def remove_official_publisher_webpage
+        @frames.delete_if { |f| f.frame_id == Url::OfficialPublisherWebpageFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the user custom url links (WXXX/WXX)
+      #
+      # @return [Array<Frames::Url::Entities::UserInfo>] returns the custom URL links
+      def user_custom_url_links
+        frame = find_frames(Url::UserUrlLinkFrame.frame_id(@major_version, @options))
+        return [] if frame.nil? || frame.empty?
+
+        frame.map { |f| Url::Entities::UserInfo.new(f.description, f.url) }
+      end
+
+      # adds a user custom url link (WXXX/WXX)
+      # Multiple ones can be added, as long as they have different description
+      #
+      # @param custom_url [Frames::Url::Entities::UserInfo] the custom url link to add
+      def user_custom_url_link=(custom_url)
+        set_frame_fields_by_selector(Url::UserUrlLinkFrame, %i[@description @url],
+                                     ->(f) { f.description == custom_url.description },
+                                     custom_url.description, custom_url.url)
+      end
+
+      alias add_user_custom_url_link user_custom_url_link=
+
+      # removes a user custom url link for the specific description (WXXX/WXX)
+      #
+      # @param description [String] the description
+      def remove_user_custom_url_link(description)
+        @frames.delete_if do |f|
+          f.frame_id == Url::UserUrlLinkFrame.frame_id(@major_version, @options) &&
+            f.description == description
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/genres.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Genres
+    BLUES = 0
+    CLASSIC_ROCK = 1
+    COUNTRY = 2
+    DANCE = 3
+    DISCO = 4
+    FUNK = 5
+    GRUNGE = 6
+    HIP_HOP = 7
+    JAZZ = 8
+    METAL = 9
+    NEW_AGE = 10
+    OLDIES = 11
+    OTHER = 12
+    POP = 13
+    RNB = 14
+    RAP = 15
+    REGGAE = 16
+    ROCK = 17
+    TECHNO = 18
+    INDUSTRIAL = 19
+    ALTERNATIVE = 20
+    SKA = 21
+    DEATH_METAL = 22
+    PRANKS = 23
+    SOUNDTRACK = 24
+    EURO_TECHNO = 25
+    AMBIENT = 26
+    TRIP_HOP = 27
+    VOCAL = 28
+    JAZZ_FUNK = 29
+    FUSION = 30
+    TRANCE = 31
+    CLASSICAL = 32
+    INSTRUMENTAL = 33
+    ACID = 34
+    HOUSE = 35
+    GAME = 36
+    SOUND_CLIP = 37
+    GOSPEL = 38
+    NOISE = 39
+    ALT_ROCK = 40
+    BASS = 41
+    SOUL = 42
+    PUNK = 43
+    SPACE = 44
+    MEDITATIVE = 45
+    INSTRUMENTAL_POP = 46
+    INSTRUMENTAL_ROCK = 47
+    ETHNIC = 48
+    GOTHIC = 49
+    DARKWAVE = 50
+    TECHNO_INDUSTRIAL = 51
+    ELECTRONIC = 52
+    POP_FOLK = 53
+    EURODANCE = 54
+    DREAM = 55
+    SOUTHERN_ROCK = 56
+    COMEDY = 57
+    CULT = 58
+    GANGSTA = 59
+    TOP_40 = 60
+    CHRISTIAN_RAP = 61
+    POP_FUNK = 62
+    JUNGLE = 63
+    NATIVE_AMERICAN = 64
+    CABARET = 65
+    NEW_WAVE = 66
+    PSYCHEDELIC = 67
+    RAVE = 68
+    SHOWTUNES = 69
+    TRAILER = 70
+    LO_FI = 71
+    TRIBAL = 72
+    ACID_PUNK = 73
+    ACID_JAZZ = 74
+    POLKA = 75
+    RETRO = 76
+    MUSICAL = 77
+    ROCK_N_ROLL = 78
+    HARD_ROCK = 79
+    FOLK = 80
+    FOLK_ROCK = 81
+    NATIONAL_FOLK = 82
+    SWING = 83
+    FAST_FUSION = 84
+    BEBOB = 85
+    LATIN = 86
+    REVIVAL = 87
+    CELTIC = 88
+    BLUEGRASS = 89
+    AVANTGARDE = 90
+    GOTHIC_ROCK = 91
+    PROGRESSIVE_ROCK = 92
+    PSYCHEDELIC_ROCK = 93
+    SYMPHONIC_ROCK = 94
+    SLOW_ROCK = 95
+    BIG_BAND = 96
+    CHORUS = 97
+    EASY_LISTENING = 98
+    ACOUSTIC = 99
+    HUMOUR = 100
+    SPEECH = 101
+    CHANSON = 102
+    OPERA = 103
+    CHAMBER_MUSIC = 104
+    SONATA = 105
+    SYMPHONY = 106
+    BOOTY_BASS = 107
+    PRIMUS = 108
+    PORN_GROOVE = 109
+    SATIRE_PARODY = 110
+    SLOW_JAM = 111
+    CLUB = 112
+    TANGO = 113
+    SAMBA = 114
+    FOLKLORE = 115
+    BALLAD = 116
+    POWER_BALLAD = 117
+    RHYTHMIC_SOUL = 118
+    FREESTYLE = 119
+    DUET = 120
+    PUNK_ROCK = 121
+    DRUM_SOLO = 122
+    ACAPELLA = 123
+    EURO_HOUSE = 124
+    DANCE_HALL = 125
+    GOA = 126
+    DRUM_N_BASS = 127
+    CLUB_HOUSE = 128
+    HARDCORE = 129
+    TERROR = 130
+    INDIE = 131
+    BRITPOP = 132
+    NEGERPUNK = 133
+    POLSK_PUNK = 134
+    BEAT = 135
+    CHRISTIAN_GANGSTA = 136
+    HEAVY_METAL = 137
+    THRASH_METAL = 138
+    ANIME = 139
+    JPOP = 140
+    SYNTHPOP = 141
+    INVALID = 255
+
+    def self.genre(id)
+      return nil if id.nil?
+
+      result = constants.find { |genre| const_get(genre) == id }
+      return :INVALID if result.nil?
+
+      result
+    end
+
+    def self.genre_by_name(name)
+      return INVALID if name.nil?
+
+      begin
+        const_get(name)
+      rescue NameError
+        name
+      end
+    end
+  end
+end

data/lib/id3taginator/header/id3v23_extended_header.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Header
+    class Id3v23ExtendedHeader
+
+      attr_accessor :size, :flags, :padding, :crc_data
+
+      # constructor
+      #
+      # @param size [Integer] the size of the extended header
+      # @param flags [String] 2 byte Array as a String representing the flags
+      # @param padding [Integer] the number of padding of the extended header
+      # @param crc_data [String] the crc data if present
+      def initialize(size, flags, padding, crc_data = nil)
+        @size = size
+        @flags = flags
+        @padding = padding
+        @crc_data = crc_data
+      end
+
+      # returns the CRC data if present
+      #
+      # @return [String, nil] the CRC data
+      def crc
+        @crc_data
+      end
+
+      # determined if the crc is present
+      #
+      # @return [Boolean] true if crc is present, else false
+      def crc?
+        (@flags[0] & 0b10000000) == 0b10000000
+      end
+    end
+  end
+end

data/lib/id3taginator/header/id3v24_extended_header.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Header
+    class Id3v24ExtendedHeader
+
+      attr_accessor :size, :flags
+
+      # constructor
+      #
+      # @param size [Integer] the size of the extended header
+      # @param flags [String] 2 byte Array as a String representing the flags
+      def initialize(size, flags)
+        @size = size
+        @flags = flags
+        @tag_is_update = false
+        @crc_data = nil
+        @restrictions = 0b00000000
+
+        flags_stream = StringIO.new(flags)
+        ext_flag = flags_stream.readbyte
+        # tag is update
+        if bit_set?(ext_flag, 0b01000000)
+          @tag_is_update = true
+          flags_stream.readbyte
+        end
+
+        # crc data
+        if bit_set?(ext_flag, 0b00100000)
+          length = ext_flag.readbyte
+          @crc_data = flags_stream.read(length)
+        end
+
+        ext_flag.readbyte if bit_set?(ext_flag, 0b00010000)
+        @restrictions = ext_flag.readbyte if bit_set?(ext_flag, 0b00010000)
+      end
+
+      # determined if the tag is an update
+      #
+      # @return [Boolean] true if it is an update, else false
+      def tag_is_an_update?
+        @tag_is_update
+      end
+
+      # returns the CRC data if present
+      #
+      # @return [String, nil] the CRC data
+      def crc
+        @crc_data
+      end
+
+      # determined if the tag is size restricted
+      #
+      # @return [Boolean] true if it restricted, else false
+      def tag_size_restrictions?
+        (@restrictions & 0b11000000) == 0b11000000
+      end
+
+      # determined if the tag is text encoding restricted
+      #
+      # @return [Boolean] true if text encoding restricted, else false
+      def text_encoding_restrictions?
+        (@restrictions & 0b00100000) == 0b00100000
+      end
+
+      # determined if the tag is fields size restricted
+      #
+      # @return [Boolean] true if fields size restricted, else false
+      def text_fields_size_restrictions?
+        (@restrictions & 0b00011000) == 0b00011000
+      end
+
+      # determined if the tag is encoding restricted
+      #
+      # @return [Boolean] true if encoding restricted, else false
+      def image_encoding_restrictions?
+        (@restrictions & 0b00000100) == 0b00000100
+      end
+
+      # determined if the tag is image encoding restricted
+      #
+      # @return [Boolean] true if image encoding restricted, else false
+      def image_size_restrictions?
+        (@restrictions & 0b00000011) == 0b00000011
+      end
+
+      # checks if the given bit of the given byte is set
+      #
+      # @param byte [Integer] the byte to check if a specific bit is set
+      # @param set [Byte] the Byte where the bit is set that should be checked
+      #
+      # @return [Boolean] true if the bit is set, else false
+      def bit_set?(byte, set)
+        (byte & set) == set
+      end
+
+      private :bit_set?
+    end
+  end
+end

data/lib/id3taginator/header/id3v2_flags.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Header
+    class Id3v2Flags
+
+      # constructor
+      #
+      # @param flags [Integer] the 1 byte header flag
+      def initialize(flags)
+        @flags = flags
+      end
+
+      # determined if the tag is unsynchronized
+      #
+      # @return [Boolean] true if unsynchronized, else false
+      def unsynchronized?
+        (@flags & 0b1000_0000) == 0b1000_0000
+      end
+
+      # enables or synchronization for the tag
+      #
+      # @param enabled [Boolean] true, if tag should be synchronized, else false
+      def unsynchronized=(enabled)
+        @flags = enabled ? @flags | 0b1000_0000 : @flags & 0b0111_1111
+      end
+
+      # determines if an extended header is present
+      #
+      # @return [Boolean] true if header is present, else false
+      def extended_header?
+        (@flags & 0b0100_0000) == 0b0100_0000
+      end
+
+      # determines if experimental tags are present
+      #
+      # @return [Boolean] true if experimental tags present, else false
+      def experimental?
+        (@flags & 0b0010_0000) == 0b0010_0000
+      end
+
+      # determines if a footer is present
+      #
+      # @return [Boolean] true if a footer is present, else false
+      def footer?
+        (@flags & 0b0001_0000) == 0b0001_0000
+      end
+
+      # enables or disables a footer
+      #
+      # @param enabled [Boolean] true, if the footer should be set to the tag, else false
+      def footer=(enabled)
+        @flags = enabled ? @flags | 0b0001_0000 : @flags & 0b1110_1111
+      end
+
+      # dumps the flags to a byte string
+      #
+      # @return [String] the String representing the flags
+      def to_bytes
+        @flags.chr
+      end
+    end
+  end
+end